# Android listeners
## OnRegisterForPushListener {id=on-register-for-push-listener}
#### onRegisterForPushRequired(PushRegistrationOrigin origin) {id=on-register-for-push-listener-on-register-for-push-required-with-origin}
This method is called when Synerise needs registration for push notifications.
See [Configuring push notifications](/developers/mobile-sdk/configuring-push-notifications/android) for more details.
```Kotlin
fun onRegisterForPushRequired(origin: PushRegistrationOrigin)
```
| Parameter | Type | Description |
| --- | --- | --- |
| **origin** | [PushRegistrationOrigin](/developers/mobile-sdk/class-reference/android/campaigns#pushregistrationorigin) | Information about the cause of the registration |
---
---
#### onRegisterForPushRequired() {id=on-register-for-push-listener-on-register-for-push-required}
This method is called when Synerise needs registration for push notifications.
See [Configuring push notifications](/developers/mobile-sdk/configuring-push-notifications/android) for more details.
```Java
- void onRegisterForPushRequired();
```
```Kotlin
fun onRegisterForPushRequired()
```
---
---
## OnNotificationListener {id=on-notification-listener}
A listener to handle events from Synerise notifications.
See [Configuring push notifications](/developers/mobile-sdk/configuring-push-notifications/android#callback-methods) for more details.
**OnNotificationListener** is available from 4.9.0 SDK version.
#### onNotificationReceived(NotificationInfo notificationInfo) {id=on-notification-listener-on-notification-receive}
This method is called when a Synerise notification is received.
```Java
- public void onNotificationReceived(NotificationInfo notificationInfo)
```
```Kotlin
fun onNotificationReceived(notificationInfo: NotificationInfo)
```
| Parameter | Type | Description |
| --- | --- | --- |
| **notificationInfo** | [NotificationInfo](/developers/mobile-sdk/class-reference/android/campaigns#notificationinfo) | Object providing info about the notification. |
#### onNotificationDismissed(NotificationInfo notificationInfo) {id=on-notification-listener-on-notification-dismissed}
This method is called when a Synerise notification is dismissed.
```Java
- public void onNotificationDismissed(NotificationInfo notificationInfo)
```
```Kotlin
fun onNotificationDismissed(notificationInfo: NotificationInfo)
```
| Parameter | Type | Description |
| --- | --- | --- |
| **notificationInfo** | [NotificationInfo](/developers/mobile-sdk/class-reference/android/campaigns#notificationinfo) | Object providing info about the notification. |
#### onNotificationClicked(NotificationInfo notificationInfo) {id=on-notification-listener-on-notification-clicked}
This method is called when a Synerise notification is clicked.
```Java
- public void onNotificationClicked(NotificationInfo notificationInfo)
```
```Kotlin
fun onNotificationClicked(notificationInfo: NotificationInfo)
```
| Parameter | Type | Description |
| --- | --- | --- |
| **notificationInfo** | [NotificationInfo](/developers/mobile-sdk/class-reference/android/campaigns#notificationinfo) | Object providing information about the notification. |
#### onActionButtonClicked(NotificationInfo notificationInfo, String actionButton) {id=on-notification-listener-on-action-button-clicked}
This method is called when an action button is clicked in a Synerise notification.
```Java
- public void onActionButtonClicked(NotificationInfo notificationInfo, String actionButton)
```
```Kotlin
fun onActionButtonClicked(notificationInfo: NotificationInfo, actionButton: String)
```
| Parameter | Type | Description |
| --- | --- | --- |
| **notificationInfo** | [NotificationInfo](/developers/mobile-sdk/class-reference/android/campaigns#notificationinfo) | Object providing information about the notification. |
| **actionButton** | String | Text on the clicked action button. |
---
---
## OnClientStateChangeListener {id=on-client-state-change-listener}
A listener to handle customer's sign-in state changes.
To set your object with listener methods, you must use [this method](/developers/mobile-sdk/method-reference/android/client-authentication#set-client-state-change-listener).
#### onClientSignedIn() {id=on-client-state-change-listener-on-client-signed-in}
This method is called when the customer signs in.
```Java
- public void onClientSignedIn()
```
```Kotlin
fun onClientSignedIn()
```
#### onClientSignedOut(ClientSessionEndReason reason) {id=on-client-state-change-listener-on-client-signed-out}
This method is called when the customer signs out.
```Java
- public void onClientSignedOut(ClientSessionEndReason reason)
```
```Kotlin
fun onClientSignedOut(reason:ClientSessionEndReason)
```
| Parameter | Type | Description |
| --- | --- | --- |
| **reason** | [ClientSessionEndReason](/developers/mobile-sdk/class-reference/android/client#clientsessionendreason) | Specifies the reason for signing out. |
---
---
## OnInjectorListener {id=on-injector-listener}
#### onOpenUrl(SyneriseSource source, String url) {id=on-injector-listener-on-open-url}
A listener to handle events from [campaigns](/developers/mobile-sdk/campaigns).
Fired when a customer interacts with the URL action.
This method returns `true` if activity is closed after executing an action; in other case, it returns `false`.
```Kotlin
fun onOpenUrl(source:SyneriseSource, url:String):Boolean
```
| Parameter | Type | Description |
| --- | --- | --- |
| **source** | SyneriseSource | Interaction source |
| **url** | String | URL value from the action of the activity |
#### onOpenUrl(InjectorSource source, String url) {id=on-injector-listener-on-open-url-deprecated}
A listener to handle events from [campaigns](/developers/mobile-sdk/campaigns).
Fired when a customer interacts with the URL action.
This method returns `true` if activity is closed after executing an action; in other case, it returns `false`.
```Kotlin
fun onOpenUrl(source:InjectorSource, url:String):Boolean
```
| Parameter | Type | Description |
| --- | --- | --- |
| **source** | InjectorSource | Interaction source |
| **url** | String | URL value from the action of the activity |
#### onDeepLink(SyneriseSource source, String deepLink) {id=on-injector-listener-on-deeplink}
Fired when a customer interacts with the DEEP_LINKING action.
The method returns `true` if activity is closed after executing the action; in other case, it returns `false`.
```Kotlin
fun onDeepLink(source:SyneriseSource, deepLink:String):Boolean
```
| Parameter | Type | Description |
| --- | --- | --- |
| **source** | SyneriseSource | Interaction source |
| **deepLink** | String | Deep link value from the action of the activity |
#### onDeepLink(InjectorSource source, String deepLink) {id=on-injector-listener-on-deeplink}
Fired when a customer interacts with the DEEP_LINKING action.
The method returns `true` if activity is closed after executing the action; in other case, it returns `false`.
```Kotlin
fun onDeepLink(source:InjectorSource, deepLink:String):Boolean
```
| Parameter | Type | Description |
| --- | --- | --- |
| **source** | InjectorSource | Interaction source |
| **deepLink** | String | Deep link value from the action of the activity |
---
---
## OnInAppListener {id=on-in-app-listener}
A listener to handle the states of [in-app message](/developers/mobile-sdk/campaigns/in-app-message).
**OnInAppListener** is available from 4.7.0 SDK version.
To set your object with listener methods, you must use [this method](/developers/mobile-sdk/method-reference/android/campaigns#set-in-app-listener).
#### shouldShow(InAppMessageData inAppMessageData) {id=on-in-app-listener-should-show}
This method is called after an in-app message is loaded and Synerise SDK asks for permission to show it.
| Parameter | Type | Description |
| --- | --- | --- |
| **inAppMessageData** | [InAppMessageData](/developers/mobile-sdk/class-reference/android/campaigns#inappmessagedata) | In-app message data. |
#### onContextFromAppRequired(InAppMessageData inAppMessageData) {id=on-in-app-listener-on-context-from-app-required}
This method is called when an individual context (for example a profile ID, an item SKU) for an in-app message is needed.
| Parameter | Type | Description |
| --- | --- | --- |
| **inAppMessageData** | [InAppMessageData](/developers/mobile-sdk/class-reference/android/campaigns#inappmessagedata) | In-app message data. |
#### onHandledOpenUrl(InAppMessageData inAppMessageData) {id=on-in-app-listener-on-handled-open-url}
This method is called when the [`SRInApp.openUrl(url)` method](/docs/campaign/in-app-messages/creating-inapp-templates/creating-inapp-template#open-url) is used in an in-app message.
| Parameter | Type | Description |
| --- | --- | --- |
| **inAppMessageData** | [InAppMessageData](/developers/mobile-sdk/class-reference/android/campaigns#inappmessagedata) | In-app message data. |
#### onHandledOpenDeepLink(InAppMessageData inAppMessageData) {id=on-in-app-listener-on-handled-open-deeplink}
This method is called when the [`SRInApp.openDeeplink(url)` method](/docs/campaign/in-app-messages/creating-inapp-templates/creating-inapp-template#open-deeplink) is used in an in-app message.
| Parameter | Type | Description |
| --- | --- | --- |
| **inAppMessageData** | [InAppMessageData](/developers/mobile-sdk/class-reference/android/campaigns#inappmessagedata) | In-app message data. |
#### onCustomAction(String identifier, HashMap params, InAppMessageData inAppMessageData) {id=on-in-app-listener-on-custom-action}
This method is called when the [`SRInApp.handleCustomAction(name, params)` method](/docs/campaign/in-app-messages/creating-inapp-templates/creating-inapp-template#trigger-a-custom-action) is used in an in-app message.
| Parameter | Type | Description |
| --- | --- | --- |
| **inAppMessageData** | [InAppMessageData](/developers/mobile-sdk/class-reference/android/campaigns#inappmessagedata) | In-app message data. |
| **identifier** | String | Identifier of the custom action. |
| **params** | HashMap | Custom action parameters. |
---
---
## OnInlineInAppListener {id=on-inline-in-app-listener}
A listener to handle global events for [inline in-app messages](/developers/mobile-sdk/campaigns/in-app-message/inline-in-app).
To set your object with listener methods, you must use [this method](/developers/mobile-sdk/method-reference/android/campaigns#set-inline-in-app-listener).
#### onInlineInAppAvailable(InlineInAppView view, InlineInAppMessageData data) {id=on-inline-in-app-listener-on-inline-in-app-available}
This method is called when the SDK creates a ready-to-display component after an event-based trigger for a placement with no existing host view.
| Parameter | Type | Description |
| --- | --- | --- |
| **view** | InlineInAppView | The ready-to-display inline in-app view. |
| **data** | InlineInAppMessageData | Inline in-app message data. |
#### onContextFromAppRequired(InAppMessageData data) {id=on-inline-in-app-listener-on-context-from-app-required}
This method is called when a per-message context is needed for rendering. This method is called on a background thread.
| Parameter | Type | Description |
| --- | --- | --- |
| **data** | InAppMessageData | In-app message data. |
#### onOpenedUrl(InlineInAppMessageData data, String url) {id=on-inline-in-app-listener-on-opened-url}
This method is called when the `SRInApp.openUrl(url)` method is used in an in-app message.
| Parameter | Type | Description |
| --- | --- | --- |
| **data** | InlineInAppMessageData | Inline in-app message data. |
| **url** | String | The URL to open. |
#### onOpenedDeepLink(InlineInAppMessageData data, String deepLink) {id=on-inline-in-app-listener-on-opened-deep-link}
This method is called when the `SRInApp.openDeeplink(url)` method is used in an in-app message.
| Parameter | Type | Description |
| --- | --- | --- |
| **data** | InlineInAppMessageData | Inline in-app message data. |
| **deepLink** | String | The deep link value. |
#### onCustomAction(InlineInAppMessageData data, String name, Map params) {id=on-inline-in-app-listener-on-custom-action}
This method is called when the `SRInApp.handleCustomAction(name, params)` method is used in an in-app message.
| Parameter | Type | Description |
| --- | --- | --- |
| **data** | InlineInAppMessageData | Inline in-app message data. |
| **name** | String | Name of the custom action. |
| **params** | Map | Custom action parameters. |
#### onCustomMethod(String name, HashMap params, InlineInAppMessageData data, InAppCustomMethodCompletion completion) {id=on-inline-in-app-listener-on-custom-method}
This method is called when the `SRInApp.customMethod(name, params)` method is used in an in-app message. Resolve the completion exactly once with success or failure.
| Parameter | Type | Description |
| --- | --- | --- |
| **name** | String | Name of the custom method. |
| **params** | HashMap | Custom method parameters. |
| **data** | InlineInAppMessageData | Inline in-app message data. |
| **completion** | InAppCustomMethodCompletion | Completion to resolve with `success()` or `failure()`. |
---
---
## OnInlineInAppViewListener {id=on-inline-in-app-view-listener}
A per-component listener to handle the lifecycle of an [inline in-app message](/developers/mobile-sdk/campaigns/in-app-message/inline-in-app) view.
#### onProcessingStarted() {id=on-inline-in-app-view-listener-on-processing-started}
This method is called when the SDK starts processing a campaign for this component.
```Java
void onProcessingStarted()
```
```Kotlin
onProcessingStarted()
```
#### onLoaded(InlineInAppMessageData data) {id=on-inline-in-app-view-listener-on-loaded}
This method is called when the inline in-app message content is loaded for the first time.
| Parameter | Type | Description |
| --- | --- | --- |
| **data** | InlineInAppMessageData | Inline in-app message data. |
#### onUpdated(InlineInAppMessageData data) {id=on-inline-in-app-view-listener-on-updated}
This method is called when the inline in-app message content is updated with a new campaign.
| Parameter | Type | Description |
| --- | --- | --- |
| **data** | InlineInAppMessageData | Inline in-app message data. |
| **error** | String | Error description. |
#### onSizeChanged(InlineInAppMessageData data, InlineInAppSize size) {id=on-inline-in-app-view-listener-on-size-changed}
This method is called when the in-app message content requests a size change via the `SRInApp.setComponentSize(width, height)` JS method. The measured size is delivered as an `InlineInAppSize`, exposing it in physical pixels, density-independent pixels (dp), and as a fraction of the device screen.
| Parameter | Type | Description |
| --- | --- | --- |
| **data** | InlineInAppMessageData | Inline in-app message data. |
| **size** | InlineInAppSize | The requested size. Exposes `getWidthPx()`/`getHeightPx()` (physical pixels), `getWidthDp()`/`getHeightDp()` (density-independent pixels), and `getWidthScreenRatio()`/`getHeightScreenRatio()` (0..1 fraction of the screen). |
#### onRemove(InlineInAppMessageData data) {id=on-inline-in-app-view-listener-on-remove}
This method is called when the in-app message content requests removal from the view hierarchy via the `SRInApp.close()` or `SRInApp.closeAndTrigger()` JS method.
| Parameter | Type | Description |
| --- | --- | --- |
| **data** | InlineInAppMessageData | Inline in-app message data. |
---
---
## OnLocationUpdateListener {id=on-location-update-listener}
A listener to handle events about location.
#### onLocationUpdateRequired() {id=on-location-update-listener-on-location-update-required}
This method is called when the Tracker module requests a location update.
```Java
- void onLocationUpdateRequired()
```
```Kotlin
fun onLocationUpdateRequired()
```
---
---
## OnContentWidgetListener {id=on-content-widget-listener}
A listener to handle [Content Widget](/developers/mobile-sdk/displaying-recommendations/content-widget) actions.
#### onLoad(ContentWidget contentWidget) {id=on-content-widget-listener-on-load}
This method is called after a widget is loaded.
```Kotlin
fun onLoad(contentWidget:ContentWidget)
```
| Parameter | Type | Description |
| --- | --- | --- |
| **contentWidget` | [ContentWidget](/developers/mobile-sdk/class-reference/android/content-widget#contentwidget) | The widget instance that called the listener method |
#### onLoadingError(ContentWidget contentWidget, ApiError apiError) {id=on-content-widget-listener-on-loading-error}
This method is called when an error occurs while loading a widget.
```Kotlin
fun onLoadingError(contentWidget:ContentWidget, apiError:ApiError)
```
| Parameter | Type | Description |
| --- | --- | --- |
| **contentWidget** | [ContentWidget](/developers/mobile-sdk/class-reference/android/content-widget#contentwidget) | The widget instance that called the listener method |
| **apiError** | [ApiError](/developers/mobile-sdk/class-reference/android/miscellaneous#apierror) | The error that occurred |
#### onClickActionReceive(ContentWidget contentWidget, BaseModel model) {id=on-content-widget-listener-on-click-action-receive}
This method is called when the customer clicks a widget’s item.
```Kotlin
fun onClickActionReceive(contentWidget:ContentWidget, model:BaseModel)
```
| Parameter | Type | Description |
| --- | --- | --- |
| **contentWidget** | [ContentWidget](/developers/mobile-sdk/class-reference/android/content-widget#contentwidget) | The widget instance that called the listener method |
| **model** | BaseModel | The model's object that was clicked |
#### onLoading(ContentWidget contentWidget, boolean isLoading) {id=on-content-widget-listener-on-loading}
This method is called when the widget’s loading state changes.
```Kotlin
fun onLoading(contentWidget:ContentWidget, isLoading:Boolean)
```
| Parameter | Type | Description |
| --- | --- | --- |
| **contentWidget** | [ContentWidget](/developers/mobile-sdk/class-reference/android/content-widget#contentwidget) | The widget instance that called the listener method |
| **isLoading** | Boolean | Widget's loading state |
#### onSizeChange(ContentWidget contentWidget, ViewGroup.LayoutParams size) {id=on-content-widget-listener-on-size-change}
This method is called when the widget’s size changes.