## Related terms
- mobile\-sdk
- campaign
See the [glossary](/glossary.md) for definitions.
---
# Campaigns
---
## Set Injector listener
---
This method sets callbacks for an injector module.
**Declared In:**
lib/main/modules/InjectorModule.js
**Related To:**
[ClientStateChangeListener](/developers/mobile-sdk/listeners-and-delegates/react-native-listeners#injector-listener)
**Class:**
[InjectorModule](/developers/mobile-sdk/class-reference/react-native/modules#injector)
**Declaration:**
public setListener(listener: IInjectorListener)
**Discussion:**
Learn more about the methods and the purpose of this listener [here](/developers/mobile-sdk/listeners-and-delegates/react-native-listeners#injector-listener).
## Set In-App Message listener
---
This method sets callbacks for in-app message campaigns.
**Declared In:**
lib/main/modules/InjectorModule.js
**Related To:**
[InjectorInAppMessageListener](/developers/mobile-sdk/listeners-and-delegates/react-native-listeners#injector-in-app-message-listener)
**Class:**
[InjectorModule](/developers/mobile-sdk/class-reference/react-native/modules#injector)
**Declaration:**
public setInAppMessageListener(listener: IInjectorInAppMessageListener)
**Discussion:**
Learn more about the methods and the purpose of this listener [here](/developers/mobile-sdk/listeners-and-delegates/react-native-listeners#injector-in-app-message-listener).
## Set Inline In-App Message listener
---
This method sets callbacks for inline in-app message campaigns.
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| ----------------------------------------------- | ----------- | --------------- | -------------------- | --------------- |
| Introduced in: | 6.0.0 | 6.15.0 | 2.0.1 | 3.0.0 |
**Declared In:**
lib/main/modules/InjectorModule.js
**Related To:**
[InjectorInlineInAppMessageListener](/developers/mobile-sdk/listeners-and-delegates/react-native-listeners#injector-inline-in-app-message-listener)
**Class:**
[InjectorModule](/developers/mobile-sdk/class-reference/react-native/modules#injector)
**Declaration:**
public setInlineInAppMessageListener(listener: IInlineInAppMessageListener)
**Parameters:**
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **listener** | [IInlineInAppMessageListener](/developers/mobile-sdk/class-reference/react-native/campaigns#iinlineinappmessagelistener) | yes | - | Object that implements the inline in-app message listener |
**Return Value:**
No value is returned.
**Discussion:**
Learn more about the methods and the purpose of this listener [here](/developers/mobile-sdk/listeners-and-delegates/react-native-listeners#injector-inline-in-app-message-listener).
The listener handles actions from inline in-app messages (URL, deeplink, custom action, custom method) and delivers components created by the SDK for event-triggered campaigns with no mounted component. Setting a new listener replaces the previous one.
**Example:**
```JavaScript
Synerise.Injector.setInlineInAppMessageListener({
onInlineInAppAvailable: (view, data) => {
// Mount `view` for data.placementKey in your component tree
},
onOpenUrl: (data, url) => {
//...
},
onDeepLink: (data, deepLink) => {
//...
},
onCustomAction: (data, name, parameters) => {
//...
},
onCustomMethod: (data, name, parameters, completion) => {
completion.success({});
},
});
```
## Render inline in-app message
---
This method triggers rendering of an inline in-app message in the component. Use it for campaigns with the on-demand trigger.
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| ----------------------------------------------- | ----------- | --------------- | -------------------- | --------------- |
| Introduced in: | 6.0.0 | 6.15.0 | 2.0.1 | 3.0.0 |
**Declared In:**
lib/main/modules/inapp/InlineInAppView.js
**Related To:**
[InlineInAppView](/developers/mobile-sdk/class-reference/react-native/campaigns#inlineinappview)
**Class:**
[InlineInAppViewHandle](/developers/mobile-sdk/class-reference/react-native/campaigns#inlineinappviewhandle)
**Declaration:**
render(): void
**Return Value:**
No value is returned.
**Discussion:**
Call it on the component ref. The method matches only campaigns with the on-demand trigger for the component's placement key. The result is reported through the component callbacks (`onLoaded`, `onUpdated` or `onFailed`). The ref is available after the component is mounted.
**Example:**
```JavaScript
const inlineViewRef = useRef(null);
// Later, for example on a button press:
inlineViewRef.current?.render();
```
## Release inline in-app message view
---
This method tears the inline in-app message down (destroys the web view and clears the campaign data) while the component stays mounted.
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| ----------------------------------------------- | ----------- | --------------- | -------------------- | --------------- |
| Introduced in: | n/a | 6.15.0 | 2.0.1 | 3.0.0 |
**Declared In:**
lib/main/modules/inapp/InlineInAppView.js
**Related To:**
[InlineInAppView](/developers/mobile-sdk/class-reference/react-native/campaigns#inlineinappview)
**Class:**
[InlineInAppViewHandle](/developers/mobile-sdk/class-reference/react-native/campaigns#inlineinappviewhandle)
**Declaration:**
release(): void
**Return Value:**
No value is returned.
**Discussion:**
Use it when you keep the component mounted but want to free the placement, for example after the `onRemove` callback. Unmounting the component releases the native view automatically, so no call is needed in that case.
**Example:**
## Check if inline in-app message is rendered
---
This method checks if the component currently shows a rendered inline in-app message.
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| ----------------------------------------------- | ----------- | --------------- | -------------------- | --------------- |
| Introduced in: | 6.0.0 | 6.15.0 | 2.0.1 | 3.0.0 |
**Declared In:**
lib/main/modules/inapp/InlineInAppView.js
**Related To:**
[InlineInAppView](/developers/mobile-sdk/class-reference/react-native/campaigns#inlineinappview)
**Class:**
[InlineInAppViewHandle](/developers/mobile-sdk/class-reference/react-native/campaigns#inlineinappviewhandle)
**Declaration:**
isRendered(): Promise<boolean>
**Return Value:**
A Promise that resolves to **true** if the component shows a rendered campaign, otherwise **false**. It also resolves to **false** when the component is not mounted.
**Example:**
## Get inline in-app message data
---
This method returns the data of the inline in-app message currently shown in the component.
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| ----------------------------------------------- | ----------- | --------------- | -------------------- | --------------- |
| Introduced in: | 6.0.0 | 6.15.0 | 2.0.1 | 3.0.0 |
**Declared In:**
lib/main/modules/inapp/InlineInAppView.js
**Related To:**
[InlineInAppView](/developers/mobile-sdk/class-reference/react-native/campaigns#inlineinappview)
[InlineInAppMessageData](/developers/mobile-sdk/class-reference/react-native/campaigns#inlineinappmessagedata)
**Class:**
[InlineInAppViewHandle](/developers/mobile-sdk/class-reference/react-native/campaigns#inlineinappviewhandle)
**Declaration:**
getData(): Promise<InlineInAppMessageData | null>
**Return Value:**
A Promise that resolves to an [InlineInAppMessageData](/developers/mobile-sdk/class-reference/react-native/campaigns#inlineinappmessagedata) object, or **null** when the component is not mounted or holds no rendered campaign.
**Example:**
```JavaScript
const data = await inlineViewRef.current?.getData();
if (data != null) {
console.log(data.campaignHash, data.placementKey);
}
```
get inAppContext(): { [key: string]: any }
set inAppContext(context: { [key: string]: any })
**Discussion:**
A map sent to the backend for server-side Jinja evaluation in in-app message templates. Use [InAppContextKey.JinjavaContext](/developers/mobile-sdk/class-reference/react-native/campaigns#inappcontextkey) as a key to pass Jinja context variables. Call `notifyInAppContextChange()` after updating it to re-evaluate active inline in-app messages with the new values.
**Example:**
**Parameters:**
No parameters.
**Return Value:**
No value is returned.
**Discussion:**
Notifies active in-app messages that the application context has changed. Call it after updating `inAppContext`. The SDK calls the `SRInApp.onContextFromApp(context)` JS callback with the current context in every displayed in-app message. The campaign is not re-rendered: server-side Jinja evaluation uses the `InAppContextKey.JinjavaContext` value only when a message is rendered.
**Example:**
## Close In-App message
---
Closes an in-app message and sends an `inApp.discard` event.
Usage examples:
- Closing a top bar or bottom bar when the user taps outside the in-app area.
- Automatically dismissing messages when navigating away from a screen.
- Controlling in-app visibility based on app logic for a smoother user experience.
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| ----------------------------------------------- | ----------- | --------------- | -------------------- | --------------- |
| Introduced in: | 5.7.0 | 6.7.0 | 1.5.0 | 2.5.0 |
**Declared In:**
lib/main/modules/InjectorModule.js
**Class:**
[InjectorModule](/developers/mobile-sdk/class-reference/react-native/modules#injector)
**Declaration:**
public closeInAppMessage(campaignHash: string)
**Parameters:**
| Parameter | Type | Mandatory | Default | Description |
| ---------------- | ------ | --------- | ------- | ---------------------------------------- |
| **campaignHash** | string | yes | - | Unique identifier of the in-app campaign |
## Set Notifications listener
---
This method sets callbacks for notifications module.
**Declared In:**
lib/main/modules/NotificationsModule.js
**Class:**
[NotificationsModule](/developers/mobile-sdk/class-reference/react-native/modules#notifications)
**Declaration:**
public setListener(listener: INotificationsListener)
## Register for push notifications
---
This method passes the Firebase Token to Synerise for notifications.
- You should call this method every time the user changes the system or application consent for notifications.
- The API key must have the `API_PERSONAL_DEVICE_CLIENT_UPDATE` permission from the **Client** group.
- If the registration fails, the SDK requests a token update again by a listener/delegate method ([Android](/developers/mobile-sdk/listeners-and-delegates/android-listeners#on-register-for-push-listener), [iOS](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#synerise-delegate-register-for-push-notifications-is-needed), [React Native](/developers/mobile-sdk/listeners-and-delegates/react-native-listeners#notifications-listener), [Flutter](/developers/mobile-sdk/listeners-and-delegates/flutter-listeners#notifications-listener)).
**Parameters:**
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **registrationToken** | string | yes | - | Firebase Token |
| **mobileAgreement** | boolean | false | null | Agreement (consent) for mobile push campaigns |
| **onSuccess** | Function | no | - | Function to be executed when the operation is completed successfully |
| **onError** | Function | no | - | Function to be executed when the operation is completed with an error |
**Return Value:**
No value is returned.
**Example:**
```JavaScript
// If you integrate Firebase Messaging in the native part of app
Synerise.Notifications.setListener({
onRegistrationToken: function(registrationToken) {
Synerise.Notifications.registerForNotifications(registrationToken, true, function(){
//success
}, function() {
//failure
});
},
onNotification: function(payload) {
//...
}
//...
//other listener's methods
});
// Or if you want to use Firebase Messaging in react native
Synerise.Notifications.registerForNotifications("YOUR_FIREBASE_TOKEN", true, function(){
//success
}, function() {
//failure
});
```
## Check if push notification is from Synerise
---
This method verifies if a notification was sent by Synerise.
**Declared In:**
lib/main/modules/NotificationsModule.js
**Class:**
[NotificationsModule](/developers/mobile-sdk/class-reference/react-native/modules#notifications)
**Declaration:**
public isSyneriseNotification(payload: object): boolean
**Parameters:**
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **payload** | object | yes | - | Notification's key-value data object |
**Return Value:**
**true** if a notification was sent by Synerise, otherwise **false**.
**Example:**
## Check if push notification is a Simple Push Campaign
---
This method verifies if a notification’s sender is Synerise and if the notification is a Simple Push campaign
**Declared In:**
lib/main/modules/NotificationsModule.js
**Class:**
[NotificationsModule](/developers/mobile-sdk/class-reference/react-native/modules#notifications)
**Declaration:**
public isSyneriseSimplePush(payload: object): boolean
**Parameters:**
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **payload** | object | yes | - | Notification's key-value data object |
**Return Value:**
**true** if a notification is a Simple Push, otherwise **false**.
**Example:**
## Check if push notification is a Silent Command
---
This method verifies if a notification’s sender is Synerise and if the notification is a Silent Command.
**Declared In:**
lib/main/modules/NotificationsModule.js
**Class:**
[NotificationsModule](/developers/mobile-sdk/class-reference/react-native/modules#notifications)
**Declaration:**
public isSilentCommand(payload: object): boolean
**Parameters:**
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **payload** | object | yes | - | Notification's key-value data object |
**Return Value:**
**true** if a notification is a Silent Command, otherwise **false**.
**Example:**
## Check if push notification is a Silent SDK Command
---
This method verifies if a notification's sender is Synerise and if the notification is a Silent SDK Command.
**Declared In:**
lib/main/modules/NotificationsModule.js
**Class:**
[NotificationsModule](/developers/mobile-sdk/class-reference/react-native/modules#notifications)
**Declaration:**
public isSilentSDKCommand(payload: object): boolean
**Parameters:**
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **payload** | object | yes | - | Notification's key-value data object |
**Return Value:**
**true** if a notification is a Silent SDK Command, otherwise **false**.
**Example:**
## Check if push notification is encrypted
---
This method verifies if a notification is encrypted.
**Declared In:**
lib/main/modules/NotificationsModule.js
**Class:**
[NotificationsModule](/developers/mobile-sdk/class-reference/react-native/modules#notifications)
**Declaration:**
public isNotificationEncrypted(payload: object): boolean
**Parameters:**
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **payload** | object | yes | - | Notification's key-value data object |
**Return Value:**
**true** if a notification is encrypted, otherwise **false**.
**Example:**
**Parameters:**
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **onSuccess** | Function | no | - | Function to be executed when the operation is completed successfully |
| **onError** | Function | no | - | Function to be executed when the operation is completed with an error |
**Return Value:**
No value is returned.
### Get Banners {#get-banners}
---
This method provides valid banners directly from SDK cache.
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| Removed in: | 4.6.0 | 4.7.0 | 0.12.0 | n/a |