> Synerise Documentation — Mobile SDK (Part 1 of 2)
>
> This is part 1 of 2 of the "Mobile SDK" section. To reconstruct the full section, fetch all 2 parts in order (part 1, part 2, …) and concatenate them. Each article begins with a top-level "# " heading. The manifest listing all sections is at https://hub.synerise.com/llms-full.txt

# SDK Lifecycle


### Synerise Builder
<!-- reusable-table-boundary -->

Synerise builder class.

**Declared In:**  
`com.synerise.sdk.core.Synerise.Builder`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-108">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-108-0" data-tab-group="tabgrp-108" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-108-1" data-tab-group="tabgrp-108">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-108-0" data-tab-group="tabgrp-108" data-tab-active="true">

```Java
public static class Builder
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-108-1" data-tab-group="tabgrp-108">

```Kotlin
static class Builder
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **app** | Application | no | - | Application context |
| **apiKey** | String | no | - | Profile API Key (formerly Client). Can be retrieved from Synerise App |
| **applicationId** | String | no | - | Application ID |
| **baseUrl** | String | no | - | Base URL in the SDK. Can be null |
| **syneriseDebugMode** | Boolean | no | - | Debug mode flag |
| **notificationIcon** | int | no | R.drawable.synerise_ic_default_icon | Notification icon |
| **notificationIconColor** | int | no | R.color.syneriseGrayTranslucent | Notification color |
| **channelDefaultName** | String | no | - | Default notification channel name |
| **channelDefaultId** | String | no | - | Default notification channel ID |
| **channelHighPriorityName** | String | no | - | High priority notification channel name |
| **channelHighPriorityId** | String | no | - | High priority notification channel ID |
| **pushListener** | OnRegisterForPushListener | no | - | Push listener |
| **locationListener** | OnLocationUpdateListener | no | - | Location listener |
| **crashHandlingEnabled** | Boolean | no | - | Crash handling flag |
| **hostApplicationType** | HostApplicationType | yes | - | Host application type |
| **hostApplicationSDKPluginVersion** | String | yes | - | Synerise SDK plugin version in the host application |
| **setRequestValidationSalt** | String | yes | - | Synerise Profile salt string for request validation |
| **messagingServiceType** | String | yes | GMS | Use `GMS` for Google Mobile Services or `HMS` for Huawei Mobile Services |

**Initializers:**  

Start initializing Synerise SDK with this method.  
To get the Workspace API Key (formerly Business) and Profile API Key (formerly Client), sign in to your Synerise account and go to [Settings > API Key](https://app.synerise.com/spa/modules/settings/apikeys/list).  
Then, copy or generate a new API Key for the workspace and API Key for profiles.


<pre><code class="language-java">public static Builder with(Application app, String apiKey, String appId)</code></pre>



---

Use this method to finish the initialization process.


<pre><code class="language-java">public void build()</code></pre>



---

**Methods:**  


This method sets the icon that will be used as the small icon in notifications.  
It must be a drawable resource (not a mipmap) due to Android Oreo adaptive icons restrictions.


<pre><code class="language-java">public Builder notificationIcon(@DrawableRes int notificationIcon)</code></pre>



---

This method sets the notification icon and text color.  
`notificationIconColor` must be in ARGB format.


<pre><code class="language-java">public Builder notificationIconColor(int notificationIconColor)</code></pre>



---

This method enables/disables logcat logs from Synerise SDK.  
It is not recommended to use debug mode in the release version of your application.


<pre><code class="language-java">public Builder syneriseDebugMode(boolean syneriseDebugMode)</code></pre>



---

This method passes info about Users application crashes as dedicated events to the backend.  
It is recommended to use `SyneriseCrashHandling`.


<pre><code class="language-java">public Builder crashHandlingEnabled(boolean exceptionHandlerEnabled)</code></pre>



---

It is important to register your profiles for push messages, so Synerise SDK may ask you to register a profile for push notifications.  
This callback is called after the profile signs in, signs up, or deletes the account.


<pre><code class="language-java">public Builder pushRegistrationRequired(@NonNull OnRegisterForPushListener listener)</code></pre>



---

This callback is called on demand by push notification, so it may be called at any time.  
Check out the [sample application](https://github.com/Synerise/android-sdk/blob/master/sample/src/main/java/com/synerise/sdk/sample/App.java) for example usage and remember to send.


<pre><code class="language-java">public Builder locationUpdateRequired(@NonNull OnLocationUpdateListener listener)</code></pre>



---

You can provide your custom base URL to use your own API.  
  
You can use one of the constants:  
**SyneriseApiUrls.SYNERISE_AZ_API_URL** -  `https://api.snrapi.com`  
**SyneriseApiUrls.SYNERISE_AZU_API_URL** - `https://api.azu.snrapi.com`  
**SyneriseApiUrls.SYNERISE_GEB_API_URL** - `https://api.geb.snrapi.com`  


<pre><code class="language-java">public Builder baseUrl(String baseUrl)</code></pre>


---

You can provide your notification channel name.  
By default, the channel name is set to your application name.


<pre><code class="language-java">public Builder notificationDefaultChannelName(@NonNull String name)</code></pre>



---

You can provide your notification channel ID.


<pre><code class="language-java">public Builder notificationDefaultChannelId(@NonNull String channelId)</code></pre>



---

You can provide your High Priority notification channel name.  
From default, channel name is set to `<your application name> High Priority`


<pre><code class="language-java">public Builder notificationHighPriorityChannelName(@NonNull String name)</code></pre>



---

You can provide your High Priority notification channel ID.


<pre><code class="language-java">public Builder notificationHighPriorityChannelId(@NonNull String channelId)</code></pre>



---

You can set the Synerise SDK host application type.


<pre><code class="language-java">public Builder hostApplicationType(HostApplicationType type)</code></pre>



---

You can set Synerise the SDK plugin version of the host application.


<pre><code class="language-java">public Builder hostApplicationSDKPluginVersion(@NonNull String version)</code></pre>



---

<!-- reusable-table-boundary -->

---
---

## InitializationConfig
<!-- reusable-table-boundary -->

Configuration class for initialization of the SDK.

**Declared In:**  
`com.synerise.sdk.core.types.model.InitializationConfig`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-109">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-109-0" data-tab-group="tabgrp-109" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-109-1" data-tab-group="tabgrp-109">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-109-0" data-tab-group="tabgrp-109" data-tab-active="true">

```Java
public class InitializationConfig
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-109-1" data-tab-group="tabgrp-109">

```Kotlin
class InitializationConfig
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **salt** | String | no | - | [Simple Profile Authentication](/developers/mobile-sdk/user-identification-and-authorization/simple-authentication) salt |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All the properties above are accessible by using getters.

</div></div></div>


**Methods:**  

There are getters and setters for the above properties.

<!-- reusable-table-boundary -->

---
---

## Settings
<!-- reusable-table-boundary -->

Class model for settings.

**Declared In:**  
`com.synerise.sdk.core.settings.Settings`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-110">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-110-0" data-tab-group="tabgrp-110" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-110-1" data-tab-group="tabgrp-110">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-110-0" data-tab-group="tabgrp-110" data-tab-active="true">

```Java
public class Settings
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-110-1" data-tab-group="tabgrp-110">

```Kotlin
class Settings
```

</div>
</div>


**Properties:**
| Property | Type | Description |
| --- | --- | --- |
| **sdk** | GeneralSettings | [General settings](/developers/mobile-sdk/settings#general) - This group contains options related to the general functioning of mobile SDK |
| **notifications** | NotificationsSettings | [Notifications settings](/developers/mobile-sdk/settings#notifications) - This group contains options related to push notifications |
| **tracker** | TrackerSettings | [Tracker](/developers/mobile-sdk/settings#tracker) - This group contains options related to tracking the customer activities in a mobile application |
| **inAppMessaging** | InAppMessagingSettings | [In-app messaging](/developers/mobile-sdk/settings#in-app-messaging) - This group contains options related to the [in-app messages](/docs/campaign/in-app-messages) feature |
| **injector** | InjectorSettings | [Injector](/developers/mobile-sdk/settings#injector) - This group contains options related to displaying [campaigns](/docs/campaign/Mobile) |
  
**Note:**  
Learn more about settings [here](/developers/mobile-sdk/settings)

<!-- reusable-table-boundary -->

---
---

## TrackMode
<!-- reusable-table-boundary -->

This enum contains the values which set a mode for tracking component interactions from the `android.widget` package.

**Declared In:**  
`com.synerise.sdk.core.types.enums.TrackMode`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-111">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-111-0" data-tab-group="tabgrp-111" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-111-1" data-tab-group="tabgrp-111">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-111-0" data-tab-group="tabgrp-111" data-tab-active="true">

```Java
public enum TrackMode
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-111-1" data-tab-group="tabgrp-111">

```Kotlin
public enum TrackMode
```

</div>
</div>


**Values:**

| Property | Description |
| --- | --- |
| **PLAIN** | Tracks screen-visits. Events are sent when onStart of activities/Fragments is called. |
| **FINE** | Tracks screen-visits and onClick events from components such as Buttons, ImageButtons, RatingBars |


**Methods:**  

There are no methods.

<!-- reusable-table-boundary -->

---
---



# Overview


Integrating Synerise Mobile (Android, iOS, React Native, Flutter) SDKs in your mobile application has many benefits, such as:

- **Time-saving and low effort** - The integration is quick, allowing you to get started right away without spending time configuring or managing session tokens. Synerise stores customer tokens (both anonymous and recognized), manages their validity, refreshes and handles the logic of log-ins and log-outs. The integration is quick and you'll be able to secure user's information in no time.
- **Safety guaranteed** - We have a highly secure and encrypted infrastructure: all sensitive data is encrypted in storage and the communication between the servers and the application is encrypted and secured well, which is proven by successfully passed audits.
- **Automatic event tracking** - All customers' activities (events) in a mobile application are tracked in real time and sent in batches to Synerise. This way, you can use the Synerise Decision Hub to analyze the customers' behavior in your mobile app.  
    
  <div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

  There is no auto-tracking option for React Native. To send events to Synerise, you must configure triggers which record and send events to Synerise.

  </div></div></div>

- **Send push notifications** - Integrating your mobile app with Synerise Mobile SDK facilitates push notifications, which you can use to communicate with your customers. All interactions related to push notifications are collected as events, such as: opening a push notification, clicking a link in the notification, rejecting the notification, and so on. Based on [these events](/developers/mobile-sdk/event-tracking#predefined-event-list), you can measure the results of your push notification campaigns in the Synerise Decision Hub.
- **Send in-app messages** - In-app messages allow you to display any creation in a mobile application and implement use cases such as [abandoned cart](/use-cases/abandoned-basket-inapp), [price drop notifications](/use-cases/in-app-price-drop-last-seen-products), sending out discount codes, or implement any information campaign, such as application update. In contrast to push notifications which are sent (pushed) to the app user by Synerise, in-app messages are requested (pulled) by the user’s device through Synerise mobile SDK and they doesn't require a marketing agreement to be displayed.
- **Display recommendations and promotions** - Your mobile app can be a distribution channel where you can display [AI-based recommendations](/docs/ai-hub/recommendations-v2) and [promotions](/docs/ai-hub/personalized-promotions) which you can create in Synerise. Because the SDK keeps the customer context, actions such as fetching a recommendation or a promotion require only one SDK call.
- **Build your application with Synerise Documents** - This feature allows you to build your mobile application based on [documents](/docs/assets/documents) in which you can include [promotions](/docs/ai-hub/personalized-promotions), [recommendations](/docs/ai-hub/recommendations-v2), [dynamic content](/docs/campaign/dynamiccontent) without releasing a new version of your app.

## What's next
---
Proceed to [Installation and configuration](/developers/mobile-sdk/installation-and-configuration). 


# SDK Lifecycle


## InitializationConfig
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRInitializationConfig.h  
  
**Inherits from:**  
[NSObject](https://developer.apple.com/documentation/objectivec/nsobject)  
  
**Declaration**:  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-325">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-325-0" data-tab-group="tabgrp-325" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-325-1" data-tab-group="tabgrp-325">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-325-0" data-tab-group="tabgrp-325" data-tab-active="true">

```Swift
class InitializationConfig: NSObject
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-325-1" data-tab-group="tabgrp-325">

```Objective-C
@interface SNRInitializationConfig: NSObject
```

</div>
</div>


**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **requestValidationSalt** | String | yes | [Simple Profile Authentication](/developers/mobile-sdk/user-identification-and-authorization/simple-authentication) salt |

<!-- reusable-table-boundary -->

---
---

## Settings
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRSettings.h  
  
**Inherits From:**  
[NSObject](https://developer.apple.com/documentation/objectivec/nsobject)  
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-326">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-326-0" data-tab-group="tabgrp-326" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-326-1" data-tab-group="tabgrp-326">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-326-0" data-tab-group="tabgrp-326" data-tab-active="true">

```Swift
class Settings: NSObject
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-326-1" data-tab-group="tabgrp-326">

```Objective-C
@interface SNRSettings : NSObject
```

</div>
</div>

  
**Properties:**
| Property | Type | Description |
| --- | --- | --- |
| **sdk** | GeneralSettings | [General settings](/developers/mobile-sdk/settings#general) - This group contains options related to the general functioning of mobile SDK |
| **notifications** | NotificationsSettings | [Notifications settings](/developers/mobile-sdk/settings#notifications) - This group contains options related to push notifications |
| **tracker** | TrackerSettings | [Tracker](/developers/mobile-sdk/settings#tracker) - This group contains options related to tracking the customer activities in a mobile application |
| **inAppMessaging** | InAppMessagingSettings | [In-app messaging](/developers/mobile-sdk/settings#in-app-messaging) - This group contains options related to the [in-app messages](/docs/campaign/in-app-messages) feature |
| **injector** | InjectorSettings | [Injector](/developers/mobile-sdk/settings#injector) - This group contains options related to displaying [campaigns](/docs/campaign/Mobile) |
  
**Note:**  
Learn more about settings [here](/developers/mobile-sdk/settings)

<!-- reusable-table-boundary -->

---
---

## TrackerAutoTrackMode
**Declared In:**  
Headers/SNRTrackerAutoTrackingSettings.h  
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

`eager` mode was removed in SDK version 5.0.0.

</div></div></div>


**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-327">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-327-0" data-tab-group="tabgrp-327" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-327-1" data-tab-group="tabgrp-327">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-327-0" data-tab-group="tabgrp-327" data-tab-active="true">

```Swift
enum TrackerAutoTrackMode: Int {
    plain,
    fine,
    disabled
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-327-1" data-tab-group="tabgrp-327">

```Objective-C
typedef NS_ENUM(NSInteger, SNRTrackerAutoTrackMode) {
    SNRTrackerAutoTrackModePlain,
    SNRTrackerAutoTrackModeFine,
    SNRTrackerAutoTrackModeDisabled
    
}
```

</div>
</div>




# Sample projects on Github


- [Github sample projects - Android](https://github.com/Synerise/android-sdk)
- [Github sample projects - iOS](https://github.com/Synerise/synerise-ios-sdk)
- [Github sample projects - React Native](https://github.com/Synerise/react-native-synerise-sdk)
- [Github sample projects - Flutter](https://github.com/Synerise/synerise-flutter-sdk)


# Modules


### Synerise
<!-- reusable-table-boundary -->

Main Synerise module responsible for whole SDK. This class is responsible for initialization of SDK.

**Declared In:**  
`com.synerise.sdk.core.Synerise`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-124">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-124-0" data-tab-group="tabgrp-124" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-124-1" data-tab-group="tabgrp-124">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-124-0" data-tab-group="tabgrp-124" data-tab-active="true">

```Java
public class Synerise
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-124-1" data-tab-group="tabgrp-124">

```Kotlin
class Synerise
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **settings** | [Settings](/developers/mobile-sdk/class-reference/android/lifecycle#settings) | no | - | Configuration of whole SDK |


**Initializers:**  

There are no initializers.



**Methods:**  


Method to get applicationContext.

<pre><code class="language-java">public static Context getApplicationContext()</code></pre>



---

Method that generates the document assigned to a slug. 

<pre><code class="language-java">public static String getClientApiKey()</code></pre>



---

Get application ID.

<pre><code class="language-java">public static String getAppId()</code></pre>



---

Get base URL.

<pre><code class="language-java">public static String getBaseUrl()</code></pre>



---

Get flag indicating debugMode state.

<pre><code class="language-java">public static boolean getSyneriseDebugMode()</code></pre>



---

<!-- reusable-table-boundary -->

---
---

### Client
Module responsible for all operations connected with a profile (formerly client). 

**Declared In:**  
`com.synerise.sdk.client.Client`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-125">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-125-0" data-tab-group="tabgrp-125" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-125-1" data-tab-group="tabgrp-125">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-125-0" data-tab-group="tabgrp-125" data-tab-active="true">

```Java
public abstract class Client
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-125-1" data-tab-group="tabgrp-125">

```Kotlin
abstract class Client
```

</div>
</div>


**Properties:**  

There are no properties.

**Initializers:**  

There are no initializers.

**Methods:**  

This method sets ClientStateChangeListener to get optional callbacks. 

<pre><code class="language-java">public static void setOnClientStateChangeListener(OnClientStateChangeListener listener)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-authentication#set-client-state-change-listener)

---

This method removes ClientStateChangeListener. 

<pre><code class="language-java">public static void removeClientStateChangeListener()</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-authentication#remove-client-state-change-listener)

---

This method changes a Profile (formerly Client) API key dynamically.

<pre><code class="language-java">public static void changeApiKey(@NonNull String apiKey)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/lifecycle#change-profile-api-key-dynamically)

---
This method changes a Profile (formerly Client) API key dynamically, with additional parameters.

<pre><code class="language-java">public static void changeApiKey(String apiKey, InitializationConfig initializationConfig)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/lifecycle#change-profile-api-key-dynamically-with-config)

---

This method registers a new customer with an email, password, and optional data.

<pre><code class="language-java">public static IApiCall registerAccount(@NonNull RegisterClient registerClient)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-authentication#register-customer-account)

---

This method activates a customer with email.

<pre><code class="language-java">public static IApiCall requestAccountActivation(String email)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-authentication#request-customer-account-activation)

---

This method confirms a customer account with the confirmation token.

<pre><code class="language-java">public static IApiCall confirmAccountActivation(String token)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-authentication#confirm-customer-account-activation)

---

This method requests a customer's account registration process with the PIN code.

<pre><code class="language-java">public static IApiCall requestAccountActivationByPin(String email)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-authentication#request-customer-account-activation-by-pin)

---

This method confirms a customer's account registration process with the PIN code.

<pre><code class="language-java">public static IApiCall confirmAccountActivationByPin(String pinCode, String email)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-authentication#confirm-customer-account-activation-by-pin)

---

This method signs a customer in to obtain a JSON Web Token (JWT) which can be used in subsequent requests.

<pre><code class="language-java">public static IApiCall signIn(@NonNull String email, @NonNull String password)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-authentication#sign-in-a-customer)

---

This method signs a customer in to obtain a JSON Web Token (JWT) which can be used in subsequent requests.

<pre><code class="language-java">public static IDataApiCall&lt;AuthConditions&gt; signInConditionally(@NonNull String email, @NonNull String password)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-authentication#sign-in-a-customer-conditionally)

---

This method authenticates a customer with OAuth, Facebook, Google, Apple, or Synerise.

<pre><code class="language-java">public static IApiCall authenticate(@NonNull String token, @NonNull ClientIdentityProvider provider, @Nullable Agreements agreements, @Nullable Attributes attributes, @Nullable String authId)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-authentication#authenticate-customer-by-identityprovider)

---

This method authenticates a customer with OAuth, Facebook, Google, Apple, or Synerise.

<pre><code class="language-java">public static IDataApiCall&lt;AuthConditions&gt; authenticateConditionally(@NonNull String token, @NonNull ClientIdentityProvider provider, @Nullable Agreements agreements, @Nullable Attributes attributes, @Nullable String authId)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-authentication#authenticate-customer-conditionally-by-identityprovider)

---

This method authenticates a customer with OAuth.

<pre><code class="language-java">public static IApiCall authenticateByOAuth(@NonNull String accessToken, @Nullable Agreements agreements, @Nullable Attributes attributes, @Nullable String authId)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-authentication#authenticate-customer-by-oauth-with-registration) - **REMOVED in version 6.0.0**

---

This method authenticates a customer with OAuth.

<pre><code class="language-java">public static IApiCall authenticateByOAuthIfRegistered(@NonNull String accessToken, @Nullable String authId)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-authentication#authenticate-customer-by-oauth-without-registration) - **REMOVED in version 6.0.0**

---

This method authenticates a customer with Facebook.

<pre><code class="language-java">public static IApiCall authenticateByFacebook(@NonNull String facebookToken, @Nullable Agreements agreements, @Nullable Attributes attributes, @Nullable String authId)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-authentication#authenticate-customer-by-facebook-with-registration) - **REMOVED in version 6.0.0**

---

This method authenticates a customer with Facebook.

<pre><code class="language-java">public static IApiCall authenticateByFacebookIfRegistered(@NonNull String facebookToken, @Nullable String authId)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-authentication#authenticate-customer-by-facebook-without-registration) - **REMOVED in version 6.0.0**

---

This method signs in a customer in with the provided token payload.

<pre><code class="language-java">public static IApiCall authenticateWithTokenPayload(TokenPayload tokenPayload, @NonNull String authId)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-authentication#authenticate-customer-with-token-payload)

---

This method authenticates a customer with Simple Profile Authentication.

<pre><code class="language-java">public static IApiCall simpleAuthentication(ClientData clientData, String authId)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-authentication#authenticate-customer-via-simple-profile-authentication)

---

This method checks if a customer is signed in (via Synerise Authentication - RaaS, OAuth, Facebook, Apple).

<pre><code class="language-java">public static boolean isSignedIn()</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#check-if-a-customer-is-signed-in-via-raas-oauth-facebook-apple)

---

This method checks if a customer is signed in (via Simple Profile Authentication).

<pre><code class="language-java">public static boolean isSignedInViaSimpleAuthentication()</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-authentication#check-if-a-customer-is-signed-in-via-simple-profile-authentication)

---

This method signs out a customer out.

<pre><code class="language-java">public static void signOut()</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-authentication#sign-out-customer)

---

This method signs out a customer out with a chosen mode.

<pre><code class="language-java">public static void signOut(ClientSignOutMode mode)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-authentication#sign-out-customer-with-mode) - **REMOVED in version 6.0.0**

---

This method signs out a customer out with a chosen mode and Determines if the method should sign out all devices

<pre><code class="language-java">public static IApiCall signOut(ClientSignOutMode mode, Boolean signOutFromAllDevices)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-authentication#sign-out-customer-with-mode-or-from-all-devices)

---

This method refreshes the customer’s current token.

<pre><code class="language-java">public static IApiCall refreshToken()</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-session#refresh-customer-token)

---

This method retrieves the customer’s current, active token.

<pre><code class="language-java">public static IDataApiCall&lt;Token&gt; retrieveToken()
    [(Click for more details)](/developers/mobile-sdk/method-reference/android/client-session#get-customer-token)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-session#retrieve-customer-token)

---

This method retrieves the customer’s current UUID.

<pre><code class="language-java">public static String getUuid()</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-session#get-current-customer-uuid)

---

Retrieves the current UUID or generates a new one from a seed.

<pre><code class="language-java">public static String getUuidForAuthentication(@NonNull String authId)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-session#get-customer-uuid-for-use-in-authentication)

---

This method regenerates the UUID and clears the authentication token, login session, custom email, and custom identifier.

<pre><code class="language-java">public static boolean regenerateUuid()</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-session#regenerate-customer)

---

This method regenerates the UUID and clears the authentication token, login session, custom email, and custom identifier.

<pre><code class="language-java">public static boolean regenerateUuid(String clientIdentifier)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-session#regenerate-customer-with-identifier)

---

This method destroys the session completely.

<pre><code class="language-java">public static void destroySession()</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-session#destroy-current-session)

---

This method gets a customer’s account information.

<pre><code class="language-java">public static IDataApiCall&lt;GetAccountInformation&gt; getAccount()</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-account#get-customer-account-information)

---

This method retrieves events for an authenticated customer.

<pre><code class="language-java">public static IDataApiCall&lt;List&lt;ClientEventData&gt;&gt; getEvents(ClientEventsQuery clientEventsQuery)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/tracking#get-customers-events)

---

This method updates a customer’s account’s basic information (without identification data: uuid, customId, email).

<pre><code class="language-java">public static IApiCall updateAccountBasicInformation(@NonNull UpdateAccountBasicInformation accountInformation)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-account#update-customer-account-basic-information)

---

This method updates a customer’s account information.

<pre><code class="language-java">public static IApiCall updateAccount(@NonNull UpdateAccountInformation accountInformation)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-account#update-customer-account-information)

---

This method requests a customer’s password reset with email.

<pre><code class="language-java">public static IApiCall requestPasswordReset(@NonNull PasswordResetRequest resetRequest)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-account#request-password-reset-for-customer-account)

---

This method confirm a customer’s password reset with the new password and token provided by password reset request.

<pre><code class="language-java">public static IApiCall confirmPasswordReset(@NonNull PasswordResetConfirmation resetConfirmation)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-account#confirm-password-reset-for-customer-account)

---

This method changes a customer’s password.

<pre><code class="language-java">public static IApiCall changePassword(@NonNull String oldPassword, @NonNull String password)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-account#change-customers-account-password)

---

This method requests a customer's email change.

<pre><code class="language-java">public static IApiCall requestEmailChange(String email, String password, @Nullable String externalToken, @Nullable String authId)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-account#request-email-change-for-customer-account)

---

This method confirms an email change.

<pre><code class="language-java">public static IApiCall confirmEmailChange(String token, boolean newsletterAgreement)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-account#confirm-email-change-for-customer-account)

---

Requests a customer's phone update. A confirmation code is sent to the phone number.

<pre><code class="language-java">public static IApiCall requestPhoneUpdate(String phone)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-account#request-phone-update-on-customer-account)

---

This method confirms a phone number update. This action requires the new phone number and confirmation code as parameters.

<pre><code class="language-java">public static IApiCall confirmPhoneUpdate(String phone, String confirmationCode, @Nullable Boolean smsAgreement)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-account#confirm-phone-update-on-customer-account)

---

This method deletes a customer's account.

<pre><code class="language-java">public static IApiCall deleteAccount(String clientAuthFactor, ClientIdentityProvider clientIdentityProvider, @Nullable String authId)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-account#delete-customer-account-by-identity-provider)

---

This method deletes a customer's account.

<pre><code class="language-java">public static IApiCall deleteAccount(String password)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-account#delete-customer-account) - **REMOVED in version 6.0.0**

---

This method deletes a customer's account by OAuth.

<pre><code class="language-java">public static IApiCall deleteAccountByOAuth(String accessToken, @Nullable String uuid)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-account#delete-customer-account-by-oauth) - **REMOVED in version 6.0.0**

---

This method deletes a customer's account by Facebook.

<pre><code class="language-java">public static IApiCall deleteAccountByFacebook(String facebookToken, @Nullable String uuid)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/client-account#delete-customer-account-by-facebook) - **REMOVED in version 6.0.0**

---

This method passes the Firebase Token to Synerise for notifications and doesn't update the agreement of the profile.

<pre><code class="language-java">public static IApiCall registerForPush(@NonNull String firebaseId)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/campaigns#register-for-push-notifications-without-agreement)

---

This method passes the Firebase Token to Synerise for notifications.

<pre><code class="language-java">public static IApiCall registerForPush(@NonNull String firebaseId, boolean mobilePushAgreement)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/campaigns#register-for-push-notifications)

--- 

---
---

### Tracker
Module responsible for sending events. 

**Declared In:**  
`com.synerise.sdk.event.Tracker`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-126">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-126-0" data-tab-group="tabgrp-126" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-126-1" data-tab-group="tabgrp-126">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-126-0" data-tab-group="tabgrp-126" data-tab-active="true">

```Java
public abstract class Tracker
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-126-1" data-tab-group="tabgrp-126">

```Kotlin
abstract class Tracker
```

</div>
</div>


**Properties:**  

There are no properties.

**Initializers:**  

There are no initializers.

**Methods:**  


This method sets a custom identifier in the parameters of every event.

<pre><code class="language-java">public static void setCustomIdentifier(String customIdentifier)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/tracking#set-custom-identifier-for-events)

---

This method sets a custom email in the parameters of every event.

<pre><code class="language-java">public static void setCustomEmail(String customEmail)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/tracking#set-custom-email-for-events)

---

This method sends an event.

<pre><code class="language-java">public static void send(Event event)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/tracking#send-event)

---

This method forces sending the events from the queue to the server.

<pre><code class="language-java">public static void flush()</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/tracking#flush-events-from-tracker)

---

---
---

### Injector
<!-- reusable-table-boundary -->

Module responsible for handling push notifications and in-app communication.

**Declared In:**  
`com.synerise.sdk.injector.Injector`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-127">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-127-0" data-tab-group="tabgrp-127" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-127-1" data-tab-group="tabgrp-127">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-127-0" data-tab-group="tabgrp-127" data-tab-active="true">

```Java
public abstract class Injector
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-127-1" data-tab-group="tabgrp-127">

```Kotlin
abstract class Injector
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Description |
|---|---|---|---|
| inAppContext | HashMap&lt;String, Object&gt; | No | The global context used for personalizing in-app message content. This property is shared between overlay and inline in-app messages |

**Initializers:**  

There are no initializers.

**Methods:**  

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.

<pre><code class="language-java">public static void closeInAppMessage(String campaignHash)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/campaigns#close-in-app-message)

---

This method handles a notification payload and starts activity.

<pre><code class="language-java">public static boolean handlePushPayload(Bundle bundle)
public static boolean handlePushPayload(Map&lt;String, String&gt; pushPayload)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/campaigns#handle-synerise-push-notification)

---

This method decrypts the notification payload. 

<pre><code class="language-java">public static Map&lt;String, String&gt; decryptPushPayload(Map&lt;String, String&gt; pushPayload) throws DecryptionException</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/campaigns#decrypt-push-notification)

---

This method verifies if a notification is encrypted.

<pre><code class="language-java">public static boolean isPushEncrypted(Map&lt;String, String&gt; pushPayload)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/campaigns#check-if-push-notification-is-encrypted)

---

This method verifies if a notification was sent by Synerise.

<pre><code class="language-java">public static boolean isSynerisePush(Map&lt;String, String&gt; pushPayload)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/campaigns#check-if-push-notification-is-from-synerise)

---

This method verifies if a notification's sender is Synerise and if the notification is a Silent Command.

<pre><code class="language-java">public static boolean isSilentCommand(Map&lt;String, String&gt; pushPayload)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/campaigns#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 SDK Command.

<pre><code class="language-java">public static boolean isSilentCommandSdk(Map&lt;String, String&gt; pushPayload)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/campaigns#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 Simple Push campaign

<pre><code class="language-java">public static boolean isSyneriseSimplePush(Map&lt;String, String&gt; pushPayload)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/campaigns#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 Banner campaign.

<pre><code class="language-java">public static boolean isSyneriseBanner(Map&lt;String, String&gt; pushPayload)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/campaigns#check-if-push-notification-is-a-banner-campaign) - **REMOVED in version 6.0.0**

---

This method converts push payload into SilentCommand object. 

<pre><code class="language-java">public static SilentCommand getSilentCommand(Map&lt;String, String&gt; payload) throws ValidationException</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/campaigns#get-a-silent-command)

---

This method fetches a walkthrough.

<pre><code class="language-java">public static void getWalkthrough()</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/campaigns#get-walkthrough) - **REMOVED in version 6.0.0**

---

This method shows a walkthrough when it is loaded.

<pre><code class="language-java">public static boolean showWalkthrough()</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/campaigns#show-walkthrough) - **REMOVED in version 6.0.0**

---

This method checks if a walkthrough is loaded.

<pre><code class="language-java">public static boolean isWalkthroughLoaded()</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/campaigns#check-if-walkthrough-is-loaded) - **REMOVED in version 6.0.0**

---

This method checks if the walkthrough is unique compared to the previous one.

<pre><code class="language-java">public static boolean isLoadedWalkthroughUnique()</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/campaigns#check-if-loaded-walkthrough-is-unique) - **REMOVED in version 6.0.0**

---

This method fetches banners set for mobile campaigns and caches the valid ones.

<pre><code class="language-java">public static void fetchBanners()
public static void fetchBanners(@NonNull final DataActionListener&lt;List&lt;TemplateBanner&gt;&gt; successListener,
                                    @NonNull final DataActionListener&lt;ApiError&gt; errorListener)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/campaigns#fetch-banners)- **REMOVED in version 6.0.0**

---

This method provides valid banners directly from SDK cache.

<pre><code class="language-java">public static List&lt;TemplateBanner&gt; getBanners()</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/campaigns#get-banners)

---

This method shows a banner immediately.

<pre><code class="language-java">public static void showBanner(TemplateBanner banner, boolean markPresented)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/campaigns#show-banner)- **REMOVED in version 6.0.0**

---

This method fetches Push Notifications set for mobile campaigns.

<pre><code class="language-java">public static IDataApiCall&lt;List&lt;SynerisePushResponse&gt;&gt; getPushes()</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/campaigns#get-pushes)

---

<!-- reusable-table-boundary -->

---
---

### Promotions
Module responsible for managing promotions.

**Declared In:**  
`com.synerise.sdk.promotions.Promotions`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-128">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-128-0" data-tab-group="tabgrp-128" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-128-1" data-tab-group="tabgrp-128">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-128-0" data-tab-group="tabgrp-128" data-tab-active="true">

```Java
public abstract class Promotions
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-128-1" data-tab-group="tabgrp-128">

```Kotlin
abstract class Promotions
```

</div>
</div>


**Properties:**  

There are no properties.

**Initializers:**  

There are no initializers.

**Methods:**  


This method retrieves all available promotions that are defined for a customer.

<pre><code class="language-java">public static IDataApiCall&lt;PromotionResponse&gt; getPromotions()</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/promotions#get-all-promotions-of-a-customer)

---

This method retrieves all available promotions that are defined for a customer.

<pre><code class="language-java">public static IDataApiCall&lt;PromotionResponse&gt; getPromotions(PromotionsApiQuery promotionsApiQuery)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/promotions#get-all-promotions-of-a-customer)

---

This method retrieves the promotion with the specified UUID.

<pre><code class="language-java">public static IDataApiCall&lt;SinglePromotionResponse&gt; getPromotionByUuid(@NonNull String uuid)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/promotions#get-promotion-by-uuid)

---

This method retrieves the promotion with the specified code.

<pre><code class="language-java">public static IDataApiCall&lt;SinglePromotionResponse&gt; getPromotionByCode(@NonNull String code)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/promotions#get-promotion-by-code)

---

This method activates the promotion with the specified UUID.

<pre><code class="language-java">public static IApiCall activatePromotionByUuid(@NonNull String uuid)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/promotions#activate-promotion-by-uuid)

---

This method activates the promotion with the specified code.

<pre><code class="language-java">public static IApiCall activatePromotionByCode(@NonNull String code)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/promotions#activate-promotion-by-code)

---

This method deactivates the promotion with the specified UUID.

<pre><code class="language-java">public static IApiCall deactivatePromotionByUuid(@NonNull String uuid)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/promotions#deactivate-promotion-by-uuid)

---

This method deactivates the promotion with the specified code.

<pre><code class="language-java">public static IApiCall deactivatePromotionByCode(@NonNull String code)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/promotions#deactivate-promotion-by-code)

---

This method retrieves an assigned voucher code or assigns a voucher from a pool identified by UUID to the profile.

When the voucher is assigned for the first time, a [voucherCode.assigned](/docs/assets/events/event-reference/loyalty#vouchercodeassigned) event is produced.

<pre><code class="language-java">public static IDataApiCall&lt;AssignVoucherResponse&gt; getOrAssignVoucher(@NonNull String poolUuid)</code></pre>

 [(Click for more details)](/developers/mobile-sdk/method-reference/android/promotions#get-or-assign-voucher-from-pool)

---

This method assigns a voucher from a pool identified by UUID to the profile.

A [voucherCode.assigned](/docs/assets/events/event-reference/loyalty#vouchercodeassigned) event is produced.

<pre><code class="language-java">public static IDataApiCall&lt;AssignVoucherResponse&gt; assignVoucherCode(@NonNull String poolUuid)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/promotions#assign-voucher-code-from-pool)

---

This method retrieves voucher codes for a customer.

<pre><code class="language-java">public static IDataApiCall&lt;VoucherCodesResponse&gt; getAssignedVoucherCodes()</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/promotions#get-voucher-codes-assigned-to-customer)

--- 

---
---

### Content
Module responsible for managing documents, reccommendations and content widget. 

**Declared In:**  
`com.synerise.sdk.content.Content`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-129">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-129-0" data-tab-group="tabgrp-129" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-129-1" data-tab-group="tabgrp-129">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-129-0" data-tab-group="tabgrp-129" data-tab-active="true">

```Java
public abstract class Content
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-129-1" data-tab-group="tabgrp-129">

```Kotlin
abstract class Content
```

</div>
</div>


**Properties:**  

There are no properties.

**Initializers:**  

There are no initializers.

**Methods:**  

This method generates the document assigned to a slug.

<pre><code class="language-java">public static IDataApiCall&lt;Object&gt; getDocument(String slugName)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/content#get-document) - **REMOVED in version 6.0.0**

---

This method generates the document that is defined for the provided slug.

<pre><code class="language-java">public static IDataApiCall&lt;Document&gt; generateDocument(String slugName)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/content#generate-document)

---

This method generates the document that is defined for parameters provided in the query object.

<pre><code class="language-java">public static IDataApiCall&lt;Document&gt; generateDocument(DocumentApiQuery documentApiQuery)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/content#generate-document-with-query-parameters)

---

This method generates documents that are defined for parameters provided in the query object.

<pre><code class="language-java">public static IDataApiCall&lt;List&lt;Object&gt;&gt; getDocuments(DocumentsApiQuery documentsApiQuery)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/content#get-documents) - **REMOVED in version 6.0.0**

---

This method generates recommendations that are defined for the options provided. The recommendations are generated by using a document with an insert.  

For instructions, see ["Displaying AI recommendations > With documents and screen views"](/developers/mobile-sdk/displaying-recommendations/documents).

<pre><code class="language-java">public static IDataApiCall&lt;RecommendationResponse&gt; getRecommendations(String slugName, RecommendationRequestBody options)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/content#get-recommendations) - **REMOVED in version 6.0.0**

---

This method generates recommendations that are defined for the options provided. The recommendations are generated by using a document with an insert.  

For instructions, see ["Displaying AI recommendations > With documents and screen views"](/developers/mobile-sdk/displaying-recommendations/documents).

<pre><code class="language-java">public static IDataApiCall&lt;RecommendationResponse&gt; getRecommendationsV2(String slugName, RecommendationRequestBody options)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/content#get-recommendations-v2)

---

This method generates the customer's highest-priority screen view campaign.

<pre><code class="language-java">public static IDataApiCall&lt;ScreenViewResponse&gt; getScreenView()</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/content#get-screen-view) - **REMOVED in version 6.0.0**

---

This method generates a customer's highest-priority screen view campaign from the feed with the provided feed slug.

<pre><code class="language-java">public static IDataApiCall&lt;ScreenView&gt; generateScreenView(String feedSlug)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/content#generate-screen-view)

---

This method generates customer's highest-priority screen view campaign that is defined for parameters provided in the query object.

<pre><code class="language-java">public static IDataApiCall&lt;ScreenView&gt; generateScreenView(ScreenViewApiQuery screenViewApiQuery)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/android/content#generate-screen-view-with-query-parameters) 


# Android

## Class reference - Android


# Basics


## Prerequisites
---
Only for campaigns served by push notifications: [Configure push notifications](/developers/mobile-sdk/configuring-push-notifications).

## Overview
---
Synerise campaigns are served in two ways:
- By Push Notifications, which means that the campaigns are delivered as a push notification:
  - Simple push
  - Silent push

- By Synerise backend, which means that the campaign is retrieved by SDK through API:
  - In-app messages


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

You can create each campaign type in the Synerise app. [Full documentation is available at this link](/docs/campaign/Mobile).

</div></div></div>


## Synerise push notification structure
---
Each notification follows this basic structure corresponding to the operating system:


<div class="content-tabs" data-tab-group="tabgrp-23">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-23-0" data-tab-group="tabgrp-23" data-tab-active="true">Android</button><button class="tab-button" data-tab-id="tabgrp-23-1" data-tab-group="tabgrp-23">iOS</button></div>

<div class="tab-panel" data-tab-id="tabgrp-23-0" data-tab-group="tabgrp-23" data-tab-active="true">

<pre><code class="language-json">{
  "data": {
    "issuer": "Synerise",
    "message-type": "static-content",
    "content-type": "simple-push",
    "content": {
      &lt;&lt;campaign content&gt;&gt;
    }
  }
}</code></pre>

</div>

<div class="tab-panel" data-tab-id="tabgrp-23-1" data-tab-group="tabgrp-23">

<pre><code class="language-json">{
  "aps": {
    &lt;&lt;Apple params for iOS notification&gt;&gt;
  },    
  "issuer": "Synerise",
  "message-type": "static-content",
  "content-type": "simple-push",
  "content": {
    &lt;&lt;campaign content&gt;&gt;
  }
}</code></pre>

</div>
</div>


- `issuer` - in Synerise notifications, the issuer is always `Synerise`. If you want to handle notifications with your own methods, remember to change the `issuer` field. If `issuer` is set to `Synerise`, the payload is always handled by the Synerise SDK.
- `message-type` - specifies if the content is static or dynamic.
- `content-type` - specifies the type of content in the payload.
- `content` - the content of the message.

You can also react to Synerise push notifications in your own way, using the payloads presented earlier in this article.


## Checking push campaign type
---
You may need to know whether an incoming push notification comes from Synerise.


<div class="content-tabs" data-tab-group="tabgrp-24">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-24-0" data-tab-group="tabgrp-24" data-tab-active="true">Android</button><button class="tab-button" data-tab-id="tabgrp-24-1" data-tab-group="tabgrp-24">iOS</button><button class="tab-button" data-tab-id="tabgrp-24-2" data-tab-group="tabgrp-24">React Native</button><button class="tab-button" data-tab-id="tabgrp-24-3" data-tab-group="tabgrp-24">Flutter</button></div>

<div class="tab-panel" data-tab-id="tabgrp-24-0" data-tab-group="tabgrp-24" data-tab-active="true">

| Method | Description |
| --- | --- |
| [`Injector.isSynerisePush`](/developers/mobile-sdk/method-reference/android/campaigns#check-if-push-notification-is-from-synerise) | Returns 'true' if the notification comes from Synerise.<br/>It is validated by checking if the `issuer` of the push is `Synerise`. |
| [`Injector.isSyneriseSimplePush`](/developers/mobile-sdk/method-reference/android/campaigns#check-if-push-notification-is-a-simple-push-campaign) | Checks if the notification payload contains a Simple Push campaign. |
| [`Injector.isSyneriseBanner`](/developers/mobile-sdk/method-reference/android/campaigns#check-if-push-notification-is-a-banner-campaign) | Checks if the notification payload contains a Banner campaign. |
| [`Injector.isSyneriseSilentCommand`](/developers/mobile-sdk/method-reference/android/campaigns#check-if-push-notification-is-a-silent-command) | Checks if the notification payload contains a Silent Command campaign. |
| [`Injector.isSilentSdkCommand`](/developers/mobile-sdk/method-reference/android/campaigns#check-if-push-notification-is-a-silent-sdk-command) | Checks if the notification payload contains a Silent SDK Command campaign. |

</div>

<div class="tab-panel" data-tab-id="tabgrp-24-1" data-tab-group="tabgrp-24">

| Method | Description |
| --- | --- |
| [`Synerise.isSyneriseNotification`](/developers/mobile-sdk/method-reference/ios/campaigns#check-if-push-notification-is-from-synerise) | Returns 'true' if the notification comes from Synerise.<br/>It is validated by checking if the `issuer` of the push is `Synerise`. |
| [`Synerise.isSyneriseSimplePush`](/developers/mobile-sdk/method-reference/ios/campaigns#check-if-push-notification-is-a-simple-push-campaign) | Checks if the notification payload contains a Simple Push campaign. |
| [`Injector.isSyneriseBanner`](/developers/mobile-sdk/method-reference/ios/campaigns#check-if-push-notification-is-a-banner-campaign) | | [`Synerise.isSyneriseBanner`](/developers/mobile-sdk/method-reference/ios/campaigns#check-if-push-notification-is-a-banner-campaign) | Checks if the notification payload contains a Banner campaign. |
| [`Synerise.isSilentCommand`](/developers/mobile-sdk/method-reference/ios/campaigns#check-if-push-notification-is-a-silent-command) | Checks if the notification payload contains a Silent Command campaign. |
| [`Synerise.isSyneriseSilentSDKCommand`](/developers/mobile-sdk/method-reference/ios/campaigns#check-if-push-notification-is-a-silent-sdk-command) | Checks if the notification payload contains a Silent SDK Command campaign. |

</div>

<div class="tab-panel" data-tab-id="tabgrp-24-2" data-tab-group="tabgrp-24">

| Method | Description |
| --- | --- |
| [`Synerise.Notificationsl.isSyneriseNotification`](/developers/mobile-sdk/method-reference/react-native/campaigns#check-if-push-notification-is-from-synerise) | Returns 'true' if the notification comes from Synerise.<br/>It is validated by checking if the `issuer` of the push is `Synerise`. |
| [`Synerise.Notificationsl.isSyneriseSimplePush`](/developers/mobile-sdk/method-reference/react-native/campaigns#check-if-push-notification-is-a-simple-push-campaign) | Checks if the notification payload contains a Simple Push campaign. |
| [`Injector.isSyneriseBanner`](/developers/mobile-sdk/method-reference/react-native/campaigns#check-if-push-notification-is-a-banner-campaign) | | [`Synerise.Notificationsl.isSyneriseBanner`](/developers/mobile-sdk/method-reference/react-native/campaigns#check-if-push-notification-is-a-banner-campaign) | Checks if the notification payload contains a Banner campaign. |
| [`Synerise.Notificationsl.isSyneriseSilentCommand`](/developers/mobile-sdk/method-reference/react-native/campaigns#check-if-push-notification-is-a-silent-command) | Checks if the notification payload contains a Silent Command campaign. |
| [`Synerise.Notificationsl.isSyneriseSilentSDKCommand`](/developers/mobile-sdk/method-reference/react-native/campaigns#check-if-push-notification-is-a-silent-sdk-command) | Checks if the notification payload contains a Silent SDK Command campaign.|

</div>

<div class="tab-panel" data-tab-id="tabgrp-24-3" data-tab-group="tabgrp-24">

| Method | Description |
| --- | --- |
| [`Synerise.notifications.isSyneriseNotification`](/developers/mobile-sdk/method-reference/flutter/campaigns#check-if-push-notification-is-from-synerise) | Returns 'true' if the notification comes from Synerise.<br/>It is validated by checking if the `issuer` of the push is `Synerise`. |
| [`Synerise.notifications.isSyneriseSimplePush`](/developers/mobile-sdk/method-reference/flutter/campaigns#check-if-push-notification-is-a-simple-push-campaign) | Checks if the notification payload contains a Simple Push campaign. |
| [`Synerise.notifications.isSyneriseBanner`](/developers/mobile-sdk/method-reference/flutter/campaigns#check-if-push-notification-is-a-banner-campaign) | Checks if the notification payload contains a Banner campaign. |
| [`Synerise.notifications.isSilentCommand`](/developers/mobile-sdk/method-reference/flutter/campaigns#check-if-push-notification-is-a-silent-command) | Checks if the notification payload contains a Silent Command campaign. |
| [`Synerise.notifications.isSyneriseSilentSDKCommand`](/developers/mobile-sdk/method-reference/flutter/campaigns#check-if-push-notification-is-a-silent-sdk-command) | Checks if the notification payload contains a Silent SDK Command campaign. |

</div>
</div>


## Localizations in campaigns
---

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This feature is currently available only for iOS SDK, React Native (iOS), and Flutter SDK (iOS).

</div></div></div>


You may set your localization to support different languages in your application - see ["Localize some strings occurring in the SDK"](/developers/mobile-sdk/settings#localize-some-strings-occurring-in-the-sdk) in the SDK Settings.

**Available keys:**  
- **CTA button** in the [in-app alert of the Simple Push campaign](/developers/mobile-sdk/campaigns/simple-push#additional-in-app-alert-when-simple-push-is-received).
- **dismiss button** in the [in-app alert of the Simple Push campaign](/developers/mobile-sdk/campaigns/simple-push#additional-in-app-alert-when-simple-push-is-received).


<div class="content-tabs code-tabs" data-tab-group="tabgrp-21">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-21-0" data-tab-group="tabgrp-21" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-21-1" data-tab-group="tabgrp-21">Objective-C</button><button class="tab-button" data-tab-id="tabgrp-21-2" data-tab-group="tabgrp-21">JavaScript</button><button class="tab-button" data-tab-id="tabgrp-21-3" data-tab-group="tabgrp-21">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-21-0" data-tab-group="tabgrp-21" data-tab-active="true">

```Swift
Synerise.settings.sdk.localizable = [
  SNR_LOCALIZABLE_STRING_KEY_OK: "Go in!",
  SNR_LOCALIZABLE_STRING_KEY_CANCEL: "Go out!"
];
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-21-1" data-tab-group="tabgrp-21">

```Objective-C
SNRSynerise.settings.sdk.localizable = @[
  SNR_LOCALIZABLE_STRING_KEY_OK: @"Go in!",
  SNR_LOCALIZABLE_STRING_KEY_CANCEL: @"Go out!"
];
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-21-2" data-tab-group="tabgrp-21">

```JavaScript
Synerise.Settings.sdk.localizable = {
  LocalizableStringKeyOK: "Go in!",
  LocalizableStringKeyCancel: "Go out!"
};
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-21-3" data-tab-group="tabgrp-21">

```Dart
Synerise.settings.sdk.localizable = {
  Localizable.localizableStringKeyOk: "Go in!", 
  Localizable.localizableStringKeyCancel: "Go out!"
};
```

</div>
</div>


## Blocking campaigns
---

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This feature is available only for iOS SDK.

</div></div></div>


If you don't want to show any of the Synerise campaigns somewhere in your application or if there are View Controllers that should never be covered by Synerise activity (for example, banners), you can block the Synerise elements.

To do this, add the **SyneriseActivityNotAllowed** protocol in your View Controller declaration.

For example:


<div class="content-tabs code-tabs" data-tab-group="tabgrp-22">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-22-0" data-tab-group="tabgrp-22" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-22-1" data-tab-group="tabgrp-22">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-22-0" data-tab-group="tabgrp-22" data-tab-active="true">

```Swift
class SampleViewController: UIViewController, SyneriseActivityNotAllowed {

}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-22-1" data-tab-group="tabgrp-22">

```Objective-C
@interface SampleViewController: UIViewController <SNRSyneriseActivityNotAllowed>

@end
```

</div>
</div>


*When View Controller implements that protocol and Synerise tries to run an activity, the activity is skipped.*





























# SDK lifecycle


---
## Initialization
---
This method initializes Synerise.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This method must be called before any other Synerise SDK method and only once during the application's lifecycle.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/Synerise.js
  
**Related To:**  
[Synerise](/developers/mobile-sdk/class-reference/react-native/lifecycle#synerise)  
[SyneriseInitializer](/developers/mobile-sdk/class-reference/react-native/lifecycle#syneriseinitializer)  
  
**Class:**  
[PromotionsModule](/developers/mobile-sdk/class-reference/react-native/modules#promotions)
  
**Builder Parameters:**
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **withBaseUrl** | string | no | - | Synerise API custom environment base URL |
| **withApiKey** | string | yes | - | Synerise Profile (formerly Client) API Key |
| **withDebugModeEnabled** | **boolean** | no | - | Enables or disables console logs |
| **withCrashHandlingEnabled** | **boolean** | no | - | Enables or disables crash handling |
| **withSettings** | **object** | no | - | Settings that have to be configured before Synerise is initialized |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Before version 1.0.0, the `withApiKey` method was called `withClientApiKey`.

</div></div></div>


**Return Value:**  
No value is returned.
  
**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1240">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1240-0" data-tab-group="tabgrp-1240" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1240-0" data-tab-group="tabgrp-1240" data-tab-active="true">

```JavaScript
Synerise.Initializer()
  .withBaseUrl("YOUR_API_BASE_URL")
  .withApiKey('YOUR_PROFILE_API_KEY')
  .withDebugModeEnabled(true)
  .withCrashHandlingEnabled(true)
  .withSettings({
    sdk: {
      enabled: true
    })
    .init();
```

</div>
</div>


<!-- reusable-table-boundary -->

## Change Profile API key dynamically
---
This method changes a Profile (formerly Client) API key dynamically.
<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/Synerise.js
  
**Declaration:**  

<pre><code class="language-TypeScript">public static changeApiKey(ApiKey: string, config?: InitializationConfig | undefined)</code></pre>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Before version 1.0.0, this method was called `changeClientApiKey`.

</div></div></div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **apiKey** | string | yes | - | New API key |
| **config** | [InitializationConfig](/developers/mobile-sdk/class-reference/react-native/lifecycle#initializationconfig) | no | - | Object for additional initialization settings after the API key change |
  
**Return Value:**  
No value is returned.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1241">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1241-0" data-tab-group="tabgrp-1241" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1241-0" data-tab-group="tabgrp-1241" data-tab-active="true">

```JavaScript
Synerise.changeApiKey(apiKey);
```

</div>
</div>


<!-- reusable-table-boundary -->

## Change Profile API Key dynamically with config
---
<!-- reusable-table-boundary -->

This method changes a Profile (formerly Client) API key dynamically, with additional parameters. It can include a salt for [Simple Profile Authentication](/developers/mobile-sdk/user-identification-and-authorization/simple-authentication) requests.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.19.0 | 5.20.0 | 0.23.0 | 1.3.0 |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/Synerise.js
  
**Declaration:**  

<pre><code class="language-TypeScript">public static changeApiKey(ApiKey: string, config?: InitializationConfig | undefined)</code></pre>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Before version 1.0.0, this method was called `changeClientApiKey`.

</div></div></div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **apiKey** | string | yes | - | New API key |
| **config** | [InitializationConfig](/developers/mobile-sdk/class-reference/react-native/lifecycle#initializationconfig) | no | - | Object for additional initialization settings after the API key change |
  
**Return Value:**  
No value is returned.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1242">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1242-0" data-tab-group="tabgrp-1242" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1242-0" data-tab-group="tabgrp-1242" data-tab-active="true">

```JavaScript
Synerise.changeApiKey(apiKey);
```

</div>
</div>


<!-- reusable-table-boundary -->


# Modules


### Synerise
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRSynerise.h

**Inherits From:**  
[NSObject](https://developer.apple.com/documentation/objectivec/nsobject)

**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-353">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-353-0" data-tab-group="tabgrp-353" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-353-1" data-tab-group="tabgrp-353">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-353-0" data-tab-group="tabgrp-353" data-tab-active="true">

```Swift
class Synerise: NSObject
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-353-1" data-tab-group="tabgrp-353">

```Objective-C
@interface SNRSynerise : NSObject
```

</div>
</div>


**Properties:**

| Property | Type | Description |
| --- | --- | --- |
| **settings** | [Settings](/developers/mobile-sdk/class-reference/ios/lifecycle#settings) | Settings module to configure the SDK |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The `settings` property is statically accessible.

</div></div></div>


**Methods:**

This method sets an object for Synerise delegate methods.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-354">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-354-0" data-tab-group="tabgrp-354" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-354-1" data-tab-group="tabgrp-354">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-354-0" data-tab-group="tabgrp-354" data-tab-active="true">

```Swift
static func setDelegate(_: SyneriseDelegate)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-354-1" data-tab-group="tabgrp-354">

```Objective-C
+ (void)setDelegate:(nonnull id<SNRSyneriseDelegate>)delegate
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#synerise-delegate)

---

This method sets an object for notification delegate methods.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-355">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-355-0" data-tab-group="tabgrp-355" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-355-1" data-tab-group="tabgrp-355">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-355-0" data-tab-group="tabgrp-355" data-tab-active="true">

```Swift
static func setNotificationDelegate(_: NotificationDelegate)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-355-1" data-tab-group="tabgrp-355">

```Objective-C
+ (void)setNotificationDelegate:(id<SNRNotificationDelegate>)delegate
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#notification-delegate)

---

This method initializes Synerise.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-356">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-356-0" data-tab-group="tabgrp-356" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-356-1" data-tab-group="tabgrp-356">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-356-0" data-tab-group="tabgrp-356" data-tab-active="true">

```Swift
static func initialize(apiKey:)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-356-1" data-tab-group="tabgrp-356">

```Objective-C
+ (void)initializeWithApiKey:(nonnull NSString *)apiKey
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/lifecycle#initialization)

---

This method initializes Synerise SDK with custom environment settings.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-357">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-357-0" data-tab-group="tabgrp-357" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-357-1" data-tab-group="tabgrp-357">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-357-0" data-tab-group="tabgrp-357" data-tab-active="true">

```Swift
static func initialize(apiKey:baseUrl:)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-357-1" data-tab-group="tabgrp-357">

```Objective-C
+ (void)initializeWithApiKey:(nonnull NSString *)apiKey andBaseUrl:(nullable NSString *)baseUrl
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/lifecycle#initialize-with-custom-environment)

---

This method sets the salt string for request validation.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-358">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-358-0" data-tab-group="tabgrp-358" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-358-1" data-tab-group="tabgrp-358">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-358-0" data-tab-group="tabgrp-358" data-tab-active="true">

```Swift
static func setRequestValidationSalt(_: String?)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-358-1" data-tab-group="tabgrp-358">

```Objective-C
+ (void)setRequestValidationSalt:(nullable NSString *)string
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/lifecycle#set-request-validation-salt)

---

This method changes a Profile (formerly Client) API key dynamically.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-359">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-359-0" data-tab-group="tabgrp-359" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-359-1" data-tab-group="tabgrp-359">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-359-0" data-tab-group="tabgrp-359" data-tab-active="true">

```Swift
static func changeApiKey(apiKey: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-359-1" data-tab-group="tabgrp-359">

```Objective-C
+ (void)changeApiKey:(NSString *)apiKey
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/lifecycle#change-profile-api-key-dynamically)

---
This method changes a Profile (formerly Client) API key dynamically, with additional parameters.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-360">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-360-0" data-tab-group="tabgrp-360" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-360-1" data-tab-group="tabgrp-360">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-360-0" data-tab-group="tabgrp-360" data-tab-active="true">

```Swift
static func changeApiKey(_ apiKey: String, config: InitializationConfig?) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-360-1" data-tab-group="tabgrp-360">

```Objective-C
(void)changeApiKey:(NSString *)apiKey config:(nullable SNRInitializationConfig *)config;
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/lifecycle#change-profile-api-key-dynamically-with-config)

---

This method sets the Synerise SDK host application type.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-361">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-361-0" data-tab-group="tabgrp-361" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-361-1" data-tab-group="tabgrp-361">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-361-0" data-tab-group="tabgrp-361" data-tab-active="true">

```Swift
static func setHostApplicationType(_: HostApplicationType)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-361-1" data-tab-group="tabgrp-361">

```Objective-C
+ (void)setHostApplicationType:(SNRHostApplicationType)type
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/lifecycle#set-up-host-application-type)

---

This method sets the Synerise SDK plugin version.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-362">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-362-0" data-tab-group="tabgrp-362" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-362-1" data-tab-group="tabgrp-362">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-362-0" data-tab-group="tabgrp-362" data-tab-active="true">

```Swift
static func setHostApplicationSDKPluginVersion(_: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-362-1" data-tab-group="tabgrp-362">

```Objective-C
+ (void)setHostApplicationSDKPluginVersion:(NSString *)type
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/lifecycle#set-host-application-sdk-plugin-version)

---

This method enables or disables console logs from Synerise SDK.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-363">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-363-0" data-tab-group="tabgrp-363" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-363-1" data-tab-group="tabgrp-363">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-363-0" data-tab-group="tabgrp-363" data-tab-active="true">

```Swift
static func setDebugModeEnabled(_: Bool)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-363-1" data-tab-group="tabgrp-363">

```Objective-C
+ (void)setDebugModeEnabled:(BOOL)enabled
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/lifecycle#enable-debug-mode)

---

This method enables or disables crash handling by Synerise SDK.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-364">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-364-0" data-tab-group="tabgrp-364" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-364-1" data-tab-group="tabgrp-364">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-364-0" data-tab-group="tabgrp-364" data-tab-active="true">

```Swift
static func setCrashHandlingEnabled(_: Bool)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-364-1" data-tab-group="tabgrp-364">

```Objective-C
+ (void)setCrashHandlingEnabled:(BOOL)enabled
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/lifecycle#enable-crash-handling)

---

This method sets the notification categories (including Synerise categories) that your app supports.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-365">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-365-0" data-tab-group="tabgrp-365" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-365-1" data-tab-group="tabgrp-365">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-365-0" data-tab-group="tabgrp-365" data-tab-active="true">

```Swift
static func setNotificationCategories(_: Set<UNNotificationCategory>)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-365-1" data-tab-group="tabgrp-365">

```Objective-C
+ (void)setNotificationCategories:(NSSet<UNNotificationCategory *> *)notificationCategories
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#set-notification-categories)

---

This method sets identifiers for Background Tasks processing.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-366">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-366-0" data-tab-group="tabgrp-366" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-366-1" data-tab-group="tabgrp-366">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-366-0" data-tab-group="tabgrp-366" data-tab-active="true">

```Swift
static func setBackgroundTaskIdentifiers(_: [String])
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-366-1" data-tab-group="tabgrp-366">

```Objective-C
+ (void)setBackgroundTaskIdentifiers:(NSArray<NSString *> *)identifiers
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#set-notification-categories)

---

This method verifies if a notification was sent by Synerise.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-367">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-367-0" data-tab-group="tabgrp-367" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-367-1" data-tab-group="tabgrp-367">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-367-0" data-tab-group="tabgrp-367" data-tab-active="true">

```Swift
static func isSyneriseNotification(_: [AnyHashable: Any]) -> Bool
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-367-1" data-tab-group="tabgrp-367">

```Objective-C
+ (BOOL)isSyneriseNotification:(nonnull NSDictionary *)userInfo
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#check-if-push-notification-is-from-synerise)

---

This method verifies if a notification’s sender is Synerise and if the notification is a Simple Push campaign

<div class="content-tabs code-tabs" data-tab-group="tabgrp-368">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-368-0" data-tab-group="tabgrp-368" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-368-1" data-tab-group="tabgrp-368">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-368-0" data-tab-group="tabgrp-368" data-tab-active="true">

```Swift
static func isSyneriseSimplePush(_: [AnyHashable: Any]) -> Bool
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-368-1" data-tab-group="tabgrp-368">

```Objective-C
+ (BOOL)isSyneriseSimplePush:(nonnull NSDictionary *)userInfo
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#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 Banner campaign.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-369">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-369-0" data-tab-group="tabgrp-369" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-369-1" data-tab-group="tabgrp-369">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-369-0" data-tab-group="tabgrp-369" data-tab-active="true">

```Swift
static func isSyneriseBanner(_: [AnyHashable: Any]) -> Bool
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-369-1" data-tab-group="tabgrp-369">

```Objective-C
+ (BOOL)isSyneriseBanner:(nonnull NSDictionary *)userInfo
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#check-if-push-notification-is-a-banner-campaign) **REMOVED in version 5.0.0**

---

This method verifies if a notification's sender is Synerise and if the notification is a Silent Command.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-370">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-370-0" data-tab-group="tabgrp-370" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-370-1" data-tab-group="tabgrp-370">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-370-0" data-tab-group="tabgrp-370" data-tab-active="true">

```Swift
static func isSyneriseSilentCommand(_: [AnyHashable: Any]) -> Bool
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-370-1" data-tab-group="tabgrp-370">

```Objective-C
+ (BOOL)isSyneriseSilentCommand:(nonnull NSDictionary *)userInfo
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#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 SDK Command.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-371">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-371-0" data-tab-group="tabgrp-371" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-371-1" data-tab-group="tabgrp-371">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-371-0" data-tab-group="tabgrp-371" data-tab-active="true">

```Swift
static func isSyneriseSilentSDKCommand(_: [AnyHashable: Any]) -> Bool
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-371-1" data-tab-group="tabgrp-371">

```Objective-C
+ (BOOL)isSyneriseSilentSDKCommand:(nonnull NSDictionary *)userInfo
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#check-if-push-notification-is-a-silent-sdk-command)

---

This method verifies if a notification is encrypted.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-372">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-372-0" data-tab-group="tabgrp-372" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-372-1" data-tab-group="tabgrp-372">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-372-0" data-tab-group="tabgrp-372" data-tab-active="true">

```Swift
static func isNotificationEncrypted(_: [AnyHashable: Any]) -> Bool
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-372-1" data-tab-group="tabgrp-372">

```Objective-C
+ (BOOL)isNotificationEncrypted:(nonnull NSDictionary *)userInfo
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#check-if-push-notification-is-encrypted)

---

This method decrypts the notification payload.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-373">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-373-0" data-tab-group="tabgrp-373" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-373-1" data-tab-group="tabgrp-373">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-373-0" data-tab-group="tabgrp-373" data-tab-active="true">

```Swift
static func decryptNotification(_: [AnyHashable: Any]) -> [AnyHashable: Any]?
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-373-1" data-tab-group="tabgrp-373">

```Objective-C
+ (nullable NSDictionary *)decryptNotification:(nonnull NSDictionary *)userInfo
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#decrypt-push-notification)

---

This method handles a notification payload and starts activity.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-374">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-374-0" data-tab-group="tabgrp-374" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-374-1" data-tab-group="tabgrp-374">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-374-0" data-tab-group="tabgrp-374" data-tab-active="true">

```Swift
static func handleNotification(_: [AnyHashable: Any])
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-374-1" data-tab-group="tabgrp-374">

```Objective-C
+ (void)handleNotification:(nonnull NSDictionary *)userInfo
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#handle-synerise-push-notification)

---

This method handles a notification payload with a user interaction and starts activity.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-375">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-375-0" data-tab-group="tabgrp-375" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-375-1" data-tab-group="tabgrp-375">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-375-0" data-tab-group="tabgrp-375" data-tab-active="true">

```Swift
static func handleNotification(_: [AnyHashable: Any], actionIdentifier: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-375-1" data-tab-group="tabgrp-375">

```Objective-C
+ (void)handleNotification:(nonnull NSDictionary *)userInfo actionIdentifier:(nullable NSString *)actionIdentifier
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#handle-synerise-push-notification-with-action)

---


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

- Synerise Domain is declared as a global string constant - `SNRSyneriseDomain`
- Synerise Bundle Identifier is declared as a global string constant - `SNRSyneriseBundleIdentifier`

</div></div></div>


<!-- reusable-table-boundary -->

---
---

### Client
The module for managing customer account data, registration, authentication, and authorization.
  
**Declared In:**  
Headers/SNRClient.h  
  
**Related To:**  
[ClientStateDelegate](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#client-state-delegate)  
[ClientRegisterAccountContext](/developers/mobile-sdk/class-reference/ios/client#clientregisteraccountcontext)  
[ClientConditionalAuthResult](/developers/mobile-sdk/class-reference/ios/client#clientconditionalauthresult)  
[ClientConditionalAuthenticationContext](/developers/mobile-sdk/class-reference/ios/client#clientconditionalauthenticationcontext)  
[ClientAuthenticationContext](/developers/mobile-sdk/class-reference/ios/client#clientauthenticationcontext)  
[ClientOAuthAuthenticationContext](/developers/mobile-sdk/class-reference/ios/client#clientoauthauthenticationcontext)  
[ClientFacebookAuthenticationContext](/developers/mobile-sdk/class-reference/ios/client#clientfacebookauthenticationcontext)  
[ClientAppleSignInAuthenticationContext](/developers/mobile-sdk/class-reference/ios/client#clientapplesigninauthenticationcontext)  
[ClientAccountInformation](/developers/mobile-sdk/class-reference/ios/client#clientaccountinformation)  
[ClientUpdateAccountContext](/developers/mobile-sdk/class-reference/ios/client#clientupdateaccountcontext)  
[ClientUpdateAccountBasicInformationContext](/developers/mobile-sdk/class-reference/ios/client#clientupdateaccountbasicinformationcontext)  
[ClientPasswordResetRequestContext](/developers/mobile-sdk/class-reference/ios/client#clientpasswordresetrequestcontext)  
[ClientPasswordResetConfirmationContext](/developers/mobile-sdk/class-reference/ios/client#clientpasswordresetconfirmationcontext)  
[Token](/developers/mobile-sdk/class-reference/ios/client#token)  
  
**Inherits From:**  
[NSObject](https://developer.apple.com/documentation/objectivec/nsobject)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-376">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-376-0" data-tab-group="tabgrp-376" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-376-1" data-tab-group="tabgrp-376">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-376-0" data-tab-group="tabgrp-376" data-tab-active="true">

```Swift
class Client: NSObject
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-376-1" data-tab-group="tabgrp-376">

```Objective-C
@interface SNRTracker : NSObject
```

</div>
</div>

  
**Methods:**

This method sets an object for a customers's state delegate methods.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-377">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-377-0" data-tab-group="tabgrp-377" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-377-1" data-tab-group="tabgrp-377">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-377-0" data-tab-group="tabgrp-377" data-tab-active="true">

```Swift
static func setClientStateDelegate(_: ClientStateDelegate)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-377-1" data-tab-group="tabgrp-377">

```Objective-C
+ (void)setClientStateDelegate:(nonnull id<SNRClientStateDelegate>)delegate
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#client-state-delegate)

---

This method registers a new customer with an email, password, and optional data.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-378">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-378-0" data-tab-group="tabgrp-378" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-378-1" data-tab-group="tabgrp-378">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-378-0" data-tab-group="tabgrp-378" data-tab-active="true">

```Swift
static func registerAccount(context: ClientRegisterAccountContext, success: ((Bool) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-378-1" data-tab-group="tabgrp-378">

```Objective-C
+ (void)registerAccount:(nonnull SNRClientRegisterAccountContext *)context success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#register-customer-account)

---

This method confirms a customer account with the confirmation token.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-379">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-379-0" data-tab-group="tabgrp-379" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-379-1" data-tab-group="tabgrp-379">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-379-0" data-tab-group="tabgrp-379" data-tab-active="true">

```Swift
static func confirmAccountActivation(token: String, success: ((Bool) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-379-1" data-tab-group="tabgrp-379">

```Objective-C
+ (void)confirmAccount:(nonnull NSString *)token success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#confirm-customer-account-activation)

---

This method activates a customer with email.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-380">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-380-0" data-tab-group="tabgrp-380" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-380-1" data-tab-group="tabgrp-380">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-380-0" data-tab-group="tabgrp-380" data-tab-active="true">

```Swift
static func requestAccountActivation(email: String, success: ((Bool) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-380-1" data-tab-group="tabgrp-380">

```Objective-C
+ (void)requestAccountActivation:(nonnull NSString *)email success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#request-customer-account-activation)

---

This method requests a customer's account registration process with the PIN code.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-381">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-381-0" data-tab-group="tabgrp-381" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-381-1" data-tab-group="tabgrp-381">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-381-0" data-tab-group="tabgrp-381" data-tab-active="true">

```Swift
static func requestAccountActivationByPin(email: String, success: ((Bool) -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-381-1" data-tab-group="tabgrp-381">

```Objective-C
+ (void)requestAccountActivationByPinWithEmail:(nonnull NSString *)email success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(SNRApiError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#request-customer-account-activation-by-pin)

---

This method confirms a customer's account registration process with the PIN code.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-382">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-382-0" data-tab-group="tabgrp-382" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-382-1" data-tab-group="tabgrp-382">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-382-0" data-tab-group="tabgrp-382" data-tab-active="true">

```Swift
static func confirmAccountActivationByPin(pinCode: String, email: String, success: ((Bool) -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-382-1" data-tab-group="tabgrp-382">

```Objective-C
+ (void)confirmAccountActivationByPin:(nonnull NSString *)pinCode email:(nonnull NSString *)email success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(SNRApiError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#confirm-customer-account-activation-by-pin)

---

This method signs a customer in to obtain a JSON Web Token (JWT) which can be used in subsequent requests.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-383">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-383-0" data-tab-group="tabgrp-383" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-383-1" data-tab-group="tabgrp-383">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-383-0" data-tab-group="tabgrp-383" data-tab-active="true">

```Swift
static func signIn(email: String, password: String, success: ((Bool) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-383-1" data-tab-group="tabgrp-383">

```Objective-C
+ (void)signInWithEmail:(nonnull NSString *)email password:(nonnull NSString *)password success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#sign-in-a-customer)

---

This method signs a customer in to obtain a JSON Web Token (JWT) which can be used in subsequent requests.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-384">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-384-0" data-tab-group="tabgrp-384" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-384-1" data-tab-group="tabgrp-384">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-384-0" data-tab-group="tabgrp-384" data-tab-active="true">

```Swift
static func signInConditionally(email: String, password: String, success: ((ClientAuthenticationResult) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-384-1" data-tab-group="tabgrp-384">

```Objective-C
+ (void)signInConditionallyWithEmail:(nonnull NSString *)email password:(nonnull NSString *)password success:(nonnull void (^)(SNRClientAuthenticationResult *authResult))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#sign-in-a-customer-conditionally)

---

This method authenticates a customer with OAuth, Facebook, Google, Apple, or Synerise.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-385">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-385-0" data-tab-group="tabgrp-385" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-385-1" data-tab-group="tabgrp-385">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-385-0" data-tab-group="tabgrp-385" data-tab-active="true">

```Swift
static func authenticate(token: AnyObject, clientIdentityProvider: ClientIdentityProvider, authID: String?, context: ClientAuthenticationContext?, success: ((Bool) -> Void), failure: ((ApiError) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-385-1" data-tab-group="tabgrp-385">

```Objective-C
+ (void)authenticateWithToken:(id)token clientIdentityProvider:(SNRClientIdentityProvider)clientIdentityProvider authID:(nullable NSString *)authID context:(nullable SNRClientAuthenticationContext *)context success:(void (^)(BOOL isSuccess))success failure:(void (^)(SNRApiError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-by-identityprovider)

---

This method authenticates a customer with OAuth, Facebook, Google, Apple, or Synerise.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-386">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-386-0" data-tab-group="tabgrp-386" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-386-1" data-tab-group="tabgrp-386">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-386-0" data-tab-group="tabgrp-386" data-tab-active="true">

```Swift
static func authenticateConditionally(token: AnyObject, clientIdentityProvider: ClientIdentityProvider, authID: String?, context: ClientConditionalAuthenticationContext?, success: ((ClientAuthenticationResult) -> Void), failure: ((ApiError) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-386-1" data-tab-group="tabgrp-386">

```Objective-C
+ (void)authenticateConditionallyWithToken:(id)token clientIdentityProvider:(SNRClientIdentityProvider)clientIdentityProvider authID:(nullable NSString *)authID context:(nullable SNRClientConditionalAuthenticationContext *)context success:(void (^)(SNRClientAuthenticationResult *authResult))success failure:(void (^)(SNRApiError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-conditionally-by-identityprovider)


---

This method authenticates a customer with OAuth.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-387">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-387-0" data-tab-group="tabgrp-387" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-387-1" data-tab-group="tabgrp-387">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-387-0" data-tab-group="tabgrp-387" data-tab-active="true">

```Swift
static func authenticateByOAuth(accessToken: String, authID: String?, context: ClientOAuthAuthenticationContext?, success: ((Bool) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-387-1" data-tab-group="tabgrp-387">

```Objective-C
+ (void)authenticateByOAuthWithAccessToken:(nonnull NSString *)accessToken authID:(nullable NSString *)authID context:(nullable SNRClientOAuthAuthenticationContext *)context success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-by-oauth-with-registration) - **REMOVED in version 5.0.0**

---

This method authenticates a customer with OAuth.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-388">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-388-0" data-tab-group="tabgrp-388" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-388-1" data-tab-group="tabgrp-388">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-388-0" data-tab-group="tabgrp-388" data-tab-active="true">

```Swift
static func authenticateByOAuthIfRegistered(accessToken: String, authID: String?, success: ((Bool) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-388-1" data-tab-group="tabgrp-388">

```Objective-C
+ (void)authenticateByOAuthIfRegisteredWithAccessToken:(nonnull NSString *)accessToken authID:(nullable NSString *)authID success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-by-oauth-without-registration) - **REMOVED in version 5.0.0**

---

This method authenticates a customer with Facebook.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-389">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-389-0" data-tab-group="tabgrp-389" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-389-1" data-tab-group="tabgrp-389">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-389-0" data-tab-group="tabgrp-389" data-tab-active="true">

```Swift
static func authenticateByFacebook(facebookToken: String, authID: String?, context: ClientFacebookAuthenticationContext?, success: ((Bool) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-389-1" data-tab-group="tabgrp-389">

```Objective-C
+ (void)authenticateByFacebookWithFacebookToken:(nonnull NSString *)facebookToken authID:(nullable NSString *)authID context:(nullable SNRClientFacebookAuthenticationContext *)context success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-by-facebook-with-registration) - **REMOVED in version 5.0.0**

---

This method authenticates a customer with Facebook.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-390">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-390-0" data-tab-group="tabgrp-390" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-390-1" data-tab-group="tabgrp-390">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-390-0" data-tab-group="tabgrp-390" data-tab-active="true">

```Swift
static func authenticateByFacebookIfRegistered(facebookToken: String, authID: String?, success: ((Bool) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-390-1" data-tab-group="tabgrp-390">

```Objective-C
+ (void)authenticateByFacebookIfRegisteredWithFacebookToken:(nonnull NSString *)facebookToken authID:(nullable NSString *)authID success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-by-facebook-without-registration) - **REMOVED in version 5.0.0**

---

This method authenticates a customer with Sign In With Apple.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-391">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-391-0" data-tab-group="tabgrp-391" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-391-1" data-tab-group="tabgrp-391">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-391-0" data-tab-group="tabgrp-391" data-tab-active="true">

```Swift
static func authenticateByAppleSignIn(identityToken: Data, authID: String?, context: ClientAppleSignInAuthenticationContext?, success: ((Bool) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-391-1" data-tab-group="tabgrp-391">

```Objective-C
+ (void)authenticateByAppleSignInWithIdentityToken:(nonnull NSData *)identityToken authID:(nullable NSString *)authID context:(nullable SNRClientAppleSignInAuthenticationContext *)context success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-by-sign-in-with-apple-with-registration) - **REMOVED in version 5.0.0**

---

This method authenticates a customer with Sign In With Apple.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-392">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-392-0" data-tab-group="tabgrp-392" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-392-1" data-tab-group="tabgrp-392">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-392-0" data-tab-group="tabgrp-392" data-tab-active="true">

```Swift
static func authenticateByAppleSignInIfRegistered(identityToken: Data, authID: String?, success: ((Bool) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-392-1" data-tab-group="tabgrp-392">

```Objective-C
+ (void)authenticateByAppleSignInIfRegisteredWithIdentityToken:(nonnull NSData *)identityToken authID:(nullable NSString *)authID success:(nonnull void (^)(BOOL isSuccess))success failure:nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-by-sign-in-with-apple-without-registration) - **REMOVED in version 5.0.0**

---

This method signs in a customer in with the provided token payload.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-393">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-393-0" data-tab-group="tabgrp-393" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-393-1" data-tab-group="tabgrp-393">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-393-0" data-tab-group="tabgrp-393" data-tab-active="true">

```Swift
static func authenticate(tokenPayload: TokenPayload, authID: String, success: (() -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-393-1" data-tab-group="tabgrp-393">

```Objective-C
+ (void)authenticateWithTokenPayload:(SNRTokenPayload *)tokenPayload authID:(NSString *)authID success:(void (^)(void))success failure:(void (^)(SNRApiError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-with-token-payload)

---

This method authenticates a customer with Simple Profile Authentication.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-394">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-394-0" data-tab-group="tabgrp-394" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-394-1" data-tab-group="tabgrp-394">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-394-0" data-tab-group="tabgrp-394" data-tab-active="true">

```Swift
static func simpleAuthentication(data: ClientSimpleAuthenticationData, authID: String, success: (() -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-394-1" data-tab-group="tabgrp-394">

```Objective-C
+ (void)simpleAuthentication:(SNRClientSimpleAuthenticationData *)data authID:(NSString *)authID success:(void (^)(void))success failure:(void (^)(SNRApiError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-via-simple-profile-authentication)

---

This method checks if a customer is signed in (via Synerise Authentication - RaaS, OAuth, Facebook, Apple).

<div class="content-tabs code-tabs" data-tab-group="tabgrp-395">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-395-0" data-tab-group="tabgrp-395" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-395-1" data-tab-group="tabgrp-395">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-395-0" data-tab-group="tabgrp-395" data-tab-active="true">

```Swift
static func isSignedIn() -> Bool
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-395-1" data-tab-group="tabgrp-395">

```Objective-C
+ (BOOL)isSignedIn
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#check-if-a-customer-is-signed-in-via-raas-oauth-facebook-apple)

---

This method checks if a customer is signed in (via Simple Profile Authentication).

<div class="content-tabs code-tabs" data-tab-group="tabgrp-396">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-396-0" data-tab-group="tabgrp-396" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-396-1" data-tab-group="tabgrp-396">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-396-0" data-tab-group="tabgrp-396" data-tab-active="true">

```Swift
static func isSignedInViaSimpleAuthentication() -> Bool
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-396-1" data-tab-group="tabgrp-396">

```Objective-C
+ (BOOL)isSignedInViaSimpleAuthentication
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#check-if-a-customer-is-signed-in-via-simple-profile-authentication)

---

This method signs out a customer out.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-397">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-397-0" data-tab-group="tabgrp-397" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-397-1" data-tab-group="tabgrp-397">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-397-0" data-tab-group="tabgrp-397" data-tab-active="true">

```Swift
static func signOut()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-397-1" data-tab-group="tabgrp-397">

```Objective-C
+ (void)signOut
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#sign-out-customer)

---

This method signs out a customer out with a chosen mode.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-398">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-398-0" data-tab-group="tabgrp-398" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-398-1" data-tab-group="tabgrp-398">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-398-0" data-tab-group="tabgrp-398" data-tab-active="true">

```Swift
static func signOut(mode: ClientSignOutMode)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-398-1" data-tab-group="tabgrp-398">

```Objective-C
+ (void)signOutWithMode:(SNRClientSignOutMode)mode
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#sign-out-customer-with-mode) - **REMOVED in version 5.0.0**

---

This method signs out a customer out with a chosen mode and Determines if the method should sign out all devices

<div class="content-tabs code-tabs" data-tab-group="tabgrp-399">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-399-0" data-tab-group="tabgrp-399" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-399-1" data-tab-group="tabgrp-399">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-399-0" data-tab-group="tabgrp-399" data-tab-active="true">

```Swift
static func signOut(mode: ClientSignOutMode, fromAllDevices: Bool, success: (() -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-399-1" data-tab-group="tabgrp-399">

```Objective-C
+ (void)signOutWithMode:(SNRClientSignOutMode)mode fromAllDevices:(BOOL)fromAllDevices success:(void (^)(void))success failure:(void (^)(SNRApiError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#sign-out-customer-with-mode-or-from-all-devices)

---

This method refreshes the customer’s current token.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-400">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-400-0" data-tab-group="tabgrp-400" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-400-1" data-tab-group="tabgrp-400">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-400-0" data-tab-group="tabgrp-400" data-tab-active="true">

```Swift
static func refreshToken(success: ((Bool) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-400-1" data-tab-group="tabgrp-400">

```Objective-C
+ (void)refreshTokenWithSuccess:(nonnull void (^)(void))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-session#refresh-customer-token)

---

This method retrieves the customer’s current, active token.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-401">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-401-0" data-tab-group="tabgrp-401" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-401-1" data-tab-group="tabgrp-401">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-401-0" data-tab-group="tabgrp-401" data-tab-active="true">

```Swift
static func retrieveToken(success: ((Token) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-401-1" data-tab-group="tabgrp-401">

```Objective-C
+ (void)retrieveTokenWithSuccess:(nonnull void (^)(SNRToken *token))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-session#retrieve-customer-token)

---

This method retrieves the customer’s current UUID.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-402">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-402-0" data-tab-group="tabgrp-402" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-402-1" data-tab-group="tabgrp-402">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-402-0" data-tab-group="tabgrp-402" data-tab-active="true">

```Swift
static func getUUID() -> String
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-402-1" data-tab-group="tabgrp-402">

```Objective-C
+ (NSString *)getUUID
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-session#get-current-customer-uuid)

---

Retrieves the current UUID or generates a new one from a seed.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-403">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-403-0" data-tab-group="tabgrp-403" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-403-1" data-tab-group="tabgrp-403">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-403-0" data-tab-group="tabgrp-403" data-tab-active="true">

```Swift
static func getUUIDForAuthentication(authID: String) -> String
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-403-1" data-tab-group="tabgrp-403">

```Objective-C
+ (NSString *)getUUIDForAuthenticationWithAuthID:(NSString *)authID;
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-session#get-customer-uuid-for-use-in-authentication)

---

This method regenerates the UUID and clears the authentication token, login session, custom email, and custom identifier.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-404">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-404-0" data-tab-group="tabgrp-404" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-404-1" data-tab-group="tabgrp-404">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-404-0" data-tab-group="tabgrp-404" data-tab-active="true">

```Swift
static func regenerateUUID()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-404-1" data-tab-group="tabgrp-404">

```Objective-C
+ (BOOL)regenerateUUID
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-session#regenerate-customer)

---

This method regenerates the UUID and clears the authentication token, login session, custom email, and custom identifier.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-405">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-405-0" data-tab-group="tabgrp-405" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-405-1" data-tab-group="tabgrp-405">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-405-0" data-tab-group="tabgrp-405" data-tab-active="true">

```Swift
static func regenerateUUID(clientIdentifier: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-405-1" data-tab-group="tabgrp-405">

```Objective-C
+ (BOOL)regenerateUUIDWithClientIdentifier:(nullable NSString *)clientIdentifier
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-session#regenerate-customer-with-identifier)

---

This method destroys the session completely.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-406">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-406-0" data-tab-group="tabgrp-406" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-406-1" data-tab-group="tabgrp-406">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-406-0" data-tab-group="tabgrp-406" data-tab-active="true">

```Swift
static func destroySession()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-406-1" data-tab-group="tabgrp-406">

```Objective-C
+ (void)destroySession
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-session#destroy-current-session)

---

This method gets a customer’s account information.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-407">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-407-0" data-tab-group="tabgrp-407" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-407-1" data-tab-group="tabgrp-407">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-407-0" data-tab-group="tabgrp-407" data-tab-active="true">

```Swift
static func getAccount(success: ((ClientAccountInformation) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-407-1" data-tab-group="tabgrp-407">

```Objective-C
+ (void)getAccountWithSuccess:(void (^)(SNRClientAccountInformation *accountInformation))success failure:(void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-account#get-customer-account-information)

---

This method retrieves events for an authenticated customer.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-408">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-408-0" data-tab-group="tabgrp-408" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-408-1" data-tab-group="tabgrp-408">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-408-0" data-tab-group="tabgrp-408" data-tab-active="true">

```Swift
static func getEvents(apiQuery: ClientEventsApiQuery, success: (([ClientEventData]) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-408-1" data-tab-group="tabgrp-408">

```Objective-C
+ (void)getEventsWithApiQuery:(nonnull SNRClientEventsApiQuery *)apiQuery success:(nonnull void (^)(NSArray<SNRClientEventData *> *events))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-account#get-customers-events)

---

This method updates a customer’s account’s basic information (without identification data: uuid, customId, email).

<div class="content-tabs code-tabs" data-tab-group="tabgrp-409">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-409-0" data-tab-group="tabgrp-409" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-409-1" data-tab-group="tabgrp-409">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-409-0" data-tab-group="tabgrp-409" data-tab-active="true">

```Swift
static func updateAccountBasicInformation(context: ClientUpdateAccountBasicInformationContext, success: ((Bool) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-409-1" data-tab-group="tabgrp-409">

```Objective-C
+ (void)updateAccountBasicInformation:(nonnull SNRClientUpdateAccountBasicInformationContext *)context success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-account#update-customer-account-basic-information)

---

This method updates a customer’s account information.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-410">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-410-0" data-tab-group="tabgrp-410" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-410-1" data-tab-group="tabgrp-410">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-410-0" data-tab-group="tabgrp-410" data-tab-active="true">

```Swift
static func updateAccount(context: ClientUpdateAccountContext, success: ((Bool) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-410-1" data-tab-group="tabgrp-410">

```Objective-C
+ (void)updateAccount:(nonnull SNRClientUpdateAccountContext *)context success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-account#update-customer-account-information)

---

This method requests a customer’s password reset with email.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-411">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-411-0" data-tab-group="tabgrp-411" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-411-1" data-tab-group="tabgrp-411">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-411-0" data-tab-group="tabgrp-411" data-tab-active="true">

```Swift
static func requestPasswordReset(context: ClientPasswordResetRequestContext, success: ((Bool) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-411-1" data-tab-group="tabgrp-411">

```Objective-C
+ (void)requestPasswordReset:(nonnull SNRClientPasswordResetRequestContext *)context success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-account#request-password-reset-for-customer-account)

---

This method confirm a customer’s password reset with the new password and token provided by password reset request.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-412">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-412-0" data-tab-group="tabgrp-412" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-412-1" data-tab-group="tabgrp-412">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-412-0" data-tab-group="tabgrp-412" data-tab-active="true">

```Swift
static func confirmResetPassword(context: ClientPasswordResetConfirmationContext, success: ((Bool) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-412-1" data-tab-group="tabgrp-412">

```Objective-C
+ (void)confirmResetPassword:(nonnull SNRClientPasswordResetConfirmationContext *)context success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-account#confirm-password-reset-for-customer-account)

---

This method changes a customer’s password.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-413">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-413-0" data-tab-group="tabgrp-413" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-413-1" data-tab-group="tabgrp-413">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-413-0" data-tab-group="tabgrp-413" data-tab-active="true">

```Swift
static func changePassword(password: String, oldPassword: String, success: ((Bool) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-413-1" data-tab-group="tabgrp-413">

```Objective-C
+ (void)changePassword:(nonnull NSString *)password oldPassword:(nonnull NSString *)oldPassword success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-account#change-customers-account-password)

---

This method requests a customer's email change.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-414">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-414-0" data-tab-group="tabgrp-414" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-414-1" data-tab-group="tabgrp-414">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-414-0" data-tab-group="tabgrp-414" data-tab-active="true">

```Swift
static func requestEmailChange(email: String, password: String?, externalToken: AnyObject?, authID: String?, success: ((Bool) -> Void), failure: ((ApiError) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-414-1" data-tab-group="tabgrp-414">

```Objective-C
+ (void)requestEmailChange:(NSString *)email password:(nullable NSString *)password externalToken:(nullable id)externalToken authID:(nullable NSString *)authID success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(SNRApiError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-account#request-email-change-for-customer-account)

---

This method confirms an email change.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-415">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-415-0" data-tab-group="tabgrp-415" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-415-1" data-tab-group="tabgrp-415">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-415-0" data-tab-group="tabgrp-415" data-tab-active="true">

```Swift
static func confirmEmailChange(token: String, newsletterAgreement: Bool, success: ((Bool) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-415-1" data-tab-group="tabgrp-415">

```Objective-C
+ (void)confirmEmailChange:(nonnull NSString *)token newsletterAgreement:(BOOL)newsletterAgreement success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-account#confirm-email-change-for-customer-account)

---

Requests a customer's phone update. A confirmation code is sent to the phone number.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-416">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-416-0" data-tab-group="tabgrp-416" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-416-1" data-tab-group="tabgrp-416">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-416-0" data-tab-group="tabgrp-416" data-tab-active="true">

```Swift
static func requestPhoneUpdate(phone: String, success: ((Bool) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-416-1" data-tab-group="tabgrp-416">

```Objective-C
+ (void)requestPhoneUpdate:(nonnull NSString *)phone success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-account#request-phone-update-on-customer-account)

---

This method confirms a phone number update. This action requires the new phone number and confirmation code as parameters.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-417">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-417-0" data-tab-group="tabgrp-417" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-417-1" data-tab-group="tabgrp-417">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-417-0" data-tab-group="tabgrp-417" data-tab-active="true">

```Swift
static func confirmPhoneUpdate(phone:confirmationCode: String, smsAgreement: Bool, success: ((Bool) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-417-1" data-tab-group="tabgrp-417">

```Objective-C
+ (void)confirmPhoneUpdate:(nonnull NSString *)phone confirmationCode:(nonnull NSString *)confirmationCode smsAgreement:(BOOL)smsAgreement success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-account#confirm-phone-update-on-customer-account)

---

This method deletes a customer's account.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-418">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-418-0" data-tab-group="tabgrp-418" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-418-1" data-tab-group="tabgrp-418">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-418-0" data-tab-group="tabgrp-418" data-tab-active="true">

```Swift
static func deleteAccount(clientAuthFactor: AnyObject, clientIdentityProvider: ClientIdentityProvider, authID: String, success: ((Bool) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-418-1" data-tab-group="tabgrp-418">

```Objective-C
+ (void)deleteAccount:(nonnull id)clientAuthFactor clientIdentityProvider:(SNRClientIdentityProvider)clientIdentityProvider authID:(nullable NSString *)authID success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-account#delete-customer-account-by-identity-provider)

---

This method deletes a customer's account.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-419">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-419-0" data-tab-group="tabgrp-419" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-419-1" data-tab-group="tabgrp-419">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-419-0" data-tab-group="tabgrp-419" data-tab-active="true">

```Swift
static func deleteAccount(password: String, success: ((Bool) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-419-1" data-tab-group="tabgrp-419">

```Objective-C
+ (void)deleteAccount:(nonnull NSString *)password success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-account#delete-customer-account) - **DEPRECATED in version 3.6.19**

---

This method passes the Firebase Token to Synerise for notifications and doesn't update the agreement of the profile.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-420">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-420-0" data-tab-group="tabgrp-420" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-420-1" data-tab-group="tabgrp-420">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-420-0" data-tab-group="tabgrp-420" data-tab-active="true">

```Swift
static func registerForPush(registrationToken: String, success: ((Bool) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-420-1" data-tab-group="tabgrp-420">

```Objective-C
+ (void)registerForPush:(nonnull NSString *)registrationToken success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#register-for-push-notifications-without-agreement)


---

This method passes the Firebase Token to Synerise for notifications.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-421">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-421-0" data-tab-group="tabgrp-421" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-421-1" data-tab-group="tabgrp-421">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-421-0" data-tab-group="tabgrp-421" data-tab-active="true">

```Swift
static func registerForPush(registrationToken: String, mobilePushAgreement: Bool, success: ((Bool) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-421-1" data-tab-group="tabgrp-421">

```Objective-C
+ (void)registerForPush:(nonnull NSString *)registrationToken mobilePushAgreement:(BOOL)mobilePushAgreement success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#register-for-push-notifications)

---
---

### Tracker
The module for sending event tracking data to Synerise backend. Tracking is performed by creating pre-defined or custom event objects and sending these to Synerise. It also includes automatic event interception by the Auto-Tracking feature.
  
**Declared In:**  
Headers/SNRTracker.h  
  
**Related To:**  
[Event](/developers/mobile-sdk/class-reference/ios/events#event)  
[TrackerParams](/developers/mobile-sdk/class-reference/ios/events#trackerparams)  
[TrackerParamsBuilder](/developers/mobile-sdk/class-reference/ios/events#trackerparamsbuilder)  
  
**Inherits From:**  
[NSObject](https://developer.apple.com/documentation/objectivec/nsobject)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-422">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-422-0" data-tab-group="tabgrp-422" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-422-1" data-tab-group="tabgrp-422">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-422-0" data-tab-group="tabgrp-422" data-tab-active="true">

```Swift
class Tracker: NSObject
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-422-1" data-tab-group="tabgrp-422">

```Objective-C
@interface SNRTracker : NSObject
```

</div>
</div>

  
**Methods:**

This method sets an object for Tracker module delegate methods.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-423">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-423-0" data-tab-group="tabgrp-423" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-423-1" data-tab-group="tabgrp-423">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-423-0" data-tab-group="tabgrp-423" data-tab-active="true">

```Swift
static func setDelegate(_: TrackerDelegate)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-423-1" data-tab-group="tabgrp-423">

```Objective-C
+ (void)setDelegate:(nonnull id<SNRTrackerDelegate>)delegate
```

</div>
</div>

[Click for more details](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#tracker-delegate)

---

This method sets a custom identifier in the parameters of every event.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-424">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-424-0" data-tab-group="tabgrp-424" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-424-1" data-tab-group="tabgrp-424">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-424-0" data-tab-group="tabgrp-424" data-tab-active="true">

```Swift
static func setCustomIdentifier(_: String?)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-424-1" data-tab-group="tabgrp-424">

```Objective-C
+ (void)setCustomIdentifier:(nullable NSString *)customIdentifier
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/tracking#set-custom-identifier-for-events)

---

This method sets a custom email in the parameters of every event.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-425">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-425-0" data-tab-group="tabgrp-425" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-425-1" data-tab-group="tabgrp-425">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-425-0" data-tab-group="tabgrp-425" data-tab-active="true">

```Swift
static func setCustomEmail(_: String?)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-425-1" data-tab-group="tabgrp-425">

```Objective-C
+ (void)setCustomEmail:(nullable NSString *)customEmail
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/tracking#set-custom-email-for-events)

---

This method sends an event.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-426">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-426-0" data-tab-group="tabgrp-426" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-426-1" data-tab-group="tabgrp-426">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-426-0" data-tab-group="tabgrp-426" data-tab-active="true">

```Swift
static func send(_: Event)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-426-1" data-tab-group="tabgrp-426">

```Objective-C
+ (void)send:(SNREvent *)event
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/tracking#send-event)

---

This method forces sending the events from the queue to the server.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-427">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-427-0" data-tab-group="tabgrp-427" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-427-1" data-tab-group="tabgrp-427">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-427-0" data-tab-group="tabgrp-427" data-tab-active="true">

```Swift
static func flushEvents(completionHandler: (() -> Void)?)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-427-1" data-tab-group="tabgrp-427">

```Objective-C
+ (void)flushEventsWithCompletionHandler:(nullable void (^)(void))completion
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/tracking#flush-events-from-tracker)

---
---

### Injector
<!-- reusable-table-boundary -->

The module for handling Synerise UI activities such as walkthrough, banner, simple push, and so on.
  
**Declared In:**  
Headers/SNRInjector.h
  
**Inherits From:**  
[NSObject](https://developer.apple.com/documentation/objectivec/nsobject)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-428">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-428-0" data-tab-group="tabgrp-428" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-428-1" data-tab-group="tabgrp-428">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-428-0" data-tab-group="tabgrp-428" data-tab-active="true">

```Swift
class Injector: NSObject
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-428-1" data-tab-group="tabgrp-428">

```Objective-C
@interface SNRInjector : NSObject
```

</div>
</div>

  
**Properties:**

| Property | Type | Optional | Description |
|---|---|---|---|
| inAppContext | [String: Any] | No | The global context used for personalizing in-app message content. This property is shared between overlay and inline in-app messages |

**Methods:**

This method sets an object for in-app messages delegate methods. 

<div class="content-tabs code-tabs" data-tab-group="tabgrp-429">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-429-0" data-tab-group="tabgrp-429" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-429-1" data-tab-group="tabgrp-429">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-429-0" data-tab-group="tabgrp-429" data-tab-active="true">

```Swift
static func setInAppMessageDelegate(_: InjectorInAppMessageDelegate)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-429-1" data-tab-group="tabgrp-429">

```Objective-C
+ (void)setInAppMessageDelegate:(id<SNRInjectorInAppMessageDelegate>)delegate
  ```

  </div>
  </div>

  [(Click for more details)](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#injector-in-app-message-delegate)

  ---

  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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-430">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-430-0" data-tab-group="tabgrp-430" data-tab-active="true">swift</button><button class="tab-button" data-tab-id="tabgrp-430-1" data-tab-group="tabgrp-430">objective-c</button></div>

<div class="tab-panel" data-tab-id="tabgrp-430-0" data-tab-group="tabgrp-430" data-tab-active="true">

```swift
static func closeInAppMessage(campaignHash: String) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-430-1" data-tab-group="tabgrp-430">

```objective-c
+ (void)closeInAppMessage:(nonnull NSString *)campaignHash
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#close-in-app-message)

---

This method fetches a walkthrough.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-431">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-431-0" data-tab-group="tabgrp-431" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-431-1" data-tab-group="tabgrp-431">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-431-0" data-tab-group="tabgrp-431" data-tab-active="true">

```Swift
static func getWalkthrough()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-431-1" data-tab-group="tabgrp-431">

```Objective-C
+ (void)getWalkthrough
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#get-walkthrough) - **REMOVED in version 5.0.0**

---

This method shows a walkthrough when it is loaded.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-432">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-432-0" data-tab-group="tabgrp-432" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-432-1" data-tab-group="tabgrp-432">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-432-0" data-tab-group="tabgrp-432" data-tab-active="true">

```Swift
static func showWalkthrough()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-432-1" data-tab-group="tabgrp-432">

```Objective-C
+ (void)showWalkthrough
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#show-walkthrough) - **REMOVED in version 5.0.0**

---

This method checks if a walkthrough is loaded.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-433">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-433-0" data-tab-group="tabgrp-433" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-433-1" data-tab-group="tabgrp-433">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-433-0" data-tab-group="tabgrp-433" data-tab-active="true">

```Swift
static func isWalkthroughLoaded() -> Bool
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-433-1" data-tab-group="tabgrp-433">

```Objective-C
+ (BOOL)isWalkthroughLoaded
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#check-if-walkthrough-is-loaded) - **REMOVED in version 5.0.0**

---

This method checks if the walkthrough is unique compared to the previous one.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-434">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-434-0" data-tab-group="tabgrp-434" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-434-1" data-tab-group="tabgrp-434">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-434-0" data-tab-group="tabgrp-434" data-tab-active="true">

```Swift
static func isLoadedWalkthroughUnique() -> Bool
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-434-1" data-tab-group="tabgrp-434">

```Objective-C
+ (BOOL)isLoadedWalkthroughUnique
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#check-if-loaded-walkthrough-is-unique) - **REMOVED in version 5.0.0**

---

This method fetches Push Notifications set for mobile campaigns.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-435">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-435-0" data-tab-group="tabgrp-435" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-435-1" data-tab-group="tabgrp-435">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-435-0" data-tab-group="tabgrp-435" data-tab-active="true">

```Swift
static func getPushes(success: (([[AnyHashable: Any]]) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-435-1" data-tab-group="tabgrp-435">

```Objective-C
+ (void)getPushesWithSuccess:(nonnull void (^)(NSArray<NSDictionary *> *pushes))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#get-pushes) - **REMOVED in version 5.0.0**

---

This method provides valid banners directly from SDK cache.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-436">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-436-0" data-tab-group="tabgrp-436" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-436-1" data-tab-group="tabgrp-436">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-436-0" data-tab-group="tabgrp-436" data-tab-active="true">

```Swift
static func getBanners() -> [[AnyHashable: Any]]
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-436-1" data-tab-group="tabgrp-436">

```Objective-C
+ (nonnull NSArray<NSDictionary *> *)getBanners
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#get-banners) - **REMOVED in version 4.6.0**

---

This method fetches banners set for mobile campaigns and caches the valid ones.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-437">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-437-0" data-tab-group="tabgrp-437" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-437-1" data-tab-group="tabgrp-437">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-437-0" data-tab-group="tabgrp-437" data-tab-active="true">

```Swift
static func fetchBanners(success: (([[AnyHashable: Any]]) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-437-1" data-tab-group="tabgrp-437">

```Objective-C
+ (void)fetchBannersWithSuccess:(nonnull void (^)(NSArray<NSDictionary *> *banners))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#fetch-banners) - **REMOVED in version 4.6.0**

---

This method shows a banner immediately.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-438">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-438-0" data-tab-group="tabgrp-438" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-438-1" data-tab-group="tabgrp-438">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-438-0" data-tab-group="tabgrp-438" data-tab-active="true">

```Swift
static func showBanner(_: [AnyHashable: Any], markPresented: Bool)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-438-1" data-tab-group="tabgrp-438">

```Objective-C
+ (void)showBanner:(nonnull NSDictionary *)bannerDictionary markPresented:(BOOL)markPresented
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#show-banner) - **REMOVED in version 4.6.0**

<!-- reusable-table-boundary -->

---
---

### Promotions
The module for handling promotions and vouchers from Synerise SDK.
  
**Declared In:**  
Headers/SNRPromotions.h  
  
**Related To:**  
[PromotionsApiQuery](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionsapiquery)  
[PromotionIdentifier](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionidentifier)  
[PromotionResponse](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionresponse)  
[Promotion](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotion)  
[AssignVoucherResponse](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#assignvoucherresponse)  
[VoucherCodesResponse](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#vouchercodesresponse)  
  
**Inherits From:**  
[NSObject](https://developer.apple.com/documentation/objectivec/nsobject)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-439">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-439-0" data-tab-group="tabgrp-439" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-439-1" data-tab-group="tabgrp-439">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-439-0" data-tab-group="tabgrp-439" data-tab-active="true">

```Swift
class Promotions: NSObject
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-439-1" data-tab-group="tabgrp-439">

```Objective-C
@interface SNRPromotions : NSObject
```

</div>
</div>

  
**Methods:**
This method retrieves all available promotions that are defined for a customer.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-440">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-440-0" data-tab-group="tabgrp-440" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-440-1" data-tab-group="tabgrp-440">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-440-0" data-tab-group="tabgrp-440" data-tab-active="true">

```Swift
static func getPromotions(success: ((PromotionResponse) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-440-1" data-tab-group="tabgrp-440">

```Objective-C
+ (void)getPromotionsWithSuccess:(nonnull void (^)(SNRPromotionResponse *promotionResponse))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/promotions#get-all-promotions-of-a-customer)

---

This method retrieves promotions that match the parameters defined in an API query.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-441">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-441-0" data-tab-group="tabgrp-441" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-441-1" data-tab-group="tabgrp-441">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-441-0" data-tab-group="tabgrp-441" data-tab-active="true">

```Swift
static func getPromotions(apiQuery: PromotionsApiQuery, success: ((PromotionResponse) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-441-1" data-tab-group="tabgrp-441">

```Objective-C
+ (void)getPromotionsWithApiQuery:(nonnull SNRPromotionsApiQuery *)apiQuery success:(nonnull void (^)(SNRPromotionResponse *promotionResponse))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/promotions#get-promotions-with-query-parameters)

---

This method retrieves the promotion with the specified UUID.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-442">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-442-0" data-tab-group="tabgrp-442" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-442-1" data-tab-group="tabgrp-442">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-442-0" data-tab-group="tabgrp-442" data-tab-active="true">

```Swift
static func getPromotion(uuid: String, success: ((Promotion) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-442-1" data-tab-group="tabgrp-442">

```Objective-C
+ (void)getPromotionByUuid:(nonnull NSString *)uuid success:(nonnull void (^)(SNRPromotion *promotion))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/promotions#get-promotion-by-uuid)

---

This method retrieves the promotion with the specified code.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-443">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-443-0" data-tab-group="tabgrp-443" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-443-1" data-tab-group="tabgrp-443">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-443-0" data-tab-group="tabgrp-443" data-tab-active="true">

```Swift
static func getPromotion(code: String, success: ((Promotion) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-443-1" data-tab-group="tabgrp-443">

```Objective-C
+ (void)getPromotionByCode:(nonnull NSString *)code success:(nonnull void (^)(SNRPromotion *promotion))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/promotions#get-promotion-by-code)

---

This method activates the promotion with the specified UUID.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-444">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-444-0" data-tab-group="tabgrp-444" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-444-1" data-tab-group="tabgrp-444">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-444-0" data-tab-group="tabgrp-444" data-tab-active="true">

```Swift
static func activatePromotion(uuid: String, success: ((Bool) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-444-1" data-tab-group="tabgrp-444">

```Objective-C
+ (void)activatePromotionByUuid:(nonnull NSString *)uuid success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/promotions#activate-promotion-by-uuid)

---

This method activates the promotion with the specified code.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-445">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-445-0" data-tab-group="tabgrp-445" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-445-1" data-tab-group="tabgrp-445">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-445-0" data-tab-group="tabgrp-445" data-tab-active="true">

```Swift
static func activatePromotion(code: String, success: ((Bool) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-445-1" data-tab-group="tabgrp-445">

```Objective-C
+ (void)activatePromotionByCode:(nonnull NSString *)code success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/promotions#activate-promotion-by-code)

---

This method activates promotions with a code or with UUID in a batch.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-446">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-446-0" data-tab-group="tabgrp-446" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-446-1" data-tab-group="tabgrp-446">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-446-0" data-tab-group="tabgrp-446" data-tab-active="true">

```Swift
static func activatePromotions(identifiers: [PromotionIdentifier], success: ((Bool) -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-446-1" data-tab-group="tabgrp-446">

```Objective-C
+ (void)activatePromotionsWithIdentifiers:(nonnull NSArray<SNRPromotionIdentifier *> *)identifiers success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(SNRApiError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/promotions#activate-promotions-in-a-batch)

---

This method deactivates the promotion with the specified UUID.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-447">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-447-0" data-tab-group="tabgrp-447" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-447-1" data-tab-group="tabgrp-447">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-447-0" data-tab-group="tabgrp-447" data-tab-active="true">

```Swift
static func deactivatePromotion(uuid: String, success: ((Bool) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-447-1" data-tab-group="tabgrp-447">

```Objective-C
+ (void)deactivatePromotionByUuid:(nonnull NSString *)uuid success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/promotions#deactivate-promotion-by-uuid)

---

This method deactivates the promotion with the specified code.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-448">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-448-0" data-tab-group="tabgrp-448" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-448-1" data-tab-group="tabgrp-448">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-448-0" data-tab-group="tabgrp-448" data-tab-active="true">

```Swift
static func deactivatePromotion(code: String, success: ((Bool) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-448-1" data-tab-group="tabgrp-448">

```Objective-C
+ (void)deactivatePromotionByUuid:(nonnull NSString *)uuid success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/promotions#deactivate-promotion-by-code)

---

This method deactivates promotions with a code or with UUID in a batch.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-449">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-449-0" data-tab-group="tabgrp-449" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-449-1" data-tab-group="tabgrp-449">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-449-0" data-tab-group="tabgrp-449" data-tab-active="true">

```Swift
static func deactivatePromotions(identifiers: [PromotionIdentifier], success: ((Bool) -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-449-1" data-tab-group="tabgrp-449">

```Objective-C
+ (void)deactivatePromotionsWithIdentifiers:(nonnull NSArray<SNRPromotionIdentifier *> *)identifiers success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(SNRApiError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/promotions#deactivate-promotions-in-a-batch)

---

This method retrieves an assigned voucher code or assigns a voucher from a pool identified by UUID to the profile.

When the voucher is assigned for the first time, a [voucherCode.assigned](/docs/assets/events/event-reference/loyalty#vouchercodeassigned) event is produced.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-450">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-450-0" data-tab-group="tabgrp-450" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-450-1" data-tab-group="tabgrp-450">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-450-0" data-tab-group="tabgrp-450" data-tab-active="true">

```Swift
static func getOrAssignVoucher(poolUUID: String, success: ((AssignVoucherResponse) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-450-1" data-tab-group="tabgrp-450">

```Objective-C
+ (void)getOrAssignVoucherWithPoolUUID:(NSString *)poolUUID success:(void (^)(SNRAssignVoucherResponse *assignVoucherResponse))success failure:(void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/promotions#get-or-assign-voucher-from-pool)

---

This method assigns a voucher from a pool identified by UUID to the profile.

A [voucherCode.assigned](/docs/assets/events/event-reference/loyalty#vouchercodeassigned) event is produced.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-451">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-451-0" data-tab-group="tabgrp-451" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-451-1" data-tab-group="tabgrp-451">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-451-0" data-tab-group="tabgrp-451" data-tab-active="true">

```Swift
static func assignVoucherCode(poolUUID: String, success: ((AssignVoucherResponse) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-451-1" data-tab-group="tabgrp-451">

```Objective-C
+ (void)assignVoucherCodeWithPoolUUID:(nonnull NSString *)poolUUID success:(nonnull void (^)(SNRAssignVoucherResponse *assignVoucherResponse))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/promotions#assign-voucher-code-from-pool)

---

This method retrieves voucher codes for a customer.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-452">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-452-0" data-tab-group="tabgrp-452" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-452-1" data-tab-group="tabgrp-452">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-452-0" data-tab-group="tabgrp-452" data-tab-active="true">

```Swift
static func getAssignedVoucherCodes(success: ((VoucherCodesResponse) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-452-1" data-tab-group="tabgrp-452">

```Objective-C
+ (void)getAssignedVoucherCodesWithSuccess:(nonnull void (^)(SNRVoucherCodesResponse *voucherCodesResponse))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/promotions#get-voucher-codes-assigned-to-customer)

---
---
 
### Content
The module for handling content from Synerise backend such as documents, recommendations, and so on.
  
**Declared In:**  
Headers/SNRContent.h
  
**Related To:**  
[Document](/developers/mobile-sdk/class-reference/ios/recommendations-and-documents#document)  
[DocumentApiQuery](/developers/mobile-sdk/class-reference/ios/recommendations-and-documents#documentapiquery)  
[DocumentsApiQuery](/developers/mobile-sdk/class-reference/ios/recommendations-and-documents#documentsapiquery)  
[RecommendationResponse](/developers/mobile-sdk/class-reference/ios/recommendations-and-documents#recommendationresponse)  
[Recommendation](/developers/mobile-sdk/class-reference/ios/recommendations-and-documents#recommendation)  
[ScreenView](/developers/mobile-sdk/class-reference/ios/miscellaneous#screenview)  
[ScreenViewApiQuery](/developers/mobile-sdk/class-reference/ios/miscellaneous#screenviewapiquery)  
  
**Inherits From:**  
[NSObject](https://developer.apple.com/documentation/objectivec/nsobject)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-453">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-453-0" data-tab-group="tabgrp-453" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-453-1" data-tab-group="tabgrp-453">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-453-0" data-tab-group="tabgrp-453" data-tab-active="true">

```Swift
class Content: NSObject
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-453-1" data-tab-group="tabgrp-453">

```Objective-C
@interface SNRContent : NSObject
```

</div>
</div>

  
**Methods:**

This method generates the document assigned to a slug.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-454">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-454-0" data-tab-group="tabgrp-454" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-454-1" data-tab-group="tabgrp-454">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-454-0" data-tab-group="tabgrp-454" data-tab-active="true">

```Swift
static func getDocument(slug: String, success: (([AnyHashable: Any]) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-454-1" data-tab-group="tabgrp-454">

```Objective-C
+ (void)getDocument:(nonnull NSString *)slug success:(nonnull void (^)(NSDictionary *document))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/content#get-document) - **REMOVED in version 5.0.0**

---

This method generates the document that is defined for the provided slug.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-455">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-455-0" data-tab-group="tabgrp-455" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-455-1" data-tab-group="tabgrp-455">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-455-0" data-tab-group="tabgrp-455" data-tab-active="true">

```Swift
static func generateDocument(slug: String, success: ((Document) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-455-1" data-tab-group="tabgrp-455">

```Objective-C
+ (void)generateDocument:(nonnull NSString *)slug success:(nonnull void (^)(SNRDocument *document))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/content#generate-document)

---

This method generates the document that is defined for parameters provided in the query object.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-456">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-456-0" data-tab-group="tabgrp-456" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-456-1" data-tab-group="tabgrp-456">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-456-0" data-tab-group="tabgrp-456" data-tab-active="true">

```Swift
static func generateDocument(apiQuery: DocumentApiQuery, success: ((Document) -> Void), failure: ((ApiError) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-456-1" data-tab-group="tabgrp-456">

```Objective-C
+ (void)generateDocumentWithApiQuery:(SNRDocumentApiQuery *)apiQuery success:(void (^)(SNRDocument *document))success failure:(void (^)(SNRApiError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/content#generate-document-with-query-parameters)

---

This method generates documents that are defined for parameters provided in the query object.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-457">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-457-0" data-tab-group="tabgrp-457" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-457-1" data-tab-group="tabgrp-457">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-457-0" data-tab-group="tabgrp-457" data-tab-active="true">

```Swift
static func getDocuments(apiQuery: DocumentsApiQuery, success: (([[AnyHashable: Any]]) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-457-1" data-tab-group="tabgrp-457">

```Objective-C
+ (void)getDocumentsWithApiQuery:(nonnull SNRDocumentsApiQuery *)apiQuery success:(nonnull void (^)(NSArray *documents))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/content#get-documents) - **REMOVED in version 5.0.0**

---

This method generates recommendations that are defined for the options provided. The recommendations are generated by using a document with an insert.  

For instructions, see ["Displaying AI recommendations > With documents and screen views"](/developers/mobile-sdk/displaying-recommendations/documents).

<div class="content-tabs code-tabs" data-tab-group="tabgrp-458">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-458-0" data-tab-group="tabgrp-458" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-458-1" data-tab-group="tabgrp-458">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-458-0" data-tab-group="tabgrp-458" data-tab-active="true">

```Swift
static func getRecommendations(options: RecommendationOptions, success: ((RecommendationResponse) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-458-1" data-tab-group="tabgrp-458">

```Objective-C
+ (void)getRecommendations:(nonnull SNRRecommendationOptions *)options success:(nonnull void (^)(SNRRecommendationResponse *recommendationResponse))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/content#get-recommendations) - **REMOVED in version 5.0.0**

---

This method generates recommendations that are defined for the options provided. The recommendations are generated by using a document with an insert.  

For instructions, see ["Displaying AI recommendations > With documents and screen views"](/developers/mobile-sdk/displaying-recommendations/documents).

<div class="content-tabs code-tabs" data-tab-group="tabgrp-459">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-459-0" data-tab-group="tabgrp-459" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-459-1" data-tab-group="tabgrp-459">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-459-0" data-tab-group="tabgrp-459" data-tab-active="true">

```Swift
static func getRecommendationsV2(apiQuery: RecommendationApiQuery, success: ((RecommendationResponse) -> Void), failure: ((Error) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-459-1" data-tab-group="tabgrp-459">

```Objective-C
+ (void)getRecommendationsV2:(nonnull SNRRecommendationApiQuery *)apiQuery success:(nonnull void (^)(SNRRecommendationResponse *recommendationResponse))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/content#get-recommendations-v2)

---

This method generates the customer's highest-priority screen view campaign.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-460">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-460-0" data-tab-group="tabgrp-460" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-460-1" data-tab-group="tabgrp-460">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-460-0" data-tab-group="tabgrp-460" data-tab-active="true">

```Swift
static func getScreenView(success: ((ScreenViewResponse) -> Void), failure: ((ApiError) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-460-1" data-tab-group="tabgrp-460">

```Objective-C
+ (void)getScreenViewWithSuccess:(nonnull void (^)(SNRScreenViewResponse *screenViewResponse))success failure:(nonnull void (^)(SNRApiError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/content#get-screen-view) - **REMOVED in version 5.0.0**

---

This method generates a customer's highest-priority screen view campaign from the feed with the provided feed slug.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-461">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-461-0" data-tab-group="tabgrp-461" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-461-1" data-tab-group="tabgrp-461">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-461-0" data-tab-group="tabgrp-461" data-tab-active="true">

```Swift
static func generateScreenView(feedSlug: String, success: ((ScreenView) -> Void), failure: ((ApiError) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-461-1" data-tab-group="tabgrp-461">

```Objective-C
+ (void)generateScreenView:(NSString *)feedSlug success:(nonnull void (^)(SNRScreenView *screenView))success failure:(nonnull void (^)(SNRApiError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/content#generate-screen-view)
---

This method generates customer's highest-priority screen view campaign that is defined for parameters provided in the query object.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-462">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-462-0" data-tab-group="tabgrp-462" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-462-1" data-tab-group="tabgrp-462">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-462-0" data-tab-group="tabgrp-462" data-tab-active="true">

```Swift
static func generateScreenView(apiQuery: ScreenViewApiQuery, success: ((ScreenView) -> Void), failure: ((ApiError) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-462-1" data-tab-group="tabgrp-462">

```Objective-C
+ (void)generateScreenView:(SNRScreenViewApiQuery *)apiQuery success:(nonnull void (^)(SNRScreenView *screenView))success failure:(nonnull void (^)(SNRApiError *error))failure
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/ios/content#generate-screen-view-with-query-parameters)


# Android

## 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.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-628">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-628-0" data-tab-group="tabgrp-628" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-628-1" data-tab-group="tabgrp-628">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-628-0" data-tab-group="tabgrp-628" data-tab-active="true">

```Java
- void onRegisterForPushRequired(PushRegistrationOrigin origin);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-628-1" data-tab-group="tabgrp-628">

```Kotlin
fun onRegisterForPushRequired(origin: PushRegistrationOrigin)
```

</div>
</div>


| 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.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-629">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-629-0" data-tab-group="tabgrp-629" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-629-1" data-tab-group="tabgrp-629">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-629-0" data-tab-group="tabgrp-629" data-tab-active="true">

```Java
- void onRegisterForPushRequired();
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-629-1" data-tab-group="tabgrp-629">

```Kotlin
fun onRegisterForPushRequired()
```

</div>
</div>


---
---

### 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.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**OnNotificationListener** is available from 4.9.0 SDK version.

</div></div></div>


##### onNotificationReceived(NotificationInfo notificationInfo) {id=on-notification-listener-on-notification-receive}

This method is called when a Synerise notification is received.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-630">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-630-0" data-tab-group="tabgrp-630" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-630-1" data-tab-group="tabgrp-630">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-630-0" data-tab-group="tabgrp-630" data-tab-active="true">

```Java
- public void onNotificationReceived(NotificationInfo notificationInfo)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-630-1" data-tab-group="tabgrp-630">

```Kotlin
fun onNotificationReceived(notificationInfo: NotificationInfo)
```

</div>
</div>


| 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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-631">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-631-0" data-tab-group="tabgrp-631" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-631-1" data-tab-group="tabgrp-631">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-631-0" data-tab-group="tabgrp-631" data-tab-active="true">

```Java
- public void onNotificationDismissed(NotificationInfo notificationInfo)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-631-1" data-tab-group="tabgrp-631">

```Kotlin
fun onNotificationDismissed(notificationInfo: NotificationInfo)
```

</div>
</div>


| 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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-632">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-632-0" data-tab-group="tabgrp-632" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-632-1" data-tab-group="tabgrp-632">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-632-0" data-tab-group="tabgrp-632" data-tab-active="true">

```Java
- public void onNotificationClicked(NotificationInfo notificationInfo)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-632-1" data-tab-group="tabgrp-632">

```Kotlin
fun onNotificationClicked(notificationInfo: NotificationInfo)
```

</div>
</div>


| 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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-633">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-633-0" data-tab-group="tabgrp-633" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-633-1" data-tab-group="tabgrp-633">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-633-0" data-tab-group="tabgrp-633" data-tab-active="true">

```Java
- public void onActionButtonClicked(NotificationInfo notificationInfo, String actionButton)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-633-1" data-tab-group="tabgrp-633">

```Kotlin
fun onActionButtonClicked(notificationInfo: NotificationInfo, actionButton: String)
```

</div>
</div>


| 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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-634">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-634-0" data-tab-group="tabgrp-634" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-634-1" data-tab-group="tabgrp-634">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-634-0" data-tab-group="tabgrp-634" data-tab-active="true">

```Java
- public void onClientSignedIn()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-634-1" data-tab-group="tabgrp-634">

```Kotlin
fun onClientSignedIn()
```

</div>
</div>


##### onClientSignedOut(ClientSessionEndReason reason) {id=on-client-state-change-listener-on-client-signed-out}

This method is called when the customer signs out.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-635">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-635-0" data-tab-group="tabgrp-635" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-635-1" data-tab-group="tabgrp-635">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-635-0" data-tab-group="tabgrp-635" data-tab-active="true">

```Java
- public void onClientSignedOut(ClientSessionEndReason reason)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-635-1" data-tab-group="tabgrp-635">

```Kotlin
fun onClientSignedOut(reason:ClientSessionEndReason)
```

</div>
</div>


| 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`.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-636">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-636-0" data-tab-group="tabgrp-636" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-636-1" data-tab-group="tabgrp-636">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-636-0" data-tab-group="tabgrp-636" data-tab-active="true">

```Java
- boolean onOpenUrl(SyneriseSource source, String url)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-636-1" data-tab-group="tabgrp-636">

```Kotlin
fun onOpenUrl(source:SyneriseSource, url:String):Boolean
```

</div>
</div>


| 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`.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This method was deprecated in SDK version 6.0.0.

</div></div></div>



<div class="content-tabs code-tabs" data-tab-group="tabgrp-637">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-637-0" data-tab-group="tabgrp-637" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-637-1" data-tab-group="tabgrp-637">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-637-0" data-tab-group="tabgrp-637" data-tab-active="true">

```Java
- boolean onOpenUrl(InjectorSource source, String url)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-637-1" data-tab-group="tabgrp-637">

```Kotlin
fun onOpenUrl(source:InjectorSource, url:String):Boolean
```

</div>
</div>


| 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`.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-638">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-638-0" data-tab-group="tabgrp-638" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-638-1" data-tab-group="tabgrp-638">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-638-0" data-tab-group="tabgrp-638" data-tab-active="true">

```Java
- boolean onDeepLink(SyneriseSource source, String deepLink)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-638-1" data-tab-group="tabgrp-638">

```Kotlin
fun onDeepLink(source:SyneriseSource, deepLink:String):Boolean
```

</div>
</div>


| 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`.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This method was deprecated in SDK version 6.0.0.

</div></div></div>



<div class="content-tabs code-tabs" data-tab-group="tabgrp-639">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-639-0" data-tab-group="tabgrp-639" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-639-1" data-tab-group="tabgrp-639">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-639-0" data-tab-group="tabgrp-639" data-tab-active="true">

```Java
- boolean onDeepLink(InjectorSource source, String deepLink)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-639-1" data-tab-group="tabgrp-639">

```Kotlin
fun onDeepLink(source:InjectorSource, deepLink:String):Boolean
```

</div>
</div>


| 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).


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**OnInAppListener** is available from 4.7.0 SDK version.

</div></div></div>

  
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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-640">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-640-0" data-tab-group="tabgrp-640" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-640-1" data-tab-group="tabgrp-640">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-640-0" data-tab-group="tabgrp-640" data-tab-active="true">

```Java
boolean shouldShow(InAppMessageData inAppMessageData)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-640-1" data-tab-group="tabgrp-640">

```Kotlin
shouldShow(inAppMessageData: InAppMessageData): boolean
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **inAppMessageData** | [InAppMessageData](/developers/mobile-sdk/class-reference/android/campaigns#inappmessagedata) | In-app message data. |

##### onShown(InAppMessageData inAppMessageData) {id=on-in-app-listener-on-shown}

This method is called after an in-app message appears.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-641">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-641-0" data-tab-group="tabgrp-641" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-641-1" data-tab-group="tabgrp-641">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-641-0" data-tab-group="tabgrp-641" data-tab-active="true">

```Java
void onShown(InAppMessageData inAppMessageData)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-641-1" data-tab-group="tabgrp-641">

```Kotlin
onShown(inAppMessageData: InAppMessageData)
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **inAppMessageData** | [InAppMessageData](/developers/mobile-sdk/class-reference/android/campaigns#inappmessagedata) | In-app message data. |

##### onDismissed(InAppMessageData inAppMessageData) {id=on-in-app-listener-on-dismissed}

This method is called after an in-app message disappears.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-642">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-642-0" data-tab-group="tabgrp-642" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-642-1" data-tab-group="tabgrp-642">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-642-0" data-tab-group="tabgrp-642" data-tab-active="true">

```Java
void onDismissed(InAppMessageData inAppMessageData)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-642-1" data-tab-group="tabgrp-642">

```Kotlin
onDismissed(inAppMessageData: InAppMessageData)
```

</div>
</div>


| 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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-643">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-643-0" data-tab-group="tabgrp-643" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-643-1" data-tab-group="tabgrp-643">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-643-0" data-tab-group="tabgrp-643" data-tab-active="true">

```Java
HashMap<String, Object> onContextFromAppRequired(InAppMessageData inAppMessageData)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-643-1" data-tab-group="tabgrp-643">

```Kotlin
onContextFromAppRequired(inAppMessageData: InAppMessageData): HashMap<String, Object>
```

</div>
</div>


| 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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-644">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-644-0" data-tab-group="tabgrp-644" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-644-1" data-tab-group="tabgrp-644">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-644-0" data-tab-group="tabgrp-644" data-tab-active="true">

```Java
void onHandledOpenUrl(InAppMessageData inAppMessageData)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-644-1" data-tab-group="tabgrp-644">

```Kotlin
onHandledOpenUrl(inAppMessageData: InAppMessageData)
```

</div>
</div>


| 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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-645">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-645-0" data-tab-group="tabgrp-645" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-645-1" data-tab-group="tabgrp-645">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-645-0" data-tab-group="tabgrp-645" data-tab-active="true">

```Java
void onHandledOpenDeepLink(InAppMessageData inAppMessageData)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-645-1" data-tab-group="tabgrp-645">

```Kotlin
onHandledOpenDeepLink(inAppMessageData: InAppMessageData)
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **inAppMessageData** | [InAppMessageData](/developers/mobile-sdk/class-reference/android/campaigns#inappmessagedata) | In-app message data. |

##### onCustomAction(String identifier, HashMap<String, Object> 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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-646">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-646-0" data-tab-group="tabgrp-646" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-646-1" data-tab-group="tabgrp-646">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-646-0" data-tab-group="tabgrp-646" data-tab-active="true">

```Java
void onCustomAction(String identifier, HashMap<String, Object> params, InAppMessageData inAppMessageData)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-646-1" data-tab-group="tabgrp-646">

```Kotlin
onCustomAction(identifier: String, params: HashMap<String, Object> , inAppMessageData: InAppMessageData)
```

</div>
</div>


| 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<String, Object> | 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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-647">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-647-0" data-tab-group="tabgrp-647" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-647-1" data-tab-group="tabgrp-647">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-647-0" data-tab-group="tabgrp-647" data-tab-active="true">

```Java
void onInlineInAppAvailable(InlineInAppView view, InlineInAppMessageData data)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-647-1" data-tab-group="tabgrp-647">

```Kotlin
onInlineInAppAvailable(view: InlineInAppView, data: InlineInAppMessageData)
```

</div>
</div>


| 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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-648">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-648-0" data-tab-group="tabgrp-648" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-648-1" data-tab-group="tabgrp-648">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-648-0" data-tab-group="tabgrp-648" data-tab-active="true">

```Java
Map<String, Object> onContextFromAppRequired(InAppMessageData data)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-648-1" data-tab-group="tabgrp-648">

```Kotlin
onContextFromAppRequired(data: InAppMessageData): MutableMap<String, Any>
```

</div>
</div>


| 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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-649">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-649-0" data-tab-group="tabgrp-649" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-649-1" data-tab-group="tabgrp-649">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-649-0" data-tab-group="tabgrp-649" data-tab-active="true">

```Java
void onOpenedUrl(InlineInAppMessageData data, String url)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-649-1" data-tab-group="tabgrp-649">

```Kotlin
onOpenedUrl(data: InlineInAppMessageData, url: String)
```

</div>
</div>


| 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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-650">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-650-0" data-tab-group="tabgrp-650" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-650-1" data-tab-group="tabgrp-650">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-650-0" data-tab-group="tabgrp-650" data-tab-active="true">

```Java
void onOpenedDeepLink(InlineInAppMessageData data, String deepLink)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-650-1" data-tab-group="tabgrp-650">

```Kotlin
onOpenedDeepLink(data: InlineInAppMessageData, deepLink: String)
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **data** | InlineInAppMessageData | Inline in-app message data. |
| **deepLink** | String | The deep link value. |

##### onCustomAction(InlineInAppMessageData data, String name, Map<String, Object> 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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-651">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-651-0" data-tab-group="tabgrp-651" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-651-1" data-tab-group="tabgrp-651">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-651-0" data-tab-group="tabgrp-651" data-tab-active="true">

```Java
void onCustomAction(InlineInAppMessageData data, String name, Map<String, Object> params)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-651-1" data-tab-group="tabgrp-651">

```Kotlin
onCustomAction(data: InlineInAppMessageData, name: String, params: Map<String, Any>)
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **data** | InlineInAppMessageData | Inline in-app message data. |
| **name** | String | Name of the custom action. |
| **params** | Map<String, Object> | Custom action parameters. |

##### onCustomMethod(String name, HashMap<String, Object> 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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-652">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-652-0" data-tab-group="tabgrp-652" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-652-1" data-tab-group="tabgrp-652">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-652-0" data-tab-group="tabgrp-652" data-tab-active="true">

```Java
void onCustomMethod(String name, HashMap<String, Object> params, InlineInAppMessageData data, InAppCustomMethodCompletion completion)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-652-1" data-tab-group="tabgrp-652">

```Kotlin
onCustomMethod(name: String, params: HashMap<String, Any>, data: InlineInAppMessageData, completion: InAppCustomMethodCompletion)
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **name** | String | Name of the custom method. |
| **params** | HashMap<String, Object> | 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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-653">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-653-0" data-tab-group="tabgrp-653" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-653-1" data-tab-group="tabgrp-653">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-653-0" data-tab-group="tabgrp-653" data-tab-active="true">

```Java
void onProcessingStarted()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-653-1" data-tab-group="tabgrp-653">

```Kotlin
onProcessingStarted()
```

</div>
</div>


##### 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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-654">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-654-0" data-tab-group="tabgrp-654" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-654-1" data-tab-group="tabgrp-654">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-654-0" data-tab-group="tabgrp-654" data-tab-active="true">

```Java
void onLoaded(InlineInAppMessageData data)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-654-1" data-tab-group="tabgrp-654">

```Kotlin
onLoaded(data: InlineInAppMessageData)
```

</div>
</div>


| 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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-655">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-655-0" data-tab-group="tabgrp-655" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-655-1" data-tab-group="tabgrp-655">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-655-0" data-tab-group="tabgrp-655" data-tab-active="true">

```Java
void onUpdated(InlineInAppMessageData data)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-655-1" data-tab-group="tabgrp-655">

```Kotlin
onUpdated(data: InlineInAppMessageData)
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **data** | InlineInAppMessageData | Inline in-app message data. |

##### onFailed(InlineInAppMessageData data, String error) {id=on-inline-in-app-view-listener-on-failed}

This method is called when the inline in-app message content fails to load or render.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-656">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-656-0" data-tab-group="tabgrp-656" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-656-1" data-tab-group="tabgrp-656">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-656-0" data-tab-group="tabgrp-656" data-tab-active="true">

```Java
void onFailed(InlineInAppMessageData data, String error)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-656-1" data-tab-group="tabgrp-656">

```Kotlin
onFailed(data: InlineInAppMessageData, error: String)
```

</div>
</div>


| 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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-657">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-657-0" data-tab-group="tabgrp-657" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-657-1" data-tab-group="tabgrp-657">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-657-0" data-tab-group="tabgrp-657" data-tab-active="true">

```Java
void onSizeChanged(InlineInAppMessageData data, InlineInAppSize size)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-657-1" data-tab-group="tabgrp-657">

```Kotlin
onSizeChanged(data: InlineInAppMessageData, size: InlineInAppSize)
```

</div>
</div>


| 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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-658">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-658-0" data-tab-group="tabgrp-658" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-658-1" data-tab-group="tabgrp-658">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-658-0" data-tab-group="tabgrp-658" data-tab-active="true">

```Java
void onRemove(InlineInAppMessageData data)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-658-1" data-tab-group="tabgrp-658">

```Kotlin
onRemove(data: InlineInAppMessageData)
```

</div>
</div>


| 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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-659">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-659-0" data-tab-group="tabgrp-659" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-659-1" data-tab-group="tabgrp-659">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-659-0" data-tab-group="tabgrp-659" data-tab-active="true">

```Java
- void onLocationUpdateRequired()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-659-1" data-tab-group="tabgrp-659">

```Kotlin
fun onLocationUpdateRequired()
```

</div>
</div>


---
---

### 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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-660">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-660-0" data-tab-group="tabgrp-660" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-660-1" data-tab-group="tabgrp-660">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-660-0" data-tab-group="tabgrp-660" data-tab-active="true">

```Java
- void onLoad(ContentWidget contentWidget)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-660-1" data-tab-group="tabgrp-660">

```Kotlin
fun onLoad(contentWidget:ContentWidget)
```

</div>
</div>


| 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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-661">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-661-0" data-tab-group="tabgrp-661" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-661-1" data-tab-group="tabgrp-661">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-661-0" data-tab-group="tabgrp-661" data-tab-active="true">

```Java
- void onLoadingError(ContentWidget contentWidget, ApiError apiError)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-661-1" data-tab-group="tabgrp-661">

```Kotlin
fun onLoadingError(contentWidget:ContentWidget, apiError:ApiError)
```

</div>
</div>


| 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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-662">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-662-0" data-tab-group="tabgrp-662" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-662-1" data-tab-group="tabgrp-662">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-662-0" data-tab-group="tabgrp-662" data-tab-active="true">

```Java
- void onClickActionReceive(ContentWidget contentWidget, BaseModel model)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-662-1" data-tab-group="tabgrp-662">

```Kotlin
fun onClickActionReceive(contentWidget:ContentWidget, model:BaseModel)
```

</div>
</div>


| 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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-663">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-663-0" data-tab-group="tabgrp-663" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-663-1" data-tab-group="tabgrp-663">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-663-0" data-tab-group="tabgrp-663" data-tab-active="true">

```Java
- void onLoading(ContentWidget contentWidget, boolean isLoading)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-663-1" data-tab-group="tabgrp-663">

```Kotlin
fun onLoading(contentWidget:ContentWidget, isLoading:Boolean)
```

</div>
</div>


| 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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-664">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-664-0" data-tab-group="tabgrp-664" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-664-1" data-tab-group="tabgrp-664">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-664-0" data-tab-group="tabgrp-664" data-tab-active="true">

```Java
- void onSizeChange(ContentWidget contentWidget, ViewGroup.LayoutParams size)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-664-1" data-tab-group="tabgrp-664">

```Kotlin
fun onSizeChange(contentWidget:ContentWidget, size:ViewGroup.LayoutParams)
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **contentWidget** | [ContentWidget](/developers/mobile-sdk/class-reference/android/content-widget#contentwidget) | The widget instance that called the listener method |
| **size** | ViewGroup.LayoutParams | Widget's new size |




# Android

## Configuring push notifications (Android)

### Prerequisites
---
Google Firebase Cloud Messaging is necessary to handle [Mobile Campaigns](/docs/campaign/Mobile) sent from Synerise.

1. Follow the instructions in [this article](https://firebase.google.com/docs/storage/android/start).
2. Integrate the Firebase project with Synerise. See [this article](/docs/settings/tool/firebase).

Documentation on how to prepare your first push notification is available in our [user guide](/docs/campaign/Mobile).

### Set up Firebase Cloud Messaging for Synerise SDK
---

1. Register your service in the AndroidManifest:
   
   <pre><code class="language-XML">&lt;application
              android:name=".App"
              android:allowBackup="true"
              android:icon="@mipmap/ic_launcher"
              android:label="@string/app_name"
              android:roundIcon="@mipmap/ic_launcher_round"
              android:supportsRtl="true"
              android:theme="@style/AppTheme"&gt;
              ...
              &lt;service android:name=".service.MyFirebaseMessagingService"&gt;
                  &lt;intent-filter&gt;
                      &lt;action android:name="com.google.firebase.MESSAGING_EVENT" /&gt;
                  &lt;/intent-filter&gt;
              &lt;/service&gt;
          &lt;/application&gt;</code></pre>

2. In your application, implement registration for Firebase notifications:
   
   <div class="content-tabs code-tabs" data-tab-group="tabgrp-527">
   <div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-527-0" data-tab-group="tabgrp-527" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-527-1" data-tab-group="tabgrp-527">kotlin</button></div>

   <div class="tab-panel" data-tab-id="tabgrp-527-0" data-tab-group="tabgrp-527" data-tab-active="true">

   ```java
   public class App extends MultiDexApplication implements OnRegisterForPushListener {

          private static final String TAG = App.class.getSimpleName();

          @Override
          public void onCreate() {
              super.onCreate();

               Synerise.Builder.with(this, syneriseClientApiKey, appId)
                                      .notificationIcon(R.drawable.ic_notification_icon)
                                      .pushRegistrationRequired(this)
                                      ...
                                      .build();
          }

          @Override
          public void onRegisterForPushRequired() {
              FirebaseInstanceId.getInstance().getInstanceId().addOnSuccessListener(instanceIdResult -> {
                  String refreshedToken = instanceIdResult.getToken();
                  Log.d(TAG, "Refreshed token: " + refreshedToken);

                  IApiCall call = Client.registerForPush(refreshedToken, true);
                  call.execute(() -> Log.d(TAG, "Register for Push succeed: " + refreshedToken),
                               apiError -> Log.w(TAG, "Register for push failed: " + refreshedToken));
              });
          }
      }
   ```

   </div>

   <div class="tab-panel" data-tab-id="tabgrp-527-1" data-tab-group="tabgrp-527">

   ```kotlin
   class App:MultiDexApplication(), OnRegisterForPushListener {
        fun onCreate() {
          super.onCreate()
          Synerise.Builder.with(this, syneriseClientApiKey, appId)
          .notificationIcon(R.drawable.ic_notification_icon)
          .pushRegistrationRequired(this)
          build()
        }
        fun onRegisterForPushRequired() {
          FirebaseInstanceId.getInstance().getInstanceId().addOnSuccessListener({ instanceIdResult->
            val refreshedToken = instanceIdResult.getToken()
            Log.d(TAG, "Refreshed token: " + refreshedToken)
            val call = Client.registerForPush(refreshedToken, true)
            call.execute({ Log.d(TAG, "Register for Push succeed: " + refreshedToken) },
              { apiError-> Log.w(TAG, "Register for push failed: " + refreshedToken) }) })
        }
        companion object {
          private val TAG = App::class.java!!.getSimpleName()
        }
      }
   ```

   </div>
   </div>


   
   <div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

   The second parameter of the registration method is the agreement for mobile push campaigns. In the Profile's card in Synerise, you can find it in the **Subscriptions** section (if you have the required access permission). Learn more about the [Client.registerForPush(token, mobilePushAgreement) method in the method reference](/developers/mobile-sdk/method-reference/android/campaigns#register-for-push-notifications).

   </div></div></div>


3. Add registerForPush method inside onNewToken callback. This should be done in your class which extends FirebaseMessagingService
   
   <div class="content-tabs code-tabs" data-tab-group="tabgrp-528">
   <div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-528-0" data-tab-group="tabgrp-528" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-528-1" data-tab-group="tabgrp-528">kotlin</button></div>

   <div class="tab-panel" data-tab-id="tabgrp-528-0" data-tab-group="tabgrp-528" data-tab-active="true">

   ```java
   @Override
          public void onNewToken(String refreshedToken) {
              super.onNewToken(refreshedToken);

              Log.d(TAG, "Refreshed token: " + refreshedToken);

              if (refreshedToken != null) {
                  IApiCall call = Client.registerForPush(refreshedToken, true);
                  call.execute(() -> Log.d(TAG, "Register for Push succeed: " + refreshedToken),
                               apiError -> Log.w(TAG, "Register for push failed: " + refreshedToken));
              }
          }
   ```

   </div>

   <div class="tab-panel" data-tab-id="tabgrp-528-1" data-tab-group="tabgrp-528">

   ```kotlin
   fun onNewToken(refreshedToken:String) {
        super.onNewToken(refreshedToken)
        Log.d(TAG, "Refreshed token: " + refreshedToken)
        if (refreshedToken != null)
        {
          val call = Client.registerForPush(refreshedToken, true)
          call.execute({ Log.d(TAG, "Register for Push succeed: " + refreshedToken) },
                       { apiError-> Log.w(TAG, "Register for push failed: " + refreshedToken) })
        }
      }
   ```

   </div>
   </div>

4. Pass the incoming push notification payload to the `Injector` in your `FirebaseMessagingService` implementation:
   
   <div class="content-tabs code-tabs" data-tab-group="tabgrp-529">
   <div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-529-0" data-tab-group="tabgrp-529" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-529-1" data-tab-group="tabgrp-529">kotlin</button></div>

   <div class="tab-panel" data-tab-id="tabgrp-529-0" data-tab-group="tabgrp-529" data-tab-active="true">

   ```java
   public class MyFirebaseMessagingService extends FirebaseMessagingService {

          @Override
          public void onMessageReceived(RemoteMessage remoteMessage) {
              super.onMessageReceived(remoteMessage);

              boolean isSynerisePush = Injector.handlePushPayload(remoteMessage.getData());
          }
      }
   ```

   </div>

   <div class="tab-panel" data-tab-id="tabgrp-529-1" data-tab-group="tabgrp-529">

   ```kotlin
   class MyFirebaseMessagingService:FirebaseMessagingService() {
        fun onMessageReceived(remoteMessage:RemoteMessage) {
          super.onMessageReceived(remoteMessage)
          val isSynerisePush = Injector.handlePushPayload(remoteMessage.getData())
        }
      }
   ```

   </div>
   </div>

      Overriding `onMessageReceived(RemoteMessage)` stops simple notifications from being displayed while the app is the active screen.
      
5. In order to configure a notification icon and notification icon color, you need to set the following two parameters in `AndroidManifest.xml`, in the `application` section:
  
   <pre><code class="language-XML">&lt;meta-data
               android:name="com.synerise.sdk.messaging.notification_icon"
               android:resource="@drawable/ic_notification_icon" /&gt;
      &lt;meta-data
               android:name="com.synerise.sdk.messaging.notification_icon_color"
               android:resource="@color/amaranth" /&gt;</code></pre>
  
   The default values are: `android icon` and `white color`.  

   
   <div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

   Check [the repository of our sample app](https://github.com/Synerise/android-sdk) for an example usage of building your non-Synerise notification.

   </div></div></div>


### Keep Firebase token always up-to-date
---
You must always keep the Firebase token updated. 

- Whenever the user changes the notification consent in the system or the application, you should call the `registerForPush` method ([Android](/developers/mobile-sdk/method-reference/android/campaigns#register-for-push-notifications); [iOS](/developers/mobile-sdk/method-reference/ios/campaigns#register-for-push-notifications), [Flutter](/developers/mobile-sdk/method-reference/flutter/campaigns), [React Native](/developers/mobile-sdk/method-reference/react-native/campaigns)).
- In many cases in the application lifecycle, such as authorization, destroyed sessions, user context change, periodic jobs ([Work Manager](/developers/mobile-sdk/installation-and-configuration/android#work-manager)), and so on, the SDK invokes the [snr_registerForPushNotificationsIsNeeded(origin)](/developers/mobile-sdk/listeners-and-delegates/android-listeners#on-register-for-push-listener-on-register-for-push-required-with-origin) method or [snr_registerForPushNotificationsIsNeeded()](/developers/mobile-sdk/listeners-and-delegates/android-listeners#on-register-for-push-listener-on-register-for-push-required) method.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

[Work Manager](/developers/mobile-sdk/installation-and-configuration/android#work-manager) allows you to keep the Firebase token updated even if the host application is not launched for a long time. It launches your app in the background approximately every 20 days and refreshes the token so it stays up to date.

</div></div></div>


#### Assign notifications to channels
Starting with Android 8.0 (API level 26), all notifications must be assigned to a channel. Otherwise, they are not displayed.

You can implement notifications in one of the following ways:

- If you already have a channel defined in your application, use the `notificationDefaultChannelId(String)` and `NotificationHighPriorityChannelId(String)` methods of Builder during SDK initialization.
- You cannot configure more than two notification channels.
- If you want the SDK to set the channel names to default (same as the application name), initialize the SDK without the methods mentioned above.

### Callback methods
---


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

[NotificationListener](/developers/mobile-sdk/listeners-and-delegates/android-listeners#on-notification-listener) is available from SDK 4.9.0 version.

</div></div></div>


If you want to receive callbacks to inform the application about notification's state, implement `OnNotificationListener` using the `Injector.setOnNotificationListener` method.

For details, see [this article](/developers/mobile-sdk/listeners-and-delegates/android-listeners#on-notification-listener).

See sample code from the application below:

<div class="content-tabs code-tabs" data-tab-group="tabgrp-530">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-530-0" data-tab-group="tabgrp-530" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-530-1" data-tab-group="tabgrp-530">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-530-0" data-tab-group="tabgrp-530" data-tab-active="true">

```java
Injector.setOnNotificationListener(new OnNotificationListener() {
            @Override
            public void onNotificationReceived(NotificationInfo notificationInfo) {
            }

            @Override
            public void onNotificationClicked(NotificationInfo notificationInfo) {
            }

            @Override
            public void onNotificationDismissed(NotificationInfo notificationInfo) {
            }

            @Override
            public void onActionButtonClicked(NotificationInfo notificationInfo, String actionButton) {
            }
        });
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-530-1" data-tab-group="tabgrp-530">

```kotlin
Injector.setOnNotificationListener(
    object callback: OnNotificationListener() {
        override fun onNotificationReceived(notificationInfo: NotificationInfo) {
        }

        override fun onNotificationClicked(notificationInfo: NotificationInfo) { 
        }

        override fun onNotificationDismissed(notificationInfo: NotificationInfo) {  
        }

        override fun onActionButtonClicked(
            notificationInfo: NotificationInfo,
            actionButton: String) {
        }
    })
```

</div>
</div>


### Configure notification encryption
---

To enable encrypted push notifications, you must change the configuration of your workspace in the Synerise Platform. For details, read [Google Firebase](/docs/settings/tool/firebase).

In the mobile application, you must set `encryption` to `true` in the notification settings. 


<div class="content-tabs code-tabs" data-tab-group="tabgrp-531">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-531-0" data-tab-group="tabgrp-531" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-531-1" data-tab-group="tabgrp-531">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-531-0" data-tab-group="tabgrp-531" data-tab-active="true">

```java
Synerise.settings.notifications.setEncryption(true);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-531-1" data-tab-group="tabgrp-531">

```kotlin
Synerise.settings.notifications.setEncryption(true)
```

</div>
</div>


The SDK performs the encryption as a part of the `Synerise.Notifications.handleNotification` method.

If you use only the `"Synerise"` issuer in push notifications, no more actions are required.

If you need custom integration of encrypted push notifications, implement the following solution:


<div class="content-tabs code-tabs" data-tab-group="tabgrp-532">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-532-0" data-tab-group="tabgrp-532" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-532-1" data-tab-group="tabgrp-532">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-532-0" data-tab-group="tabgrp-532" data-tab-active="true">

```java
Map<String, String> data = remoteMessage.getData();
    if (Injector.isPushEncrypted(data)) {
        data = Injector.decryptPushPayload(data);
    }
// your operations on push notification
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-532-1" data-tab-group="tabgrp-532">

```kotlin
val data = remoteMessage.getData()
    if (Injector.isPushEncrypted(data)) {
        data = Injector.decryptPushPayload(data)
    }
// your operations on push notification
```

</div>
</div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The `decryptPushPayload` method returns raw data when the payload is not encrypted. If the crypter fails, the method returns null.<br/>

For more information, read [the description of the decryption method](/developers/mobile-sdk/method-reference/android/campaigns#decrypt-push-notification).

</div></div></div>


### Handling actions from push notifications
---
- [Read more about types of actions in campaigns](/developers/mobile-sdk/campaigns/action-handling#types-of-actions-in-campaigns)  
- [Read more about handling actions from push notifications](/developers/mobile-sdk/campaigns/action-handling)  



# SDK lifecycle


## Set Synerise delegate
---
This method sets an object for Synerise delegate methods.
**Declared In:**  
Headers/SNRSynerise.h
  
**Related To:**  
[SyneriseDelegate](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#synerise-delegate)  
  
**Class:**  
Synerise
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1140">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1140-0" data-tab-group="tabgrp-1140" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1140-1" data-tab-group="tabgrp-1140">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1140-0" data-tab-group="tabgrp-1140" data-tab-active="true">

```Swift
static func setDelegate(_ delegate: SyneriseDelegate)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1140-1" data-tab-group="tabgrp-1140">

```Objective-C
+ (void)setDelegate:(SNRSyneriseDelegate *)delegate
```

</div>
</div>

  
**Discussion:**  
Learn more about the methods and the purpose of this listener [here](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#synerise-delegate).

## Initialization
---
This method initializes Synerise.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This method must be called before any other Synerise SDK method and only once during the application's lifecycle.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRSynerise.h
  
**Class:**  
[Synerise](/developers/mobile-sdk/class-reference/ios/modules#synerise)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1141">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1141-0" data-tab-group="tabgrp-1141" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1141-1" data-tab-group="tabgrp-1141">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1141-0" data-tab-group="tabgrp-1141" data-tab-active="true">

```Swift
static func initialize(apiKey: String) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1141-1" data-tab-group="tabgrp-1141">

```Objective-C
+ (void)initializeWithApiKey:(NSString *)apiKey
```

</div>
</div>

  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Before version 5.0.0, this method was called `Synerise.initialize(clientApiKey:)`.

</div></div></div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **apiKey** | String | yes | - | Synerise Profile (formerly Client) API Key |
  
**Return Value:**  
No value is returned.

**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1142">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1142-0" data-tab-group="tabgrp-1142" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1142-1" data-tab-group="tabgrp-1142">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1142-0" data-tab-group="tabgrp-1142" data-tab-active="true">

```Swift
let apiKey = "YOUR_PROFILE_API_KEY"
Synerise.initialize(apiKey: apiKey)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1142-1" data-tab-group="tabgrp-1142">

```Objective-C
static NSString *apiKey = @"YOUR_PROFILE_API_KEY";
[SNRSynerise initializeWithApiKey:apiKey];
```

</div>
</div>


<!-- reusable-table-boundary -->

## Initialize with custom environment
---
This method initializes Synerise SDK with custom environment settings.  
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This method must be called before any other Synerise SDK method and only once during the application's lifecycle.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRSynerise.h
  
**Class:**  
[Synerise](/developers/mobile-sdk/class-reference/ios/modules#synerise)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1143">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1143-0" data-tab-group="tabgrp-1143" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1143-1" data-tab-group="tabgrp-1143">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1143-0" data-tab-group="tabgrp-1143" data-tab-active="true">

```Swift
static func initialize(apiKey: String, baseUrl: String?) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1143-1" data-tab-group="tabgrp-1143">

```Objective-C
+ (void)initializeWithApiKey:(NSString *)apiKey andBaseUrl:(nullable NSString *)baseUrl
```

</div>
</div>

  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Before version 5.0.0, this method was called `Synerise.initialize(clientApiKey:baseUrl:)`.

</div></div></div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **apiKey** | String | yes | - | Synerise Profile (formerly Client) API Key |
| **baseUrl** | String | no | - | Synerise API custom environment base URL |
  
You can use one of the constants:

<div class="content-tabs" data-tab-group="tabgrp-1153">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1153-0" data-tab-group="tabgrp-1153" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1153-1" data-tab-group="tabgrp-1153">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1153-0" data-tab-group="tabgrp-1153" data-tab-active="true">

**SyneriseApiUrls.SYNERISE_AZ_API_URL** -  `https://api.snrapi.com`  
**SyneriseApiUrls.SYNERISE_AZU_API_URL** - `https://api.azu.snrapi.com`  
**SyneriseApiUrls.SYNERISE_GEB_API_URL** - `https://api.geb.snrapi.com`

</div>

<div class="tab-panel" data-tab-id="tabgrp-1153-1" data-tab-group="tabgrp-1153">

**SNR_SYNERISE_AZ_API_URL** - `https://api.snrapi.com`  
**SNR_SYNERISE_AZU_API_URL** - `https://api.azu.snrapi.com`  
**SNR_SYNERISE_GEB_API_URL** - `https://api.geb.snrapi.com`

</div>
</div>


**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1144">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1144-0" data-tab-group="tabgrp-1144" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1144-1" data-tab-group="tabgrp-1144">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1144-0" data-tab-group="tabgrp-1144" data-tab-active="true">

```Swift
let apiKey = "YOUR_PROFILE_API_KEY"
let apiBaseUrl = "YOUR_API_BASE_URL"
Synerise.initialize(apiKey: apiKey, baseUrl: apiBaseUrl)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1144-1" data-tab-group="tabgrp-1144">

```Objective-C
static NSString *apiKey = @"YOUR_PROFILE_API_KEY";
static NSString *apiBaseUrl = @"YOUR_API_BASE_URL";
[SNRSynerise initializeWithApiKey:apiKey andBaseUrl:apiBaseUrl];
```

</div>
</div>


<!-- reusable-table-boundary -->

## Change Profile API Key dynamically
---
This method changes a Profile (formerly Client) API key dynamically.
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRSynerise.h
  
**Class:**  
[Synerise](/developers/mobile-sdk/class-reference/ios/modules#synerise)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1145">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1145-0" data-tab-group="tabgrp-1145" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1145-1" data-tab-group="tabgrp-1145">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1145-0" data-tab-group="tabgrp-1145" data-tab-active="true">

```Swift
static func changeApiKey(_ apiKey: String) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1145-1" data-tab-group="tabgrp-1145">

```Objective-C
+ (void)changeApiKey:(nonnull NSString *)apiKey
```

</div>
</div>

  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Before version 5.0.0, this method was called `Synerise.changeClientApiKey(_ clientApiKey:)`.

</div></div></div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **apiKey** | String | yes | - | Synerise Profile API Key (formerly Client API key) |
  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->

## Change Profile API Key dynamically with config
---
<!-- reusable-table-boundary -->

This method changes a Profile (formerly Client) API key dynamically, with additional parameters. It can include a salt for [Simple Profile Authentication](/developers/mobile-sdk/user-identification-and-authorization/simple-authentication) requests.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.19.0 | 5.20.0 | 0.23.0 | 1.3.0 |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRSynerise.h
  
**Class:**  
[Synerise](/developers/mobile-sdk/class-reference/ios/modules#synerise)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1146">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1146-0" data-tab-group="tabgrp-1146" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1146-1" data-tab-group="tabgrp-1146">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1146-0" data-tab-group="tabgrp-1146" data-tab-active="true">

```Swift
static func changeApiKey(_ apiKey: String, config: InitializationConfig?) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1146-1" data-tab-group="tabgrp-1146">

```Objective-C
+ (void)changeApiKey:(nonnull NSString *)apiKey config:(nullable SNRInitializationConfig *)config;
```

</div>
</div>

  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Before version 5.0.0, this method was called `Synerise.changeClientApiKey(_ clientApiKey:config:)`.

</div></div></div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **apiKey** | String | yes | - | Synerise Profile API Key (formerly Client API key) |
| **config** | [InitializationConfig](/developers/mobile-sdk/class-reference/ios/lifecycle#initializationconfig) | no | - | Object for additional initialization settings after the API key change |
  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->

## Set Request Validation Salt
---
<!-- reusable-table-boundary -->

This method sets the salt string for request validation.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.14.0 | 5.7.1 | 0.15.0 | 0.7.0 |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRSynerise.h
  
**Class:**  
[Synerise](/developers/mobile-sdk/class-reference/ios/modules#synerise)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1147">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1147-0" data-tab-group="tabgrp-1147" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1147-1" data-tab-group="tabgrp-1147">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1147-0" data-tab-group="tabgrp-1147" data-tab-active="true">

```Swift
static func setRequestValidationSalt(_: String?) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1147-1" data-tab-group="tabgrp-1147">

```Objective-C
+ (void)setRequestValidationSalt:(nullable NSString *)string
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **salt** | String | no | - | Synerise Profile salt string for request validation |
  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->

## Set up host application type
---
<!-- reusable-table-boundary -->

This method sets the Synerise SDK host application type.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.6.1 | 3.6.22 | - | - |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRSynerise.h
  
**Class:**  
[Synerise](/developers/mobile-sdk/class-reference/ios/modules#synerise)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1148">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1148-0" data-tab-group="tabgrp-1148" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1148-1" data-tab-group="tabgrp-1148">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1148-0" data-tab-group="tabgrp-1148" data-tab-active="true">

```Swift
static func setHostApplicationType(_ type: HostApplicationType) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1148-1" data-tab-group="tabgrp-1148">

```Objective-C
+ (void)setHostApplicationType:(SNRHostApplicationType)type
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **type** | [HostApplicationType](/developers/mobile-sdk/class-reference/ios/miscellaneous#hostapplicationtype) | yes | - | Specifies the type of host application |
  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->

## Set host application SDK plugin version
---
<!-- reusable-table-boundary -->

This method sets the Synerise SDK plugin version.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.14.6 | 5.11.0 | - | - |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRSynerise.h
  
**Class:**  
[Synerise](/developers/mobile-sdk/class-reference/ios/modules#synerise)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1149">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1149-0" data-tab-group="tabgrp-1149" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1149-1" data-tab-group="tabgrp-1149">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1149-0" data-tab-group="tabgrp-1149" data-tab-active="true">

```Swift
static func setHostApplicationSDKPluginVersion(_ version: String) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1149-1" data-tab-group="tabgrp-1149">

```Objective-C
+ (void)setHostApplicationSDKPluginVersion:(NSString *)version
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **version** | String | yes | - | Specifies the version of the Synerise SDK plugin in the host application |
  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->

## Enable Debug Mode
---
This method enables or disables console logs from Synerise SDK.  
  

<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

It is not recommended to use debug mode in the release version of your application.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRSynerise.h
  
**Class:**  
[Synerise](/developers/mobile-sdk/class-reference/ios/modules#synerise)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1150">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1150-0" data-tab-group="tabgrp-1150" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1150-1" data-tab-group="tabgrp-1150">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1150-0" data-tab-group="tabgrp-1150" data-tab-active="true">

```Swift
static func setDebugModeEnabled(_: Bool) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1150-1" data-tab-group="tabgrp-1150">

```Objective-C
+ (void)setDebugModeEnabled:(BOOL)enabled;
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **enabled** | Bool | yes | - | Enables or disables console logs |
  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->

## Enable Crash Handling
---
This method enables or disables crash handling by Synerise SDK.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

If set to true, Synerise SDK will send the `client.applicationCrashed` event with information about crash.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRSynerise.h
  
**Class:**  
[Synerise](/developers/mobile-sdk/class-reference/ios/modules#synerise)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1151">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1151-0" data-tab-group="tabgrp-1151" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1151-1" data-tab-group="tabgrp-1151">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1151-0" data-tab-group="tabgrp-1151" data-tab-active="true">

```Swift
static func setCrashHandlingEnabled(_: Bool) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1151-1" data-tab-group="tabgrp-1151">

```Objective-C
+ (void)setCrashHandlingEnabled:(BOOL)enabled
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **enabled** | Bool | yes | - | Enables or disables crash handling |
  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->

## Set Background Task identifiers
---
<!-- reusable-table-boundary -->

This method sets identifiers for Background Tasks processing.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.23.0 | - | - | - |


<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Do not use those identifiers for other Background Tasks in your app.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRSynerise.h
  
**Class:**  
[Synerise](/developers/mobile-sdk/class-reference/ios/modules#synerise)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1152">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1152-0" data-tab-group="tabgrp-1152" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1152-1" data-tab-group="tabgrp-1152">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1152-0" data-tab-group="tabgrp-1152" data-tab-active="true">

```Swift
static func setBackgroundTaskIdentifiers(_: [String]) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1152-1" data-tab-group="tabgrp-1152">

```Objective-C
+ (void)setBackgroundTaskIdentifiers:(NSArray<NSString *> *)identifiers
```

</div>
</div>



**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **identifiers** | [String] | yes | - | Identifiers for Background Tasks registered in the host appliaction. |
  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->


# SDK Lifecycle


### InitializationConfig
<!-- reusable-table-boundary -->

Class for additional initialization parameters.

**Declared In:**  
lib/classes/models/Misc/InitializationConfig.js

**Declaration:**  

<pre><code class="language-TypeScript">class InitializationConfig</code></pre>


**Properties:**
| Property | Type | Description |
| --- | --- | --- |
| **requestValidationSalt** | string | [Simple Profile Authentication](/developers/mobile-sdk/user-identification-and-authorization/simple-authentication) salt |

<!-- reusable-table-boundary -->

---
---

### Synerise
<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/Synerise.js  
  
**Declaration:**  

<pre><code class="language-TypeScript">class Synerise</code></pre>

  
**Properties:**
| Property | Type | Description |
| --- | --- | --- |
| **Initializer** | [SyneriseInitializer](/developers/mobile-sdk/class-reference/react-native/lifecycle#syneriseinitializer) | Returns the [SyneriseInitializer](/developers/mobile-sdk/class-reference/react-native/lifecycle#syneriseinitializer) object used for initialization |
| **Settings** | [SettingsModule](/developers/mobile-sdk/class-reference/react-native/modules#settings) | Returns the Settings module when Synerise is initialized |
| **Client** | [ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client) | Returns the Client module when Synerise is initialized |
| **Tracker** | [TrackerModule](/developers/mobile-sdk/class-reference/react-native/modules#tracker) | Returns the Tracker module when Synerise is initialized |
| **Notifications** | [NotificationsModule](/developers/mobile-sdk/class-reference/react-native/modules#notifications) | Returns the Notifications module when Synerise is initialized|
| **Injector** | [InjectorModule](/developers/mobile-sdk/class-reference/react-native/modules#injector) | Returns the Injector module when Synerise is initialized |
| **Promotions** | [PromotionsModule](/developers/mobile-sdk/class-reference/react-native/modules#promotions) | Returns the Promotions module when Synerise is initialized |
| **Content** | [ContentModule](/developers/mobile-sdk/class-reference/react-native/modules#content) | Returns the Content module when Synerise is initialized |

**Methods:**

This method sets the callback function that is invoked when the Synerise SDK is initialized.

<pre><code class="language-TypeScript">public static onReady(callback: () =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/listeners-and-delegates/react-native-listeners#initialization)

---

This method sets the callback function that is invoked when an error occurs while initializing the Synerise SDK.

<pre><code class="language-TypeScript">public static onError(callback: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/listeners-and-delegates/react-native-listeners#initialization)

---

This method checks if Synerise is initialized.

<pre><code class="language-TypeScript">public static isInitialized(): boolean</code></pre>


---

This method changes the Profile API Key (formerly Client API Key) dynamically.

<pre><code class="language-TypeScript">public static changeApiKey(ApiKey: string, config?: InitializationConfig | undefined)</code></pre>


---

<!-- reusable-table-boundary -->

---
---

### SyneriseInitializer
Class responsible for initialization of the SDK.
  
**Declared In:**  
lib/main/Synerise.js  
  
**Declaration:**

<pre><code class="language-TypeScript">class SyneriseInitializer</code></pre>

  
**Methods:**

This method sets Profile API Key (formerly Client API Key) for the SDK initialization.

<pre><code class="language-TypeScript">public withApiKey(ApiKey: string)</code></pre>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Before version 1.0.0, this method was called `withClientApiKey`.

</div></div></div>


---

This method sets the Synerise API base URL for SDK initialization in a custom environment.

<pre><code class="language-TypeScript">public withBaseUrl(baseUrl: string)</code></pre>


---

This method sets the salt string for request validation.

<pre><code class="language-TypeScript">public withRequestValidationSalt(requestValidationSalt: string)</code></pre>


---

This method enables or disables console logs from Synerise SDK.

<pre><code class="language-TypeScript">public withDebugModeEnabled(debugModeEnabled: boolean)</code></pre>


---

This method enables or disables crash handling by Synerise SDK.

<pre><code class="language-TypeScript">public withCrashHandlingEnabled(crashHandlingEnabled: boolean)</code></pre>


---

This method sets the required settings prior to the Synerise initialization.

<pre><code class="language-TypeScript">public withSettings(settings: ISettingsOptions)</code></pre>


---

This method initializes Synerise.

<pre><code class="language-TypeScript">public init()</code></pre>


---

---
---






# SDK lifecycle


---
## Initialization
---
This method initializes Synerise.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This method must be called before any other Synerise SDK method and only once during the application's lifecycle.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/synerise_initializer.dart

**Class:**  
[Synerise](/developers/mobile-sdk/class-reference/flutter/lifecycle#synerise)  
[SyneriseInitializer](/developers/mobile-sdk/class-reference/flutter/lifecycle#syneriseinitializer)  
  
**Builder Parameters:**
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **withBaseUrl** | String | no | - | Synerise API custom environment base URL |
| **withApiKey** | String | yes | - | Synerise Profile (formerly Client) API Key |
| **withDebugModeEnabled** | bool | no | - | Enables or disables console logs |
| **withCrashHandlingEnabled** | bool | no | - | Enables or disables crash handling |
| **setRequestValidationSalt** | String | no | - | Sets salt string for request validation |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Before version 2.0.0, the `withApiKey` method was called `withClientApiKey`.

</div></div></div>


**Return Value:**  
No value is returned.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-985">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-985-0" data-tab-group="tabgrp-985" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-985-0" data-tab-group="tabgrp-985" data-tab-active="true">

```Dart
Synerise.initializer()
  .withBaseUrl("YOUR_API_BASE_URL")
  .withApiKey("YOUR_PROFILE_API_KEY")
  .withDebugModeEnabled(false)
.init();
```

</div>
</div>


<!-- reusable-table-boundary -->

## Change Profile API Key dynamically
---
This method changes a Profile (formerly Client) API key dynamically.
<!-- reusable-table-boundary -->

**Declared In:**  
lib/synerise.dart
  
**Class:**  
[Synerise](/developers/mobile-sdk/class-reference/flutter/lifecycle#synerise)
  
**Declaration:**  

<pre><code class="language-Dart">static Future&lt;void&gt; changeApiKey(String apiKey, [InitializationConfig? config]) async</code></pre>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Before version 2.0.0, this method was called `changeClientApiKey`.

</div></div></div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **clientApiKey** | String | yes | - | Synerise Profile API Key (formerly Client API key) |
| **config** | [InitializationConfig](/developers/mobile-sdk/class-reference/flutter/lifecycle#initializationconfig) | no | - | Object for additional initialization settings after the API key change |
  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->

## Change Profile API Key dynamically with config
---
<!-- reusable-table-boundary -->

This method changes a Profile (formerly Client) API key dynamically, with additional parameters. It can include a salt for [Simple Profile Authentication](/developers/mobile-sdk/user-identification-and-authorization/simple-authentication) requests.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.19.0 | 5.20.0 | 0.23.0 | 1.3.0 |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/synerise.dart
  
**Class:**  
[Synerise](/developers/mobile-sdk/class-reference/flutter/lifecycle#synerise)
  
**Declaration:**  

<pre><code class="language-Dart">static Future&lt;void&gt; changeApiKey(String apiKey, [InitializationConfig? config]) async</code></pre>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Before version 2.0.0, this method was called `changeClientApiKey`.

</div></div></div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **clientApiKey** | String | yes | - | Synerise Profile API Key (formerly Client API key) |
| **config** | [InitializationConfig](/developers/mobile-sdk/class-reference/flutter/lifecycle#initializationconfig) | no | - | Object for additional initialization settings after the API key change |
  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->

## Set up Debug Mode
---
This method enables or disables console logs from Synerise SDK.  
  

<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

It is not recommended to use debug mode in the release version of your application.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/synerise_initializer.dart

**Class:**  
[Synerise](/developers/mobile-sdk/class-reference/flutter/lifecycle#synerise)
  
**Declaration:**  

<pre><code class="language-Dart">.withDebugModeEnabled(bool debugModeEnabled)</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **enabled** | Bool | yes | - | Enables or disables console logs |
  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->

## Enable Crash Handling
---
This method enables or disables crash handling by Synerise SDK.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

If set to true, Synerise SDK will send the `client.applicationCrashed` event with information about crash.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/synerise_initializer.dart

**Class:**  
[Synerise](/developers/mobile-sdk/class-reference/flutter/lifecycle#synerise)
  
**Declaration:**  

<pre><code class="language-Dart">.withCrashHandlingEnabled(bool crashHandlingEnabled)</code></pre>

    
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **enabled** | Bool | yes | - | Enables or disables crash handling |
  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->

## Set Request Validation Salt
---
<!-- reusable-table-boundary -->

This method sets the salt string for request validation.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.14.0 | 5.7.1 | 0.15.0 | 0.7.0 |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/synerise_initializer.dart
  
**Class:**  
[Synerise](/developers/mobile-sdk/class-reference/flutter/lifecycle#synerise)
  
**Declaration:**  

<pre><code class="language-Dart">.setRequestValidationSalt(String requestValidationSalt)</code></pre>

  
  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **string** | String | yes | - | Synerise Profile salt string for request validation |
  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->



# Profile identification


## Anonymous customers
---
When you initialize the SDK, on the first start a UUID is generated and a JWT token is retrieved for an *anonymous customer*. The customer in this scenario is fully anonymous within the system and does not contain any personal information.

Such a token allows some basic operations such as tracking events of anonymous customers, sending in-app messages, push notifications, display documents and more. However, better profile identification and management with extra features is provided when a customer is logged in.


## Recognized customers
---
When an anonymous profile provides the unique identifier, the anonymous profile in the database is updated with new data. It becomes a known customer profile, which means that any activity before the customer was recognized is still present in the profile’s history.

You can operate on personal information without fully authenticating a customer.
You may have already imported customer data into Synerise and you have personal information in the system. The data can be linked.

In such cases, you need to authenticate through your own backend systems. Before you can do that, you must merge the UUIDs from the SDK with a specific customer:
1. Retrieve the customer UUID generated by Synerise SDK.
2. Process the UUID in your own backend. If you use 3rd party authorization, you may need to pass this UUID into other systems.
3. Authorize the customer and match their identifier (loyalty card number, email address, or another type of identifier used in your system) with the customer UUID from Synerise.
4. Provide the customer UUID back to Synerise with all the additional information collected through the authorization process.  
    
   <div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

   Sending this data directly from the application itself is highly discouraged and may cause authorization issues.

   </div></div></div>


We recommend this customer recognition process to advanced clients. If you are a new Synerise clients and would like to run this kind of integration, you can contact us through [this form](https://hgintelligence.atlassian.net/servicedesk/customer/portal/1).

## Authenticated customers
---
Synerise offers a means to fully authenticate customers and create customer sessions with JWT tokens that have access to all the features provided by Synerise.  

Three authentication methods are supported:
- [Simple Profile Authentication](/developers/mobile-sdk/user-identification-and-authorization/simple-authentication)
- [Synerise Authentication](/developers/mobile-sdk/user-identification-and-authorization/synerise-authentication)
- [OAuth](/developers/mobile-sdk/user-identification-and-authorization/oauth)
    
  <div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

  This is the recommended authentication method.

  </div></div></div>

- [Facebook Login](/developers/mobile-sdk/user-identification-and-authorization/authenticate-external-providers#facebook-login)
- [Sign in with Apple](/developers/mobile-sdk/user-identification-and-authorization/authenticate-external-providers#sign-in-with-apple)
    
  <div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

  Available only for iOS and React Native (iOS).

  </div></div></div>



# SDK Lifecycle


## InitializationConfig
<!-- reusable-table-boundary -->

Class for additional initialization parameters.

**Declared In:**  
lib/main/initialization_config.dart

**Declaration:**  

<pre><code class="language-dart">class InitializationConfig</code></pre>


**Properties**
| Property | Type | Description |
| --- | --- | --- |
| **requestValidationSalt** | String | [Simple Profile Authentication](/developers/mobile-sdk/user-identification-and-authorization/simple-authentication) salt |

<!-- reusable-table-boundary -->

---
---

## Synerise
<!-- reusable-table-boundary -->

Main SDK class responsible for managing all Synerise modules and core features.
  
**Declared In:**  
lib/synerise.dart 

**Related To:**  
[SyneriseInitializer](/developers/mobile-sdk/class-reference/flutter/lifecycle#syneriseinitializer)  
[SettingsImpl](/developers/mobile-sdk/class-reference/flutter/modules#settings)  
[NotificationsImpl](/developers/mobile-sdk/class-reference/flutter/modules#notifications)  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)  
[TrackerImpl](/developers/mobile-sdk/class-reference/flutter/modules#tracker)  
[InjectorImpl](/developers/mobile-sdk/class-reference/flutter/modules#injector)  
[ContentImpl](/developers/mobile-sdk/class-reference/flutter/modules#content)  

**Declaration:**

<pre><code class="language-Dart">class Synerise</code></pre>


**Properties:**
| Property | Type | Description |
| --- | --- | --- |
| **settings** | [SettingsImpl](/developers/mobile-sdk/class-reference/flutter/modules#settings) | Returns the Settings module |
| **notifications** | [NotificationsImpl](/developers/mobile-sdk/class-reference/flutter/modules#notifications) | Returns the Notifications module |
| **client** | [ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client) | Returns the Client module |
| **tracker** | [TrackerImpl](/developers/mobile-sdk/class-reference/flutter/modules#tracker) | Returns the Tracker module |
| **injector** | [InjectorImpl](/developers/mobile-sdk/class-reference/flutter/modules#injector) | Returns the Injector module |
| **content** | [ContentImpl](/developers/mobile-sdk/class-reference/flutter/modules#content) | Returns the Content module |
  
**Methods:**

This method initializes Synerise.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-161">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-161-0" data-tab-group="tabgrp-161" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-161-0" data-tab-group="tabgrp-161" data-tab-active="true">

```Dart
static SyneriseInitializer initializer()
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/lifecycle#initialization)

---

This method changes a Profile (formerly Client) API key dynamically.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-162">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-162-0" data-tab-group="tabgrp-162" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-162-0" data-tab-group="tabgrp-162" data-tab-active="true">

```Dart
SyneriseInitializer changeApiKey(String apiKey)
```

</div>
</div>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/lifecycle#change-profile-api-key-dynamically)

---

<!-- reusable-table-boundary -->

---
---

## SyneriseInitializer
Class responsible for initialization of the SDK.
  
**Declared In:**  
lib/main/synerise_initializer.dart  
  
**Declaration:**

<pre><code class="language-Dart">class SyneriseInitializer</code></pre>


**Methods:**

This method sets Profile API Key (formerly Client API Key) for the SDK initialization.

<pre><code class="language-Dart">SyneriseInitializer withApiKey(String apiKey)</code></pre>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Before version 2.0.0, this method was called `withClientApiKey`.

</div></div></div>


---

This method sets the Synerise API base URL for SDK initialization in a custom environment.

<pre><code class="language-Dart">SyneriseInitializer withBaseUrl(String baseUrl)</code></pre>


---

This method sets the salt string for request validation.

<pre><code class="language-Dart">SyneriseInitializer setRequestValidationSalt(String requestValidationSalt)</code></pre>


---

This method enables or disables console logs from Synerise SDK.

<pre><code class="language-Dart">SyneriseInitializer withDebugModeEnabled(bool debugModeEnabled)</code></pre>


---

This method enables or disables crash handling by Synerise SDK.

<pre><code class="language-Dart">SyneriseInitializer withCrashHandlingEnabled(bool crashHandlingEnabled)</code></pre>


---

This method chooses the type of mobile services to use:
- `gms` for Google Mobile Services (default)
- `hms` for Huawei Mobile Services (can only be used on Huawei devices)


<pre><code class="language-Dart">SyneriseInitializer setMessagingServiceType(String messagingServiceType)</code></pre>


---

This method initializes Synerise.

<pre><code class="language-Dart">Future&lt;void&gt; init() async</code></pre>





# SDK lifecycle


## Change Profile API Key dynamically
---
This method changes a Profile (formerly Client) API key dynamically.
<!-- reusable-table-boundary -->

**Method name:**  
Client.changeApiKey(newApiKey)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-900">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-900-0" data-tab-group="tabgrp-900" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-900-1" data-tab-group="tabgrp-900">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-900-0" data-tab-group="tabgrp-900" data-tab-active="true">

```java
public static void changeApiKey(@NonNull String newApiKey)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-900-1" data-tab-group="tabgrp-900">

```kotlin
fun changeApiKey(@NonNull newApiKey:String)
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **newApiKey** | String | yes | - | New API Key |


**Return Value:**  
Void type method.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-901">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-901-0" data-tab-group="tabgrp-901" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-901-1" data-tab-group="tabgrp-901">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-901-0" data-tab-group="tabgrp-901" data-tab-active="true">

```java
Client.changeApiKey(apiKey);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-901-1" data-tab-group="tabgrp-901">

```kotlin
Client.changeApiKey(apiKey);
```

</div>
</div>


<!-- reusable-table-boundary -->

## Change Profile API Key dynamically with config
---
<!-- reusable-table-boundary -->

This method changes a Profile (formerly Client) API key dynamically, with additional parameters. It can include a salt for [Simple Profile Authentication](/developers/mobile-sdk/user-identification-and-authorization/simple-authentication) requests.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.19.0 | 5.20.0 | 0.23.0 | 1.3.0 |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Method name:**  
Client.changeApiKey(apiKey, initializationConfig)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-902">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-902-0" data-tab-group="tabgrp-902" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-902-1" data-tab-group="tabgrp-902">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-902-0" data-tab-group="tabgrp-902" data-tab-active="true">

```java
public static void changeApiKey(String apiKey, InitializationConfig initializationConfig)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-902-1" data-tab-group="tabgrp-902">

```kotlin
fun changeApiKey(@NonNull apiKey:String, @Nullable initializationConfig:InitializationConfig)
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **apiKey** | String | yes | - | New API Key |
| **initializationConfig** | [InitializationConfig](/developers/mobile-sdk/class-reference/android/lifecycle#initializationconfig) | no | - | Object for additional initialization settings after the API key change |


**Return Value:**  
Void type method.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-903">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-903-0" data-tab-group="tabgrp-903" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-903-1" data-tab-group="tabgrp-903">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-903-0" data-tab-group="tabgrp-903" data-tab-active="true">

```java
Client.changeApiKey(apiKey, initializationConfig);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-903-1" data-tab-group="tabgrp-903">

```kotlin
Client.changeApiKey(apiKey, initializationConfig);
```

</div>
</div>


<!-- reusable-table-boundary -->



# Android

## Method reference - Android




# Android

## Installation and configuration (Android)

In this article, you will find out how to install, configure, and initialize the Synerise SDK in an Android mobile application. While performing the actions from this guide, keep the presented order.  


<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The [Settings](/developers/mobile-sdk/settings#pre-initialization-settings) article contains additional information about SDK behaviors you may need prior to configuration.

</div></div></div>
 

If you want to find out what kind of benefits you can get from integrating with mobile SDK, go [here](/developers/mobile-sdk/overview). 

### Requirements
---
You need:  
* Access to a [workspace](/docs/settings/workspace)
* A Profile [API Key](/docs/settings/tool/api#adding-api-keys)  
    When creating the API key, use allowlisting or denylisting to only allow the events you intend to use.
* Minimum Android SDK version: 24
* Supported targetSDKVersion: 34

#### 3rd Party Frameworks

- [RxJava](https://github.com/ReactiveX/RxJava)
- [RxAndroid](https://github.com/ReactiveX/RxAndroid)
- [OkHttp](https://github.com/square/okhttp)
- [Retrofit](https://github.com/square/retrofit)
- [OkHttp](https://github.com/square/okhttp)
- [Picasso](https://github.com/square/picasso)
- [Fresco](https://github.com/facebook/fresco)
- [ConstraintLayout](https://github.com/androidx/constraintlayout)
- [Joda-Time](https://github.com/JodaOrg/joda-time)

### Installation
---
1. Set maven path in your `root/build.gradle` file:

    
   <pre><code class="language-groovy">...
       allprojects {
           repositories {
               google()
               jcenter()
               maven { url 'https://pkgs.dev.azure.com/Synerise/AndroidSDK/_packaging/prod/maven/v1' }
           }
       }</code></pre>


2. Add dependency to your `project/build.gradle` file:

    
   <pre><code class="language-groovy">buildscript {
           repositories {
               google()
               jcenter()
           }
           dependencies {
               classpath 'com.android.tools.build:gradle:3.4.2'
           }
       }</code></pre>

    
    
   <div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

   We guarantee stability only on Android Gradle plugin 3.4.2 or lower.

   </div></div></div>


3. Import dependency in your `app/build.gradle` file and apply the plugin:
    
   <pre><code class="language-groovy">apply plugin: 'com.android.application'

       ...
       dependencies {
       ...
       // Synerise Android SDK;
       implementation 'com.synerise.sdk:synerise-mobile-sdk:ANDROID_SDK_VERSION'
       // Replace ANDROID_SDK_VERSION with the version, for example 5.4.0;
       // Check latest version at https://github.com/Synerise/android-sdk/blob/master/CHANGELOG.md
       }</code></pre>

4. *For Android Studio versions older than 3.5*: Go to **File > Settings > Build, Execution, Deployment > Instant Run** and make sure that Instant Run is disabled.


### Configuration
---

For your convenience, [Synerise.Builder](/developers/mobile-sdk/class-reference/android/lifecycle#synerise-builder) makes it possible to configure SDK behavior depending on your needs.

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The `Synerise.Builder.with(..)` method is mandatory.

</div></div></div>


The basic callbacks you need:
- [.pushRegistrationRequired(OnRegisterForPushListener)](/developers/mobile-sdk/class-reference/android/lifecycle#synerise-builder) - Synerise SDK may request registering a customer for push notifications. This callback is called after a customer signs in, signs up, or deletes an account.
- [.baseUrl(String)](/developers/mobile-sdk/class-reference/android/lifecycle#synerise-builder) - This callback lets you provide your custom base URL to use your own domain for connecting to the Synerise API.
    
  <div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

  If you use Synerise hosted on:  
  - Google Cloud ([app.geb.synerise.com](https://app.geb.synerise.com)), use `baseUrl(https://api.geb.snrapi.com)`
  - Microsoft Azure USA ([app.azu.synerise.com](https://app.azu.synerise.com)), use `baseUrl(https://api.azu.snrapi.com)`

  </div></div></div>
  

- `.mesaggingServiceType(MessagingServiceType)` - This callback sets the messaging provider: Huawei Mobile Services (HMS) or Google Mobile Services (GMS). When publishing the app to appGallery, we recommend using HMS.



<details class="accordion"><summary>Click to expand the full list of callbacks</summary><div class="accordion-content"><table> <thead> <tr> <th>Callbacks</th> <th>Description</th> </tr> </thead> <tbody><tr> <td><a href="/developers/mobile-sdk/class-reference/android/lifecycle/#synerise-builder">.build()</a></td> <td>Builds the Synerise SDK with the provided data. The `Synerise.Builder.build()` method can be called only once during the entire application lifecycle, so you must call this method in your `Application` class.</td> </tr> <tr> <td><a href="/developers/mobile-sdk/class-reference/android/lifecycle/#synerise-builder">.crashHandlingEnabled(boolean)</a></td> <td>For more information, see the <a href="/developers/mobile-sdk/miscellaneous/#crash-handling">Crash Handling</a> section.</td> </tr> <tr> <td><a href="/developers/mobile-sdk/class-reference/android/lifecycle/#synerise-builder">.notificationDefaultChannelId(String)</a></td> <td>Sets the ID of Push Notification Channel.</td> </tr> <tr> <td><a href="/developers/mobile-sdk/class-reference/android/lifecycle/#synerise-builder">.notificationDefaultChannelName(String)</a></td> <td>Sets the name of Push Notification Channel.</td> </tr> <tr> <td><a href="/developers/mobile-sdk/class-reference/android/lifecycle/#synerise-builder">.notificationHighPriorityChannelId(String)</a></td> <td>Sets the ID of High Priority Push Notification Channel.</td> </tr> <tr> <td><a href="/developers/mobile-sdk/class-reference/android/lifecycle/#synerise-builder">.notificationHighPriorityChannelName(String)</a></td> <td>Sets the name of High Priority Push Notification Channel.</td> </tr> <tr> <td>`.rxJavaErrorHandlingEnabled(boolean)`</td> <td>If set to true, Synerise handles rxJava errors. <br>If false, you need to call rxJavaPlugins.setErrorHandler on your own.</td> </tr> <tr> <td><a href="/developers/mobile-sdk/class-reference/android/lifecycle/#synerise-builder">.syneriseDebugMode(boolean)</a></td> <td>When true, enables full network traffic logs. It is not recommended to use debug mode in a release version of your app. Debug mode is disabled by default.</td> </tr> <tr> <td>`Synerise.settings.injector.automatic = boolean;`</td> <td>When true, enables automatic mode in the injector.</td> </tr> <tr> <td>`Synerise.settings.tracker.autoTracking.trackMode = TrackMode`</td> <td>Sets the mode for view tracking.</td> </tr> <tr> <td>`Synerise.settings.tracker.locationAutomatic = boolean;`</td> <td>Use to obtain customer location and send the location event automatically.</td> </tr> <tr> <td>`Synerise.settings.tracker.setAutoFlushTimeout(int);`</td> <td>Sets the maximum time (in ms) since the last event queue was sent before attempting to automatically send another queue. Default value: 5000 ms. Minimum value: 50 ms.</td> </tr> <tr> <td>`Synerise.settings.tracker.setMaximumBatchSize(int);`</td> <td>Sets the maximum number of events which may be sent in a single batch. Default value: 100. You can set the value between 1 and 100.</td> </tr> <tr> <td>`Synerise.settings.tracker.setMinimumBatchSize(int);`</td> <td>Sets the minimum number of events in queue required to send them. Default value: 10. You can set the value between 1 and 100.</td> </tr> </tbody></table></div></details>


### Initialization
---


<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Synerise SDK must be initialized in the [Application class](https://developer.android.com/reference/android/app/Application). This is because Synerise SDK performs some operations while the application is running in the background.

</div></div></div>


1. Initialize Synerise Android SDK by using the `with` method and provide:  
    - `Application name`   
    - `Application instance` 
    - [API Key](/docs/settings/tool/api)
        1. To get the Profile (client) API key, go to **Synerise > Settings > API keys**.
        2. On the list of the keys, select the one you created as a part of [requirements](#requirements).
        3. In the **General** section, click **Show**.  
        4. Copy the API key. 
    
2. Add the key in your `Application` sub-class:  
    
   <div class="content-tabs code-tabs" data-tab-group="tabgrp-607">
   <div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-607-0" data-tab-group="tabgrp-607" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-607-1" data-tab-group="tabgrp-607">kotlin</button></div>

   <div class="tab-panel" data-tab-id="tabgrp-607-0" data-tab-group="tabgrp-607" data-tab-active="true">

   ```Swift
   public class App extends MultiDexApplication {
           @Override
           public void onCreate() {
               super.onCreate();
               initSynerise();
           }
           private void initSynerise() {
               String syneriseClientApiKey = getString(R.string.synerise_clientool/api_key);
               String appId = getString(R.string.app_name);
               Synerise.settings.tracker.autoTracking.trackMode = FINE;
               Synerise.settings.tracker.setMinimumBatchSize(10);
               Synerise.settings.tracker.setMaximumBatchSize(100);
               Synerise.settings.tracker.setAutoFlushTimeout(5000);
               Synerise.settings.injector.automatic = false;
               Synerise.settings.tracker.locationAutomatic = true;
               Synerise.Builder.with(this, syneriseClientApiKey, appId)
                               .notificationIcon(R.drawable.notification_icon)
                               .notificationIconColor(ContextCompat.getColor(this, R.color.amaranth))
                               .syneriseDebugMode(true)
                               .pushRegistrationRequired(this)
                               .locationUpdateRequired(this)
                               .notificationDefaultChannelId("your-channel-id")
                               .notificationDefaultChannelName("your-channel-name")
                               .notificationHighPriorityChannelId("your-high-channel-id")
                               .notificationHighPriorityChannelName("your-high-channel-name")
                               .baseUrl("http://your-base-url.com/")
                               .setRequestValidationSalt("YOUR_REQUEST_VALIDATION_SALT")
                               .build();
           }
       }
   ```

   </div>

   <div class="tab-panel" data-tab-id="tabgrp-607-1" data-tab-group="tabgrp-607">

   ```kotlin
   class App : MultiDexApplication() {
           override fun onCreate() {
               super.onCreate()
               initSynerise()
           }
           private fun initSynerise() {
               val syneriseClientApiKey = accountManager!!.getClientProfileApiKey()
               val appId = getString(R.string.app_name)
               Synerise.settings.tracker.autoTracking.trackMode = FINE;
               Synerise.settings.tracker.setMinimumBatchSize(10);
               Synerise.settings.tracker.setMaximumBatchSize(100);
               Synerise.settings.tracker.setAutoFlushTimeout(5000);
               Synerise.settings.injector.automatic = false;
               Synerise.settings.tracker.locationAutomatic = true;
               Synerise.Builder.with(this, syneriseClientApiKey, appId)
                   .notificationIcon(R.drawable.ic_cart)
                   .notificationIconColor(ContextCompat.getColor(this, R.color.amaranth))
                   .syneriseDebugMode(true)
                   .pushRegistrationRequired(this)
                   .locationUpdateRequired(this)
                   .notificationDefaultChannelId("your-channel-id")
                   .notificationDefaultChannelName("your-channel-name")
                   .notificationHighPriorityChannelId("your-high-channel-id")
                   .notificationHighPriorityChannelName("your-high-channel-name")
                   .baseUrl("http://your-base-url.com/")
                   .setRequestValidationSalt("YOUR_REQUEST_VALIDATION_SALT")
                   .build()
           }
       }
   ```

   </div>
   </div>


3. Add the key in your `/values` strings file (for example, `strings.xml`):


<pre><code class="language-XML">&lt;resources&gt;

    &lt;string name="app_name" translatable="false"&gt;Your GREAT application name&lt;/string&gt;
    &lt;string name="synerise_client_api_key" translatable="false"&gt;EF1AD0E0-532B-6AEE-6010-DEDC78F6E155&lt;/string&gt; &lt;!-- replace with valid client api key --&gt;

    ...

&lt;/resources&gt;</code></pre>



<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Secure sensitive keys (for example, `apiKey` and `requestValidationSalt`) with mechanisms like string obfuscation or encryption.

</div></div></div>


### Troubleshooting
---

#### MultiDex {id=troubleshooting-multidex}

Sometimes, MultiDex errors may occur. In that case, enable MultiDex as follows (API >= 21):

<pre><code class="language-groovy">defaultConfig {
    applicationId "com.your.app"
    minSdkVersion 21
    ...
    multiDexEnabled true
}</code></pre>
  

or for API < 21:  


<pre><code class="language-groovy">defaultConfig {
    applicationId "com.your.app"
    minSdkVersion 20
    ...
    multiDexEnabled true
}</code></pre>


<pre><code class="language-groovy">dependencies {
    ...
    // MultiDex
    implementation 'com.android.support:multidex:1.0.3'
    ...
}</code></pre>


<pre><code class="language-java">public class YourApp extends MultiDexApplication {

    @Override
    public void onCreate() {
        super.onCreate();
        ...
    }</code></pre>


You can find more information about MultiDex at [this link](https://developer.android.com/studio/build/multidex.html). 

#### AndroidManifest Merger {id=troubleshooting-androidmanifest-merger}

Sometimes, AndroidManifest Merger errors may occur. In that case, paste the following code in your AndroidManifest application tag.

<pre><code class="language-XML">&lt;application
    ...
    tools:replace="android:theme"&gt;</code></pre>


Also, if your app did not ask for location permission, remove it from your app with:

<pre><code class="language-xml">&lt;uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" tools:node="remove"/&gt;</code></pre>


### Work Manager
Work Manager is a mechanism to schedule and run code in the background to keep your app up to date. Synerise supports using Work Manager since SDK version **5.21.0**.
  
#### Benefits
Currently, the SDK uses background tasks only to refresh the registration token for push notifications every 20 days. In these situations, the SDK invokes the [onRegisterForPushRequired(origin:)](/developers/mobile-sdk/listeners-and-delegates/android-listeners#on-register-for-push-listener-on-register-for-push-required-with-origin) callback method or [onRegisterForPushRequired()](/developers/mobile-sdk/listeners-and-delegates/android-listeners#on-register-for-push-listener-on-register-for-push-required) callback method.
  
#### Setting up

Work Manager is configured out of the box without any special configuration.

### Proguard configuration

The Synerise Android SDK obfuscates code on its own. We highly recommend keeping the entire SDK. Rules:

```plaintext
# keep entire Synerise SDK
-keep class com.synerise.sdk.** { *; }
-keepclassmembers class com.synerise.sdk.** { *; }
-keepclassmembers class com.synerise.sdk.** {
    public <init>();
}
```






# Android

## Content Widget (Android)

Content widget is a feature in the Software Development Kit that allows you to embed an easily customizable view with [recommendations](/docs/ai-hub/recommendations-v2) in your application.

Two view layouts are available:

- Horizontal slider - a single row view that slides horizontally on the screen.
- Grid view - can be displayed as full- or half-screen grid layout within your app.

Both views offer a number of configuration options that allow you to style the view consistently in the app. Additionally, the Content widget automatically tracks 4 events:

- `recommendation.seen` or `recommendation.view` (depending on configuration) sent when a recommended item is visible to the customer.
<figure><img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/developers/mobile-sdk/_gfx/recommendation-seen.png" alt="Recommendation.seen event" class="large"><figcaption>Recommendation.seen event</figcaption></figure>

- `recommendation.click` sent when a customer clicks the recommended item.
<figure><img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/developers/mobile-sdk/_gfx/recommendation-click.png" alt="Recommendation.click event" class="large"><figcaption>Recommendation.click event</figcaption></figure>

- `product.like` sent when a customer clicks a selectable button in the recommendation. (The button must be added)
<figure><img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/developers/_gfx/add-to-favourites-event.png" alt="Event sent when a user clicks the "like" button on an item" class="large"><figcaption>Event sent when a user clicks the "like" button on an item</figcaption></figure>

- `product.dislike` sent when a customer clicks a selectable button in the recommendation a second time. (The button must be added)
<figure><img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/developers/mobile-sdk/_gfx/product-dislike.png" alt="Product.dislike event" class="large"><figcaption>Product.dislike event</figcaption></figure>


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Currently, the widget can only be used for displaying AI recommendations.

</div></div></div>


### Prerequisites
---

To use the content widget feature, you must:
- Obtain a customer token from [Customer Authentication](/developers/mobile-sdk/user-identification-and-authorization/overview#authenticated-customers).
- [Create an AI Recommendation](/docs/ai-hub/recommendations-v2).
- [Create a document](/docs/assets/documents).  
    Such a document should contain the following content:
    
  <pre><code class="language-json">{
      "name": "Similar Products",
      "recommendations": "{% recommendations_json3 campaignId=COhsCCOdu8Cg %} {% endrecommendations_json3 %}"
  }</code></pre>


- In the notepad, save the document's slug and the ID of the recommendation for later use.



<div class="admonition admonition-tip"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M9.663 17h4.673M12 3v1m6.364 1.636l-.707.707M21 12h-1M4 12H3m3.343-5.657l-.707-.707m2.828 9.9a5 5 0 117.072 0l-.548.547A3.374 3.374 0 0014 18.469V19a2 2 0 11-4 0v-.531c0-.895-.356-1.754-.988-2.386l-.548-.547z" /></svg></div><div class="admonition-body"><div class="admonition-content">

It's a good practice to name slugs based on the area of the app that you want to place the content in, for example `product-details`, `menu`, and so on.

</div></div></div>


### Basic implementation
---

Configure the `ContentWidgetOptions` and `ContentWidgetAppearance` settings first.

| Class | Description |
| --- | --- |
| `ContentWidgetOptions` | Contains options for business logic, such as the slug, product identifier, and so on. [Read more](#widget-options).|
| `ContentWidgetAppearance` | Contains the UI configuration. [Read more](#widget-options). |

The example below is the most basic implementation.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-561">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-561-0" data-tab-group="tabgrp-561" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-561-1" data-tab-group="tabgrp-561">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-561-0" data-tab-group="tabgrp-561" data-tab-active="true">

```java
String productId = "10214";
String slug = "similar";
        
ContentWidgetOptions options = new ContentWidgetRecommendationsOptions(this, slug, new OnRecommendationModelMapper() {
            @Override
            public ContentWidgetRecommendationDataModel onRecommendationMapping(Recommendation recommendation) {
            // Mapping provided by 
                HashMap<String, Object> data = recommendation.getFeed();
                String imageLink = (String) data.get("imageLink");
                String productName = (String) data.get("title");

                String price = null;
                String salePrice = null;
                try {
                    JSONObject json = new JSONObject(data.get("price").toString());
                    price = json.getString("value");
                    if (data.containsKey("salePrice")) {
                        JSONObject jsonSalePrice = new JSONObject(data.get("salePrice").toString());
                        salePrice = jsonSalePrice.getString("value");
                    }
                } catch (JSONException e) {
                    e.printStackTrace();
                }
                return new ContentWidgetRecommendationDataModel(productName, imageLink, price, salePrice, null);
            }
        });
options.attributes.put(ContentWidgetOptions.ContentWidgetOptionsAttributeKeyProductId, productId);
ContentWidgetItemLayout itemLayoutDetails = new ContentWidgetItemLayout();
ContentWidgetHorizontalSliderLayout layout = new ContentWidgetHorizontalSliderLayout();
ContentWidgetAppearance contentWidgetAppearance = new ContentWidgetAppearance(layout, itemLayoutDetails);
ContentWidget widget = new ContentWidget(options, contentWidgetAppearance);

View view = widget.getView(); // our widget
insertPoint.addView(view); // your view which will receive widget
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-561-1" data-tab-group="tabgrp-561">

```kotlin
val productId = "10214"
val slug = "similar"
val options = ContentWidgetOptions(this, slug)
options.attributes.put(ContentWidgetOptions.ContentWidgetOptionsAttributeKeyProductId, productId);
val itemLayoutDetails = ContentWidgetItemLayout()
val layout = ContentWidgetHorizontalSliderLayout()
val contentWidgetAppearance = ContentWidgetAppearance(layout, itemLayoutDetails)
val widget = ContentWidget(options, contentWidgetAppearance)
val view = widget.getView() // our widget
insertPoint.addView(view) // your view which will receive widget
```

</div>
</div>


### Widget options
---

The [ContentWidgetRecommendationOptions](/developers/mobile-sdk/class-reference/android/content-widget#contentwidgetoptions) class is responsible for defining the business logic options of the widget, for example:

- document slug
- product identifier (which is stored inside class instance in attributes HashMap)
- recommendation model mapper

The table explains the parameters that can be configured in `ContentWidgetRecommendationOptions`.

| Parameter | Type | Default | Description |
| --- | --- | --- | --- |
| activity | `Activity` | - | Activity to which you insert the widget (must be included) |
| slug | `String` | - | Slug of a document |
| attributes | `Hashmap` | - | Custom attributes for generating data |
| mapper | `OnRecommendationModelMapper` | - | Mapper responsible for mapping data from feed to contentWidgetRecommendation model |
| recommendationEventType | `RecommendationEventType` | - | Recommendation event type. <ul><li>RECOMMENDATION_VIEW_EVENT sends all products in one event. We highly recommend using this type of event in content widget.</li><li>RECOMMENDATION_SEEN_EVENT sends each event as a separate event.</li></ul> |

#### Example

<div class="content-tabs code-tabs" data-tab-group="tabgrp-562">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-562-0" data-tab-group="tabgrp-562" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-562-1" data-tab-group="tabgrp-562">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-562-0" data-tab-group="tabgrp-562" data-tab-active="true">

```java
String productId = "10214";
String slug = "similar";
ContentWidgetOptions options = new ContentWidgetRecommendationsOptions(this, slug, new OnRecommendationModelMapper() {
            @Override
            public ContentWidgetRecommendationDataModel onRecommendationMapping(Recommendation recommendation) {
            // here you should implement your mapping to SyneriseModel
                HashMap<String, Object> data = recommendation.getFeed();
                String imageLink = (String) data.get("imageLink");
                String productName = (String) data.get("title");

                String price = null;
                String salePrice = null;
                try {
                    JSONObject json = new JSONObject(data.get("price").toString());
                    price = json.getString("value");
                    if (data.containsKey("salePrice")) {
                        JSONObject jsonSalePrice = new JSONObject(data.get("salePrice").toString());
                        salePrice = jsonSalePrice.getString("value");
                    }
                } catch (JSONException e) {
                    e.printStackTrace();
                }
                return new ContentWidgetRecommendationDataModel(productName, imageLink, price, salePrice, null);
            }
        });
options.attributes.put(ContentWidgetOptions.ContentWidgetOptionsAttributeKeyProductId, productId);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-562-1" data-tab-group="tabgrp-562">

```kotlin
var productId = "10214"
var slug = "similar"
var options: ContentWidgetOptions = ContentWidgetRecommendationsOptions(this, slug, object : OnRecommendationModelMapper() {
        fun onRecommendationMapping(recommendation: Recommendation): ContentWidgetRecommendationDataModel? {
        // here you should implement your mapping to SyneriseModel
            val data = recommendation.getFeed()
            val imageLink = data["imageLink"] as String?
            val productName = data["title"] as String?
            var price: String? = null
            var salePrice: String? = null
            try {
                val json = JSONObject(data["price"].toString())
                price = json.getString("value")
                if (data.containsKey("salePrice")) {
                    val jsonSalePrice = JSONObject(data["salePrice"].toString())
                    salePrice = jsonSalePrice.getString("value")
                }
            } catch (e: JSONException) {
                e.printStackTrace()
            }
            return ContentWidgetRecommendationDataModel(productName, imageLink, price, salePrice, null)
        }
    })
options.attributes.put(ContentWidgetOptions.ContentWidgetOptionsAttributeKeyProductId, productId);
```

</div>
</div>



<div class="admonition admonition-tip"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M9.663 17h4.673M12 3v1m6.364 1.636l-.707.707M21 12h-1M4 12H3m3.343-5.657l-.707-.707m2.828 9.9a5 5 0 117.072 0l-.548.547A3.374 3.374 0 0014 18.469V19a2 2 0 11-4 0v-.531c0-.895-.356-1.754-.988-2.386l-.548-.547z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The recommendation response depends on your item feed.  
In order to map your item feed, override `onRecommendationMapping` and inside it return [ContentWidgetRecommendationDataModel](/developers/mobile-sdk/class-reference/android/content-widget#contentwidgetrecommendationdatamodel).  
The configuration of the data frames is available in [AI engine configuration](https://app.synerise.com/spa/modules/ai-v2/config). It is defined separately for each item feed.

</div></div></div>


### Appearance configuration
---

The [ContentWidgetAppearance](/developers/mobile-sdk/class-reference/android/content-widget#contentwidgetappearance) class is responsible for defining the appearance of the widget.

The class consists of parameters that define the widget's appearance, however, two of them are the most important:

-  **Main layout class**: defines the way of distributing elements in the widget. Currently, two layouts are provided: 
    - `ContentWidgetHorizontalSliderLayout`  
    - `ContentWidgetGridLayout`
-  **Item layout class**: defines appearance and parameters for the item in the widget. Currently, there is only one layout provided: `ContentWidgetBaseItemLayout`.

The table explains the parameters that can be configured in [ContentWidgetAppearance](/developers/mobile-sdk/class-reference/android/content-widget#contentwidgetappearance).

| Parameter | Type | Default | Description |
| --- | --- | --- | --- |
| layout | [ContentWidgetBaseLayout](/developers/mobile-sdk/class-reference/android/content-widget#contentwidgetbaselayout) | - | Class that inherits from `ContentWidgetBaseLayout`, contains the UI details of the widget's layout |
| itemLayout | [ContentWidgetBaseItemLayout](/developers/mobile-sdk/class-reference/android/content-widget#contentwidgetbaseitemlayout) | - | Class that inherits from `ContentWidgetBaseItemLayout`, contains the UI details of a single item in a widget |

### Layouts

#### Horizontal slider
---

This layout is intended to present recommendations in a fixed-hight horizontal scrollable slider.

Each item in the slider is called a *card*.


<details class="accordion"><summary>Click to see a screen with example widget with horizontal slider</summary><div class="accordion-content"><img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/developers/mobile-sdk/_gfx/android-widget-slider.png" alt="Content Widget - Horizontal Slider" style="height:auto;max-width:50%"></div></details>



##### Parameters

The table below contains the parameters that can be configured in [ContentWidgetHorizontalSliderLayout](/developers/mobile-sdk/class-reference/android/content-widget#contentwidgetsliderlayout).

| Parameter | Type | Default | Description |
| --- | --- | --- | --- |
| cardViewSize | `ViewGroup.LayoutParams` | 0 | Size of a single item (cardView). You can provide this parameter in dp (recommended) or px. |
| cardViewHorizontalSpacing | `Int` | 0 | Horizontal spacing between items. You can provide this parameter in dp (recommended) or px. |
| cardViewBackgroundColor | `Int` | #fff | Background color of a cardView |



<div class="admonition admonition-tip"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M9.663 17h4.673M12 3v1m6.364 1.636l-.707.707M21 12h-1M4 12H3m3.343-5.657l-.707-.707m2.828 9.9a5 5 0 117.072 0l-.548.547A3.374 3.374 0 0014 18.469V19a2 2 0 11-4 0v-.531c0-.895-.356-1.754-.988-2.386l-.548-.547z" /></svg></div><div class="admonition-body"><div class="admonition-content">

`CardViewSize` can be set either by attribution or by a setter.

</div></div></div>


##### Example


<div class="content-tabs code-tabs" data-tab-group="tabgrp-563">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-563-0" data-tab-group="tabgrp-563" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-563-1" data-tab-group="tabgrp-563">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-563-0" data-tab-group="tabgrp-563" data-tab-active="true">

```java
ContentWidgetHorizontalSliderLayout layout = new ContentWidgetHorizontalSliderLayout();

layout.setCardViewSize(250, 300);
layout.cardViewHorizontalSpacing = 15;
layout.cardViewBackgroundColor = ContextCompat.getColor(Synerise.getApplicationContext(), R.color.regent);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-563-1" data-tab-group="tabgrp-563">

```kotlin
val layout = ContentWidgetHorizontalSliderLayout()
layout.setCardViewSize(250, 300)
layout.cardViewHorizontalSpacing = 15
layout.cardViewBackgroundColor = ContextCompat.getColor(Synerise.getApplicationContext(), R.color.regent)
```

</div>
</div>


#### Grid view 
---

This layout presents recommendations in a vertical scrollable grid, with elements organized into columns and rows. You can create a full- or half-screen widget.


<details class="accordion"><summary>Click to see a screen with example widget with grid layout</summary><div class="accordion-content"><img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/developers/mobile-sdk/_gfx/android-widget-fullscreen.png" alt="Content Widget - Grid View" style="height:auto;max-width:50%;display:block"></div></details>



##### Constructor

| Parameter | Type | Default | Description |
| --- | --- | --- | --- |
| preferredWidth | `Float` | - | Preferred width of your widget. You can pass the width in dp (recommended) or px |


<div class="content-tabs code-tabs" data-tab-group="tabgrp-564">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-564-0" data-tab-group="tabgrp-564" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-564-1" data-tab-group="tabgrp-564">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-564-0" data-tab-group="tabgrp-564" data-tab-active="true">

```java
float screenWidthDp = displayMetrics.widthPixels;
ContentWidgetGridLayout layout = new ContentWidgetGridLayout(screenWidthDp);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-564-1" data-tab-group="tabgrp-564">

```kotlin
var screenWidthDp = displayMetrics.widthPixels
var layout = ContentWidgetGridLayout(screenWidthDp)
```

</div>
</div>


##### Parameters

The table contains the parameters that can be configured in [ContentWidgetGridLayout](/developers/mobile-sdk/class-reference/android/content-widget#contentwidgetgridlayout). 

| Parameter | Type | Default | Description |
| --- | --- | --- | --- |
| cardViewSize | `ViewGroup.LayoutParams` | 0 | Size of a single item (cardView) |
| cardViewVerticalSpacing | `Int` | 0 | Vertical spacing between items in dp or px |
| cardViewHorizontalSpacing | `Int` | 0 | Horizontal spacing between items in dp or px |
| cardViewBackgroundColor | `Int` | #fff | Background color of a cardView |
| includeEdgeSpacing | `Boolean` | false | When `true`, edge spacing is enabled |


<div class="admonition admonition-tip"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M9.663 17h4.673M12 3v1m6.364 1.636l-.707.707M21 12h-1M4 12H3m3.343-5.657l-.707-.707m2.828 9.9a5 5 0 117.072 0l-.548.547A3.374 3.374 0 0014 18.469V19a2 2 0 11-4 0v-.531c0-.895-.356-1.754-.988-2.386l-.548-.547z" /></svg></div><div class="admonition-body"><div class="admonition-content">

CardViewSize and preferredWidth can be set by attribution or by a setter.

</div></div></div>




##### Example


<div class="content-tabs code-tabs" data-tab-group="tabgrp-565">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-565-0" data-tab-group="tabgrp-565" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-565-1" data-tab-group="tabgrp-565">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-565-0" data-tab-group="tabgrp-565" data-tab-active="true">

```java
float screenWidthDp = displayMetrics.widthPixels;
ContentWidgetGridLayout layout = new ContentWidgetGridLayout(screenWidthDp);

layout.setCardViewSize(250, 300);
layout.cardViewHorizontalSpacing = 15;
layout.cardViewVerticalSpacing = 20;
layout.includeEdgeSpacing = false;
layout.cardViewBackgroundColor = ContextCompat.getColor(Synerise.getApplicationContext(), R.color.regent);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-565-1" data-tab-group="tabgrp-565">

```kotlin
val screenWidthDp = displayMetrics.widthPixels
val layout = ContentWidgetGridLayout(screenWidthDp)
layout.setCardViewSize(250, 300)
layout.cardViewHorizontalSpacing = 15
layout.cardViewVerticalSpacing = 20
layout.includeEdgeSpacing = false
layout.cardViewBackgroundColor = ContextCompat.getColor(Synerise.getApplicationContext(), R.color.regent)
```

</div>
</div>


#### Basic item layout
---

This is the basic layout for items. It contains: the image, the title, and the price from the uploaded data.

##### Parameters

The table below contains parameters that can be configured in `ContentWidgetItemLayout`.

| Parameter | Type | Default | Description |
| --- | --- | --- | --- |
| imageHeightToCardHeightRatio | `Double` | 0.6 | Image height. A ratio of `0.6` means that the image height equals 60% of the entire height of an item |
| imageWidthToCardWidthRatio | `Double` | 1 | Image width. `1` means that the image width is equal to the width of the item |
| imageScaleType | `ImageView.ScaleType` | ImageView.ScaleType.CENTER_INSIDE | Scaling type of the image |
| imageMargin | `Int` | 0 | General margin of the image |
| itemLabelStyle | `Typeface` | - | Typeface of the label |
| itemLabelSize | `Int` | 12 | Size of the label |
| itemLabelColor | `Int` | #000 | Label text color |
| itemLabelMarginLeft | `Int` | 0 | Left margin of the label text |
| itemLabelMarginRight | `Int` | 0 | Right margin of the label text |
| itemLabelMarginBottom | `Int` | 0 | Bottom margin of the label text |
| itemLabelMarginTop | `Int` | 0 | Top margin of the label text |
| cardViewCornerRadius | `Float` | 0 | Corner radius of the cardView |
| cardViewElevation | `Float` | 0 | Elevation of the cardView |
| itemTitleStyle | `Typeface` | - | Typeface of the product title |
| itemTitleSize | `Int` | 12 | Size of the title |
| itemTitleColor | `Int` | #000 | Color of the title text |
| itemTitleMarginLeft | `Int` | 0 | Left margin of the title text |
| itemTitleMarginRight | `Int` | 0 | Right margin of the title text |
| itemTitleMarginBottom | `Int` | 0 | Bottom margin of the title text |
| itemTitleMarginTop | `Int` | 0 | Top margin of the title text |
| itemPriceStyle | `Typeface` | - | Typeface of the price |
| itemPriceSize | `Int` | 12 | Size of the price text |
| itemPriceColor | `Int` | #000 | Color of the price text |
| itemPriceMarginLeft | `Int` | 0 | Left margin of the price text |
| itemPriceMarginRight | `Int` | 0 | Right margin of the price text |
| itemPriceMarginTop | `Int` | 0 | Top margin of the price text |
| itemPriceMarginBottom | `Int` | 0 | Bottom margin of the price text |
| itemSalePriceStyle | `Typeface` | - | Typeface of the sale price |
| itemSalePriceSize | `Int` | 12 | Size of the sale price |
| itemSalePriceColor | `Int` | #000 | Color of the sale price text |
| itemSalePriceGravity | `Int` | Gravity.LEFT | Gravity of the sale price text |
| itemSalePriceMarginLeft | `Int` | 0 | Left margin of the sale price text |
| itemSalePriceMarginRight | `Int` | 0 | Right margin of the sale price text |
| itemSalePriceMarginTop | `Int` | 0 | Top margin of the sale price text |
| itemSalePriceMarginBottom | `Int` | 0 | Bottom margin of the sale price text |
| itemSalePriceOrientation | `Int` | LinearLayout.HORIZONTAL | Orientation of the sale price text |
| isItemSalePriceVisible | `boolean` | false | Flag determining whether to show the sale price or not |
| itemDiscountPercentageLabelStyle | `Typeface` | - | Typeface of discount percentage label |
| itemDiscountPercentageLabelColor | `Int` | #000 | Color of discount percentage label |
| itemDiscountPercentageLabelSize | `Int` | 12 | Size of the discount percentage label text |
| itemDiscountPercentageLabelMarginLeft | `Int` | 0 | Left margin of the discount percentage label text |
| itemDiscountPercentageLabelMarginRight | `Int` | 0 | Right margin of the discount percentage label text |
| itemDiscountPercentageLabelMarginTop | `Int` | 0 | Top margin of the discount percentage label text |
| itemDiscountPercentageLabelMarginBottom | `Int` | 0 | Bottom margin of the discount percentage label text |
| isItemDiscountPercentageLabelVisible | `boolean` | false | Flag determining whether to show the discount percentage label or not |
| itemActionButton | `ImageButtonCustomAction` | - | Object which stores all information about the ActionButton |
| itemBadge | `ContentWidgetBadge` | - | Object which stores all information about the Badge |
| imageButtonCustomActionGravity | `Int` | Gravity.TOP | Gravity of the actionButton |


<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

- You can combine the `Gravity.*` parameters. For example, to align an item to top and right, use: 
```Gravity.TOP | Gravity.RIGHT```  
- All text elements are centered horizontally.

</div></div></div>



<div class="admonition admonition-tip"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M9.663 17h4.673M12 3v1m6.364 1.636l-.707.707M21 12h-1M4 12H3m3.343-5.657l-.707-.707m2.828 9.9a5 5 0 117.072 0l-.548.547A3.374 3.374 0 0014 18.469V19a2 2 0 11-4 0v-.531c0-.895-.356-1.754-.988-2.386l-.548-.547z" /></svg></div><div class="admonition-body"><div class="admonition-content">

ItemTitleMargins, ItemPriceMargins, ItemLabelMargins, ItemSalePriceMargins, and ItemDiscountLabelMargins can be set using setters, as shown below.

</div></div></div>



<div class="content-tabs code-tabs" data-tab-group="tabgrp-566">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-566-0" data-tab-group="tabgrp-566" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-566-1" data-tab-group="tabgrp-566">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-566-0" data-tab-group="tabgrp-566" data-tab-active="true">

```java
public void setItemTitleMargins(int marginLeft, int marginRight, int marginTop, int marginBottom)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-566-1" data-tab-group="tabgrp-566">

```kotlin
fun setItemTitleMargins(marginLeft:Int, marginRight:Int, marginTop:Int, marginBottom:Int)
```

</div>
</div>


#### Example


<div class="content-tabs code-tabs" data-tab-group="tabgrp-567">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-567-0" data-tab-group="tabgrp-567" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-567-1" data-tab-group="tabgrp-567">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-567-0" data-tab-group="tabgrp-567" data-tab-active="true">

```java
ContentWidgetItemLayout itemLayoutDetails = new ContentWidgetItemLayout();
itemLayoutDetails.cardViewElevation = 5;
itemLayoutDetails.cardViewCornerRadius = 10;
itemLayoutDetails.imageHeightToCardHeightRatio = 0.6
itemLayoutDetails.imageWidthToCardWidthRatio = 1;
itemLayoutDetails.imageMargin = 5;
itemLayoutDetails.itemTitleStyle = Typeface.create("sans-serif-condensed", Typeface.NORMAL);
itemLayoutDetails.itemTitleSize = 12;
itemLayoutDetails.itemTitleColor = ContextCompat.getColor(Synerise.getApplicationContext(), R.color.charcoal);
itemLayoutDetails.itemTitleGravity = Gravity.LEFT;
itemLayoutDetails.setItemTitleMargins(10, 0, 0, 0);
itemLayoutDetails.itemPriceStyle = Typeface.create("sans-serif-light", Typeface.BOLD);
itemLayoutDetails.itemPriceSize = 12;
itemLayoutDetails.itemPriceColor = ContextCompat.getColor(Synerise.getApplicationContext(), R.color.charcoal);
itemLayoutDetails.itemPriceGravity = Gravity.LEFT;
itemLayoutDetails.setItemPriceMargins(10, 0, 3, 0);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-567-1" data-tab-group="tabgrp-567">

```kotlin
val itemLayoutDetails = ContentWidgetItemLayout()
itemLayoutDetails.cardViewElevation = 5
itemLayoutDetails.cardViewCornerRadius = 10
itemLayoutDetails.imageHeightToCardHeightRatio = 0.6
itemLayoutDetails.imageWidthToCardWidthRatio = 1
itemLayoutDetails.imageMargin = 5
itemLayoutDetails.itemTitleStyle = Typeface.create("sans-serif-condensed", Typeface.NORMAL)
itemLayoutDetails.itemTitleSize = 12
itemLayoutDetails.itemTitleColor = ContextCompat.getColor(Synerise.getApplicationContext(), R.color.charcoal)
itemLayoutDetails.itemTitleGravity = Gravity.LEFT
itemLayoutDetails.setItemTitleMargins(10, 0, 0, 0)
itemLayoutDetails.itemPriceStyle = Typeface.create("sans-serif-light", Typeface.BOLD)
itemLayoutDetails.itemPriceSize = 12
itemLayoutDetails.itemPriceColor = ContextCompat.getColor(Synerise.getApplicationContext(), R.color.charcoal)
itemLayoutDetails.itemPriceGravity = Gravity.LEFT
itemLayoutDetails.setItemPriceMargins(10, 0, 3, 0)
```

</div>
</div>


## Interaction with the widget

### Public interface
---

`load()` - Starts fetching data and creates a view structure of the widget.

`getView()` - Gets the root view of the whole widget view structure.

`onContentWidgetListener` is used to inform developers about the state of a widget. Read more below.

### Listener
---

- `onLoading(ContentWidget contentWidget, boolean isLoading)` - Called when the widget loading state changes. 
- `onLoad(ContentWidget contentWidget)` - Called after the widget is loaded. 
- `onLoadingError(ContentWidget contentWidget, ApiError apiError)` - Called when an error occurs while loading. 
- `onSizeChange(ContentWidget contentWidget, ViewGroup.LayoutParams size)` - Called when the widget size changes. 
- `onClickActionReceive(ContentWidget contentWidget, BaseModel model)` - Called when the customer clicks a widget item. 

## Image button custom action

`ImageButtonCustomAction` is used to add `imageButton` to your widget. You can add a `singleStateButton` or a `selectableButton`.

### Parameters

The following table contains the parameters that can be configured in `ImageButtonCustomAction`.

| Parameter | Type | Default | Description |
| --- | --- | --- | --- |
| predefinedAction | `PredefinedActionType` | null | PredefinedAction determines which event is sent on click |
| marginLeft | `Int` | 0 | Left margin of the image button |
| marginRight | `Int` | 0 | Right margin of the image button |
| marginTop | `Int` | - | Top margin of the image button |
| marginBottom | `Int` | 0 | Bottom margin of the image button |


<div class="admonition admonition-tip"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M9.663 17h4.673M12 3v1m6.364 1.636l-.707.707M21 12h-1M4 12H3m3.343-5.657l-.707-.707m2.828 9.9a5 5 0 117.072 0l-.548.547A3.374 3.374 0 0014 18.469V19a2 2 0 11-4 0v-.531c0-.895-.356-1.754-.988-2.386l-.548-.547z" /></svg></div><div class="admonition-body"><div class="admonition-content">

ImageButtonCustomAction margins can be set using setters, as shown below.

</div></div></div>



<div class="content-tabs code-tabs" data-tab-group="tabgrp-568">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-568-0" data-tab-group="tabgrp-568" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-568-1" data-tab-group="tabgrp-568">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-568-0" data-tab-group="tabgrp-568" data-tab-active="true">

```java
public void setImageButtonCustomActionMargins(int marginLeft, int marginRight, int marginTop, int marginBottom)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-568-1" data-tab-group="tabgrp-568">

```kotlin
fun setImageButtonCustomActionMargins(marginLeft:Int, marginRight:Int, marginTop:Int, marginBottom:Int)
```

</div>
</div>



The following table contains the parameters that can be configured in `ContentWidgetBadge`.

| Parameter | Type | Default | Description |
| --- | --- | --- | --- |
| textStyle | `Typeface` | - | Typeface of the text badge |
| textSize | `Int` | 12 | Size of the badge text |
| rule | `Int` | RelativeLayout.ALIGN_LEFT | Rule deremining position of a badge. Can be ALIGN_LEFT or ALIGN_RIGHT |
| paddingLeft | `Int` | 0 | Left padding of the badge text |
| paddingRight | `Int` | 0 | Right padding of the badge text |
| paddingTop | `Int` | 0 | Top padding of the badge text |
| paddingBottom | `Int` | 0 | Bottom padding of the badge text |
| marginLeft | `Int` | 0 | Left margin of the badge |
| marginRight | `Int` | 0 | Right margin of the badge |
| marginTop | `Int` | - | Top margin of the badge |
| marginBottom | `Int` | 0 | Bottom margin of the badge |


<div class="admonition admonition-tip"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M9.663 17h4.673M12 3v1m6.364 1.636l-.707.707M21 12h-1M4 12H3m3.343-5.657l-.707-.707m2.828 9.9a5 5 0 117.072 0l-.548.547A3.374 3.374 0 0014 18.469V19a2 2 0 11-4 0v-.531c0-.895-.356-1.754-.988-2.386l-.548-.547z" /></svg></div><div class="admonition-body"><div class="admonition-content">

ContentWidgetBadge margins and paddings can be set using setters, as shown below.

</div></div></div>



<div class="content-tabs code-tabs" data-tab-group="tabgrp-569">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-569-0" data-tab-group="tabgrp-569" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-569-1" data-tab-group="tabgrp-569">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-569-0" data-tab-group="tabgrp-569" data-tab-active="true">

```java
public void setMargins(int marginLeft, int marginRight, int marginTop, int marginBottom)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-569-1" data-tab-group="tabgrp-569">

```kotlin
fun setMargins(marginLeft:Int, marginRight:Int, marginTop:Int, marginBottom:Int)
```

</div>
</div>



<div class="content-tabs code-tabs" data-tab-group="tabgrp-570">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-570-0" data-tab-group="tabgrp-570" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-570-1" data-tab-group="tabgrp-570">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-570-0" data-tab-group="tabgrp-570" data-tab-active="true">

```java
public void setPaddings(int paddingLeft, int paddingRight, int paddingTop, int paddingBottom)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-570-1" data-tab-group="tabgrp-570">

```kotlin
fun setPaddings(paddingLeft:Int, paddingRight:Int, paddingTop:Int, paddingBottom:Int)
```

</div>
</div>


### setStateDrawables
This method is responsible for passing icons to the image button.

<!-- reusable-table-boundary -->

**Method name:** imageButtonCustomAction.setStateDrawables(dislikeIcon, likeIcon)

#### Declaration

<div class="content-tabs code-tabs" data-tab-group="tabgrp-571">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-571-0" data-tab-group="tabgrp-571" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-571-1" data-tab-group="tabgrp-571">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-571-0" data-tab-group="tabgrp-571" data-tab-active="true">

```java
public void setStateDrawables(@NonNull Drawable defaultStateDrawable, @Nullable Drawable selectedStateDrawable)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-571-1" data-tab-group="tabgrp-571">

```kotlin
fun setStateDrawables(@NonNull defaultStateDrawable:Drawable, @Nullable selectedStateDrawable:Drawable)
```

</div>
</div>


#### Parameters
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| defaultStateDrawable | `Drawable` | yes | --- | Icon that appears in default and false state |
| selectedStateDrawable | `Drawable` | no | --- | Icon that appears in the selected state |

#### Return Value
Void type

#### Example

<div class="content-tabs code-tabs" data-tab-group="tabgrp-572">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-572-0" data-tab-group="tabgrp-572" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-572-1" data-tab-group="tabgrp-572">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-572-0" data-tab-group="tabgrp-572" data-tab-active="true">

```Java
Drawable likeHeart = ContextCompat.getDrawable(this, R.drawable.ic_heart);
Drawable unlikeHeart = ContextCompat.getDrawable(this, R.drawable.ic_heart_outline);
favouriteIcon.setStateDrawables(unlikeHeart, likeHeart);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-572-1" data-tab-group="tabgrp-572">

```Kotlin
val likeHeart = ContextCompat.getDrawable(this, R.drawable.ic_heart)
val unlikeHeart = ContextCompat.getDrawable(this, R.drawable.ic_heart_outline)
favouriteIcon.setStateDrawables(unlikeHeart, likeHeart)
```

</div>
</div>


<!-- reusable-table-boundary -->


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

If you want a `singleStateButton`, pass `null` instead of `selectedStateDrawable`.

</div></div></div>


### Public interface
Set a listener by using `setOnItemActionListener`.

`OnActionItemStateListener` is used to inform developers about the state of an ImageButton.

### Listener

- `onReceiveClickAction(BaseModel model, boolean isSelected, ImageButton imageButton)` - called when the customer clicks the image button in the widget.
- `onStateCheck(BaseModel model)` - called before showing the view, when `selectableImageButton` needs information about the button state.

### Example

The example shows how to implement the "like" button.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-573">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-573-0" data-tab-group="tabgrp-573" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-573-1" data-tab-group="tabgrp-573">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-573-0" data-tab-group="tabgrp-573" data-tab-active="true">

```java
ImageButtonCustomAction favouriteIcon = new ImageButtonCustomAction();
        Drawable likeHeart = ContextCompat.getDrawable(this, R.drawable.ic_heart);
        Drawable unlikeHeart = ContextCompat.getDrawable(this, R.drawable.ic_heart_outline);
        favouriteIcon.setStateDrawables(unlikeHeart, likeHeart);
        favouriteIcon.setImageButtonCustomActionMargins(0, 0, 0, 0);
        favouriteIcon.predefinedAction = PredefinedActionType.SEND_LIKE_EVENT;
        favouriteIcon.setOnItemActionListener(new OnActionItemStateListener() {
            @Override
            public void onReceiveClickAction(BaseModel model, boolean isSelected, ImageButton imageButton) {
                Recommendation recommendation = (Recommendation) model;
                ViewUtils.pulse(imageButton);
            }

            @Override
            public boolean onStateCheck(BaseModel model) {
                return false;
            }
        });

        itemLayoutDetails.setItemAction(favouriteIcon);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-573-1" data-tab-group="tabgrp-573">

```kotlin
val favouriteIcon = ImageButtonCustomAction()
        val likeHeart = ContextCompat.getDrawable(this, R.drawable.ic_heart)
        val unlikeHeart = ContextCompat.getDrawable(this, R.drawable.ic_heart_outline)
        favouriteIcon.setStateDrawables(unlikeHeart!!, likeHeart)
        favouriteIcon.setImageButtonCustomActionMargins(0, 0, 0, 0)
        favouriteIcon.predefinedAction = PredefinedActionType.SEND_LIKE_EVENT
        favouriteIcon.setOnItemActionListener(object : OnActionItemStateListener {
            override fun onReceiveClickAction(model: BaseModel, isSelected: Boolean, imageButton: ImageButton) {
                val recommendation = model as Recommendation
                ViewUtils.pulse(imageButton)
            }

            override fun onStateCheck(model: BaseModel): Boolean {
                return false
            }
        })

        itemLayoutDetails.setItemAction(favouriteIcon)
```

</div>
</div>



## Sample implementations

### Horizontal slider

Slider layout with a fixed height.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-574">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-574-0" data-tab-group="tabgrp-574" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-574-1" data-tab-group="tabgrp-574">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-574-0" data-tab-group="tabgrp-574" data-tab-active="true">

```java
public void loadWidget() {
    String productId = "10214";
    String slug = "similar";
    ContentWidgetOptions options = new ContentWidgetRecommendationsOptions(this, slug, new OnRecommendationModelMapper() {
            @Override
            public ContentWidgetRecommendationDataModel onRecommendationMapping(Recommendation recommendation) {
                HashMap<String, Object> data = recommendation.getFeed();
                String imageLink = (String) data.get("imageLink");

                String productName = (String) data.get("title");

                String price = null;
                String salePrice = null;
                try {
                    JSONObject json = new JSONObject(data.get("price").toString());
                    price = json.getString("value");
                    if (data.containsKey("salePrice")) {
                        JSONObject jsonSalePrice = new JSONObject(data.get("salePrice").toString());
                        salePrice = jsonSalePrice.getString("value");
                    }
                } catch (JSONException e) {
                    e.printStackTrace();
                }
                ContentWidgetBadgeDataModel badgeDataModel = new ContentWidgetBadgeDataModel("Example badge", Color.BLACK, Color.RED);
                ContentWidgetRecommendationDataModel dataModel = new ContentWidgetRecommendationDataModel(productName, imageLink, price, salePrice, "PLN");
                dataModel.setBadgeDataModel(badgeDataModel);
                dataModel.setLabel("Black Week");
                return dataModel;
            }});
    options.attributes.put(ContentWidgetOptions.ContentWidgetOptionsAttributeKeyProductId, productId);
        ContentWidgetBasicProductItemLayout itemLayoutDetails = new ContentWidgetBasicProductItemLayout();
        ContentWidgetHorizontalSliderLayout layout = new ContentWidgetHorizontalSliderLayout();

        //CardView parameters
        if (!cardViewWidth.getEditText().getText().toString().matches("") && !cardViewHeight.getEditText().getText().toString().matches(""))
            layout.setCardViewSize(Integer.parseInt(cardViewWidth.getEditText().getText().toString()), Integer.parseInt(cardViewHeight.getEditText().getText().toString()));
        if (!cardViewElevation.getEditText().getText().toString().matches(""))
            itemLayoutDetails.cardViewElevation = Integer.parseInt(cardViewElevation.getEditText().getText().toString());
        if (!cornerRadius.getEditText().getText().toString().matches(""))
            itemLayoutDetails.cardViewCornerRadius = Integer.parseInt(cornerRadius.getEditText().getText().toString());
        if (!horizontalSpacing.getEditText().getText().toString().matches(""))
            layout.cardViewHorizontalSpacing = Integer.parseInt(horizontalSpacing.getEditText().getText().toString());
        layout.cardViewBackgroundColor = ContextCompat.getColor(Synerise.getApplicationContext(), R.color.regent);

        //Image size as ratio to cardview size
        if (!imageHeightRatio.getEditText().getText().toString().matches(""))
            itemLayoutDetails.imageHeightToCardHeightRatio = Float.parseFloat(imageHeightRatio.getEditText().getText().toString());
        if (!imageWidthRatio.getEditText().getText().toString().matches(""))
            itemLayoutDetails.imageWidthToCardWidthRatio = Float.parseFloat(imageWidthRatio.getEditText().getText().toString());
        itemLayoutDetails.imageScaleType = ImageView.ScaleType.CENTER_CROP;
        itemLayoutDetails.imageMargin = 0; //have to be set when you set cardViewElevation

        //TextView product label
        itemLayoutDetails.itemLabelSize = 12;
        itemLayoutDetails.itemLabelColor = Color.GREEN;
        itemLayoutDetails.setItemLabelMargins(0,0,2,0);

        //TextView product name
        itemLayoutDetails.itemTitleStyle = Typeface.create("sans-serif-condensed", Typeface.NORMAL);
        itemLayoutDetails.itemTitleSize = 12;
        itemLayoutDetails.itemTitleColor = ContextCompat.getColor(Synerise.getApplicationContext(), R.color.charcoal);
        itemLayoutDetails.setItemTitleMargins(10, 0, 0, 0);

        //TextView Product price
        itemLayoutDetails.itemPriceStyle = Typeface.create("sans-serif-light", Typeface.BOLD);
        itemLayoutDetails.itemPriceSize = 13;
        itemLayoutDetails.itemPriceColor = ContextCompat.getColor(Synerise.getApplicationContext(), R.color.charcoal);
        itemLayoutDetails.setItemPriceMargins(10, 0, 3, 0);

        //TextView Product Sale price
        itemLayoutDetails.isItemSalePriceVisible = true;
        itemLayoutDetails.itemSalePriceStyle = Typeface.create("sans-serif", Typeface.BOLD);
        itemLayoutDetails.itemSalePriceSize = 13;
        itemLayoutDetails.itemSalePriceColor = ContextCompat.getColor(Synerise.getApplicationContext(), R.color.red);
        itemLayoutDetails.itemSalePriceOrientation = LinearLayout.HORIZONTAL;
        itemLayoutDetails.setItemSalePriceMargins(4, 0, 3, 0);
        // CrossedOut Price color
        itemLayoutDetails.itemRegularPriceColor = ContextCompat.getColor(Synerise.getApplicationContext(), R.color.com_facebook_blue);
        itemLayoutDetails.priceDecimalSeparator = ',';
        itemLayoutDetails.priceGroupSeparator = ' ';

        // DiscountLabel
        itemLayoutDetails.itemDiscountPercentageLabelSize = 13;
        itemLayoutDetails.isItemDiscountPercentageLabelVisible = true;
        itemLayoutDetails.itemDiscountPercentageLabelColor = Color.BLUE;
        itemLayoutDetails.itemDiscountPercentageLabelStyle = Typeface.create("sans-serif", Typeface.BOLD);
        itemLayoutDetails.setItemDiscountLabelMargins(4, 0, 3, 0);

        // Badge
        ContentWidgetBadge badge = new ContentWidgetBadge();
        badge.textSize = 12;
        badge.rule = RelativeLayout.ALIGN_LEFT; // left or right
        badge.setMargins(0,0,0,20);
        badge.setPaddings(10, 10, 0, 0);

        //ImageButton
        ImageButtonCustomAction favouriteIcon = new ImageButtonCustomAction();
        Drawable likeHeart = ContextCompat.getDrawable(this, R.drawable.ic_heart);
        Drawable unlikeHeart = ContextCompat.getDrawable(this, R.drawable.ic_heart_outline);
        favouriteIcon.setStateDrawables(unlikeHeart, likeHeart);
        favouriteIcon.setImageButtonCustomActionMargins(0, 0, 0, 0);
        favouriteIcon.predefinedAction = PredefinedActionType.SEND_LIKE_EVENT;
        favouriteIcon.setOnItemActionListener(new OnActionItemStateListener() {
            @Override
            public void onReceiveClickAction(BaseModel model, boolean isSelected, ImageButton imageButton) {
                Recommendation recommendationModel = (Recommendation) model;
                ViewUtils.pulse(imageButton);
            }

            @Override
            public boolean onStateCheck(BaseModel model) {
                return false;
            }
        });

        itemLayoutDetails.setBadge(badge);
        itemLayoutDetails.setItemAction(favouriteIcon);

        ContentWidgetAppearance contentWidgetAppearance = new ContentWidgetAppearance(layout, itemLayoutDetails);
        ContentWidget widget = new ContentWidget(options, contentWidgetAppearance);

        widget.setOnContentWidgetListener(new OnContentWidgetListener() {
            @Override
            public void onLoading(ContentWidget contentWidget, boolean isLoading) {

            }

            @Override
            public void onLoadingError(ContentWidget contentWidget, ApiError apiError) {
                Toast.makeText(getApplicationContext(), apiError.toString(),Toast.LENGTH_LONG).show();
            }

            @Override
            public void onLoad(ContentWidget contentWidget) {
                insertPoint.removeAllViews();
                View view = widget.getView(); // our widget
                insertPoint.addView(view); // your view which will receive widget
            }

            @Override
            public void onClickActionReceive(ContentWidget contentWidget, BaseModel model) {
                Recommendation recommendationModel = (Recommendation) model;
                String itemId = recommendationModel.getItemId();
                startActivity(WidgetRecommendedProductDetailsActivity.createIntent(getApplicationContext(), itemId));
            }

            @Override
            public void onSizeChange(ContentWidget contentWidget, ViewGroup.LayoutParams size) {
                ViewGroup.LayoutParams params = insertPoint.getLayoutParams();
                params.height = size.height;
                insertPoint.setLayoutParams(params);
            }
        });
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-574-1" data-tab-group="tabgrp-574">

```kotlin
fun loadWidget() {
    val productId = "10214"
    val slug = "similar"
    var options: ContentWidgetOptions = ContentWidgetRecommendationsOptions(this, slug, object : OnRecommendationModelMapper() {
        fun onRecommendationMapping(recommendation: Recommendation): ContentWidgetRecommendationDataModel? {
        // here you should implement your mapping to SyneriseModel
            val data = recommendation.getFeed()
            val imageLink = data["imageLink"] as String?
            val productName = data["title"] as String?
            var price: String? = null
            var salePrice: String? = null
            try {
                val json = JSONObject(data["price"].toString())
                price = json.getString("value")
                if (data.containsKey("salePrice")) {
                    val jsonSalePrice = JSONObject(data["salePrice"].toString())
                    salePrice = jsonSalePrice.getString("value")
                }
            } catch (e: JSONException) {
                e.printStackTrace()
            }
            val badgeDataModel = ContentWidgetBadgeDataModel("Example badge", Color.BLACK, Color.RED)
            val dataModel = ContentWidgetRecommendationDataModel(productName, imageLink, price, salePrice, "PLN")
            dataModel.setBadgeDataModel(badgeDataModel);
            dataModel.setLabel("Black Week");
            return dataModel
        }
    })

    options.attributes.put(ContentWidgetOptions.ContentWidgetOptionsAttributeKeyProductId, productId);
    val itemLayoutDetails = ContentWidgetItemLayout()
    val layout = ContentWidgetHorizontalSliderLayout()

    layout.setCardViewSize(250, 350)
    itemLayoutDetails.cardViewElevation = 5
    itemLayoutDetails.cardViewCornerRadius = 10
    layout.cardViewHorizontalSpacing = 20
    layout.cardViewBackgroundColor = ContextCompat.getColor(Synerise.getApplicationContext(), R.color.regent)

    //Image size as ratio to cardview size
    itemLayoutDetails.imageHeightToCardHeightRatio = 0.6
    itemLayoutDetails.imageWidthToCardWidthRatio = 1
    itemLayoutDetails.imageMargin = 5 //have to be set when you set cardViewElevation
    itemLayoutDetails.imageScaleType = ImageView.ScaleType.CENTER_CROP;

    //TextView product label
    itemLayoutDetails.itemLabelSize = 12;
    itemLayoutDetails.itemLabelColor = Color.GREEN;
    itemLayoutDetails.setItemLabelMargins(0,0,2,0);

    //TextView product name
    itemLayoutDetails.itemTitleStyle = Typeface.create("sans-serif-condensed", Typeface.NORMAL)
    itemLayoutDetails.itemTitleSize = 12
    itemLayoutDetails.itemTitleColor = ContextCompat.getColor(Synerise.getApplicationContext(), R.color.charcoal)
    itemLayoutDetails.itemTitleGravity = Gravity.LEFT
    itemLayoutDetails.setItemTitleMargins(10, 0, 0, 0)

    //TextView Product price
    itemLayoutDetails.itemPriceStyle = Typeface.create("sans-serif-light", Typeface.BOLD)
    itemLayoutDetails.itemPriceSize = 12
    itemLayoutDetails.itemPriceColor = ContextCompat.getColor(Synerise.getApplicationContext(), R.color.charcoal)
    itemLayoutDetails.itemPriceGravity = Gravity.LEFT
    itemLayoutDetails.setItemPriceMargins(10, 0, 3, 0)

    //TextView Product Sale Price
    itemLayoutDetails.itemSalePriceStyle = Typeface.create("sans-serif", Typeface.BOLD)
    itemLayoutDetails.itemSalePriceSize = 13
    itemLayoutDetails.itemSalePriceColor = ContextCompat.getColor(Synerise.getApplicationContext(), R.color.red)
    itemLayoutDetails.itemSalePriceOrientation = LinearLayout.HORIZONTAL
    itemLayoutDetails.isItemSalePriceVisible = true
    itemLayoutDetails.setItemSalePriceMargins(5, 0, 3, 0)
    // CrossedOut Price color
    itemLayoutDetails.itemRegularPriceColor = ContextCompat.getColor(Synerise.getApplicationContext(), R.color.com_facebook_blue);
    itemLayoutDetails.priceDecimalSeparator = ',';
    itemLayoutDetails.priceGroupSeparator = ' ';

    // DiscountLabel
    itemLayoutDetails.itemDiscountPercentageLabelSize = 13;
    itemLayoutDetails.isItemDiscountPercentageLabelVisible = true;
    itemLayoutDetails.itemDiscountPercentageLabelColor = Color.BLUE;
    itemLayoutDetails.itemDiscountPercentageLabelStyle = Typeface.create("sans-serif", Typeface.BOLD);
    itemLayoutDetails.setItemDiscountLabelMargins(4, 0, 3, 0);

    // Badge
    val badge = ContentWidgetBadge();
    badge.textSize = 12;
    badge.rule = RelativeLayout.ALIGN_LEFT; // left or right
    badge.setMargins(0,0,0,20);
    badge.setPaddings(10, 10, 0, 0);
    
    //ImageButton
    val favouriteIcon = ImageButtonCustomAction()
    val likeHeart = ContextCompat.getDrawable(this, R.drawable.ic_heart)
    val unlikeHeart = ContextCompat.getDrawable(this, R.drawable.ic_heart_outline)
    favouriteIcon.setStateDrawables(unlikeHeart, likeHeart)
    favouriteIcon.setImageButtonCustomActionMargins(0, 0, 0, 0)
    favouriteIcon.predefinedAction = PredefinedActionType.SEND_LIKE_EVENT
    favouriteIcon.setOnItemActionListener(object:OnActionItemStateListener() {
        fun onReceiveClickAction(model:BaseModel, isSelected:Boolean, imageButton:ImageButton) {
            val recommendation = model as Recommendation
            ViewUtils.pulse(imageButton)
        }
        
        fun onStateCheck(model:BaseModel):Boolean {
            // Here you should set buttonState based on a product and a customer.
            return false
        }
    })
    
    itemLayoutDetails.setBadge(badge);
    itemLayoutDetails.setItemAction(favouriteIcon)
    val contentWidgetAppearance = ContentWidgetAppearance(layout, itemLayoutDetails)
    val widget = ContentWidget(options, contentWidgetAppearance)

    widget.setOnContentWidgetListener(object:OnContentWidgetListener() {
        fun onLoading(contentWidget:ContentWidget, isLoading:Boolean) {
        
        }

        fun onLoadingError(contentWidget:ContentWidget, apiError:ApiError) {
            Toast.makeText(getApplicationContext(), apiError.toString(), Toast.LENGTH_LONG).show()
        }

        fun onLoad(contentWidget:ContentWidget) {
            insertPoint.removeAllViews()
            val view = widget.getView() // our widget
            insertPoint.addView(view) // your view which will receive widget
        }

        fun onClickActionReceive(contentWidget:ContentWidget, model:BaseModel) {
            val recommendation = model as Recommendation
            startActivity(WidgetRecommendedProductDetailsActivity.createIntent(getApplicationContext(), recommendation.getProductRetailerPartNo()))
        }

        fun onSizeChange(contentWidget:ContentWidget, size:ViewGroup.LayoutParams) {
            val params = insertPoint.getLayoutParams()
            params.height = size.height
            insertPoint.setLayoutParams(params)
        }
    })
}
```

</div>
</div>


### Grid view
---

If you want to avoid double scroll view, set the height as shown in the `widgetSizeDidChange` callback.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-575">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-575-0" data-tab-group="tabgrp-575" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-575-1" data-tab-group="tabgrp-575">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-575-0" data-tab-group="tabgrp-575" data-tab-active="true">

```java
private void loadFullScreenWidget() {
    String slug = "similar";
    String productId = "10214";
    ContentWidgetOptions options = new ContentWidgetRecommendationsOptions(this, slug, new OnRecommendationModelMapper() {
            @Override
            public ContentWidgetRecommendationDataModel onRecommendationMapping(Recommendation recommendation) {
                HashMap<String, Object> data = recommendation.getFeed();
                String imageLink = (String) data.get("imageLink");

                String productName = (String) data.get("title");

                String price = null;
                String salePrice = null;
                try {
                    JSONObject json = new JSONObject(data.get("price").toString());
                    price = json.getString("value");
                    if (data.containsKey("salePrice")) {
                        JSONObject jsonSalePrice = new JSONObject(data.get("salePrice").toString());
                        salePrice = jsonSalePrice.getString("value");
                    }
                } catch (JSONException e) {
                    e.printStackTrace();
                }
                return new ContentWidgetRecommendationDataModel(productName, imageLink, price, salePrice, null);
            }});
    options.attributes.put(ContentWidgetOptions.ContentWidgetOptionsAttributeKeyProductId, productId);
    ContentWidgetItemLayout itemLayoutDetails = new ContentWidgetItemLayout();
    DisplayMetrics displayMetrics = new DisplayMetrics();
    getWindowManager().getDefaultDisplay().getMetrics(displayMetrics);
    float screenWidthDp = displayMetrics.widthPixels;
    ContentWidgetGridLayout layout = new ContentWidgetGridLayout(screenWidthDp);

    //CardView parameters
    layout.setCardViewSize(250, 350);
    itemLayoutDetails.cardViewElevation = 5;
    itemLayoutDetails.cardViewCornerRadius = 5;
    layout.cardViewHorizontalSpacing = 10;
    layout.cardViewVerticalSpacing = 10;
    layout.includeEdgeSpacing = false;
    layout.cardViewBackgroundColor = ContextCompat.getColor(Synerise.getApplicationContext(), R.color.regent);

    //Image size as ratio to cardview size
    itemLayoutDetails.imageHeightToCardHeightRatio = 0.7;
    itemLayoutDetails.imageWidthToCardWidthRatio = 1;
    itemLayoutDetails.imageMargin = 5; //have to be set when you set cardViewElevation

    //TextView product name
    itemLayoutDetails.itemTitleStyle = Typeface.create("sans-serif-condensed", Typeface.NORMAL);
    itemLayoutDetails.itemTitleSize = 12;
    itemLayoutDetails.itemTitleColor = ContextCompat.getColor(Synerise.getApplicationContext(), R.color.charcoal);
    itemLayoutDetails.itemTitleGravity = Gravity.LEFT;
    itemLayoutDetails.setItemTitleMargins(10, 0, 10, 0);

    //TextView Product price
    itemLayoutDetails.itemPriceStyle = Typeface.create("sans-serif-light", Typeface.BOLD);
    itemLayoutDetails.itemPriceSize = 12;
    itemLayoutDetails.itemPriceColor = ContextCompat.getColor(Synerise.getApplicationContext(), R.color.charcoal);
    itemLayoutDetails.itemPriceGravity = Gravity.LEFT;
    itemLayoutDetails.setItemPriceMargins(10, 0, 10, 0);
    
    //TextView Product Sale Price
    itemLayoutDetails.itemSalePriceStyle = Typeface.create("sans-serif", Typeface.BOLD)
    itemLayoutDetails.itemSalePriceSize = 13
    itemLayoutDetails.itemSalePriceColor = ContextCompat.getColor(Synerise.getApplicationContext(), R.color.red)
    itemLayoutDetails.itemSalePriceOrientation = LinearLayout.HORIZONTAL
    itemLayoutDetails.isItemSalePriceVisible = true
    itemLayoutDetails.setItemSalePriceMargins(5, 0, 3, 0)
    
    //ImageButton
    val favouriteIcon = ImageButtonCustomAction()
    val likeHeart = ContextCompat.getDrawable(this, R.drawable.ic_heart)
    val unlikeHeart = ContextCompat.getDrawable(this, R.drawable.ic_heart_outline)
    favouriteIcon.setStateDrawables(unlikeHeart, likeHeart)
    favouriteIcon.setImageButtonCustomActionMargins(0, 0, 0, 0)
    favouriteIcon.predefinedAction = PredefinedActionType.SEND_LIKE_EVENT
    favouriteIcon.setOnItemActionListener(object:OnActionItemStateListener() {
        fun onReceiveClickAction(model:BaseModel, isSelected:Boolean, imageButton:ImageButton) {
            val recommendation = model as Recommendation
            ViewUtils.pulse(imageButton)
        }
        
        fun onStateCheck(model:BaseModel):Boolean {
            // Here you should set buttonState based on a product and a customer.
            return false
        }
    })
    
    itemLayoutDetails.setItemAction(favouriteIcon)
    ContentWidgetAppearance contentWidgetAppearance = new ContentWidgetAppearance(layout, itemLayoutDetails);
    ContentWidget widget = new ContentWidget(options, contentWidgetAppearance);


    widget.setOnContentWidgetListener(new OnContentWidgetListener() {
            @Override
            public void onLoading(ContentWidget contentWidget, boolean isLoading) {

            }

            @Override
            public void onLoadingError(ContentWidget contentWidget, ApiError apiError) {
                Toast.makeText(getApplicationContext(), apiError.toString(),Toast.LENGTH_LONG).show();
            }

            @Override
            public void onLoad(ContentWidget contentWidget) {
                insertPoint.removeAllViews();
                View view = widget.getView();
                insertPoint.addView(view);
            }

            @Override
            public void onClickActionReceive(ContentWidget contentWidget, BaseModel model) {
                Recommendation recommendation = (Recommendation)model;
                startActivity(WidgetRecommendedProductDetailsActivity.createIntent(getApplicationContext(), recommendation.getProductRetailerPartNo()));
            }

            @Override
            public void onSizeChange(ContentWidget contentWidget, ViewGroup.LayoutParams size) {
                ViewGroup.LayoutParams params = insertPoint.getLayoutParams();
                params.height = size.height;
                insertPoint.setLayoutParams(params);
            }
        });
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-575-1" data-tab-group="tabgrp-575">

```kotlin
private fun loadFullScreenWidget() {
    val slug = "similar"
    val productId = "10214"
    var options: ContentWidgetOptions = ContentWidgetRecommendationsOptions(this, slug, object : OnRecommendationModelMapper() {
        fun onRecommendationMapping(recommendation: Recommendation): ContentWidgetRecommendationDataModel? {
        // here you should implement your mapping to SyneriseModel
            val data = recommendation.getFeed()
            val imageLink = data["imageLink"] as String?
            val productName = data["title"] as String?
            var price: String? = null
            var salePrice: String? = null
            try {
                val json = JSONObject(data["price"].toString())
                price = json.getString("value")
                if (data.containsKey("salePrice")) {
                    val jsonSalePrice = JSONObject(data["salePrice"].toString())
                    salePrice = jsonSalePrice.getString("value")
                }
            } catch (e: JSONException) {
                e.printStackTrace()
            }
            return ContentWidgetRecommendationDataModel(productName, imageLink, price, salePrice, null)
        }
    })
    
    options.attributes.put(ContentWidgetOptions.ContentWidgetOptionsAttributeKeyProductId, productId);
    val itemLayoutDetails = ContentWidgetItemLayout()
    val displayMetrics = DisplayMetrics()
    getWindowManager().getDefaultDisplay().getMetrics(displayMetrics)
    val screenWidthDp = displayMetrics.widthPixels
    val layout = ContentWidgetGridLayout(screenWidthDp)

    //CardView parameters
    layout.setCardViewSize(250, 350)
    itemLayoutDetails.cardViewElevation = 5
    itemLayoutDetails.cardViewCornerRadius = 5
    layout.cardViewHorizontalSpacing = 10
    layout.cardViewVerticalSpacing = 10
    layout.includeEdgeSpacing = false
    layout.cardViewBackgroundColor = ContextCompat.getColor(Synerise.getApplicationContext(), R.color.regent)

    //Image size as ratio to cardview size
    itemLayoutDetails.imageHeightToCardHeightRatio = 0.7
    itemLayoutDetails.imageWidthToCardWidthRatio = 1
    itemLayoutDetails.imageMargin = 5 //have to be set when you set cardViewElevation

    //TextView product name
    itemLayoutDetails.itemTitleStyle = Typeface.create("sans-serif-condensed", Typeface.NORMAL)
    itemLayoutDetails.itemTitleSize = 12
    itemLayoutDetails.itemTitleColor = ContextCompat.getColor(Synerise.getApplicationContext(), R.color.charcoal)
    itemLayoutDetails.itemTitleGravity = Gravity.LEFT
    itemLayoutDetails.setItemTitleMargins(10, 0, 10, 0)

    //TextView Product price
    itemLayoutDetails.itemPriceStyle = Typeface.create("sans-serif-light", Typeface.BOLD)
    itemLayoutDetails.itemPriceSize = 12
    itemLayoutDetails.itemPriceColor = ContextCompat.getColor(Synerise.getApplicationContext(), R.color.charcoal)
    itemLayoutDetails.itemPriceGravity = Gravity.LEFT
    itemLayoutDetails.setItemPriceMargins(10, 0, 10, 0)
    
    //TextView Product Sale Price
    itemLayoutDetails.itemSalePriceStyle = Typeface.create("sans-serif", Typeface.BOLD)
    itemLayoutDetails.itemSalePriceSize = 13
    itemLayoutDetails.itemSalePriceColor = ContextCompat.getColor(Synerise.getApplicationContext(), R.color.red)
    itemLayoutDetails.itemSalePriceOrientation = LinearLayout.HORIZONTAL
    itemLayoutDetails.isItemSalePriceVisible = true
    itemLayoutDetails.setItemSalePriceMargins(5, 0, 3, 0)
    
    //ImageButton
    val favouriteIcon = ImageButtonCustomAction()
    val likeHeart = ContextCompat.getDrawable(this, R.drawable.ic_heart)
    val unlikeHeart = ContextCompat.getDrawable(this, R.drawable.ic_heart_outline)
    favouriteIcon.setStateDrawables(unlikeHeart, likeHeart)
    favouriteIcon.setImageButtonCustomActionMargins(0, 0, 0, 0)
    favouriteIcon.predefinedAction = PredefinedActionType.SEND_LIKE_EVENT
    favouriteIcon.setOnItemActionListener(object:OnActionItemStateListener() {
        fun onReceiveClickAction(model:BaseModel, isSelected:Boolean, imageButton:ImageButton) {
            val recommendation = model as Recommendation
            ViewUtils.pulse(imageButton)
        }
        
        fun onStateCheck(model:BaseModel):Boolean {
            // Here you should set buttonState based on a product and a customer.
            return false
        }
    })
    
    itemLayoutDetails.setItemAction(favouriteIcon)
    val contentWidgetAppearance = ContentWidgetAppearance(layout, itemLayoutDetails)
    val widget = ContentWidget(options, contentWidgetAppearance)
    widget.setOnContentWidgetListener(object:OnContentWidgetListener() {
        fun onLoading(contentWidget:ContentWidget, isLoading:Boolean) {
        
        }
        
        fun onLoadingError(contentWidget:ContentWidget, apiError:ApiError) {
            Toast.makeText(getApplicationContext(), apiError.toString(), Toast.LENGTH_LONG).show()
        }

        fun onLoad(contentWidget:ContentWidget) {
            insertPoint.removeAllViews()
            val view = widget.getView()
            insertPoint.addView(view)
        }

        fun onClickActionReceive(contentWidget:ContentWidget, model:BaseModel) {
            val recommendation = model as Recommendation
            startActivity(WidgetRecommendedProductDetailsActivity.createIntent(getApplicationContext(), recommendation.getProductRetailerPartNo()))
        }

        fun onSizeChange(contentWidget:ContentWidget, size:ViewGroup.LayoutParams) {
            val params = insertPoint.getLayoutParams()
            params.height = size.height
            insertPoint.setLayoutParams(params)
        }
    })
}
```

</div>
</div>


### More information
---

You can find more information under the following links:

- [Sample App on GitHub](https://github.com/Synerise/android-sdk)
- [Horizontal slider implementation in the Sample App on GitHub](https://github.com/Synerise/android-sdk/blob/master/sample/src/main/java/com/synerise/sdk/sample/ui/dev/content/WidgetHorizontalSliderActivity.java)
- [Grid implementation in the Sample App on GitHub](https://github.com/Synerise/android-sdk/blob/master/sample/src/main/java/com/synerise/sdk/sample/ui/dev/content/WidgetGridViewActivity.java)
```



# Profile management



<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to handling identifiers](/docs/settings/configuration/identifier-standardization).

</div></div></div>


When the customer is authenticated with a JWT token in your application, You can retrieve or update customer details by using the SDK methods. These methods can be used only by recognized profiles, except [updating a customer account's basic information](#update-a-customer-accounts-basic-information), which can be used for anonymous profile too.


<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

You must synchronize your data with Synerise backend after deleting an account on your side.

</div></div></div>


## Profile management methods

### Get a customer account details
You can use this method to retrieve all information about a customer from Synerise. You can then present that information in the app.

| OS           | Method                                                                                                                         |
|--------------|--------------------------------------------------------------------------------------------------------------------------------|
| Android      | [Client.getAccount()](/developers/mobile-sdk/method-reference/android/client-account#get-customer-account-information)               |
| iOS          | [Client.getAccount(success:failure:)](/developers/mobile-sdk/method-reference/ios/client-account#get-customer-account-information)   |
| React Native | [Synerise.Client.getAccount(onSuccess, onError)](/developers/mobile-sdk/method-reference/react-native/client-account#get-customer-account-information) |
| Flutter | [Synerise.client.getAccount()](/developers/mobile-sdk/method-reference/flutter/client-account#get-customer-account-information)       |

### Update a customer account's basic information
You can use this method to let customers update their own basic information, except for updating identifiers: `uuid`, `customId`, `email`.

| OS           | Method                                                                                                                                     |
|--------------|--------------------------------------------------------------------------------------------------------------------------------------------|
| Android      | [Client.updateAccountBasicInformation(accountInformation)](/developers/mobile-sdk/method-reference/android/client-account#update-customer-account-basic-information)                     |
| iOS          | [Client.updateAccountBasicInformation(context:success:failure:)](/developers/mobile-sdk/method-reference/ios/client-account#update-customer-account-basic-information) |
| React Native | [Synerise.Client.updateAccountBasicInformation(context, onSuccess, onError)](/developers/mobile-sdk/method-reference/react-native/client-account#update-customer-account-basic-information)       |
| Flutter | [Synerise.client.updateAccountBasicInformation(context)](/developers/mobile-sdk/method-reference/flutter/client-account#update-customer-account-basic-information)       |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This method can be used by recognized and anonymous profiles.

</div></div></div>


### Update a customer account's details
You can use this method to let customers update their own information, including updating identifiers: `uuid`, `customId`, `email`.

| OS           | Method                                                                                                                                     |
|--------------|--------------------------------------------------------------------------------------------------------------------------------------------|
| Android      | [Client.updateAccount(accountInformation)](/developers/mobile-sdk/method-reference/android/client-account#update-customer-account-information)                     |
| iOS          | [Client.updateAccount(context:success:failure:)](/developers/mobile-sdk/method-reference/ios/client-account#update-customer-account-information) |
| React Native | [Synerise.Client.updateAccount(context, onSuccess, onError)](/developers/mobile-sdk/method-reference/react-native/client-account#update-customer-account-information)       |
| Flutter | [Synerise.client.updateAccount(context)](/developers/mobile-sdk/method-reference/flutter/client-account#update-customer-account-information)       |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This method can be used only by recognized profiles.

</div></div></div>


### Change a customer's password

Separately from customer information updates, a customer may want to change their password. The default password policy is:
- Minimum 6 characters
- At least one uppercase letter
- At least one lowercase letter
- At least one digit
- At least one non-alphanumeric character

Passwords are PBKDF2-encrypted.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

You can define the password policy in the Synerise platform (`app.synerise.com`). You can find more information about it [here](/docs/settings/tool/iam-for-apps/synerise#password-policy).

</div></div></div>


This method allows a customer to change their password, but they must provide their current password first.

| OS           | Method                                                                                                                                             |
|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
| Android      | [Client.changePassword(oldPassword, password)](/developers/mobile-sdk/method-reference/android/client-account#change-customers-account-password)                        |
| iOS          | [Client.changePassword(password:oldPassword:success:failure:)](/developers/mobile-sdk/method-reference/ios/client-account#change-customers-account-password) |
| React Native | [Synerise.Client.changePassword()](/developers/mobile-sdk/method-reference/react-native/client-account#change-customers-account-password) |
| Flutter | [Synerise.client.changePassword(oldPassword, password)](/developers/mobile-sdk/method-reference/flutter/client-account#change-customers-account-password)       |

### Request and confirm email change

These methods allow customers request and confirm the change of their email address.

| OS           | Method                                                                                                                                                                                                                                                                                                                                                                       |
|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Android      | - [Client.requestEmailChange(email, password, externalToken, authId)](/developers/mobile-sdk/method-reference/android/client-account#request-email-change-for-customer-account) <br> - [Client.confirmEmailChange(token, newsletterAgreement)](/developers/mobile-sdk/method-reference/android/client-account#confirm-email-change-for-customer-account)                                                       |
| iOS          | - [Client.requestEmailChange(email:password:externalToken:authID:success:failure:)](/developers/mobile-sdk/method-reference/ios/client-account#request-email-change-for-customer-account) <br> - [Client.confirmEmailChange(token:success:failure:)](/developers/mobile-sdk/method-reference/ios/client-account#confirm-email-change-for-customer-account)                                                        |
| React Native | - [Synerise.Client.requestEmailChange(email, password, onSuccess, onError)](/developers/mobile-sdk/method-reference/react-native/client-account#request-email-change-for-customer-account) <br> - [Synerise.Client.confirmEmailChange(token, newsletterAgreement, onSuccess, onError)](/developers/mobile-sdk/method-reference/react-native/client-account#confirm-email-change-for-customer-account) |
| Flutter | n/a |

### Request and confirm phone number change

These methods allow customers to request and confirm the change of their phone number.

| OS           | Method                                                                                                                                                                                                                                                                                                                                                           |
|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Android      | - [requestPhoneUpdate(phone:success:failure:)](/developers/mobile-sdk/method-reference/android/client-account#request-phone-update-on-customer-account) <br> - [Client.confirmPhoneUpdate(phone, confirmationCode, smsAgreement)](/developers/mobile-sdk/method-reference/android/client-account#confirm-phone-update-on-customer-account)                                             |
| iOS          | - [Client.requestPhoneUpdate(phone:success:failure:)](/developers/mobile-sdk/method-reference/ios/client-account#request-phone-update-on-customer-account) <br> - [Client.confirmPhoneUpdate(phone:confirmationCode:success:failure:)](/developers/mobile-sdk/method-reference/ios/client-account#confirm-phone-update-on-customer-account)                                                             |
| React Native | - [Synerise.Client.requestPhoneUpdate(phone, onSuccess, onError)](/developers/mobile-sdk/method-reference/react-native/client-account#request-phone-update-on-customer-account) <br> - [Synerise.Client.confirmPhoneUpdate(phone, confirmationCode, smsAgreement, onSuccess, onError)](/developers/mobile-sdk/method-reference/react-native/client-account#confirm-phone-update-on-customer-account) |
| Flutter | n/a |

### Remove a customer

To allow a customer to remove their account, implement the following method:

| OS           | Method                                                                                                                                                                                                                              |
|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Android      | [Client.deleteAccount(clientAuthFactor, clientIdentityProvider, authId)](/developers/mobile-sdk/method-reference/android/client-account#delete-customer-account-by-identity-provider)                                                                |
| iOS          | [Client.deleteAccount(clientAuthFactor:clientIdentityProvider:authID:success:failure:)](/developers/mobile-sdk/method-reference/ios/client-account#delete-customer-account-by-identity-provider)                                          |
| React Native | [Synerise.Client.deleteAccountByIdentityProvider(clientAuthFactor, clientIdentityProvider, authID, onSuccess, onError)](/developers/mobile-sdk/method-reference/react-native/client-account#delete-customer-account-by-identity-provider) |
| Flutter | [Synerise.client.deleteAccount(clientAuthFactor, identityProvider, authId)](/developers/mobile-sdk/method-reference/flutter/client-account#delete-customer-account)       |



# Action handling


## Types of actions in campaigns
---
Campaigns can have three action types:
- **OPEN APP** - This option opens your app after clicking the notification. If the app is already in the foreground, clicking the notification doesn't have any effect.
- **OPEN URL** - This option opens a URL. Depending on your implementation, the link is opened in the browser by default or in your custom implementation, such as a webview in your application.
- **DEEP LINKING** - This option lets you transfer users to a specific view in your app by system methods or by your custom implementation.

## Handling actions from campaigns {id=handling-actions-from-campaigns}
---
You can handle actions from campaigns by using dedicated listeners and delegates:
- [OnInjectorListener](/developers/mobile-sdk/listeners-and-delegates/android-listeners#on-injector-listener) for [handling actions in Android](/developers/mobile-sdk/campaigns/action-handling#handling-actions-from-campaigns-in-android)
- [SyneriseDelegate](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#synerise-delegate) for [handling actions in iOS](/developers/mobile-sdk/campaigns/action-handling#handling-actions-from-campaigns-in-ios)
- [InjectorListener](/developers/mobile-sdk/listeners-and-delegates/react-native-listeners#injector-listener) for [handling actions in React Native](/developers/mobile-sdk/campaigns/action-handling#handling-actions-from-campaigns-in-react-native)
- [InjectorListener](/developers/mobile-sdk/listeners-and-delegates/flutter-listeners#injector-listener) for [handling actions in Flutter](/developers/mobile-sdk/campaigns/action-handling#handling-actions-from-campaigns-in-flutter)

If you don't implement listener/delegate for handling actions in your customized way:
- The SDK runs the default browser with the requested URL address for **OPEN URL**.
- The SDK tries to handle the deep link in the host app by a system method for **DEEP LINKING**.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

On iOS, deep links require special attention. The default SDK behaviour uses the [UIApplication.shared.canOpenURL(_:)](https://developer.apple.com/documentation/uikit/uiapplication/1622952-canopenurl) method. That method verifies a whitelist of deep links in `LSApplicationQueriesSchemes` key in the `\*.plist` file. Read more in [Apple documentation](https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/LaunchServicesKeys.html#//apple_ref/doc/plist/info/LSApplicationQueriesSchemes).

</div></div></div>


### Android {id=handling-actions-from-campaigns-in-android}

You can handle actions from each type of campaign in your own customized way by using [OnInjectorListener](/developers/mobile-sdk/listeners-and-delegates/android-listeners#on-injector-listener) methods. 

The [OnInAppListener](/developers/mobile-sdk/listeners-and-delegates/android-listeners#on-in-app-listener) monitors when a [JS method is used in an in-app message](/docs/campaign/in-app-messages/creating-inapp-templates/creating-inapp-template#javascript-methods-in-in-app-messages).

In extended methods for handling **OPEN URL** and **DEEP LINKING**, the following parameters are available:
- URL value from the action of the activity.
- Deep link value from the action of the activity.
- [`SyneriseSource`](/developers/mobile-sdk/class-reference/android/campaigns#synerisesource): enum that defines the kind of activity from the action that was sent.

#### Configuration {id=configuration-for-handling-actions-from-campaigns-in-android}

1. Make your activity available for deep linking by including the following parameters in your AndroidManifest:
   
   <pre><code class="language-XML">&lt;activity
         android:name=".ui.linking.DeepLinkingActivity"&gt;
         &lt;intent-filter&gt;
             &lt;action android:name="syne://test" /&gt;
             &lt;category android:name="android.intent.category.DEFAULT" /&gt;
              &lt;data 
                 android:scheme="syne"
                 android:host="test" /&gt;
         &lt;/intent-filter&gt;
      &lt;/activity&gt;</code></pre>


   For the configuration above, the sample **deep link** parameter is `syne://test?param=value`, where:
   - `syne` and `test` are the scheme and host provided in the intent filter.
   - `parameter` is the parameter name.
   - `value` is the parameter value.

   
     <div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

     Your action name must be the same as your URI scheme and host.

     </div></div></div>

2. **Optional**: Define an activity to be called after closing the activity that was initiated by deep linking. Provide an additional intent category:
   
   <div class="highlight-code-block" data-hl-lines="7">
   <pre><code class="language-XML">&lt;activity
         android:name=".ui.linking.DeepLinkingActivity"
         android:parentActivityName=".ui.linking.ParentDeepLinkingActivity"&gt;
         &lt;intent-filter&gt;
             &lt;action android:name="android.intent.action.VIEW" /&gt;
             &lt;category android:name="android.intent.category.DEFAULT" /&gt;
             &lt;category android:name="android.intent.category.BROWSABLE" /&gt;
             &lt;data
                 android:host="test"
                 android:scheme="syne" /&gt;
         &lt;/intent-filter&gt;
      &lt;/activity&gt;</code></pre>
   </div>



<div class="admonition admonition-tip"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M9.663 17h4.673M12 3v1m6.364 1.636l-.707.707M21 12h-1M4 12H3m3.343-5.657l-.707-.707m2.828 9.9a5 5 0 117.072 0l-.548.547A3.374 3.374 0 0014 18.469V19a2 2 0 11-4 0v-.531c0-.895-.356-1.754-.988-2.386l-.548-.547z" /></svg></div><div class="admonition-body"><div class="admonition-content">

If your deep link doesn't contain the `://` characters after the scheme, it is treated as a regular string key and set to the Intent's action.  
This means that you can set an action name (in your AndroidManifest activity's intent filter) to any string and then match it with the provided deep link.

</div></div></div>


#### Sample implementation {id=handling-open-url-deeplink-actions-in-android}


<pre><code class="language-java">InjectorActionHandler.setOnInjectorListener(new OnInjectorListener() {
  @Override
  public boolean onOpenUrl(SyneriseSource source, String url) {
    //your implementation of OPEN URL action
    return false;
  }

  @Override
  public boolean onDeepLink(SyneriseSource source, String deepLink) {
    //your implementation of DEEP LINKING action
    return false;
  }
});</code></pre>



<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

If you don't configure a custom action, the SDK applies the default behavior, as described [earlier](/developers/mobile-sdk/campaigns/action-handling#handling-actions-from-campaigns).

</div></div></div>


### iOS {id=handling-actions-from-campaigns-in-ios}

You can handle actions from each type of campaign in your own customized way by using [SyneriseDelegate](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#synerise-delegate) methods. 

The [InjectorInAppMessageDelegate](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#injector-in-app-message-delegate) monitors when a [JS method is used in an in-app message](/docs/campaign/in-app-messages/creating-inapp-templates/creating-inapp-template#javascript-methods-in-in-app-messages).

In extended methods for handling **OPEN URL** and **DEEP LINKING**, the following parameters are available:
- URL value from the action of the activity.
- Deep link value from the action of the activity.
- [`SyneriseSource`](/developers/mobile-sdk/class-reference/ios/campaigns#synerisesource): enum that defines the kind of activity from the action that was sent.  
    This enum replaces the deprecated [`SyneriseActivity` enum](/developers/mobile-sdk/class-reference/ios/campaigns#syneriseactivity).
- `SyneriseActivityCompletionHandler`: block/closure that defines whether an activity should be hidden or not and what code should be invoked after.

#### Sample implementation of OPEN URL action {id=handling-open-url-action-in-ios}

This way you can, for example, check the type of activity or use your own webview to show the web page.


<pre><code class="language-swift">// MARK: - SyneriseDelegate

func snr_handledAction(url: URL, source: SyneriseSource) {
  if source == .simplePush {
    if UIApplication.shared.canOpenURL(url) {
      UIApplication.shared.openURL(url)
    }
    return
  }

  if source == .simplePush {
    //...
    return
  }
}</code></pre>



#### Sample implementation of DEEP LINKING action {id=handling-deeplink-action-in-ios}

This way you can, for example, check the type of activity and handle your deep link in a custom way.


<pre><code class="language-swift">// MARK: - SyneriseDelegate

func snr_handledAction(deepLink: String, source: SyneriseSource) {
  if source == .inAppMessage {
    goToHelpWithId(deepLink)
    return
  }

  if source == .simplePush {
    goToMessageWithId(deepLink)
    return
  }
}</code></pre>


#### System method to handle deep links

The code below presents a system method sample implementation to handle deep links. See [Apple Developer - UIApplication.open(_:options:completionHandler:)](https://developer.apple.com/documentation/uikit/uiapplication/1648685-open) method for more details.



<pre><code class="language-swift">@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
  //...
  //other methods
  func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey: Any] = [:]) -&gt; Bool {
    let sourceApplication: String? = options[UIApplication.OpenURLOptionsKey.sourceApplication] as? String
    let annotation: Any? = options[UIApplication.OpenURLOptionsKey.annotation]
        
    let handled: Bool = ApplicationDelegate.shared.application(app, open: url, sourceApplication: sourceApplication, annotation: annotation)
      if handled == true {
        return true
      }
        
      if url.scheme == "sample-swift" {
        applicationController.getMainCoordinator()?.didReceiveDeeplink(host: url.host!, pathComponents: url.pathComponents)
        return true
      }
        
    return false
  }
}</code></pre>



<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

If you don't configure a custom action, the SDK applies the default behavior, as described [earlier](/developers/mobile-sdk/campaigns/action-handling#handling-actions-from-campaigns).

</div></div></div>


### React Native {id=handling-actions-from-campaigns-in-react-native}

You can specify your custom action when a customer interacts with your simple push, banner, walkthrough, or in-app message.

You can handle actions from each type of campaign in your own customized way by using [InjectorListener](/developers/mobile-sdk/listeners-and-delegates/react-native-listeners#injector-listener) methods.

In listener methods for handling **OPEN URL** and **DEEP LINKING**, the following parameters are available:
- URL value from the action of the activity.
- Deep link value from the action of the activity.
- [`SyneriseSource`](/developers/mobile-sdk/class-reference/react-native/campaigns#synerisesource): enum that defines the kind of activity from the action that was sent.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-13">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-13-0" data-tab-group="tabgrp-13" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-13-0" data-tab-group="tabgrp-13" data-tab-active="true">

```JavaScript
Synerise.Injector.setListener({
  onOpenUrl: function(url, source) {
    //your implementation of OPEN URL action
    Linking.openURL(url);
  },
  onDeepLink: function(deepLink, source) {
    //your implementation of DEEP LINKING action
  }
  //...
  //other listener's methods
});
```

</div>
</div>



<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

If you don't configure a custom action, the SDK applies the default behavior, as described [earlier](/developers/mobile-sdk/campaigns/action-handling#handling-actions-from-campaigns).

</div></div></div>


### Flutter {id=handling-actions-from-campaigns-in-flutter}

You can specify your custom action when a customer interacts with your simple push, banner, walkthrough, or in-app message.

You can handle actions from each type of campaign in your own customized way by using [InjectorListener](/developers/mobile-sdk/listeners-and-delegates/flutter-listeners#injector-listener) methods.

In listener methods for handling **OPEN URL** and **DEEP LINKING**, the following parameters are available:
- URL value from the action of the activity.
- Deep link value from the action of the activity.
- [`SyneriseSource`](/developers/mobile-sdk/class-reference/flutter/campaigns#synerisesource): enum that defines the kind of activity from the action that was sent.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-14">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-14-0" data-tab-group="tabgrp-14" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-14-0" data-tab-group="tabgrp-14" data-tab-active="true">

```Dart
Synerise.injector.listener((listener) {
  listener.onOpenUrl = (url, source) {
    //your implementation of OPEN URL action
  };
  listener.onDeepLink = (deepLink, source) {
    //your implementation of DEEP LINKING action
  };
  //...
  //other listener's methods
});
```

</div>
</div>



<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

If you don't configure a custom action, the SDK applies the default behavior, as described [earlier](/developers/mobile-sdk/campaigns/action-handling#handling-actions-from-campaigns).

</div></div></div>


## Universal linking
---
Universal links help your users follow links to content in your app or to your website. When they open a universal link, their mobile OS checks whether any installed app is registered for that domain. If there is no configured application URL for a given path, the user stays on the website.


<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

In order to send universal links from Synerise, you must use the **OPEN URL** action in your campaign configuration on Synerise UI.

</div></div></div>


### Android {id=universal-linking-in-android}

In order to implement universal links, you need to configure them in the `AndroidManifest.xml` file in your application.

Add data to your activity in order to connect a URL with a screen.  


<pre><code class="language-XML">&lt;activity
  android:name=".ui.dev.tracker.TrackerViewActivity"
  android:screenOrientation="portrait"&gt;
  &lt;intent-filter&gt;
      &lt;action android:name="android.intent.action.VIEW" /&gt;
      &lt;category android:name="android.intent.category.DEFAULT" /&gt;
      &lt;category android:name="android.intent.category.BROWSABLE" /&gt;
      &lt;data
          android:host="synerise.com"
          android:pathPrefix="/tracker"
          android:scheme="https" /&gt;
      &lt;!-- note that the leading "/" is required for pathPrefix--&gt;
  &lt;/intent-filter&gt;
&lt;/activity&gt;</code></pre>


### iOS {id=universal-linking-in-ios}

To implement universal links:
1. On your app identifier, enable `Associated Domains`
2. In your Xcode project, enable `Associated Domain` (in capabilities).
3. Configure your website to host the `apple-app-site-association` file.
    
   <pre><code class="language-json">{
         "applinks": {
           "apps": [],
           "details": [
             {
               "appID": “&lt;&lt;TEAM_ID&gt;&gt;.com.synerise.sdk.sample",
               "paths": [
                 "*"
               ]
             }
           ]
         }
       }</code></pre>

4. Configure your app to handle universal links.

    
   <div class="content-tabs code-tabs" data-tab-group="tabgrp-15">
   <div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-15-0" data-tab-group="tabgrp-15" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-15-1" data-tab-group="tabgrp-15">Objective-C</button></div>

   <div class="tab-panel" data-tab-id="tabgrp-15-0" data-tab-group="tabgrp-15" data-tab-active="true">

   ```Swift
   func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([Any]?) -> Void) -> Bool {
     if userActivity.activityType == NSUserActivityTypeBrowsingWeb {
       let url = userActivity.webpageURL!
       print(url.absoluteString)
       // handle url and run app action that you want
     }

     return true
   }
   ```

   </div>

   <div class="tab-panel" data-tab-id="tabgrp-15-1" data-tab-group="tabgrp-15">

   ```Objective-C
   - (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray * _Nullable))restorationHandler{
     if ([userActivity.activityType isEqualToString: NSUserActivityTypeBrowsingWeb]) {
       NSURL *url = userActivity.webpageURL;
       NSLog(@"URL: %@", url.absoluteString);
       // handle url and run app action that you want
     }

     return YES;
   }
   ```

   </div>
   </div>


For more details, see [Apple Developer - Universal Links for Developers](https://developer.apple.com/ios/universal-links/).

## Handling actions from campaigns (older SDK versions) {id=handling-actions-from-campaigns-in-older-sdk-versions}
---

### Android (version 5.12.0 and lower) {id=legacy-handling-actions-from-campaigns-in-android}

You can handle actions in your own customized way by using:
- [InjectorListener](/developers/mobile-sdk/listeners-and-delegates/android-listeners#on-injector-listener) methods for simple push.
- [InAppMessageListener](/developers/mobile-sdk/listeners-and-delegates/android-listeners#on-in-app-listener) methods for in-app messages.


<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

You cannot handle actions in your own customized way for simple push. It works as default, so **OPEN URL** opens the browser and **DEEP LINKING** opens an activity associated with this deep link.

</div></div></div>


#### Configuration {id=legacy-configuration-for-handling-actions-from-campaigns-in-android}

1. Make your activity available for deep linking by including the following parameters in your AndroidManifest:
   
   <pre><code class="language-XML">&lt;activity
         android:name=".ui.linking.DeepLinkingActivity"&gt;
         &lt;intent-filter&gt;
             &lt;action android:name="syne://test" /&gt;
             &lt;category android:name="android.intent.category.DEFAULT" /&gt;
              &lt;data 
                 android:scheme="syne"
                 android:host="test" /&gt;
         &lt;/intent-filter&gt;
      &lt;/activity&gt;</code></pre>

   
   <div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

   Your action name must be the same as your URI scheme and host.

   </div></div></div>

2. **Optional**: Define an activity to be called after closing the activity that was initiated by deep linking. Provide an additional intent category:
   
   <div class="highlight-code-block" data-hl-lines="7">
   <pre><code class="language-XML">&lt;activity
         android:name=".ui.linking.DeepLinkingActivity"
         android:parentActivityName=".ui.linking.ParentDeepLinkingActivity"&gt;
         &lt;intent-filter&gt;
             &lt;action android:name="android.intent.action.VIEW" /&gt;
             &lt;category android:name="android.intent.category.DEFAULT" /&gt;
             &lt;category android:name="android.intent.category.BROWSABLE" /&gt;
             &lt;data
                 android:host="test"
                 android:scheme="syne" /&gt;
         &lt;/intent-filter&gt;
      &lt;/activity&gt;</code></pre>
   </div>


   For the configuration above, the sample **deep link** parameter is `syne://test?param=value`, where:
   - `syne` and `test` are the scheme and host provided in the intent filter.
   - `parameter` is the parameter name.
   - `value` is the parameter value.

   
     <div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

     Your action name must be the same as your URI scheme and host.

     </div></div></div>

   
2. **Optional**: Define an activity to be called after closing the activity that was initiated by deep linking. Provide an additional intent category:
   
   <div class="highlight-code-block" data-hl-lines="7">
   <pre><code class="language-XML">&lt;activity
         android:name=".ui.linking.DeepLinkingActivity"
         android:parentActivityName=".ui.linking.ParentDeepLinkingActivity"&gt;
         &lt;intent-filter&gt;
             &lt;action android:name="android.intent.action.VIEW" /&gt;
             &lt;category android:name="android.intent.category.DEFAULT" /&gt;
             &lt;category android:name="android.intent.category.BROWSABLE" /&gt;
             &lt;data
                 android:host="test"
                 android:scheme="syne" /&gt;
         &lt;/intent-filter&gt;
      &lt;/activity&gt;</code></pre>
   </div>



<div class="admonition admonition-tip"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M9.663 17h4.673M12 3v1m6.364 1.636l-.707.707M21 12h-1M4 12H3m3.343-5.657l-.707-.707m2.828 9.9a5 5 0 117.072 0l-.548.547A3.374 3.374 0 0014 18.469V19a2 2 0 11-4 0v-.531c0-.895-.356-1.754-.988-2.386l-.548-.547z" /></svg></div><div class="admonition-body"><div class="admonition-content">

If your deep link doesn't contain the `://` characters after the scheme, it is treated as a regular string key and set to the Intent's action.  
This means that you can set an action name (in your AndroidManifest activity's intent filter) to any string and then match it with the provided deep link.

</div></div></div>


#### Simple Push {id=legacy-handling-simple-push-actions-in-android}

The SDK handle those actions by default, so **OPEN URL** opens the browser and **DEEP LINKING** opens an activity associated with this deep link.

   

#### In-app messages {id=legacy-handling-in-app-message-actions-in-android}

The SDK allows you to handle those actions. By default, an **OPEN URL** opens the browser and **DEEP LINKING** opens an activity associated with this deep link.

You can specify your custom action when a customer interacts with your in-app messages.


<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The callbacks presented below work only with in-app message.

</div></div></div>


If you want to implement your own behavior, refer to the following code: 


<div class="content-tabs code-tabs" data-tab-group="tabgrp-16">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-16-0" data-tab-group="tabgrp-16" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-16-1" data-tab-group="tabgrp-16">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-16-0" data-tab-group="tabgrp-16" data-tab-active="true">

```Java
public static OnInAppListener NULL = new OnInAppListener() {
  @Override
  public void onHandledOpenUrl(InAppMessageData inAppMessageData) {
    //your implementation of OPEN URL action
  }

  @Override
  public void onHandledOpenDeepLink(InAppMessageData inAppMessageData) {
    //your implementation of DEEP LINKING action
  }
};
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-16-1" data-tab-group="tabgrp-16">

```Kotlin
var inAppCallbacks: OnInAppListener = object : OnInAppListener() {
  override fun onHandledOpenUrl(inAppMessageData: InAppMessageData) {
    //your implementation of OPEN URL action
  }

  override fun onHandledOpenDeepLink(inAppMessageData: InAppMessageData) {
    //your implementation of DEEP LINKING action
  }
}
```

</div>
</div>


- `onHandledOpenUrl(InAppMessageData)` - callback is fired when a customer interacts with the **OPEN URL** action. Returns **true** if the activity is closed after the action is executed, **false** otherwise.
- `onHandledOpenDeepLink(InAppMessageData)` - callback is fired when a customer interacts with the **DEEP LINKING** action. Returns **true** if the activity is closed after the action is executed, **false** otherwise.

### React Native (version 0.17.0 and lower) {id=legacy-handling-actions-from-campaigns-in-react-native}


<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

React Native SDK (version 0.17.0 and lower) cannot handle actions by default, you must implement it.

</div></div></div>


You can handle actions in your own customized way by using:
 - [InjectorListener](/developers/mobile-sdk/listeners-and-delegates/react-native-listeners#injector-listener) methods for simple push, banner and walkthrough
 - [InjectorInAppMessageListener](/developers/mobile-sdk/listeners-and-delegates/react-native-listeners#injector-in-app-message-listener) methods for in-app messages.

#### Simple Push, Banner and Walkthrough {id=legacy-handling-simple-push-banner-walkthrough-actions-in-react-native}

You can specify your custom action when a customer interacts with your simple push, banner, or walkthrough.


<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

On Android, you cannot handle actions in your own customized way for simple push. It works as default so **OPEN URL** opens the browser and **DEEP LINKING** opens an activity.

</div></div></div>



<div class="content-tabs code-tabs" data-tab-group="tabgrp-17">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-17-0" data-tab-group="tabgrp-17" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-17-0" data-tab-group="tabgrp-17" data-tab-active="true">

```JavaScript
Synerise.Injector.setListener({
  onOpenUrl: function(url) {
    //your implementation of OPEN URL action
    Linking.openURL(url);
  },
  onDeepLink: function(deepLink) {
    //your implementation of DEEP LINKING action
  }
  //...
  //other listener's methods
});
```

</div>
</div>



#### In-app messages {id=legacy-handling-in-app-message-actions-in-react-native}

You can specify your custom action when a customer interacts with your in-app messages.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-18">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-18-0" data-tab-group="tabgrp-18" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-18-0" data-tab-group="tabgrp-18" data-tab-active="true">

```JavaScript
Synerise.Injector.setInAppMessageListener({
  onOpenUrl: function(data, url) {
    //your implementation of OPEN URL action
  },
  onDeepLink: function(data, deepLink) {
    //your implementation of DEEP LINKING action
  },
  //...
  //other listener's methods
});
```

</div>
</div>


### Flutter (version 0.7.4 and lower) {id=legacy-handling-actions-from-campaigns-in-flutter}


<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Flutter SDK (version 0.7.4 and lower) cannot handle actions by default, you must implement it.

</div></div></div>


You can handle actions in your own customized way by using:
 - [InjectorListener](/developers/mobile-sdk/listeners-and-delegates/flutter-listeners#injector-listener) methods for simple push, banner and walkthrough
 - [InjectorInAppMessageListener](/developers/mobile-sdk/listeners-and-delegates/flutter-listeners#injector-in-app-message-listener) methods for in-app messages.
  

#### Simple Push, Banner and Walkthrough {id=legacy-handling-simple-push-banner-walkthrough-actions-in-flutter}

You can specify your custom action when a customer interacts with your simple push, banner, or walkthrough.


<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

On Android, you cannot handle actions in your own customized way for simple push. It works as default so **OPEN URL** opens the browser and **DEEP LINKING** opens an activity.

</div></div></div>



<div class="content-tabs code-tabs" data-tab-group="tabgrp-19">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-19-0" data-tab-group="tabgrp-19" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-19-0" data-tab-group="tabgrp-19" data-tab-active="true">

```Dart
Synerise.injector.listener((listener) {
  listener.onOpenUrl = (url) {
    //your implementation of OPEN URL action
  };
  listener.onDeepLink = (deepLink) {
    //your implementation of DEEP LINKING action
  };
  //...
  //other listener's methods
});
```

</div>
</div>



#### In-app messages {id=legacy-handling-in-app-message-actions-in-flutter}

You can specify your custom action when a customer interacts with your in-app messages.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-20">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-20-0" data-tab-group="tabgrp-20" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-20-0" data-tab-group="tabgrp-20" data-tab-active="true">

```Dart
Synerise.injector.inAppMessageListener((listener) {
  listener.onOpenUrl = (data, url) {
    //your implementation of OPEN URL action
  };
  listener.onDeepLink = (data, deepLink) {
    //your implementation of DEEP LINKING action
  };
  //...
  //other listener's methods
});
```

</div>
</div>




# Session management


## UUID regeneration mechanism

The UUID is regenerated when:
* the application is reinstalled and UUID cannot be recovered
* one of the UUID regeneration methods is invoked:
    - [Regenerate customer](#regenerate-customer)
    - [Regenerate customer with identifier](#regenerate-customer-with-identifier)
* the destroy session method is invoked - [Destroy customer session](#destroy-customer-session)
* the SDK is reinitialized by changing the **Profile API Key** with one of these methods:
    - [Change Profile API Key dynamically](/developers/mobile-sdk/method-reference/android/lifecycle#change-profile-api-key-dynamically) for Android SDK
    - [Change Profile API Key dynamically](/developers/mobile-sdk/method-reference/ios/lifecycle#change-profile-api-key-dynamically) for iOS SDK
    - [Change Profile API Key dynamically](/developers/mobile-sdk/method-reference/react-native/lifecycle#change-profile-api-key-dynamically) for React Native SDK
    - [Change Profile API Key dynamically](/developers/mobile-sdk/method-reference/flutter/lifecycle#change-profile-api-key-dynamically) for Flutter SDK
* the customer is authenticated by [Simple Profile Authentication](/developers/mobile-sdk/user-identification-and-authorization/simple-authentication) with your own UUID set
* the customer is authenticated by one of the following options and the **authId/authID** parameter is used:
    - [Simple Profile Authentication](/developers/mobile-sdk/user-identification-and-authorization/simple-authentication#authentication-methods)
    - [Registration as a Service](/developers/mobile-sdk/user-identification-and-authorization/simple-authentication#authentication-methods)
    - [OAuth](/developers/mobile-sdk/user-identification-and-authorization/oauth#authentication-methods)
    - [External Providers](/developers/mobile-sdk/user-identification-and-authorization/authenticate-external-providers)
    
      <div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

      the **authId/authID** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer)

      </div></div></div>


* the customer is signed out with **SESSION_DESTROY** mode
* the customer is removed by the [removal methods](/developers/mobile-sdk/user-identification-and-authorization/identification-and-user-management#remove-a-customer)

## Session management methods

### Refresh customer token

This method refreshes the customer’s current token.

| OS           | Method                                                                                                                                                                                                                                                                                                                                                                       |
|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Android      | [Client.refreshToken()](/developers/mobile-sdk/method-reference/android/client-session#refresh-customer-token) |
| iOS          | [Client.refreshToken()](/developers/mobile-sdk/method-reference/ios/client-session#refresh-customer-token)               |
| React Native | [Synerise.Client.refreshToken()](/developers/mobile-sdk/method-reference/react-native/client-session#refresh-customer-token)  |
| Flutter | [Synerise.client.refreshToken()](/developers/mobile-sdk/method-reference/flutter/client-session#refresh-customer-token)  |

### Retrieve customer token

This method retrieves the customer’s current, active token. Authentication required.

| OS           | Method                                                                                                                                                                                                                                                                                                                                                                       |
|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Android      | [Client.retrieveToken()](/developers/mobile-sdk/method-reference/android/client-session#retrieve-customer-token) |
| iOS          | [Client.retrieveToken()](/developers/mobile-sdk/method-reference/ios/client-session#retrieve-customer-token)               |
| React Native | [Synerise.Client.retrieveToken()](/developers/mobile-sdk/method-reference/react-native/client-session#retrieve-customer-token)  |
| Flutter | [Synerise.client.retrieveToken()](/developers/mobile-sdk/method-reference/flutter/client-session#retrieve-customer-token)  |

### Get current customer UUID

This method retrieves the customer’s current UUID.

| OS           | Method                                                                                                                                                                                                                                                                                                                                                                       |
|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Android      | [Client.getUuid()](/developers/mobile-sdk/method-reference/android/client-session#get-current-customer-uuid) |
| iOS          | [Client.getUUID()](/developers/mobile-sdk/method-reference/ios/client-session#get-current-customer-uuid)               |
| React Native | [Synerise.Client.getUUID()](/developers/mobile-sdk/method-reference/react-native/client-session#get-current-customer-uuid)  |
| Flutter | [Synerise.client.getUUID()](/developers/mobile-sdk/method-reference/flutter/client-session#get-current-customer-uuid)  |

### Regenerate customer

This method regenerates the UUID and clears the authentication token, login session, custom email, and custom identifier. This operation works only if the customer is anonymous.

| OS           | Method                                                                                                                                                                                                                                                                                                                                                                       |
|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Android      | [Client.regenerateUuid()](/developers/mobile-sdk/method-reference/android/client-session#regenerate-customer) |
| iOS          | [Client.regenerateUUID()](/developers/mobile-sdk/method-reference/ios/client-session#regenerate-customer)               |
| React Native | [Synerise.Client.regenerateUUID()](/developers/mobile-sdk/method-reference/react-native/client-session#regenerate-customer)  |
| Flutter | [Synerise.client.regenerateUUID()](/developers/mobile-sdk/method-reference/flutter/client-session#regenerate-customer)  |


### Regenerate customer with identifier

This method regenerates the UUID and clears the authentication token, login session, custom email, and custom identifier. The optional clientIdentifier parameter is a seed for UUID generation.

| OS           | Method                                                                                                                                                                                                                                                                                                                                                                       |
|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Android      | [Client.regenerateUuid(clientIdentifier)](/developers/mobile-sdk/method-reference/android/client-session#regenerate-customer-with-identifier) |
| iOS          | [Client.regenerateUUID](/developers/mobile-sdk/method-reference/ios/client-session#regenerate-customer-with-identifier)               |
| React Native | [Synerise.Client.regenerateUUIDWithClientIdentifier()](/developers/mobile-sdk/method-reference/react-native/client-session#regenerate-customer-with-identifier)  |
| Flutter | n/a |

### Destroy customer session

This method clears all session data and creates a new anonymous session with a new profile UUID.

| OS           | Method                                                                                                                                                                                                                                                                                                                                                                       |
|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Android      | [Client.destroySession()](/developers/mobile-sdk/method-reference/android/client-session#destroy-current-session) |
| iOS          | [Client.destroySession()](/developers/mobile-sdk/method-reference/ios/client-session#destroy-current-session)               |
| React Native | [Synerise.Client.destroySession()](/developers/mobile-sdk/method-reference/react-native/client-session#destroy-current-session)  |
| Flutter | [Synerise.client.destroySession()](/developers/mobile-sdk/method-reference/flutter/client-session#destroy-current-session)  |


# Simple Profile Authentication



<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to handling identifiers](/docs/settings/configuration/identifier-standardization).

</div></div></div>


Simple Profile Authentication is an approach to authenticate customers once they provide their email address or custom ID. It allows for synchronization of data between Synerise and your database, ensuring consistency and an accurate profiling of customers. However, once you create a customer's profile using this authentication method, it cannot be deleted.  

When configuring Simple Profile Authentication, you can enable an authentication salt. It's a randomized string that your application must send with the authentication request. This provides an additional layer of security by reducing the risk of requests being made from outside the application. We strongly recommend using this option.

The implementation of this authentication method is straightforward, requiring the usage of a single method. Unlike other authentication standards, it does not involve intercommunication between your application's backend and Synerise's backend. Instead, customer data is transmitted through a device for validation and authorization.

Additionally, in the Synerise platform (`app.synerise.com`) you can define the following settings:
- [Assignment of loyalty card](/docs/settings/tool/iam-for-apps/general#loyalty-card-assignment)
- [JWT longevity](/docs/settings/tool/iam-for-apps/general#jwt-lifetime)

Simple Profile Authentication proves particularly useful in scenarios when:
- you have a large customer base
- you don't require [OAuth](/developers/mobile-sdk/user-identification-and-authorization/oauth), which in most cases is recommended


<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Currently this authentication is available only for: 
- Android (from `5.7.1` version)
- iOS (from `4.14.0` version)
- React Native (from `0.15.0` version)
- Flutter(from `0.7.0` version)

</div></div></div>


## Integration process
---

1. In the Synerise platform (`app.synerise.com`), go to **Settings > API keys** and create or update the Profile key. 
    1. In the **Permissions** section, enable the following permissions:
        - `SAUTH_SIMPLE_AUTH_CREATE` (the **Auth** group)
        - `API_PERSONAL_INFORMATION_CLIENT_READ`
        - `SAUTH_LOGOUT_CLIENT_CREATE`
    2. In the **Simple Profile Authentication** section:
        1. Enable the **Simple Profile Authentication** toggle.
        2. If you want to use a salt when authenticating, enable the **Authentication salt** toggle.  
        **Result**: A randomized salt is generated. It will need to be included in your mobile application (described further in this article).
        
           <div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

           We recommend enabling the salt. This improves the security of your requests by adding a layer of client/server authentication.

           </div></div></div>
  
            <figure><img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/developers/mobile-sdk/_gfx/simple-auth-salt.png" class="large" alt="Simple Profile Authentication with salt enabled (recommended)"><figcaption>Simple Profile Authentication with salt enabled (recommended)</figcaption></figure>
    3. In the **Profile modification allowlist** section, allow modification of the following profile attributes:
        - `UUID`
        - `email` or `customId` (choose the identifier you will use in [this method](#authentication-methods))
    
          <div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

          You can learn more about creating API keys in the Synerise platform [here](/docs/settings/tool/api).

          </div></div></div>

1. **If you enabled the Authentication salt**: Insert the salt into the initialization script.
    
   <div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

   It is your responsibility to ensure the secure storage of the salt in your application. We highly recommend keeping the salt encrypted.

   </div></div></div>

    You can find the Synerise initialization scripts in the articles below:
    - [Android](/developers/mobile-sdk/installation-and-configuration/android#initialization)
    - [iOS](/developers/mobile-sdk/installation-and-configuration/ios#initialization)
    - [React Native](/developers/mobile-sdk/installation-and-configuration/react-native#initialization)
    - [Flutter](/developers/mobile-sdk/installation-and-configuration/flutter#initialization)
2. As a sign-in method, implement [this method](#authentication-methods). In the customer's data object, `authId` (unique identifier of a customer in your data base), `email` or `customId` parameters are required. As a result of this method, the `client.simpleAuthLogin` event is generated on the activity list of a customer in the Synerise platform in **Behavioral Data Hub**.
    
   <details class="accordion"><summary>Click here to see the event body</summary><div class="accordion-content"><pre><code class="language-json">{ "action": "client.simpleAuthLogin", "eventUUID": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "unique": null, "createDate": 1689166104952, "label": "Simple Profile Auth client login", "params": { "ip": "xxx.xx.xxx.xx" } }</code></pre></div></details>

   A customer logged in with this method is assigned with a Simple Profile Authentication token (a JWT) whose [longevity you can define in the Synerise platform](/docs/settings/tool/iam-for-apps/general#jwt-lifetime).  
1. To check if a customer is signed in through Simple Profile Authentication, use [this method](#check-if-a-customer-is-signed-in).

<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

To check if a customer is signed in with other authentication types, use [this method](/developers/mobile-sdk/user-identification-and-authorization/synerise-authentication#check-if-a-customer-is-signed-in)

</div></div></div>



## Authentication use cases
---
| Use case                                             | Outcome                                                                                                                                                                                                                                                                                                           |
|------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| An anonymous customer signs in to a new account       | 1. Before signing in, a user is only assigned with UUID and clientId. <br> 2. When signed in, they receive authID, and email and custom ID are assigned. The customer can update their data.                                                                                                                      |
| An anonymous customer signs in to an existing account | 1. Before signing in, a user is only assigned with UUID and clientId. <br> 2. A customer signs in to their account on the interface with their credentials (authID) <br> 3. A customer is [merged](/developers/api/clients/merging-profiles). <br> 4. A customer is signed in and can update their data. |
| Signed-in customer signs in to a new account          | 1. A customer is already recognized. <br> 2. A customer provides new sign-in credentials and the customer is signed in to a new account (a new account is created). This customer receives authID, and email and custom ID are assigned. The customer can update their data.                                       |
| Signed-in customer signs in to an existing account    | 1. A customer is already recognized. <br> 2. A customer re-signs in to other existing account on the interface with credentials (authID). <br> 3. A customer is signs in and can update their data.                                                                                                               |

## Troubleshooting
---
- If the `authID` value is not unique, there is a risk of generating the same UUID for various customers which results in an error. This is because the UUID is generated based on the `authID` value
- An error may occur when `email` or `customId` is not unique and there is an attempt to update a customer with other's customer `email` or `customId`. 

## Best practices
---
- Check if a customer is signed in with [this method](#check-if-a-customer-is-signed-in).
- Use the [Simple Profile Authentication method](#authentication-methods) only for logging in and updating a customer's data.
- Provide a sign-out feature with [this method](#customer-sign-out).

## Authentication methods
---

This method authenticates a customer with Simple Profile Authentication.

| OS           | Method                                                                                                                                    |
|--------------|-------------------------------------------------------------------------------------------------------------------------------------------|
| Android      | [Client.simpleAuthentication(clientData, authId)](/developers/mobile-sdk/method-reference/android/client-authentication#authenticate-customer-via-simple-profile-authentication)                |
| iOS          | [Client.simpleAuthentication(data:authID:success:failure:)](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-via-simple-profile-authentication) |
| React Native | [Synerise.Client.simpleAuthentication(data, authID, onSuccess, onError)](/developers/mobile-sdk/method-reference/react-native/client-authentication#authenticate-customer-via-simple-profile-authentication) |
| Flutter | [Synerise.client.simpleAuthentication(clientData, authId)](/developers/mobile-sdk/method-reference/flutter/client-authentication#authenticate-customer-via-simple-profile-authentication) |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authId/authID** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>


## Other methods
---

### Check if a customer is signed in

This method checks if a customer is signed in through Simple Profile Authentication. 


<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This method returns `false` if a customer is authenticated through [RaaS](/developers/mobile-sdk/user-identification-and-authorization/synerise-authentication), [oAuth](/developers/mobile-sdk/user-identification-and-authorization/oauth), [Facebook or Apple](/developers/mobile-sdk/user-identification-and-authorization/authenticate-external-providers).

</div></div></div>


| OS           | Method                                                                                                                                    |
|--------------|-------------------------------------------------------------------------------------------------------------------------------------------|
| Android      | [Client.isSignedInViaSimpleAuthentication()](/developers/mobile-sdk/method-reference/android/client-authentication#check-if-a-customer-is-signed-in-via-simple-profile-authentication)                |
| iOS          | [Client.isSignedInViaSimpleAuthentication()](/developers/mobile-sdk/method-reference/ios/client-authentication#check-if-a-customer-is-signed-in-via-simple-profile-authentication) |
| React Native |  [Synerise.Client.isSignedInViaSimpleAuthentication()](/developers/mobile-sdk/method-reference/react-native/client-authentication#check-if-a-customer-is-signed-in-via-simple-profile-authentication) |
| Flutter | [Synerise.client.isSignedInViaSimpleAuthentication()](/developers/mobile-sdk/method-reference/flutter/client-authentication#check-if-a-customer-is-signed-in-via-simple-profile-authentication) |

### Customer sign out

This method signs out the customer. The method terminates the JWT token and ends the customer session.

| OS           | Method                                                                                                                |
|--------------|-----------------------------------------------------------------------------------------------------------------------|
| Android      | - [Client.signOut()](/developers/mobile-sdk/method-reference/android/client-authentication#sign-out-customer) <br/> -  [Client.signOut(mode, signOutFromAllDevices)](/developers/mobile-sdk/method-reference/android/client-authentication#sign-out-customer-with-mode-or-from-all-devices) |
| iOS          | - [Client.signOut()](/developers/mobile-sdk/method-reference/ios/client-authentication#sign-out-customer) <br/> - [Client.signOut(mode:fromAllDevices:success:failure:)](/developers/mobile-sdk/method-reference/ios/client-authentication#sign-out-customer-with-mode-or-from-all-devices) |
| React Native | - [Synerise.Client.signOut()](/developers/mobile-sdk/method-reference/react-native/client-authentication#sign-out-a-customer) <br/> - [Synerise.Client.signOutWithMode(mode, fromAllDevices, onSuccess, onError)](/developers/mobile-sdk/method-reference/react-native/client-authentication#sign-out-customer-with-mode-or-from-all-devices) |
| Flutter | [Synerise.client.signOut()](/developers/mobile-sdk/method-reference/flutter/client-authentication#sign-out-a-customer) |


## What's next
---
When the customer's is signed in, you can implement [profile management methods](/developers/mobile-sdk/user-identification-and-authorization/identification-and-user-management#profile-management-methods) and [session management methods](/developers/mobile-sdk/user-identification-and-authorization/session-management).



# iOS

## Configuring push notifications (iOS)

### Prerequisites
--- 
- Configure handling push notifications in your application. See [Apple Developer - Notifications](https://developer.apple.com/notifications/).

- Google Firebase Cloud Messaging is necessary to handle [Mobile Campaigns](/docs/campaign/Mobile) sent from Synerise.

  1. Follow the instructions in [Firebase - Get Started on iOS](https://firebase.google.com/docs/storage/ios/start).
  2. Integrate the Firebase with Synerise. See [Integration](/docs/settings/tool/firebase) section.

### Set up Firebase Cloud Messaging for Synerise SDK
---
Extend the Firebase Messaging Delegate so our SDK can receive the Firebase token that is required to deliver push notifications from Synerise:

<div class="content-tabs code-tabs" data-tab-group="tabgrp-537">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-537-0" data-tab-group="tabgrp-537" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-537-1" data-tab-group="tabgrp-537">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-537-0" data-tab-group="tabgrp-537" data-tab-active="true">

```Swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    FirebaseApp.configure()
       Messaging.messaging().delegate = self

    if #available(iOS 10, *) {
      UNUserNotificationCenter.current().requestAuthorization(options: [.alert, .badge, .sound]) { (granted, error) in
      if granted {
        DispatchQueue.main.async {
          UIApplication.shared.registerForRemoteNotifications()
        }

        guard let fcmToken = Messaging.messaging().fcmToken else {
          return
        }

        let mobilePushAgreement = true // true or false, should depend on device permissions and customer's agreement in the application

        Client.registerForPush(registrationToken:fcmToken, mobilePushAgreement:mobilePushAgreement, success: { (success) in
          // success
        }) { (error) in
          // failure
        }
      }
    } else {
      let settings = UIUserNotificationSettings(types: [.alert, .badge, .sound], categories: nil)
      application.registerUserNotificationSettings(settings)
    }
  }

  // MARK: - MessagingDelegate

  func messaging(_ messaging: Messaging, didReceiveRegistrationToken fcmToken: String) {
    if let registrationToken = fcmToken {
      let mobilePushAgreement = true // true or false, should depend on device permissions and customer's agreement in the application

      Client.registerForPush(registrationToken:registrationToken, mobilePushAgreement:mobilePushAgreement, success: { (success) in
        // success
      }) { (error) in
        // failure
      }
    }
  }
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-537-1" data-tab-group="tabgrp-537">

```Objective-C
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  [FIRApp configure];
  [FIRMessaging messaging].delegate = self;

  if (@available(iOS 10, *)) {
    [UNUserNotificationCenter currentNotificationCenter].delegate = self;
    UNAuthorizationOptions authOptions = (UNAuthorizationOptionAlert | UNAuthorizationOptionSound | UNAuthorizationOptionBadge);
    [[UNUserNotificationCenter currentNotificationCenter] requestAuthorizationWithOptions:authOptions completionHandler:^(BOOL granted, NSError *error) {
      if (granted == YES) {
        [[UIApplication sharedApplication] registerForRemoteNotifications];
      }

      NSString *fcmToken = [FIRMessaging messaging].FCMToken;
      if (fcmToken == nil) {
        return;
      }

      BOOL mobilePushAgreement = YES; // YES or NO, should depend on device permissions and customer's agreement in the application

      [SNRClient registerForPush:fcmToken mobilePushAgreement:mobilePushAgreement success:^(BOOL isSuccess) {
        // success
      } failure:^(NSError *error) {
        // failure
      }];
    }];
} else {
  UIUserNotificationType allNotificationTypes = (UIUserNotificationTypeSound | UIUserNotificationTypeAlert | UIUserNotificationTypeBadge);
  UIUserNotificationSettings *settings = [UIUserNotificationSettings settingsForTypes:allNotificationTypes categories:nil];

  [[UIApplication sharedApplication] registerUserNotificationSettings:settings];
}

#pragma mark - FIRMessagingDelegate

- (void)messaging:(FIRMessaging *)messaging didReceiveRegistrationToken:(NSString *)fcmToken {
  if (fcmToken != nil) {
    BOOL mobilePushAgreement = YES; // YES or NO, should depend on device permissions and customer's agreement in the application

    [SNRClient registerForPush:fcmToken mobilePushAgreement:mobilePushAgreement success:^(BOOL isSuccess) {
      // success
    } failure:^(NSError *error) {
      // failure
    }];
  }
}
```

</div>
</div>



<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The second parameter of the registration method is the agreement for mobile push campaigns. In the Profile's card in Synerise, you can find it in the **Subscriptions** section (if you have the required access permission). Learn more about the [Client.registerForPush(registrationToken:mobilePushAgreement:success:failure:) method in the method reference](/developers/mobile-sdk/method-reference/ios/campaigns#register-for-push-notifications).

</div></div></div>


### Keep Firebase token always up-to-date
---
You must always keep the Firebase token updated. In many cases in the application lifecycle, such as authorization, destroyed sessions, user context change, periodic jobs ([Background Tasks](/developers/mobile-sdk/installation-and-configuration/ios#background-tasks)), and so on, the registration needs to be updated. In these situations, the SDK invokes the [snr_registerForPushNotificationsIsNeeded(origin:)](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#synerise-delegate-register-for-push-notifications-is-needed-by-origin) method or [snr_registerForPushNotificationsIsNeeded()](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#synerise-delegate-register-for-push-notifications-is-needed) method.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

[Background Tasks](/developers/mobile-sdk/installation-and-configuration/ios#background-tasks)) allows you to keep the Firebase token updated even if the host application is not launched for a long time. It launches your app in the background approximately every 20 days and refreshes the token so it stays up to date.

</div></div></div>



<div class="content-tabs code-tabs" data-tab-group="tabgrp-538">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-538-0" data-tab-group="tabgrp-538" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-538-1" data-tab-group="tabgrp-538">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-538-0" data-tab-group="tabgrp-538" data-tab-active="true">

```Swift
// MARK: - SyneriseDelegate

func snr_registerForPushNotificationsIsNeeded(origin: PushNotificationsRegistrationOrigin) -> Void {
  guard let fcmToken = Messaging.messaging().fcmToken else {
    return
  }

  let mobilePushAgreement = true // true or false, depending to customer's agreement in the application

  Client.registerForPush(registrationToken:fcmToken, mobilePushAgreement:mobilePushAgreement, success: { (success) in
    // success
  }) { (error) in
    // failure
  }
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-538-1" data-tab-group="tabgrp-538">

```Objective-C
#pragma mark - SNRSyneriseDelegate

- (void)SNR_registerForPushNotificationsIsNeededByOrigin:(SNRPushNotificationsRegistrationOrigin)origin {
  NSString *fcmToken = [FIRMessaging messaging].FCMToken;

  if (fcmToken == nil) {
    return;
  }

  BOOL mobilePushAgreement = YES; // YES or NO, depending to customer's agreement in the application

  [SNRClient registerForPush:fcmToken mobilePushAgreement:mobilePushAgreement success:^(BOOL isSuccess) {
    // success
  } failure:^(NSError *error) {
    // failure
  }];
}
```

</div>
</div>



### Configure Notification Encryption
---
To enable encrypted push notifications, you must change the configuration of your workspace in the Synerise portal. See [Google Firebase](/docs/settings/tool/firebase).


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

iOS 10 or higher version is required for this feature.

</div></div></div>


Set your Keychain Group Identifier (see [this section](/developers/mobile-sdk/settings#set-up-keychain-group-identifier)) and enable `Synerise.settings.notifications.encryption` in SDK settings:


<div class="content-tabs code-tabs" data-tab-group="tabgrp-539">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-539-0" data-tab-group="tabgrp-539" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-539-1" data-tab-group="tabgrp-539">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-539-0" data-tab-group="tabgrp-539" data-tab-active="true">

```Swift
Synerise.settings.sdk.keychainGroupIdentifier = "YOUR_KEYCHAIN_GROUP_IDENTIFIER"
Synerise.settings.notifications.encryption = true
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-539-1" data-tab-group="tabgrp-539">

```Objective-C
SNRSynerise.settings.sdk.keychainGroupIdentifier = @"YOUR_KEYCHAIN_GROUP_IDENTIFIER";
SNRSynerise.settings.notifications.encryption = YES;
```

</div>
</div>


**Next:** Configure [Synerise Notification Service Extension](/developers/mobile-sdk/configuring-push-notifications/ios#synerise-notification-service-extension).

### Synerise Notification Service Extension {id=synerise-notification-service-extension}
---
**Synerise Notification Service Extension** is an object that adds the notification functionality to the SDK. It works by implementing the [`UNNotificationServiceExtension`](https://developer.apple.com/documentation/usernotifications/unnotificationserviceextension) that cooperates with the host application.

The Synerise Notification Service Extension facilitates some operations by automating them. This means a one-time implementation provides new functionalities, changes, and fixes, along with new versions of the SDK.

It implements the following operations:
- Decrypting **Simple Push** communication data (if encryption is enabled).
- Tracking events from **Simple Push** communication (e.g. `push.view`).
- Tracking `push.dismiss` when the notification is cleared from the notification center.
- Adding action buttons to **Simple Push** communication (if the communication contains any).
- Improving the appearance of **Simple Push** communication (Rich Media - Single Image) with an image thumbnail.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

From version 4.24.0, the SDK started tracking `push.dismiss` events when clearing from the notification center. You can enable tracking this event by setting **kSNRNotificationServiceExtensionOptionsPushDismissProcessing** to true ([see implementation below](/developers/mobile-sdk/configuring-push-notifications/ios#synerise-notification-service-extension-implementation)). If you enable this option, it can cause a noticeable amount of generated events.

</div></div></div>


#### Configuration {id=synerise-notification-service-extension-configuration}

1. Configure **App Group Identifier** (see [this section](/developers/mobile-sdk/settings#set-up-app-group-identifier)).
2. Configure **Keychain Group Identifier** (see [this section](/developers/mobile-sdk/settings#set-up-keychain-group-identifier)).
3. Add the **Notification Service Extension** to your iOS project ([Apple Developer - UNNotificationServiceExtension](https://developer.apple.com/documentation/usernotifications/unnotificationserviceextension)).
4. Configure the SDK both in the host application and in the notification service extension.


<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

- Configuring **App Group Identifier** and **Keychain Group Identifier** both in the host application and in the notification service extension is required for proper functioning of all **Notification Service Extension** features.
- Your host application and the **Notification Service Extension** must have the same **iOS Deployment Target** version (newer than iOS 10).
- If you want to enable processing the campaign by **Notification Service Extension**, select the [Mutable-Content](/developers/mobile-sdk/configuring-push-notifications/ios#mutable-content-parameter) option.

</div></div></div>


#### Implementation {id=synerise-notification-service-extension-implementation}


<div class="content-tabs code-tabs" data-tab-group="tabgrp-540">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-540-0" data-tab-group="tabgrp-540" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-540-1" data-tab-group="tabgrp-540">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-540-0" data-tab-group="tabgrp-540" data-tab-active="true">

```Swift
import UserNotifications
import SyneriseSDK

class NotificationService: UNNotificationServiceExtension {

  var contentHandler: ((UNNotificationContent) -> Void)?
  var bestAttemptContent: UNMutableNotificationContent?

  override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
    self.contentHandler = contentHandler
    self.bestAttemptContent = (request.content.mutableCopy() as? UNMutableNotificationContent)
    
    if let bestAttemptContent = self.bestAttemptContent {
        Synerise.settings.sdk.appGroupIdentifier = "YOUR_APP_GROUP_IDENTIFIER"
        Synerise.settings.sdk.keychainGroupIdentifier = "YOUR_KEYCHAIN_GROUP_IDENTIFIER"
        
        NotificationServiceExtension.setDelegate(self)
        NotificationServiceExtension.setNotificationDelegate(self)

        #if DEBUG
        NotificationServiceExtension.setDebugModeEnabled(true)
        #endif
        
        NotificationServiceExtension.setDecryptionFallbackNotificationTitleAndBody(title: "(Encrypted))", body: "(Encrypted)")
        NotificationServiceExtension.didReceiveNotificationExtensionRequest(request, withMutableNotificationContent: bestAttemptContent, options: [
          kSNRNotificationServiceExtensionOptionsPushDismissProcessing: true
        ])
        
        contentHandler(bestAttemptContent)
    }
  }

  override func serviceExtensionTimeWillExpire() {
    // Called just before the extension will be terminated by the system.
    // Use this as an opportunity to deliver your "best attempt" at modified content, otherwise the original push payload will be used.
    
    if let contentHandler = self.contentHandler, let bestAttemptContent =  self.bestAttemptContent {
        contentHandler(bestAttemptContent)
    }
  }
}

extension NotificationService: NotificationServiceExtensionDelegate {
  
  func notificationServiceExtensionDidFailProcessingWithError(_ error: Error) {
#if DEBUG
        self.bestAttemptContent?.title = error.localizedDescription
#endif
  }
    
  func notificationServiceExtensionDidFailDecryptionWithError(_ error: Error) {
#if DEBUG
    self.bestAttemptContent?.title = error.localizedDescription
#endif
  }
}

extension NotificationService: NotificationDelegate {
    // This method is called when a Synerise notification is received.
    func snr_notificationDidReceive(notificationInfo: NotificationInfo) {
        //...
    }
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-540-1" data-tab-group="tabgrp-540">

```Objective-C
#import "NotificationService.h"
#import <UserNotifications/UserNotifications.h>
#import <SyneriseSDK/SyneriseSDK.h>

@interface NotificationService () <SNRNotificationServiceExtensionDelegate, SNRNotificationDelegate>

@property (nonatomic, strong) void (^contentHandler)(UNNotificationContent *contentToDeliver);
@property (nonatomic, strong) UNMutableNotificationContent *bestAttemptContent;

@end

@implementation NotificationService

- (void)didReceiveNotificationRequest:(UNNotificationRequest *)request withContentHandler:(void (^)(UNNotificationContent * _Nonnull))contentHandler {
    self.contentHandler = contentHandler;
    self.bestAttemptContent = [request.content mutableCopy];
    
    SNRSynerise.settings.sdk.appGroupIdentifier = @"YOUR_APP_GROUP_IDENTIFIER";
    SNRSynerise.settings.sdk.keychainGroupIdentifier = @"YOUR_KEYCHAIN_GROUP_IDENTIFIER";
    
    [SNRNotificationServiceExtension setDelegate:self];
    [SNRNotificationServiceExtension setNotificationDelegate:self];

#ifdef DEBUG
    [SNRNotificationServiceExtension setDebugModeEnabled:YES];
#endif
    
    [SNRNotificationServiceExtension setDecryptionFallbackNotificationTitle:@"(Encrypted)" andBody:@"(Encrypted)"];
    [SNRNotificationServiceExtension didReceiveNotificationExtensionRequest:request withMutableNotificationContent:self.bestAttemptContent options:@{
        kSNRNotificationServiceExtensionOptionsPushDismissProcessing: @(YES) // if true, tracking `push.dismiss` by clearing from the notification center is enabled
    }];
    
    self.contentHandler(self.bestAttemptContent);
}

- (void)serviceExtensionTimeWillExpire {
    // Called just before the extension will be terminated by the system.
    // Use this as an opportunity to deliver your "best attempt" at modified content, otherwise the original push payload will be used.

    self.contentHandler(self.bestAttemptContent);
}

#pragma mark - SNRNotificationServiceExtensionDelegate

- (void)notificationServiceExtensionDidFailProcessingWithError:(NSError *)error {
#ifdef DEBUG
    self.bestAttemptContent.body = error.localizedDescription;
#endif
}

- (void)notificationServiceExtensionDidFailDecryptionWithError:(NSError *)error {
#ifdef DEBUG
    self.bestAttemptContent.body = error.localizedDescription;
#endif
}

#pragma mark - SNRNotificationDelegate

// This method is called when a Synerise notification is received.
- (void)SNR_notificationDidReceive:(SNRNotificationInfo *)notificationInfo {
    //...
}

@end
```

</div>
</div>


Examples of Notification Service Extensions:
  - [Notification Service Extension in Swift](https://github.com/Synerise/synerise-ios-sdk/tree/master/SampleAppSwift/4.10.0/SyneriseNotificationServiceExtension)
  - [Notification Service Extension in Objective-C](https://github.com/Synerise/synerise-ios-sdk/tree/master/SampleAppSwift/4.10.0/SyneriseNotificationServiceExtensionObjC)


#### Debug Mode {id=synerise-notification-service-extension-debug-mode}

You can enable the debug mode for Notification Service Extension logging and testing purposes.


<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Do not use the debug mode in a release version of your application.

</div></div></div>



<div class="content-tabs code-tabs" data-tab-group="tabgrp-541">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-541-0" data-tab-group="tabgrp-541" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-541-1" data-tab-group="tabgrp-541">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-541-0" data-tab-group="tabgrp-541" data-tab-active="true">

```Swift
override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
  self.contentHandler = contentHandler
  self.bestAttemptContent = (request.content.mutableCopy() as? UNMutableNotificationContent)

  //...
  NotificationServiceExtension.setDebugModeEnabled(true)
  //...
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-541-1" data-tab-group="tabgrp-541">

```Objective-C
- (void)didReceiveNotificationRequest:(UNNotificationRequest *)request withContentHandler:(void (^)(UNNotificationContent * _Nonnull))contentHandler {
  self.contentHandler = contentHandler;
  self.bestAttemptContent = [request.content mutableCopy];

  //...
  [SNRNotificationServiceExtension setDebugModeEnabled:YES];
  //...
}
```

</div>
</div>



<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

In the debug mode, decryption process is considered successful even if it fails. Your best attempt content (`UNNotificationContent` object) is modified - the notification displays the title and body with the problem that occurred during decryption. It may help you debug and find problems with the configuration.

</div></div></div>


### Handling incoming push notifications
---


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

You may disable handling push notifications in the SDK at any time. See [Enable/disable notifications](/developers/mobile-sdk/settings#enabledisable-notifications).

</div></div></div>


Documentation on how to prepare push notifications in [app.synerise.com](https://app.synerise.com) is available in our [user guide](/docs/campaign/Mobile).

In order to handle Synerise push notifications, you must pass the incoming push payload to the Synerise SDK.

#### Synerise payload

The following code shows how to handle push notifications in the `AppDelegate`:


<div class="content-tabs code-tabs" data-tab-group="tabgrp-542">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-542-0" data-tab-group="tabgrp-542" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-542-1" data-tab-group="tabgrp-542">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-542-0" data-tab-group="tabgrp-542" data-tab-active="true">

```Swift
// Support for Push Notifications on iOS 9
// Support for Silent Notifications

func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable : Any], fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) {
  let isSyneriseNotification: Bool = Synerise.isSyneriseNotification(userInfo)
  
  if isSyneriseNotification {
    Synerise.handleNotification(userInfo)
    completionHandler(.noData)
  }
}

func application(_ application: UIApplication, handleActionWithIdentifier identifier: String?, forRemoteNotification userInfo: [AnyHashable : Any], completionHandler: @escaping () -> Void) {
  let isSyneriseNotification: Bool = Synerise.isSyneriseNotification(userInfo)
  
  if isSyneriseNotification {
    Synerise.handleNotification(userInfo, actionIdentifier: identifier)
    completionHandler()
  }
}

// Support for Push Notifications on iOS 10 and above

// MARK: - UNUserNotificationCenterDelegate

@available(iOS 10.0, *)
func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void) {
  let userInfo = response.notification.request.content.userInfo
  
  let isSyneriseNotification: Bool = Synerise.isSyneriseNotification(userInfo)
  
  if isSyneriseNotification {
    Synerise.handleNotification(userInfo, actionIdentifier: response.actionIdentifier)
    completionHandler()
  }
}

@available(iOS 10.0, *)
func userNotificationCenter(_ center: UNUserNotificationCenter, willPresent notification: UNNotification, withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void) {
  let userInfo = notification.request.content.userInfo

  let isSyneriseNotification: Bool = Synerise.isSyneriseNotification(userInfo)
  
  if isSyneriseNotification {
    Synerise.handleNotification(userInfo)
    completionHandler(UNNotificationPresentationOptions.init(rawValue: 0))
  }
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-542-1" data-tab-group="tabgrp-542">

```Objective-C
// Support for Push Notifications on iOS 9
// Support for Silent Notifications

- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler {
  BOOL isSyneriseNotification = [SNRSynerise isSyneriseNotification:userInfo];
  
  if (isSyneriseNotification) {
    [SNRSynerise handleNotification:userInfo];
    completionHandler(UIBackgroundFetchResultNoData);
  }
}

- (void)application:(UIApplication *)application handleActionWithIdentifier:(nullable NSString *)identifier forRemoteNotification:(NSDictionary *)userInfo completionHandler:(void(^)())completionHandler {
  BOOL isSyneriseNotification = [SNRSynerise isSyneriseNotification:userInfo];
  
  if (isSyneriseNotification) {
    [SNRSynerise handleNotification:userInfo actionIdentifier:identifier];
    completionHandler();
  }
}

// Support for Push Notifications on iOS 10 and above

// pragma mark - UNUserNotificationCenterDelegate

- (void)userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void (^)(void))completionHandler NS_AVAILABLE_IOS(10) {
  NSDictionary *userInfo = response.notification.request.content.userInfo;

  BOOL isSyneriseNotification = [SNRSynerise isSyneriseNotification:userInfo];
  
  if (isSyneriseNotification) {
    [SNRSynerise handleNotification:userInfo actionIdentifier:response.actionIdentifier];
    completionHandler();
  }
}

- (void)userNotificationCenter:(UNUserNotificationCenter *)center willPresentNotification:(UNNotification *)notification withCompletionHandler:(void (^)(UNNotificationPresentationOptions))completionHandler NS_AVAILABLE_IOS(10) {
  NSDictionary *userInfo = notification.request.content.userInfo;

  BOOL isSyneriseNotification = [SNRSynerise isSyneriseNotification:userInfo];
  if (isSyneriseNotification) {
    [SNRSynerise handleNotification:userInfo];
    completionHandler(UNNotificationPresentationOptionNone);
  }
}
```

</div>
</div>



<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All of these methods must be implemented to ensure proper handling of push notifications.

</div></div></div>



<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Displaying the notification banner on top of the screen in foreground state depends on values passed in `completionHandler` in the [UNUserNotificationCenterDelegate.userNotificationCenter(_:willPresent:completionHandler:)](https://developer.apple.com/documentation/usernotifications/unusernotificationcenterdelegate/1649518-usernotificationcenter) method.

</div></div></div>


#### Custom payload

You may send both custom push notifications and custom campaigns in [Synerise](https://app.synerise.com). The code below of one sample delegate method checks if the notification origin and then handles it.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-543">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-543-0" data-tab-group="tabgrp-543" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-543-1" data-tab-group="tabgrp-543">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-543-0" data-tab-group="tabgrp-543" data-tab-active="true">

```Swift
@available(iOS 10.0, *)
func userNotificationCenter(_ center: UNUserNotificationCenter, willPresent notification: UNNotification, withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void) {
  let userInfo = notification.request.content.userInfo

  let isSyneriseNotification: Bool = Synerise.isSyneriseNotification(userInfo)

  if isSyneriseNotification {
    Synerise.handleNotification(userInfo)
    completionHandler(UNNotificationPresentationOptions.init(rawValue: 0))
  } else {
    // Handle other notification in your own way
  }
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-543-1" data-tab-group="tabgrp-543">

```Objective-C
- (void)userNotificationCenter:(UNUserNotificationCenter *)center willPresentNotification:(UNNotification *)notification withCompletionHandler:(void (^)(UNNotificationPresentationOptions))completionHandler NS_AVAILABLE_IOS(10) {
  NSDictionary *userInfo = notification.request.content.userInfo;

  BOOL isSyneriseNotification = [SNRSynerise isSyneriseNotification:userInfo];
  if (isSyneriseNotification) {
    [SNRSynerise handleNotification:userInfo];
    completionHandler(UNNotificationPresentationOptionNone);
  } else {
    // Handle other notification in your own way
  }
}
```

</div>
</div>


#### Encrypted payloads

If you handle the Synerise push notification, you do not have to do anything. The SDK decrypts Synerise push notification's payload:
- In [Notification Service Extension](#synerise-notification-service-extension) for push notifications
- In the SDK, after invoking [`Synerise.handleNotification(_:)`](/developers/mobile-sdk/method-reference/ios/campaigns#handle-synerise-push-notification) for silent push notifications 

Otherwise, if it is a custom encrypted push notification sent by Synerise, or you need decrypt data from the push notification, there are two methods for dealing with them:
- [`Synerise.isNotificationEncrypted(_:)`](/developers/mobile-sdk/method-reference/ios/campaigns#check-if-push-notification-is-encrypted) - checks if the notification payload is encrypted by Synerise.
- [`Synerise.decryptNotification(_:)`](/developers/mobile-sdk/method-reference/ios/campaigns#decrypt-push-notification) - decrypts a notification payload.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-544">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-544-0" data-tab-group="tabgrp-544" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-544-1" data-tab-group="tabgrp-544">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-544-0" data-tab-group="tabgrp-544" data-tab-active="true">

```Swift
@available(iOS 10.0, *)
func userNotificationCenter(_ center: UNUserNotificationCenter, willPresent notification: UNNotification, withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void) {
  let userInfo = notification.request.content.userInfo

  let isSyneriseNotification: Bool = Synerise.isSyneriseNotification(userInfo)

  if isSyneriseNotification {
    let isNotificationEncrypted: Bool = Synerise.isNotificationEncrypted(userInfo)
    if isNotificationEncrypted == true {
        if let userInfoDecrypted = Synerise.decryptNotification(userInfo) {
            // Handle decrypted payload in your own way
        }

    Synerise.handleNotification(userInfo)
    completionHandler(UNNotificationPresentationOptions.init(rawValue: 0))
  }
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-544-1" data-tab-group="tabgrp-544">

```Objective-C
- (void)userNotificationCenter:(UNUserNotificationCenter *)center willPresentNotification:(UNNotification *)notification withCompletionHandler:(void (^)(UNNotificationPresentationOptions))completionHandler NS_AVAILABLE_IOS(10) {
  NSDictionary *userInfo = notification.request.content.userInfo;

  BOOL isSyneriseNotification = [SNRSynerise isSyneriseNotification:userInfo];
  if (isSyneriseNotification) {
      BOOL isNotificationEncrypted = [SNRSynerise isNotificationEncrypted:userInfo];
      if (isNotificationEncrypted == YES) {
        NSDictionary *userInfoDecrypted = [SNRSynerise decryptNotification:userInfo];
        if (userInfoDecrypted != nil) {
            // Handle decrypted payload in your own way
        }

    [SNRSynerise handleNotification:userInfo];
    completionHandler(UNNotificationPresentationOptionNone);
  }
}
```

</div>
</div>


Remember, if you want to send custom push notifications by Synerise (and it is not a silent push notification), you must implement the code in your [Notification Service Extension](/developers/mobile-sdk/configuring-push-notifications/ios#synerise-notification-service-extension):

<div class="content-tabs code-tabs" data-tab-group="tabgrp-545">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-545-0" data-tab-group="tabgrp-545" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-545-1" data-tab-group="tabgrp-545">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-545-0" data-tab-group="tabgrp-545" data-tab-active="true">

```Swift
import UserNotifications
import SyneriseSDK

class NotificationService: UNNotificationServiceExtension {

  var contentHandler: ((UNNotificationContent) -> Void)?
  var bestAttemptContent: UNMutableNotificationContent?

  override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
    self.contentHandler = contentHandler
    self.bestAttemptContent = (request.content.mutableCopy() as? UNMutableNotificationContent)
    
    if let bestAttemptContent = self.bestAttemptContent {
      var userInfo = notification.request.content.userInfo
      let isSyneriseNotification: Bool = Synerise.isSyneriseNotification(userInfo)

      if isSyneriseNotification == true {
        //...
      } else {
        let isNotificationEncrypted: Bool = Synerise.isNotificationEncrypted(userInfo)
        if isNotificationEncrypted == true {
          if let userInfoDecrypted = Synerise.decryptNotification(userInfo) {
            bestAttemptContent.title = userInfoDecrypted["aps"]?["alert"]?["title"]
            bestAttemptContent.body = userInfoDecrypted["aps"]?["alert"]?["body"]
            bestAttemptContent.userInfo = userInfoDecrypted;
          } else {
            bestAttemptContent.title = "YOUR_FALLBACK_TITLE"
            bestAttemptContent.body = "YOUR_FALLBACK_BODY"
          }
        }
      }

      contentHandler(bestAttemptContent)
    }
  }
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-545-1" data-tab-group="tabgrp-545">

```Objective-C
#import "NotificationService.h"
#import <UserNotifications/UserNotifications.h>
#import <SyneriseSDK/SyneriseSDK.h>
  
@interface NotificationService ()

@property (nonatomic, strong) void (^contentHandler)(UNNotificationContent *contentToDeliver);
@property (nonatomic, strong) UNMutableNotificationContent *bestAttemptContent;

@end

@implementation NotificationService

- (void)didReceiveNotificationRequest:(UNNotificationRequest *)request withContentHandler:(void (^)(UNNotificationContent * _Nonnull))contentHandler {
    self.contentHandler = contentHandler;
    self.bestAttemptContent = [request.content mutableCopy];
    
    NSDictionary *userInfo = notification.request.content.userInfo;

    BOOL isSyneriseNotification = [SNRSynerise isSyneriseNotification:userInfo];
    if (isSyneriseNotification == YES) {
      //...
    } else {
      BOOL isNotificationEncrypted = [SNRSynerise isNotificationEncrypted:userInfo];
      if (isNotificationEncrypted == YES) {
        NSDictionary *userInfoDecrypted = [SNRSynerise decryptNotification:userInfo];
        if (userInfoDecrypted != nil) {
          bestAttemptContent.title = userInfoDecrypted[@"aps"][@"alert"][@"title"];
          bestAttemptContent.body = userInfoDecrypted[@"aps"][@"alert"][@"body"];
          bestAttemptContent.userInfo = userInfoDecrypted;
        } else {
          bestAttemptContent.title = "YOUR_FALLBACK_TITLE"
          bestAttemptContent.body = "YOUR_FALLBACK_BODY"
        }
      }
    }

    self.contentHandler(self.bestAttemptContent);
}

@end
```

</div>
</div>


#### 'Content-Available' parameter

If you want to receive push notification in the background and foreground states, enable the `Content-Available` option while creating a push notification in Synerise ([Creating mobile push templates](/docs/campaign/Mobile/creating-mobile-push-templates/mobile-push-visual-builder)).

<figure>
  <img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/developers/mobile-sdk/_gfx/visual-builder-content-available-option.png" alt="`Content-Available` option in visual builder" class="full">
  <figcaption>Enabled `Content-Available` option in a visual builder</figcaption>
</figure>

When you want support this option, you must add the capability to your application. In the **Signing and Capability** tab, in the **Background Modes** capability, select the **Remote notifications** checkbox:

<figure>
  <img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/developers/mobile-sdk/_gfx/xcode-remote-notifications-capability.png" alt="Remote notifications capability in the Xcode" class="full">
  <figcaption>Remote notifications capability in the Xcode</figcaption>
</figure>

Your application will be notified of the notification delivery when it's in the foreground or background (the app will be woken up). This ensures that the necessary method and code responsible for receiving background notifications are executed. On iOS, it calls your app delegate’s [application(_:didReceiveRemoteNotification:fetchCompletionHandler:)](https://developer.apple.com/documentation/uikit/uiapplicationdelegate/1623013-application) method. On watchOS, it calls your extension delegate’s [didReceiveRemoteNotification(_:fetchCompletionHandler:)](https://developer.apple.com/documentation/watchkit/wkextensiondelegate/3152235-didreceiveremotenotification) method.

For more details, see [Apple Developer - Pushing Background Updates to Your App](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/pushing_background_updates_to_your_app).

#### 'Mutable-Content' parameter

If you want your notification to be processed by the Notification Service Extension, enable the `Mutable-Content` option while creating a push notification in Synerise ([Creating mobile push templates](/docs/campaign/Mobile/creating-mobile-push-templates/mobile-push-visual-builder)).

<figure>
<img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/developers/mobile-sdk/_gfx/visual-builder-mutable-content-option.png" alt="`Mutable-Content` option in visual builder" class="full">
<figcaption> Enabled `Mutable-Content` option in a visual builder</figcaption>
</figure>

If you want to have full support for **Simple Push** communication, and to make `Mutable-Content` relevant and functional, you must configure [Synerise Notification Service Extension](/developers/mobile-sdk/configuring-push-notifications/ios#synerise-notification-service-extension). This extension is required to fully support Simple Push communication for iOS, such as gathering the view events.

For more details, see [Apple Developer - Modifying content in newly delivered notifications](https://developer.apple.com/documentation/usernotifications/modifying-content-in-newly-delivered-notifications).

#### Delegate methods


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

[NotificationDelegate](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#notification-delegate) is available from SDK version 4.10.0.

</div></div></div>


A [NotificationDelegate](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#notification-delegate) handles events from Synerise notifications.

- To handle "receive" events when an application is disabled or in background state: set the delegate in the notification service extension by using the `NotificationServiceExtension.setNotificationDelegate(_:)` method. See [this section](/developers/mobile-sdk/configuring-push-notifications/ios#synerise-notification-service-extension-implementation) to get a sample code for the notification service extension.
- **SDK version 4.14.3 or newer:** To handle "receive" events when an application is launched by the notification or in foreground state: set the delegate in the application by using the `Synerise.setNotificationDelegate(_:)` method.
- To handle "dismiss" and "click" events: set the delegate in the application by using the `Synerise.setNotificationDelegate(_:)` method.

See a sample code from the application below:

<div class="content-tabs code-tabs" data-tab-group="tabgrp-546">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-546-0" data-tab-group="tabgrp-546" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-546-1" data-tab-group="tabgrp-546">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-546-0" data-tab-group="tabgrp-546" data-tab-active="true">

```Swift
extension SyneriseManager: NotificationDelegate {
    // This method is called when a Synerise notification is received.
    func snr_notificationDidReceive(notificationInfo: NotificationInfo) {
        //...
    }

    // This method is called when a Synerise notification is dismissed.
    func snr_notificationDidDissmis(notificationInfo: NotificationInfo) {
        //...
    }
    
    // This method is called when a Synerise notification is clicked.
    func snr_notificationClicked(notificationInfo: NotificationInfo) {
        //...
    }
    
    // This method is called when an action button is clicked in a Synerise notification.
    func snr_notificationClicked(notificationInfo: NotificationInfo, actionButton: String) {
        //...
    }
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-546-1" data-tab-group="tabgrp-546">

```Objective-C
#pragma mark - SNRNotificationDelegate

// This method is called when a Synerise notification is received.
- (void)SNR_notificationDidReceive:(SNRNotificationInfo *)notificationInfo {
    //...
}

// This method is called when a Synerise notification is dismissed.
- (void)SNR_notificationDidDissmis:(SNRNotificationInfo *)notificationInfo {
    //...
}

// This method is called when a Synerise notification is clicked.
- (void)SNR_notificationClicked:(SNRNotificationInfo *)notificationInfo {
    //...
}

// This method is called when an action button is clicked in a Synerise notification.
- (void)SNR_notificationActionButtonClicked:(SNRNotificationInfo *)notificationInfo actionButton:(NSString *)actionButton {
    //...
}
```

</div>
</div>



### Handling actions from push notifications
---
- [Read more about types of actions in campaigns](/developers/mobile-sdk/campaigns/action-handling#types-of-actions-in-campaigns)  
- [Read more about handling actions from push notifications](/developers/mobile-sdk/campaigns/action-handling#handling-actions-from-campaigns-in-ios)  

### Additional in-app alert from push notifications
---
The iOS SDK can display an additional alert in the application after a push notification is received. See [this article](/developers/mobile-sdk/campaigns/simple-push#additional-in-app-alert-when-simple-push-is-received) to read more about this feature.

<figure><img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/developers/mobile-sdk/_gfx/ios-simple-push-in-app-alert.png" alt="Simple Push campaign with in-app alert" class="small"><figcaption>Simple Push campaign with in-app alert</figcaption></figure>

### Rich Media in push notifications
--- 

**Notification Content Extension** is an object that allows rendering your own appearance of a push notification when the notification is expanded (by tapping the notification). It works by implementing the UNNotificationContentExtension that cooperates with the host application.

Synerise SDK does most of the work needed and provides classes for the Notification Content Extensions. When you create an extension, you only need to make it inherit from a suitable Synerise SDK class.

#### Prerequisites {id=rich-media-in-push-notifications-prerequisites}
1. Configure **App Group Identifier** (see [this section](/developers/mobile-sdk/settings#set-up-app-group-identifier)).
2. Configure **Keychain Group Identifier** (see [this section](/developers/mobile-sdk/settings#set-up-keychain-group-identifier)).

#### Configuration {id=rich-media-in-push-notifications-configuration}

To add this feature in your [Simple Push Campaigns](/developers/mobile-sdk/campaigns/simple-push), you must:  
1. Add the **Notification Content Extensions** in your iOS project - separately for each type of our Rich Media extensions.
2. Configure the host application and the notification content extensions with the SDK.


<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

- Configuring **App Group Identifier** and **Keychain Group Identifier** both in the host application and in the notification service extension is required for proper functioning of all **Notification Content Extensions** features.
- Your host application and all the **Notification Content Extensions** must have the same **iOS Deployment Target** version (higher than iOS 10).

</div></div></div>


#### Application implementation {id=rich-media-in-push-notifications-application-implementation}

You must create push notification categories with the right identifiers, correlating with **Content Extensions** that you added before. The identifiers must be taken from the Synerise SDK constants (they are used in the code sample below). This does not affect button names.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-547">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-547-0" data-tab-group="tabgrp-547" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-547-1" data-tab-group="tabgrp-547">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-547-0" data-tab-group="tabgrp-547" data-tab-active="true">

```Swift
Synerise.settings.sdk.appGroupIdentifier = "YOUR_APP_GROUP_IDENTIFIER"
Synerise.settings.sdk.keychainGroupIdentifier = "YOUR_KEYCHAIN_GROUP_IDENTIFIER"

let singleMediaCategory = UNNotificationCategory(identifier: SNRSingleMediaContentExtensionViewControllerCategoryIdentifier, actions: [], intentIdentifiers: [], options: [])

let carouselPrevious = UNNotificationAction(identifier: SNRCarouselContentExtensionViewControllerPreviousItemIdentifier, title: "Previous", options: [])
let carouselAction = UNNotificationAction(identifier: SNRCarouselContentExtensionViewControllerChooseItemIdentifier, title: "Go!", options: UNNotificationActionOptions.foreground)
let carouselNext = UNNotificationAction(identifier: SNRCarouselContentExtensionViewControllerNextItemIdentifier, title: "Next", options: [])
let carouselCategory = UNNotificationCategory(identifier: SNRCarouselContentExtensionViewControllerCategoryIdentifier, actions: [carouselPrevious, carouselAction, carouselNext], intentIdentifiers: [], options: [])

// Use this method when you use SDK 4.21.0 or higher
Synerise.setNotificationCategories([singleMediaCategory, carouselCategory])
// or
// Use this method when you use SDK lower than 4.21.0
UNUserNotificationCenter.current().setNotificationCategories([singleMediaCategory, carouselCategory])
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-547-1" data-tab-group="tabgrp-547">

```Objective-C
SNRSynerise.settings.notifications.appGroupIdentifier = @"YOUR_APP_GROUP_IDENTIFIER";
SNRSynerise.settings.sdk.keychainGroupIdentifier = @"YOUR_KEYCHAIN_GROUP_IDENTIFIER";

UNNotificationCategory *singleMediaCategory = [UNNotificationCategory categoryWithIdentifier:SNRSingleMediaContentExtensionViewControllerCategoryIdentifier actions:@[] intentIdentifiers:@[] options:0];

UNNotificationAction *carouselPreviousAction = [UNNotificationAction actionWithIdentifier:SNRCarouselContentExtensionViewControllerPreviousItemIdentifier title:@"Previous" options:0];
UNNotificationAction *carouselGoAction = [UNNotificationAction actionWithIdentifier:SNRCarouselContentExtensionViewControllerChooseItemIdentifier title:@"Go" options:0];
UNNotificationAction *carouselNextAction = [UNNotificationAction actionWithIdentifier:SNRCarouselContentExtensionViewControllerNextItemIdentifier title:@"Next" options:0];
UNNotificationCategory *carouselCategory = [UNNotificationCategory categoryWithIdentifier:SNRCarouselContentExtensionViewControllerCategoryIdentifier actions:@[carouselPreviousAction, carouselGoAction, carouselNextAction] intentIdentifiers:@[] options:0];

[[UNUserNotificationCenter currentNotificationCenter] setNotificationCategories:[NSSet setWithObjects:singleMediaCategory, carouselCategory, nil]];
```

</div>
</div>


| Method | Description |
| --- | --- |
| [`Synerise.setNotificationCategories(_:)`](/developers/mobile-sdk/method-reference/ios/campaigns#set-notification-categories) | Sets the notification categories (including Synerise categories) that your app supports. Use this method when you use SDK 4.21.0 or higher. |
| [`UNUserNotificationCenter.current().setNotificationCategories(_:)`](https://developer.apple.com/documentation/usernotifications/unusernotificationcenter/setnotificationcategories(_:)) | Sets the notification categories by using the standard iOS SDK method. Use this method when you use SDK lower than 4.21.0. |

#### Single Media implementation {id=rich-media-in-push-notifications-single-media-implementation}


<div class="content-tabs code-tabs" data-tab-group="tabgrp-548">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-548-0" data-tab-group="tabgrp-548" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-548-1" data-tab-group="tabgrp-548">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-548-0" data-tab-group="tabgrp-548" data-tab-active="true">

```Swift
import UIKit
import UserNotifications
import UserNotificationsUI
import SyneriseSDK

class NotificationViewController: SingleMediaContentExtensionViewController, UNNotificationContentExtension {

  func didReceive(_ notification: UNNotification) {
  Synerise.settings.sdk.appGroupIdentifier = "YOUR_APP_GROUP_IDENTIFIER"
  Synerise.settings.sdk.keychainGroupIdentifier = "YOUR_KEYCHAIN_GROUP_IDENTIFIER"

    self.contentViewIsScrollable = false
    self.imageContentMode = .scaleAspectFit

    setSyneriseNotification(notification)
  }

  func didReceive(_ response: UNNotificationResponse, completionHandler completion: @escaping (UNNotificationContentExtensionResponseOption) -> Void) {
    setSyneriseNotificationResponse(response, completionHandler: completion)
  }
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-548-1" data-tab-group="tabgrp-548">

```Objective-C
#import <UIKit/UIKit.h>
#import <UserNotifications/UserNotifications.h>
#import <UserNotificationsUI/UserNotificationsUI.h>
#import <SyneriseSDK/SyneriseSDK.h>

@interface SingleMediaNotificationViewController : SNRSingleMediaContentExtensionViewController <UNNotificationContentExtension>

@end

#import "SingleMediaNotificationViewController.h"

@implementation SingleMediaNotificationViewController

- (void)didReceiveNotification:(UNNotification *)notification {
  SNRSynerise.settings.notifications.appGroupIdentifier = @"YOUR_APP_GROUP_IDENTIFIER";
  SNRSynerise.settings.sdk.keychainGroupIdentifier = @"YOUR_KEYCHAIN_GROUP_IDENTIFIER";

  self.contentViewIsScrollable = NO;
  self.imageContentMode = UIViewContentModeScaleAspectFit;

  [self setSyneriseNotification:notification];
}

- (void)didReceiveNotificationResponse:(UNNotificationResponse *)response completionHandler:(void (^)(UNNotificationContentExtensionResponseOption))completion {
  [self setSyneriseNotificationResponse:response completionHandler:completion];
}

@end
```

</div>
</div>


##### Properties {id=rich-media-in-push-notifications-single-media-properties}

| Parameter | Type | Default | Description |
| --- | --- | --- | --- |
| contentViewIsScrollable | `Bool` | true | This parameter specifies if vertical scroll is enabled. If false, content is adjusted to the screen height. |
| imageContentMode | `UIViewContentMode` | `UIViewContentModeScaleAspectFill` | This parameter sets the rendering mode of an image |

##### Info.plist {id=rich-media-in-push-notifications-single-media-info-plist}

The configuration for your **Content Extension** in `\*.plist` file must be:
- correlated with Synerise SDK constants for notification category  
  *NSExtension->NSExtensionAttributes->UNNotificationExtensionCategory->0* must be **synerise.notifications.category.single-media**.

- configured without a storyboard (by, default a storyboard is set).  
  *NSExtensionMainStoryboard* key and its values must be removed from `\*.plist` file.

- correlated with the principal class  
  *NSextensionPrincipalClass* key must have value with the name of the main class for the notification extension you have created. For **Content Extension** written in Swift, the prefix `$(PRODUCT_MODULE_NAME).` is required. For Objective-C, it is not.

Example `\*.plist` file for single media: 

<figure>
  <img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/developers/mobile-sdk/_gfx/ios-single-media-plist-configuration.png" alt="Sample *.plist configuration in Single Image Notification Content Extension" class="full">
  <figcaption>Sample *.plist configuration in Single Image Notification Content Extension</figcaption>
</figure>

##### Example {id=rich-media-in-push-notifications-single-media-example}

Examples of Single Media Notification Content Extension:
- [Single Media Notification Content Extension in Swift](https://github.com/Synerise/synerise-ios-sdk/tree/master/SampleAppSwift/4.10.0/SyneriseSingleMediaNotificationContentExtension)
- [Single Media Notification Content Extension in Objective-C](https://github.com/Synerise/synerise-ios-sdk/tree/master/SampleAppSwift/4.10.0/SyneriseSingleMediaNotificationContentExtensionObjC)

#### Carousel implementation {id=rich-media-in-push-notifications-carousel-implementation}


<div class="content-tabs code-tabs" data-tab-group="tabgrp-549">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-549-0" data-tab-group="tabgrp-549" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-549-1" data-tab-group="tabgrp-549">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-549-0" data-tab-group="tabgrp-549" data-tab-active="true">

```Swift
import UIKit
import UserNotifications
import UserNotificationsUI
import SyneriseSDK

class NotificationViewController: CarouselContentExtensionViewController, UNNotificationContentExtension {

  func didReceive(_ notification: UNNotification) {
  Synerise.settings.sdk.appGroupIdentifier = "YOUR_APP_GROUP_IDENTIFIER"
  Synerise.settings.sdk.keychainGroupIdentifier = "YOUR_KEYCHAIN_GROUP_IDENTIFIER"

    self.imageContentMode = .scaleAspectFit

    setSyneriseNotification(notification)
  }

  func didReceive(_ response: UNNotificationResponse, completionHandler completion: @escaping (UNNotificationContentExtensionResponseOption) -> Void) {
    setSyneriseNotificationResponse(response, completionHandler: completion)
  }
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-549-1" data-tab-group="tabgrp-549">

```Objective-C
#import <UIKit/UIKit.h>
#import <UserNotifications/UserNotifications.h>
#import <UserNotificationsUI/UserNotificationsUI.h>
#import <SyneriseSDK/SyneriseSDK.h>

@interface CarouselNotificationViewController : SNRCarouselContentExtensionViewController <UNNotificationContentExtension>

@end

#import "CarouselNotificationViewController.h"

@implementation CarouselNotificationViewController

- (void)didReceiveNotification:(UNNotification *)notification {
  SNRSynerise.settings.notifications.appGroupIdentifier = @"YOUR_APP_GROUP_IDENTIFIER";
  SNRSynerise.settings.sdk.keychainGroupIdentifier = @"YOUR_KEYCHAIN_GROUP_IDENTIFIER";

  [self setSyneriseNotification:notification];
}

- (void)didReceiveNotificationResponse:(UNNotificationResponse *)response completionHandler:(void (^)(UNNotificationContentExtensionResponseOption))completion {
  [self setSyneriseNotificationResponse:response completionHandler:completion];
}

@end
```

</div>
</div>


##### Properties {id=rich-media-in-push-notifications-carousel-properties}

| Parameter | Type | Default | Description |
| --- | --- | --- | --- |
| imageContentMode | `UIViewContentMode` | `UIViewContentModeScaleAspectFill` | This parameter sets the rendering mode of images |

##### Info.plist {id=rich-media-in-push-notifications-carousel-info-plist}

The configuration for your **Content Extension** in `\*.plist` file must be:
- correlated with Synerise SDK constants for notification category.  
  *NSExtension->NSExtensionAttributes->UNNotificationExtensionCategory->0* must be **synerise.notifications.category.carousel**.<br/><br/>

- configured without storyboard (it is set by default).  
  *NSExtensionMainStoryboard* key and its values must be removed from `\*.plist` file.<br/><br/>

- correlated with the principal class.  
  *NSextensionPrincipalClass* key must have value with name of your main class for the notification extension you have created. For **Content Extension** written in Swift, the prefix `$(PRODUCT_MODULE_NAME).` is required. For Objective-C, it is not.

See proper `\*.plist` file example for single media below:  

<figure>
  <img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/developers/mobile-sdk/_gfx/ios-carousel-plist-configuration.png" alt="Sample *.plist configuration in Carousel Notification Content Extension" class="full">
  <figcaption>Sample *.plist configuration in Carousel Notification Content Extension</figcaption>
</figure>

##### Example {id=rich-media-in-push-notifications-carousel-example}

Examples of Carousel Notification Content Extension:
- [Carousel Notification Content Extension in Swift](https://github.com/Synerise/synerise-ios-sdk/tree/master/SampleAppSwift/4.10.0/SyneriseCarouselNotificationContentExtension)
- [Carousel Notification Content Extension in Objective-C](https://github.com/Synerise/synerise-ios-sdk/tree/master/SampleAppSwift/4.10.0/SyneriseCarouselNotificationContentExtensionObjC)



# Client


### ClientIdentityProvider
**Declared In:**  
Headers/SNRClientIdentityProvider.h
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-178">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-178-0" data-tab-group="tabgrp-178" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-178-1" data-tab-group="tabgrp-178">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-178-0" data-tab-group="tabgrp-178" data-tab-active="true">

```Swift
enum ClientIdentityProvider: Int {
    synerise,
    oauth,
    simpleAuth,
    facebook,
    apple,
    google
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-178-1" data-tab-group="tabgrp-178">

```Objective-C
typedef NS_ENUM(NSUInteger, SNRClientIdentityProvider) {
    SNRClientIdentityProviderSynerise,
    SNRClientIdentityProviderOAuth,
    SNRClientIdentityProviderSimpleAuth,
    SNRClientIdentityProviderFacebook,
    SNRClientIdentityProviderApple,
    SNRClientIdentityProviderGoogle
}
```

</div>
</div>

  
**Functions:**

Converts from **ClientIdentityProvider** to **String**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-179">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-179-0" data-tab-group="tabgrp-179" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-179-1" data-tab-group="tabgrp-179">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-179-0" data-tab-group="tabgrp-179" data-tab-active="true">

```Swift
func SNR_ClientIdentityProviderToString(_: ClientIdentityProvider) -> String
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-179-1" data-tab-group="tabgrp-179">

```Objective-C
NSString * SNR_ClientIdentityProviderToString(SNRClientIdentityProvider type)
```

</div>
</div>


---

Converts from **String** to **ClientIdentityProvider**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-180">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-180-0" data-tab-group="tabgrp-180" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-180-1" data-tab-group="tabgrp-180">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-180-0" data-tab-group="tabgrp-180" data-tab-active="true">

```Swift
func SNR_StringToClientIdentityProvider(_: String) -> ClientIdentityProvider
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-180-1" data-tab-group="tabgrp-180">

```Objective-C
SNRClientIdentityProvider SNR_StringToClientIdentityProvider(NSString * _Nullable string)
```

</div>
</div>


---
---

### ClientConditionalAuthenticationContext
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClientConditionalAuthContext.h  
  
**Related To:**  
[ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-181">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-181-0" data-tab-group="tabgrp-181" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-181-1" data-tab-group="tabgrp-181">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-181-0" data-tab-group="tabgrp-181" data-tab-active="true">

```Swift
class ClientConditionalAuthContext: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-181-1" data-tab-group="tabgrp-181">

```Objective-C
@interface SNRClientConditionalAuthContext : SNRBaseModel
```

</div>
</div>

  
**Properties:**
Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements) | yes | nil | Object that stores all agreements of a customer |
| **attributes** | [AnyHashable: Any] | yes | [] | Additional custom attributes of a customer |
  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-182">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-182-0" data-tab-group="tabgrp-182" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-182-1" data-tab-group="tabgrp-182">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-182-0" data-tab-group="tabgrp-182" data-tab-active="true">

```Swift
init()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-182-1" data-tab-group="tabgrp-182">

```Objective-C
- (instancetype)init
```

</div>
</div>


<!-- reusable-table-boundary -->

---
---

### ClientAuthenticationContext
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClientAuthenticationContext.h  
  
**Related To:**  
[ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-183">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-183-0" data-tab-group="tabgrp-183" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-183-1" data-tab-group="tabgrp-183">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-183-0" data-tab-group="tabgrp-183" data-tab-active="true">

```Swift
class ClientAuthenticationContext: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-183-1" data-tab-group="tabgrp-183">

```Objective-C
@interface SNRClientAuthenticationContext : SNRBaseModel
```

</div>
</div>

  
**Properties:**
Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements) | yes | nil | Object that stores all agreements of a customer |
| **attributes** | [AnyHashable: Any] | yes | [] | Additional custom attributes of a customer |
  
**Initializers:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-184">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-184-0" data-tab-group="tabgrp-184" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-184-1" data-tab-group="tabgrp-184">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-184-0" data-tab-group="tabgrp-184" data-tab-active="true">

```Swift
init()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-184-1" data-tab-group="tabgrp-184">

```Objective-C
- (instancetype)init
```

</div>
</div>


<!-- reusable-table-boundary -->

---
---

### ClientConditionalAuthResult
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClientConditionalAuthResult.h  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)
    
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-185">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-185-0" data-tab-group="tabgrp-185" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-185-1" data-tab-group="tabgrp-185">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-185-0" data-tab-group="tabgrp-185" data-tab-active="true">

```Swift
class ClientConditionalAuthResult: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-185-1" data-tab-group="tabgrp-185">

```Objective-C
@interface SNRClientConditionalAuthResult : SNRBaseModel
```

</div>
</div>

  
**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **isSuccess** | Bool | no | Result of authentication operation |
| **token** | String | yes | Token as a raw string |
| **status** | [ClientConditionalAuthStatus](/developers/mobile-sdk/class-reference/ios/client#clientconditionalauthstatus) | no | Status of the authentication |
| **conditions** | [AnyObject] | yes | Authentication conditions |
  

<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties are read-only.

</div></div></div>


<!-- reusable-table-boundary -->

---
---

### ClientConditionalAuthStatus
**Declared In:**  
Headers/SNRClientConditionalAuthStatus.h  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-186">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-186-0" data-tab-group="tabgrp-186" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-186-1" data-tab-group="tabgrp-186">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-186-0" data-tab-group="tabgrp-186" data-tab-active="true">

```Swift
enum ClientConditionalAuthStatus: Int {
    success,
    unauthorized,
    activationRequired,
    registrationRequired,
    approvalRequired,
    termsAcceptanceRequired,
    mfaRequired,
    unknown
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-186-1" data-tab-group="tabgrp-186">

```Objective-C
typedef NS_ENUM(NSUInteger, SNRClientConditionalAuthStatus) {
    SNRClientConditionalAuthStatusSuccess,
    SNRClientConditionalAuthStatusUnauthorized,
    SNRClientConditionalAuthStatusActivationRequired,
    SNRClientConditionalAuthStatusRegistrationRequired,
    SNRClientConditionalAuthStatusApprovalRequired,
    SNRClientConditionalAuthStatusTermsAcceptanceRequired,
    SNRClientConditionalAuthStatusMFARequired,
    SNRClientConditionalAuthStatusUnknown
}
```

</div>
</div>

  
**Functions:**
  
Converts from **ClientConditionalAuthStatus** to **String**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-187">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-187-0" data-tab-group="tabgrp-187" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-187-1" data-tab-group="tabgrp-187">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-187-0" data-tab-group="tabgrp-187" data-tab-active="true">

```Swift
func SNR_ClientConditionalAuthStatusToString(_: ClientConditionalAuthStatus) -> String
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-187-1" data-tab-group="tabgrp-187">

```Objective-C
NSString * SNR_ClientConditionalAuthStatusToString(SNRClientConditionalAuthStatus status)
```

</div>
</div>


---

Converts from **String** to **ClientConditionalAuthStatus**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-188">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-188-0" data-tab-group="tabgrp-188" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-188-1" data-tab-group="tabgrp-188">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-188-0" data-tab-group="tabgrp-188" data-tab-active="true">

```Swift
func SNR_StringToClientConditionalAuthStatus(_: String) -> ClientConditionalAuthStatus
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-188-1" data-tab-group="tabgrp-188">

```Objective-C
SNRClientConditionalAuthStatus SNR_StringToClientConditionalAuthStatus(NSString * _Nullable string)
```

</div>
</div>


---
---

### ClientSimpleAuthenticationData
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClientSimpleAuthenticationData.h  
  
**Related To:**  
[ClientSex](/developers/mobile-sdk/class-reference/ios/client#clientsex)  
[ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-189">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-189-0" data-tab-group="tabgrp-189" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-189-1" data-tab-group="tabgrp-189">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-189-0" data-tab-group="tabgrp-189" data-tab-active="true">

```Swift
class ClientSimpleAuthenticationData: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-189-1" data-tab-group="tabgrp-189">

```Objective-C
@interface SNRClientSimpleAuthenticationData : SNRBaseModel
```

</div>
</div>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **email** | String | yes | Customer's email |
| **phone** | String | yes | Customer's phone |
| **customId** | String | yes | Customer's custom ID |
| **uuid** | String | yes | Customer's UUID |
| **firstName** | String | yes | Customer's first name |
| **lastName** | String | yes | Customer's last name |
| **displayName** | String | yes | Customer's display name |
| **sex** | [ClientSex](/developers/mobile-sdk/class-reference/ios/client#clientsex) | yes | Customer's sex |
| **company** | String | yes | Customer's company |
| **address** | String | yes | Customer's address |
| **city** | String | yes | Customer's city |
| **province** | String | yes | Customer's province |
| **zipCode** | String | yes | Customer's ZIP code |
| **countryCode** | String | yes | Customer's country code |
| **birthDate** | String | yes | Customer's birthdate |
| **avatarUrl** | String | yes | Customer's avatar URL |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements) | yes | Customer's agreements |
| **attributes** | [AnyHashable: Any] | yes | Customer's attributes |
  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-190">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-190-0" data-tab-group="tabgrp-190" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-190-1" data-tab-group="tabgrp-190">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-190-0" data-tab-group="tabgrp-190" data-tab-active="true">

```Swift
init()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-190-1" data-tab-group="tabgrp-190">

```Objective-C
- (instancetype)init
```

</div>
</div>


<!-- reusable-table-boundary -->

---
---

### ClientSessionEndReason
**Declared In:**   
Headers/SNRClientSessionEndReason.h  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-191">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-191-0" data-tab-group="tabgrp-191" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-191-1" data-tab-group="tabgrp-191">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-191-0" data-tab-group="tabgrp-191" data-tab-active="true">

```Swift
enum ClientSessionEndReason: Int {
    userSignOut,
    systemSignOut,
    sessionExpiration,
    securityException,
    clientRejected,
    userAccountDeleted
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-191-1" data-tab-group="tabgrp-191">

```Objective-C
typedef NS_ENUM(NSUInteger, SNRClientSessionEndReason) {
    SNRClientSessionEndReasonUserSignOut,
    SNRClientSessionEndReasonSystemSignOut,
    SNRClientSessionEndReasonSessionExpiration,
    SNRClientSessionEndReasonSessionDestroyed,
    SNRClientSessionEndReasonSecurityException,
    SNRClientSessionEndReasonClientRejected,
    SNRClientSessionEndReasonUserAccountDeleted
}
```

</div>
</div>


---
---

### ClientSignOutMode
**Declared In:**  
Headers/SNRClientSignOutMode.h  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-192">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-192-0" data-tab-group="tabgrp-192" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-192-1" data-tab-group="tabgrp-192">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-192-0" data-tab-group="tabgrp-192" data-tab-active="true">

```Swift
enum ClientSignOutMode: Int {
    .signOut,
    .signOutWithSessionDestroy
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-192-1" data-tab-group="tabgrp-192">

```Objective-C
typedef NS_ENUM(NSUInteger, SNRClientSignOutMode) {
    SNRClientSignOutModeSignOut,
    SNRClientSignOutModeSignOutWithSessionDestroy
}
```

</div>
</div>


---
---

### ClientAccountInformation
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClientAccountInformation.h  
  
**Related To:**  
[ClientSex](/developers/mobile-sdk/class-reference/ios/client#clientsex)  
[ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Conforms To:**  
[NSSecureCoding](https://developer.apple.com/documentation/foundation/nssecurecoding)    
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-193">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-193-0" data-tab-group="tabgrp-193" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-193-1" data-tab-group="tabgrp-193">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-193-0" data-tab-group="tabgrp-193" data-tab-active="true">

```Swift
class ClientAccountInformation: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-193-1" data-tab-group="tabgrp-193">

```Objective-C
@interface SNRClientAccountInformation : SNRBaseModel
```

</div>
</div>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **clientId** | Int | no | Customer's ID |
| **email** | String | no | Customer's email |
| **phone** | String | yes | Customer's phone |
| **customId** | String | yes | Customer's custom ID |
| **uuid** | String | no | Customer's UUID |
| **firstName** | String | yes | Customer's first name |
| **lastName** | String | yes | Customer's last name |
| **displayName** | String | yes | Customer's display name |
| **sex** | [ClientSex](/developers/mobile-sdk/class-reference/ios/client#clientsex) | no | Customer's sex |
| **company** | String | yes | Customer's company |
| **address** | String | yes | Customer's address |
| **city** | String | yes | Customer's city |
| **province** | String | yes | Customer's province |
| **zipCode** | String | yes | Customer's ZIP code |
| **countryCode** | String | yes | Customer's country code |
| **birthDate** | String | yes | Customer's birthdate |
| **lastActivityDate** | Date | no | Customer's last activity date |
| **avatarUrl** | String | yes | Customer's avatar URL |
| **anonymous** | Bool | no | Customer's anonymous flag |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements) | no | Customer's agreements |
| **attributes** | [AnyHashable: Any] | yes | Customer's attributes |
| **tags** | [String] | yes | Customer's tags |
  

<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties are read-only.

</div></div></div>


<!-- reusable-table-boundary -->

---
---

### ClientUpdateAccountBasicInformationContext
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClientUpdateAccountBasicInformationContext.h  
  
**Related To:**  
[ClientSex](/developers/mobile-sdk/class-reference/ios/client#clientsex)  
[ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Conforms To:**  
[NSSecureCoding](https://developer.apple.com/documentation/foundation/nssecurecoding)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-194">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-194-0" data-tab-group="tabgrp-194" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-194-1" data-tab-group="tabgrp-194">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-194-0" data-tab-group="tabgrp-194" data-tab-active="true">

```Swift
class ClientUpdateAccountBasicInformationContext: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-194-1" data-tab-group="tabgrp-194">

```Objective-C
@interface SNRClientUpdateAccountBasicInformationContext : SNRBaseModel
```

</div>
</div>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **firstName** | String | yes | Customer's first name |
| **lastName** | String | yes | Customer's last name |
| **displayName** | String | yes | Customer's display name |
| **sex** | [ClientSex](/developers/mobile-sdk/class-reference/ios/client#clientsex) | yes | Customer's sex |
| **phone** | String | yes | Customer's phone |
| **company** | String | yes | Customer's company |
| **address** | String | yes | Customer's address |
| **city** | String | yes | Customer's city |
| **province** | String | yes | Customer's province |
| **zipCode** | String | yes | Customer's ZIP code |
| **countryCode** | String | yes | Customer's country code |
| **birthDate** | String | yes | Customer's birthdate |
| **avatarUrl** | String | yes | Customer's avatar URL |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements) | no | Customer's agreements |
| **attributes** | [AnyHashable: Any] | yes | Customer's attributes |
  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-195">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-195-0" data-tab-group="tabgrp-195" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-195-1" data-tab-group="tabgrp-195">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-195-0" data-tab-group="tabgrp-195" data-tab-active="true">

```Swift
init()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-195-1" data-tab-group="tabgrp-195">

```Objective-C
- (instancetype)init
```

</div>
</div>


<!-- reusable-table-boundary -->

---
---

### ClientUpdateAccountContext
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClientUpdateAccountContext.h  
  
**Related To:**  
[ClientSex](/developers/mobile-sdk/class-reference/ios/client#clientsex)  
[ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Conforms To:**  
[NSSecureCoding](https://developer.apple.com/documentation/foundation/nssecurecoding)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-196">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-196-0" data-tab-group="tabgrp-196" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-196-1" data-tab-group="tabgrp-196">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-196-0" data-tab-group="tabgrp-196" data-tab-active="true">

```Swift
class ClientUpdateAccountContext: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-196-1" data-tab-group="tabgrp-196">

```Objective-C
@interface SNRClientUpdateAccountContext : SNRBaseModel
```

</div>
</div>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **email** | String | yes | Customer's email |
| **phone** | String | yes | Customer's phone |
| **customId** | String | yes | Customer's custom ID |
| **uuid** | String | yes | Customer's UUID |
| **firstName** | String | yes | Customer's first name |
| **lastName** | String | yes | Customer's last name |
| **displayName** | String | yes | Customer's display name |
| **sex** | [ClientSex](/developers/mobile-sdk/class-reference/ios/client#clientsex) | yes | Customer's sex |
| **company** | String | yes | Customer's company |
| **address** | String | yes | Customer's address |
| **city** | String | yes | Customer's city |
| **province** | String | yes | Customer's province |
| **zipCode** | String | yes | Customer's ZIP code |
| **countryCode** | String | yes | Customer's country code |
| **birthDate** | String | yes | Customer's birthdate |
| **avatarUrl** | String | yes | Customer's avatar URL |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements) | no | Customer's agreements |
| **attributes** | [AnyHashable: Any] | yes | Customer's attributes |
  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-197">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-197-0" data-tab-group="tabgrp-197" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-197-1" data-tab-group="tabgrp-197">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-197-0" data-tab-group="tabgrp-197" data-tab-active="true">

```Swift
init()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-197-1" data-tab-group="tabgrp-197">

```Objective-C
- (instancetype)init
```

</div>
</div>


<!-- reusable-table-boundary -->

---
---

### ClientRegisterAccountContext
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClientRegisterAccountContext.h  
  
**Related To:**  
[ClientSex](/developers/mobile-sdk/class-reference/ios/client#clientsex)  
[ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-198">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-198-0" data-tab-group="tabgrp-198" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-198-1" data-tab-group="tabgrp-198">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-198-0" data-tab-group="tabgrp-198" data-tab-active="true">

```Swift
class ClientRegisterAccountContext: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-198-1" data-tab-group="tabgrp-198">

```Objective-C
@interface SNRClientRegisterAccountContext : SNRBaseModel
```

</div>
</div>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **email** | String | no | Customer's email |
| **password** | String | no | Customer's password |
| **firstName** | String | yes | Customer's first name |
| **lastName** | String | yes | Customer's last name |
| **customId** | String | yes | Customer's custom ID |
| **sex** | [ClientSex](/developers/mobile-sdk/class-reference/ios/client#clientsex) | yes | Customer's sex |
| **phone** | String | yes | Customer's phone |
| **company** | String | yes | Customer's company |
| **address** | String | yes | Customer's address |
| **city** | String | yes | Customer's city |
| **province** | String | yes | Customer's province code |
| **zipCode** | String | yes | Customer's ZIP code |
| **countryCode** | String | yes | Customer's country code |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements) | yes | Customer's agreements |
| **attributes** | [AnyHashable: Any] | yes | Customer's attributes |
  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-199">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-199-0" data-tab-group="tabgrp-199" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-199-1" data-tab-group="tabgrp-199">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-199-0" data-tab-group="tabgrp-199" data-tab-active="true">

```Swift
init(email: String, password: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-199-1" data-tab-group="tabgrp-199">

```Objective-C
- (instancetype)initWithEmail:(nonnull NSString *)email andPassword:(nonnull NSString *)password
```

</div>
</div>


<!-- reusable-table-boundary -->

---
---

### ClientPasswordResetRequestContext
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClientPasswordResetRequestContext.h  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-200">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-200-0" data-tab-group="tabgrp-200" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-200-1" data-tab-group="tabgrp-200">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-200-0" data-tab-group="tabgrp-200" data-tab-active="true">

```Swift
class ClientPasswordResetRequestContext: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-200-1" data-tab-group="tabgrp-200">

```Objective-C
@interface SNRClientPasswordResetRequestContext : SNRBaseModel
```

</div>
</div>

  
**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **email** | Bool | no | Customer's email |
  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-201">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-201-0" data-tab-group="tabgrp-201" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-201-1" data-tab-group="tabgrp-201">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-201-0" data-tab-group="tabgrp-201" data-tab-active="true">

```Swift
init(email: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-201-1" data-tab-group="tabgrp-201">

```Objective-C
- (instancetype)initWithEmail:(nonnull NSString *)email
```

</div>
</div>


<!-- reusable-table-boundary -->

---
---

### ClientPasswordResetConfirmationContext
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClientPasswordResetConfirmationContext.h
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-202">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-202-0" data-tab-group="tabgrp-202" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-202-1" data-tab-group="tabgrp-202">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-202-0" data-tab-group="tabgrp-202" data-tab-active="true">

```Swift
class ClientPasswordResetConfirmationContext: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-202-1" data-tab-group="tabgrp-202">

```Objective-C
@interface SNRClientPasswordResetConfirmationContext : SNRBaseModel
```

</div>
</div>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **password** | String | no | Customer's password |
| **token** | String | no | Customer's token |
  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-203">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-203-0" data-tab-group="tabgrp-203" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-203-1" data-tab-group="tabgrp-203">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-203-0" data-tab-group="tabgrp-203" data-tab-active="true">

```Swift
init(password: String, token: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-203-1" data-tab-group="tabgrp-203">

```Objective-C
- (instancetype)initWithPassword:(nonnull NSString *)password andToken:(nonnull NSString *)token
```

</div>
</div>


<!-- reusable-table-boundary -->

---
---

### ClientSex
**Declared In:**  
Headers/SNRClientSex.h  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-204">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-204-0" data-tab-group="tabgrp-204" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-204-1" data-tab-group="tabgrp-204">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-204-0" data-tab-group="tabgrp-204" data-tab-active="true">

```Swift
enum ClientSex: Int {
    notSpecified,
    male,
    female,
    other
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-204-1" data-tab-group="tabgrp-204">

```Objective-C
typedef NS_ENUM(NSUInteger, SNRClientSex) {
    SNRClientSexNotSpecified = 0,
    SNRClientSexMale,
    SNRClientSexFemale,
    SNRClientSexOther,
}
```

</div>
</div>

  
**Functions:**

Converts from **ClientSex** to **String**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-205">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-205-0" data-tab-group="tabgrp-205" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-205-1" data-tab-group="tabgrp-205">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-205-0" data-tab-group="tabgrp-205" data-tab-active="true">

```Swift
func SNR_ClientSexToString(_: ClientSex) -> String
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-205-1" data-tab-group="tabgrp-205">

```Objective-C
NSString * SNR_ClientSexToString(SNRClientSex type)
```

</div>
</div>


<br>

Converts from **String** to **ClientSex**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-206">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-206-0" data-tab-group="tabgrp-206" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-206-1" data-tab-group="tabgrp-206">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-206-0" data-tab-group="tabgrp-206" data-tab-active="true">

```Swift
func SNR_StringToClientSex(_: String) -> ClientSex
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-206-1" data-tab-group="tabgrp-206">

```Objective-C
SNRClientSex SNR_StringToClientSex(NSString * _Nullable string)
```

</div>
</div>


---
---

### ClientAgreements
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClientAgreements.h  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Conforms To:**  
[NSSecureCoding](https://developer.apple.com/documentation/foundation/nssecurecoding)  
[NSCopying](https://developer.apple.com/documentation/foundation/nscopying)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-207">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-207-0" data-tab-group="tabgrp-207" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-207-1" data-tab-group="tabgrp-207">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-207-0" data-tab-group="tabgrp-207" data-tab-active="true">

```Swift
class ClientAgreements: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-207-1" data-tab-group="tabgrp-207">

```Objective-C
@interface SNRClientAgreements : SNRBaseModel
```

</div>
</div>

  
**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **email** | Bool | no | Email agreement |
| **sms** | Bool | no | SMS agreement |
| **push** | Bool | no | Push notifications agreement |
| **bluetooth** | Bool | no | Bluetooth agreement |
| **rfid** | Bool | no | RFID agreement |
| **wifi** | Bool | no | WIFI agreement |
  
**Initializers:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-208">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-208-0" data-tab-group="tabgrp-208" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-208-1" data-tab-group="tabgrp-208">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-208-0" data-tab-group="tabgrp-208" data-tab-active="true">

```Swift
init()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-208-1" data-tab-group="tabgrp-208">

```Objective-C
- (instancetype)init
```

</div>
</div>


<!-- reusable-table-boundary -->

---
---

### ClientEventData
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClientEventData.h  
  
**Related To:**  
[Event](/developers/mobile-sdk/class-reference/ios/events#event)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-209">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-209-0" data-tab-group="tabgrp-209" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-209-1" data-tab-group="tabgrp-209">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-209-0" data-tab-group="tabgrp-209" data-tab-active="true">

```Swift
class ClientEventData: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-209-1" data-tab-group="tabgrp-209">

```Objective-C
@interface SNRClientEventData : SNRBaseModel
```

</div>
</div>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **time** | String | no | Event's time |
| **label** | String | no | Event's label |
| **action** | String | no | Event's action |
| **client** | [AnyHashable: Any] | no | Event's customer identification |
| **params** | [AnyHashable: Any] | no | Event's parameters |
  

<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties are read-only.

</div></div></div>

  
**Methods:**

This method retrieves a customer ID.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-210">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-210-0" data-tab-group="tabgrp-210" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-210-1" data-tab-group="tabgrp-210">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-210-0" data-tab-group="tabgrp-210" data-tab-active="true">

```Swift
func getClientID() -> Int
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-210-1" data-tab-group="tabgrp-210">

```Objective-C
- (NSInteger)getClientID
```

</div>
</div>


---

This method retrieves a customer UUID.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-211">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-211-0" data-tab-group="tabgrp-211" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-211-1" data-tab-group="tabgrp-211">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-211-0" data-tab-group="tabgrp-211" data-tab-active="true">

```Swift
func getClientUUIDString() -> String?
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-211-1" data-tab-group="tabgrp-211">

```Objective-C
- (nullable NSString *)getClientUUIDString
```

</div>
</div>


---

This method retrieves a customer email.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-212">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-212-0" data-tab-group="tabgrp-212" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-212-1" data-tab-group="tabgrp-212">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-212-0" data-tab-group="tabgrp-212" data-tab-active="true">

```Swift
func getClientEmail() -> String?
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-212-1" data-tab-group="tabgrp-212">

```Objective-C
- (nullable NSString *)getClientEmail
```

</div>
</div>


<!-- reusable-table-boundary -->

---
---

### ClientEventsApiQuery
<!-- reusable-table-boundary -->

The object to set parameters easily for fetching client events from API.
  
**Declared In:**  
Headers/SNRClientEventsApiQuery.h  
  
**Inherits From:**  
[NSObject](https://developer.apple.com/documentation/objectivec/nsobject)
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-213">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-213-0" data-tab-group="tabgrp-213" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-213-1" data-tab-group="tabgrp-213">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-213-0" data-tab-group="tabgrp-213" data-tab-active="true">

```Swift
class ClientEventsApiQuery: NSObject
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-213-1" data-tab-group="tabgrp-213">

```Objective-C
@interface SNRClientEventsApiQuery : NSObject
```

</div>
</div>

  
**Properties:**
| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **actions** | [String] | no  | [] | Specifies event actions for query |
| **timeFrom** | String | yes  | nil | Specifies time from for query |
| **timeTo** | String | yes | nil | Specifies time to for query |
| **limit** | String | no | 100 | Limit of items in the response |
  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-214">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-214-0" data-tab-group="tabgrp-214" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-214-1" data-tab-group="tabgrp-214">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-214-0" data-tab-group="tabgrp-214" data-tab-active="true">

```Swift
init()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-214-1" data-tab-group="tabgrp-214">

```Objective-C
- (instancetype)init
```

</div>
</div>


<!-- reusable-table-boundary -->

---
---

### TokenPayload
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRTokenPayload.h  
  
**Related To:**  
[TokenOrigin](/developers/mobile-sdk/class-reference/ios/client#tokenorigin)
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-215">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-215-0" data-tab-group="tabgrp-215" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-215-1" data-tab-group="tabgrp-215">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-215-0" data-tab-group="tabgrp-215" data-tab-active="true">

```Swift
class TokenPayload: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-215-1" data-tab-group="tabgrp-215">

```Objective-C
@interface SNRTokenPayload : SNRBaseModel
```

</div>
</div>

  
**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **tokenString** | String | no | Token as a raw string |
| **expirationDate** | Date | no | Token's expiration time |
| **creationDate** | Date | no | Token's creation time |
| **rlm** | String | no | Token's RLM |
| **origin** | [TokenOrigin](/developers/mobile-sdk/class-reference/ios/client#tokenorigin) | no | Token's origin |
| **uuid** | String | no | Customer's UUID |
| **clientId** | String | no | Customer's ID |
| **customId** | String | yes | Customer's custom ID |
  
**Initializers:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-216">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-216-0" data-tab-group="tabgrp-216" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-216-1" data-tab-group="tabgrp-216">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-216-0" data-tab-group="tabgrp-216" data-tab-active="true">

```Swift
init(tokenString: String, expirationDate: Date, creationDate: Date, rlm: String, origin: TokenOrigin, uuid: String, clientId: String, customId: String?)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-216-1" data-tab-group="tabgrp-216">

```Objective-C
- (instancetype)initWithTokenString:(NSString *)tokenString expirationDate:(NSDate *)expirationDate creationDate:(NSDate *)creationDate rlm:(NSString *)rlm origin:(SNRTokenOrigin)origin uuid:(NSString *)uuid clientId:(NSString *)clientId customId:(nullable NSString *)customId;
```

</div>
</div>


<!-- reusable-table-boundary -->

---
---

### Token
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRToken.h  
  
**Related To:**  
[TokenOrigin](/developers/mobile-sdk/class-reference/ios/client#tokenorigin)
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-217">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-217-0" data-tab-group="tabgrp-217" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-217-1" data-tab-group="tabgrp-217">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-217-0" data-tab-group="tabgrp-217" data-tab-active="true">

```Swift
class Token: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-217-1" data-tab-group="tabgrp-217">

```Objective-C
@interface SNRToken : SNRBaseModel
```

</div>
</div>

  
**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **tokenString** | String | no | Token as a raw string |
| **expirationDate** | String | no | Token's expiration time |
| **rlm** | String | no | Token's RLM |
| **origin** | [TokenOrigin](/developers/mobile-sdk/class-reference/ios/client#tokenorigin) | no | Token's origin |
| **clientId** | String | no | Customer's ID |
| **customId** | String | yes | Customer's custom ID |
  
**Methods:**
Checks if the token is near expiration.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-218">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-218-0" data-tab-group="tabgrp-218" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-218-1" data-tab-group="tabgrp-218">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-218-0" data-tab-group="tabgrp-218" data-tab-active="true">

```Swift
func isNearExpiring() -> Bool
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-218-1" data-tab-group="tabgrp-218">

```Objective-C
- (BOOL)isNearExpiring
```

</div>
</div>


<!-- reusable-table-boundary -->

---
---

### TokenOrigin

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The `Oauth` value was renamed in 5.0.0 version to `OAuth`.

</div></div></div>

**Declared In:**  
Headers/SNRTokenOrigin.h  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-219">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-219-0" data-tab-group="tabgrp-219" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-219-1" data-tab-group="tabgrp-219">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-219-0" data-tab-group="tabgrp-219" data-tab-active="true">

```Swift
enum TokenOrigin: Int {
    unknown,
    synerise,
    simpleAuth,
    facebook,
    OAuth,
    apple
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-219-1" data-tab-group="tabgrp-219">

```Objective-C
typedef NS_ENUM(NSUInteger, SNRTokenOrigin) {
    SNRTokenOriginUnknown,
    SNRTokenOriginSynerise,
    SNRTokenOriginSimpleAuth,
    SNRTokenOriginFacebook,
    SNRTokenOriginOAuth,
    SNRTokenOriginApple
}
```

</div>
</div>

  
**Functions:**
Converts from **TokenOrigin** to **String**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-220">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-220-0" data-tab-group="tabgrp-220" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-220-1" data-tab-group="tabgrp-220">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-220-0" data-tab-group="tabgrp-220" data-tab-active="true">

```Swift
func SNR_TokenOriginToString(_: TokenOrigin) -> String
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-220-1" data-tab-group="tabgrp-220">

```Objective-C
NSString * SNR_TokenOriginToString(SNRTokenOrigin type)
```

</div>
</div>


---

Converts from **String** to **TokenOrigin**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-221">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-221-0" data-tab-group="tabgrp-221" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-221-1" data-tab-group="tabgrp-221">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-221-0" data-tab-group="tabgrp-221" data-tab-active="true">

```Swift
func SNR_StringToTokenOrigin(_: String) -> TokenOrigin
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-221-1" data-tab-group="tabgrp-221">

```Objective-C
SNRTokenOrigin SNR_StringToTokenOrigin(NSString *string)
```

</div>
</div>


---
---

## Removed symbols
---

### <del>ClientOAuthAuthenticationContext</del>{#clientoauthauthenticationcontext}
<!-- reusable-table-boundary -->

| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.6.11 | 3.6.13 | 0.9.12 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | 1.0.0 | n/a |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClientOAuthAuthenticationContext.h
  
**Related To:**  
[ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-222">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-222-0" data-tab-group="tabgrp-222" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-222-1" data-tab-group="tabgrp-222">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-222-0" data-tab-group="tabgrp-222" data-tab-active="true">

```Swift
class ClientOAuthAuthenticationContext: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-222-1" data-tab-group="tabgrp-222">

```Objective-C
@interface SNRClientOAuthAuthenticationContext : SNRBaseModel
```

</div>
</div>

  
**Properties:**
Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements) | yes | nil | Object that stores all agreements of a customer |
| **attributes** | [AnyHashable: Any] | yes | [] | Additional custom attributes of a customer |
  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-223">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-223-0" data-tab-group="tabgrp-223" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-223-1" data-tab-group="tabgrp-223">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-223-0" data-tab-group="tabgrp-223" data-tab-active="true">

```Swift
init()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-223-1" data-tab-group="tabgrp-223">

```Objective-C
- (instancetype)init
```

</div>
</div>


<!-- reusable-table-boundary -->

---
---

### <del>ClientFacebookAuthenticationContext</del>{#clientfacebookauthenticationcontext}
<!-- reusable-table-boundary -->

| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.3.8 | 3.3.0 | 0.9.7 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | 1.0.0 | n/a |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClientFacebookAuthenticationContext.h
  
**Related To:**  
[ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-224">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-224-0" data-tab-group="tabgrp-224" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-224-1" data-tab-group="tabgrp-224">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-224-0" data-tab-group="tabgrp-224" data-tab-active="true">

```Swift
class ClientFacebookAuthenticationContext: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-224-1" data-tab-group="tabgrp-224">

```Objective-C
@interface SNRClientFacebookAuthenticationContext : SNRBaseModel
```

</div>
</div>

  
**Properties:**
Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements) | yes | nil | Object that stores all agreements of a customer |
| **attributes** | [AnyHashable: Any] | yes | [] | Additional custom attributes of a customer |
  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-225">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-225-0" data-tab-group="tabgrp-225" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-225-1" data-tab-group="tabgrp-225">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-225-0" data-tab-group="tabgrp-225" data-tab-active="true">

```Swift
init()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-225-1" data-tab-group="tabgrp-225">

```Objective-C
- (instancetype)init
```

</div>
</div>


<!-- reusable-table-boundary -->

---
---

### <del>ClientAppleSignInAuthenticationContext</del>{#clientapplesigninauthenticationcontext}
<!-- reusable-table-boundary -->

| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.6.11 | n/a | 0.9.12 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.7.6 | n/a | 0.9.19 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | n/a | 1.0.0 | n/a |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClientAppleSignInAuthenticationContext.h  
  
**Related To:**  
[ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-226">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-226-0" data-tab-group="tabgrp-226" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-226-1" data-tab-group="tabgrp-226">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-226-0" data-tab-group="tabgrp-226" data-tab-active="true">

```Swift
class ClientAppleSignInAuthenticationContext: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-226-1" data-tab-group="tabgrp-226">

```Objective-C
@interface SNRClientAppleSignInAuthenticationContext : SNRBaseModel
```

</div>
</div>

  
**Properties:**
Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/ios/client#clientagreements) | yes | nil | Object that stores all agreements of a customer |
| **attributes** | [AnyHashable: Any] | yes | [] | Additional custom attributes of a customer |
  
**Initializers:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-227">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-227-0" data-tab-group="tabgrp-227" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-227-1" data-tab-group="tabgrp-227">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-227-0" data-tab-group="tabgrp-227" data-tab-active="true">

```Swift
init()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-227-1" data-tab-group="tabgrp-227">

```Objective-C
- (instancetype)init
```

</div>
</div>


<!-- reusable-table-boundary -->



# Simple push


## Overview
---
Simple push is a standard push notification interacting with your operating system. If an app is not active (was closed or running in the background) in the moment of receiving simple push, it appears in the notification center. When a customer clicks the notification, they are taken to the application and a simple push is presented.

If an app is active, the simple push is presented right away.

Read more about creating and testing simple push [here](/docs/campaign/Mobile/creating-mobile-push).


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Additionaly, iOS and React Native (iOS) simple push campaigns support two types of Rich Media extensions:
- [Single Media](#single-media)
- [Image Carousel](#image-carousel)
  
<br/>

Add support for Rich Media Push Notifications in your application. See [Rich Media in Push Notifications](/developers/mobile-sdk/configuring-push-notifications/ios#rich-media-in-push-notifications) section.

</div></div></div>


## Configuration
---
Simple push campaign is served by push notifications. See:
- [Configuring push notifications - Android](/developers/mobile-sdk/configuring-push-notifications/android)
- [Configuring push notifications - iOS](/developers/mobile-sdk/configuring-push-notifications/ios)
- [Configuring push notifications - React Native](/developers/mobile-sdk/configuring-push-notifications/react-native)
- [Configuring push notifications - Flutter](/developers/mobile-sdk/configuring-push-notifications/flutter)

Additionally, check possible available configuration options in the [Settings](/developers/mobile-sdk/settings#notifications).

## Events generated by simple push
---
For information about events generated by simple push, see the [event reference](/docs/assets/events/event-reference/mobile-push).


## Handling actions from simple push
---
Handling main actions from campaigns depends on campaign type and operating system and it is described [here](/developers/mobile-sdk/campaigns/action-handling).


## Additional in-app alert when simple push is received
---

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This feature is available only in iOS SDK, React Native SDK (iOS) and Flutter SDK (iOS).

</div></div></div>


The iOS SDK displays an additional alert in the application after a simple push campaign is received and it is configured with [OPEN_URL](/developers/mobile-sdk/campaigns/action-handling#types-of-actions-in-campaigns) or [DEEP_LINKING](/developers/mobile-sdk/campaigns/action-handling#types-of-actions-in-campaigns) action. This alert is displayed in the middle of the screen with content from the native notification payload. This is the default behavior.

You can disable it in the SDK Settings - [Enable/disable notification alerts](/developers/mobile-sdk/settings#enabledisable-notification-in-app-alerts).

<figure><img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/developers/mobile-sdk/_gfx/ios-simple-push-in-app-alert.png" alt="Simple Push campaign with in-app alert" class="small"><figcaption>Simple Push campaign with in-app alert</figcaption></figure>


## Payload
---
<br/>

<div class="content-tabs" data-tab-group="tabgrp-36">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-36-0" data-tab-group="tabgrp-36" data-tab-active="true">Android</button><button class="tab-button" data-tab-id="tabgrp-36-1" data-tab-group="tabgrp-36">iOS</button></div>

<div class="tab-panel" data-tab-id="tabgrp-36-0" data-tab-group="tabgrp-36" data-tab-active="true">

<pre><code class="language-json">{
  "data": {
    "issuer": "Synerise",
    "message-type": "static-content",
    "content-type": "simple-push",
    "content": {
      "notification": {
        "title": "Finish your purchase",
        "body": "You have in your basket Road Bike RS-500 with discount for \"New Users\". Comeback to the basket and complete your purchase.",
        "icon": "https://upload.snrcdn.net/f2afa4d4d7af216196047d1f7f0613f22a50a8c8/default/origin/7eba69de2d4dab3a9388b9d72abd91eb.png",
        "action": {
          "type": "OPEN_APP"
        }
      },
      "buttons": [
        {
          "identifier": "check",
          "text": "Check",
          "action": {
            "type": "OPEN_URL",
            "item": "http://www.synerise.com"
          }
        },
        {
          "identifier": "view_similar",
          "text": "View similar",
          "action": {
            "type": "OPEN_URL",
            "item": "http://www.synerise.com"
          }
        }
      ],
      "campaign": {
        "hash_id": "196211cc-af48-4064-8860-aad986449322",
        "variant_id": 3175648,
        "type": "Mobile push",
        "title": "SimplePush For Docs"
      }
    }
  }
}</code></pre>



The example presents a simple push campaign with a main action, image, and two clickable buttons connected to actions. All user interactions are tracked by Synerise Android SDK.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The look of your push notifications may vary depending on Android versions.

</div></div></div>


<figure><img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/developers/mobile-sdk/_gfx/android-simple-push-expanded.png" alt="Expanded simple push notification" class="medium"><figcaption>Simple push notification presented on Android 10</figcaption></figure>

</div>

<div class="tab-panel" data-tab-id="tabgrp-36-1" data-tab-group="tabgrp-36">

<pre><code class="language-json">{
  "aps": {
    "alert": {
      "title": "Complete your purchase",
      "body": "Your basket contains Road Bike RS-500 with a discount for \"New Users\". Come and complete your purchase!"
    },
    "sound": "default",
    "category": "[YOUR CATEGORY]",
    "mutable-content": 1
  },
  "issuer": "Synerise",
  "message-type": "dynamic-content",
  "content-type": "simple-push",
  "content": {
    "campaign": {
      "variant_id": 3175648,
      "hash_id": "196211cc-af48-4064-8860-aad986449322",
      "type": "Simple Push",
      "title": "Simple Push campaign for docs"
    },
    "notification": {
      "action": {
        "type": "OPEN_APP"
      }
    },
    "buttons": [{
      "identifier": "check",
      "text": "Check",
      "action": {
        "type": "OPEN_URL",
        "item": "http://www.synerise.com"
      }
    },
    {
      "identifier": "view_similiar",
      "text": "View similiar",
      "action": {
        "type": "OPEN_URL",
        "item": "http://www.synerise.com"
      }
    }]
  }
}</code></pre>



The example presents a simple push campaign with a main action and two clickable buttons connected to actions. All user interactions are tracked by Synerise iOS SDK.

<figure><img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/developers/mobile-sdk/_gfx/ios-simple-push-campaign-1.png" alt="Simple Push campaign" class="small"><figcaption>Simple push campaign presented on iOS 14</figcaption></figure>


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The look of your push notifications may vary depending on iOS versions.

</div></div></div>

</div>
</div>


## Single Media
---

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This feature is available only in iOS SDK.

</div></div></div>


It is a simple push campaign with an image that can be seen after expanding the notification.

### Payload {id=single-media-payload}


<div class="content-tabs" data-tab-group="tabgrp-37">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-37-0" data-tab-group="tabgrp-37" data-tab-active="true">iOS</button></div>

<div class="tab-panel" data-tab-id="tabgrp-37-0" data-tab-group="tabgrp-37" data-tab-active="true">

<pre><code class="language-json">{
  "aps": {
    "alert": {
      "title": "Complete your purchase",
      "body": "Your basket contains Road Bike RS-500 with a discount for \"New Users\". Come and complete your purchase!"
    },
    "sound": "default",
    "category": "synerise.notifications.category.single-media",
    "mutable-content": 1
  },
  "issuer": "Synerise",
  "message-type": "dynamic-content",
  "content-type": "simple-push",
  "content": {
    "campaign": {
      "variant_id": 3175648,
      "hash_id": "196211cc-af48-4064-8860-aad986449322",
      "type": "Simple Push",
      "title": "Simple Push campaign for docs"
    },
    "notification": {
      "action": {
        "type": "OPEN_APP"
      }
    },
    "buttons": [{
      "identifier": "check",
      "text": "Check",
      "action": {
        "type": "OPEN_URL",
        "item": "http://www.synerise.com"
      }
    },
    {
      "identifier": "view_similiar",
      "text": "View similiar",
      "action": {
        "type": "OPEN_URL",
        "item": "http://www.synerise.com"
      }
    }],
    "rich-media": {
      "type": "single-image",
      "single-image": {
        "image": "https://upload.snrcdn.net/f2afa4d4d7af216196047d1f7f0613f22a50a8c8/default/origin/7eba69de2d4dab3a9388b9d72abd91eb.png"
      }
    }
  }
}</code></pre>



The example presents a simple push campaign with a main action, single image, and two clickable buttons connected to actions. All user interactions are tracked by Synerise iOS SDK.

<figure><img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/developers/mobile-sdk/_gfx/ios-simple-push-campaign-2.png" alt="Simple Push campaign" class="small"><figcaption>Simple push campaign presented on iOS 14</figcaption></figure>


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The look of your push notifications may vary depending on iOS versions.

</div></div></div>

</div>
</div>


## Image Carousel
---

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This feature is available only in iOS SDK.

</div></div></div>


It is a simple push campaign with images that can be seen and swiped after expanding the notification.

### Payload {id=image-carousel-payload}


<div class="content-tabs" data-tab-group="tabgrp-38">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-38-0" data-tab-group="tabgrp-38" data-tab-active="true">iOS</button></div>

<div class="tab-panel" data-tab-id="tabgrp-38-0" data-tab-group="tabgrp-38" data-tab-active="true">

<pre><code class="language-json">{
    "aps":
    {
        "alert":
        {
            "title": "Complete your purchase",
            "body": "Your basket contains Road Bike RS-500 with a discount for \"New Users\". Come and complete your purchase!"
        },
        "sound": "default",
        "badge": "5",
        "category": "synerise.notifications.category.carousel"
    },
    "issuer": "Synerise",
    "message-type": "dynamic-content",
    "content-type": "simple-push",
    "content":
    {
        "campaign":
        {
            "variant_id": 3175648,
            "hash_id": "196211cc-af48-4064-8860-aad986449322",
            "type": "Simple Push",
            "title": "Simple Push campaign for docs"
        },
        "notification":
        {
            "action":
            {
                "type": "OPEN_URL",
                "item": "https://www.synerise.com"
            }
        },
        "rich-media":
        {
            "type": "carousel",
            "carousel":
            {
                "orientation": "PORTRAIT",
                "items":
                [
                    {
                        "caption": "Check!",
                        "subcaption": "Road Bike RS-500",
                        "image": "https://upload.snrcdn.net/f2afa4d4d7af216196047d1f7f0613f22a50a8c8/default/origin/7eba69de2d4dab3a9388b9d72abd91eb.png",
                        "url": "https://www.synerise.com"
                    },
                    {
                        "caption": "Check!",
                        "subcaption": "Road Bike RS-500",
                        "image": "https://upload.snrcdn.net/f2afa4d4d7af216196047d1f7f0613f22a50a8c8/default/origin/7eba69de2d4dab3a9388b9d72abd91eb.png",
                        "url": "https://www.synerise.com"
                    }
                ]
            }
        }
    }
}</code></pre>



<details class="accordion"><summary>Click to see an example push with image carousel</summary><div class="accordion-content"><p>The example presents a simple push campaign with a main action and carousel of images with connected actions. All user interactions are tracked by Synerise iOS SDK.</p> <div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content"> <p>The look of your push notifications may vary depending on iOS versions.</p> </div></div></div> <figure><img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/developers/mobile-sdk/_gfx/ios-simple-push-campaign-3.png" alt="Simple Push campaign" class="small"><figcaption>Simple Push campaign presented on iOS 14</figcaption></figure></div></details>

</div>
</div>





# iOS

## iOS delegates

### SyneriseDelegate {id=synerise-delegate}
A delegate to handle the SDK lifecycle events.
  
To set your object as delegate, you must use [this method](/developers/mobile-sdk/method-reference/ios/lifecycle#set-synerise-delegate).


<div class="content-tabs code-tabs" data-tab-group="tabgrp-668">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-668-0" data-tab-group="tabgrp-668" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-668-1" data-tab-group="tabgrp-668">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-668-0" data-tab-group="tabgrp-668" data-tab-active="true">

```Swift
Synerise.setDelegate(YOUR_OBJECT)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-668-1" data-tab-group="tabgrp-668">

```Objective-C
[SNRSynerise setDelegate:YOUR_OBJECT];
```

</div>
</div>



<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

If optional methods for handling URL and deeplink are not implemented, SDK has a default behavior.

</div></div></div>


##### snr_initialized() {id=synerise-delegate-initialized}

This method is called when the Synerise SDK is initialized.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-669">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-669-0" data-tab-group="tabgrp-669" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-669-1" data-tab-group="tabgrp-669">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-669-0" data-tab-group="tabgrp-669" data-tab-active="true">

```Swift
func snr_initialized() -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-669-1" data-tab-group="tabgrp-669">

```Objective-C
- (void)SNR_initialized
```

</div>
</div>


##### snr_initializationError(error: Error) {id=synerise-delegate-initialization-error}

This method is called when an error occurs while initializing the Synerise SDK.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-670">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-670-0" data-tab-group="tabgrp-670" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-670-1" data-tab-group="tabgrp-670">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-670-0" data-tab-group="tabgrp-670" data-tab-active="true">

```Swift
func snr_initializationError(error: Error) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-670-1" data-tab-group="tabgrp-670">

```Objective-C
- (void)SNR_initializationError:(NSError *)error
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **error** | NSError | The error that occurred. |

##### snr_registerForPushNotificationsIsNeeded() {id=synerise-delegate-register-for-push-notifications-is-needed}

This method is called when Synerise needs registration for push notifications.
  
See [Configuring push notifications](/developers/mobile-sdk/configuring-push-notifications/ios) for more details.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

After invoking this method, you must invoke the [Client.registerForPush(registrationToken:mobilePushAgreement:success:failure:)](/developers/mobile-sdk/method-reference/ios/campaigns#register-for-push-notifications) method again.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This method is invoked when the **snr_registerForPushNotificationsIsNeeded(origin:)** method is not implemented.

</div></div></div>



<div class="content-tabs code-tabs" data-tab-group="tabgrp-671">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-671-0" data-tab-group="tabgrp-671" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-671-1" data-tab-group="tabgrp-671">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-671-0" data-tab-group="tabgrp-671" data-tab-active="true">

```Swift
func snr_registerForPushNotificationsIsNeeded() -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-671-1" data-tab-group="tabgrp-671">

```Objective-C
- (void)SNR_registerForPushNotificationsIsNeeded
```

</div>
</div>


##### snr_registerForPushNotificationsIsNeeded(origin: PushNotificationsRegistrationOrigin) {id=synerise-delegate-register-for-push-notifications-is-needed-by-origin}

This method is called when Synerise needs registration for push notifications.
  
See [Configuring push notifications](/developers/mobile-sdk/configuring-push-notifications/ios) for more details.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

After invoking this method, you must invoke the [Client.registerForPush(registrationToken:mobilePushAgreement:success:failure:)](/developers/mobile-sdk/method-reference/ios/campaigns#register-for-push-notifications) method again.

</div></div></div>



<div class="content-tabs code-tabs" data-tab-group="tabgrp-672">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-672-0" data-tab-group="tabgrp-672" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-672-1" data-tab-group="tabgrp-672">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-672-0" data-tab-group="tabgrp-672" data-tab-active="true">

```Swift
func snr_registerForPushNotificationsIsNeeded(origin: PushNotificationsRegistrationOrigin) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-672-1" data-tab-group="tabgrp-672">

```Objective-C
- (void)SNR_registerForPushNotificationsIsNeededByOrigin:(SNRPushNotificationsRegistrationOrigin)origin
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **origin** | [PushNotificationsRegistrationOrigin](/developers/mobile-sdk/class-reference/ios/campaigns#pushnotificationsregistrationorigin) | Origin of the push notifications registration from the SDK. |

##### snr_handledAction(url: URL) {id=snr-handled-url-action}

This method is called when Synerise handles URL action from campaign activities.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This method is invoked when the **snr_handledAction(url:source:)** method is not implemented.

</div></div></div>



<div class="content-tabs code-tabs" data-tab-group="tabgrp-673">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-673-0" data-tab-group="tabgrp-673" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-673-1" data-tab-group="tabgrp-673">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-673-0" data-tab-group="tabgrp-673" data-tab-active="true">

```Swift
func snr_handledAction(url: URL) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-673-1" data-tab-group="tabgrp-673">

```Objective-C
- (void)SNR_handledActionWithURL:(NSURL *)url
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **url** | NSURL | URL value from the action of the activity. |

##### snr_handledAction(url: URL, source: SyneriseSource) {id=snr-handled-url-action-advanced-with-parameters}

This method is called when Synerise handles URL action from campaign activities.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-674">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-674-0" data-tab-group="tabgrp-674" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-674-1" data-tab-group="tabgrp-674">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-674-0" data-tab-group="tabgrp-674" data-tab-active="true">

```Swift
func snr_handledAction(url: URL, source: SyneriseSource) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-674-1" data-tab-group="tabgrp-674">

```Objective-C
- (void)SNR_handledActionWithURL:(NSURL *)url source:(SNRSyneriseSource)source
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **url** | NSURL | URL value from the action of the activity. |
| **source** | [SyneriseSource](/developers/mobile-sdk/class-reference/ios/campaigns#synerisesource) | Identifies Synerise campaign source ([SyneriseSource](/developers/mobile-sdk/class-reference/ios/campaigns#synerisesource)). |

##### snr_handledAction(url: URL, activity: SyneriseActivity, completionHandler: SyneriseActivityCompletionHandler) {id=snr-handled-url-action-advanced-with-parameters-deprecated}

This method is called when Synerise handles URL action from campaign activities.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This method was deprecated in SDK version 5.0.0.

</div></div></div>



<div class="content-tabs code-tabs" data-tab-group="tabgrp-675">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-675-0" data-tab-group="tabgrp-675" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-675-1" data-tab-group="tabgrp-675">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-675-0" data-tab-group="tabgrp-675" data-tab-active="true">

```Swift
func snr_handledAction(url: URL, activity: SyneriseActivity, completionHandler: SyneriseActivityCompletionHandler) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-675-1" data-tab-group="tabgrp-675">

```Objective-C
- (void)SNR_handledActionWithURL:(NSURL *)url activity:(SNRSyneriseActivity)activity completionHandler:(SNRSyneriseActivityCompletionHandler)completionHandler
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **url** | NSURL | URL value from the action of the activity. |
| **activity** | [SyneriseActivity](/developers/mobile-sdk/class-reference/ios/campaigns#syneriseactivity) | Identifies Synerise campaign activity ([SyneriseActivity](/developers/mobile-sdk/class-reference/ios/campaigns#syneriseactivity)). |
| **completionHandler** | [SyneriseActivityAction](/developers/mobile-sdk/class-reference/ios/campaigns#syneriseactivityaction) | A block/closure that should be invoked with [SyneriseActivityAction](/developers/mobile-sdk/class-reference/ios/campaigns#syneriseactivityaction) parameters and a completion block to execute. |

##### snr_handledAction(deepLink: String) {id=snr-handled-deeplink-action}

This method is called when Synerise handles deeplink action from campaign activities.  


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This method is invoked when the **snr_handledAction(deepLink:source:)** method is not implemented.

</div></div></div>



<div class="content-tabs code-tabs" data-tab-group="tabgrp-676">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-676-0" data-tab-group="tabgrp-676" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-676-1" data-tab-group="tabgrp-676">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-676-0" data-tab-group="tabgrp-676" data-tab-active="true">

```Swift
func snr_handledAction(deepLink: String) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-676-1" data-tab-group="tabgrp-676">

```Objective-C
- (void)SNR_handledActionWithDeepLink:(NSString *)deepLink
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **deepLink** | String | Deep link value from the action of the activity. |

##### snr_handledAction(deepLink: String, source: SyneriseSource) {id=snr-handled-deeplink-action-advanced-with-parameters}

This method is called when Synerise handles deeplink action from campaign activities.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-677">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-677-0" data-tab-group="tabgrp-677" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-677-1" data-tab-group="tabgrp-677">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-677-0" data-tab-group="tabgrp-677" data-tab-active="true">

```Swift
func snr_handledAction(deepLink: String, source: SyneriseSource) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-677-1" data-tab-group="tabgrp-677">

```Objective-C
- (void)SNR_handledActionWithDeepLink:(NSString *)deepLink source:(SNRSyneriseSource)source
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **deeplink** | String | Deep link value from the action of the activity. |
| **source** | [SyneriseSource](/developers/mobile-sdk/class-reference/ios/campaigns#synerisesource) | Identifies Synerise campaign source ([SyneriseActivity](/developers/mobile-sdk/class-reference/ios/campaigns#synerisesource)). |


##### snr_handledAction(deepLink: String, activity: SyneriseActivity, completionHandler: SyneriseActivityCompletionHandler) {id=snr-handled-deeplink-action-advanced-with-parameters-deprecated}

This method is called when Synerise handles deeplink action from campaign activities.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This method was deprecated in SDK version 5.0.0.

</div></div></div>



<div class="content-tabs code-tabs" data-tab-group="tabgrp-678">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-678-0" data-tab-group="tabgrp-678" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-678-1" data-tab-group="tabgrp-678">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-678-0" data-tab-group="tabgrp-678" data-tab-active="true">

```Swift
func snr_handledAction(deepLink: String, activity: SyneriseActivity, completionHandler: SyneriseActivityCompletionHandler) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-678-1" data-tab-group="tabgrp-678">

```Objective-C
- (void)SNR_handledActionWithDeepLink:(NSString *)deepLink activity:(SNRSyneriseActivity)activity completionHandler:(SNRSyneriseActivityCompletionHandler)completionHandler
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **deeplink** | String | Deep link value from the action of the activity. |
| **activity** | [SyneriseActivity](/developers/mobile-sdk/class-reference/ios/campaigns#syneriseactivity) | Identifies Synerise campaign activity ([SyneriseActivity](/developers/mobile-sdk/class-reference/ios/campaigns#syneriseactivity)). |
| **completionHandler** | [SyneriseActivityAction](/developers/mobile-sdk/class-reference/ios/campaigns#syneriseactivityaction) | A block/closure that should be invoked with parameters: [SyneriseActivityAction](/developers/mobile-sdk/class-reference/ios/campaigns#syneriseactivityaction) and completion block to execute. |

---
---

### NotificationDelegate {id=notification-delegate}

A delegate to handle events from Synerise notifications.
  
See [Configuring push notifications](/developers/mobile-sdk/configuring-push-notifications/ios#delegate-methods) for more details.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**NotificationDelegate** is available from 4.10.0 SDK version. All methods are optional.

</div></div></div>


To set your object as delegate, you must use [this method](/developers/mobile-sdk/method-reference/ios/campaigns#set-notification-delegate).


<div class="content-tabs code-tabs" data-tab-group="tabgrp-679">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-679-0" data-tab-group="tabgrp-679" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-679-1" data-tab-group="tabgrp-679">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-679-0" data-tab-group="tabgrp-679" data-tab-active="true">

```Swift
Synerise.setNotificationDelegate(YOUR_OBJECT)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-679-1" data-tab-group="tabgrp-679">

```Objective-C
[SNRSynerise setNotificationDelegate:YOUR_OBJECT];
```

</div>
</div>


##### snr_notificationDidReceive(notificationInfo: NotificationInfo) {id=notification-delegate-notification-did-receive}

This method is called when a Synerise notification is received.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-680">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-680-0" data-tab-group="tabgrp-680" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-680-1" data-tab-group="tabgrp-680">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-680-0" data-tab-group="tabgrp-680" data-tab-active="true">

```Swift
snr_notificationDidReceive(notificationInfo: NotificationInfo)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-680-1" data-tab-group="tabgrp-680">

```Objective-C
- (void)SNR_notificationDidReceive:(SNRNotificationInfo *)notificationInfo
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **notificationInfo** | [NotificationInfo](/developers/mobile-sdk/class-reference/ios/campaigns#notificationinfo) | Object providing information about the notification. |

##### snr_notificationDidDismiss(notificationInfo: NotificationInfo) {id=notification-delegate-notification-did-dismiss}

This method is called when a Synerise notification is dismissed.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-681">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-681-0" data-tab-group="tabgrp-681" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-681-1" data-tab-group="tabgrp-681">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-681-0" data-tab-group="tabgrp-681" data-tab-active="true">

```Swift
func snr_notificationDidDissmis(notificationInfo: NotificationInfo)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-681-1" data-tab-group="tabgrp-681">

```Objective-C
- (void)SNR_notificationDidDissmis:(SNRNotificationInfo *)notificationInfo
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **notificationInfo** | [NotificationInfo](/developers/mobile-sdk/class-reference/ios/campaigns#notificationinfo) | Object providing information about the notification. |

##### snr_notificationClicked(notificationInfo: NotificationInfo) {id=notification-delegate-notification-clicked}

This method is called when a Synerise notification is clicked.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-682">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-682-0" data-tab-group="tabgrp-682" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-682-1" data-tab-group="tabgrp-682">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-682-0" data-tab-group="tabgrp-682" data-tab-active="true">

```Swift
func snr_notificationClicked(notificationInfo: NotificationInfo)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-682-1" data-tab-group="tabgrp-682">

```Objective-C
- (void)SNR_notificationClicked:(SNRNotificationInfo *)notificationInfo
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **notificationInfo** | [NotificationInfo](/developers/mobile-sdk/class-reference/ios/campaigns#notificationinfo) | Object providing information about the notification. |

##### snr_notificationClicked(notificationInfo: NotificationInfo, actionButton: String) {id=notification-delegate-notification-clicked-with-button}

This method is called when an action button is clicked in a Synerise notification.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-683">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-683-0" data-tab-group="tabgrp-683" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-683-1" data-tab-group="tabgrp-683">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-683-0" data-tab-group="tabgrp-683" data-tab-active="true">

```Swift
func snr_notificationClicked(notificationInfo: NotificationInfo, actionButton: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-683-1" data-tab-group="tabgrp-683">

```Objective-C
- (void)SNR_notificationActionButtonClicked:(SNRNotificationInfo *)notificationInfo actionButton:(NSString *)actionButton
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **notificationInfo** | [NotificationInfo](/developers/mobile-sdk/class-reference/ios/campaigns#notificationinfo) | Object providing information about the notification. |
| **actionButton** | String | Text on the clicked action button. |

---
---

### ClientStateDelegate {id=client-state-delegate}
A delegate to handle customer's sign-in state changes.
  
To set your object as delegate, you must use [this method](/developers/mobile-sdk/method-reference/ios/client-authentication#set-client-state-delegate).


<div class="content-tabs code-tabs" data-tab-group="tabgrp-684">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-684-0" data-tab-group="tabgrp-684" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-684-1" data-tab-group="tabgrp-684">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-684-0" data-tab-group="tabgrp-684" data-tab-active="true">

```Swift
Client.setClientStateDelegate(YOUR_OBJECT)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-684-1" data-tab-group="tabgrp-684">

```Objective-C
[SNRClient setClientStateDelegate:YOUR_OBJECT];
```

</div>
</div>


##### snr_clientIsSignedIn() {id=client-state-delegate-client-is-signed-in}

This method is called when a customer signs in.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-685">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-685-0" data-tab-group="tabgrp-685" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-685-1" data-tab-group="tabgrp-685">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-685-0" data-tab-group="tabgrp-685" data-tab-active="true">

```Swift
func snr_clientIsSignedIn()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-685-1" data-tab-group="tabgrp-685">

```Objective-C
- (void)SNR_clientIsSignedIn
```

</div>
</div>


##### snr_clientIsSignedOut(reason: ClientSessionEndReason) {id=client-state-delegate-client-is-signed-out}

This method is called when a customer signs out.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-686">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-686-0" data-tab-group="tabgrp-686" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-686-1" data-tab-group="tabgrp-686">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-686-0" data-tab-group="tabgrp-686" data-tab-active="true">

```Swift
func snr_clientIsSignedOut(reason: ClientSessionEndReason)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-686-1" data-tab-group="tabgrp-686">

```Objective-C
- (void)SNR_clientIsSignedOutWithReason:(SNRClientSessionEndReason)reason
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **reason** | [ClientSessionEndReason](/developers/mobile-sdk/class-reference/ios/client#clientsessionendreason) | Specifies the reason for signing out. |

---
---

### InjectorInAppMessageDelegate {id=injector-in-app-message-delegate}
A delegate to handle the states of [in-app message](/developers/mobile-sdk/campaigns/in-app-message).


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**InjectorInAppMessageDelegate** is available from 4.6.0 SDK version.

</div></div></div>

  
To set your object as delegate, you must use [this method](/developers/mobile-sdk/method-reference/ios/campaigns#set-in-app-message-delegate).


<div class="content-tabs code-tabs" data-tab-group="tabgrp-687">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-687-0" data-tab-group="tabgrp-687" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-687-1" data-tab-group="tabgrp-687">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-687-0" data-tab-group="tabgrp-687" data-tab-active="true">

```Swift
Injector.setInAppMessageDelegate(YOUR_OBJECT)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-687-1" data-tab-group="tabgrp-687">

```Objective-C
[SNRInjector setInAppMessageDelegate:YOUR_OBJECT];
```

</div>
</div>


##### snr_shouldInAppMessageAppear(data: InAppMessageData) -> Bool {id=injector-in-app-message-delegate-should-in-app-message-appear}

This method is called after an in-app message is loaded and Synerise SDK asks for permission to show it.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-688">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-688-0" data-tab-group="tabgrp-688" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-688-1" data-tab-group="tabgrp-688">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-688-0" data-tab-group="tabgrp-688" data-tab-active="true">

```Swift
func snr_shouldInAppMessageAppear(data: InAppMessageData) -> Bool
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-688-1" data-tab-group="tabgrp-688">

```Objective-C
- (BOOL)SNR_shouldInAppMessageAppear:(SNRInAppMessageData *)data
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **data** | [InAppMessageData](/developers/mobile-sdk/class-reference/ios/campaigns#inappmessagedata) | Model representation of the in-app message. |

##### snr_inAppMessageDidAppear(data: InAppMessageData) {id=injector-in-app-message-delegate-in-app-message-did-appear}

This method is called after an in-app message appears.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-689">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-689-0" data-tab-group="tabgrp-689" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-689-1" data-tab-group="tabgrp-689">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-689-0" data-tab-group="tabgrp-689" data-tab-active="true">

```Swift
func snr_inAppMessageDidAppear(data: InAppMessageData)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-689-1" data-tab-group="tabgrp-689">

```Objective-C
- (void)SNR_inAppMessageDidAppear:(SNRInAppMessageData *)data
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **data** | [InAppMessageData](/developers/mobile-sdk/class-reference/ios/campaigns#inappmessagedata) | Model representation of the in-app message. |

##### snr_inAppMessageDidDisappear(data: InAppMessageData) {id=injector-in-app-message-delegate-in-app-message-did-disappear}

This method is called after an in-app message disappears.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-690">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-690-0" data-tab-group="tabgrp-690" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-690-1" data-tab-group="tabgrp-690">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-690-0" data-tab-group="tabgrp-690" data-tab-active="true">

```Swift
func snr_inAppMessageDidDisappear(data: InAppMessageData)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-690-1" data-tab-group="tabgrp-690">

```Objective-C
- (void)SNR_inAppMessageDidDisappear:(SNRInAppMessageData *)data
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **data** | [InAppMessageData](/developers/mobile-sdk/class-reference/ios/campaigns#inappmessagedata) | Model representation of the in-app message. |

##### snr_inAppMessageDidChangeSize(rect: CGRect) {id=injector-in-app-message-delegate-in-app-message-did-change-size}

This method is called when an in-app message changes its size.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-691">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-691-0" data-tab-group="tabgrp-691" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-691-1" data-tab-group="tabgrp-691">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-691-0" data-tab-group="tabgrp-691" data-tab-active="true">

```Swift
func snr_inAppMessageDidChangeSize(rect: CGRect)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-691-1" data-tab-group="tabgrp-691">

```Objective-C
- (void)SNR_inAppMessageDidChangeSize:(CGRect)rect
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **data** | [InAppMessageData](/developers/mobile-sdk/class-reference/ios/campaigns#inappmessagedata) | Model representation of the in-app message. |

##### snr_inAppMessageContextIsNeeded(data: InAppMessageData) -> [AnyHashable: Any]? {id=injector-in-app-message-delegate-in-app-message-context-is-needed}

This method is called when an individual context (for example a profile ID, an item SKU) for an in-app message is needed.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-692">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-692-0" data-tab-group="tabgrp-692" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-692-1" data-tab-group="tabgrp-692">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-692-0" data-tab-group="tabgrp-692" data-tab-active="true">

```Swift
func snr_inAppMessageContextIsNeeded(data: InAppMessageData) -> [AnyHashable: Any]?
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-692-1" data-tab-group="tabgrp-692">

```Objective-C
- (nullable NSDictionary *)SNR_inAppMessageContextIsNeeded:(SNRInAppMessageData *)data
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **data** | [InAppMessageData](/developers/mobile-sdk/class-reference/ios/campaigns#inappmessagedata) | Model representation of the in-app message. |

##### snr_inAppMessageHandledAction(data: InAppMessageData, deepLink: String) {id=injector-in-app-message-delegate-in-app-message-handled-deeplink-action}

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.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This method was renamed in 5.0.0 SDK version from `snr_inAppMessageHandledAction(data:deeplink:)`.

</div></div></div>



<div class="content-tabs code-tabs" data-tab-group="tabgrp-693">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-693-0" data-tab-group="tabgrp-693" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-693-1" data-tab-group="tabgrp-693">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-693-0" data-tab-group="tabgrp-693" data-tab-active="true">

```Swift
func snr_inAppMessageHandledAction(data: InAppMessageData, deepLink: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-693-1" data-tab-group="tabgrp-693">

```Objective-C
- (void)SNR_inAppMessageHandledDeeplinkAction:(SNRInAppMessageData *)data deepLink:(NSString *)deepLink
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **data** | [InAppMessageData](/developers/mobile-sdk/class-reference/ios/campaigns#inappmessagedata) | Model representation of the in-app message. |
| **deepLink** | String | Deep link value from the action of the activity. |

##### snr_inAppMessageHandledAction(data: InAppMessageData, url: URL) {id=injector-in-app-message-delegate-in-app-message-handled-url-action}

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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-694">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-694-0" data-tab-group="tabgrp-694" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-694-1" data-tab-group="tabgrp-694">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-694-0" data-tab-group="tabgrp-694" data-tab-active="true">

```Swift
func snr_inAppMessageHandledAction(data: InAppMessageData, url: URL)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-694-1" data-tab-group="tabgrp-694">

```Objective-C
- (void)SNR_inAppMessageHandledURLAction:(SNRInAppMessageData *)data url:(NSURL *)url
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **data** | [InAppMessageData](/developers/mobile-sdk/class-reference/ios/campaigns#inappmessagedata) | Model representation of the in-app message. |
| **url** | URL | URL value from the action of the activity. |

##### snr_inAppMessageHandledCustomAction(data: InAppMessageData, name: String, parameters: [AnyHashable: Any]) {id=injector-in-app-message-delegate-in-app-message-handled-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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-695">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-695-0" data-tab-group="tabgrp-695" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-695-1" data-tab-group="tabgrp-695">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-695-0" data-tab-group="tabgrp-695" data-tab-active="true">

```Swift
func snr_inAppMessageHandledCustomAction(data: InAppMessageData, name: String, parameters: [AnyHashable: Any])
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-695-1" data-tab-group="tabgrp-695">

```Objective-C
- (void)SNR_inAppMessageHandledCustomAction:(SNRInAppMessageData *)data name:(NSString *)name parameters:(NSDictionary *)parameters
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **data** | [InAppMessageData](/developers/mobile-sdk/class-reference/ios/campaigns#inappmessagedata) | Model representation of the in-app message. |
| **name** | String | Custom action name for identification. |
| **parameters** | [AnyHashable: Any] | Custom action parameters. |

---
---

### InjectorInlineInAppMessageDelegate {id=injector-inline-in-app-message-delegate}
A delegate to handle global events for [inline in-app messages](/developers/mobile-sdk/campaigns/in-app-message/inline-in-app).
  
To set your object as delegate, you must use [this method](/developers/mobile-sdk/method-reference/ios/campaigns#set-inline-in-app-message-delegate).


<div class="content-tabs code-tabs" data-tab-group="tabgrp-696">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-696-0" data-tab-group="tabgrp-696" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-696-1" data-tab-group="tabgrp-696">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-696-0" data-tab-group="tabgrp-696" data-tab-active="true">

```Swift
Injector.setInlineInAppMessageDelegate(YOUR_OBJECT)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-696-1" data-tab-group="tabgrp-696">

```Objective-C
[SNRInjector setInlineInAppMessageDelegate:YOUR_OBJECT];
```

</div>
</div>


##### snr_inlineInAppMessageDidBecomeAvailable(view: InlineInAppView, data: InlineInAppMessageData) {id=injector-inline-in-app-message-delegate-did-become-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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-697">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-697-0" data-tab-group="tabgrp-697" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-697-1" data-tab-group="tabgrp-697">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-697-0" data-tab-group="tabgrp-697" data-tab-active="true">

```Swift
func snr_inlineInAppMessageDidBecomeAvailable(view: InlineInAppView, data: InlineInAppMessageData)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-697-1" data-tab-group="tabgrp-697">

```Objective-C
- (void)SNR_inlineInAppMessageDidBecomeAvailable:(SNRInlineInAppView *)view data:(SNRInlineInAppMessageData *)data
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **view** | InlineInAppView | The ready-to-display inline in-app view. |
| **data** | InlineInAppMessageData | Inline in-app message data. |

##### snr_inlineInAppMessageContextIsNeeded(data: InlineInAppMessageData) -> [AnyHashable: Any]? {id=injector-inline-in-app-message-delegate-context-is-needed}

This method is called when a per-message context is needed for rendering.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-698">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-698-0" data-tab-group="tabgrp-698" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-698-1" data-tab-group="tabgrp-698">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-698-0" data-tab-group="tabgrp-698" data-tab-active="true">

```Swift
func snr_inlineInAppMessageContextIsNeeded(data: InlineInAppMessageData) -> [AnyHashable: Any]?
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-698-1" data-tab-group="tabgrp-698">

```Objective-C
- (nullable NSDictionary *)SNR_inlineInAppMessageContextIsNeeded:(SNRInlineInAppMessageData *)data
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **data** | InlineInAppMessageData | Inline in-app message data. |

##### snr_inlineInAppMessageHandledAction(data: InlineInAppMessageData, url: URL) {id=injector-inline-in-app-message-delegate-handled-url-action}

This method is called when the `SRInApp.openUrl(url)` method is used in an in-app message.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-699">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-699-0" data-tab-group="tabgrp-699" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-699-1" data-tab-group="tabgrp-699">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-699-0" data-tab-group="tabgrp-699" data-tab-active="true">

```Swift
func snr_inlineInAppMessageHandledAction(data: InlineInAppMessageData, url: URL)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-699-1" data-tab-group="tabgrp-699">

```Objective-C
- (void)SNR_inlineInAppMessageHandledURLAction:(SNRInlineInAppMessageData *)data url:(NSURL *)url
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **data** | InlineInAppMessageData | Inline in-app message data. |
| **url** | URL | The URL to open. |

##### snr_inlineInAppMessageHandledAction(data: InlineInAppMessageData, deepLink: String) {id=injector-inline-in-app-message-delegate-handled-deeplink-action}

This method is called when the `SRInApp.openDeeplink(url)` method is used in an in-app message.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-700">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-700-0" data-tab-group="tabgrp-700" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-700-1" data-tab-group="tabgrp-700">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-700-0" data-tab-group="tabgrp-700" data-tab-active="true">

```Swift
func snr_inlineInAppMessageHandledAction(data: InlineInAppMessageData, deepLink: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-700-1" data-tab-group="tabgrp-700">

```Objective-C
- (void)SNR_inlineInAppMessageHandledDeeplinkAction:(SNRInlineInAppMessageData *)data deepLink:(NSString *)deepLink
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **data** | InlineInAppMessageData | Inline in-app message data. |
| **deepLink** | String | The deep link value. |

##### snr_inlineInAppMessageHandledCustomAction(data: InlineInAppMessageData, name: String, parameters: [AnyHashable: Any]) {id=injector-inline-in-app-message-delegate-handled-custom-action}

This method is called when the `SRInApp.handleCustomAction(name, params)` method is used in an in-app message.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-701">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-701-0" data-tab-group="tabgrp-701" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-701-1" data-tab-group="tabgrp-701">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-701-0" data-tab-group="tabgrp-701" data-tab-active="true">

```Swift
func snr_inlineInAppMessageHandledCustomAction(data: InlineInAppMessageData, name: String, parameters: [AnyHashable: Any])
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-701-1" data-tab-group="tabgrp-701">

```Objective-C
- (void)SNR_inlineInAppMessageHandledCustomAction:(SNRInlineInAppMessageData *)data name:(NSString *)name parameters:(NSDictionary *)parameters
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **data** | InlineInAppMessageData | Inline in-app message data. |
| **name** | String | Custom action name. |
| **parameters** | [AnyHashable: Any] | Custom action parameters. |

##### snr_inlineInAppMessageHandledCustomMethod(data: InlineInAppMessageData, name: String, parameters: [AnyHashable: Any], completion: InAppCustomMethodCompletion) {id=injector-inline-in-app-message-delegate-handled-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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-702">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-702-0" data-tab-group="tabgrp-702" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-702-1" data-tab-group="tabgrp-702">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-702-0" data-tab-group="tabgrp-702" data-tab-active="true">

```Swift
func snr_inlineInAppMessageHandledCustomMethod(data: InlineInAppMessageData, name: String, parameters: [AnyHashable: Any], completion: InAppCustomMethodCompletion)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-702-1" data-tab-group="tabgrp-702">

```Objective-C
- (void)SNR_inlineInAppMessageHandledCustomMethod:(SNRInlineInAppMessageData *)data name:(NSString *)name parameters:(NSDictionary *)parameters completion:(SNRInAppCustomMethodCompletion *)completion
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **data** | InlineInAppMessageData | Inline in-app message data. |
| **name** | String | Custom method name. |
| **parameters** | [AnyHashable: Any] | Custom method parameters. |
| **completion** | InAppCustomMethodCompletion | Completion to resolve with `success()` or `failure()`. |

---
---

### InlineInAppViewDelegate {id=inline-in-app-view-delegate}
A per-component delegate to handle the lifecycle of an [inline in-app message](/developers/mobile-sdk/campaigns/in-app-message/inline-in-app) view.

##### snr_inlineInAppViewDidStartProcessing(view: InlineInAppView) {id=inline-in-app-view-delegate-did-start-processing}

This method is called when the SDK starts processing a campaign for this component.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-703">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-703-0" data-tab-group="tabgrp-703" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-703-1" data-tab-group="tabgrp-703">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-703-0" data-tab-group="tabgrp-703" data-tab-active="true">

```Swift
func snr_inlineInAppViewDidStartProcessing(view: InlineInAppView)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-703-1" data-tab-group="tabgrp-703">

```Objective-C
- (void)SNR_inlineInAppViewDidStartProcessing:(SNRInlineInAppView *)view
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **view** | InlineInAppView | The inline in-app view. |

##### snr_inlineInAppViewDidLoad(view: InlineInAppView, data: InlineInAppMessageData) {id=inline-in-app-view-delegate-did-load}

This method is called when the inline in-app message content is loaded for the first time.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-704">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-704-0" data-tab-group="tabgrp-704" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-704-1" data-tab-group="tabgrp-704">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-704-0" data-tab-group="tabgrp-704" data-tab-active="true">

```Swift
func snr_inlineInAppViewDidLoad(view: InlineInAppView, data: InlineInAppMessageData)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-704-1" data-tab-group="tabgrp-704">

```Objective-C
- (void)SNR_inlineInAppViewDidLoad:(SNRInlineInAppView *)view data:(SNRInlineInAppMessageData *)data
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **view** | InlineInAppView | The inline in-app view. |
| **data** | InlineInAppMessageData | Inline in-app message data. |

##### snr_inlineInAppViewDidUpdate(view: InlineInAppView, data: InlineInAppMessageData) {id=inline-in-app-view-delegate-did-update}

This method is called when the inline in-app message content is updated with a new campaign.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-705">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-705-0" data-tab-group="tabgrp-705" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-705-1" data-tab-group="tabgrp-705">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-705-0" data-tab-group="tabgrp-705" data-tab-active="true">

```Swift
func snr_inlineInAppViewDidUpdate(view: InlineInAppView, data: InlineInAppMessageData)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-705-1" data-tab-group="tabgrp-705">

```Objective-C
- (void)SNR_inlineInAppViewDidUpdate:(SNRInlineInAppView *)view data:(SNRInlineInAppMessageData *)data
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **view** | InlineInAppView | The inline in-app view. |
| **data** | InlineInAppMessageData | Inline in-app message data. |

##### snr_inlineInAppViewDidFail(view: InlineInAppView, error: Error) {id=inline-in-app-view-delegate-did-fail}

This method is called when the inline in-app message content fails to load or render.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-706">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-706-0" data-tab-group="tabgrp-706" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-706-1" data-tab-group="tabgrp-706">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-706-0" data-tab-group="tabgrp-706" data-tab-active="true">

```Swift
func snr_inlineInAppViewDidFail(view: InlineInAppView, error: Error)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-706-1" data-tab-group="tabgrp-706">

```Objective-C
- (void)SNR_inlineInAppViewDidFail:(SNRInlineInAppView *)view error:(NSError *)error
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **view** | InlineInAppView | The inline in-app view. |
| **error** | Error | The error that occurred. |

##### snr_inlineInAppViewChangeSizeIsNeeded(view: InlineInAppView, data: InlineInAppMessageData, size: InlineInAppSize) {id=inline-in-app-view-delegate-change-size-is-needed}

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, points, and as a fraction of the device screen.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-707">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-707-0" data-tab-group="tabgrp-707" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-707-1" data-tab-group="tabgrp-707">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-707-0" data-tab-group="tabgrp-707" data-tab-active="true">

```Swift
func snr_inlineInAppViewChangeSizeIsNeeded(view: InlineInAppView, data: InlineInAppMessageData, size: InlineInAppSize)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-707-1" data-tab-group="tabgrp-707">

```Objective-C
- (void)SNR_inlineInAppViewChangeSizeIsNeeded:(SNRInlineInAppView *)view data:(SNRInlineInAppMessageData *)data size:(SNRInlineInAppSize *)size
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **view** | InlineInAppView | The inline in-app view. |
| **data** | InlineInAppMessageData | Inline in-app message data. |
| **size** | InlineInAppSize | The requested size. Exposes `widthPx`/`heightPx` (physical pixels), `widthPt`/`heightPt` (points), and `widthScreenRatio`/`heightScreenRatio` (0..1 fraction of the screen). |

##### snr_inlineInAppViewShouldBeRemoved(view: InlineInAppView, data: InlineInAppMessageData) {id=inline-in-app-view-delegate-should-be-removed}

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.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-708">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-708-0" data-tab-group="tabgrp-708" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-708-1" data-tab-group="tabgrp-708">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-708-0" data-tab-group="tabgrp-708" data-tab-active="true">

```Swift
func snr_inlineInAppViewShouldBeRemoved(view: InlineInAppView, data: InlineInAppMessageData)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-708-1" data-tab-group="tabgrp-708">

```Objective-C
- (void)SNR_inlineInAppViewShouldBeRemoved:(SNRInlineInAppView *)view data:(SNRInlineInAppMessageData *)data
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **view** | InlineInAppView | The inline in-app view. |
| **data** | InlineInAppMessageData | Inline in-app message data. |

---
---

### TrackerDelegate {id=tracker-delegate}
A delegate to handle events from the Tracker.

To set your object as delegate, you must use [this method](/developers/mobile-sdk/method-reference/ios/tracking#set-tracker-delegate).


<div class="content-tabs code-tabs" data-tab-group="tabgrp-709">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-709-0" data-tab-group="tabgrp-709" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-709-1" data-tab-group="tabgrp-709">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-709-0" data-tab-group="tabgrp-709" data-tab-active="true">

```Swift
Tracker.setDelegate(YOUR_OBJECT)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-709-1" data-tab-group="tabgrp-709">

```Objective-C
[SNRTracker setDelegate:YOUR_OBJECT];
```

</div>
</div>


##### snr_locationUpdateRequired() {id=tracker-delegate-location-update-required}

This method is called when the Tracker module requests a location update.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-710">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-710-0" data-tab-group="tabgrp-710" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-710-1" data-tab-group="tabgrp-710">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-710-0" data-tab-group="tabgrp-710" data-tab-active="true">

```Swift
func snr_locationUpdateRequired()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-710-1" data-tab-group="tabgrp-710">

```Objective-C
- (void)SNR_locationUpdateRequired
```

</div>
</div>


---
---

### NotificationServiceExtensionDelegate {id=notification-service-extension-delegate}
A delegate to handle events from Notification Extension Service.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**NotificationServiceExtensionDelegate** is available from 4.0.0 SDK version.

</div></div></div>


To set your object as delegate, you must use this code in your Notification Service Extension.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-711">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-711-0" data-tab-group="tabgrp-711" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-711-1" data-tab-group="tabgrp-711">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-711-0" data-tab-group="tabgrp-711" data-tab-active="true">

```Swift
NotificationServiceExtension.setDelegate(YOUR_OBJECT)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-711-1" data-tab-group="tabgrp-711">

```Objective-C
[SNRNotificationServiceExtension setDelegate:YOUR_OBJECT];
```

</div>
</div>


##### notificationServiceExtensionDidFailDecryptionWithError(_: Error) {id=notification-service-extension-delegate-notification-service-extension-did-fail-decryption}

This method is called when the decryption process fails.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-712">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-712-0" data-tab-group="tabgrp-712" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-712-1" data-tab-group="tabgrp-712">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-712-0" data-tab-group="tabgrp-712" data-tab-active="true">

```Swift
func notificationServiceExtensionDidFailDecryptionWithError(_: Error)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-712-1" data-tab-group="tabgrp-712">

```Objective-C
- (void)notificationServiceExtensionDidFailDecryptionWithError:(NSError *)error
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **error** | NSError | The error that occurred |

##### notificationServiceExtensionDidFailProcessingWithError(_: Error) {id=notification-service-extension-delegate-notification-service-extension-did-fail-processing}

This method is called when the processing notification operation fails.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-713">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-713-0" data-tab-group="tabgrp-713" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-713-1" data-tab-group="tabgrp-713">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-713-0" data-tab-group="tabgrp-713" data-tab-active="true">

```Swift
func notificationServiceExtensionDidFailProcessingWithError(_: Error)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-713-1" data-tab-group="tabgrp-713">

```Objective-C
- (void)notificationServiceExtensionDidFailProcessingWithError:(NSError *)error
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **error** | NSError | The error that occurred |

---
---

### ContentWidgetDelegate {id=content-widget-delegate}
A delegate to handle [Content Widget](/developers/mobile-sdk/displaying-recommendations/content-widget) actions.
  
To set your object as delegate, you must use this code below.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-714">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-714-0" data-tab-group="tabgrp-714" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-714-1" data-tab-group="tabgrp-714">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-714-0" data-tab-group="tabgrp-714" data-tab-active="true">

```Swift
let widget = ContentWidget(options: widgetOptions, appearance: widgetAppearance)
widget.delegate = YOUR_OBJECT
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-714-1" data-tab-group="tabgrp-714">

```Objective-C
SNRContentWidget *widget = [SNRContentWidget initWithOptions:options andAppearance:appearance];
widget.delegate = YOUR_OBJECT;
```

</div>
</div>


##### snr_widgetDidLoad(widget: ContentWidget) {id=content-widget-delegate-widget-did-load}

This method is called after a widget is loaded.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-715">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-715-0" data-tab-group="tabgrp-715" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-715-1" data-tab-group="tabgrp-715">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-715-0" data-tab-group="tabgrp-715" data-tab-active="true">

```Swift
func snr_widgetDidLoad(widget: ContentWidget)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-715-1" data-tab-group="tabgrp-715">

```Objective-C
- (void)SNR_widgetDidLoad:(SNRContentWidget *)widget
```

</div>
</div>



| Parameter | Type | Description |
| --- | --- | --- |
| **widget** | [ContentWidget](/developers/mobile-sdk/class-reference/ios/content-widget#contentwidget) | The widget instance that called the delegate method. |

##### snr_widgetDidNotLoad(widget:ContentWidget error: Error) {id=content-widget-delegate-widget-did-not-load}

This method is called when an error occurs while loading a widget.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-716">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-716-0" data-tab-group="tabgrp-716" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-716-1" data-tab-group="tabgrp-716">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-716-0" data-tab-group="tabgrp-716" data-tab-active="true">

```Swift
func snr_widgetDidNotLoad(widget:ContentWidget error: Error)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-716-1" data-tab-group="tabgrp-716">

```Objective-C
- (void)SNR_widget:(SNRContentWidget *)widget didNotLoadWithError:(NSError *)error
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **widget** | [ContentWidget](/developers/mobile-sdk/class-reference/ios/content-widget) | The widget instance that called the delegate method. |
| **error** | NSError | The error that occurred. |

##### snr_widgetDidReceiveClickAction(widget:ContentWidget model: BaseModel) {id=content-widget-delegate-widget-did-receive-click-action}

This method is called when the customer clicks a widget’s item.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-717">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-717-0" data-tab-group="tabgrp-717" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-717-1" data-tab-group="tabgrp-717">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-717-0" data-tab-group="tabgrp-717" data-tab-active="true">

```Swift
func snr_widgetDidReceiveClickAction(widget:ContentWidget model: BaseModel)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-717-1" data-tab-group="tabgrp-717">

```Objective-C
- (void)SNR_widget:(SNRContentWidget *)widget didReceiveClickActionForModel:(SNRBaseModel *)model
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **widget** | [ContentWidget](/developers/mobile-sdk/class-reference/ios/content-widget) | The widget instance that called the delegate method. |
| **model** | BaseModel | The model's object that was clicked. |

##### snr_widgetIsLoading(widget: ContentWidget isLoading: Bool) {id=content-widget-delegate-widget-is-loading}

This method is called when the widget’s loading state changes.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-718">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-718-0" data-tab-group="tabgrp-718" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-718-1" data-tab-group="tabgrp-718">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-718-0" data-tab-group="tabgrp-718" data-tab-active="true">

```Swift
func snr_widgetIsLoading(widget: ContentWidget isLoading: Bool)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-718-1" data-tab-group="tabgrp-718">

```Objective-C
- (void)SNR_widget:(SNRContentWidget *)widget isLoading:(BOOL)isLoading
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **widget** | [ContentWidget](/developers/mobile-sdk/class-reference/ios/content-widget) | The widget instance that called the delegate method. |
| **isLoading** | Bool | Widget's loading state. |

##### snr_widgetDidChangeSize(widget: ContentWidget size: CGSize) {id=content-widget-delegate-widget-did-change-size}

This method is called when the widget’s size changes.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-719">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-719-0" data-tab-group="tabgrp-719" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-719-1" data-tab-group="tabgrp-719">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-719-0" data-tab-group="tabgrp-719" data-tab-active="true">

```Swift
func snr_widgetDidChangeSize(widget: ContentWidget size: CGSize)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-719-1" data-tab-group="tabgrp-719">

```Objective-C
- (void)SNR_widget:(SNRContentWidget *)widget didChangeToSize:(CGSize)size
```

</div>
</div>


| Parameter | Type | Description |
| --- | --- | --- |
| **widget** | [ContentWidget](/developers/mobile-sdk/class-reference/ios/content-widget) | The widget instance that called the delegate method. |
| **size** | CGSize | Widget's new size. |

---
---

### InjectorWalkthroughDelegate {id=injector-walkthrough-delegate}


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**InjectorWalkthroughDelegate** was removed in 5.0.0 SDK version.

</div></div></div>


---
---

### InjectorBannerDelegate {id=injector-banner-delegate}


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**InjectorBannerDelegate** was removed in 5.0.0 SDK version.

</div></div></div>




# Modules


### BaseModule
**Declared In:**  
lib/modules/base/base_module.dart  
  
**Declaration:**

<pre><code class="language-Dart">class BaseModule</code></pre>


---
---

### Settings
<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/notifications/settings_impl.dart 
  
**Declaration:**  

<pre><code class="language-Dart">class SettingsImpl</code></pre>


**Properties:**
| Property | Type | Description |
| --- | --- | --- |
| **sdk** | GeneralSettings | [General settings](/developers/mobile-sdk/settings#general) - This group contains options related to the general functioning of mobile SDK |
| **notifications** | NotificationsSettings | [Notifications settings](/developers/mobile-sdk/settings#notifications) - This group contains options related to push notifications |
| **tracker** | TrackerSettings | [Tracker](/developers/mobile-sdk/settings#tracker) - This group contains options related to tracking the customer activities in a mobile application |
| **inAppMessaging** | InAppMessagingSettings | [In-app messaging](/developers/mobile-sdk/settings#in-app-messaging) - This group contains options related to the [in-app messages](/docs/campaign/in-app-messages) feature |
| **injector** | InjectorSettings | [Injector](/developers/mobile-sdk/settings#injector) - This group contains options related to displaying [campaigns](/docs/campaign/Mobile) |

**Note:**  
Learn more about settings [here](/developers/mobile-sdk/settings)

<!-- reusable-table-boundary -->

---
---

### Notifications
**Declared In:**  
lib/modules/notifications/notifications_impl.dart 
  
**Declaration:**  

<pre><code class="language-Dart">class NotificationsImpl</code></pre>

  
**Listeners:**  
[NotificationsListener](/developers/mobile-sdk/listeners-and-delegates/flutter-listeners#notifications-listener) 
  
**Methods:**

This method passes the Firebase Token to Synerise for notifications.

<pre><code class="language-Dart">Future&lt;void&gt; registerForNotifications(String registrationToken, {bool? mobileAgreement, required void Function() onSuccess, required void Function(SyneriseError error) onError})</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/campaigns#register-for-push-notifications)

---

This method handles a notification payload and starts activity.

<pre><code class="language-Dart">Future&lt;bool&gt; handleNotification(Map notification) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/campaigns#handle-synerise-push-notification)

---

This method handles a notification payload with a user interaction and starts activity.

<pre><code class="language-Dart">Future&lt;bool&gt; handleNotificationClick(Map notification) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/campaigns#handle-synerise-push-notification-click)
    
---

This method verifies if a notification was sent by Synerise.

<pre><code class="language-Dart">Future&lt;bool&gt; isSyneriseNotification(Map notification) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/campaigns#check-if-push-notification-is-from-synerise)

---

This method verifies if a notification’s sender is Synerise and if the notification is a Simple Push campaign

<pre><code class="language-Dart">Future&lt;bool&gt; isSyneriseSimplePush(Map notification) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/campaigns#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 Banner campaign.

<pre><code class="language-Dart">Future&lt;bool&gt; isSyneriseBanner(Map notification) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/campaigns#check-if-push-notification-is-a-banner-campaign) - **REMOVED in version 2.0.0**

---

This method verifies if a notification's sender is Synerise and if the notification is a Silent Command.

<pre><code class="language-Dart">Future&lt;bool&gt; isSilentCommand(Map notification) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/campaigns#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 SDK Command.

<pre><code class="language-Dart">Future&lt;bool&gt; isSilentSDKCommand(Map notification) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/campaigns#check-if-push-notification-is-a-silent-sdk-command)

---
---

### Client
**Declared In:**  
lib/modules/client/client_impl.dart  
  
**Related To:**  
[ClientAccountRegisterContext](/developers/mobile-sdk/class-reference/flutter/client#clientaccountregistercontext)  
[ClientIdentityProvider](/developers/mobile-sdk/class-reference/flutter/client#clientidentityprovider)  
[ClientAuthContext](/developers/mobile-sdk/class-reference/flutter/client#clientauthcontext)  
[ClientConditionalAuthContext](/developers/mobile-sdk/class-reference/flutter/client#clientconditionalauthcontext) 
[ClientAccountInformation](/developers/mobile-sdk/class-reference/flutter/client#clientaccountinformation)  
[ClientAccountUpdateContext](/developers/mobile-sdk/class-reference/flutter/client#clientaccountupdatecontext)    
[ClientConditionalAuthResult](/developers/mobile-sdk/class-reference/flutter/client#clientconditionalauthresult)   
[ClientPasswordResetRequestContext](/developers/mobile-sdk/method-reference/flutter/client-account#request-password-reset-for-customer-account)  
[ClientPasswordResetConfirmationContext](/developers/mobile-sdk/method-reference/flutter/client-account#confirm-password-reset-for-customer-account)
[Token](/developers/mobile-sdk/class-reference/flutter/client#token)  
  
**Inherits From:**  
[BaseModule](/developers/mobile-sdk/class-reference/flutter/modules#basemodule)  
  
**Declaration:**

<pre><code class="language-Dart">class ClientImpl extends BaseModule</code></pre>


**Methods:**

This method registers a new customer with an email, password, and optional data.

<pre><code class="language-Dart">Future&lt;void&gt; registerAccount(ClientAccountRegisterContext context, {required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-authentication#register-customer-account)

---

This method confirms a customer account with the confirmation token.

<pre><code class="language-Dart">Future&lt;void&gt; confirmAccountActivation(String token, {required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-authentication#confirm-customer-account-activation)

---

This method activates a customer with email.

<pre><code class="language-Dart">Future&lt;void&gt; requestAccountActivation(String email, {required void Function() onSuccess, required void Function(SyneriseError error) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-authentication#request-customer-account-activation)

---

This method requests a customer's account registration process with the PIN code.

<pre><code class="language-Dart">Future&lt;void&gt; requestAccountActivationByPin(String email, {required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-authentication#request-customer-account-activation-by-pin)

---

This method confirms a customer's account registration process with the PIN code.

<pre><code class="language-Dart">Future&lt;void&gt; confirmAccountActivationByPin(String email, String pinCode, {required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-authentication#confirm-customer-account-activation-by-pin)

---

This method signs a customer in to obtain a JSON Web Token (JWT) which can be used in subsequent requests.

<pre><code class="language-Dart">Future&lt;void&gt; signIn(String email, String password, {required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-authentication#sign-in-a-customer)

---

This method signs a customer in to obtain a JSON Web Token (JWT) which can be used in subsequent requests.

<pre><code class="language-Dart">Future&lt;void&gt; signInConditionally(String email, String password, {required void Function(ClientConditionalAuthResult) onSuccess, required void Function(SyneriseError error) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-authentication#sign-in-a-customer-conditionally)

---

This method authenticates a customer with OAuth, Facebook, Google, Apple, or Synerise.

<pre><code class="language-Dart">Future&lt;void&gt; authenticate(ClientAuthContext clientAuthContext, IdentityProvider identityProvider, String tokenString, {required void Function(bool) onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-authentication#authenticate-customer-by-identityprovider)

---

This method authenticates a customer with OAuth, Facebook, Google, Apple, or Synerise.

<pre><code class="language-Dart">Future&lt;void&gt; authenticateConditionally(ClientConditionalAuthContext clientAuthContext, IdentityProvider identityProvider, String tokenString, {String? authID, required void Function(ClientConditionalAuthResult) onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-authentication#authenticate-customer-conditionally-by-identityprovider)

---

This method authenticates a customer with Simple Profile Authentication.

<pre><code class="language-Dart">Future&lt;void&gt; simpleAuthentication(ClientSimpleAuthenticationData data, String authID, {required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-authentication#authenticate-customer-via-simple-profile-authentication)

---

This method checks if a customer is signed in (via Synerise Authentication - RaaS, OAuth, Facebook, Apple).

<pre><code class="language-Dart">Future&lt;bool&gt; isSignedIn() async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-authentication#check-if-a-customer-is-signed-in-via-raas-oauth-facebook-apple)

---

This method checks if a customer is signed in (via Simple Profile Authentication).

<pre><code class="language-Dart">Future&lt;bool&gt; isSignedInViaSimpleAuthentication() async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-authentication#check-if-a-customer-is-signed-in-via-simple-profile-authentication)

---

This method signs out a customer out.

<pre><code class="language-Dart">Future&lt;void&gt; signOut() async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-authentication#sign-out-a-customer)

---

This method signs out a customer out with a chosen mode and Determines if the method should sign out all devices

<pre><code class="language-Dart">Future&lt;void&gt; signOutWithMode(ClientSignOutMode mode, bool fromAllDevices, {required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-authentication#sign-out-customer-with-mode-or-from-all-devices)

---

This method refreshes the customer’s current token.

<pre><code class="language-Dart">Future&lt;void&gt; refreshToken({required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-session#refresh-customer-token)

---

This method retrieves the customer’s current, active token.

<pre><code class="language-Dart">Future&lt;void&gt; retrieveToken({required void Function(Token) onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-session#retrieve-customer-token)

---

This method retrieves the customer’s current UUID.

<pre><code class="language-Dart">Future&lt;String&gt; getUUID() async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-session#get-current-customer-uuid)

---

This method regenerates the UUID and clears the authentication token, login session, custom email, and custom identifier.

<pre><code class="language-Dart">Future&lt;void&gt; regenerateUUID() async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-session#regenerate-customer)

---

This method regenerates the UUID and clears the authentication token, login session, custom email, and custom identifier.

<pre><code class="language-Dart">Future&lt;void&gt; regenerateUUIDWithClientIdentifier(String clientIdentifier) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-session#regenerate-customer-with-identifier)

---

This method destroys the session completely.

<pre><code class="language-Dart">Future&lt;void&gt; destroySession({required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-session#destroy-current-session)

---

This method gets a customer’s account information.

<pre><code class="language-Dart">Future&lt;void&gt; getAccount({required void Function(ClientAccountInformation) onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-account#get-customer-account-information)

---

This method updates a customer’s account’s basic information (without identification data: uuid, customId, email).

<pre><code class="language-Dart">Future&lt;void&gt; updateAccountBasicInformation(ClientAccountUpdateBasicInformationContext context, {required void Function() onSuccess, required void Function(SyneriseError error) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-account#update-customer-account-basic-information)

---

This method updates a customer’s account information.

<pre><code class="language-Dart">Future&lt;void&gt; updateAccount(ClientAccountUpdateContext context, {required void Function() onSuccess, required void Function(SyneriseError error) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-account#update-customer-account-information)

---

This method requests a customer’s password reset with email.

<pre><code class="language-Dart">Future&lt;void&gt; requestPasswordReset(String email, {required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-account#request-password-reset-for-customer-account)

---

This method confirm a customer’s password reset with the new password and token provided by password reset request.

<pre><code class="language-Dart">Future&lt;void&gt; confirmPasswordReset(String password, String token, {required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-account#confirm-password-reset-for-customer-account)

---

This method changes a customer’s password.

<pre><code class="language-Dart">Future&lt;void&gt; changePassword(String oldPassword, String newPassword, {required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-account#change-customers-account-password)

---

This method requests a customer's email change.

<pre><code class="language-Dart">Future&lt;void&gt; requestEmailChange(String email, String password, {String? externalToken, String? authID, required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-account#request-email-change-for-customer-account)

---

This method confirms an email change.

<pre><code class="language-Dart">Future&lt;void&gt; confirmEmailChange(String token, bool newsletterAgreement, {required void Function() onSuccess, required void Function(SyneriseError error) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-account#confirm-email-change-for-customer-account)

---

Requests a customer's phone update. A confirmation code is sent to the phone number.

<pre><code class="language-Dart">Future&lt;void&gt; requestPhoneUpdate(String phone, {required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-account#request-phone-update-on-customer-account)

---

This method confirms a phone number update. This action requires the new phone number and confirmation code as parameters.

<pre><code class="language-Dart">Future&lt;void&gt; confirmPhoneUpdate(String phone, String confirmationCode, bool smsAgreement, {required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-account#confirm-phone-update-on-customer-account)

---

This method deletes a customer's account.

<pre><code class="language-Dart">Future&lt;void&gt; deleteAccount(String clientAuthFactor, IdentityProvider identityProvider, {String? authId, required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/client-account#delete-customer-account)

---

---
---

### Tracker
**Declared In:**  
lib/modules/tracker/tracker_impl.dart  
  
**Related To:**  
[Event](/developers/mobile-sdk/class-reference/flutter/events#event)  
[CustomEvent](/developers/mobile-sdk/class-reference/flutter/events#customevent)  

**Inherits From:**  
[BaseModule](/developers/mobile-sdk/class-reference/flutter/modules#basemodule)  
  
**Declaration:**

<pre><code class="language-Dart">class TrackerImpl extends BaseModule</code></pre>


**Methods:**

This method sets a custom identifier in the parameters of every event.

<pre><code class="language-Dart">Future&lt;void&gt; setCustomIdentifier(String customIdentifier) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/tracking#set-custom-identifier-for-events)

---

This method sets a custom email in the parameters of every event.

<pre><code class="language-Dart">Future&lt;void&gt; setCustomEmail(String customEmail) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/tracking#set-custom-email-for-events)

---

This method sends an event.

<pre><code class="language-Dart">Future&lt;void&gt; send(Event event) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/tracking#send-event)

---

This method forces sending the events from the queue to the server.

<pre><code class="language-Dart">Future&lt;void&gt; flush() async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/tracking#flush-events-from-tracker)

---
---

### Injector
**Declared In:**   
lib/modules/injector/injector_impl.dart  
  
**Inherits From:**  
[BaseModule](/developers/mobile-sdk/class-reference/flutter/modules#basemodule)  
  
**Declaration:**

<pre><code class="language-Dart">class InjectorImpl extends BaseModule</code></pre>

  
**Listeners:**  
[InjectorListener](/developers/mobile-sdk/listeners-and-delegates/flutter-listeners#injector-listener)  
[InjectorInAppMessageListener](/developers/mobile-sdk/listeners-and-delegates/flutter-listeners#injector-in-app-message-listener)   
  
**Methods:**

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.

<pre><code class="language-dart">void closeInAppMessage(String campaignHash)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/campaigns#close-in-app-message)

---

This method fetches a walkthrough.

<pre><code class="language-Dart">void getWalkthrough() async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/campaigns#get-walkthrough) - **REMOVED in version 2.0.0**

---

This method shows a walkthrough when it is loaded.

<pre><code class="language-Dart">void showWalkthrough() async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/campaigns#show-walkthrough)- **REMOVED in version 2.0.0**

---

This method checks if a walkthrough is loaded.

<pre><code class="language-Dart">Future&lt;bool&gt; isWalkthroughLoaded() async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/campaigns#check-if-walkthrough-is-loaded)- **REMOVED in version 2.0.0**

---

This method checks if the walkthrough is unique compared to the previous one.

<pre><code class="language-Dart">Future&lt;bool&gt; isLoadedWalkthroughUnique() async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/campaigns#check-if-is-loaded-walkthrough-unique)- **REMOVED in version 2.0.0**

---
---

### Promotions
The module for handling promotions and vouchers from Synerise SDK.
  
**Declared In:**  
lib/modules/promotions/promotions_impl.dart

**Related To:**  
[PromotionResponse](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotionresponse)  
[Promotion](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotion)  
[AssignVoucherResponse](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#assignvoucherresponse)  
[VoucherCodesResponse](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#vouchercodesresponse)  
  
**Inherits From:**  
[Module](/developers/mobile-sdk/class-reference/flutter/modules#basemodule)  
  
**Declaration:**

<pre><code class="language-Dart">class PromotionsImpl extends BaseModule</code></pre>

  
**Methods:**

This method retrieves all available promotions that are defined for a customer.

<pre><code class="language-Dart">Future&lt;void&gt; getAllPromotions({required void Function(PromotionResponse promotionResponse) onSuccess, required void Function(SyneriseError error) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/promotions#get-all-promotions-of-a-customer)

---

This method retrieves promotions that match the parameters defined in an API query.

<pre><code class="language-Dart">Future&lt;void&gt; getPromotions(PromotionsApiQuery apiQuery, {required void Function(PromotionResponse promotionResponse) onSuccess, required void Function(SyneriseError error) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/promotions#get-promotions-with-query-parameters)

---

This method retrieves the promotion with the specified UUID.

<pre><code class="language-Dart">Future&lt;void&gt; getPromotionByUUID(String uuid, {required void Function(Promotion promotion) onSuccess, required void Function(SyneriseError error) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/promotions#get-promotion-by-uuid)

---

This method retrieves the promotion with the specified code.

<pre><code class="language-Dart">Future&lt;void&gt; getPromotionByCode(String code, {required void Function(Promotion promotion) onSuccess, required void Function(SyneriseError error) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/promotions#get-promotion-by-code)

---

This method activates the promotion with the specified UUID.

<pre><code class="language-Dart">Future&lt;void&gt; activatePromotionByUUID(String uuid, {required void Function() onSuccess, required void Function(SyneriseError error) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/promotions#activate-promotion-by-uuid)

---

This method activates the promotion with the specified code.

<pre><code class="language-Dart">Future&lt;void&gt; activatePromotionByCode(String code, {required void Function() onSuccess, required void Function(SyneriseError error) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/promotions#activate-promotion-by-code)

---

This method activates promotions with a code or with UUID in a batch.

<pre><code class="language-Dart">Future&lt;void&gt; activatePromotionsBatch(List&lt;PromotionIdentifier&gt; promotionsToActivate, {required void Function() onSuccess, required void Function(SyneriseError error) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/promotions#activate-promotions-in-a-batch)

---

This method deactivates the promotion with the specified UUID.

<pre><code class="language-Dart">Future&lt;void&gt; deactivatePromotionByUUID(String uuid, {required void Function() onSuccess, required void Function(SyneriseError error) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/promotions#deactivate-promotion-by-uuid)

---

This method deactivates the promotion with the specified code.

<pre><code class="language-Dart">Future&lt;void&gt; deactivatePromotionByCode(String code, {required void Function() onSuccess, required void Function(SyneriseError error) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/promotions#deactivate-promotion-by-code)

---

This method deactivates promotions with a code or with UUID in a batch.

<pre><code class="language-Dart">Future&lt;void&gt; deactivatePromotionsBatch(List&lt;PromotionIdentifier&gt; promotionsToDeactivate, {required void Function() onSuccess, required void Function(SyneriseError error) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/promotions#deactivate-promotions-in-a-batch)

---

This method retrieves an assigned voucher code or assigns a voucher from a pool identified by UUID to the profile.

When the voucher is assigned for the first time, a [voucherCode.assigned](/docs/assets/events/event-reference/loyalty#vouchercodeassigned) event is produced.

<pre><code class="language-Dart">Future&lt;void&gt; getOrAssignVoucher(String poolUuid, {required void Function(AssignVoucherResponse assignVoucherResponse) onSuccess, required void Function(SyneriseError error) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/promotions#get-or-assign-voucher-from-pool)

---

This method assigns a voucher from a pool identified by UUID to the profile.

A [voucherCode.assigned](/docs/assets/events/event-reference/loyalty#vouchercodeassigned) event is produced.

<pre><code class="language-Dart">Future&lt;void&gt; assignVoucherCode(String poolUuid, {required void Function(AssignVoucherResponse response) onSuccess, required void Function(SyneriseError error) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/promotions#assign-voucher-code-from-pool)

---

This method retrieves voucher codes for a customer.

<pre><code class="language-Dart">Future&lt;void&gt; getAssignedVoucherCodes({required void Function(VoucherCodesResponse voucherCodesResponse) onSuccess, required void Function(SyneriseError error) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/promotions#get-voucher-codes-assigned-to-customer)

---
---

### Content
The module for handling content from Synerise backend such as documents, recommendations, and so on.

**Declared In:**  
lib/modules/content/content_impl.dart  
  
**Related To:**  
[DocumentsApiQuery](/developers/mobile-sdk/class-reference/flutter/recommendations-and-documents#documentsapiquery)  
[Document](/developers/mobile-sdk/class-reference/flutter/recommendations-and-documents#document)  
[RecommendationResponse](/developers/mobile-sdk/class-reference/flutter/recommendations-and-documents#recommendationresponse)   
[RecommendationOptions](/developers/mobile-sdk/class-reference/flutter/recommendations-and-documents#recommendationoptions)  
[Recommendation](/developers/mobile-sdk/class-reference/flutter/recommendations-and-documents#recommendation)  
[ScreenView](/developers/mobile-sdk/class-reference/flutter/miscellaneous#screenview)  
[ScreenViewAudienceInfo](/developers/mobile-sdk/class-reference/flutter/miscellaneous#screenviewaudienceinfo)   
[ScreenViewApiQuery](/developers/mobile-sdk/class-reference/flutter/miscellaneous#screenviewapiquery)  
[BrickworksApiQuery](/developers/mobile-sdk/class-reference/flutter/miscellaneous#brickworksapiquery)
  
**Inherits From:**  
[BaseModule](/developers/mobile-sdk/class-reference/flutter/modules#basemodule)  
  
**Declaration:**

<pre><code class="language-Dart">class ContentImpl extends BaseModule</code></pre>

  
**Methods:**

This method generates the document assigned to a slug.

<pre><code class="language-Dart">Future&lt;void&gt; getDocuments(DocumentsApiQuery documentsApiQuery, {required void Function(List&lt;Map&lt;String, Object&gt;&gt; documentsList) onSuccess, required void Function(SyneriseError error) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/content#get-document) - **REMOVED in version 2.0.0 **


---

This method generates the document that is defined for the provided slug.

<pre><code class="language-Dart">Future&lt;void&gt; generateDocument(String slug, {required void Function(Document document) onSuccess, required void Function(SyneriseError error) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/content#generate-document)

---

This method generates the document that is defined for parameters provided in the query object.

<pre><code class="language-Dart">Future&lt;void&gt; generateDocumentWithApiQuery(DocumentApiQuery apiQuery, {required void Function(Document document) onSuccess, required void Function(SyneriseError error) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/content#generate-document-with-query-parameters)

---

This method generates documents that are defined for parameters provided in the query object.

<pre><code class="language-Dart">Future&lt;List&lt;Map&lt;String, Object&gt;&gt;&gt; getDocuments(DocumentsApiQuery documentsApiQueryModel) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/content#get-documents) - **REMOVED in version 2.0.0 **


---

This method generates recommendations that are defined for the options provided. The recommendations are generated by using a document with an insert.  

For instructions, see ["Displaying AI recommendations > With documents and screen views"](/developers/mobile-sdk/displaying-recommendations/documents).

<pre><code class="language-Dart">Future&lt;void&gt; getRecommendations(RecommendationOptions recommendationOptions, {required void Function(RecommendationResponse recommendationResponse) onSuccess, required void Function(SyneriseError error) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/content#get-recommendations) - **REMOVED in version 2.0.0 **


---

This method generates recommendations that are defined for the options provided. The recommendations are generated by using a document with an insert.  

For instructions, see ["Displaying AI recommendations > With documents and screen views"](/developers/mobile-sdk/displaying-recommendations/documents).

<pre><code class="language-Dart">Future&lt;void&gt; getRecommendationsV2(RecommendationOptions recommendationOptions, {required void Function(RecommendationResponse recommendationResponse) onSuccess, required void Function(SyneriseError error) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/content#get-recommendations-v2)

---

This method generates the customer's highest-priority screen view campaign.

<pre><code class="language-Dart">Future&lt;void&gt; getScreenView({required void Function(ScreenViewResponse screenViewResponse) onSuccess, required void Function(SyneriseError error) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/content#get-screen-view) - **REMOVED in version 2.0.0 **


---

This method generates a customer's highest-priority screen view campaign from the feed with the provided feed slug.

<pre><code class="language-Dart">Future&lt;void&gt; generateScreenView(String feedSlug, {required void Function(ScreenView screenView) onSuccess, required void Function(SyneriseError error) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/content#generate-screen-view)

---

This method generates customer's highest-priority screen view campaign that is defined for parameters provided in the query object.

<pre><code class="language-Dart">Future&lt;void&gt; generateScreenViewWithApiQuery(ScreenViewApiQuery apiQuery, {required void Function(ScreenView screenView) onSuccess, required void Function(SyneriseError error) onError}) async</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/flutter/content#generate-screen-view-with-query-parameters)

---



# Client


## ClientIdentityProvider
**Declared In:**  
lib/classes/models/Client/ClientIdentityProvider.js   
  
**Declaration:**  

<pre><code class="language-TypeScript">enum ClientIdentityProvider {
  Facebook = 'FACEBOOK',
  Google = 'GOOGLE',
  Oauth = 'OAUTH',
  Synerise = 'SYNERISE',
  Unknown = 'UNKNOWN',
}</code></pre>


**Functions:**

Converts from `ClientIdentityProvider` to string.

<pre><code class="language-TypeScript">function ClientIdentityProviderToString(clientIdentityProvider: ClientIdentityProvider): string</code></pre>


---

Converts from string to `ClientIdentityProvider`.

<pre><code class="language-TypeScript">function ClientIdentityProviderFromString(string: string): ClientIdentityProvider</code></pre>


---
---
## ClientAuthContext
<!-- reusable-table-boundary -->

**Declared In:**  
lib/classes/models/Client/ClientAuthContext.js  
  
**Related To:**  
[ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel)   
  
**Declaration:**

<pre><code class="language-TypeScript">interface IClientAuthContext {
  authID?: string;
  agreements?: IClientAgreements;
  attributes?: object;
}</code></pre>

  

<pre><code class="language-TypeScript">class ClientAuthContext extends BaseModel</code></pre>

  
**Properties:**  
Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements) | yes | nil | Object that stores all agreements of a customer |
| **attributes** | object | yes | [] | Additional custom attributes of a customer |
| **authID** | string | yes | [] | Optional identifier of authorization |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authID** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>

  
**Initializers:**  

<pre><code class="language-TypeScript">constructor(modelObject?: IClientAuthContext)</code></pre>


<!-- reusable-table-boundary -->

---
---

## ClientSimpleAuthenticationData
<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js  
  
**Related To:**  
[ClientSex](/developers/mobile-sdk/class-reference/react-native/client#clientsex)  
[ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel)  
  
**Declaration:**  

<pre><code class="language-TypeScript">class ClientSimpleAuthenticationData extends BaseModel</code></pre>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **email** | string | yes | Customer's email |
| **phone** | string | yes | Customer's phone |
| **customId** | string | yes | Customer's custom ID |
| **uuid** | string | yes | Customer's UUID |
| **firstName** | string | yes | Customer's first name |
| **lastName** | string | yes | Customer's last name |
| **displayName** | string | yes | Customer's display name |
| **sex** | [ClientSex](/developers/mobile-sdk/class-reference/react-native/client#clientsex) | yes | Customer's sex |
| **company** | string | yes | Customer's company |
| **address** | string | yes | Customer's address |
| **city** | string | yes | Customer's city |
| **province** | string | yes | Customer's province |
| **zipCode** | string | yes | Customer's ZIP code |
| **countryCode** | string | yes | Customer's country code |
| **birthDate** | string | yes | Customer's birthdate |
| **avatarUrl** | string | yes | Customer's avatar URL |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements) | yes | Customer's agreements |
| **attributes** | object | yes | Customer's attributes |

<!-- reusable-table-boundary -->

---
---

## ClientSessionEndReason
**Declared In:**  
lib/classes/models/Client/ClientSessionEndReason.js  
  
**Declaration:**  

<pre><code class="language-TypeScript">enum ClientSessionEndReason {
  NotSpecified = 'NOT_SPECIFIED',
  SessionExpiration = 'SESSION_EXPIRATION',
  SecurityException = 'SECURITY_EXCEPTION',
  UserSignOut = 'USER_SIGN_OUT',
  SystemSignOut = 'SYSTEM_SIGN_OUT',
  SessionDestroyed = 'SESSION_DESTROYED',
  ClientRejected = 'CLIENT_REJECTED',
  UserAccountDeleted = 'USER_ACCOUNT_DELETED'
}</code></pre>

  
**Functions:**

Converts from **ClientSessionEndReason** to **string**.

<pre><code class="language-TypeScript">function ClientSessionEndReasonToString(reason: ClientSessionEndReason): string</code></pre>


---

Converts from **string** to **ClientSessionEndReason**.

<pre><code class="language-TypeScript">function ClientSessionEndReasonFromString(string: string): ClientSessionEndReason</code></pre>


---
---

## ClientSignOutMode
**Declared In:**  
lib/classes/models/Client/ClientSignOutMode.js  
  
**Declaration:**  

<pre><code class="language-TypeScript">enum ClientSignOutMode {
  SignOut = 'SIGN_OUT',
  SignOutWithSessionDestroy = 'SIGN_OUT_WITH_SESSION_DESTROY'
}</code></pre>

  
**Functions:**

Converts from **ClientSignOutMode** to **string**.

<pre><code class="language-TypeScript">function ClientSignOutModeToString(mode: ClientSignOutMode): string</code></pre>


---
---

## ClientAccountInformation
<!-- reusable-table-boundary -->

Model representating the customer information.
  

<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This is a read-only class and it is not meant to be instantiated directly.

</div></div></div>

  
**Declared In:**  
lib/classes/models/Client/ClientAccountInformation.js   
  
**Related To:**
[ClientSex](/developers/mobile-sdk/class-reference/react-native/client#clientsex)  
[ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel)  
  
**Declaration:**  

<pre><code class="language-TypeScript">class ClientAccountInformation extends BaseModel</code></pre>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **clientId** | number | no | Customer's ID |
| **email** | string | no | Customer's email |
| **phone** | string | yes | Customer's phone |
| **customId** | string | yes | Customer's custom ID |
| **uuid** | string | no | Customer's UUID |
| **firstName** | string | yes | Customer's first name |
| **lastName** | string | yes | Customer's last name |
| **displayName** | string | yes | Customer's display name |
| **sex** | [ClientSex](/developers/mobile-sdk/class-reference/react-native/client#clientsex) | no | Customer's sex |
| **company** | string | yes | Customer's company |
| **address** | string | yes | Customer's address |
| **city** | string | yes | Customer's city |
| **province** | string | yes | Customer's province |
| **zipCode** | string | yes | Customer's ZIP code |
| **countryCode** | string | yes | Customer's country code |
| **birthDate** | string | yes | Customer's birthdate |
| **lastActivityDate** | Date | no | Customer's last activity date |
| **avatarUrl** | string | yes | Customer's avatar URL |
| **anonymous** | boolean | no | Customer's anonymous flag |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements) | no | Customer's agreements |
| **attributes** | Array<object> | yes | Customer's attributes |
| **tags** | Array<string> | yes | Customer's tags |

<!-- reusable-table-boundary -->

---
---

## ClientAccountUpdateBasicInformationContext
<!-- reusable-table-boundary -->

**Declared In:**  
lib/classes/models/Client/ClientAccountUpdateBasicInformationContext.js  
  
**Related To:**  
[ClientSex](/developers/mobile-sdk/class-reference/react-native/client#clientsex)  
[ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel)  
  
**Declaration:**

<pre><code class="language-TypeScript">class ClientAccountUpdateBasicInformationContext extends BaseModel</code></pre>

  
**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **firstName** | string | yes | Customer's first name |
| **lastName** | string | yes | Customer's last name |
| **displayName** | string | yes | Customer's display name |
| **sex** | [ClientSex](/developers/mobile-sdk/class-reference/react-native/client#clientsex) | yes | Customer's sex |
| **phone** | string | yes | Customer's phone number |
| **company** | string | yes | Customer's company |
| **address** | string | yes | Customer's address |
| **city** | string | yes | Customer's city |
| **province** | string | yes | Customer's province |
| **zipCode** | string | yes | Customer's ZIP code |
| **countryCode** | string | yes | Customer's country code |
| **birthDate** | string | yes | Customer's birthdate |
| **avatarUrl** | string | yes | Customer's avatar URL |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements) | no | Customer's agreements |
| **attributes** | object | yes | Customer's attributes |
  
**Initializers:**   

<pre><code class="language-TypeScript">constructor(modelObject?: IClientAccountUpdateBasicInformationContext)</code></pre>


<!-- reusable-table-boundary -->

---
---

## ClientAccountUpdateContext
<!-- reusable-table-boundary -->

**Declared In:**  
lib/classes/models/Client/ClientAccountUpdateContext.js  
  
**Related To:**  
[ClientSex](/developers/mobile-sdk/class-reference/react-native/client#clientsex)  
[ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel)  
  
**Declaration:**

<pre><code class="language-TypeScript">class ClientAccountUpdateContext extends BaseModel</code></pre>

  
**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **email** | string | yes | Customer's email |
| **customId** | string | yes | Customer's custom ID |
| **uuid** | string | yes | Customer's UUID |
| **firstName** | string | yes | Customer's first name |
| **lastName** | string | yes | Customer's last name |
| **displayName** | string | yes | Customer's display name |
| **sex** | [ClientSex](/developers/mobile-sdk/class-reference/react-native/client#clientsex) | yes | Customer's sex |
| **phone** | string | yes | Customer's phone number |
| **company** | string | yes | Customer's company |
| **address** | string | yes | Customer's address |
| **city** | string | yes | Customer's city |
| **province** | string | yes | Customer's province |
| **zipCode** | string | yes | Customer's ZIP code |
| **countryCode** | string | yes | Customer's country code |
| **birthDate** | string | yes | Customer's birthdate |
| **avatarUrl** | string | yes | Customer's avatar URL |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements) | no | Customer's agreements |
| **attributes** | object | yes | Customer's attributes |
  
**Initializers:**   

<pre><code class="language-TypeScript">constructor(modelObject?: IClientAccountUpdateContext)</code></pre>


<!-- reusable-table-boundary -->

---
---

## ClientAccountRegisterContext
<!-- reusable-table-boundary -->

**Declared In:**  
lib/classes/models/Client/ClientAccountRegisterContext.js  
  
**Related To:**  
[ClientSex](/developers/mobile-sdk/class-reference/react-native/client#clientsex)  
[ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel)  
  
**Declaration:**

<pre><code class="language-TypeScript">class ClientAccountRegisterContext extends BaseModel</code></pre>

  
**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **email** | string | no | Customer's email |
| **password** | string | no | Customer's password |
| **firstName** | string | yes | Customer's first name |
| **lastName** | string | yes | Customer's last name |
| **customId** | string | yes | Customer's custom ID |
| **sex** | [ClientSex](/developers/mobile-sdk/class-reference/react-native/client#clientsex) | yes | Customer's sex |
| **phone** | string | yes | Customer's phone |
| **company** | string | yes | Customer's company |
| **address** | string | yes | Customer's address |
| **city** | string | yes | Customer's city |
| **province** | string | yes | Customer's province code |
| **zipCode** | string | yes | Customer's ZIP code |
| **countryCode** | string | yes | Customer's country code |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements) | yes | Customer's agreements |
| **attributes** | object | yes | Customer's attributes |
  
**Initializers:**

<pre><code class="language-TypeScript">constructor(email: string, password: string, modelObject?: IClientAccountRegisterContext)</code></pre>


<!-- reusable-table-boundary -->

---
---

## ClientSex
**Declared In:**  
lib/classes/models/Client/ClientSex.js  
  
**Declaration:**  

<pre><code class="language-TypeScript">enum ClientSex {
  NotSpecified = 'NOT_SPECIFIED',
  Male = 'MALE',
  Female = 'FEMALE',
  Other = 'OTHER'
}</code></pre>

  
**Functions:**

Converts from **ClientSex** to **string**.

<pre><code class="language-TypeScript">function ClientSexToString(clientSex: ClientSex): string</code></pre>


---

Converts from **string** to **ClientSex**.

<pre><code class="language-TypeScript">function ClientSexFromString(string: string): ClientSex</code></pre>


---
---

## ClientAgreements
<!-- reusable-table-boundary -->

**Declared In:**  
lib/classes/models/Client/ClientAgreements.js  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel)  
  
**Declaration:**  

<pre><code class="language-TypeScript">interface IClientAgreements {
  email?: boolean;
  sms?: boolean;
  push?: boolean;
  bluetooth?: boolean;
  rfid?: boolean;
  wifi?: boolean;
}</code></pre>

  

<pre><code class="language-TypeScript">class ClientAgreements extends BaseModel</code></pre>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **email** | boolean | no | Email agreement |
| **sms** | boolean | no | SMS agreement |
| **push** | boolean | no | Push notifications agreement |
| **bluetooth** | boolean | no | Bluetooth agreement |
| **rfid** | boolean | no | RFID agreement |
| **wifi** | boolean | no | WIFI agreement |
  
**Initializers:**  

<pre><code class="language-TypeScript">constructor()</code></pre>



<pre><code class="language-TypeScript">constructor(modelObject?: IClientAgreements)</code></pre>


<!-- reusable-table-boundary -->

---
---

## Token
<!-- reusable-table-boundary -->

**Declared In:**  
lib/classes/models/Token/Token.js  
  
**Related To:**  
[TokenOrigin](/developers/mobile-sdk/class-reference/react-native/client#tokenorigin)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel)  
  
**Declaration:**

<pre><code class="language-TypeScript">class Token extends BaseModel</code></pre>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **tokenString** | string | no | Token as a raw string |
| **tokenOrigin** | [TokenOrigin](/developers/mobile-sdk/class-reference/react-native/client#tokenorigin) | no | Token's origin |
| **expirationDate** | string | yes | Token's expiration time |

<!-- reusable-table-boundary -->

---
---

## TokenOrigin
**Declared In:**  
lib/classes/models/Token/TokenOrigin.js  
  
**Declaration:**

<pre><code class="language-TypeScript">enum TokenOrigin {
  Unknown = 'UNKNOWN',
  Synerise = 'SYNERISE',
  Facebook = 'FACEBOOK',
  Oauth = 'OAUTH',
}</code></pre>

  
**Functions:**

Converts from **TokenOrigin** to **string**.

<pre><code class="language-TypeScript">function TokenOriginToString(tokenOrigin: TokenOrigin): string</code></pre>


---

Converts from **string** to **TokenOrigin**.

<pre><code class="language-TypeScript">function TokenOriginFromString(string: string): TokenOrigin</code></pre>


---
---

## Removed symbols
---

### <del>ClientOAuthAuthenticationContext</del>{#clientoauthauthenticationcontext}
<!-- reusable-table-boundary -->

| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.6.11 | 3.6.13 | 0.9.12 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | 1.0.0 | n/a |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/classes/models/Client/ClientOAuthAuthenticationContext.js  
  
**Related To:**  
[ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel)    
  
**Declaration:**

<pre><code class="language-TypeScript">interface IClientOAuthAuthenticationContext {
  authID?: string;
  agreements?: IClientAgreements;
  attributes?: object;
}</code></pre>



<pre><code class="language-TypeScript">class ClientOAuthAuthenticationContext extends BaseModel</code></pre>

  
**Properties:**
Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements) | yes | nil | Object that stores all agreements of a customer |
| **attributes** | object | yes | [] | Additional custom attributes of a customer |

**Initializers:**

<pre><code class="language-TypeScript">constructor()</code></pre>

  

<pre><code class="language-TypeScript">constructor(modelObject?: IClientOAuthAuthenticationContext)</code></pre>


<!-- reusable-table-boundary -->

---
---

### <del>ClientFacebookAuthenticationContext</del>{#clientfacebookauthenticationcontext}
<!-- reusable-table-boundary -->

| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.3.8 | 3.3.0 | 0.9.7 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | 1.0.0 | n/a |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/classes/models/Client/ClientOAuthAuthenticationContext.js  
  
**Related To:**  
[ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel)    
  
**Declaration:**

<pre><code class="language-TypeScript">interface IClientOAuthAuthenticationContext {
  authID?: string;
  agreements?: IClientAgreements;
  attributes?: object;
}</code></pre>



<pre><code class="language-TypeScript">class ClientOAuthAuthenticationContext extends BaseModel</code></pre>

  
**Properties:**
Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements) | yes | nil | Object that stores all agreements of a customer |
| **attributes** | object | yes | [] | Additional custom attributes of a customer |

**Initializers:**

<pre><code class="language-TypeScript">constructor()</code></pre>

  

<pre><code class="language-TypeScript">constructor(modelObject?: IClientOAuthAuthenticationContext)</code></pre>


<!-- reusable-table-boundary -->

---
---

### <del>ClientAppleSignInAuthenticationContext</del>{#clientapplesigninauthenticationcontext}
<!-- reusable-table-boundary -->

| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.6.11 | n/a | 0.9.12 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.7.6 | n/a | 0.9.19 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | n/a | 1.0.0 | n/a |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/classes/models/Client/ClientAppleSignInAuthenticationContext.js  
  
**Related To:**  
[ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements)    
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel)   
  
**Declaration:**

<pre><code class="language-TypeScript">interface IClientAppleSignInAuthenticationContext {
  authID?: string;
  agreements?: IClientAgreements;
  attributes?: object;
}</code></pre>



<pre><code class="language-TypeScript">class ClientAppleSignInAuthenticationContext extends BaseModel</code></pre>

  
**Properties:**  
Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/react-native/client#clientagreements) | yes | nil | Object that stores all agreements of a customer |
| **attributes** | object | yes | [] | Additional custom attributes of a customer |
  
**Initializers:**  

<pre><code class="language-TypeScript">constructor()</code></pre>


---


<pre><code class="language-TypeScript">constructor(modelObject?: IClientAppleSignInAuthenticationContext)</code></pre>


<!-- reusable-table-boundary -->


# Modules


### BaseModule
Main module abstract class for inheriting classes.
  
**Declared In:**  
lib/main/modules/BaseModule.js  
  
**Declaration:**  

<pre><code class="language-TypeScript">class BaseModule</code></pre>

  
---
---
  
### Settings
<!-- reusable-table-boundary -->

The module for managing the SDK settings.  
  
**Declared In:**  
lib/main/modules/SettingsModule.js  
  
**Inherits From:**  
[Module](/developers/mobile-sdk/class-reference/react-native/modules#basemodule)  
  
**Declaration:**

<pre><code class="language-TypeScript">class SettingsModule extends Module</code></pre>


**Properties:**
| Property | Type | Description |
| --- | --- | --- |
| **sdk** | ISettingsOptions | [General settings](/developers/mobile-sdk/settings#general) - This group contains options related to the general functioning of mobile SDK |
| **notifications** | ISettingsOptions | [Notifications settings](/developers/mobile-sdk/settings#notifications) - This group contains options related to push notifications |
| **tracker** | ISettingsOptions | [Tracker](/developers/mobile-sdk/settings#tracker) - This group contains options related to tracking the customer activities in a mobile application |
| **inAppMessaging** | ISettingsOptions | [In-app messaging](/developers/mobile-sdk/settings#in-app-messaging) - This group contains options related to the [in-app messages](/docs/campaign/in-app-messages) feature |
| **injector** | ISettingsOptions | [Injector](/developers/mobile-sdk/settings#injector) - This group contains options related to displaying [campaigns](/docs/campaign/Mobile) |
  
**Note:**  
Learn more about settings [here](/developers/mobile-sdk/settings)

<!-- reusable-table-boundary -->
  
---
---

### Notifications
The module for managing notifications.
  
**Declared In:**  
lib/main/modules/NotificationsModule.js  
  
**Inherits From:**  
[Module](/developers/mobile-sdk/class-reference/react-native/modules#basemodule)  
  
**Declaration:**

<pre><code class="language-TypeScript">class NotificationsModule extends Module</code></pre>

  
**Methods:**

This method sets an object for Notifications listener methods.

<pre><code class="language-TypeScript">public setListener(listener: INotificationsListener)</code></pre>

[(Click for more details)](/developers/mobile-sdk/listeners-and-delegates/react-native-listeners#notifications-listener)

---

This method passes the Firebase Token to Synerise for notifications.

<pre><code class="language-TypeScript">public registerForNotifications(registrationToken: string, mobileAgreement: boolean | null, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/campaigns#register-for-push-notifications)

---

This method verifies if a notification was sent by Synerise.

<pre><code class="language-TypeScript">public isSyneriseNotification(payload: object): boolean</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/campaigns#check-if-push-notification-is-from-synerise)

---

This method verifies if a notification’s sender is Synerise and if the notification is a Simple Push campaign

<pre><code class="language-TypeScript">public isSyneriseSimplePush(payload: object): boolean</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/campaigns#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 Banner campaign.

<pre><code class="language-TypeScript">public isSyneriseBanner(payload: object): boolean</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/campaigns#check-if-push-notification-is-a-banner-campaign) - **REMOVED in version 1.0.0**

---

This method verifies if a notification's sender is Synerise and if the notification is a Silent Command.

<pre><code class="language-TypeScript">public isSilentCommand(payload: object): boolean</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/campaigns#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 SDK Command.

<pre><code class="language-TypeScript">public isSilentSDKCommand(payload: object): boolean</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/campaigns#check-if-push-notification-is-a-silent-sdk-command)

---

This method verifies if a notification is encrypted.

<pre><code class="language-TypeScript">public isNotificationEncrypted(payload: object): boolean</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/campaigns#check-if-push-notification-is-encrypted)

---

This method decrypts the notification payload.

<pre><code class="language-TypeScript">public decryptNotification(payload: object): object | null</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/campaigns#decrypt-push-notification)

---

This method handles a notification payload with a user interaction and starts activity.

<pre><code class="language-TypeScript">public handleNotification(payload: object, actionIdentifier: string | null)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/campaigns#handle-synerise-push-notification)

---

---
---

### Client
The module for managing customer account data, registration, and authorization.

**Declared In:**  
lib/main/modules/ClientModule.js  
  
**Related To:**  
[ClientAccountRegisterContext](/developers/mobile-sdk/class-reference/react-native/client#clientaccountregistercontext)  
[ClientIdentityProvider](/developers/mobile-sdk/class-reference/react-native/client#clientidentityprovider)  
[ClientAuthContext](/developers/mobile-sdk/class-reference/react-native/client#clientauthcontext)  
[ClientOAuthAuthenticationContext](/developers/mobile-sdk/class-reference/react-native/client#clientoauthauthenticationcontext)  
[ClientFacebookAuthenticationContext](/developers/mobile-sdk/class-reference/react-native/client#clientfacebookauthenticationcontext)  
[ClientAppleSignInAuthenticationContext](/developers/mobile-sdk/class-reference/react-native/client#clientapplesigninauthenticationcontext)  
[ClientAccountInformation](/developers/mobile-sdk/class-reference/react-native/client#clientaccountinformation)  
[ClientAccountUpdateContext](/developers/mobile-sdk/class-reference/react-native/client#clientaccountupdatecontext)  
[Token](/developers/mobile-sdk/class-reference/react-native/client#token)  
  
**Inherits From:**  
[Module](/developers/mobile-sdk/class-reference/react-native/modules#basemodule)  
  
**Declaration:**  

<pre><code class="language-TypeScript">class ClientModule extends Module</code></pre>

  
**Methods:**

This method sets an object for customer's state listener methods.

<pre><code class="language-TypeScript">public setClientStateChangeListener(listener: IClientStateChangeListener)</code></pre>

[(Click for more details)](/developers/mobile-sdk/listeners-and-delegates/react-native-listeners#client-state-listener)

---

This method registers a new customer with an email, password, and optional data.

<pre><code class="language-TypeScript">public registerAccount(context: ClientAccountRegisterContext, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-authentication#register-customer-account)

---

This method confirms a customer account with the confirmation token.

<pre><code class="language-TypeScript">public confirmAccountActivation(token: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-authentication#confirm-customer-account-activation)

---

This method activates a customer with email.

<pre><code class="language-TypeScript">public requestAccountActivation(email: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-authentication#request-customer-account-activation)

---

This method signs a customer in to obtain a JSON Web Token (JWT) which can be used in subsequent requests.

<pre><code class="language-TypeScript">public signIn(email: string, password: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-authentication#sign-in-a-customer)

---

This method signs a customer in to obtain a JSON Web Token (JWT) which can be used in subsequent requests.

<pre><code class="language-TypeScript">public signInConditionally(email: string, password: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-authentication#sign-in-a-customer-conditionally)

---

This method authenticates a customer with OAuth, Facebook, Google, Apple, or Synerise.

<pre><code class="language-TypeScript">public authenticate(token: string, provider: ClientIdentityProvider, context: ClientAuthContext, onSuccess: (authResult: ClientConditionalAuthResult) =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-authentication#authenticate-customer-by-identityprovider)

---

This method authenticates a customer with OAuth, Facebook, Google, Apple, or Synerise.

<pre><code class="language-TypeScript">public authenticateConditionally(token: string, provider: ClientIdentityProvider, context: ClientAuthContext, onSuccess: (authResult: ClientConditionalAuthResult) =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-authentication#authenticate-customer-conditionally-by-identityprovider)

---

This method authenticates a customer with OAuth.

<pre><code class="language-TypeScript">public authenticateByOAuth(accessToken: string, context: ClientOAuthAuthenticationContext, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-authentication#authenticate-customer-by-oauth-with-registration) - **REMOVED in version 1.0.0**

---

This method authenticates a customer with OAuth.

<pre><code class="language-TypeScript">public authenticateByOAuthIfRegistered(accessToken: string, authID: string | null, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-authentication#authenticate-customer-by-oauth-without-registration) - **REMOVED in version 1.0.0**

---

This method authenticates a customer with Facebook.

<pre><code class="language-TypeScript">public authenticateByFacebook(facebookToken: string, context: ClientFacebookAuthenticationContext, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-authentication#authenticate-customer-by-facebook-with-registration) - **REMOVED in version 1.0.0**

---

This method authenticates a customer with Facebook.

<pre><code class="language-TypeScript">public authenticateByFacebookIfRegistered(facebookToken: string, authID: string | null, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-authentication#authenticate-customer-by-facebook-without-registration) - **REMOVED in version 1.0.0**

---

This method authenticates a customer with Sign In With Apple.

<pre><code class="language-TypeScript">public authenticateByAppleSignIn(identityToken: string, context: ClientAppleSignInAuthenticationContext, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-authentication#authenticate-customer-by-sign-in-with-apple-with-registration) - **REMOVED in version 1.0.0**

---

This method authenticates a customer with Sign In With Apple.

<pre><code class="language-TypeScript">public authenticateByAppleSignInIfRegistered(identityToken: string, authID: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-authentication#authenticate-customer-by-sign-in-with-apple-without-registration) - **REMOVED in version 1.0.0**

---

This method authenticates a customer with Simple Profile Authentication.

<pre><code class="language-TypeScript">public simpleAuthentication(data: ClientSimpleAuthenticationData, authID: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-authentication#authenticate-customer-via-simple-profile-authentication)

---

This method checks if a customer is signed in (via Synerise Authentication - RaaS, OAuth, Facebook, Apple).

<pre><code class="language-TypeScript">public isSignedIn(): boolean</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-authentication#check-if-a-customer-is-signed-in-via-raas-oauth-facebook-apple)

---

This method checks if a customer is signed in (via Simple Profile Authentication).

<pre><code class="language-TypeScript">public isSignedInViaSimpleAuthentication(): boolean</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-authentication#check-if-a-customer-is-signed-in-via-simple-profile-authentication)

---

This method signs out a customer out.

<pre><code class="language-TypeScript">public signOut()</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-authentication#sign-out-a-customer)

---

This method signs out a customer out with a chosen mode and Determines if the method should sign out all devices

<pre><code class="language-TypeScript">public signOutWithMode(mode: ClientSignOutMode, fromAllDevices: boolean, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-authentication#sign-out-customer-with-mode-or-from-all-devices)

---

This method refreshes the customer’s current token.

<pre><code class="language-TypeScript">public refreshToken(onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-session#refresh-customer-token)

---

This method retrieves the customer’s current, active token.

<pre><code class="language-TypeScript">public retrieveToken(onSuccess: (token: Token) =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-session#retrieve-customer-token)

---

This method retrieves the customer’s current UUID.

<pre><code class="language-TypeScript">public getUUID(): string</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-session#get-current-customer-uuid)

---

This method regenerates the UUID and clears the authentication token, login session, custom email, and custom identifier.

<pre><code class="language-TypeScript">public regenerateUUID()</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-session#regenerate-customer)

---

This method regenerates the UUID and clears the authentication token, login session, custom email, and custom identifier.

<pre><code class="language-TypeScript">public regenerateUUIDWithClientIdentifier(clientIdentifier: string)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-session#regenerate-customer-with-identifier)

---

This method destroys the session completely.

<pre><code class="language-TypeScript">public destroySession()</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-session#destroy-current-session)

---

This method gets a customer’s account information.

<pre><code class="language-TypeScript">public getAccount(onSuccess: (clientAccountInformation: ClientAccountInformation) =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-account#get-customer-account-information)

---

This method updates a customer’s account’s basic information (without identification data: uuid, customId, email).

<pre><code class="language-TypeScript">public updateAccountBasicInformation(context: ClientAccountUpdateBasicInformationContext, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-account#update-customer-account-basic-information)

---

This method updates a customer’s account information.

<pre><code class="language-TypeScript">public updateAccount(context: ClientAccountUpdateContext, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-account#update-customer-account-information)

---

This method requests a customer’s password reset with email.

<pre><code class="language-TypeScript">public requestPasswordReset(email: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-account#request-password-reset-for-customer-account)

---

This method confirm a customer’s password reset with the new password and token provided by password reset request.

<pre><code class="language-TypeScript">public confirmPasswordReset(password: string, token: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-account#confirm-password-reset-for-customer-account)

---

This method changes a customer’s password.

<pre><code class="language-TypeScript">public changePassword(oldPassword: string, newPassword: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-account#change-customers-account-password)

---

This method requests a customer's email change.

<pre><code class="language-TypeScript">public requestEmailChange(email: string, password: string | null, externalToken: string | null, authID: string | null, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-account#request-email-change-for-customer-account)

---

This method confirms an email change.

<pre><code class="language-TypeScript">public confirmEmailChange(token: string, newsletterAgreement: boolean, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-account#confirm-email-change-for-customer-account)

---

Requests a customer's phone update. A confirmation code is sent to the phone number.

<pre><code class="language-TypeScript">public requestPhoneUpdate(phone: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-account#request-phone-update-on-customer-account)

---

This method confirms a phone number update. This action requires the new phone number and confirmation code as parameters.

<pre><code class="language-TypeScript">public confirmPhoneUpdate(phone: string, confirmationCode: string, smsAgreement: boolean, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-account#confirm-phone-update-on-customer-account)

---

This method requests a customer's account registration process with the PIN code.

<pre><code class="language-TypeScript">public requestAccountActivationByPin(email: string, onSuccess: () =&gt; void, onError: (error: Error)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-authentication#request-customer-account-activation-by-pin)

---

This method confirms a customer's account registration process with the PIN code.

<pre><code class="language-TypeScript">public confirmAccountActivationByPin(pinCode: string, email: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-authentication#confirm-customer-account-activation-by-pin)

---

This method deletes a customer's account.

<pre><code class="language-TypeScript">public deleteAccountByIdentityProvider(clientAuthFactor: string, clientIdentityProvider: ClientIdentityProvider, authID: string | null, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-account#delete-customer-account-by-identity-provider)

---

This method deletes a customer's account.

<pre><code class="language-TypeScript">public deleteAccount(password: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-account#delete-customer-account)

---

This method deletes a customer's account by OAuth.

<pre><code class="language-TypeScript">public deleteAccountByOAuth(password: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-account#delete-customer-account-by-oauth)

---

This method deletes a customer's account by Facebook.

<pre><code class="language-TypeScript">public deleteAccountByFacebook(password: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/client-account#delete-customer-account-by-facebook)

---
---

### Tracker
The module for sending event tracking data to Synerise backend. Tracking is performed by creating pre-defined or custom event objects and sending these to Synerise. It also includes automatic event interception by the Auto-Tracking feature.
  
**Declared In:**  
lib/main/modules/TrackerModule.js  

**Related To:**  
[Event](/developers/mobile-sdk/class-reference/react-native/events#event)  

**Inherits From:**  
[Module](/developers/mobile-sdk/class-reference/react-native/modules#basemodule)  

**Declaration:**

<pre><code class="language-TypeScript">class TrackerModule extends Module</code></pre>

  
**Methods:**

This method sets a custom identifier in the parameters of every event.

<pre><code class="language-TypeScript">public setCustomIdentifier(identifier: string)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/tracking#set-custom-identifier-for-events)

---

This method sets a custom email in the parameters of every event.

<pre><code class="language-TypeScript">public setCustomEmail(email: string)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/tracking#set-custom-email-for-events)

---

This method sends an event.

<pre><code class="language-TypeScript">public send(event: Event)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/tracking#send-event)

---

This method forces sending the events from the queue to the server.

<pre><code class="language-TypeScript">public flushEvents(onSuccess: () =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/tracking#flush-events-from-tracker)

---
---

### Injector
The module for handling Synerise UI activities such as walkthrough, banner, simple push, and so on.
  
**Declared In:**  
lib/main/modules/InjectorModule.js  
  
**Inherits From:**  
[Module](/developers/mobile-sdk/class-reference/react-native/modules#basemodule)   
  
**Declaration:**  

<pre><code class="language-TypeScript">class InjectorModule extends Module</code></pre>

  
**Methods:**

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.

<pre><code class="language-typescript">public closeInAppMessage(campaignHash: string)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/campaigns#close-in-app-message)

---

This method sets an object for Injector listener methods.

<pre><code class="language-TypeScript">public setListener(listener: IInjectorListener)</code></pre>

[(Click for more details)](/developers/mobile-sdk/listeners-and-delegates/react-native-listeners#injector-listener)

---

This method sets an object for in-app message listener methods.

<pre><code class="language-TypeScript">public setInAppMessageListener(listener: IInjectorInAppMessageListener)</code></pre>

[(Click for more details)](/developers/mobile-sdk/listeners-and-delegates/react-native-listeners#injector-in-app-message-listener)

---

This method sets if banners should be shown or not.

<pre><code class="language-TypeScript">public setShouldBannerPresentFlag(shouldPresentBanner: boolean)</code></pre>


---

This method fetches banners set for mobile campaigns and caches the valid ones.

<pre><code class="language-TypeScript">public fetchBanners(onSuccess: (banners: Array&lt;Object&gt;) =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/campaigns#fetch-banners) - **REMOVED in 0.12.0**

---

This method provides valid banners directly from SDK cache.

<pre><code class="language-TypeScript">public getBanners(): Array&lt;Object&gt;</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/campaigns#get-banners) - **REMOVED in 0.12.0**

---

This method shows a banner immediately.

<pre><code class="language-TypeScript">public showBanner(banner: Object, markPresented: boolean)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/campaigns#show-banner) - **REMOVED in 0.12.0**

---

This method fetches a walkthrough.

<pre><code class="language-TypeScript">public getWalkthrough()</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/campaigns#get-walkthrough) - **REMOVED in version 1.0.0**

---

This method shows a walkthrough when it is loaded.

<pre><code class="language-TypeScript">public showWalkthrough()</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/campaigns#show-walkthrough) - **REMOVED in version 1.0.0**

---

This method checks if a walkthrough is loaded.

<pre><code class="language-TypeScript">public isWalkthroughLoaded(): boolean</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/campaigns#check-if-walkthrough-is-loaded) - **REMOVED in version 1.0.0**

---

This method checks if the walkthrough is unique compared to the previous one.

<pre><code class="language-TypeScript">public isLoadedWalkthroughUnique(): boolean</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/campaigns#check-if-is-loaded-walkthrough-unique) - **REMOVED in version 1.0.0**

---
---

### Promotions
The module for handling promotions and vouchers from Synerise SDK.
  
**Declared In:**  
lib/main/modules/PromotionsModule.js    
  
**Related To:**  
[PromotionResponse](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotionresponse)  
[Promotion](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotion)  
[AssignVoucherResponse](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#assignvoucherresponse)  
[VoucherCodesResponse](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#vouchercodesresponse)  
  
**Inherits From:**  
[Module](/developers/mobile-sdk/class-reference/react-native/modules#basemodule)  
  
**Declaration:**

<pre><code class="language-TypeScript">class PromotionsModule extends Module</code></pre>

  
**Methods:**

This method retrieves all available promotions that are defined for a customer.

<pre><code class="language-TypeScript">public getAllPromotions(onSuccess: (promotionResponse: PromotionResponse) =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/promotions#get-all-promotions-of-a-customer)

---

This method retrieves promotions that match the parameters defined in an API query.

<pre><code class="language-TypeScript">public getPromotions(apiQuery: PromotionsApiQuery, onSuccess: (promotionResponse: PromotionResponse) =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/promotions#get-promotions-with-query-parameters)

---

This method retrieves the promotion with the specified UUID.

<pre><code class="language-TypeScript">public getPromotionByUUID(uuid: string, onSuccess: (promotion: Promotion) =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/promotions#get-promotion-by-uuid)

---

This method retrieves the promotion with the specified code.

<pre><code class="language-TypeScript">public getPromotionByCode(code: string, onSuccess: (promotion: Promotion) =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/promotions#get-promotion-by-code)

---

This method activates the promotion with the specified UUID.

<pre><code class="language-TypeScript">public activatePromotionByUUID(uuid: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/promotions#activate-promotion-by-uuid)

---

This method activates the promotion with the specified code.

<pre><code class="language-TypeScript">public activatePromotionByCode(code: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/promotions#activate-promotion-by-code)

---

This method activates promotions with a code or with UUID in a batch.

<pre><code class="language-TypeScript">public activatePromotionsBatch(promotionsIdentifiers: Array&lt;PromotionIdentifier&gt;, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/promotions#activate-promotions-in-a-batch)

---

This method deactivates the promotion with the specified UUID.

<pre><code class="language-TypeScript">public deactivatePromotionByUUID(uuid: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/promotions#deactivate-promotion-by-uuid)

---

This method deactivates the promotion with the specified code.

<pre><code class="language-TypeScript">public deactivatePromotionByCode(code: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/promotions#deactivate-promotion-by-code)

---

This method deactivates promotions with a code or with UUID in a batch.

<pre><code class="language-TypeScript">public deactivatePromotionsBatch(promotionsIdentifiers: Array&lt;PromotionIdentifier&gt;, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/promotions#deactivate-promotions-in-a-batch)

---

This method retrieves an assigned voucher code or assigns a voucher from a pool identified by UUID to the profile.

When the voucher is assigned for the first time, a [voucherCode.assigned](/docs/assets/events/event-reference/loyalty#vouchercodeassigned) event is produced.

<pre><code class="language-TypeScript">public getOrAssignVoucher(poolUuid: string, onSuccess: (assignVoucherRespone: AssignVoucherResponse) =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/promotions#get-or-assign-voucher-from-pool)

---

This method assigns a voucher from a pool identified by UUID to the profile.

A [voucherCode.assigned](/docs/assets/events/event-reference/loyalty#vouchercodeassigned) event is produced.

<pre><code class="language-TypeScript">public assignVoucherCode(poolUuid: string, onSuccess: (assignVoucherRespone: AssignVoucherResponse) =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/promotions#assign-voucher-code-from-pool)

---

This method retrieves voucher codes for a customer.

<pre><code class="language-TypeScript">public getAssignedVoucherCodes(onSuccess: (voucherCodesResponse: VoucherCodesResponse) =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/promotions#get-voucher-codes-assigned-to-customer)

---
---

### Content
The module for handling content from Synerise backend such as documents, recommendations, and so on.
  
**Declared In:**  
lib/main/modules/ContentModule.js  
  
**Related To:**  
[RecommendationResponse](/developers/mobile-sdk/class-reference/react-native/recommendations-and-documents#recommendationresponse)  
[Recommendation](/developers/mobile-sdk/class-reference/react-native/recommendations-and-documents#recommendation)  
[DocumentApiQuery](/developers/mobile-sdk/class-reference/react-native/recommendations-and-documents#documentapiquery)  
[ScreenViewApiQuery](/developers/mobile-sdk/class-reference/react-native/miscellaneous#screenviewapiquery)
[BrickworksApiQuery](/developers/mobile-sdk/class-reference/react-native/miscellaneous#brickworksapiquery)
  
**Inherits From:**  
[Module](/developers/mobile-sdk/class-reference/react-native/modules#basemodule)   
  
**Declaration:**

<pre><code class="language-TypeScript">class ContentModule extends Module</code></pre>

  
**Methods:**

---

This method generates the document assigned to a slug.

<pre><code class="language-TypeScript">public getDocument(slug: string, onSuccess: (document: object) =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/content#get-document) - **REMOVED in version 1.0.0**

---

This method generates the document that is defined for the provided slug.

<pre><code class="language-TypeScript">public generateDocument(slug: string, onSuccess: (document: Document) =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/content#generate-document)

---

This method generates the document that is defined for the provided slug.

<pre><code class="language-TypeScript">public generateDocumentWithApiQuery(slug: string, onSuccess: (document: Document) =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/content#generate-document-with-query-parameters)

---

This method generates documents that are defined for parameters provided in the query object.

<pre><code class="language-TypeScript">public getDocuments(apiQuery: DocumentsApiQuery, onSuccess: (documents: Array&lt;object&gt;) =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/content#get-documents) - **REMOVED in version 1.0.0**

---

This method generates recommendations that are defined for the options provided. The recommendations are generated by using a document with an insert.  

For instructions, see ["Displaying AI recommendations > With documents and screen views"](/developers/mobile-sdk/displaying-recommendations/documents).

<pre><code class="language-TypeScript">public getRecommendations(options: RecommendationOptions, onSuccess: (recommendationResponse: RecommendationResponse) =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/content#get-recommendations) - **REMOVED in version 1.0.0**

---

This method generates recommendations that are defined for the options provided. The recommendations are generated by using a document with an insert.  

For instructions, see ["Displaying AI recommendations > With documents and screen views"](/developers/mobile-sdk/displaying-recommendations/documents).

<pre><code class="language-TypeScript">public getRecommendationsV2(options: RecommendationOptions, onSuccess: (recommendationResponse: RecommendationResponse) =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/content#get-recommendations-v2)

---

This method generates the customer's highest-priority screen view campaign.

<pre><code class="language-TypeScript">public getScreenView(onSuccess: (screenViewResponse: ScreenViewResponse) =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/content#get-screen-view) - **REMOVED in version 1.0.0**

---

This method generates a customer's highest-priority screen view campaign from the feed with the provided feed slug.

<pre><code class="language-TypeScript">public generateScreenView(slug: String, onSuccess: (screenView: ScreenView) =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/content#generate-screen-view)

---

This method generates a customer's highest-priority screen view campaign from the feed with the provided feed slug.

<pre><code class="language-TypeScript">public generateScreenViewWithApiQuery(apiQuery: ScreenViewApiQuery, onSuccess: (screenView: ScreenView) =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

[(Click for more details)](/developers/mobile-sdk/method-reference/react-native/content#generate-screen-view-with-query-parameters)

---


# Public interfaces


## IDataApiCall
---
IDataApiCall is a public interface used to execute requests with parameterized objects.

**Java**:

<pre><code class="language-java">public interface IDataApiCall&lt;T&gt; {
/**
     * It is recommended to call the {@link #cancel()} method before next execution.
     *
     * @param onSuccessListener callback with response
     * @param onFailureListener callback with Throwable instance
     */
    void execute(@NonNull DataActionListener&lt;T&gt; onSuccessListener, @NonNull DataActionListener&lt;ApiError&gt; onFailureListener);
    /**
     * Cancels the API request, therefore no response will be provided nor callback fired. &lt;br&gt;
     * It is recommended to call this method when an activity/fragment is being stopped.
     */
    void cancel();
    /**
     * Specify a reactive Scheduler for your request. &lt;br&gt;
     * By default, all internal methods use the {@link Schedulers#io()} scheduler.
     * See {@link io.reactivex.schedulers.Schedulers} factory for more info.
     *
     * @param scheduler reactive scheduler.
     */
    BasicDataApiCall&lt;T&gt; subscribeOn(Scheduler scheduler);
    /**
     * Specify your action when the request is being subscribed. This action will be fired just before calling the API.
     *
     * @param onSubscribeListener callback
     */
    BasicDataApiCall&lt;T&gt; onSubscribe(ActionListener onSubscribeListener);
    /**
     * Specify your action when the request succeeds, fails, or is cancelled.
     *
     * @param doFinallyListener callback
     */
    BasicDataApiCall&lt;T&gt; doFinally(ActionListener doFinallyListener);
    /**
     * Get the original reactive observable to chain your requests.&lt;br&gt;
     * Note that some of the SDK methods not only wrap observables in IDataApiCall,
     * but also add some extra logic, which shouldn't be skipped.&lt;br&gt;
     *
     * @return original reactive observable.
     */
    Observable&lt;T&gt; getObservable();
}</code></pre>


## IApiCall
---
IApiCall is a public interface used to execute requests.

**Java**:

<pre><code class="language-java">public interface IApiCall&lt;T&gt; {
    /**
     * It is recommended to call the {@link #cancel()} method before next execution.
     *
     * @param onSuccessListener successful callback with no response
     * @param onFailureListener callback with Throwable instance
     */
    void execute(@NonNull ActionListener onSuccessListener, @NonNull DataActionListener&lt;ApiError&gt; onFailureListener);
    /**
     * Cancels the API request, therefore no response will be provided nor callback fired. &lt;br&gt;
     * It is recommended to call this method when an activity/fragment is being stopped.
     */
    void cancel();
    /**
     * Specify a reactive Scheduler for your request. &lt;br&gt;
     * By default, all internal methods use the {@link Schedulers#io()} scheduler.
     * See {@link io.reactivex.schedulers.Schedulers} factory for more info.
     *
     * @param scheduler reactive scheduler.
     */
    BasicApiCall&lt;T&gt; subscribeOn(Scheduler scheduler);
    /**
     * Specify your action when the request is being subscribed. This action will be fired just before calling API.
     *
     * @param onSubscribeListener callback.
     */
    BasicApiCall&lt;T&gt; onSubscribe(ActionListener onSubscribeListener);
    /**
     * Specify your action when the request succeeds, fails, or is cancelled.
     *
     * @param doFinallyListener callback.
     */
    BasicApiCall&lt;T&gt; doFinally(ActionListener doFinallyListener);
    /**
     * Get the original reactive observable to chain your requests.&lt;br&gt;
     * Note that some of SDK methods not only wrap observables in IApiCall,
     * but also add some extra logic, which shouldn't be skipped.&lt;br&gt;
     *
     * @return original reactive observable.
     */
    Observable&lt;T&gt; getObservable();
}</code></pre>



# iOS

## Content Widget (iOS)

Content widget is a feature in the Software Development Kit that allows you to embed an easily customizable view with [recommendations](/docs/ai-hub/recommendations-v2) in your application.

Two view layouts are available:

- Horizontal slider - a single row view that slides horizontally on the screen.
- Grid view - can be displayed as full- or half-screen grid layout within your app.

Both views offer a number of configuration options that allow you to style the view consistently in the app. Additionally, the Content widget automatically tracks 4 events:

- `recommendation.seen` or `recommendation.view` (depending on configuration) sent when a recommended item is visible to the customer.
<figure><img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/developers/mobile-sdk/_gfx/recommendation-seen.png" alt="Recommendation.seen event" class="large"><figcaption>Recommendation.seen event</figcaption></figure>

- `recommendation.click` sent when a customer clicks the recommended item.
<figure><img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/developers/mobile-sdk/_gfx/recommendation-click.png" alt="Recommendation.click event" class="large"><figcaption>Recommendation.click event</figcaption></figure>

- `product.like` sent when a customer clicks a selectable button in the recommendation. (The button must be added)
<figure><img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/developers/_gfx/add-to-favourites-event.png" alt="Event sent when a user clicks the "like" button on an item" class="large"><figcaption>Event sent when a user clicks the "like" button on an item</figcaption></figure>

- `product.dislike` sent when a customer clicks a selectable button in the recommendation a second time. (The button must be added)
<figure><img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/developers/mobile-sdk/_gfx/product-dislike.png" alt="Product.dislike event" class="large"><figcaption>Product.dislike event</figcaption></figure>


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Currently, the widget can only be used for displaying AI recommendations.

</div></div></div>


### Prerequisites
---

To use the content widget feature, you must:
- Obtain a customer token from [Customer Authentication](/developers/mobile-sdk/user-identification-and-authorization/overview#authenticated-customers).
- [Create an AI Recommendation](/docs/ai-hub/recommendations-v2).
- [Create a document](/docs/assets/documents).  
    Such a document should contain the following content:
    
  <pre><code class="language-json">{
      "name": "Similar Products",
      "recommendations": "{% recommendations_json3 campaignId=COhsCCOdu8Cg %} {% endrecommendations_json3 %}"
  }</code></pre>


- In the notepad, save the document's slug and the ID of the recommendation for later use.



<div class="admonition admonition-tip"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M9.663 17h4.673M12 3v1m6.364 1.636l-.707.707M21 12h-1M4 12H3m3.343-5.657l-.707-.707m2.828 9.9a5 5 0 117.072 0l-.548.547A3.374 3.374 0 0014 18.469V19a2 2 0 11-4 0v-.531c0-.895-.356-1.754-.988-2.386l-.548-.547z" /></svg></div><div class="admonition-body"><div class="admonition-content">

It's a good practice to name slugs based on the area of the app that you want to place the content in, for example `product-details`, `menu`, and so on.

</div></div></div>


### Basic implementation
---

Configure the [`ContentWidgetOptions`](/developers/mobile-sdk/class-reference/ios/content-widget#contentwidgetoptions) and [`ContentWidgetAppearance`](/developers/mobile-sdk/class-reference/ios/content-widget#contentwidgetappearance) settings first.

| Class | Description |
| --- | --- |
| [`ContentWidgetOptions`](/developers/mobile-sdk/class-reference/ios/content-widget#contentwidgetoptions) | [`ContentWidgetOptions`](/developers/mobile-sdk/class-reference/ios/content-widget#contentwidgetoptions) contains options for business logic, such as the slug, product identifier, and so on. [Read more](#options). |
| [`ContentWidgetAppearance`](/developers/mobile-sdk/class-reference/ios/content-widget#contentwidgetappearance) | [`ContentWidgetAppearance`](/developers/mobile-sdk/class-reference/ios/content-widget#contentwidgetappearance) contains the UI configuration. [Read more](#options). |

The example below is the most basic implementation.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-576">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-576-0" data-tab-group="tabgrp-576" data-tab-active="true">swift</button><button class="tab-button" data-tab-id="tabgrp-576-1" data-tab-group="tabgrp-576">objective-c</button></div>

<div class="tab-panel" data-tab-id="tabgrp-576-0" data-tab-group="tabgrp-576" data-tab-active="true">

```swift
let options = ContentWidgetOptions()
options.slug = "similar"
options.mapping = { model in
    guard let imageURLString = model.attributes["imageLink"] as? String,
                let imageURL = URL(string: imageURLString),
                let title = model.attributes["title"] as? String,
                let priceDictionary = model.attributes["price"] as? [AnyHashable: Any],
                let priceValue = priceDictionary["value"] as? Double
    else {
        return nil
    }

    let dataModel = ContentWidgetRecommendationDataModel(imageURL: imageURL, title: title, priceCurrency: "PLN", price: NSNumber(value: priceValue), salePrice: nil)

    if let salePriceDictionary = model.attributes["salePrice"] as? [AnyHashable: Any],
        let salePriceValue = salePriceDictionary["value"] as? Double {
        dataModel.salePriceValue = NSNumber(floatLiteral: salePriceValue)
    }

    let badgeDataModel = ContentWidgetBadgeDataModel(backgroundColor: UIColor.black, textColor: UIColor.white, text: "Black Week")
    dataModel.badge = badgeDataModel

    return dataModel
}

let gridLayout = ContentWidgetGridLayout()
let itemLayout = ContentWidgetBasicProductItemLayout()
let appearance = ContentWidgetAppearance(widgetLayout: gridLayout, itemLayout: itemLayout)

let widget = ContentWidget(options: options, appearance: appearance)

let widgetView = widget.getView()
widgetView.frame = CGRect(x: 0, y: 0, width: UIScreen.main.bounds.size.width, height: UIScreen.main.bounds.size.height)

view.addSubview(widgetView)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-576-1" data-tab-group="tabgrp-576">

```objective-c
SNRContentWidgetOptions *options = [SNRContentWidgetOptions new];
options.slug = @"similar";
options.mapping = ^(SNRContentWidgetRecommendationModel *model) {
    NSString *imageURLString = model.attributes[@"imageLink"];
    NSString *imageURL = [[NSURL alloc] initWithString:imageURLString];
    NSString *title = model.attributes[@"title"];
    NSDictionary *priceDictionary = model.attributes[@"price"];
    NSNumber *priceValue = priceDictionary[@"value"];
    if (imageURL == nil || title == nil || priceValue == nil) {
        return nil;
    }


    SNRContentWidgetRecommendationDataModel *dataModel = [[SNRContentWidgetRecommendationDataModel alloc] initWithimageURL:imageURL title:title priceCurrency:@"PLN" price:priceValue salePrice:nil];

    NSDictionary *salePriceDictionary = model.attributes[@"salePrice"];
    NSNumber *salePriceValue = salePriceDictionary[@"value"];
    if (salePrice != nil) {
        dataModel.salePriceValue = salePriceValue;
    }

    SNRContentWidgetBadgeDataModel *badgeDataModel = [[SNRContentWidgetBadgeDataModel alloc] initWithBackgroundColor:backgroundColor textColor:textColor text:text];
    dataModel.badge = badgeDataModel;

    return dataModel;
}

SNRContentWidgetGridLayout *gridLayout = [SNRContentWidgetGridLayout new];
SNRContentWidgetBasicProductItemLayout *itemLayout = [SNRContentWidgetBasicProductItemLayout new];
SNRContentWidgetAppearance *appearance = [[SNRContentWidgetAppearance alloc] initWithLayout:gridLayout andItemLayout:itemLayout];

SNRContentWidget *widget = [[SNRContentWidget alloc] initWithOptions:options andAppearance:appearance];

UIView *widgetView = [widget getView];
widgetView.frame = CGRectMake(0, 0, [UIScreen mainScreen].bounds.size.width, [UIScreen mainScreen].bounds.size.height);

[self.view addSubview:widgetView];
```

</div>
</div>


### Options
---

The [`ContentWidgetRecommendationsOptions`](/developers/mobile-sdk/class-reference/ios/content-widget#contentwidgetoptions) class is responsible for defining the business logic options of the widget, for example:

- slug of the document
- product identifier
- recommendation data model mapper

The table explains the parameters that can be configured in [`ContentWidgetRecommendationsOptions`](/developers/mobile-sdk/class-reference/ios/content-widget#contentwidgetoptions).

| Parameter | Type | Default | Description |
| --- | --- | --- | --- |
| slug | `String` | nil | Slug of a document |
| productID | `String` | nil | Product identifier for generating data |
| mapping | `((ContentWidgetRecommendationModel) -> (ContentWidgetRecommendationDataModel?))` | nil | Mapping block responsible for mapping data from the feed to a `ContentWidgetRecommendationDataModel` |
| recommendationEventType | `ContentWidgetRecommendationEventType` | - | Recommendation event type. <ul><li>**.view** sends all products in one event. We highly recommend using this type of event in content widget.</li><li>**.seen** sends each event as a separate event.</li></ul> |


<div class="content-tabs code-tabs" data-tab-group="tabgrp-577">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-577-0" data-tab-group="tabgrp-577" data-tab-active="true">swift</button><button class="tab-button" data-tab-id="tabgrp-577-1" data-tab-group="tabgrp-577">objective-c</button></div>

<div class="tab-panel" data-tab-id="tabgrp-577-0" data-tab-group="tabgrp-577" data-tab-active="true">

```swift
let widgetOptions = ContentWidgetRecommendationsOptions()
widgetOptions.slug = "similar"
widgetOptions.productID = "12345"
widgetOptions.mapping = { model in
    guard let imageURLString = model.attributes["imageLink"] as? String,
                let imageURL = URL(string: imageURLString),
                let title = model.attributes["title"] as? String,
                let priceDictionary = model.attributes["price"] as? [AnyHashable: Any],
                let priceValue = priceDictionary["value"] as? Double
    else {
        return nil
    }

    let dataModel = ContentWidgetRecommendationDataModel(imageURL: imageURL, title: title, priceCurrency: "PLN", price: NSNumber(value: priceValue), salePrice: nil)

    if let salePriceDictionary = model.attributes["salePrice"] as? [AnyHashable: Any],
        let salePriceValue = salePriceDictionary["value"] as? Double {
        dataModel.salePriceValue = NSNumber(floatLiteral: salePriceValue)
    }

    let badgeDataModel = ContentWidgetBadgeDataModel(backgroundColor: UIColor.black, textColor: UIColor.white, text: "Black Week")
    dataModel.badge = badgeDataModel

    return dataModel
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-577-1" data-tab-group="tabgrp-577">

```objective-c
SNRContentWidgetRecommendationsOptions *widgetOptions = [SNRContentWidgetRecommendationsOptions new];
widgetOptions.slug = @"similar";
widgetOptions.productID = @"12345";
widgetOptions.mapping = ^(SNRContentWidgetRecommendationModel *model) {
    NSString *imageURLString = model.attributes[@"imageLink"];
    NSString *imageURL = [[NSURL alloc] initWithString:imageURLString];
    NSString *title = model.attributes[@"title"];
    NSDictionary *priceDictionary = model.attributes[@"price"];
    NSNumber *priceValue = priceDictionary[@"value"];
    if (imageURL == nil || title == nil || priceValue == nil) {
        return nil;
    }


    SNRContentWidgetRecommendationDataModel *dataModel = [[SNRContentWidgetRecommendationDataModel alloc] initWithimageURL:imageURL title:title priceCurrency:@"PLN" price:priceValue salePrice:nil];

    NSDictionary *salePriceDictionary = model.attributes[@"salePrice"];
    NSNumber *salePriceValue = salePriceDictionary[@"value"];
    if (salePrice != nil) {
        dataModel.salePriceValue = salePriceValue;
    }

    SNRContentWidgetBadgeDataModel *badgeDataModel = [[SNRContentWidgetBadgeDataModel alloc] initWithBackgroundColor:backgroundColor textColor:textColor text:text];
    dataModel.badge = badgeDataModel;

    return dataModel;
}
```

</div>
</div>


### Appearance
---

The [`ContentWidgetAppearance`](/developers/mobile-sdk/class-reference/ios/content-widget#contentwidgetappearance) class is responsible for defining the appearance of the widget.

The class consists of parameters that define the widget's appearance, however, two of them are the most important:

-  **Main layout class**: defines the way of distributing elements in the widget. Currently, two layouts are provided: [`ContentWidgetHorizontalSliderLayout`](/developers/mobile-sdk/class-reference/ios/content-widget#contentwidgethorizontalsliderlayout) and [`ContentWidgetGridLayout`](/developers/mobile-sdk/class-reference/ios/content-widget#contentwidgetgridlayout).
-  **Item layout class**: defines appearance and parameters for the item in the widget. Currently, there is only one layout provided: [`ContentWidgetBasicProductItemLayout`](/developers/mobile-sdk/class-reference/ios/content-widget#contentwidgetbasicproductitemlayout).


The table explains the parameters that can be configured in [`ContentWidgetAppearance`](/developers/mobile-sdk/class-reference/ios/content-widget#contentwidgetappearance).

| Parameter | Type | Default | Description |
| --- | --- | --- | --- |
| layout | [`ContentWidgetLayout`](/developers/mobile-sdk/class-reference/ios/content-widget#contentwidgetlayout) | - | Class that inherits from [`ContentWidgetLayout`](/developers/mobile-sdk/class-reference/ios/content-widget#contentwidgetlayout) contains the UI details of `widgetLayout` |
| itemLayout | [`ContentWidgetItemLayout`](/developers/mobile-sdk/class-reference/ios/content-widget#contentwidgetitemlayout) | - | Class that inherits from [`ContentWidgetItemLayout`](/developers/mobile-sdk/class-reference/ios/content-widget#contentwidgetitemlayout) contains the UI details of a single item in a widget |

### Widget layouts
---

#### Horizontal Slider

This layout is intended to present recommendations in a fixed-hight horizontal scrollable slider.


**Example widget configuration with horizontal slider:**

<img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/developers/mobile-sdk/_gfx/ios-widget-slider.png" alt="Content Widget - Horizontal Slider" style="height:auto;max-width:50%">

##### Parameters

The table explains the parameters of `SNRContentWidgetHorizontalLayout`.

| Property | Type | Default | Description |
| --- | --- | --- | --- |
| backgroundColor | `UIColor` | UIColor.clearColor | Background color of a widget |
| insets | `UIEdgeInsets` | (8.0, 8.0, 8.0, 8.0) | Inner widget margins in pt |
| itemSize | `CGSize` | (150.0, 200.0) | Size of a single item in pt |
| itemSpacing | `CGFloat` | 16.0 | Horizontal spacing between items in pt |
| numberOfItems | `Int` | - | A **read-only** property. It returns the number of items after a widget is loaded |

##### Example


<div class="content-tabs code-tabs" data-tab-group="tabgrp-578">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-578-0" data-tab-group="tabgrp-578" data-tab-active="true">swift</button><button class="tab-button" data-tab-id="tabgrp-578-1" data-tab-group="tabgrp-578">objective-c</button></div>

<div class="tab-panel" data-tab-id="tabgrp-578-0" data-tab-group="tabgrp-578" data-tab-active="true">

```swift
let horizontalSliderLayout = ContentWidgetHorizontalSliderLayout()
horizontalSliderLayout.insets = UIEdgeInsets(top: 16.0, left: 16.0, bottom: 16.0, right: 16.0)
horizontalSliderLayout.itemSize = CGSize(width: 150, height: 350)
horizontalSliderLayout.itemSpacing = 8.0
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-578-1" data-tab-group="tabgrp-578">

```objective-c
SNRContentWidgetHorizontalSliderLayout *horizontalSliderLayout = [SNRContentWidgetHorizontalSliderLayout new];
horizontalSliderLayout.insets = UIEdgeInsetsMake(16.0f, 16.0f, 16.0f, 16.0f);
horizontalSliderLayout.itemSize = CGSizeMake(150.0f, 350.0f);
horizontalSliderLayout.itemSpacing = 8.0f;
```

</div>
</div>


#### Grid View

This layout presents recommendations in a vertical scrollable grid, with elements organized into columns and rows. You can create a full- or half-screen widget.

**Example widget configuration with grid layout:**

<img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/developers/mobile-sdk/_gfx/ios-widget-fullscreen.png" alt="Content Widget - Grid View" style="height:auto;max-width:50%">

##### Parameters

The table explains the parameters of the grid layout.

| Property | Type | Default | Description |
| --- | --- | --- | --- |
| backgroundColor | `UIColor` | UIColor.clearColor | Background color of a widget |
| insets | `UIEdgeInsets` | (8.0, 8.0, 8.0, 8.0) | Inner widget margins in pt |
| itemSize | `CGSize` | (150.0, 200.0) | Size of a single item in pt|
| itemHorizontalSpacing | `CGFloat` | 16.0 | Horizontal spacing between items in pt |
| itemVerticalSpacing | `CGFloat` | 16.0 | Vertical spacing between items in pt |
| numberOfItems | `Int` | - | A **read-only** property. It returns the number of items after the widget is loaded |

##### Example


<div class="content-tabs code-tabs" data-tab-group="tabgrp-579">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-579-0" data-tab-group="tabgrp-579" data-tab-active="true">swift</button><button class="tab-button" data-tab-id="tabgrp-579-1" data-tab-group="tabgrp-579">objective-c</button></div>

<div class="tab-panel" data-tab-id="tabgrp-579-0" data-tab-group="tabgrp-579" data-tab-active="true">

```swift
let gridLayout = ContentWidgetGridLayout()
gridLayout.insets = UIEdgeInsets(top: 16.0, left: 16.0, bottom: 16.0, right: 16.0)
gridLayout.itemSize = CGSize(width: 150, height: 350)
gridLayout.horizontalItemSpacing = 8.0
gridLayout.verticalItemSpacing = 8.0
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-579-1" data-tab-group="tabgrp-579">

```objective-c
SNRContentWidgetGridLayout *gridLayout = [SNRContentWidgetGridLayout new];
gridLayout.insets = UIEdgeInsetsMake(16.0f, 16.0f, 16.0f, 16.0f);
gridLayout.itemSize = CGSizeMake(150.0f, 350.0f);
gridLayout.horizontalItemSpacing = 8.0f;
gridLayout.verticalItemSpacing = 8.0f;
```

</div>
</div>


### Widget Item layouts
---

#### Basic Product Item Layout

This is the basic layout for items. It contains: the image, the title, and the price from the uploaded data.

##### Parameters

The table below contains all parameters you can configure in the basic item layout. 

| Property | Type | Default | Description |
| --- | --- | --- | --- |
| backgroundColor | `UIColor` | UIColor.whiteColor | Background color of an item |
| cornerRadius | `CGFloat` | 0.0 | Radius of the item corners |
| borderWidth | `CGFloat` | 0.0 | Width of the item's border |
| borderColor | `CGFloat` | nil | Color of the item's border |
| shadowColor | `UIColor` | nil | Color of the item's shadow |
| imageWidthRatio | `CGFloat` | 1.0 | Image width. A ratio of `1.0` means that the image width equals to 100% of the entire height of the item |
| imageHeightRatio | `CGFloat` | 0.35 | Image height. A ratio of `0.35` means that image height equals to 35% of the entire height of the item |
| imageBackground | `UIColor` | UIColor.clearColor | Background color of the image |
| imageContentMode | `UIViewContentMode` | UIViewContentMode.scaleToFill | Display content mode of the image |
| topTextInsets | `UIEdgeInsets` | (8.0, 8.0, 8.0, 8.0) | Inner margins of the top text label |
| topTextFont | `UIFont` | UIFont.systemFont(ofSize: 16.0) | Font of the top text label |
| topTextFontColor | `UIColor` | UIColor.blackColor | Color of the top text label |
| topTextAlignment | `NSTextAlignment` | NSTextAlignment.center | Alignment of the top text label |
| titleInsets | `UIEdgeInsets` | (8.0, 8.0, 8.0, 8.0) | Inner margins of the title label |
| titleFont | `UIFont` | UIFont.systemFont(ofSize: 16.0) | Font of the title label |
| titleFontColor | `UIColor` | UIColor.blackColor | Color of the title label |
| titleAlignment | `NSTextAlignment` | NSTextAlignment.center | Alignment of the title label |
| subtitleInsets | `UIEdgeInsets` | (8.0, 8.0, 8.0, 8.0) | Inner margins of the subtitle label |
| subtitleFont | `UIFont` | UIFont.systemFont(ofSize: 16.0) | Font of the subtitle label |
| subtitleFontColor | `UIColor` | UIColor.blackColor | Color of the subtitle label |
| subtitleAlignment | `NSTextAlignment` | NSTextAlignment.center | Alignment of the subtitle label |
| identifierInsets | `UIEdgeInsets` | (8.0, 8.0, 8.0, 8.0) | Inner margins of the identifier label |
| identifierFont | `UIFont` | UIFont.systemFont(ofSize: 16.0) | Font of the identifier label |
| identifierFontColor | `UIColor` | UIColor.blackColor | Color of the identifier label |
| identifierAlignment | `NSTextAlignment` | NSTextAlignment.center | Alignment of the identifier label |
| priceInsets | `UIEdgeInsets` | (8.0, 8.0, 8.0, 8.0) | Inner margins of the price label |
| priceFont | `UIFont` | UIFont.systemFont(ofSize: 14.0) | Font of the price label |
| priceFontColor | `UIColor` | UIColor.blackColor | Color of the price label |
| priceAlignment | `NSTextAlignment` | NSTextAlignment.center | Alignment of the price label |
| priceGroupSeparator | `String` | nil | Separator of price group |
| priceDecimalSeparator | `String` | nil | Separator of price decimal |
| priceCurrencyPosition | `ContentWidgetPriceCurrencyPosition` | .right | Determines the side on which the price currency is |
| isSalePriceVisible | `Bool` | true | Flag determining whether to show the sale price label or not |
| salePriceOrientation | `UILayoutConstraintAxis` | UILayoutConstraintAxis.Horizontal | Orientation of the sale price label |
| isDiscountPercentageVisible | `Bool` | true | Flag determining whether to show the discount percentage label or not |
| discountPercentageFont | `UIFont` | UIFont.systemFont(ofSize: 10.0) | Font of the discount percentage label |
| discountPercentageFontColor | `UIColor` | UIColor.blackColor | Font of the discount percentage label |
| regularPriceFont | `UIFont` | nil | Font of the regular price label |
| regularPriceFontColor | `UIColor` | nil | Color of the sale regular label |
| salePriceFont | `UIFont` | nil | Font of the sale price label |
| salePriceFontColor | `UIColor` | nil | Color of the sale price label |
| loyaltyPointsInsets | `UIEdgeInsets` | (8.0, 8.0, 8.0, 8.0) | Inner margins of the loyalty points label |
| loyaltyPointsAlignment | `NSTextAlignment` | NSTextAlignment.left | Alignment of the loyalty points label |
| loyaltyPointsNumberFont | `UIFont` | UIFont.systemFont(ofSize: 16.0) | Font of the loyalty points number label |
| loyaltyPointsNumberFontColor | `UIColor` | UIColor.blackColor | Color of the loyalty points number label |
| loyaltyPointsTextFont | `UIFont` | UIFont.systemFont(ofSize: 16.0) | Font of the loyalty points text label |
| loyaltyPointsTextFontColor | `UIColor` | UIColor.blackColor | Color of the loyalty points text label |
| loyaltyPointsText | `UIFont` | 'Loyalty points' | Text after the number of loyalty points |
| badge | `SNRContentWidgetBadgeItemLayoutPartial` | nil | Optional badge view |
| actionButton | `SNRContentWidgetImageButtonCustomAction` | nil | Optional button for your own custom action |

##### Example


<div class="content-tabs code-tabs" data-tab-group="tabgrp-580">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-580-0" data-tab-group="tabgrp-580" data-tab-active="true">swift</button><button class="tab-button" data-tab-id="tabgrp-580-1" data-tab-group="tabgrp-580">objective-c</button></div>

<div class="tab-panel" data-tab-id="tabgrp-580-0" data-tab-group="tabgrp-580" data-tab-active="true">

```swift
let itemLayout = ContentWidgetBasicProductItemLayout()
itemLayout.imageWidthRatio = 1.0
itemLayout.imageHeightRatio = 0.4
itemLayout.borderWidth = 2.0
itemLayout.borderColor = UIColor.black
itemLayout.shadowColor = UIColor.black
itemLayout.cornerRadius = 12.0
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-580-1" data-tab-group="tabgrp-580">

```objective-c
SNRContentWidgetBasicProductItemLayout *itemLayout = [SNRContentWidgetBasicProductItemLayout new];
itemLayout.imageWidthRatio = 1.0f;
itemLayout.imageHeightRatio = 0.4f;
itemLayout.borderWidth = 2.0f;
itemLayout.borderColor = [UIColor blackColor];
itemLayout.shadowColor = [UIColor blackColor];
itemLayout.cornerRadius = 12.0f;
```

</div>
</div>



### Interaction with the Widget
---

#### Public Interface

`load()` - Starts fetching data and creates a view structure of the widget.

`isLoaded()` - Checks whether the widget is successfully loaded.

`getView()` - Gets the root view of the whole widget view structure.

#### Delegation

[`ContentWidgetDelegate`](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#content-widget-delegate) is used to inform developers about the state of a widget. 

- `snr_widgetIsLoading(widget:isLoading:)` - Called when the widget’s loading state changes. It's an **optional** method.
- `snr_widgetDidLoad(widget:)` - Called after the widget is loaded. It's a **required** method.
- `snr_widgetDidNotLoad(widget:error:)` - Called when an error occurs while loading. It's a **required** method.
- `snr_widgetDidChangeSize(widget:size:)` - Called when the widget size changes. It's an **optional** method.
- `snr_widgetDidReceiveClickAction(widget:model:)` - Called when the customer clicks a widget item. It's a **required** method.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Check the [`ContentWidgetDelegate`](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#content-widget-delegate) section for more details.

</div></div></div>


#### Image Button Custom Action

[`ContentWidgetImageButtonCustomAction`](/developers/mobile-sdk/class-reference/ios/content-widget#contentwidgetbasecustomaction) is used to add an image button to your widget (only if the item layout allows). You can add a button with a single state or make it selectable.

##### Parameters

| Property | Type | Default | Description |
| --- | --- | --- | --- |
| predefinedActionType | [`ContentWidgetBaseCustomActionPredefiniedActionType`](/developers/mobile-sdk/class-reference/ios/content-widget#contentwidgetbasecustomactionpredefiniedactiontype) | .none | It determines which event is sent on click |
| size | `CGSize` | CGSize.Zero | Button size |
| position | `CGPoint` | CGPoint.Zero | Position |
| backgroundColor | `UIColor` | UIColor.clearColor | Background color of the button |
| tintColor | `UIColor` | UIColor.blackColor | Fill color of the button's image, if an asset supports it |
| image | `UIImage` | nil | Button image |
| isSelectable | `Bool` | nil | Flag determining whether the button is selectable |
| selectedImage | `UIImage` | nil | Image of the button when the button is selected |
| isSelected | `SNRContentWidgetImageButtonCustomActionIsSelectedBlock` | nil | Block/closure to be executed when the widget needs to determine the state of a button in the cell |
| onReceiveClickAction | `SNRContentWidgetImageButtonCustomActionReceiveClickActionBlock` | nil | Block/closure to be executed when the button is clicked |

##### Block/Closures

- `isSelected` - Called when the widget tries to determine button's state. The only one parameter is model of data for the cell (for example [`Recommendation`](/developers/mobile-sdk/class-reference/ios/recommendations-and-documents#recommendation)). It's an **optional** property.
- `onReceiveClickAction` - Called when the button was clicked. Parameters are model of data for the cell (for example [`Recommendation`](/developers/mobile-sdk/class-reference/ios/recommendations-and-documents#recommendation)) and current state of button. It's an **optional** property.


### Sample Implementations
---

#### Horizontal Slider

This is an example with [`ContentWidgetHorizontalSliderLayout`](/developers/mobile-sdk/class-reference/ios/content-widget#contentwidgethorizontalsliderlayout). It always has fixed height, so after the widget is loaded, its content height can be calculated.

That is why it is done in the `snr_widgetDidLoad(widget:)` method.

The widget content size in a horizontal slider layout can be calculated by the `getSize()` method.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-581">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-581-0" data-tab-group="tabgrp-581" data-tab-active="true">swift</button><button class="tab-button" data-tab-id="tabgrp-581-1" data-tab-group="tabgrp-581">objective-c</button></div>

<div class="tab-panel" data-tab-id="tabgrp-581-0" data-tab-group="tabgrp-581" data-tab-active="true">

```swift
class ContentWidgetHorizontalSliderSampleViewController: UIViewController, ContentWidgetDelegate {
    
    var widget: ContentWidget!

    @IBOutlet weak var widgetContainerView: UIView!

    // MARK: - Lifecycle

    override func viewDidLoad() {
        super.viewDidLoad()

        setupWidget()
    }

    // MARK: - Private

    func setupWidget() -> Void {
        let options = ContentWidgetRecommendationsOptions()
        options.slug = "similar"
        options.productID = "12345"
        options.mapping = { model in
            guard let imageURLString = model.attributes["imageLink"] as? String,
                        let imageURL = URL(string: imageURLString),
                        let title = model.attributes["title"] as? String,
                        let priceDictionary = model.attributes["price"] as? [AnyHashable: Any],
                        let priceValue = priceDictionary["value"] as? Double
            else {
                return nil
            }

            let dataModel = ContentWidgetRecommendationDataModel(imageURL: imageURL, title: title, priceCurrency: "PLN", price: NSNumber(value: priceValue), salePrice: nil)

            if let salePriceDictionary = model.attributes["salePrice"] as? [AnyHashable: Any],
                let salePriceValue = salePriceDictionary["value"] as? Double {
                dataModel.salePriceValue = NSNumber(floatLiteral: salePriceValue)
            }

            let badgeDataModel = ContentWidgetBadgeDataModel(backgroundColor: UIColor.black, textColor: UIColor.white, text: "Black Week")
            dataModel.badge = badgeDataModel

            return dataModel
        }

        let horizontalSliderLayout = ContentWidgetHorizontalSliderLayout()
        horizontalSliderLayout.insets = UIEdgeInsets(top: 16.0, left: 16.0, bottom: 16.0, right: 16.0)
        horizontalSliderLayout.itemSize = CGSize(width: 150, height: 350)
        horizontalSliderLayout.itemSpacing = 8.0

        let itemLayout = ContentWidgetBasicProductItemLayout()
        itemLayout.imageWidthRatio = 1.0
        itemLayout.imageHeightRatio = 0.4
        itemLayout.borderWidth = 2.0
        itemLayout.borderColor = UIColor.black
        itemLayout.shadowColor = UIColor.black
        itemLayout.cornerRadius = 12.0

        let actionButton = ContentWidgetImageButtonCustomAction()
        actionButton.backgroundColor = UIColor.clear
        actionButton.tintColor = UIColor.black
        actionButton.image = UIImage(imageLiteralResourceName: "Shop Flow/icon_favorite_add")
        actionButton.isSelectable = true
        actionButton.selectedImage = UIImage(imageLiteralResourceName: "Shop Flow/icon_favorite_remove")
        actionButton.size = CGSize(width: 40, height: 40)
        actionButton.predefinedActionType = .sendLikeEvent
        actionButton.onReceiveClickAction = {
            model, isSelected in

            if let recommendationModel = model as? Recommendation {
                print("Content Widget did receive click action for action button \(recommendationModel.title)")
            }
        }
        actionButton.isSelected = {
            model in

            return false
        }

        itemLayout.actionButton = actionButton
        itemLayout.actionButtonPosition = CGPoint(x: (150.0 - 40 - 8), y: 8)

        let appearance = ContentWidgetAppearance(widgetLayout: horizontalSliderLayout, itemLayout: itemLayout)

        widget = ContentWidget(options: options, appearance: appearance)
        widget.delegate = self
        widget.load()
    }

    // MARK: - ContentWidgetDelegate

    func snr_widgetIsLoading(widget: ContentWidget, isLoading: Bool) {
        print("Content Widget is loading: \(isLoading)")
    }

    func snr_widgetDidLoad(widget: ContentWidget) {
        print("Content Widget did load")

        let widgetView: UIView = widget.getView()
        let widgetSize: CGSize = (widget.layout as! ContentWidgetHorizontalSliderLayout).getSize()

        widgetContainerView.addSubview(widgetView)

        widgetView.translatesAutoresizingMaskIntoConstraints = false
        widgetView.topAnchor.constraint(equalTo: widgetContainerView.topAnchor).isActive = true
        widgetView.bottomAnchor.constraint(equalTo: widgetContainerView.bottomAnchor).isActive = true
        widgetView.leftAnchor.constraint(equalTo: widgetContainerView.leftAnchor).isActive = true
        widgetView.rightAnchor.constraint(equalTo: widgetContainerView.rightAnchor).isActive = true

        widgetContainerView.heightAnchor.constraint(equalToConstant: widgetSize.height).isActive = true
    }

    func snr_widgetDidNotLoad(widget: ContentWidget, error: Error) {
        print("Content Widget did not load. Error: \(error.localizedDescription)")
    }

    func snr_widgetDidChangeSize(widget: ContentWidget, size: CGSize) {
        print("Content Widget did change size to: \(size)")
    }

    func snr_widgetDidReceiveClickAction(widget: ContentWidget, model: BaseModel) {
        if let recommendationModel = model as? Recommendation {
            print("Content Widget did receive click action for \(recommendationModel.title)")
        }
    }
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-581-1" data-tab-group="tabgrp-581">

```objective-c
@interface ContentWidgetHorizontalSliderSampleViewController : UIViewController 

@property (weak, nonatomic, nonnull, readwrite) IBOutlet UIView *widgetContainerView;

@end

@@implementation ContentWidgetHorizontalSliderSampleViewController () <SNRContentWidgetDelegate>

@property (strong, nonatomic, nullable, readwrite) SNRContentWidget *widget;

@end

@@implementation ContentWidgetHorizontalSliderSampleViewController 
    
#pragma mark - Lifecycle

- (void)viewDidLoad {
    [super viewDidLoad];

    [self setupWidget];
}

#pragma mark - Private

- (void)setupWidget {
    SNRContentWidgetOptions *options = [SNRContentWidgetOptions new];
    options.slug = @"similar";
    options.productID = @"12345";
    options.mapping = ^(SNRContentWidgetRecommendationModel *model) {
        NSString *imageURLString = model.attributes[@"imageLink"];
        NSString *imageURL = [[NSURL alloc] initWithString:imageURLString];
        NSString *title = model.attributes[@"title"];
        NSDictionary *priceDictionary = model.attributes[@"price"];
        NSNumber *priceValue = priceDictionary[@"value"];
        if (imageURL == nil || title == nil || priceValue == nil) {
            return nil;
        }


        SNRContentWidgetRecommendationDataModel *dataModel = [[SNRContentWidgetRecommendationDataModel alloc] initWithimageURL:imageURL title:title priceCurrency:@"PLN" price:priceValue salePrice:nil];

        NSDictionary *salePriceDictionary = model.attributes[@"salePrice"];
        NSNumber *salePriceValue = salePriceDictionary[@"value"];
        if (salePrice != nil) {
            dataModel.salePriceValue = salePriceValue;
        }

        SNRContentWidgetBadgeDataModel *badgeDataModel = [[SNRContentWidgetBadgeDataModel alloc] initWithBackgroundColor:backgroundColor textColor:textColor text:text];
        dataModel.badge = badgeDataModel;

        return dataModel;
    }

    SNRContentWidgetHorizontalSliderLayout *horizontalSliderLayout = [SNRContentWidgetHorizontalSliderLayout new];
    horizontalSliderLayout.insets = UIEdgeInsetsMake(16.0f, 16.0f, 16.0f, 16.0f);
    horizontalSliderLayout.itemSize = CGSizeMake(150.0f, 350.0f);
    horizontalSliderLayout.itemSpacing = 8.0f;

    SNRContentWidgetBasicProductItemLayout *itemLayout = [SNRContentWidgetBasicProductItemLayout new];

    itemLayout.imageWidthRatio = 1.0f;
    itemLayout.imageHeightRatio = 0.4f;
    itemLayout.borderWidth = 2.0f;
    itemLayout.borderColor = [UIColor blackColor];
    itemLayout.shadowColor = [UIColor blackColor];
    itemLayout.cornerRadius = 12.0f;

    SNRContentWidgetImageButtonCustomAction *actionButton = [SNRContentWidgetImageButtonCustomAction new];
    actionButton.backgroundColor = [UIColor clearColor];
    actionButton.tintColor = [UIColor blackColor];
    actionButton.image = [UIImage imageNamed:@"Shop Flow/icon_favorite_add"];
    actionButton.isSelectable = YES
    actionButton.selectedImage = [UIImage imageNamed:@"Shop Flow/icon_favorite_remove"];
    actionButton.size = CGSizeMake(40.0f, 40.0f);
    actionButton.predefinedActionType = SNRContentWidgetBaseCustomActionPredefiniedActionTypeSendLikeEvent;
    actionButton.onReceiveClickAction = ^(SNRBaseModel *model, BOOL isSelected) {
        NSLog(@"Content Widget did receive click action for action button %@", ((SNRRecommednation *)recommendationModel.title));
    };
    actionButton.isSelected = ^(SNRBaseModel *model) {
        return NO;
    };

    itemLayout.actionButton = actionButton
    itemLayout.actionButtonPosition = CGPointMake((150.0f - 40.0f - 8), 8.0f)

    SNRContentWidgetAppearance *appearance = [[SNRContentWidgetAppearance alloc] initWithLayout:horizontalSliderLayout andItemLayout:itemLayout];

    SNRContentWidget *widget = [[SNRContentWidget alloc] initWithOptions:options andAppearance:appearance];
    widget.delegate = self

    [widget load];
    self.widget = widget;
}

#pragma mark - SNRContentWidgetDelegate

- (void)SNR_widget:(SNRContentWidget *)widget isLoading:(BOOL)isLoading {
    NSLog(@"Content Widget is loading: %@", isLoading ?? @"true" : @"false");
}

- (void)SNR_widgetDidLoad:(SNRContentWidget *)widget {
    NSLog(@"Content Widget did load");

    UIView *widgetView = [widget getView];
    CGSize widgetSize = [((SNRContentWidgetHorizontalSliderLayout *)widget.layout getSize];

    [self.widgetContainerView addSubview:widgetView];

    widgetView.translatesAutoresizingMaskIntoConstraints = NO;
    [widgetView.topAnchor constraintEqualTo:widgetContainerView.topAnchor].active = YES;
    [widgetView.bottomAnchor constraintEqualTo:widgetContainerView.bottomAnchor].active = YES;
    [widgetView.leftAnchor constraintEqualTo:widgetContainerView.leftAnchor].active = YES;
    [widgetView.rightAnchor constraintEqualTo:widgetContainerView.rightAnchor].active = YES;

    [widgetContainerView.heightAnchor constraintEqualToConstant:widgetSize.height].active = YES;
}

- (void)SNR_widget:(SNRContentWidget *)widget didNotLoadWithError:(NSError *)error {
    NSLog(@"Content Widget did not load. Error: %@", error.localizedDescription);
}

- (void)SNR_widget:(SNRContentWidget *)widget didChangeToSize:(CGSize)size {
    NSLog(@"Content Widget did change size to %@", NSStringFromCGSize(size));
}

- (void)SNR_widget:(SNRContentWidget *)widget didReceiveClickActionForModel:(SNRBaseModel *)model {
    if ([model isKindOfClass:[SNRRecommendation class]] == YES) {
        SNRRecommendation *recommendationModel = ((SNRRecommendation *)model);
        NSLog(@"Content Widget did receive click action for %@", recommendationModel.title);
    }
}

@end
```

</div>
</div>


#### Grid View

A basic example with [`ContentWidgetGridLayout`](/developers/mobile-sdk/class-reference/ios/content-widget#contentwidgetgridlayout) and `UITableViewController`. Remember that cells are prototyped.

Initially, the height of the tenth row equals zero, because there is no possibility of getting the correct height of the widget. Before the widget is loaded, we don't know how many items it's going to contain.

The widget view is flexible, so it fits the dimensions that you set up. If the height of the widget that you set is smaller than the total height of the generated grid, the content can be scrolled vertically.

The grid's content height depends on:

- The widget width that you set up
- The number of items that have been loaded

That is why the code below reloads the tenth row after the widget is loaded. Earlier, it was impossible to calculate the height correctly.

In addition, the widget row is reloaded when the `snr_widgetDidChangeSize(widget:size:)` method is called. In this case, it's a required action, because the widget has pinned constraints to superview in a prototyped cell. 

The widget's content size changes with the tableview size, for example when the screen orientation changes, the widget's height needs to be re-calculated. Otherwise, the cell height may be larger that necessary.

The total widget content size in a grid layout can be calculated by the `getSize(preferredWidth:)` method.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-582">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-582-0" data-tab-group="tabgrp-582" data-tab-active="true">swift</button><button class="tab-button" data-tab-id="tabgrp-582-1" data-tab-group="tabgrp-582">objective-c</button></div>

<div class="tab-panel" data-tab-id="tabgrp-582-0" data-tab-group="tabgrp-582" data-tab-active="true">

```swift
class ContentWidgetGridViewSampleViewController: UITableViewController, ContentWidgetDelegate {
    
    var widget: ContentWidget!

    @IBOutlet weak var widgetContainerView: UIView!

    // MARK: - Lifecycle

    override func viewDidLoad() {
        super.viewDidLoad()

        setupWidget()
    }

    func setupWidget() -> Void {
        let options = ContentWidgetRecommendationsOptions()
        options.slug = "similar"
        options.productID = "12345"
        options.mapping = { model in
            guard let imageURLString = model.attributes["imageLink"] as? String,
                        let imageURL = URL(string: imageURLString),
                        let title = model.attributes["title"] as? String,
                        let priceDictionary = model.attributes["price"] as? [AnyHashable: Any],
                        let priceValue = priceDictionary["value"] as? Double
            else {
                return nil
            }

            let dataModel = ContentWidgetRecommendationDataModel(imageURL: imageURL, title: title, priceCurrency: "PLN", price: NSNumber(value: priceValue), salePrice: nil)

            if let salePriceDictionary = model.attributes["salePrice"] as? [AnyHashable: Any],
                let salePriceValue = salePriceDictionary["value"] as? Double {
                dataModel.salePriceValue = NSNumber(floatLiteral: salePriceValue)
            }

            let badgeDataModel = ContentWidgetBadgeDataModel(backgroundColor: UIColor.black, textColor: UIColor.white, text: "Black Week")
            dataModel.badge = badgeDataModel

            return dataModel
        }

        let gridLayout = ContentWidgetGridLayout()
        gridLayout.insets = UIEdgeInsets(top: 16.0, left: 16.0, bottom: 16.0, right: 16.0)
        gridLayout.itemSize = CGSize(width: 150.0, height: 350.0)
        gridLayout.horizontalItemSpacing = 8.0
        gridLayout.verticalItemSpacing = 8.0

        let itemLayout = ContentWidgetBasicProductItemLayout()
        itemLayout.imageWidthRatio = 1.0
        itemLayout.imageHeightRatio = 0.4
        itemLayout.borderWidth = 2.0
        itemLayout.borderColor = UIColor.black
        itemLayout.shadowColor = UIColor.black
        itemLayout.cornerRadius = 12.0

        actionButton.onReceiveClickAction = {
            model, isSelected in

            if let recommendationModel = model as? Recommendation {
                print("Content Widget did receive click action for action button \(recommendationModel.title)")
            }
        }
        actionButton.isSelected = {
            model in

            return false
        }

        itemLayout.actionButton = actionButton
        itemLayout.actionButtonPosition = CGPoint(x: (150.0 - 40.0 - 8.0), y: 8.0)

        let appearance = ContentWidgetAppearance(widgetLayout: gridLayout, itemLayout: itemLayout)

        widget = ContentWidget(options: options, appearance: appearance)
        widget.delegate = self
        widget.load()
    }

    // MARK: - UITableViewDataSource, UITableViewDelegate

    override func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
        return 10
    }

    override func tableView(_ tableView: UITableView, heightForRowAt indexPath: IndexPath) -> CGFloat {
        if indexPath.row == 10 {
            if widget != nil && widget.isLoaded() {
                return (widget.layout as! ContentWidgetGridLayout).getSize(preferredWidth: tableView.bounds.size.width).height
            } else {
                return 0
            }
        }

        return 100.0
    }

    // MARK: - ContentWidgetDelegate

    func snr_widgetIsLoading(widget: ContentWidget, isLoading: Bool) {
        print("Content Widget is loading: \(isLoading)")
    }

    func snr_widgetDidLoad(widget: ContentWidget) {
        print("Content Widget did load")

        view.addSubview(widgetView)

        widgetView = widget.getView()
        widgetContainerView.addSubview(widgetView)

        widgetView.translatesAutoresizingMaskIntoConstraints = false
        widgetView.topAnchor.constraint(equalTo: widgetContainerView.topAnchor).isActive = true
        widgetView.bottomAnchor.constraint(equalTo: widgetContainerView.bottomAnchor).isActive = true
        widgetView.leftAnchor.constraint(equalTo: widgetContainerView.leftAnchor).isActive = true
        widgetView.rightAnchor.constraint(equalTo: widgetContainerView.rightAnchor).isActive = true

        tableView.reloadData()
    }

    func snr_widgetDidNotLoad(widget: ContentWidget, error: Error) {
        print("Content Widget did not load. Error: \(error.localizedDescription)")
    }

    func snr_widgetDidChangeSize(widget: ContentWidget, size: CGSize) {
        print("Content Widget did change size to: \(size)")

        tableView.reloadData()
    }

    func snr_widgetDidReceiveClickAction(widget: ContentWidget, model: BaseModel) {
        if let recommendationModel = model as? Recommendation {
            print("Content Widget did receive click action for \(recommendationModel.title)")
        }
    }
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-582-1" data-tab-group="tabgrp-582">

```objective-c
@interface ContentWidgetGridViewSampleViewController : UITableViewController 

@property (weak, nonatomic, nonnull, readwrite) IBOutlet UIView *widgetContainerView;

@end

@@implementation ContentWidgetGridViewSampleViewController () <SNRContentWidgetDelegate>

@property (strong, nonatomic, nullable, readwrite) SNRContentWidget *widget;

@end

@@implementation ContentWidgetGridViewSampleViewController 
    
#pragma mark - Lifecycle

- (void)viewDidLoad {
    [super viewDidLoad];

    [self setupWidget];
}

#pragma mark - Private

- (void)setupWidget {
    SNRContentWidgetOptions *options = [SNRContentWidgetOptions new];
    options.slug = @"similar";
    options.productID = @"12345";
    options.mapping = ^(SNRContentWidgetRecommendationModel *model) {
        NSString *imageURLString = model.attributes[@"imageLink"];
        NSString *imageURL = [[NSURL alloc] initWithString:imageURLString];
        NSString *title = model.attributes[@"title"];
        NSDictionary *priceDictionary = model.attributes[@"price"];
        NSNumber *priceValue = priceDictionary[@"value"];
        if (imageURL == nil || title == nil || priceValue == nil) {
            return nil;
        }


        SNRContentWidgetRecommendationDataModel *dataModel = [[SNRContentWidgetRecommendationDataModel alloc] initWithimageURL:imageURL title:title priceCurrency:@"PLN" price:priceValue salePrice:nil];

        NSDictionary *salePriceDictionary = model.attributes[@"salePrice"];
        NSNumber *salePriceValue = salePriceDictionary[@"value"];
        if (salePrice != nil) {
            dataModel.salePriceValue = salePriceValue;
        }

        SNRContentWidgetBadgeDataModel *badgeDataModel = [[SNRContentWidgetBadgeDataModel alloc] initWithBackgroundColor:backgroundColor textColor:textColor text:text];
        dataModel.badge = badgeDataModel;

        return dataModel;
    }

    SNRContentWidgetGridLayout *gridLayout = [SNRContentWidgetGridLayout new];
    gridLayout.insets = UIEdgeInsetsMake(16.0f, 16.0f, 16.0f, 16.0f);
    gridLayout.itemSize = CGSizeMake(150.0f, 350.0f);
    gridLayout.horizontalItemSpacing = 8.0f;
    gridLayout.verticalItemSpacing = 8.0f;

    SNRContentWidgetImageButtonCustomAction *actionButton = [SNRContentWidgetImageButtonCustomAction new];
    actionButton.backgroundColor = [UIColor clearColor];
    actionButton.tintColor = [UIColor blackColor];
    actionButton.image = [UIImage imageNamed:@"Shop Flow/icon_favorite_add"];
    actionButton.isSelectable = YES
    actionButton.selectedImage = [UIImage imageNamed:@"Shop Flow/icon_favorite_remove"];
    actionButton.size = CGSizeMake(40.0f, 40.0f);
    actionButton.predefinedActionType = SNRContentWidgetBaseCustomActionPredefiniedActionTypeSendLikeEvent;
    actionButton.onReceiveClickAction = ^(SNRBaseModel *model, BOOL isSelected) {
        NSLog(@"Content Widget did receive click action for action button %@", ((SNRRecommednation *)recommendationModel.title));
    };
    actionButton.isSelected = ^(SNRBaseModel *model) {
        return NO;
    };

    itemLayout.actionButton = actionButton
    itemLayout.actionButtonPosition = CGPointMake((150.0f - 40.0f - 8), 8.0f)

    SNRContentWidgetAppearance *appearance = [[SNRContentWidgetAppearance alloc] initWithLayout:gridLayout andItemLayout:itemLayout];

    SNRContentWidget *widget = [[SNRContentWidget alloc] initWithOptions:options andAppearance:appearance];
    widget.delegate = self;

    [widget load];
}

#pragma mark - UITableViewDataSource, UITableViewDelegate

- (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section {
    return 10;
}

- (CGFloat)tableView:(UITableView *)tableView heightForRowAtIndexPath:(NSIndexPath *)indexPath {
    if (indexPath.row == 10) {
        if (self.widget != nil && [self.widget isLoaded] == YES) {
            return [((ContentWidgetGridLayout *)widget.layout) getSizeForPreferredWidth:tableView.bounds.size.width].height;
        } else {
            return 0;
        }
    }

    return 100.0f;
}

#pragma mark - SNRContentWidgetDelegate

- (void)SNR_widget:(SNRContentWidget *)widget isLoading:(BOOL)isLoading {
    NSLog(@"Content Widget is loading: %@", isLoading ?? @"true" : @"false");
}

- (void)SNR_widgetDidLoad:(SNRContentWidget *)widget {
    NSLog(@"Content Widget did load");


    UIView *widgetView = [self.widget getView];
    CGSize widgetSize = [((SNRContentWidgetHorizontalSliderLayout *)widget.layout getSize];

    [self.widgetContainerView addSubview:widgetView];

    widgetView.translatesAutoresizingMaskIntoConstraints = NO;
    [widgetView.topAnchor constraintEqualTo:widgetContainerView.topAnchor].active = YES;
    [widgetView.bottomAnchor constraintEqualTo:widgetContainerView.bottomAnchor].active = YES;
    [widgetView.leftAnchor constraintEqualTo:widgetContainerView.leftAnchor].active = YES;
    [widgetView.rightAnchor constraintEqualTo:widgetContainerView.rightAnchor].active = YES;

    [widgetContainerView.heightAnchor constraintEqualToConstant:widgetSize.height].active = YES;
}

- (void)SNR_widget:(SNRContentWidget *)widget didNotLoadWithError:(NSError *)error {
    NSLog(@"Content Widget did not load. Error: %@", error.localizedDescription);
}

- (void)SNR_widget:(SNRContentWidget *)widget didChangeToSize:(CGSize)size {
    NSLog(@"Content Widget did change size to %@", NSStringFromCGSize(size));
}

- (void)SNR_widget:(SNRContentWidget *)widget didReceiveClickActionForModel:(SNRBaseModel *)model {
    if ([model isKindOfClass:[SNRRecommendation class]] == YES) {
        SNRRecommendation *recommendationModel = ((SNRRecommendation *)model);
        NSLog(@"Content Widget did receive click action for %@", recommendationModel.title);
    }
}

@end
```

</div>
</div>


### More information
---

You can find more information under the following links:

- [Sample App on GitHub](https://github.com/Synerise/ios-sdk/tree/master/SampleAppSwift/4.1.0) 
- [Horizontal Slider implementation in the Sample App on GitHub](https://github.com/Synerise/synerise-ios-sdk/blob/master/SampleAppSwift/4.1.0/SampleAppSwift/Main/Developer%20Tools%20Flow/ViewControllers/ContentAPI/RecommendationsWidgetAsSliderTableViewController.swift)
- [Grid implementation in the Sample App on GitHub](https://github.com/Synerise/synerise-ios-sdk/blob/master/SampleAppSwift/4.1.0/SampleAppSwift/Main/Developer%20Tools%20Flow/ViewControllers/ContentAPI/RecommendationsWidgetAsGridTableViewController.swift)



# iOS

## Method reference - iOS


# Customer authentication


---

## Set Client State listener
---
This method sets callbacks for a customer's state changes.
**Declared In:**  
lib/main/modules/ClientModule.js
  
**Related To:**  
[ClientStateChangeListener](/developers/mobile-sdk/listeners-and-delegates/react-native-listeners#client-state-listener)  
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public setClientStateChangeListener(listener: IClientStateChangeListener)</code></pre>

  
**Discussion:**  
Learn more about the methods and the purpose of this listener [here](/developers/mobile-sdk/listeners-and-delegates/react-native-listeners#client-state-listener).

## Register customer account
---
This method registers a new customer with an email, password, and optional data.
  
This method requires the context object with a customer’s email, password, and optional data. Omitted fields are not modified.
  
Depending on the backend configuration, the account may require activation. For details, see  [customer registration](/developers/mobile-sdk/user-identification-and-authorization/overview).
  
Do not allow signing in again (or signing up) when a customer is already signed in. Sign the customer out first.
  
Do not create multiple instances nor call this method multiple times before execution.
  
This method is a global operation and doesn't require customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_REGISTER_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Related To:**  
[ClientAccountRegisterContext](/developers/mobile-sdk/class-reference/react-native/client#clientaccountregistercontext)
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public registerAccount(context: ClientAccountRegisterContext, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **context** | [ClientAccountRegisterContext](/developers/mobile-sdk/class-reference/react-native/client#clientaccountregistercontext) | yes | - | Object with the customer's email, password, and other optional data |
| **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:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1211">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1211-0" data-tab-group="tabgrp-1211" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1211-0" data-tab-group="tabgrp-1211" data-tab-active="true">

```JavaScript
let email = "EMAIL";
let password = "PASSWORD";

let context = new ClientAccountRegisterContext(email, password);
context.phone = '123456789';
context.customId = '000111';

context.firstName = 'John';
context.lastName = 'Rise';
context.sex = ClientSex.Male;

context.company = 'Synerise';
context.address = 'Marszałkowska';
context.city = 'Warszawa';
context.province = 'Mazowieckie';
context.zipCode = '00-000';
context.countryCode = 'PL';

context.agreements = new ClientAgreements({
    email: true,
    sms: false,
    push: true,
    bluetooth: false,
    rfid: true,
    wifi: false
});

context.attributes = { ATTRIBUTE_1: 'ATTRIBUTE_1' }
context.tags = ['TAG_1', 'TAG_2']

Synerise.Client.registerAccount(context, function() {
  // success
}, function(error) {
  // failure
});
```

</div>
</div>


<!-- reusable-table-boundary -->

## Request customer account activation
---
This method requests sending an email with a URL that confirms the registration and activates the account.
  
This method is a global operation and doesn't require customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CONFIRMATION_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)

**Declaration:**  

<pre><code class="language-TypeScript">public requestAccountActivation(email: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Before version 1.0.0, this method was called `activateAccount`.

</div></div></div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | string | yes | - | Customer's email |
| **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:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1212">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1212-0" data-tab-group="tabgrp-1212" data-tab-active="true">TypeScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1212-0" data-tab-group="tabgrp-1212" data-tab-active="true">

```TypeScript
Synerise.Client.requestAccountActivation("EMAIL", function() {
  // success
}, function(error) {
  // failure
});
```

</div>
</div>


<!-- reusable-table-boundary -->

## Confirm customer account activation
---
This method confirms a customer account with the confirmation token.
  
This method is a global operation and doesn't require customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 400 status code if the account is already confirmed or 404 if the account does not exist.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CONFIRMATION_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public confirmAccountActivation(token: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Before version 1.0.0, this method was called `confirmAccount`.

</div></div></div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **token** | string | yes | - | Customer's token provided by email |
| **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:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1213">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1213-0" data-tab-group="tabgrp-1213" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1213-0" data-tab-group="tabgrp-1213" data-tab-active="true">

```JavaScript
Synerise.Client.confirmAccountActivation("TOKEN", function() {
  // success
}, function(error) {
  // failure
});
```

</div>
</div>


<!-- reusable-table-boundary -->


## Request customer account activation by pin
---
This method requests a customer's account registration process with the PIN code.
  
This method is a global operation and doesn't require customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_PIN_CODE_RESEND_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public requestAccountActivationByPin(email: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

    
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | string | yes | - | Customer's email |
| **onSuccess** | Function | yes | - | Function to be executed when the operation is completed successfully |
| **onError** | Function | yes | - | Function to be executed when the operation is completed with an error |
  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->

## Confirm customer account activation by pin
---
This method confirms a customer's account registration process with the PIN code.
  
This method is a global operation and doesn't require customer authentication.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_PIN_CODE_RESEND_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public confirmAccountActivationByPin(pinCode: string, email: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **pinCode** | string | yes | - | Code sent to a customer's email |
| **email** | string | yes | - | Customer's email |
| **onSuccess** | Function | yes | - | Function to be executed when the operation is completed successfully |
| **onError** | Function | yes | - | Function to be executed when the operation is completed with an error |

**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->

## Sign in a customer
---
This method signs a customer in to obtain a JSON Web Token (JWT) which can be used in subsequent requests.
  
The SDK will refresh the token before each call if it is about to expire (but not expired).
  
Do NOT allow signing in again (or signing up) when a customer is already signed in. First, sign the customer out.
  
Do NOT create multiple instances nor call this method multiple times before execution.
<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public signIn(email: string, password: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | string | yes | - | Customer's email |
| **password** | string | yes | - | Customer's password |
| **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:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1214">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1214-0" data-tab-group="tabgrp-1214" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1214-0" data-tab-group="tabgrp-1214" data-tab-active="true">

```JavaScript
let email = "EMAIL";
let password = "PASSWORD";

Synerise.Client.signIn(email, password, function() {
  // success
}, function(error) {
  // failure
});
```

</div>
</div>


<!-- reusable-table-boundary -->

## Sign in a customer conditionally
---
<!-- reusable-table-boundary -->

This method signs a customer in to obtain a JSON Web Token (JWT) which can be used in subsequent requests.
  
The SDK will refresh the token before each call if it is about to expire (but not expired).
  
Do NOT allow signing in again (or signing up) when a customer is already signed in. First, sign the customer out.
  
Do NOT create multiple instances nor call this method multiple times before execution.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | n/a |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public signInConditionally(email: string, password: string, onSuccess: (authResult: ClientConditionalAuthResult) =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | string | yes | - | Customer's email |
| **password** | string | yes | - | Customer's password |
| **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:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1215">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1215-0" data-tab-group="tabgrp-1215" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1215-0" data-tab-group="tabgrp-1215" data-tab-active="true">

```JavaScript
let email = "EMAIL";
let password = "PASSWORD";

Synerise.Client.signInConditionally(email, password, function(clientConditionalAuthResult) {
  // success
}, function(error) {
  // failure
});
```

</div>
</div>


<!-- reusable-table-boundary -->

## Authenticate customer by IdentityProvider
---
<!-- reusable-table-boundary -->

This method authenticates a customer with OAuth, Facebook, Google, Apple, or Synerise.
  
If an account for the customer does not exist and the identity provider is different than Synerise, this request creates an account.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | 0.3.0 |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js

**Related To:**  
[ClientAuthContext](/developers/mobile-sdk/class-reference/react-native/client#clientauthcontext)  
[ClientIdentityProvider](/developers/mobile-sdk/class-reference/react-native/client#clientidentityprovider)  
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public authenticate(token: string, provider: ClientIdentityProvider, context: ClientAuthContext, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **token** | string | yes | - | Token retrieved from provider  |
| **clientIdentityProvider** | [ClientIdentityProvider](/developers/mobile-sdk/class-reference/react-native/client#clientidentityprovider) | yes | - | Provider of your token |
| **context** | [ClientAuthContext](/developers/mobile-sdk/class-reference/react-native/client#clientauthcontext) | yes | - | Object which wraps around agreements, attributes and authId |
| **onSuccess** | Function | yes | - | Function to be executed when the operation is completed successfully |
| **onError** | Function | yes | - | Function to be executed when the operation is completed with an error |

**Return Value:**  
No value is returned.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1216">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1216-0" data-tab-group="tabgrp-1216" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1216-0" data-tab-group="tabgrp-1216" data-tab-active="true">

```JavaScript
Synerise.Client.authenticate(token, ClientIdentityProvider.Oauth, context, function() {
  // success
}, function(error) {
  // failure
})
```

</div>
</div>


<!-- reusable-table-boundary -->

## Authenticate customer conditionally by IdentityProvider
---
<!-- reusable-table-boundary -->

This method authenticates a customer with OAuth, Facebook, Google, Apple, or Synerise.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | n/a |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Related To:**  
[ClientAuthContext](/developers/mobile-sdk/class-reference/react-native/client#clientauthcontext)  
[ClientIdentityProvider](/developers/mobile-sdk/class-reference/react-native/client#clientidentityprovider)
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public authenticateConditionally(token: string, provider: ClientIdentityProvider, context: ClientAuthContext, onSuccess: (authResult: ClientConditionalAuthResult) =&gt; void, onError: (error: Error) =&gt; void)</code></pre>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **token** | string | yes | - | Token retrieved from provider |
| **clientIdentityProvider** | [ClientIdentityProvider](/developers/mobile-sdk/class-reference/react-native/client#clientidentityprovider) | yes | - | Provider of your token |
| **context** | [ClientAuthContext](/developers/mobile-sdk/class-reference/react-native/client#clientauthcontext) | no | - | Object which contains agreements, attributes, and identifier of authorization |
| **onSuccess** | Function | yes | - | Function to be executed when the operation is completed successfully |
| **onError** | Function | yes | - | Function to be executed when the operation is completed with an error |

**Return Value:**  
No value is returned.
  
**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1217">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1217-0" data-tab-group="tabgrp-1217" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1217-0" data-tab-group="tabgrp-1217" data-tab-active="true">

```JavaScript
Synerise.Client.authenticateConditionally(token, ClientIdentityProvider.Oauth, context, function(clientConditionalAuthResult) {
    // success
}, function(error) {
    // failure
})
```

</div>
</div>


<!-- reusable-table-boundary -->

## Authenticate customer via Simple Profile Authentication
---
<!-- reusable-table-boundary -->

This method authenticates a customer with Simple Profile Authentication.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.14.0 | 5.7.1 | 0.15.0 | 0.7.0 |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

When you use this method, you must set a request validation salt by using the `Synerise.setRequestValidationSalt(_:)` method (if salt is enabled for Simple Profile Authentication).

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_SIMPLE_AUTH_CREATE` from the **Auth** group.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js

**Related To:**  
[ClientSimpleAuthenticationData](/developers/mobile-sdk/class-reference/react-native/client#clientsimpleauthenticationdata)  
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public simpleAuthentication(data: ClientSimpleAuthenticationData, authID: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **data** | [ClientSimpleAuthenticationData](/developers/mobile-sdk/class-reference/react-native/client#clientsimpleauthenticationdata) | yes | - | Object which contains customer data |
| **authID** | string | yes | - | Required identifier of authorization |
| **onSuccess** | Function | yes | - | Function to be executed when the operation is completed successfully |
| **onError** | Function | yes | - | Function to be executed when the operation is completed with an error |

**Return Value:**  
No value is returned.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1218">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1218-0" data-tab-group="tabgrp-1218" data-tab-active="true">TypeScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1218-0" data-tab-group="tabgrp-1218" data-tab-active="true">

```TypeScript
let data: ClientSimpleAuthenticationData = new ClientSimpleAuthenticationData();
context.email = "EMAIL";
context.firstName = "FIRST_NAME";
let authID: String = "AUTH_ID"

Synerise.Client.simpleAuthentication(data, authID, function() {
  // success
}, function(error) {
  // failure
})
```

</div>
</div>


<!-- reusable-table-boundary -->

## Check if a customer is signed in (via RaaS, OAuth, Facebook, Apple)
---
This method checks if a customer is signed in (via Synerise Authentication - RaaS, OAuth, Facebook, Apple).
**Declared In:**  
lib/main/modules/ClientModule.js
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public isSignedIn(): boolean</code></pre>

  
**Return Value:**  
**true** if the customer is signed in, otherwise returns **false**.
  
**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1219">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1219-0" data-tab-group="tabgrp-1219" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1219-0" data-tab-group="tabgrp-1219" data-tab-active="true">

```JavaScript
let isSignedIn = Synerise.Client.isSignedIn();
```

</div>
</div>


## Check if a customer is signed in (via Simple Profile Authentication)
---
<!-- reusable-table-boundary -->

This method checks if a customer is signed in (via Simple Profile Authentication).
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.14.0 | 5.7.1 | 0.15.0 | 0.7.0 |

<!-- reusable-table-boundary -->
**Declared In:**  
lib/main/modules/ClientModule.js
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public isSignedInViaSimpleAuthentication(): boolean</code></pre>

  
**Return Value:**  
**true** if the customer is signed in (via Simple Profile Authentication), otherwise returns **false**.
  
**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1220">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1220-0" data-tab-group="tabgrp-1220" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1220-0" data-tab-group="tabgrp-1220" data-tab-active="true">

```JavaScript
let isSignedIn = Synerise.Client.isSignedInViaSimpleAuthentication();
```

</div>
</div>


## Sign out a customer
---
This method signs out a customer out.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This method works with every authentication type (via Synerise, External Provider, OAuth or Simple Profile Authentication).

</div></div></div>

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public signOut()</code></pre>

  
**Return Value:**  
No value is returned.
  
**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1221">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1221-0" data-tab-group="tabgrp-1221" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1221-0" data-tab-group="tabgrp-1221" data-tab-active="true">

```JavaScript
Synerise.Client.signOut();
```

</div>
</div>


## Sign out customer with mode or from all devices
---
<!-- reusable-table-boundary -->

This method signs out a customer out with a chosen mode and Determines if the method should sign out all devices.

Available modes:
- `.signOut` mode signs out the customer.
- `.signOutWithSessionDestroy` mode signs out the customer and additionally, clears the anonymous session and regenerates the customer UUID.

The `fromAllDevices` parameter determines whether the method should notify the backend to sign out all devices.

**IMPORTANT: It is an asynchronous method.**
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.11.0 | 5.1.0 | 0.14.0 | 1.0.0 |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This method works with every authentication type (via Synerise, External Provider, OAuth or Simple Profile Authentication).

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Related To:**  
[ClientSignOutMode](/developers/mobile-sdk/class-reference/react-native/client#clientsignoutmode)
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public signOutWithMode(mode: ClientSignOutMode, fromAllDevices: boolean, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **mode** | [ClientSignOutMode](/developers/mobile-sdk/class-reference/react-native/client#clientsignoutmode) | yes | - | Mode of signing out |
| **fromAllDevices** | Bool | yes | - | Determines if the method should sign out all devices |

**Return Value:**  
No value is returned.
  
**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1222">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1222-0" data-tab-group="tabgrp-1222" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1222-0" data-tab-group="tabgrp-1222" data-tab-active="true">

```JavaScript
Synerise.Client.signOutWithMode(
  ClientSignOutMode.SignOutWithSessionDestroy,
  true,
  () => {
    this.setState({
      isLoading: false,
      isSignedIn: true,
    })
  },
  (error) => {
    this.setState({
      isLoading: false,
      isSignedIn: false,
    })

  console.log('ERROR: ' + error.message);
  }
)
```

</div>
</div>


<!-- reusable-table-boundary -->

## Deprecated methods

### Authenticate customer by OAuth with registration
---
<!-- reusable-table-boundary -->

This method authenticates a customer with OAuth.
  
If an account for the customer does not exist, this request creates an account.
  
| Available on | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.6.11 | 3.6.13 | 0.9.12 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | 1.0.0 | n/a |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 401 status code if the provided access token and/or API Key is invalid.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Related To:**  
[ClientOAuthAuthenticationContext](/developers/mobile-sdk/class-reference/react-native/client#clientoauthauthenticationcontext)
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public authenticateByOAuth(accessToken: string, context: ClientOAuthAuthenticationContext, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **accessToken** | string | yes | - | OAuth Access Token |
| **clientOAuthContext** | [ClientOAuthAuthenticationContext](/developers/mobile-sdk/class-reference/react-native/client#clientoauthauthenticationcontext) | yes | - | Object which contains agreements, attributes, and identifier of authorization |
| **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:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1223">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1223-0" data-tab-group="tabgrp-1223" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1223-0" data-tab-group="tabgrp-1223" data-tab-active="true">

```JavaScript
Synerise.Client.authenticateByOAuth(token, context, function() {
   // success
}, function(error) {
   // failure
})
```

</div>
</div>


<!-- reusable-table-boundary -->

### Authenticate customer by OAuth without registration
---
<!-- reusable-table-boundary -->

This method authenticates a customer with OAuth.
  
| Available on | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.6.11 | 3.6.13 | 0.9.12 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | 1.0.0 | n/a |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 401 status code if the provided access token and/or API Key is invalid.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public authenticateByOAuthIfRegistered(accessToken: string, authID: string | null, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **accessToken** | string | yes | - | OAuth Access Token |
| **authID** | string | no | null | Optional identifier of authorization |
| **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 |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authID** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>

  
**Return Value:**  
No value is returned.
  
**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1224">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1224-0" data-tab-group="tabgrp-1224" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1224-0" data-tab-group="tabgrp-1224" data-tab-active="true">

```JavaScript
Synerise.Client.authenticateByOAuthIfRegistered(accessToken, authID, function() {
   // success
}, function(error) {
   // failure
})
```

</div>
</div>


<!-- reusable-table-boundary -->

### Authenticate customer by Facebook with registration
---
<!-- reusable-table-boundary -->

This method authenticates a customer with Facebook.
  
If an account for the customer does not exist, this request creates an account.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.3.8 | 3.3.0 | 0.9.7 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | 1.0.0 | n/a |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 401 status code if the provided Facebook token and/or API Key is invalid.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js

**Related To:**  
[ClientFacebookAuthenticationContext](/developers/mobile-sdk/class-reference/react-native/client#clientfacebookauthenticationcontext)
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public authenticateByFacebook(facebookToken: string, context: ClientFacebookAuthenticationContext, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **facebookToken** | string | yes | - | Facebook Access Token |
| **clientFacebookAuthenticationContext** | [ClientFacebookAuthenticationContext](/developers/mobile-sdk/class-reference/react-native/client#clientfacebookauthenticationcontext) | yes | - | Object which contains agreements, attributes, and identifier of authorization |
| **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:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1225">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1225-0" data-tab-group="tabgrp-1225" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1225-0" data-tab-group="tabgrp-1225" data-tab-active="true">

```JavaScript
Synerise.Client.authenticateByFacebook(token, clientFacebookAuthenticationContext, function(clientConditionalAuthResult) {
  // success
}, function(error) {
  // failure
})
```

</div>
</div>


<!-- reusable-table-boundary -->

### Authenticate customer by Facebook without registration
---
<!-- reusable-table-boundary -->

This method authenticates a customer with Facebook.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.3.8 | 3.3.0 | 0.9.7 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | 1.0.0 | n/a |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 401 status code if the provided Facebook token and/or API Key is invalid.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public authenticateByFacebookIfRegistered(facebookToken: string, authID: string | null, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **facebookToken** | string | yes | - | Facebook Access Token |
| **authID** | string | no | null | Optional identifier of authorization |
| **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 |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authID** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>

  
**Return Value:**  
No value is returned.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1226">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1226-0" data-tab-group="tabgrp-1226" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1226-0" data-tab-group="tabgrp-1226" data-tab-active="true">

```JavaScript
Synerise.Client.authenticateByFacebookIfRegistered(facebookToken, authID, function() {
    // success
}, function(error) {
    // failure
})
```

</div>
</div>


<!-- reusable-table-boundary -->

### Authenticate customer by Sign in with Apple with registration
---
<!-- reusable-table-boundary -->

This method authenticates a customer with Sign In With Apple.
  
If an account for the customer does not exist, this request creates an account.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.6.11 | n/a | 0.9.12 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.7.6 | n/a | 0.9.19 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | n/a | 1.0.0 | n/a |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Related To:**  
[ClientAppleSignInAuthenticationContext](/developers/mobile-sdk/class-reference/react-native/client#clientapplesigninauthenticationcontext)
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public authenticateByAppleSignIn(identityToken: string, context: ClientAppleSignInAuthenticationContext, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **identityToken** | string | yes | - | Apple Identity Token |
| **context** | [ClientAppleSignInAuthenticationContext](/developers/mobile-sdk/class-reference/react-native/client#clientapplesigninauthenticationcontext) | yes | - | Object which contains agreements, attributes, and identifier of authorization |
| **success** | Function | no | - | Function to be executed when the operation is completed successfully |
| **failure** | Function | no | - | Function to be executed when the operation is completed with an error |

**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->

### Authenticate customer by Sign in with Apple without registration
---
<!-- reusable-table-boundary -->

This method authenticates a customer with Sign In With Apple.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.6.11 | 3.6.13 | 0.9.12 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | 1.0.0 | n/a |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public authenticateByAppleSignInIfRegistered(identityToken: string, authID: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **identityToken** | string | yes | - | Apple Identity Token |
| **authID** | string | no | null | Optional identifier of authorization |
| **success** | Function | no | - | Function to be executed when the operation is completed successfully |
| **failure** | Function | no | - | Function to be executed when the operation is completed with an error |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authID** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>

  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->








# Customer authentication


---
## Register customer account
---
This method registers a new customer with an email, password, and optional data.
  
This method requires the context object with a customer’s email, password, and optional data. Omitted fields are not modified.
  
Depending on the backend configuration, the account may require activation. For details, see  [customer registration](/developers/mobile-sdk/user-identification-and-authorization/overview).
  
Do not allow signing in again (or signing up) when a customer is already signed in. Sign the customer out first.
  
Do not create multiple instances nor call this method multiple times before execution.
  
This method is a global operation and doesn't require customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_REGISTER_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/client/client_impl.dart
  
**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)


<div class="content-tabs" data-tab-group="tabgrp-963">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-963-0" data-tab-group="tabgrp-963" data-tab-active="true">SDK &gt;= 1.0.0</button><button class="tab-button" data-tab-id="tabgrp-963-1" data-tab-group="tabgrp-963">Legacy SDK</button></div>

<div class="tab-panel" data-tab-id="tabgrp-963-0" data-tab-group="tabgrp-963" data-tab-active="true">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; registerAccount(ClientAccountRegisterContext context, {required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **context** | [ClientAccountRegisterContext](/developers/mobile-sdk/class-reference/flutter/client#clientaccountregistercontext) | yes | - | Object with the customer's email, password, and other optional data |
| **onSuccess** | Function() | yes | - | Function to be executed when the operation is completed successfully |
| **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error |
  
**Return Value:**  
No value is returned.
  
**Example:**  

<pre><code class="language-Dart">ClientAccountRegisterContext clientAccountRegisterContext = ClientAccountRegisterContext(email: email, password: password);

await Synerise.client.registerAccount(clientAccountRegisterContext, onSuccess: () {
  //onSuccess handling
}, onError: (SyneriseError error) {
  //onError handling
});</code></pre>

</div>

<div class="tab-panel" data-tab-id="tabgrp-963-1" data-tab-group="tabgrp-963">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; registerAccount(ClientAccountRegisterContext context) async</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **context** | [ClientAccountRegisterContext](/developers/mobile-sdk/class-reference/flutter/client#clientaccountregistercontext) | yes | - | Object with the customer's email, password, and other optional data |

**Return Value:**  
No value is returned.
  
**Example:**  

<pre><code class="language-Dart">await Synerise.client.registerAccount(clientAccountRegisterContext).catchError((error)</code></pre>

</div>
</div>


<!-- reusable-table-boundary -->

## Request customer account activation
---
This method requests sending an email with a URL that confirms the registration and activates the account.
  
This method is a global operation and doesn't require customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CONFIRMATION_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/client/client_impl.dart  
  
**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)


<div class="content-tabs" data-tab-group="tabgrp-964">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-964-0" data-tab-group="tabgrp-964" data-tab-active="true">SDK &gt;= 1.0.0</button><button class="tab-button" data-tab-id="tabgrp-964-1" data-tab-group="tabgrp-964">Legacy SDK</button></div>

<div class="tab-panel" data-tab-id="tabgrp-964-0" data-tab-group="tabgrp-964" data-tab-active="true">

**Declaration:**    

<pre><code class="language-Dart">Future&lt;void&gt; requestAccountActivation(String email,
      {required void Function() onSuccess,
      required void Function(SyneriseError error) onError}) async</code></pre>


Before version 2.0.0, this method was called `activateAccount`
    
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | String | yes | - | Customer’s email |
| **onSuccess** | Function() | yes | - | Function to be executed when the operation is completed successfully |
| **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error |

**Return Value:**  
No value is returned.
  
**Example:**  

<pre><code class="language-Dart">await Synerise.client.synerise-flutter-sdkAccount(email, onSuccess: () {
      //onSuccess handling
    }, onError: (SyneriseError error) {
      //onError handling
    });</code></pre>

</div>

<div class="tab-panel" data-tab-id="tabgrp-964-1" data-tab-group="tabgrp-964">

**Declaration:**    

<pre><code class="language-Dart">Future&lt;void&gt; activateAccount(String email) async</code></pre>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | String | yes | - | Customer’s email |

**Return Value:**  
No value is returned.
  
**Example:**  

<pre><code class="language-Dart">await Synerise.client.activateAccount(email).catchError((error)</code></pre>

</div>
</div>


<!-- reusable-table-boundary -->

## Confirm customer account activation
---
This method confirms a customer account with the confirmation token.
  
This method is a global operation and doesn't require customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 400 status code if the account is already confirmed or 404 if the account does not exist.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CONFIRMATION_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/client/client_impl.dart
  
**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)
  

<div class="content-tabs" data-tab-group="tabgrp-965">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-965-0" data-tab-group="tabgrp-965" data-tab-active="true">SDK &gt;= 1.0.0</button><button class="tab-button" data-tab-id="tabgrp-965-1" data-tab-group="tabgrp-965">Legacy SDK</button></div>

<div class="tab-panel" data-tab-id="tabgrp-965-0" data-tab-group="tabgrp-965" data-tab-active="true">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; confirmAccountActivation(String token, {required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Before version 1.0.0, this method was called `confirmAccount`.

</div></div></div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **token** | String | yes | - | Customer’s token provided by email |
| **onSuccess** | Function() | yes | - | Function to be executed when the operation is completed successfully |
| **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error |

**Return Value:**  
No value is returned.
  
**Example:**  

<pre><code class="language-Dart">await Synerise.client.confirmAccountActivation(token, onSuccess: () {
      //onSuccess handling
    }, onError: (SyneriseError error) {
      //onError handling
    });</code></pre>

</div>

<div class="tab-panel" data-tab-id="tabgrp-965-1" data-tab-group="tabgrp-965">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; confirmAccountActivation(String token) async</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **token** | String | yes | - | Customer’s token provided by email |

**Return Value:**  
No value is returned.
  
**Example:**  

<pre><code class="language-Dart">await Synerise.client.confirmAccount(token).catchError((error)</code></pre>

</div>
</div>


<!-- reusable-table-boundary -->

## Request customer account activation by pin
---
This method requests a customer's account registration process with the PIN code.
  
This method is a global operation and doesn't require customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_PIN_CODE_RESEND_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/client/client_impl.dart
  
**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)
  

<div class="content-tabs" data-tab-group="tabgrp-966">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-966-0" data-tab-group="tabgrp-966" data-tab-active="true">SDK &gt;= 1.0.0</button><button class="tab-button" data-tab-id="tabgrp-966-1" data-tab-group="tabgrp-966">Legacy SDK</button></div>

<div class="tab-panel" data-tab-id="tabgrp-966-0" data-tab-group="tabgrp-966" data-tab-active="true">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; requestAccountActivationByPin(String email, {required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Description |
| --- | --- | --- | --- |
| **email** | String | yes | Customer's email |
| **onSuccess** | Function() | yes | - | Function to be executed when the operation is completed successfully |
| **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error |
  
**Return Value:**  
No value is returned.
  
**Example:**

<pre><code class="language-Dart">await Synerise.client.requestAccountActivationByPin(email, onSuccess: () {
  //onSuccess handling
}, onError: (SyneriseError error) {
  //onError handling
});</code></pre>

</div>

<div class="tab-panel" data-tab-id="tabgrp-966-1" data-tab-group="tabgrp-966">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; requestAccountActivationByPin(String email) async</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Description |
| --- | --- | --- | --- |
| **email** | String | yes | Customer's email |
  
**Return Value:**  
No value is returned.
  
**Example:**

<pre><code class="language-Dart">await Synerise.client.requestAccountActivationByPin(email).catchError((error) {</code></pre>

</div>
</div>


<!-- reusable-table-boundary -->

## Confirm customer account activation by pin
---
This method confirms a customer's account registration process with the PIN code.
  
This method is a global operation and doesn't require customer authentication.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_PIN_CODE_RESEND_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/client/client_impl.dart

**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)
  

<div class="content-tabs" data-tab-group="tabgrp-967">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-967-0" data-tab-group="tabgrp-967" data-tab-active="true">SDK &gt;= 1.0.0</button><button class="tab-button" data-tab-id="tabgrp-967-1" data-tab-group="tabgrp-967">Legacy SDK</button></div>

<div class="tab-panel" data-tab-id="tabgrp-967-0" data-tab-group="tabgrp-967" data-tab-active="true">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; confirmAccountActivationByPin(String email, String pinCode, {required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>


**Parameters:**  
| Parameter | Type | Mandatory | Description |
| --- | --- | --- | --- |
| **pinCode** | String | yes | Code sent to a customer's email |
| **email** | String | yes | Customer's email |
| **onSuccess** | Function() | yes | Function to be executed when the operation is completed successfully |
| **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | Function to be executed when the operation is completed with an error |

**Return Value:**  
No value is returned.
  
**Example:**  

<pre><code class="language-Dart">await Synerise.client.confirmAccountActivationByPin(email, pinCode, onSuccess: () {
      //onSuccess handling
    }, onError: (SyneriseError error) {
      //onError handling
    });</code></pre>

</div>

<div class="tab-panel" data-tab-id="tabgrp-967-1" data-tab-group="tabgrp-967">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; confirmAccountActivationByPin(String email, String pinCode) async</code></pre>


**Parameters:**  
| Parameter | Type | Mandatory | Description |
| --- | --- | --- | --- |
| **pinCode** | String | yes | Code sent to a customer's email |
| **email** | String | yes | Customer's email |
  
**Return Value:**  
No value is returned.
  
**Example:**

<pre><code class="language-Dart">await Synerise.client.confirmAccountActivationByPin(email, pinCode).catchError((error) {</code></pre>

</div>
</div>


<!-- reusable-table-boundary -->

## Sign in a customer
---
This method signs a customer in to obtain a JSON Web Token (JWT) which can be used in subsequent requests.
  
The SDK will refresh the token before each call if it is about to expire (but not expired).
  
Do NOT allow signing in again (or signing up) when a customer is already signed in. First, sign the customer out.
  
Do NOT create multiple instances nor call this method multiple times before execution.
<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/client/client_impl.dart
  
**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)
  

<div class="content-tabs" data-tab-group="tabgrp-968">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-968-0" data-tab-group="tabgrp-968" data-tab-active="true">SDK &gt;= 1.0.0</button><button class="tab-button" data-tab-id="tabgrp-968-1" data-tab-group="tabgrp-968">Legacy SDK</button></div>

<div class="tab-panel" data-tab-id="tabgrp-968-0" data-tab-group="tabgrp-968" data-tab-active="true">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; signIn(String email, String password, {required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | String | yes | - | Customer’s email |
| **password** | String | yes | - | Customer’s password |
| **onSuccess** | Function() | yes | - | Function to be executed when the operation is completed successfully |
| **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error |

**Return Value:**  
No value is returned.

**Example:**  

<pre><code class="language-Dart">await Synerise.client.signIn(email, password, onSuccess: () {
  //onSuccess handling
}, onError: (SyneriseError error) {
  //onError handling
});</code></pre>

</div>

<div class="tab-panel" data-tab-id="tabgrp-968-1" data-tab-group="tabgrp-968">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; signIn(String email, String password) async</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | String | yes | - | Customer’s email |
| **password** | String | yes | - | Customer’s password |

**Return Value:**  
No value is returned.

**Example:**  

<pre><code class="language-Dart">await Synerise.client.signIn(email,password).catchError((error)</code></pre>

</div>
</div>


<!-- reusable-table-boundary -->

## Sign in a customer conditionally
---
<!-- reusable-table-boundary -->

This method signs a customer in to obtain a JSON Web Token (JWT) which can be used in subsequent requests.
  
The SDK will refresh the token before each call if it is about to expire (but not expired).
  
Do NOT allow signing in again (or signing up) when a customer is already signed in. First, sign the customer out.
  
Do NOT create multiple instances nor call this method multiple times before execution.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | n/a |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/client/client_impl.dart
  
**Related To:**  
[ClientConditionalAuthResult](/developers/mobile-sdk/class-reference/flutter/client#clientconditionalauthresult)  

**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)
  

<div class="content-tabs" data-tab-group="tabgrp-969">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-969-0" data-tab-group="tabgrp-969" data-tab-active="true">SDK &gt;= 1.0.0</button><button class="tab-button" data-tab-id="tabgrp-969-1" data-tab-group="tabgrp-969">Legacy SDK</button></div>

<div class="tab-panel" data-tab-id="tabgrp-969-0" data-tab-group="tabgrp-969" data-tab-active="true">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; signInConditionally(String email, String password,
      {required void Function(ClientConditionalAuthResult) onSuccess,
      required void Function(SyneriseError error) onError}) async</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Description |
| --- | --- | --- | --- |
| **email** | String | yes | Customer's email |
| **password** | String | yes | Customer's password |
  
**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-960">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-960-0" data-tab-group="tabgrp-960" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-960-0" data-tab-group="tabgrp-960" data-tab-active="true">

```Dart
await Synerise.client.signInConditionally(email, password, onSuccess: (ClientConditionalAuthResult result) {
      //onSuccess handling
    }, onError: (SyneriseError error) {
      //onError handling
    });
```

</div>
</div>

</div>

<div class="tab-panel" data-tab-id="tabgrp-969-1" data-tab-group="tabgrp-969">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;ClientConditionalAuthResult&gt; signInConditionally(String email, String password) async</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Description |
| --- | --- | --- | --- |
| **email** | String | yes | Customer's email |
| **password** | String | yes | Customer's password |
  
**Return Value:**  
[ClientConditionalAuthResult](/developers/mobile-sdk/class-reference/flutter/client#clientconditionalauthresult)
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-961">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-961-0" data-tab-group="tabgrp-961" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-961-0" data-tab-group="tabgrp-961" data-tab-active="true">

```Dart
await Synerise.client.signInConditionally(email, password).catchError((error)
```

</div>
</div>

</div>
</div>


<!-- reusable-table-boundary -->

## Authenticate customer by IdentityProvider
---
<!-- reusable-table-boundary -->

This method authenticates a customer with OAuth, Facebook, Google, Apple, or Synerise.
  
If an account for the customer does not exist and the identity provider is different than Synerise, this request creates an account.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | 0.3.0 |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/client/client_impl.dart  
  
**Related To:**  
[ClientAuthContext](/developers/mobile-sdk/class-reference/flutter/client#clientauthcontext)  
[ClientIdentityProvider](/developers/mobile-sdk/class-reference/flutter/client#clientidentityprovider)  
  
**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)


<div class="content-tabs" data-tab-group="tabgrp-970">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-970-0" data-tab-group="tabgrp-970" data-tab-active="true">SDK &gt;= 1.0.0</button><button class="tab-button" data-tab-id="tabgrp-970-1" data-tab-group="tabgrp-970">Legacy SDK</button></div>

<div class="tab-panel" data-tab-id="tabgrp-970-0" data-tab-group="tabgrp-970" data-tab-active="true">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; authenticate(ClientAuthContext clientAuthContext, IdentityProvider identityProvider, String tokenString,
    {required void Function(bool) onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **clientAuthContext** | [ClientAuthContext](/developers/mobile-sdk/class-reference/flutter/client#clientauthcontext) | yes | - | Object which contains agreements, attributes, and identifier of authorization |
| **identityProvider** | [ClientIdentityProvider](/developers/mobile-sdk/class-reference/flutter/client#clientidentityprovider) | yes | - | Provider of your token |
| **tokenString** | String | yes | - | Token retrieved from provider |
| **onSuccess** | Function() | yes | - | Function to be executed when the operation is completed successfully |
| **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error |

**Return Value:**  
No value is returned.
  
**Example:**  

<pre><code class="language-Dart">await Synerise.client.authenticate(clientAuthContext, identityProvider, tokenString, onSuccess: (bool result) {
      //onSuccess handling
    }, onError: (SyneriseError error) {
      //onError handling
    });</code></pre>

</div>

<div class="tab-panel" data-tab-id="tabgrp-970-1" data-tab-group="tabgrp-970">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;bool&gt; authenticate(ClientAuthContext clientAuthContext, IdentityProvider identityProvider, String tokenString) async</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **clientAuthContext** | [ClientAuthContext](/developers/mobile-sdk/class-reference/flutter/client#clientauthcontext) | yes | - | Object which contains agreements, attributes, and identifier of authorization |
| **identityProvider** | [ClientIdentityProvider](/developers/mobile-sdk/class-reference/flutter/client#clientidentityprovider) | yes | - | Provider of your token |
| **tokenString** | String | yes | - | Token retrieved from provider |
  
**Return Value:**  
**true** if the operation is success, otherwise it throws an error.
  
**Example:**  

<pre><code class="language-Dart">await Synerise.client.authenticate(clientAuthContext, identityProvider, tokenString).catchError((error)</code></pre>

</div>
</div>


<!-- reusable-table-boundary -->

## Authenticate customer conditionally by IdentityProvider
---
<!-- reusable-table-boundary -->

This method authenticates a customer with OAuth, Facebook, Google, Apple, or Synerise.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | n/a |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/client/client_impl.dart

**Related To:**  
[ClientConditionalAuthResult](/developers/mobile-sdk/class-reference/flutter/client#clientconditionalauthresult)  
[ClientIdentityProvider](/developers/mobile-sdk/class-reference/flutter/client#clientidentityprovider)
  
**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)
  

<div class="content-tabs" data-tab-group="tabgrp-971">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-971-0" data-tab-group="tabgrp-971" data-tab-active="true">SDK &gt;= 1.0.0</button><button class="tab-button" data-tab-id="tabgrp-971-1" data-tab-group="tabgrp-971">Legacy SDK</button></div>

<div class="tab-panel" data-tab-id="tabgrp-971-0" data-tab-group="tabgrp-971" data-tab-active="true">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; authenticateConditionally(ClientAuthContext clientAuthContext, IdentityProvider identityProvider, String tokenString,
    {String? authID, required void Function(ClientConditionalAuthResult) onSuccess, required void Function(SyneriseError) onError}) async</code></pre>


**Parameters:**  
| Parameter | Type | Optional | Description |
| --- | --- | --- | --- |
| **clientAuthContext** | [ClientAuthContext](/developers/mobile-sdk/class-reference/flutter/client#clientauthcontext) | no | Object which contains agreements and attributes |
| **identityProvider** | [ClientIdentityProvider](/developers/mobile-sdk/class-reference/flutter/client#clientidentityprovider) | no | Provider of your token |
| **tokenString** | String | no | Token retrieved from provider |
| **authID** | String | yes | Optional identifier of authorization |
| **onSuccess** | Function([ClientConditionalAuthResult](/developers/mobile-sdk/class-reference/flutter/client#clientconditionalauthresult) result) | yes | Function to be executed when the operation is completed successfully |
| **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | Function to be executed when the operation is completed with an error |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authID** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>

  
**Return Value:**  
No value is returned.
  
**Example:**  

<pre><code class="language-Dart">Token token = Token(tokenString: "tokenString", origin: TokenOrigin.anonymous, expirationDate: DateTime;
    await Synerise.client.retrieveToken(onSuccess: (Token token) {
      token = token;
    }, onError: (SyneriseError error) {
    //onError handling
    });
    String tokenString = token.tokenString;
    IdentityProvider identityProvider = IdentityProvider.oauth;
    
    await Synerise.client.authenticateConditionally(identityProvider, tokenString, onSuccess: (ClientConditionalAuthResult result) {
      //onSuccess handling
    }, onError: (SyneriseError error) {
      //onError handling
    });</code></pre>

</div>

<div class="tab-panel" data-tab-id="tabgrp-971-1" data-tab-group="tabgrp-971">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;ClientConditionalAuthResult&gt; authenticateConditionally(ClientAuthContext clientAuthContext, IdentityProvider identityProvider, String tokenString) async</code></pre>


**Parameters:**  
| Parameter | Type | Optional | Description |
| --- | --- | --- | --- |
| **token** | String | no | Token retrieved from provider |
| **clientIdentityProvider** | [ClientIdentityProvider](/developers/mobile-sdk/class-reference/flutter/client#clientidentityprovider) | no | Provider of your token |
| **authID** | String | yes | Optional identifier of authorization |
| **context** | [ClientConditionalAuthContext](/developers/mobile-sdk/class-reference/flutter/client#clientconditionalauthcontext) | no | Object which contains agreements and attributes |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authID** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>

  
**Return Value:**  
[ClientConditionalAuthResult](/developers/mobile-sdk/class-reference/flutter/client#clientconditionalauthresult)
  
**Example:**

<pre><code class="language-Dart">ClientAgreements? agreements = ClientAgreements(push: false, rfid: false, wifi: false);
    Map&lt;String, Object&gt;? attributes;
    ClientAuthContext clientAuthContext = ClientAuthContext(authId: 'AUTH_ID', agreements: agreements, attributes: attributes);
    Token token = await Synerise.client.retrieveToken().catchError((error) {
      String errorMessage = Utils.handlePlatformException(error);
      Utils.displaySimpleAlert("error on handling api call \n $errorMessage", context);
      throw Exception(errorMessage);
    });
    String tokenString = token.tokenString;
    IdentityProvider identityProvider = IdentityProvider.oauth;
    
    ClientConditionalAuthResult result =
        await Synerise.client.authenticateConditionally(clientAuthContext, identityProvider, tokenString).catchError((error) {
      String errorMessage = Utils.handlePlatformException(error);
      Utils.displaySimpleAlert("error on handling api call: you need to be signed in to authenticate \n $errorMessage", context);
      throw Exception(errorMessage);
    });</code></pre>

</div>
</div>


<!-- reusable-table-boundary -->

## Authenticate customer via Simple Profile Authentication
---
<!-- reusable-table-boundary -->

This method authenticates a customer with Simple Profile Authentication.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.14.0 | 5.7.1 | 0.15.0 | 0.7.0 |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

When you use this method, you must set a request validation salt by using the `Synerise.setRequestValidationSalt(_:)` method (if salt is enabled for Simple Profile Authentication).

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_SIMPLE_AUTH_CREATE` from the **Auth** group.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/client/client_impl.dart
  
**Related To:**  
[ClientSimpleAuthenticationData](/developers/mobile-sdk/class-reference/flutter/client#clientsimpleauthenticationdata)  
  
**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)
  

<div class="content-tabs" data-tab-group="tabgrp-972">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-972-0" data-tab-group="tabgrp-972" data-tab-active="true">SDK &gt;= 1.0.0</button><button class="tab-button" data-tab-id="tabgrp-972-1" data-tab-group="tabgrp-972">Legacy SDK</button></div>

<div class="tab-panel" data-tab-id="tabgrp-972-0" data-tab-group="tabgrp-972" data-tab-active="true">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; simpleAuthentication(ClientSimpleAuthenticationData data, String authID, {required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>


**Parameters:**  
| Parameter | Type | Mandatory | Description |
| --- | --- | --- | --- |
| **data** | [ClientSimpleAuthenticationData](/developers/mobile-sdk/class-reference/flutter/client#clientsimpleauthenticationdata) | yes | Object which contains customer data |
| **authID** | String | yes | Required identifier of authorization |
| **onSuccess** | Function() | yes | - | Function to be executed when the operation is completed successfully |
| **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authID** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>


**Return Value:**  
No value is returned.

**Example:**  

<pre><code class="language-Dart">ClientSimpleAuthenticationData data =
        ClientSimpleAuthenticationData(firstName: firstName, lastName: lastName, email: email, customId: customID);
    await Synerise.client.simpleAuthentication(data, authID, onSuccess: () {
      //onSuccess handling
    }, onError: (SyneriseError error) {
      //onError handling
    });</code></pre>

</div>

<div class="tab-panel" data-tab-id="tabgrp-972-1" data-tab-group="tabgrp-972">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; simpleAuthentication(ClientSimpleAuthenticationData clientSimpleAuthenticationData, String authID) async</code></pre>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **data** | [ClientSimpleAuthenticationData](/developers/mobile-sdk/class-reference/flutter/client#clientsimpleauthenticationdata) | yes | - | Object which contains customer data |
| **authID** | String | yes | null | Required identifier of authorization |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authID** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>

  
**Return Value:**  
No value is returned.

</div>
</div>


<!-- reusable-table-boundary -->

## Check if a customer is signed in (via RaaS, OAuth, Facebook, Apple)
---
This method checks if a customer is signed in (via Synerise Authentication - RaaS, OAuth, Facebook, Apple).
**Declared In:**  
lib/modules/client/client_impl.dart

**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)
  
**Declaration:**  

<pre><code class="language-Dart">Future&lt;bool&gt; isSignedIn() async</code></pre>


**Return Value:**  
**true** if the customer is signed in, otherwise returns **false**.
  
**Example:**  

<pre><code class="language-Dart">bool isSignedInBool = await Synerise.client.isSignedIn();</code></pre>


## Check if a customer is signed in (via Simple Profile Authentication)
---
<!-- reusable-table-boundary -->

This method checks if a customer is signed in (via Simple Profile Authentication).
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.14.0 | 5.7.1 | 0.15.0 | 0.7.0 |

<!-- reusable-table-boundary -->
**Declared In:**  
lib/modules/client/client_impl.dart
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/flutter/modules#client)
  
**Declaration:**  

<pre><code class="language-Dart">Future&lt;bool&gt; isSignedInViaSimpleAuthentication() async</code></pre>

    
**Return Value:**  
**true** if the customer is signed in (via Simple Profile Authentication), otherwise returns **false**.

**Example:**  

<pre><code class="language-Dart">await Synerise.client
        .isSignedInViaSimpleAuthentication()
        .then((bool result) {
      if (result == true) {
        //result handling
      } else {
        //error handling
      }
    });</code></pre>


## Sign out a customer
---
This method signs out a customer out.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This method works with every authentication type (via Synerise, External Provider, OAuth or Simple Profile Authentication).

</div></div></div>

 **Declared In:**  
lib/modules/client/client_impl.dart
  
**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)
  
**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; signOut() async</code></pre>


**Return Value:**  
No value is returned.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-962">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-962-0" data-tab-group="tabgrp-962" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-962-0" data-tab-group="tabgrp-962" data-tab-active="true">

```Dart
Synerise.client.signOut().whenComplete(() => {
      //onSuccess handling
    });
```

</div>
</div>


## Sign out customer with mode or from all devices
---
<!-- reusable-table-boundary -->

This method signs out a customer out with a chosen mode and Determines if the method should sign out all devices.

Available modes:
- `.signOut` mode signs out the customer.
- `.signOutWithSessionDestroy` mode signs out the customer and additionally, clears the anonymous session and regenerates the customer UUID.

The `fromAllDevices` parameter determines whether the method should notify the backend to sign out all devices.

**IMPORTANT: It is an asynchronous method.**
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.11.0 | 5.1.0 | 0.14.0 | 1.0.0 |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This method works with every authentication type (via Synerise, External Provider, OAuth or Simple Profile Authentication).

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/client/client_impl.dart
  
**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)
  

<div class="content-tabs" data-tab-group="tabgrp-973">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-973-0" data-tab-group="tabgrp-973" data-tab-active="true">SDK &gt;= 1.0.0</button><button class="tab-button" data-tab-id="tabgrp-973-1" data-tab-group="tabgrp-973">Legacy SDK</button></div>

<div class="tab-panel" data-tab-id="tabgrp-973-0" data-tab-group="tabgrp-973" data-tab-active="true">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; signOutWithMode(ClientSignOutMode mode, bool fromAllDevices, {required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

    
**Parameters:**  
| Parameter | Type | Mandatory | Description |
| --- | --- | --- | --- |
| **mode** | [ClientSignOutMode](/developers/mobile-sdk/class-reference/flutter/client#clientsignoutmode) | yes | Mode of signing out |
| **fromAllDevices** | bool | yes | Determines if the method should sign out all devices |
| **onSuccess** | Function() | yes | - | Function to be executed when the operation is completed successfully |
| **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error |

**Return Value:**  
No value is returned.
  
**Example:**

<pre><code class="language-Dart">ClientSignOutMode mode = ClientSignOutMode.signOutWithSessionDestroy;
    bool fromAllDevices = true;
    await Synerise.client.signOutWithMode(mode, fromAllDevices, onSuccess: () {
      //onSuccess handling
    }, onError: (SyneriseError error) {
      //onError handling
    });</code></pre>

</div>

<div class="tab-panel" data-tab-id="tabgrp-973-1" data-tab-group="tabgrp-973">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; signOutWithMode(ClientSignOutMode mode, bool fromAllDevices) async</code></pre>

    
**Parameters:**  
| Parameter | Type | Mandatory | Description |
| --- | --- | --- | --- |
| **mode** | [ClientSignOutMode](/developers/mobile-sdk/class-reference/flutter/client#clientsignoutmode) | yes | Mode of signing out |
| **fromAllDevices** | bool | yes | Determines if the method should sign out all devices |

**Return Value:**  
No value is returned.
  
**Example:**

<pre><code class="language-Dart">ClientSignOutMode mode = ClientSignOutMode.signOutWithSessionDestroy;
    bool fromAllDevices = true;
    await Synerise.client.signOutWithMode(mode, fromAllDevices).catchError((error) {</code></pre>

</div>
</div>


<!-- reusable-table-boundary -->





# Synerise Authentication



<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to handling identifiers](/docs/settings/configuration/identifier-standardization).

</div></div></div>


Synerise Authentication (also known as Registration as a Service) provides customer identity and account management features native to Synerise without any need for third party systems. To use RaaS, implement a set of methods listed below in your application.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

For a full list of available methods, see the [method reference section](/developers/mobile-sdk/method-reference).

</div></div></div>


Additionally, in the Synerise platform (`app.synerise.com`) you can define the following settings:
- [Registration mode](/docs/settings/tool/iam-for-apps/synerise#registration-mode)
- [Assignment of loyalty card](/docs/settings/tool/iam-for-apps/general#loyalty-card-assignment)
- [JWT longevity](/docs/settings/tool/iam-for-apps/general#jwt-lifetime)
- [Custom ID overwriting](/docs/settings/tool/iam-for-apps/general#custom-id-overwriting)
- [External ID overwriting](/docs/settings/tool/iam-for-apps/general#external-id-overwriting)
- [Enabling email address change through a link in the email](/docs/settings/tool/iam-for-apps/general#email-address-change)
- [Templates of email notifications](/docs/settings/tool/iam-for-apps/general#templates) such as account confirmation, email change request, PIN confirmation, and so on.
- [Password policy](/docs/settings/tool/iam-for-apps/synerise#password-policy)

## Registration methods
---

### Register new customers

This method lets you pass all customer information along with any agreements and attributes at once.

The primary unique identifier used by Synerise is the email address. However, you may also define a `customId` as a unique identifier. You can read more [here](/docs/settings/configuration/non-unique-emails).


| OS           | Method                                                                                                                                    |
|--------------|-------------------------------------------------------------------------------------------------------------------------------------------|
| Android      | [Client.registerAccount(registerClient)](/developers/mobile-sdk/method-reference/android/client-authentication#register-customer-account)                |
| iOS          | [Client.registerAccount(context:success:failure:)](/developers/mobile-sdk/method-reference/ios/client-authentication#register-customer-account) |
| React Native | [Synerise.Client.registerAccount(context, onSuccess, onError)](/developers/mobile-sdk/method-reference/react-native/client-authentication#register-customer-account)       |
| Flutter | [Synerise.client.registerAccount(context)](/developers/mobile-sdk/method-reference/flutter/client-authentication#register-customer-account)       |


Depending on backend configuration at Synerise, the registration may or may not require email confirmations/ The following registration behaviors are supported:


| Name                        | Description                                                                                                                                                        |
|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Automatic                   | The account is ready to use right after registration, no confirmations are required. Customer has the attribute `snrs_email_confirmed` set to `false`.         |
| Email Confirmation Required | The account is ready to use right after registration, but the email confirmation is required. The confirmation sets `snrs_email_confirmed` to `true`.          |
| Email Activation Required   | An activation email is sent and the account cannot be used until the address is confirmed. Activation also means that `snrs_email_confirmed` is set to `true`. |
| PIN Activation Required   | An activation email is sent and the account cannot be used until the PIN sent in the email is provided ([Android](/developers/mobile-sdk/method-reference/android/client-authentication#request-customer-account-activation-by-pin), [iOS](/developers/mobile-sdk/method-reference/ios/client-authentication#request-customer-account-activation-by-pin), [React Native](/developers/mobile-sdk/method-reference/react-native/client-authentication#request-customer-account-activation-by-pin)). |

### Request customer account activation by email

This method requests sending an email with a URL that confirms the registration and activates the account.

| OS           | Method                                                                                                                |
|--------------|-----------------------------------------------------------------------------------------------------------------------|
| Android      | [Client.requestAccountActivation(email)](/developers/mobile-sdk/method-reference/android/client-authentication#request-customer-account-activation)               |
| iOS          | [Client.requestAccountActivation(email:success:failure:)](/developers/mobile-sdk/method-reference/ios/client-authentication#request-customer-account-activation)                     |
| React Native | [Synerise.Client.requestAccountActivation(email, onSuccess, onError)](/developers/mobile-sdk/method-reference/react-native/client-authentication#request-customer-account-activation) |
| Flutter      | [Synerise.client.requestAccountActivation(email)](/developers/mobile-sdk/method-reference/flutter/client-authentication#request-customer-account-activation) |

### Confirm customer account activation

This method confirms a customer account with the confirmation token.

| OS           | Method                                                                                                                |
|--------------|-----------------------------------------------------------------------------------------------------------------------|
| Android      | [Client.confirmAccountActivation(token)](/developers/mobile-sdk/method-reference/android/client-authentication#confirm-customer-account-activation)               |
| iOS          | [Client.confirmAccountActivation(token:success:failure:)](/developers/mobile-sdk/method-reference/ios/client-authentication#confirm-customer-account-activation)                     |
| React Native | [Synerise.Client.confirmAccountActivation(token, onSuccess, onError)](/developers/mobile-sdk/method-reference/react-native/client-authentication#confirm-customer-account-activation) |
| Flutter      | [Synerise.client.confirmAccountActivation(token)](/developers/mobile-sdk/method-reference/flutter/client-authentication#confirm-customer-account-activation) |


### Request customer account by pin

This method requests sending an email to a customer with the PIN code needed during account registration process.

| OS           | Method                                                                                                                |
|--------------|-----------------------------------------------------------------------------------------------------------------------|
| Android      | [Client.requestAccountActivationByPin(email)](/developers/mobile-sdk/method-reference/android/client-authentication#request-customer-account-activation-by-pin)               |
| iOS          | [Client.requestAccountActivationByPin(email:success:failure:)](/developers/mobile-sdk/method-reference/ios/client-authentication#request-customer-account-activation-by-pin)                     |
| React Native | [Synerise.Client.requestAccountActivationByPin(email, onSuccess, onError)](/developers/mobile-sdk/method-reference/react-native/client-authentication#request-customer-account-activation-by-pin) |
| Flutter | n/a |


### Confirm customer account activation by pin

This method requires a customer to enter a PIN code during account registration process sent through an email.

| OS           | Method                                                                                                                |
|--------------|-----------------------------------------------------------------------------------------------------------------------|
| Android      | [Client.confirmAccountActivationByPin(pinCode, email)](/developers/mobile-sdk/method-reference/android/client-authentication#confirm-customer-account-activation-by-pin)               |
| iOS          | [Client.confirmAccountActivationByPin(pinCode:success:failure:)](/developers/mobile-sdk/method-reference/ios/client-authentication#confirm-customer-account-activation-by-pin)                     |
| React Native | [Synerise.Client.confirmAccountActivationByPin(pinCode, onSuccess, onError)](/developers/mobile-sdk/method-reference/react-native/client-authentication#confirm-customer-account-activation-by-pin) |
| Flutter | n/a |

## Authentication methods
---
Once a customer is registered, you can let users log in by implementing this method. After a successful log-in, the application receives a JWT token. The SDK refreshes that token while a customer is using the application and events are being sent (auto-refresh occurs only when the token is still valid).


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Token longevity can be changed in the Synerise application. You can learn how to do it in [this article](/docs/settings/tool/iam-for-apps/general#jwt-lifetime).

</div></div></div>


| OS           | Method                                                                                                                                                                                                                                                                                           |
|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Android      | - [Client.signIn()](/developers/mobile-sdk/method-reference/android/client-authentication#sign-in-a-customer) <br> - [Client.signInConditionally](/developers/mobile-sdk/method-reference/android/client-authentication#sign-in-a-customer-conditionally) |
| iOS          | - [Client.signIn(email:password:success:failure:)](/developers/mobile-sdk/method-reference/ios/client-authentication#sign-in-a-customer) <br> - [Client.signInConditionally(email:password:success:failure:)](/developers/mobile-sdk/method-reference/ios/client-authentication#sign-in-a-customer-conditionally) |
| React Native | [Synerise.Client.signIn()](/developers/mobile-sdk/method-reference/react-native/client-authentication#sign-in-a-customer) <br> [Synerise.Client.signInConditionally](/developers/mobile-sdk/method-reference/react-native/client-authentication#sign-in-a-customer-conditionally) |
| Flutter | [Synerise.client.signIn()](/developers/mobile-sdk/method-reference/flutter/client-authentication#sign-in-a-customer) |

## Other methods
---

### Check if a customer is signed in

This method checks if a customer is signed in through oAuth, Facebook, Sign in with Apple, or RaaS.


<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This method returns `false` if a customer is authenticated through [Simple Profile Authentication](/developers/mobile-sdk/user-identification-and-authorization/simple-authentication).

</div></div></div>


| OS           | Method                                                                                                                                    |
|--------------|-------------------------------------------------------------------------------------------------------------------------------------------|
| Android      | [Client.isSignedIn()](/developers/mobile-sdk/method-reference/android/client-authentication#check-if-a-customer-is-signed-in-via-raas-oauth-facebook-apple)                |
| iOS          | [Client.isSignedIn()](/developers/mobile-sdk/method-reference/ios/client-authentication#check-if-a-customer-is-signed-in-via-raas-oauth-facebook-apple) |
| React Native | [Synerise.Client.isSignedIn()](/developers/mobile-sdk/method-reference/react-native/client-authentication#check-if-a-customer-is-signed-in-via-raas-oauth-facebook-apple)       |
| Flutter | [Synerise.client.isSignedIn()](/developers/mobile-sdk/method-reference/flutter/client-authentication#check-if-a-customer-is-signed-in-via-raas-oauth-facebook-apple)      |

### Customer sign out

This method signs out the customer. The method terminates the JWT token and ends the customer session.

| OS           | Method                                                                                                                |
|--------------|-----------------------------------------------------------------------------------------------------------------------|
| Android      | - [Client.signOut()](/developers/mobile-sdk/method-reference/android/client-authentication#sign-out-customer) <br/> -  [Client.signOut(mode, signOutFromAllDevices)](/developers/mobile-sdk/method-reference/android/client-authentication#sign-out-customer-with-mode-or-from-all-devices) |
| iOS          | - [Client.signOut()](/developers/mobile-sdk/method-reference/ios/client-authentication#sign-out-customer) <br/> - [Client.signOut(mode:fromAllDevices:success:failure:)](/developers/mobile-sdk/method-reference/ios/client-authentication#sign-out-customer-with-mode-or-from-all-devices) |
| React Native | - [Synerise.Client.signOut()](/developers/mobile-sdk/method-reference/react-native/client-authentication#sign-out-a-customer) <br/> - [Synerise.Client.signOutWithMode(mode, fromAllDevices, onSuccess, onError)](/developers/mobile-sdk/method-reference/react-native/client-authentication#sign-out-customer-with-mode-or-from-all-devices) |
| Flutter | [Synerise.client.signOut()](/developers/mobile-sdk/method-reference/flutter/client-authentication#sign-out-a-customer) |



## What's next
---
When the customer's account is registered and/or they are signed in, you can implement [profile management methods](/developers/mobile-sdk/user-identification-and-authorization/identification-and-user-management#profile-management-methods) and [session management methods](/developers/mobile-sdk/user-identification-and-authorization/session-management).


# Customer authentication


## Set Client State delegate
---
This method sets an object for a customer's state delegate methods.
**Declared In:**  
Headers/SNRClient.h
  
**Related To:**  
[ClientStateDelegate](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#client-state-delegate)  
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1074">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1074-0" data-tab-group="tabgrp-1074" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1074-1" data-tab-group="tabgrp-1074">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1074-0" data-tab-group="tabgrp-1074" data-tab-active="true">

```Swift
static func setClientStateDelegate(_ delegate: ClientStateDelegate)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1074-1" data-tab-group="tabgrp-1074">

```Objective-C
+ (void)setClientStateDelegate:(SNRClientStateDelegate *)delegate
```

</div>
</div>

  
**Discussion:**  
Learn more about the methods and the purpose of this listener [here](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#client-state-delegate).

## Register customer account
---
This method registers a new customer with an email, password, and optional data.
  
This method requires the context object with a customer’s email, password, and optional data. Omitted fields are not modified.
  
Depending on the backend configuration, the account may require activation. For details, see  [customer registration](/developers/mobile-sdk/user-identification-and-authorization/overview).
  
Do not allow signing in again (or signing up) when a customer is already signed in. Sign the customer out first.
  
Do not create multiple instances nor call this method multiple times before execution.
  
This method is a global operation and doesn't require customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_REGISTER_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClient.h
  
**Related To:**  
[ClientRegisterAccountContext](/developers/mobile-sdk/class-reference/ios/client#clientregisteraccountcontext)
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1075">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1075-0" data-tab-group="tabgrp-1075" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1075-1" data-tab-group="tabgrp-1075">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1075-0" data-tab-group="tabgrp-1075" data-tab-active="true">

```Swift
static func registerAccount(context: ClientRegisterAccountContext, success: (() -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1075-1" data-tab-group="tabgrp-1075">

```Objective-C
+ (void)registerAccount:(nonnull SNRClientRegisterAccountContext *)context success:(nonnull void (^)(void))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **context** | [ClientRegisterAccountContext](/developers/mobile-sdk/class-reference/ios/client#clientregisteraccountcontext) | yes | - | Object with the customer's email, password, and other optional data |
| **success** | (() -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Since version 5.0.0, the **success** closure does NOT contain the `isSuccess` parameter.

</div></div></div>

  
**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1076">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1076-0" data-tab-group="tabgrp-1076" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1076-1" data-tab-group="tabgrp-1076">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1076-0" data-tab-group="tabgrp-1076" data-tab-active="true">

```Swift
let agreements: ClientAgreements = ClientAgreements()
agreements.email = true
agreements.sms = true
agreements.push = true
agreements.bluetooth = true
agreements.rfid = true
agreements.wifi = true
let email: String = "YOUR_EMAIL"
let password: String = "YOUR_PASSWORD"
let context: ClientRegisterAccountContext = ClientRegisterAccountContext(email: email, password: password)
context.firstName = "FIRST_NAME"
context.lastName = "LAST_NAME"
context.customId = "CUSTOM_ID"
context.sex = .male
context.phone = "123-456-789"
context.company = "Synerise"
context.address = "Lubostroń 1"
context.city = "Kraków"
context.province = "Małopolskie"
context.zipCode = "30-383"
context.countryCode = "+48"
context.agreements = agreements
context.attributes = ["attribute1": "value1", "attribute2": "value2"]
context.tags = ["tag1", "tag2" "tag3"]
Client.registerAccount(context: context, success: {
  // success
}, failure: { (error) in
  // failure
})
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1076-1" data-tab-group="tabgrp-1076">

```Objective-C
SNRClientAgreements *agreements = [SNRClientAgreements new];
agreements.email = true;
agreements.sms = true;
agreements.push = true;
agreements.bluetooth = true;
agreements.rfid = true;
agreements.wifi = true;
NSString *email = @"EMAIL";
NSString *password = @"PASSWORD";
SNRClientRegisterAccountContext *context = [SNRClientRegisterAccountContext alloc] initWithEmail:email andPassword:password];
context.firstName = @"FIRST_NAME";
context.lastName = @"LAST_NAME";
context.customId = @"CUSTOM_ID";
context.sex = SNRClientSexMale;
context.phone = @"123-456-789";
context.company = @"Synerise";
context.address = @"Lubostroń 1";
context.city = @"Kraków";
context.province = @"Małopolskie";
context.zipCode = @"30-383";
context.countryCode = @"+48";
context.agreements = agreements;
context.attributes = @{@"attribute": @"value"};
context.tags = @[@"tag1", @"tag2" @"tag3"];
[SNRClient registerAccount:context success:^() {
  // success
} failure:^(SNRApiError *error) {
  // failure
}];
```

</div>
</div>


<!-- reusable-table-boundary -->

## Request customer account activation
---
This method requests sending an email with a URL that confirms the registration and activates the account.
  
This method is a global operation and doesn't require customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CONFIRMATION_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClient.h

**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1077">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1077-0" data-tab-group="tabgrp-1077" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1077-1" data-tab-group="tabgrp-1077">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1077-0" data-tab-group="tabgrp-1077" data-tab-active="true">

```Swift
static func requestAccountActivation(email: String, success: (() -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1077-1" data-tab-group="tabgrp-1077">

```Objective-C
+ (void)requestAccountActivationWithEmail:(nonnull NSString *)email success:(nonnull void (^)(void))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | String | yes | - | Customer's email |
| **success** | (() -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Before version 5.0.0, this method was called `Synerise.activateAccount(email:success:failure:)`.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Since version 5.0.0, the **success** closure does NOT contain the `isSuccess` parameter.

</div></div></div>


**Return Value:**  
No value is returned.

**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1078">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1078-0" data-tab-group="tabgrp-1078" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1078-1" data-tab-group="tabgrp-1078">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1078-0" data-tab-group="tabgrp-1078" data-tab-active="true">

```Swift
let email: String = "EMAIL"
Client.requestAccountActivation(email: email, success: {
  // success   
}) { (error) in
  // failure 
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1078-1" data-tab-group="tabgrp-1078">

```Objective-C
NSString *email = @"EMAIL";
[SNRClient requestAccountActivationWithEmail:email success:^() {
  // success
} failure:^(NSError * error) {
  // failure
}];
```

</div>
</div>


<!-- reusable-table-boundary -->

## Confirm customer account activation
---
This method confirms a customer account with the confirmation token.
  
This method is a global operation and doesn't require customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 400 status code if the account is already confirmed or 404 if the account does not exist.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CONFIRMATION_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClient.h
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1079">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1079-0" data-tab-group="tabgrp-1079" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1079-1" data-tab-group="tabgrp-1079">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1079-0" data-tab-group="tabgrp-1079" data-tab-active="true">

```Swift
static func confirmAccountActivation(token: String, success: (() -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1079-1" data-tab-group="tabgrp-1079">

```Objective-C
+ (void)confirmAccountActivationByToken:(nonnull NSString *)token success:(nonnull void (^)(void))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **token** | String | yes | - | Confirmation token |
| **success** | (() -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Before version 5.0.0, this method was called `Synerise.confirmAccount(token:success:failure:)`.

</div></div></div>

  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Since version 5.0.0, the **success** closure does NOT contain the `isSuccess` parameter.

</div></div></div>

  
**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1080">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1080-0" data-tab-group="tabgrp-1080" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1080-1" data-tab-group="tabgrp-1080">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1080-0" data-tab-group="tabgrp-1080" data-tab-active="true">

```Swift
let token: String = "TOKEN"
Client.confirmAccountActivation(token: token, success: {
  // success
}, failure: { (error) in
  // failure
})
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1080-1" data-tab-group="tabgrp-1080">

```Objective-C
NSString *token = @"TOKEN";
[SNRClient confirmAccountActivationByToken:token success:^() {
  // success
} failure:^(SNRApiError *error) {
  // failure
}];
```

</div>
</div>


<!-- reusable-table-boundary -->

## Request customer account activation by pin
---
This method requests a customer's account registration process with the PIN code.
  
This method is a global operation and doesn't require customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_PIN_CODE_RESEND_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClient.h
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1081">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1081-0" data-tab-group="tabgrp-1081" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1081-1" data-tab-group="tabgrp-1081">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1081-0" data-tab-group="tabgrp-1081" data-tab-active="true">

```Swift
static func requestAccountActivationByPin(email: String, success: (() -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1081-1" data-tab-group="tabgrp-1081">

```Objective-C
+ (void)requestAccountActivationByPinWithEmail:(nonnull NSString *)email success:(nonnull void (^)(void))success failure:(nonnull void (^)(SNRApiError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | String | yes | - | Customer's email |
| **success** | (() -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Since version 5.0.0, the **success** closure does NOT contain the `isSuccess` parameter.

</div></div></div>


**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1082">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1082-0" data-tab-group="tabgrp-1082" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1082-1" data-tab-group="tabgrp-1082">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1082-0" data-tab-group="tabgrp-1082" data-tab-active="true">

```Swift
let email: String = "EMAIL"
Client.requestAccountActivationByPin(email: email, success: {
  // success
}) { (error) in
  // failure
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1082-1" data-tab-group="tabgrp-1082">

```Objective-C
NSString *email = @"EMAIL";
[SNRClient requestAccountActivationByPinWithEmail:email success:^() {
  // success
} failure:^(SNRApiError *error) {
  // failure
}];
```

</div>
</div>


<!-- reusable-table-boundary -->

## Confirm customer account activation by pin
---
This method confirms a customer's account registration process with the PIN code.
  
This method is a global operation and doesn't require customer authentication.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_PIN_CODE_RESEND_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClient.h
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1083">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1083-0" data-tab-group="tabgrp-1083" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1083-1" data-tab-group="tabgrp-1083">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1083-0" data-tab-group="tabgrp-1083" data-tab-active="true">

```Swift
static func confirmAccountActivationByPin(pinCode: String, email: String, success: (() -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1083-1" data-tab-group="tabgrp-1083">

```Objective-C
+ (void)confirmAccountActivationByPin:(nonnull NSString *)pinCode email:(nonnull NSString *)email success:(nonnull void (^)(void))success failure:(nonnull void (^)(SNRApiError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **pinCode** | String | yes | - | Code sent to a customer's email |
| **email** | String | yes | - | Customer's email |
| **success** | (() -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Since version 5.0.0, the **success** closure does NOT contain the `isSuccess` parameter.

</div></div></div>

  
**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1084">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1084-0" data-tab-group="tabgrp-1084" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1084-1" data-tab-group="tabgrp-1084">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1084-0" data-tab-group="tabgrp-1084" data-tab-active="true">

```Swift
let pinCode: String = "PIN_CODE"
let email: String = "EMAIL"
Client.confirmAccountActivationByPin(pinCode: pinCode, email: email, success: {
  // success
}) { (error) in
  // failure
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1084-1" data-tab-group="tabgrp-1084">

```Objective-C
NSString *pinCode = @"PIN_CODE";
NSString *email = @"EMAIL";
[SNRClient confirmAccountActivationByPin:pinCode email:email success:^() {
  // success
} failure:^(SNRApiError *error) {
  // failure
}];
```

</div>
</div>


<!-- reusable-table-boundary -->

## Sign in a customer
---
This method signs a customer in to obtain a JSON Web Token (JWT) which can be used in subsequent requests.
  
The SDK will refresh the token before each call if it is about to expire (but not expired).
  
Do NOT allow signing in again (or signing up) when a customer is already signed in. First, sign the customer out.
  
Do NOT create multiple instances nor call this method multiple times before execution.
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClient.h
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1085">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1085-0" data-tab-group="tabgrp-1085" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1085-1" data-tab-group="tabgrp-1085">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1085-0" data-tab-group="tabgrp-1085" data-tab-active="true">

```Swift
static func signIn(email: String, password: String, success: (() -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1085-1" data-tab-group="tabgrp-1085">

```Objective-C
+ (void)signInWithEmail:(nonnull NSString *)email password:(nonnull NSString *)password success:(nonnull void (^)(void))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | String | yes | - | Customer's email |
| **password** | String | yes | - | Customer's password |
| **success** | (() -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Since version 5.0.0, the **success** closure does NOT contain the `isSuccess` parameter.

</div></div></div>

  
**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1086">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1086-0" data-tab-group="tabgrp-1086" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1086-1" data-tab-group="tabgrp-1086">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1086-0" data-tab-group="tabgrp-1086" data-tab-active="true">

```Swift
let email: String = "EMAIL"
let password: String = "PASSWORD"
Client.signIn(email: email, password: password, success: {
  // success
}, failure: { (error) in
  // failure
})
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1086-1" data-tab-group="tabgrp-1086">

```Objective-C
NSString *email = @"EMAIL";
NSString *password = @"PASSWORD";
[SNRClient signInWithEmail:email password:password success:^() {
  // success
} failure:^(SNRApiError *error) {
  // failure
}];
```

</div>
</div>


<!-- reusable-table-boundary -->

## Sign in a customer conditionally
---
<!-- reusable-table-boundary -->

This method signs a customer in to obtain a JSON Web Token (JWT) which can be used in subsequent requests.
  
The SDK will refresh the token before each call if it is about to expire (but not expired).
  
Do NOT allow signing in again (or signing up) when a customer is already signed in. First, sign the customer out.
  
Do NOT create multiple instances nor call this method multiple times before execution.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | n/a |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClient.h
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1087">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1087-0" data-tab-group="tabgrp-1087" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1087-1" data-tab-group="tabgrp-1087">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1087-0" data-tab-group="tabgrp-1087" data-tab-active="true">

```Swift
static func signInConditionally(email: String, password: String, success: ((ClientAuthenticationResult) -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1087-1" data-tab-group="tabgrp-1087">

```Objective-C
+ (void)signInConditionallyWithEmail:(nonnull NSString *)email password:(nonnull NSString *)password success:(nonnull void (^)(SNRClientAuthenticationResult *result))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | String | yes | - | Customer's email |
| **password** | String | yes | - | Customer's password |
| **success** | ((ClientAuthenticationResult) -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  
**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1088">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1088-0" data-tab-group="tabgrp-1088" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1088-1" data-tab-group="tabgrp-1088">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1088-0" data-tab-group="tabgrp-1088" data-tab-active="true">

```Swift
let email: String = "EMAIL"
let password: String = "PASSWORD"
Client.signInConditionally(email: email, password: password, success: { (result) in
  // success
}, failure: { (error) in
  // failure
})
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1088-1" data-tab-group="tabgrp-1088">

```Objective-C
NSString *email = @"EMAIL";
NSString *password = @"PASSWORD";
[SNRClient signInConditionallyWithEmail:email password:password success:^(SNRClientAuthenticationResult *result) {
  // success
} failure:^(SNRApiError *error) {
  // failure
}];
```

</div>
</div>


<!-- reusable-table-boundary -->

## Authenticate customer by IdentityProvider
---
<!-- reusable-table-boundary -->

This method authenticates a customer with OAuth, Facebook, Google, Apple, or Synerise.
  
If an account for the customer does not exist and the identity provider is different than Synerise, this request creates an account.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | 0.3.0 |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClient.h
  
**Related To:**  
[ClientAuthenticationContext](/developers/mobile-sdk/class-reference/ios/client#clientauthenticationcontext)  
[ClientIdentityProivider](/developers/mobile-sdk/class-reference/ios/client#clientidentityprovider)
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1089">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1089-0" data-tab-group="tabgrp-1089" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1089-1" data-tab-group="tabgrp-1089">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1089-0" data-tab-group="tabgrp-1089" data-tab-active="true">

```Swift
static func authenticate(token: AnyObject, clientIdentityProvider: ClientIdentityProvider, authID: String?, context: ClientAuthenticationContext?, success: (() -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1089-1" data-tab-group="tabgrp-1089">

```Objective-C
+ (void)authenticateWithToken:(id)token clientIdentityProvider:(SNRClientIdentityProvider)clientIdentityProvider authID:(nullable NSString *)authID context:(nullable SNRClientAuthenticationContext *)context success:(void (^)(void))success failure:(void (^)(SNRApiError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **token** | AnyObject | yes | - | Token retrieved from provider |
| **clientIdentityProvider** | [ClientIdentityProvider](/developers/mobile-sdk/class-reference/ios/client#clientidentityprovider) | yes | - | Provider of your token |
| **authID** | String | no | nil | Optional identifier of authorization |
| **context** | [ClientAuthenticationContext](/developers/mobile-sdk/class-reference/ios/client#clientauthenticationcontext) | no | nil | Object which contains agreements and attributes |
| **success** | (() -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authID** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Since version 5.0.0, the **success** closure does NOT contain the `isSuccess` parameter.

</div></div></div>

  
**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1090">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1090-0" data-tab-group="tabgrp-1090" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1090-1" data-tab-group="tabgrp-1090">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1090-0" data-tab-group="tabgrp-1090" data-tab-active="true">

```Swift
let agreements: ClientAgreements = ClientAgreements()
agreements.email = true
agreements.sms = true
agreements.push = true
agreements.bluetooth = true
agreements.rfid = true
agreements.wifi = true
let context: ClientAuthenticationContext = ClientAuthenticationContext()
context.agreements = agreements
context.attributes = ["attribute1": "value1", "attribute2": "value2"]
let accessToken: String = "ACCESS_TOKEN"
let authID: String = "AUTH_ID"
Client.authenticate(token: token, authID: authID, context: context, success: {
  // success
}) { (error) in
  // failure   
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1090-1" data-tab-group="tabgrp-1090">

```Objective-C
SNRClientAgreements *agreements = [SNRClientAgreements new];
agreements.email = true;
agreements.sms = true;
agreements.push = true;
agreements.bluetooth = true;
agreements.rfid = true;
agreements.wifi = true;
SNRClientAuthenticationContext *context = [SNRClientAuthenticationContext new];
context.agreements = agreements;
context.attributes = @{"attribute1": "value1", "attribute2": "value2"};
NSString *accessToken = @"ACCESS_TOKEN";
NSString *authID = @"AUTH_ID";
[SNRClient authenticateWithToken:token authID:authID context:context success:^() {
  // success
} failure:^(SNRApiError *error) {
  // failure  
}];
```

</div>
</div>


<!-- reusable-table-boundary -->

## Authenticate customer conditionally by IdentityProvider
---
<!-- reusable-table-boundary -->

This method authenticates a customer with OAuth, Facebook, Google, Apple, or Synerise.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | n/a |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClient.h
  
**Related To:**  
[ClientConditionalAuthResult](/developers/mobile-sdk/class-reference/ios/client#clientconditionalauthresult)  
[ClientIdentityProvider](/developers/mobile-sdk/class-reference/ios/client#clientidentityprovider)
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1091">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1091-0" data-tab-group="tabgrp-1091" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1091-1" data-tab-group="tabgrp-1091">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1091-0" data-tab-group="tabgrp-1091" data-tab-active="true">

```Swift
static func authenticateConditionally(token: AnyObject, clientIdentityProvider: ClientIdentityProvider, authID: String?, context: ClientConditionalAuthenticationContext?, success: ((ClientAuthenticationResult) -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1091-1" data-tab-group="tabgrp-1091">

```Objective-C
+ (void)authenticateConditionallyWithToken:(id)token clientIdentityProvider:(SNRClientIdentityProvider)clientIdentityProvider authID:(nullable NSString *)authID context:(nullable SNRClientConditionalAuthenticationContext *)context success:(void (^)(SNRClientAuthenticationResult *authenticationResult))success failure:(void (^)(SNRApiError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **token** | AnyObject | yes | - | Token retrieved from provider |
| **clientIdentityProvider** | [ClientIdentityProvider](/developers/mobile-sdk/class-reference/ios/client#clientidentityprovider) | yes | - | Provider of your token |
| **authID** | String | no | nil | Optional identifier of authorization |
| **context** | [ClientConditionalAuthenticationContext](/developers/mobile-sdk/class-reference/ios/client#clientconditionalauthenticationcontext) | no | nil | Object which contains agreements and attributes |
| **success** | (([ClientConditionalAuthResult](/developers/mobile-sdk/class-reference/ios/client#clientconditionalauthenticationcontext)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authID** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>

  
**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1092">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1092-0" data-tab-group="tabgrp-1092" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1092-1" data-tab-group="tabgrp-1092">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1092-0" data-tab-group="tabgrp-1092" data-tab-active="true">

```Swift
let agreements: ClientAgreements = ClientAgreements()
agreements.email = true
agreements.sms = true
agreements.push = true
agreements.bluetooth = true
agreements.rfid = true
agreements.wifi = true
let context: ClientConditionalAuthenticationContext = ClientConditionalAuthenticationContext()
context.agreements = agreements
context.attributes = ["attribute1": "value1", "attribute2": "value2"]
let accessToken: String = "ACCESS_TOKEN"
let authID: String = "AUTH_ID"
Client.authenticateConditionally(token: token, authID: authID, context: context, success: { (success) in
  // success
}) { (error) in
  // failure   
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1092-1" data-tab-group="tabgrp-1092">

```Objective-C
SNRClientAgreements *agreements = [SNRClientAgreements new];
agreements.email = true;
agreements.sms = true;
agreements.push = true;
agreements.bluetooth = true;
agreements.rfid = true;
agreements.wifi = true;
SNRClientConditionalAuthenticationContext *context = [SNRClientConditionalAuthenticationContext new];
context.agreements = agreements;
context.attributes = @{"attribute1": "value1", "attribute2": "value2"};
NSString *accessToken = @"ACCESS_TOKEN";
NSString *authID = @"AUTH_ID";
[SNRClient authenticateConditionallyWithToken:token authID:authID context:context success:^(BOOL isSuccess) {
  // success
} failure:^(SNRApiError *error) {
  // failure  
}];
```

</div>
</div>


<!-- reusable-table-boundary -->

## Authenticate customer with token payload
---
<!-- reusable-table-boundary -->

This method signs in a customer in with the provided token payload.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.15.0 | 5.15.0 | n/a | n/a |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClient.h
  
**Related To:**  
[TokenPayload](/developers/mobile-sdk/class-reference/ios/client#tokenpayload)  
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1093">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1093-0" data-tab-group="tabgrp-1093" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1093-1" data-tab-group="tabgrp-1093">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1093-0" data-tab-group="tabgrp-1093" data-tab-active="true">

```Swift
static func authenticate(tokenPayload: TokenPayload, authID: String, success: (() -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1093-1" data-tab-group="tabgrp-1093">

```Objective-C
+ (void)authenticateWithTokenPayload:(SNRTokenPayload *)tokenPayload authID:(NSString *)authID success:(void (^)(void))success failure:(void (^)(SNRApiError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **tokenPayload** | [TokenPayload](/developers/mobile-sdk/class-reference/ios/client#tokenpayload) | yes | - | Object which contains a token's payload |
| **authID** | String | yes | - | Required customer's identifier of authorization |
| **success** | (() -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authID** parameter is used for decreasion the number of UUID refreshes so it must be unique for every customer.

</div></div></div>

  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->

## Authenticate customer via Simple Profile Authentication
---
<!-- reusable-table-boundary -->

This method authenticates a customer with Simple Profile Authentication.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.14.0 | 5.7.1 | 0.15.0 | 0.7.0 |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

When you use this method, you must set a request validation salt by using the `Synerise.setRequestValidationSalt(_:)` method (if salt is enabled for Simple Profile Authentication).

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_SIMPLE_AUTH_CREATE` from the **Auth** group.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClient.h
  
**Related To:**  
[ClientSimpleAuthenticationData](/developers/mobile-sdk/class-reference/ios/client#clientsimpleauthenticationdata)  
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1094">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1094-0" data-tab-group="tabgrp-1094" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1094-1" data-tab-group="tabgrp-1094">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1094-0" data-tab-group="tabgrp-1094" data-tab-active="true">

```Swift
static func simpleAuthentication(data: ClientSimpleAuthenticationData, authID: String, success: (() -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1094-1" data-tab-group="tabgrp-1094">

```Objective-C
+ (void)simpleAuthentication:(SNRClientSimpleAuthenticationData *)data authID:(NSString *)authID success:(void (^)(void))success failure:(void (^)(SNRApiError *error))failure
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **data** | [ClientSimpleAuthenticationData](/developers/mobile-sdk/class-reference/ios/client#clientsimpleauthenticationdata) | yes | - | Object which contains customer data |
| **authID** | String | yes | - | Required identifier of authorization |
| **success** | (() -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authID** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>

  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->

## Check if a customer is signed in (via RaaS, OAuth, Facebook, Apple)
---
This method checks if a customer is signed in (via Synerise Authentication - RaaS, OAuth, Facebook, Apple).
**Declared In:**  
Headers/SNRClient.h
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1095">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1095-0" data-tab-group="tabgrp-1095" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1095-1" data-tab-group="tabgrp-1095">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1095-0" data-tab-group="tabgrp-1095" data-tab-active="true">

```Swift
static func isSignedIn() -> Bool
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1095-1" data-tab-group="tabgrp-1095">

```Objective-C
+ (BOOL)isSignedIn
```

</div>
</div>

  
**Return Value:**  
**true** if the customer is signed in, otherwise returns **false**.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1096">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1096-0" data-tab-group="tabgrp-1096" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1096-1" data-tab-group="tabgrp-1096">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1096-0" data-tab-group="tabgrp-1096" data-tab-active="true">

```Swift
let isSignedIn: Bool = Client.isSignedIn()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1096-1" data-tab-group="tabgrp-1096">

```Objective-C
BOOL isSignedIn = [SNRClient isSignedIn];
```

</div>
</div>


## Check if a customer is signed in (via Simple Profile Authentication)
---
<!-- reusable-table-boundary -->

This method checks if a customer is signed in (via Simple Profile Authentication).
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.14.0 | 5.7.1 | 0.15.0 | 0.7.0 |

<!-- reusable-table-boundary -->
**Declared In:**  
Headers/SNRClient.h
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1097">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1097-0" data-tab-group="tabgrp-1097" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1097-1" data-tab-group="tabgrp-1097">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1097-0" data-tab-group="tabgrp-1097" data-tab-active="true">

```Swift
static func isSignedInViaSimpleAuthentication() -> Bool
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1097-1" data-tab-group="tabgrp-1097">

```Objective-C
+ (BOOL)isSignedInViaSimpleAuthentication
```

</div>
</div>

    
**Return Value:**  
**true** if the customer is signed in (via Simple Profile Authentication), otherwise returns **false**.

## Sign out customer
---
This method signs out a customer out.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This method works with every authentication type (via Synerise, External Provider, OAuth or Simple Profile Authentication).

</div></div></div>

**Declared In:**  
Headers/SNRClient.h
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1098">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1098-0" data-tab-group="tabgrp-1098" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1098-1" data-tab-group="tabgrp-1098">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1098-0" data-tab-group="tabgrp-1098" data-tab-active="true">

```Swift
static func signOut() -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1098-1" data-tab-group="tabgrp-1098">

```Objective-C
+ (void)signOut
```

</div>
</div>

  
**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1099">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1099-0" data-tab-group="tabgrp-1099" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1099-1" data-tab-group="tabgrp-1099">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1099-0" data-tab-group="tabgrp-1099" data-tab-active="true">

```Swift
Client.signOut()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1099-1" data-tab-group="tabgrp-1099">

```Objective-C
[SNRClient signOut];
```

</div>
</div>


## Sign out customer with mode or from all devices
---
<!-- reusable-table-boundary -->

This method signs out a customer out with a chosen mode and Determines if the method should sign out all devices.

Available modes:
- `.signOut` mode signs out the customer.
- `.signOutWithSessionDestroy` mode signs out the customer and additionally, clears the anonymous session and regenerates the customer UUID.

The `fromAllDevices` parameter determines whether the method should notify the backend to sign out all devices.

**IMPORTANT: It is an asynchronous method.**
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.11.0 | 5.1.0 | 0.14.0 | 1.0.0 |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This method works with every authentication type (via Synerise, External Provider, OAuth or Simple Profile Authentication).

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClient.h
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1100">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1100-0" data-tab-group="tabgrp-1100" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1100-1" data-tab-group="tabgrp-1100">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1100-0" data-tab-group="tabgrp-1100" data-tab-active="true">

```Swift
static func signOut(mode: ClientSignOutMode, fromAllDevices: Bool, success: ((Bool) -> Void), failure: ((ApiError) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1100-1" data-tab-group="tabgrp-1100">

```Objective-C
+ (void)signOutWithmode:(SNRClientSignOutMode)mode fromAllDevices:(BOOL)fromAllDevices success:(void (^)(void))success failure:(void (^)(SNRApiError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **mode** | [ClientSignOutMode](/developers/mobile-sdk/class-reference/ios/client#clientsignoutmode) | yes | - | Mode of signing out |
| **fromAllDevices** | Bool | yes | - | Determines if the method should sign out all devices |
| **success** | (() -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |

**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1101">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1101-0" data-tab-group="tabgrp-1101" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1101-1" data-tab-group="tabgrp-1101">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1101-0" data-tab-group="tabgrp-1101" data-tab-active="true">

```Swift
Client.signOut(mode: .signOutWithSessionDestroy, fromAllDevices: true, success: {
  // success        
}) { (error) in
  // failure
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1101-1" data-tab-group="tabgrp-1101">

```Objective-C
[SNRClient signOutWithMode:SNRClientSignOutModeSignOutWithSessionDestroy fromAllDevices:YES success:^{
  // success     
} failure:^(SNRApiError *error) {
  // failure
}];
```

</div>
</div>


<!-- reusable-table-boundary -->

## Removed methods

### <del>Authenticate customer by OAuth with registration</del> {#authenticate-customer-by-oauth-with-registration}
---
<!-- reusable-table-boundary -->

This method authenticates a customer with OAuth.
  
If an account for the customer does not exist, this request creates an account.
  
| Available on | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.6.11 | 3.6.13 | 0.9.12 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | 1.0.0 | n/a |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 401 status code if the provided access token and/or API Key is invalid.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Replaced By:**  
[Authenticate customer by IdentityProvider](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-by-identityprovider)

**Declared In:**  
Headers/SNRClient.h
  
**Related To:**  
[ClientOAuthAuthenticationContext](/developers/mobile-sdk/class-reference/ios/client#clientoauthauthenticationcontext)  
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1102">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1102-0" data-tab-group="tabgrp-1102" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1102-1" data-tab-group="tabgrp-1102">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1102-0" data-tab-group="tabgrp-1102" data-tab-active="true">

```Swift
static func authenticateByOAuth(accessToken: String, authID: String?, context: ClientOAuthAuthenticationContext?, success: ((Bool) -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1102-1" data-tab-group="tabgrp-1102">

```Objective-C
+ (void)authenticateByOAuthWithAccessToken:(NSString *)accessToken authID:(nullable NSString *)authID context:(nullable SNRClientOAuthAuthenticationContext *)context success:(nullable void (^)(BOOL isSuccess))success failure:(nullable void (^)(NSError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **accessToken** | String | yes | - | OAuth Access Token |
| **authID** | String | no | nil | Optional identifier of authorization |
| **context** | [ClientOAuthAuthenticationContext](/developers/mobile-sdk/class-reference/ios/client#clientoauthauthenticationcontext) | no | nil | Object which contains agreements and attributes |
| **success** | ((Bool) -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authID** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>

  
**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1103">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1103-0" data-tab-group="tabgrp-1103" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1103-1" data-tab-group="tabgrp-1103">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1103-0" data-tab-group="tabgrp-1103" data-tab-active="true">

```Swift
let agreements: ClientAgreements = ClientAgreements()
agreements.email = true
agreements.sms = true
agreements.push = true
agreements.bluetooth = true
agreements.rfid = true
agreements.wifi = true
let context: ClientOAuthContext = ClientOAuthContext()
context.agreements = agreements
context.attributes = ["attribute1": "value1", "attribute2": "value2"]
let accessToken: String = "ACCESS_TOKEN"
let authID: String = "AUTH_ID"
Client.authenticateByOAuth(accessToken: accessToken, authID: authID, context: context, success: { (success) in
  // success
}) { (error) in
  // failure   
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1103-1" data-tab-group="tabgrp-1103">

```Objective-C
SNRClientAgreements *agreements = [SNRClientAgreements new];
agreements.email = true;
agreements.sms = true;
agreements.push = true;
agreements.bluetooth = true;
agreements.rfid = true;
agreements.wifi = true;
SNRClientOAuthContext *context = [SNRClientOAuthContext new];
context.agreements = agreements;
context.attributes = @{"attribute1": "value1", "attribute2": "value2"};
NSString *accessToken = @"ACCESS_TOKEN";
NSString *authID = @"AUTH_ID";
[SNRClient authenticateByOAuthWithAccessToken:accessToken authID:authID context:context success:^(BOOL isSuccess) {
  // success
} failure:^(SNRApiError *error) {
  // failure  
}];
```

</div>
</div>


<!-- reusable-table-boundary -->

### <del>Authenticate customer by OAuth without registration</del> {#authenticate-customer-by-oauth-without-registration}
---
<!-- reusable-table-boundary -->

This method authenticates a customer with OAuth.
  
| Available on | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.6.11 | 3.6.13 | 0.9.12 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | 1.0.0 | n/a |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 401 status code if the provided access token and/or API Key is invalid.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Replaced By:**  
[Authenticate customer conditionally by IdentityProvider](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-conditionally-by-identityprovider)

**Declared In:**  
Headers/SNRClient.h
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1104">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1104-0" data-tab-group="tabgrp-1104" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1104-1" data-tab-group="tabgrp-1104">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1104-0" data-tab-group="tabgrp-1104" data-tab-active="true">

```Swift
static func authenticateByOAuthIfRegistered(accessToken: String, authID: String?, success: ((Bool) -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1104-1" data-tab-group="tabgrp-1104">

```Objective-C
+ (void)authenticateByOAuthIfRegisteredWithAccessToken:(nonnull NSString *)accessToken authID:(nullable NSString *)authID success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **accessToken** | String | yes | - | OAuth Access Token |
| **authID** | String | no | nil | Optional identifier of authorization |
| **success** | ((Bool) -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authID** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>

  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->

### <del>Authenticate customer by Facebook with registration</del> {#authenticate-customer-by-facebook-with-registration}
---
<!-- reusable-table-boundary -->

This method authenticates a customer with Facebook.
  
If an account for the customer does not exist, this request creates an account.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.3.8 | 3.3.0 | 0.9.7 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | 1.0.0 | n/a |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 401 status code if the provided Facebook token and/or API Key is invalid.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Replaced By:**  
[Authenticate customer by IdentityProvider](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-by-identityprovider)

**Declared In:**  
Headers/SNRClient.h
  
**Related To:**  
[ClientFacebookAuthenticationContext](/developers/mobile-sdk/class-reference/ios/client#clientfacebookauthenticationcontext)
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1105">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1105-0" data-tab-group="tabgrp-1105" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1105-1" data-tab-group="tabgrp-1105">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1105-0" data-tab-group="tabgrp-1105" data-tab-active="true">

```Swift
static func authenticateByFacebook(facebookToken: String, authID: String?, context: ClientFacebookAuthenticationContext?, success: ((Bool) -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1105-1" data-tab-group="tabgrp-1105">

```Objective-C
+ (void)authenticateByFacebookWithFacebookToken:(nonnull NSString *)facebookToken authID:(nullable NSString *)authID context:(nullable SNRClientFacebookAuthenticationContext *)context success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **facebookToken** | String | yes | - | Facebook Access Token |
| **authID** | String | no | nil | Optional identifier of authorization |
| **context** | [ClientFacebookAuthenticationContext](/developers/mobile-sdk/class-reference/ios/client#clientfacebookauthenticationcontext) | no | nil | Object which contains agreements and attributes |
| **success** | ((Bool) -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authID** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>

  
**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1106">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1106-0" data-tab-group="tabgrp-1106" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1106-1" data-tab-group="tabgrp-1106">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1106-0" data-tab-group="tabgrp-1106" data-tab-active="true">

```Swift
let agreements: ClientAgreements = ClientAgreements()
agreements.email = true
agreements.sms = true
agreements.push = true
agreements.bluetooth = true
agreements.rfid = true
agreements.wifi = true

let context: ClientFacebookAuthenticationContext = ClientFacebookAuthenticationContext()
context.agreements = agreements
context.attributes = ["attribute1": "value1", "attribute2": "value2"]

guard let facebookToken = FBSDKAccessToken.current()?.tokenString else {
    return
}
let authID: String = "AUTH_ID"

Client.authenticateByFacebook(facebookToken: fa, authID: authID, context: context, success: { (success) in
  // success
}) { (error) in
  // failure
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1106-1" data-tab-group="tabgrp-1106">

```Objective-C
SNRClientAgreements *agreements = [SNRClientAgreements new];
agreements.email = true;
agreements.sms = true;
agreements.push = true;
agreements.bluetooth = true;
agreements.rfid = true;
agreements.wifi = true;
SNRClientFacebookAuthenticationContext *context = [SNRClientFacebookAuthenticationContext new];
context.agreements = agreements;
context.attributes = @{"attribute1": "value1", "attribute2": "value2"};
NSString *facebookToken =  [FBSDKAccessToken currentAccessToken].tokenString;
NSString *authID = @"AUTH_ID";
[SNRClient authenticateByFacebookWithFacebookToken:facebookToken authID:authID context:context success:^(BOOL isSuccess) {
  // success
} failure:^(SNRApiError *error) {
  // failure  
}];
```

</div>
</div>


<!-- reusable-table-boundary -->

### <del>Authenticate customer by Facebook without registration</del> {#authenticate-customer-by-facebook-without-registration}
---
<!-- reusable-table-boundary -->

This method authenticates a customer with Facebook.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.3.8 | 3.3.0 | 0.9.7 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | 1.0.0 | n/a |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 401 status code if the provided Facebook token and/or API Key is invalid.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Replaced By:**  
[Authenticate customer conditionally by IdentityProvider](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-conditionally-by-identityprovider)

**Declared In:**  
Headers/SNRClient.h
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**   

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1107">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1107-0" data-tab-group="tabgrp-1107" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1107-1" data-tab-group="tabgrp-1107">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1107-0" data-tab-group="tabgrp-1107" data-tab-active="true">

```Swift
static func authenticateByFacebookIfRegistered(facebookToken: String, authID: String?, success: ((Bool) -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1107-1" data-tab-group="tabgrp-1107">

```Objective-C
+ (void)authenticateByFacebookIfRegisteredWithFacebookToken:(nonnull NSString *)facebookToken authID:(nullable NSString *)authID success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **facebookToken** | String | yes | - | Facebook Access Token |
| **authID** | String | no | nil | Optional identifier of authorization |
| **success** | ((Bool) -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authID** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>

  
**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1108">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1108-0" data-tab-group="tabgrp-1108" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1108-1" data-tab-group="tabgrp-1108">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1108-0" data-tab-group="tabgrp-1108" data-tab-active="true">

```Swift
guard let facebookToken = FBSDKAccessToken.current()?.tokenString else {
    return
}
let authID: String = "AUTH_ID"
Client.authenticateByFacebookIfRegistered(facebookToken: facebookToken, success: { (success) in
  // success
}, failure: { (error) in
  // failure
})
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1108-1" data-tab-group="tabgrp-1108">

```Objective-C
NSString *facebookToken =  [FBSDKAccessToken currentAccessToken].tokenString;
NSString *authID = @"AUTH_ID";
[SNRClient authenticateByFacebookIfRegisteredWithFacebookToken:facebookToken authID:authID success:^(BOOL isSuccess) {
  // success
} failure:^(SNRApiError *error) {
  // failure  
}];
```

</div>
</div>


<!-- reusable-table-boundary -->

### <del>Authenticate customer by Sign in with Apple with registration</del> {#authenticate-customer-by-sign-in-with-apple-with-registration}
---
<!-- reusable-table-boundary -->

This method authenticates a customer with Sign In With Apple.
  
If an account for the customer does not exist, this request creates an account.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.6.11 | n/a | 0.9.12 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.7.6 | n/a | 0.9.19 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | n/a | 1.0.0 | n/a |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Replaced By:**  
[Authenticate customer by IdentityProvider](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-by-identityprovider)

**Declared In:**  
Headers/SNRClient.h
  
**Related To:**  
[ClientAppleSignInAuthenticationContext](/developers/mobile-sdk/class-reference/ios/client#clientapplesigninauthenticationcontext)  
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1109">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1109-0" data-tab-group="tabgrp-1109" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1109-1" data-tab-group="tabgrp-1109">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1109-0" data-tab-group="tabgrp-1109" data-tab-active="true">

```Swift
static func authenticateByAppleSignIn(identityToken: Data, authID: String?, context: ClientAppleSignInAuthenticationContext?, success: ((Bool) -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1109-1" data-tab-group="tabgrp-1109">

```Objective-C
+ (void)authenticateByAppleSignInWithIdentityToken:(nonnull NSData *)identityToken authID:(nullable NSString *)authID context:(nullable SNRClientAppleSignInAuthenticationContext *)context success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **identityToken** | Data | yes | - | Apple Identity Token |
| **context** | [ClientAppleSignInAuthenticationContext](/developers/mobile-sdk/class-reference/ios/client#clientapplesigninauthenticationcontext) | no | nil | Object which contains agreements and attributes |
| **authID** | String | no | nil | Optional identifier of authorization |
| **success** | ((Bool) -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authID** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>

  
**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1110">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1110-0" data-tab-group="tabgrp-1110" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1110-1" data-tab-group="tabgrp-1110">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1110-0" data-tab-group="tabgrp-1110" data-tab-active="true">

```Swift
extension LoginViewController: ASAuthorizationControllerDelegate {
    func authorizationController(controller: ASAuthorizationController, didCompleteWithAuthorization authorization: ASAuthorization) {
        if let appleIDCredential = authorization.credential as? ASAuthorizationAppleIDCredential {
            let agreements: ClientAgreements = ClientAgreements()
            agreements.email = true
            agreements.sms = true
            agreements.push = true
            agreements.bluetooth = true
            agreements.rfid = true
            agreements.wifi = true
            let context: ClientAppleSignInAuthenticationContext = ClientAppleSignInAuthenticationContext(identityToken: appleIdCredential.identityToken!)
            context.agreements = agreements
            context.attributes = ["param": "value"]
            Client.authenticateByAppleSignIn(context: context, authID: authID, success: { (success) in
              // success
            }) { (error) in
              // failure
            }
        }
    }
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1110-1" data-tab-group="tabgrp-1110">

```Objective-C
#pragma mark - ASAuthorizationControllerDelegate

- (void)authorizationController:(ASAuthorizationController *)controller 
   didCompleteWithAuthorization:(ASAuthorization *)authorization {
       id credential = authorization.credential;
    if (credential != nil) {
        SNRClientAgreements *agreements = [SNRClientAgreements new];
        agreements.email = true;
        agreements.sms = true;
        agreements.push = true;
        agreements.bluetooth = true;
        agreements.rfid = true;
        agreements.wifi = true;
        SNRClientAppleSignInAuthenticationContext*context = [[SNRClientAppleSignInAuthenticationContext alloc] initWithIdentityToken:credential.identityToken];
        context.agreements = agreements;
        context.attributes = @{"attribute1": "value1", "attribute2": "value2"};
        [SNRClient authenticateByAppleSignInWithContext:context authID:authID success:^(BOOL isSuccess) {
          // success
        } failure:^(SNRApiError *error) {
          // failure  
        }];
    }
}
```

</div>
</div>


<!-- reusable-table-boundary -->

### <del>Authenticate customer by Sign in with Apple without registration</del> {#authenticate-customer-by-sign-in-with-apple-without-registration}
---
<!-- reusable-table-boundary -->

This method authenticates a customer with Sign In With Apple.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.6.11 | 3.6.13 | 0.9.12 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | 1.0.0 | n/a |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Replaced By:**  
[Authenticate customer conditionally by IdentityProvider](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-conditionally-by-identityprovider)

**Declared In:**  
Headers/SNRClient.h
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1111">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1111-0" data-tab-group="tabgrp-1111" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1111-1" data-tab-group="tabgrp-1111">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1111-0" data-tab-group="tabgrp-1111" data-tab-active="true">

```Swift
static func authenticateByAppleSignInIfRegistered(identityToken: String, authID: String?, success: ((Bool) -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1111-1" data-tab-group="tabgrp-1111">

```Objective-C
+ (void)authenticateByAppleSignInIfRegisteredWithIdentityToken:(nonnull NSData *)identityToken authID:(nullable NSString *)authID success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **identityToken** | String | yes | - | Apple Identity Token |
| **authID** | String | no | nil | Optional identifier of authorization |
| **success** | ((Bool) -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authID** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>

  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->

### <del>Sign out customer with mode</del> {#sign-out-customer-with-mode}
---
<!-- reusable-table-boundary -->

This method signs out a customer out with a chosen mode:
- `.signOut` mode notifies the backend that the customer is signed out.
- `.signOutWithSessionDestroy` mode notifies the backend that the customer is signed out and additionally, clears the anonymous session and regenerates the customer UUID.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.4.0 | 4.6.0 | 0.12.0 | 0.7.0 |
| <span style="color:orange">Deprecated in:</span> | 4.11.0 | 5.1.0 | - | - |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | 0.14.0 | 1.0.0 |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This method works with every authentication type (via Synerise, External Provider, OAuth or Simple Profile Authentication).

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Replaced By:**  
[Sign out with mode or from all devices](/developers/mobile-sdk/method-reference/ios/client-authentication#sign-out-customer-with-mode-or-from-all-devices)
  
**Declared In:**  
Headers/SNRClient.h
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1112">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1112-0" data-tab-group="tabgrp-1112" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1112-1" data-tab-group="tabgrp-1112">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1112-0" data-tab-group="tabgrp-1112" data-tab-active="true">

```Swift
static func signOut(mode: ClientSignOutMode) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1112-1" data-tab-group="tabgrp-1112">

```Objective-C
+ (void)signOutWithmode:(SNRClientSignOutMode)mode
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **mode** | [ClientSignOutMode](/developers/mobile-sdk/class-reference/ios/client#clientsignoutmode) | yes | - | Mode of signing out |
  
**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1113">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1113-0" data-tab-group="tabgrp-1113" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1113-1" data-tab-group="tabgrp-1113">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1113-0" data-tab-group="tabgrp-1113" data-tab-active="true">

```Swift
Client.signOut(mode: .signOutWithSessionDestroy)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1113-1" data-tab-group="tabgrp-1113">

```Objective-C
[SNRClient signOutWithMode:SNRClientSignOutModeSignOutWithSessionDestroy];
```

</div>
</div>


<!-- reusable-table-boundary -->


# Overlay in-app


An overlay in-app message is a banner displayed over the app view.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

You can use:
- the **safe area** mode on iOS from the `5.1.0` version, 
- the **display cutouts** mode on Android from the `6.1.0` version.

</div></div></div>


## Controlling behavior and actions
---
You may control an incoming in-app message and decide whether to show it (the display of in-app message can be triggered by occurrence of specific events). By default, the SDK allows in-app message display.  

The user interface allows selecting up to 3 trigger events, however, in Android, only for `5.8.1` SDK version (released on 28.08.2023) or higher all triggers are considered altogether. For older SDK versions in Android, only the last event from the trigger list will be considered.  
These limitations don't apply in iOS.

Also, you can be notified (in the form of events) about the campaign actions in the following cases:
- When the in-app message is presented.
- When the in-app message disappeared.
- When additional context is needed to render the campaign.
- When the customer invoked an action.

You can handle the message using:
- [OnInAppListener](/developers/mobile-sdk/listeners-and-delegates/android-listeners#on-in-app-listener) methods for Android. 
- [InjectorInAppMessageDelegate](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#injector-in-app-message-delegate) methods for iOS. 
- [InjectorInAppMessageListener](/developers/mobile-sdk/listeners-and-delegates/react-native-listeners#injector-in-app-message-listener) methods for React Native. 
- [InjectorInAppMessageListener](/developers/mobile-sdk/listeners-and-delegates/flutter-listeners#injector-in-app-message-listener) methods for Flutter. 

See the following code samples:


<div class="content-tabs code-tabs" data-tab-group="tabgrp-31">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-31-0" data-tab-group="tabgrp-31" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-31-1" data-tab-group="tabgrp-31">Kotlin</button><button class="tab-button" data-tab-id="tabgrp-31-2" data-tab-group="tabgrp-31">Swift</button><button class="tab-button" data-tab-id="tabgrp-31-3" data-tab-group="tabgrp-31">Objective-C</button><button class="tab-button" data-tab-id="tabgrp-31-4" data-tab-group="tabgrp-31">JavaScript</button><button class="tab-button" data-tab-id="tabgrp-31-5" data-tab-group="tabgrp-31">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-31-0" data-tab-group="tabgrp-31" data-tab-active="true">

```Java
public static OnInAppListener NULL = new OnInAppListener() {
  // This method is called after an in-app message is loaded and Synerise SDK asks for permission to show it.
  @Override
  public boolean shouldShow(InAppMessageData inAppMessageData) {
    return true;
  }

  // This method is called after an in-app message appears.
  @Override
  public void onShown(InAppMessageData inAppMessageData) {
    //...  
  }

  // This method is called after an in-app message disappears.
  @Override
  public void onDismissed(InAppMessageData inAppMessageData) {
    //...
  }

  // This method is called when a individual context for an in-app message is needed.
  @Override
  public HashMap<String, Object> onContextFromAppRequired(InAppMessageData inAppMessageData) {
    return new HashMap<>();
  }

  // This method is called when the SRInApp.openUrl(url) method is used in an in-app message.
  @Override
  public void onHandledOpenUrl(InAppMessageData inAppMessageData) {
    //...
  }

  // This method is called when the SRInApp.openDeeplink(url) method is used in an in-app message.
  @Override
  public void onHandledOpenDeepLink(InAppMessageData inAppMessageData) {
    //...
  }

  // This method is called when the
  // SRInApp.handleCustomAction(name, params) method is used in an in-app message.
  @Override
  public void onCustomAction(String identifier, HashMap<String, Object> params, InAppMessageData inAppMessageData) {
    //...
  }
};
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-31-1" data-tab-group="tabgrp-31">

```Kotlin
var inAppCallbacks: OnInAppListener = object : OnInAppListener() {
  // This method is called after an in-app message is loaded and Synerise SDK asks for permission to show it.
  override fun shouldShow(inAppMessageData: InAppMessageData): Boolean {
    return true
  }

  // This method is called after an in-app message appears.
  override fun onShown(inAppMessageData: InAppMessageData) {
    //...
  }

  // This method is called after an in-app message disappears.
  override fun onDismissed(inAppMessageData: InAppMessageData) {
    //...
  }

  // This method is called when a individual context for an in-app message is needed.
  override fun onContextFromAppRequired(inAppMessageData: InAppMessageData): HashMap<String, Any> {
    return HashMap()
  }

  // This method is called when the SRInApp.openUrl(url) method is used in an in-app message.
  override fun onHandledOpenUrl(inAppMessageData: InAppMessageData) {
    //...
  }

  // This method is called when the SRInApp.openDeeplink(url) method is used in an in-app message.
  override fun onHandledOpenDeepLink(inAppMessageData: InAppMessageData) {
    //...
  }

  // This method is called when the
  // SRInApp.handleCustomAction(name, params) method is used in an in-app message.
  override fun onCustomAction(identifier: String?, params: HashMap<String?, Any?>?, inAppMessageData: InAppMessageData?) {
    //...
  }
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-31-2" data-tab-group="tabgrp-31">

```Swift
// MARK: - InjectorInAppMessageDelegate

// This method is called after an in-app message is loaded and Synerise SDK asks for permission to show it.
func snr_shouldInAppMessageAppear(data: InAppMessageData) -> Bool {
  return true
}

// This method is called after an in-app message appears.
func snr_inAppMessageDidAppear(data: InAppMessageData) {
  //...
}

// This method is called after an in-app message disappears.
func snr_inAppMessageDidDisappear(data: InAppMessageData) {
  //...
}

// This method is called when an in-app message changes size.
func snr_inAppMessageDidChangeSize(rect: CGRect) {
  //...
}

// This method is called when a individual context for an in-app message is needed.
func snr_inAppMessageContextIsNeeded(data: InAppMessageData) -> [AnyHashable: Any]? {
  return []
}

// This method is called when the SRInApp.openUrl(url) method is used in an in-app message.
func snr_inAppMessageHandledAction(data: InAppMessageData, url: URL) {
  //...
}

// This method is called when the SRInApp.openDeeplink(url) method is used in an in-app message.
func snr_inAppMessageHandledAction(data: InAppMessageData, deeplink: String) {
  //...
}

// This method is called when the
  // SRInApp.handleCustomAction(name, params) method is used in an in-app message.
func snr_inAppMessageHandledCustomAction(data: InAppMessageData, name: String, parameters: [AnyHashable: Any]) {
  //...
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-31-3" data-tab-group="tabgrp-31">

```Objective-C
#pragma mark - SNRInjectorInAppMessageDelegate

// This method is called after an in-app message is loaded and Synerise SDK asks for permission to show it.
- (BOOL)SNR_shouldInAppMessageAppear:(SNRInAppMessageData *)data {
  //...
}

// This method is called after an in-app message appears.
- (void)SNR_inAppMessageDidAppear:(SNRInAppMessageData *)data {
  //...
}

// This method is called after an in-app message disappears.
- (void)SNR_inAppMessageDidDisappear:(SNRInAppMessageData *)data {
  //...
}

// This method is called when an in-app message changes size.
- (void)SNR_inAppMessageDidChangeSize:(CGRect)rect {
  //...
}

// This method is called when a individual context for an in-app message is needed.
- (nullable NSDictionary *)SNR_inAppMessageContextIsNeeded:(SNRInAppMessageData *)data {
  //...
}

// This method is called when the SRInApp.openUrl(url) method is used in an in-app message.
- (void)SNR_inAppMessageHandledURLAction:(SNRInAppMessageData *)data url:(NSURL *)url {
  //...
}

// This method is called when the SRInApp.openDeeplink(url) method is used in an in-app message.
- (void)SNR_inAppMessageHandledDeeplinkAction:(SNRInAppMessageData *)data deeplink:(NSString *)deeplink {
  //...
}

// This method is called when the
  // SRInApp.handleCustomAction(name, params) method is used in an in-app message.
- (void)SNR_inAppMessageHandledCustomAction:(SNRInAppMessageData *)data name:(NSString *)name parameters:(NSDictionary *)parameters {
  //...
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-31-4" data-tab-group="tabgrp-31">

```JavaScript
Synerise.onReady(function() {
  Synerise.Injector.setInAppMessageListener({
    // This method is called after an in-app message is loaded and Synerise SDK asks for permission to show it.
    shouldPresent: function(data) {
      return true;
    },
    // This method is called after an in-app message appears.
    onPresent: function(data) {
      //...
    },
    // This method is called after an in-app message disappears.
    onHide: function(data) {
      //...
    },
    // This method is called when a individual context for an in-app message is needed.
    contextIsNeeded: function(data) {
      return {}
    },
    // This method is called when the SRInApp.openUrl(url) method is used in an in-app message.
    onOpenUrl: function(data, url) {
      //...
    },
    // This method is called when the SRInApp.openDeeplink(url) method is used in an in-app message.
    onDeepLink: function(data, deepLink) {
      //...
    },
    // This method is called when Synerise handles custom action from in-app messages.
    onCustomAction: function(data, name, parameters) {
      //...
    }
  });
})
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-31-5" data-tab-group="tabgrp-31">

```Dart
Synerise.injector.inAppMessageListener((listener) {
  // This method is called after an in-app message appears.
  listener.onPresent = (data) {
    //...
  };
  // This method is called after an in-app message disappears.
  listener.onHide = (data) {
    //...
  };
  // This method is called when the SRInApp.openUrl(url) method is used in an in-app message.
  listener.onOpenUrl = (data, url) {
    //...
  };
  // This method is called when the SRInApp.openDeeplink(url) method is used in an in-app message.
  listener.onDeepLink = (data, deepLink) {
    //...
  };
  // This method is called when Synerise handles custom action from in-app messages.
  listener.onCustomAction(data, name, parameters) {
    //...
  };
});
```

</div>
</div>


## Closing a message  

Overlay in-app messages can be closed with a [JS method included in their content](/docs/campaign/in-app-messages/creating-inapp-templates/creating-inapp-template#close-a-message), but you can also use a mobile SDK method. This can be used to close top or bottom bar in-app from somewhere else on the screen.  
Using this method generates an `inApp.discard` event.  
See the method reference:
- [Android](/developers/mobile-sdk/method-reference/android/campaigns#close-in-app-message)
- [Flutter](/developers/mobile-sdk/method-reference/flutter/campaigns#close-in-app-message)
- [iOS](/developers/mobile-sdk/method-reference/ios/campaigns#close-in-app-message)
- [React Native](/developers/mobile-sdk/method-reference/react-native/campaigns#close-in-app-message)

## Example
---
This is an overlay in-app message campaign example with full screen presentation.

<figure><img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/developers/mobile-sdk/_gfx/android-in-app-campaign-1.png" alt="In-app message campaign example" class="small"><figcaption>In-app message campaign (Android)</figcaption></figure>
<figure><img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/developers/mobile-sdk/_gfx/ios-in-app-campaign-1.png" alt="In-app message campaign example" class="small"><figcaption>In-app message campaign (iOS)</figcaption></figure>



# Huawei integration in Android SDK


## Enable integration in the Synerise platform

Before you start integrating Huawei services in your app, you must configure the integration in Synerise platform. For instructions, see ["Huawei integration"](/docs/settings/tool/huawei-integration).

## Configuration
In order to integrate Huawei Mobile Services with Synerise, you must add `.mesaggingServiceType(MessagingServiceType)` to your `Synerise.Builder`.

We recommend passing `MessagingServiceType.HMS` as an argument when you build the app for AppGallery.


<div class="admonition admonition-tip"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M9.663 17h4.673M12 3v1m6.364 1.636l-.707.707M21 12h-1M4 12H3m3.343-5.657l-.707-.707m2.828 9.9a5 5 0 117.072 0l-.548.547A3.374 3.374 0 0014 18.469V19a2 2 0 11-4 0v-.531c0-.895-.356-1.754-.988-2.386l-.548-.547z" /></svg></div><div class="admonition-body"><div class="admonition-content">

More information about `Synerise.Builder` is available in ["Configuration"](/developers/mobile-sdk/installation-and-configuration/android#configuration).

</div></div></div>


## Implementing Huawei notifications in applications

1. Register your service in the AndroidManifest:
   
   <pre><code class="language-XML">&lt;application
           android:name=".App"
           android:allowBackup="true"
           android:icon="@mipmap/ic_launcher"
           android:label="@string/app_name"
           android:roundIcon="@mipmap/ic_launcher_round"
           android:supportsRtl="true"
           android:theme="@style/AppTheme"&gt;
           ...
           &lt;service
           android:name=".service.MyPushService"
           android:exported="false"&gt;
           &lt;intent-filter&gt;
               &lt;action android:name="com.huawei.push.action.MESSAGING_EVENT" /&gt;
           &lt;/intent-filter&gt;
       &lt;/service&gt;
       &lt;/application&gt;</code></pre>


2. In `onRegisterForPush`, pass the huaweiToken using the [`Client.registerForPush(token, pushAgreement)` method](/developers/mobile-sdk/method-reference/android/campaigns#register-for-push-notifications).
3. Add the Huawei registration method:  
    
   <div class="content-tabs code-tabs" data-tab-group="tabgrp-613">
   <div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-613-0" data-tab-group="tabgrp-613" data-tab-active="true">kotlin</button></div>

   <div class="tab-panel" data-tab-id="tabgrp-613-0" data-tab-group="tabgrp-613" data-tab-active="true">

   ```kotlin
   override fun onNewToken(p0: String?, p1: Bundle?) {
       super.onNewToken(p0, p1)
       val call = Client.registerForPush(p0!!, true)
       call.execute(
           {
               Log.i(TAG, "Register for Push succeed: $p0")
           }
       ) { apiError: Any? ->
           Log.i(TAG, "Register for push failed:" + apiError.toString())
       }
       Log.i(TAG, p0!!)
       Log.i(TAG, "receive token: $p0")
   }
   ```

   </div>
   </div>

1. Pass the incoming push notification payload to the `Injector` in your `HmsMessageService` implementation:
   
   <div class="content-tabs code-tabs" data-tab-group="tabgrp-614">
   <div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-614-0" data-tab-group="tabgrp-614" data-tab-active="true">kotlin</button></div>

   <div class="tab-panel" data-tab-id="tabgrp-614-0" data-tab-group="tabgrp-614" data-tab-active="true">

   ```kotlin
   val scope = CoroutineScope(Dispatchers.IO + SupervisorJob())

       override fun onMessageReceived(p0: RemoteMessage?) {
           super.onMessageReceived(p0)
           val data: Map<String, String> = p0!!.dataOfMap
           scope.launch {
               Injector.handlePushPayload(data)
           }
       }
   ```

   </div>
   </div>



<div class="admonition admonition-tip"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M9.663 17h4.673M12 3v1m6.364 1.636l-.707.707M21 12h-1M4 12H3m3.343-5.657l-.707-.707m2.828 9.9a5 5 0 117.072 0l-.548.547A3.374 3.374 0 0014 18.469V19a2 2 0 11-4 0v-.531c0-.895-.356-1.754-.988-2.386l-.548-.547z" /></svg></div><div class="admonition-body"><div class="admonition-content">

For more information, visit [Huawei Codelab](https://developer.huawei.com/consumer/en/codelab/HMSPushKit/index.html#0).

</div></div></div>



## Links and Deep Links

In order to implement links and deep links, refer to [this](/developers/mobile-sdk/campaigns/action-handling#handling-actions-from-campaigns-in-android) instruction.

## Configuring notification encryption

Instructions for encrypting push notifications are available [here](/developers/mobile-sdk/configuring-push-notifications/android#configure-notification-encryption).


# iOS

## Installation and configuration (iOS)

In this article, you will find out how to install and initialize the Synerise SDK in an iOS application. While performing the actions from this guide, keep the presented order. 


<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The [Settings](/developers/mobile-sdk/settings#pre-initialization-settings) article contains additional information about SDK behaviors you may need prior to configuration.

</div></div></div>
 

If you want to find out what kind of benefits you can get from integrating with mobile SDK, go [here](/developers/mobile-sdk/overview).

### Requirements
---
You need:
* Access to a [workspace](/docs/settings/workspace)
* A Profile [API Key](/docs/settings/tool/api#adding-api-keys)  
    When creating the API key, use allowlisting or denylisting to only allow the events you intend to use.
* One of the following dependency managers:
    - [CocoaPods](https://guides.cocoapods.org/using/getting-started.html) - CocoaPods is a dependency manager for iOS projects.
    - [Carthage](https://github.com/Carthage/Carthage) - Carthage is a simple, decentralized dependency manager for iOS projects. 
    - [Swift Package Manager](https://www.swift.org/package-manager/) - Swift Package Manager (SPM) is a dependency manager built into Xcode.
* Recommended environment:
    - Xcode 16
    - iOS SDK 18
* Target deployment:
    - **iOS 13.0+** for SDK versions 5.0.0 and higher
    - **iOS 9.0+** for SDK versions lower than 5.0.0


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Bitcode is not supported in SDK version 5.0.0 and higher. Xcode ignores bitcode.

</div></div></div>
 

#### Apple Frameworks

The Synerise SDK references the following Apple frameworks:

- `Foundation.framework`
- `UIKit.framework`
- `CoreGraphics.framework`
- `SystemConfiguration.framework`
- `MobileCoreServices.framework`
- `CoreTelephony.framework`
- `Security.framework`
- `CommonCrypto.framework`
- `WebKit.framework`
- `UserNotifications.framework`

#### 3rd Party Frameworks

- [AFNetworking (fork)](https://github.com/AFNetworking/AFNetworking)
- [TrustKit](https://github.com/datatheorem/TrustKit)
- [Aspects](https://github.com/steipete/Aspects)


### Installation
---

#### CocoaPods

1. Add CocoaPods dependency to **Synerise SDK** into your `Podfile`:
    
   <pre><code class="language-ruby">use_frameworks!

       target YOUR_PROJECT_TARGET do
         pod 'SyneriseSDK'
       end</code></pre>

2. Execute the following shell command in the directory depending on your project configuration:
    
   <pre><code class="language-plaintext">pod repo update  
       pod install</code></pre>


#### Swift Package Manager (SPM)

1. Go to Xcode project’s settings and navigate to the Package Dependencies tab.
2. Below the packages list, click the Add button.
3. Enter the URL of Synerise SDK repository **(https://github.com/Synerise/synerise-ios-sdk)** in the search text field.
4. Under the Dependency Rule section, select the SDK version. Finally, click **Add Package**.
5. Select the package that best suits your needs and click **Add Package**.

#### Carthage

1. Add the Carthage dependency to **Synerise SDK** into your `Cartfile`:

    
   <pre><code class="language-plaintext">github "synerise/ios-sdk"</code></pre>


2. Execute the shell command in directory depending on your project configuration:

    
   <pre><code class="language-plaintext">carthage update</code></pre>


3. Go to Xcode project target's **General** section.
4. In Finder, open `<YOUR_XCODE_PROJECT_DIRECTORY>/Carthage/Build/iOS`
5. Drag `SyneriseSDK.framework` to **Embedded Binaries**.
6. Make sure the **Copy items if needed** option is selected.
7. Click **Finish**.

### Initialization
---

#### Setting up

1. Go to Xcode project target's **General** section.
2. Find the **Other Linker Flags** property and add the ***-ObjC*** flag.

2. If you are going to use push notifications:
    1. Go to `Info.plist`
    2. Add a row for **Required background mode** with the following array type value: `App downloads content in response to push notifications` or add the code below directly:
    
       <pre><code class="language-xml">&lt;key&gt;UIBackgroundModes&lt;/key&gt;
           &lt;array&gt;
               &lt;string&gt;remote-notification&lt;/string&gt;
           &lt;/array&gt;</code></pre>


3. If you are going to use HTTP addresses (instead of only HTTPS), change the allowlist domains in your app by adding configuration to `Info.plist` in one of the following ways:
    - Add configured domain/domains that you need.
    
      <pre><code class="language-xml">&lt;key&gt;NSAppTransportSecurity&lt;/key&gt;
          &lt;dict&gt;
              &lt;key&gt;NSExceptionDomains&lt;/key&gt;
              &lt;dict&gt;
                  &lt;key&gt;yourdomain.com&lt;/key&gt;
                  &lt;dict&gt;
                  &lt;!--Include to allow subdomains--&gt;
                  &lt;key&gt;NSIncludesSubdomains&lt;/key&gt;
                  &lt;true/&gt;
                  &lt;!--Include to allow HTTP requests--&gt;
                  &lt;key&gt;NSTemporaryExceptionAllowsInsecureHTTPLoads&lt;/key&gt;
                  &lt;true/&gt;
                  &lt;!--Include to specify minimum TLS version--&gt;
                  &lt;key&gt;NSTemporaryExceptionMinimumTLSVersion&lt;/key&gt;
                  &lt;string&gt;TLSv1.1&lt;/string&gt;
                  &lt;/dict&gt;
              &lt;/dict&gt;
          &lt;/dict&gt;</code></pre>

    - Give permission for all domains.
    
      <pre><code class="language-xml">&lt;key&gt;NSAppTransportSecurity&lt;/key&gt;
          &lt;dict&gt;
              &lt;key&gt;NSAllowsArbitraryLoads&lt;/key&gt;&lt;true/&gt;
          &lt;/dict&gt;</code></pre>


#### Importing Synerise SDK

Import the **Synerise SDK** header into the files that contain code relating to SDK. 


<div class="content-tabs code-tabs" data-tab-group="tabgrp-615">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-615-0" data-tab-group="tabgrp-615" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-615-1" data-tab-group="tabgrp-615">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-615-0" data-tab-group="tabgrp-615" data-tab-active="true">

```Swift
import SyneriseSDK
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-615-1" data-tab-group="tabgrp-615">

```Objective-C
#import <SyneriseSDK/SyneriseSDK.h>
```

</div>
</div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

In Objective-C, you can include it in your Prefix Header (PCH) and Synerise SDK will be imported to all files automatically.

</div></div></div>


#### Basic initialization

Initialize Synerise SDK and provide the [Profile API Key](/docs/settings/tool/api).  
  
You may initialize it wherever you want and when you need.  


<div class="content-tabs code-tabs" data-tab-group="tabgrp-616">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-616-0" data-tab-group="tabgrp-616" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-616-1" data-tab-group="tabgrp-616">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-616-0" data-tab-group="tabgrp-616" data-tab-active="true">

```Swift
Synerise.initialize(apiKey: "YOUR_PROFILE_API_KEY") // 1
Synerise.setDebugModeEnabled(false) // 2
Synerise.setCrashHandlingEnabled(true) // 3
Synerise.setDelegate(self) // 4
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-616-1" data-tab-group="tabgrp-616">

```Objective-C
[SNRSynerise initializeWithApiKey:@"YOUR_PROFILE_API_KEY"]; // 1
[SNRSynerise setDebugModeEnabled:NO]; // 2
[SNRSynerise setCrashHandlingEnabled:YES]; // 3
[SNRSynerise setDelegate:self]; // 4
```

</div>
</div>


Basic methods you need:
1. [`Synerise.initialize(apiKey:)`](/developers/mobile-sdk/method-reference/ios/lifecycle#initialization) - Initializes Synerise SDK.
2. [`Synerise.setDebugModeEnabled(_:)`](/developers/mobile-sdk/method-reference/ios/lifecycle#enable-debug-mode) - Enables debug mode for Synerise SDK. See [Debug mode](/developers/mobile-sdk/installation-and-configuration/ios#debug-mode) section for more information.
3. [`Synerise.setCrashHandlingEnabled(_:)`](/developers/mobile-sdk/method-reference/ios/lifecycle#enable-crash-handling) - Enables crash handling. Synerise SDK sends a crash event automatically when an uncaught exception occurs.
4. [`Synerise.setDelegate(_:)`](/developers/mobile-sdk/method-reference/ios/lifecycle#set-synerise-delegate)- Sets delegate to handle main actions from Synerise SDK. See [`SyneriseDelegate`](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#synerise-delegate) section for more information.

#### Initialization with custom API environment

To change API base URL for on-premise installations, use the following initialization method:


<div class="content-tabs code-tabs" data-tab-group="tabgrp-617">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-617-0" data-tab-group="tabgrp-617" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-617-1" data-tab-group="tabgrp-617">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-617-0" data-tab-group="tabgrp-617" data-tab-active="true">

```Swift
Synerise.initialize(apiKey: "YOUR_PROFILE_API_KEY", baseUrl: "YOUR_API_BASE_URL")
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-617-1" data-tab-group="tabgrp-617">

```Objective-C
[SNRSynerise initializeWithClientApiKey:@"YOUR_PROFILE_API_KEY" andBaseUrl:@"YOUR_API_BASE_URL"];
```

</div>
</div>



#### Advanced initialization

This is an example of advanced initialization with:
- custom API base URL for on-premise installations
- request validation salt configured
- debug mode enabled
- crash handling enabled
- most of the settings options available
- main delegate [`SyneriseDelegate`](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#synerise-delegate)
- client's state delegate [`ClientStateDelegate`](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#client-state-delegate)


<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

We highly recommend to configure settings when Synerise SDK is initialized, before invoking the [`Synerise.initialize(apiKey:)`](/developers/mobile-sdk/method-reference/ios/lifecycle#initialization) method. See [Settings](/developers/mobile-sdk/settings) section for more details about settings options.

</div></div></div>



<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Secure sensitive keys (for example, `apiKey` and `requestValidationSalt`) with mechanisms like string obfuscation or encryption.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

You can find more information about all [Synerise iOS SDK delegates here](/developers/mobile-sdk/listeners-and-delegates/ios-delegates).

</div></div></div>



<div class="content-tabs code-tabs" data-tab-group="tabgrp-618">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-618-0" data-tab-group="tabgrp-618" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-618-1" data-tab-group="tabgrp-618">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-618-0" data-tab-group="tabgrp-618" data-tab-active="true">

```Swift
Synerise.settings.sdk.enabled = true
Synerise.settings.sdk.appGroupIdentifier = "YOUR_APP_GROUP_IDENTIFIER"
Synerise.settings.sdk.keychainGroupIdentifier = "YOUR_KEYCHAIN_GROUP_IDENTIFIER"
Synerise.settings.sdk.minTokenRefreshInterval = 1800
Synerise.settings.sdk.shouldDestroySessionOnApiKeyChange = false

Synerise.settings.notifications.enabled = true
Synerise.settings.notifications.disableInAppAlerts = true
Synerise.settings.notifications.encryption = false

Synerise.settings.tracker.autotracking.enabled = true
Synerise.settings.tracker.autotracking.mode = AutoTrackMode.Fine
Synerise.settings.tracker.autotracking.excludedClasses = [SampleViewController.self]
Synerise.settings.tracker.autotracking.excludedViewTags = [0, 1, 2]

Synerise.settings.tracker.tracking.enabled = true

Synerise.settings.tracker.minBatchSize = 10
Synerise.settings.tracker.maxBatchSize = 100
Synerise.settings.tracker.autoFlushTimeout = 5.0
Synerise.settings.tracker.autoTracking.mode = .fine
Synerise.settings.tracker.locationAutomatic = true

Synerise.settings.injector.automatic = true

Synerise.initialize(apiKey: "YOUR_PROFILE_API_KEY", baseUrl: "YOUR_API_BASE_URL")
Synerise.setRequestValidationSalt("YOUR_REQUEST_VALIDATION_SALT")
Synerise.setDebugModeEnabled(false)
Synerise.setCrashHandlingEnabled(true)
Synerise.setDelegate(self)

Client.setClientStateDelegate(self)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-618-1" data-tab-group="tabgrp-618">

```Objective-C
SNRSynerise.settings.sdk.enabled = @YES;
SNRSynerise.settings.sdk.appGroupIdentifier = @"YOUR_APP_GROUP_IDENTIFIER";
SNRSynerise.settings.sdk.keychainGroupIdentifier = @"YOUR_KEYCHAIN_GROUP_IDENTIFIER";
SNRSynerise.settings.sdk.minTokenRefreshInterval = 1800;
SNRSynerise.settings.sdk.shouldDestroySessionOnApiKeyChange = NO;

SNRSynerise.settings.notifications.enabled = YES;
SNRSynerise.settings.notifications.disableInAppAlerts = YES;
SNRSynerise.settings.notifications.encryption = NO;

SNRSynerise.settings.tracker.autotracking.enabled = YES;
SNRSynerise.settings.tracker.autotracking.mode = SNRTrackerAutoTrackModeFine;
SNRSynerise.settings.tracker.autotracking.excludedClasses = [SampleViewController.class];
SNRSynerise.settings.tracker.autotracking.excludedViewTags = [@0, @2, @3];

SNRSynerise.settings.tracker.tracking.enabled = YES;

SNRSynerise.settings.tracker.minBatchSize = 10;
SNRSynerise.settings.tracker.maxBatchSize = 100;
SNRSynerise.settings.tracker.autoFlushTimeout = 5.0;
SNRSynerise.settings.tracker.autoTracking.mode = SNRTrackerAutoTrackModeFine;
SNRSynerise.settings.tracker.locationAutomatic = YES;

SNRSynerise.settings.injector.automatic = YES;

[SNRSynerise initializeWithApiKey:@"YOUR_PROFILE_API_KEY" andBaseUrl:@"YOUR_API_BASE_URL"];
[SNRSynerise setRequestValidationSalt:@"YOUR_REQUEST_VALIDATION_SALT"];
[SNRSynerise setDebugModeEnabled:NO];
[SNRSynerise setCrashHandlingEnabled:YES];
[SNRSynerise setDelegate:self];

[SNRClient setClientStateDelegate:self];
```

</div>
</div>


#### Initialization process

During initialization, the library starts and when it is ready or an error occurs, the SDK notifies you.

When the delegate method is called, Synerise is ready to use.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-619">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-619-0" data-tab-group="tabgrp-619" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-619-1" data-tab-group="tabgrp-619">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-619-0" data-tab-group="tabgrp-619" data-tab-active="true">

```Swift
// MARK: - SyneriseDelegate

// This method is called when the Synerise SDK is initialized.
func snr_initialized() {
  //...
}

// This method is called when an error occurs while initializing the Synerise SDK.
func snr_initializationError(error: Error) {
  //...
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-619-1" data-tab-group="tabgrp-619">

```Objective-C
#pragma mark - SNRSyneriseDelegate

// This method is called when the Synerise SDK is initialized.
- (void)SNR_initialized {
  //...
}

// This method is called when an error occurs while initializing the Synerise SDK.
- (void)SNR_initializationError:(NSError *)error {
  //...
}
```

</div>
</div>



### Debug Mode
---
You can enable debug logs for Synerise SDK by method [`Synerise.setDebugModeEnabled(_:)`](/developers/mobile-sdk/method-reference/ios/lifecycle#enable-debug-mode).


<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Do not use Debug Mode in a release version of your application.

</div></div></div>



<div class="content-tabs code-tabs" data-tab-group="tabgrp-620">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-620-0" data-tab-group="tabgrp-620" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-620-1" data-tab-group="tabgrp-620">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-620-0" data-tab-group="tabgrp-620" data-tab-active="true">

```Swift
Synerise.setDebugModeEnabled(true) // Enables logging for all modules
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-620-1" data-tab-group="tabgrp-620">

```Objective-C
[SNRSynerise setDebugModeEnabled:YES]; // Enables logging for all modules
```

</div>
</div>


You can receive some logs about:
- **Core**: push notifications
- **Tracker**: auto-tracked events, declarative events, sending process
- **Client**: customer state, authorization
- **Injector**: campaigns, UI
- **Promotions**: promotions, vouchers
- **Content**: content widget, documents, recommendations

### Background Tasks
---
[Background Tasks](https://developer.apple.com/documentation/backgroundtasks) is a mechanism to schedule and run code in the background to keep your app up to date. 

Synerise supports using Background Tasks since SDK version **4.23.0**. You can pass configured identifiers for Synerise SDK by using the  [`Synerise.setBackgroundTaskIdentifiers(_:)`](/developers/mobile-sdk/method-reference/ios/lifecycle#set-background-task-identifiers) method. The identifiers that you are going to pass have to be configured properly in the host app.
  
##### Benefits

Currently, the SDK uses Background Tasks only to refresh the registration token for Push Notifications every 20 days. In these situations, the SDK invokes the [snr_registerForPushNotificationsIsNeeded(origin:)](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#synerise-delegate-register-for-push-notifications-is-needed-by-origin) method or [snr_registerForPushNotificationsIsNeeded()](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#synerise-delegate-register-for-push-notifications-is-needed) method.
  
##### Setting up

To configure Background Tasks in your app:
1. Go to Xcode project's target's **Signing & Capabilities** section.
2. In the **Background Modes** capability (you may need to add it), enable **Background fetch** and **Background processing**.
3. Go to `Info.plist`.
4. Add a row with the following array type value: `Permitted background task scheduler identifiers`.
5. Add string identifiers, each as a separate item to declare possible Background Tasks identifiers in your app.
6. Pass these Background Tasks identifiers to SDK by using the [`Synerise.setBackgroundTaskIdentifiers(_:)`](/developers/mobile-sdk/method-reference/ios/lifecycle#set-background-task-identifiers) method. You must invoke the method **BEFORE** your app is launched (before the `application(_ application:didFinishLaunchingWithOptions launchOptions:)` method finishes).

Sample `\*.plist` configuration for Background Tasks:
<figure>
  <img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/developers/mobile-sdk/_gfx/ios-background-tasks-plist-configuration.png" alt="Sample *.plist configuration for Background Tasks" class="full">
  <figcaption>Sample *.plist configuration for Background Tasks</figcaption>
</figure>

Example code for passing Background Tasks identifiers to the SDK:  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-621">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-621-0" data-tab-group="tabgrp-621" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-621-1" data-tab-group="tabgrp-621">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-621-0" data-tab-group="tabgrp-621" data-tab-active="true">

```Swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    // ...
    Synerise.setBackgroundTaskIdentifiers(["YOUR_BACKGROUND_TASK_IDENTIFIER"])

    return true
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-621-1" data-tab-group="tabgrp-621">

```Objective-C
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // ...
    [SNRSynerise setBackgroundTaskIdentifiers:@[@"YOUR_BACKGROUND_TASK_IDENTIFIER"]];

    return YES;
}
```

</div>
</div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The method's parameter is an array because of possible future purposes.

</div></div></div>



<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Do not use those identifiers for other Background Tasks in your app.

</div></div></div>


Documentation is available at [Apple Developer - Using background tasks to update your app](https://developer.apple.com/documentation/uikit/app_and_environment/scenes/preparing_your_ui_to_run_in_the_background/using_background_tasks_to_update_your_app).

**IMPORTANT: To configure Background Tasks properly, you must set `SyneriseDelegate` before the SDK initialization.**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-622">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-622-0" data-tab-group="tabgrp-622" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-622-1" data-tab-group="tabgrp-622">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-622-0" data-tab-group="tabgrp-622" data-tab-active="true">

```Swift
Synerise.setDelegate(self)
Synerise.initialize(apiKey: "YOUR_PROFILE_API_KEY")
// ...
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-622-1" data-tab-group="tabgrp-622">

```Objective-C
[SNRSynerise setDelegate:self];
[SNRSynerise initializeWithApiKey:@"YOUR_PROFILE_API_KEY"];
// ...
```

</div>
</div>


### Privacy manifest
---
From **1 May 2024**, Apple requires you to add a privacy manifest. It's a file in your project that describes your reason and method for collecting data.

Third-party frameworks that track data should have a privacy manifest. When you create the application privacy report, these privacy manifest files are automatically aggregated into a single file. 

Synerise supports privacy manifests since SDK version **4.17.0**. When you use an SDK version older than **4.17.0**, refer to the Synerise API usage requirements defined below when creating an Apple privacy manifest.

##### APIs usage

| API | Reason | Description |
| --- | --- | --- |
| User defaults APIs | **CA92.1**<br/>**1C8F.1** | Synerise uses User Defaults to persist the SDK data and share them between the application and extensions |

##### Tracking

Synerise does not track any data that is protected by the [App Tracking Transparency](https://developer.apple.com/documentation/apptrackingtransparency) framework.

##### Collected Data

| Data type | Value | Purpose |
| --- | --- | --- |
| User ID | **NSPrivacyCollectedDataTypeUserID** | Analytics, Product Personalization |
| Other usage data | **NSPrivacyCollectedDataTypeOtherUsageData** | Analytics, Product Personalization, App Functionality |
| Product interaction | **NSPrivacyCollectedDataTypeProductInteraction** | Analytics |
| Advertising data | **NSPrivacyCollectedDataTypeAdvertisingData** | Other Purposes, App Functionality |
| Crash data | **NSPrivacyCollectedDataTypeOtherUserContent** | Analytics |


### Warnings and limitations
---

Be careful with keychain deletion operations due to the possibility of deleting Synerise data. All the SDK library data keys are named `snr.[KEY_NAME]`.





# Client


### ClientIdentityProvider
<!-- reusable-table-boundary -->

This enum contains values which set the provider for deleting a profile (a profile itself and their account).

**Declared In:**  
`com.synerise.sdk.client.model.ClientIdentityProvider`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-50">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-50-0" data-tab-group="tabgrp-50" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-50-1" data-tab-group="tabgrp-50">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-50-0" data-tab-group="tabgrp-50" data-tab-active="true">

```Java
public enum ClientIdentityProvider
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-50-1" data-tab-group="tabgrp-50">

```Kotlin
public enum ClientIdentityProvider
```

</div>
</div>


**Values:**

| Property | Value | Description |
| --- | --- | --- |
| **FACEBOOK** | "FACEBOOK" | Facebook provider |
| **GOOGLE** | "GOOGLE" | Google provider |
| **OAUTH** | "OAUTH" | Oauth provider |
| **SYNERISE** | "SYNERISE" | Synerise provider |
| **SIMPLE_AUTH** | "SIMPLE_AUTH" | Simple Profile Authentication provider |

**Methods:**  

Get a provider.


<pre><code class="language-java">public static ClientIdentityProvider getByProvider(String provider)</code></pre>


---

<!-- reusable-table-boundary -->

---
---

### AuthConditions
<!-- reusable-table-boundary -->

Auth conditions model. 
Model passes status and conditions.

**Declared In:**  
`com.synerise.sdk.client.model`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-51">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-51-0" data-tab-group="tabgrp-51" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-51-1" data-tab-group="tabgrp-51">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-51-0" data-tab-group="tabgrp-51" data-tab-active="true">

```Java
public class AuthConditions
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-51-1" data-tab-group="tabgrp-51">

```Kotlin
class AuthConditions
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **status** | [ConditionalAuthenticationStatus](/developers/mobile-sdk/class-reference/android/client#conditionalauthenticationstatus) | no | - | Status of authentication |
| **conditions** | ArrayList<Object> | no | - | List of conditions |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All of the properties above are accessible by using getters.

</div></div></div>


**Methods:**  

There are getters and setters for the above properties.

---

<!-- reusable-table-boundary --> 

---
---

### ConditionalAuthenticationStatus
<!-- reusable-table-boundary -->

This enum contains values which describe the status of an after a log-in attempt.

**Declared In:**  
`com.synerise.sdk.client.model.ConditionalAuthenticationStatus`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-52">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-52-0" data-tab-group="tabgrp-52" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-52-1" data-tab-group="tabgrp-52">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-52-0" data-tab-group="tabgrp-52" data-tab-active="true">

```Java
public enum ConditionalAuthenticationStatus
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-52-1" data-tab-group="tabgrp-52">

```Kotlin
public enum ConditionalAuthenticationStatus
```

</div>
</div>


**Values:**

| Property | Description |
| --- | -- |
| **SUCCESS** | Authentication successful |
| **UNAUTHORIZED** | Currently unused |
| **ACTIVATION_REQUIRED** |Currently unused |
| **REGISTRATION_REQUIRED** | Currently unused |
| **APPROVAL_REQUIRED** | Currently unused |
| **TERMS_ACCEPTANCE_REQUIRED** | Currently unused |
| **MFA_REQUIRED** | Currently unused |

**Methods:**  

There are no methods.

<!-- reusable-table-boundary -->

---
---

### ClientData
<!-- reusable-table-boundary -->

**Declared In:**  
`com.synerise.sdk.client.model.simpleAuth`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-53">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-53-0" data-tab-group="tabgrp-53" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-53-1" data-tab-group="tabgrp-53">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-53-0" data-tab-group="tabgrp-53" data-tab-active="true">

```Java
public final class ClientData extends ClientDataInformation
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-53-1" data-tab-group="tabgrp-53">

```Kotlin
class ClientData : ClientDataInformation
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | String | yes | - | Customer's email |
| **phone** | String | yes | - | Customer's phone |
| **customId** | String | yes | - | Customer's custom ID |
| **uuid** | String | yes | - | Customer's uuid |
| **firstName** | String | yes | - | Customer's first name |
| **lastName** | String | yes | - | Customer's last name |
| **displayName** | String | yes | - | Customer's display name |
| **company** | String | yes | - | Customer's company |
| **address** | String | yes | - | Customer's address |
| **city** | String | yes | - | Customer's city |
| **province** | String | yes | - | Customer's province |
| **zipCode** | String | yes | - | Customer's ZIP code |
| **countryCode** | String | yes | - | Customer's country code |
| **birthDate** | String | yes | - | Customer's birthdate |
| **sex** | [Sex](/developers/mobile-sdk/class-reference/android/client#sex) | yes | - | Customer's sex |
| **avatarUrl** | String | yes | - | Customer's avatar URL |
| **agreements** | [Agreements](/developers/mobile-sdk/class-reference/android/client#agreements) | yes | - | Customer's agreements |
| **attributes** | [Attributes](/developers/mobile-sdk/class-reference/android/client#attributes) | yes | - | Customer's attributes |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties above are accessible by using setters.

</div></div></div>


**Initializers:**  
There are no initializers.

**Methods:**  
There are only setters for above properties.

<!-- reusable-table-boundary --> 

---
---

### ClientSessionEndReason
<!-- reusable-table-boundary -->

This enum contains values which describe the reason for sending a session.

**Declared In:**  
`com.synerise.sdk.core.types.enums.ClientSessionEndReason`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-54">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-54-0" data-tab-group="tabgrp-54" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-54-1" data-tab-group="tabgrp-54">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-54-0" data-tab-group="tabgrp-54" data-tab-active="true">

```Java
public enum ClientSessionEndReason
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-54-1" data-tab-group="tabgrp-54">

```Kotlin
public enum ClientSessionEndReason
```

</div>
</div>


**Values:**

| Property | Description |
| --- | --- |
| **SESSION_EXPIRATION** | Session ended due to token expiration. |
| **SECURITY_EXCEPTION** | Session ended due to security errors. |
| **USER_SIGN_OUT** | Session ended due to a profile sign-out. |
| **SYSTEM_SIGN_OUT** | Session ended due to a remote sign out by the system. |
| **SESSION_DESTROYED** | Session ended due to the `Client.destroySession` method. |
| **CLIENT_REJECTED** | Session ended due to 401 or 410 response. |
| **USER_ACCOUNT_DELETED** | Session ended due to profile account deletion. |

**Methods:**  

There are no methods.

<!-- reusable-table-boundary -->

---
---

### ClientSignOutMode
<!-- reusable-table-boundary -->

This enum contains values for the sign out mode.

**Declared In:**  
`com.synerise.sdk.core.types.enums`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-55">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-55-0" data-tab-group="tabgrp-55" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-55-1" data-tab-group="tabgrp-55">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-55-0" data-tab-group="tabgrp-55" data-tab-active="true">

```Java
public enum ClientSignOutMode
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-55-1" data-tab-group="tabgrp-55">

```Kotlin
public enum ClientSignOutMode
```

</div>
</div>


**Values:**

| Property | Value | Description |
| --- | --- | --- |
| **SIGN_OUT** | "LOGOUT" | Sign out with a backend call. The token is invalidated and cleared in the SDK, but the UUID remains the same. |
| **SIGN_OUT_WITH_SESSION_DESTROY** | "LOGOUT_WITH_SESSION_DESTROY" | Sign out with a backend call. The token is invalidated. The token and UUID are cleared in the SDK. |


**Methods:**  

No methods.

---

<!-- reusable-table-boundary -->

---
---

### GetAccountInformation
<!-- reusable-table-boundary -->

Class providing a profile account information.

**Declared In:**  
`com.synerise.sdk.client.model.GetAccountInformation`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-56">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-56-0" data-tab-group="tabgrp-56" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-56-1" data-tab-group="tabgrp-56">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-56-0" data-tab-group="tabgrp-56" data-tab-active="true">

```Java
public final class GetAccountInformation extends AccountInformation implements Serializable
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-56-1" data-tab-group="tabgrp-56">

```Kotlin
class GetAccountInformation:AccountInformation(), Serializable
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **clientId** | long | no | - | A unique ID of a profile |
| **lastActivityDate** | Date | no | - | Profile's last performed activity date |
| **email** | String | no | - | Profile's email |
| **phone** | String | no | - | Profile's phone |
| **customId** | String | no | - | Profile's customId |
| **uuid** | String | no | - | Profile's UUID |
| **firstName** | String | no | - | Profile's first name |
| **lastName** | String | no | - | Profile's last name |
| **displayName** | String | no | - | Profile's display name |
| **company** | String | no | - | Profile's company |
| **address** | String | no | - | Profile's address |
| **city** | String | no | - | Profile's city |
| **province** | String | no | - | Profile's province |
| **zipCode** | String | no | - | Profile's ZIP code |
| **countryCode** | String | no | - | Profile's country code |
| **birthDate** | String | no | - | Profile's birth date |
| **sex** | [Sex](/developers/mobile-sdk/class-reference/android/client#sex) | no | - | Profile's sex |
| **avatarUrl** | String | no | - | Profile's avatar URL |
| **anonymous** | Boolean | no | - | Defines if the profile is anonymous |
| **agreements** | [Agreements](/developers/mobile-sdk/class-reference/android/client#agreements) | no | - | Profile's agreements |
| **attributes** | [Attributes](/developers/mobile-sdk/class-reference/android/client#attributes) | no | - | Profile's attributes |
| **tags** | List<String> | no | - | Profile's tags |



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties above are accessible by using getters.

</div></div></div>


**Initializers:**  
There are no initializers.

**Methods:**  
There are only getters for the above properties.

---

<!-- reusable-table-boundary --> 


---
---

### UpdateAccountBasicInformation
<!-- reusable-table-boundary -->

Class providing data to update account basic information.

**Declared In:**  
`com.synerise.sdk.client.model.UpdateAccountBasicInformation`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-57">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-57-0" data-tab-group="tabgrp-57" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-57-1" data-tab-group="tabgrp-57">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-57-0" data-tab-group="tabgrp-57" data-tab-active="true">

```Java
public final class UpdateAccountBasicInformation
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-57-1" data-tab-group="tabgrp-57">

```Kotlin
class UpdateAccountBasicInformation
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **phoneNumber** | String | no | - | Profile's phone |
| **firstName** | String | no | - | Profile's first name |
| **lastName** | String | no | - | Profile's last name |
| **displayName** | String | no | - | Profile's display name |
| **company** | String | no | - | Profile's company |
| **address** | String | no | - | Profile's address |
| **city** | String | no | - | Profile's city |
| **province** | String | no | - | Profile's province |
| **zipCode** | String | no | - | Profile's ZIP code |
| **countryCode** | String | no | - | Profile's country code |
| **birthDate** | String | no | - | Profile's birth date |
| **sex** | [Sex](/developers/mobile-sdk/class-reference/android/client#sex) | no | - | Profile's sex |
| **avatarUrl** | String | no | - | Profile's avatar URL |
| **anonymous** | Boolean | no | - | Defines if the profile is anonymous |
| **agreements** | [Agreements](/developers/mobile-sdk/class-reference/android/client#agreements) | no | - | Profile's agreements |
| **attributes** | [Attributes](/developers/mobile-sdk/class-reference/android/client#attributes) | no | - | Profile's attributes |



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties above are accessible by using setters.

</div></div></div>


**Initializers:**  
There are no initializers.

**Methods:**  
There are only setters for above properties.

---

<!-- reusable-table-boundary -->

---
---

### UpdateAccountInformation
<!-- reusable-table-boundary -->

Class providing data to update account information.

**Declared In:**  
`com.synerise.sdk.client.model.UpdateAccountInformation`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-58">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-58-0" data-tab-group="tabgrp-58" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-58-1" data-tab-group="tabgrp-58">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-58-0" data-tab-group="tabgrp-58" data-tab-active="true">

```Java
public final class UpdateAccountInformation extends AccountInformation
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-58-1" data-tab-group="tabgrp-58">

```Kotlin
class UpdateAccountInformation:AccountInformation()
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | String | no | - | Profile's email |
| **phoneNumber** | String | no | - | Profile's phone |
| **customId** | String | no | - | Profile's customId |
| **uuid** | String | no | - | Profile's uuid |
| **firstName** | String | no | - | Profile's first name |
| **lastName** | String | no | - | Profile's last name |
| **displayName** | String | no | - | Profile's display name |
| **company** | String | no | - | Profile's company |
| **address** | String | no | - | Profile's address |
| **city** | String | no | - | Profile's city |
| **province** | String | no | - | Profile's province |
| **zipCode** | String | no | - | Profile's ZIP code |
| **countryCode** | String | no | - | Profile's country code |
| **birthDate** | String | no | - | Profile's birth date |
| **sex** | [Sex](/developers/mobile-sdk/class-reference/android/client#sex) | no | - | Profile's sex |
| **avatarUrl** | String | no | - | Profile's avatar URL |
| **anonymous** | Boolean | no | - | Defines if the profile is anonymous |
| **agreements** | [Agreements](/developers/mobile-sdk/class-reference/android/client#agreements) | no | - | Profile's agreements |
| **attributes** | [Attributes](/developers/mobile-sdk/class-reference/android/client#attributes) | no | - | Profile's attributes |



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties above are accessible by using setters.

</div></div></div>


**Initializers:**  

There are no initializers.

**Methods:**  

There are only setters for above properties.

---

<!-- reusable-table-boundary --> 

---
---

### RegisterClient
<!-- reusable-table-boundary -->

Class responsible for registering a profile.

**Declared In:**  
`com.synerise.sdk.client.model.client.RegisterClient`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-59">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-59-0" data-tab-group="tabgrp-59" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-59-1" data-tab-group="tabgrp-59">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-59-0" data-tab-group="tabgrp-59" data-tab-active="true">

```Java
public class RegisterClient extends BaseClient
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-59-1" data-tab-group="tabgrp-59">

```Kotlin
class RegisterClient : BaseClient
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **agreements** | [Agreements](/developers/mobile-sdk/class-reference/android/client#agreements) | no | - | Profile's agreements |
| **attributes** | [Attributes](/developers/mobile-sdk/class-reference/android/client#attributes) | no | - | Profile's attributes |
| **city** | String | yes | - | Profile's city |
| **company** | String | yes | - | Profile's company |
| **countryCode** | String | yes | - | Profile's country code |
| **customId** | String | yes | - | Profile's customId |
| **firstName** | String | yes | - | Profile's first name |
| **lastName** | String | yes | - | Profile's last name |
| **phoneNumber** | String | yes | - | Profile's phone number |
| **province** | String | yes | - | Profile's province |
| **sex** | [Sex](/developers/mobile-sdk/class-reference/android/client#sex) | yes | - | Profile's sex |
| **zipCode** | String | yes | - | Profile's ZIP code |
| **uuid** | String | yes | - | Profile's UUID |
| **email** | String | yes | - | Profile's email |
| **password** | String | yes | - | Profile's password |



**Initializers:**  

There are no initializers.

**Methods:**  

All properties have their own setters.

---

<!-- reusable-table-boundary --> 

---
---

### PasswordResetRequest
<!-- reusable-table-boundary -->

Class responsible for creating a payload for password reset request.

**Declared In:**  
`com.synerise.sdk.client.model.password.PasswordResetRequest`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-60">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-60-0" data-tab-group="tabgrp-60" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-60-1" data-tab-group="tabgrp-60">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-60-0" data-tab-group="tabgrp-60" data-tab-active="true">

```Java
public final class PasswordResetRequest
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-60-1" data-tab-group="tabgrp-60">

```Kotlin
class PasswordResetRequest
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | String | yes | - | Profile's email |



**Initializers:**  

There is a constructor.


<pre><code class="language-java">public PasswordResetRequest(@NonNull String email)</code></pre>


**Methods:**  

There are no methods.

---

<!-- reusable-table-boundary --> 

---
---

### PasswordResetConfirmation
<!-- reusable-table-boundary -->

Class responsible for creating a payload for password reset confirmation.

**Declared In:**  
`com.synerise.sdk.client.model.password.PasswordResetConfirmation`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-61">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-61-0" data-tab-group="tabgrp-61" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-61-1" data-tab-group="tabgrp-61">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-61-0" data-tab-group="tabgrp-61" data-tab-active="true">

```Java
public final class PasswordResetConfirmation
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-61-1" data-tab-group="tabgrp-61">

```Kotlin
class PasswordResetConfirmation
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **password** | String | no | - | Profile's password |
| **token** | String | no | - | Profile's token |




**Initializers:**  

There is a constructor.


<pre><code class="language-java">public PasswordResetConfirmation(@NonNull String password, @NonNull String token)</code></pre>


**Methods:**  

There are no methods.

---

<!-- reusable-table-boundary --> 

---
---

### Sex
<!-- reusable-table-boundary -->

This enum contains values for the `sex` parameter.

**Declared In:**  
`com.synerise.sdk.core.types.enums.Sex`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-62">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-62-0" data-tab-group="tabgrp-62" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-62-1" data-tab-group="tabgrp-62">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-62-0" data-tab-group="tabgrp-62" data-tab-active="true">

```Java
public enum Sex
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-62-1" data-tab-group="tabgrp-62">

```Kotlin
public enum Sex
```

</div>
</div>


**Values:**

| Property | Value | Description |
| --- | --- | --- |
| **FEMALE** | "FEMALE" | Female |
| **MALE** | "MALE" | Male |
| **OTHER** | "OTHER" | Other |
| **NA** | "NOT_SPECIFIED" | Not specified |

**Methods:**  

This method retrieves the value of the `sex` parameter.


<pre><code class="language-java">public String getSex()</code></pre>


---

This method retrieves the value of the `sex` parameter.


<pre><code class="language-java">public static Sex getSex(String name)</code></pre>


---

<!-- reusable-table-boundary -->

---
---

### Agreements
<!-- reusable-table-boundary -->

Class responsible for passing agreements.

**Declared In:**  
`com.synerise.sdk.client.model.client.Agreements`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-63">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-63-0" data-tab-group="tabgrp-63" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-63-1" data-tab-group="tabgrp-63">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-63-0" data-tab-group="tabgrp-63" data-tab-active="true">

```Java
public class Agreements
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-63-1" data-tab-group="tabgrp-63">

```Kotlin
class Agreements
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | Boolean | yes | - | Email agreement |
| **sms** | Boolean | yes | - | SMS agreement |
| **push** | Boolean | yes | - | Push agreement |
| **bluetooth** | Boolean | yes | - | Bluetooth agreement |
| **rfid** | Boolean | yes | - | RFID agreement |
| **wifi** | Boolean | yes | - | WiFi agreement |


**Initializers:**  

There are no initializers.

**Methods:**  

All properties have their own setters and getters.

---

<!-- reusable-table-boundary --> 

---
---

### Attributes
<!-- reusable-table-boundary -->

Class responsible for passing attributes.

**Declared In:**  
`com.synerise.sdk.client.model.client.Attributes`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-64">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-64-0" data-tab-group="tabgrp-64" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-64-1" data-tab-group="tabgrp-64">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-64-0" data-tab-group="tabgrp-64" data-tab-active="true">

```Java
public class Attributes
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-64-1" data-tab-group="tabgrp-64">

```Kotlin
class Attributes
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **properties** | HashMap<String, String> | yes | - | A key-value pair of profile's attributes |



**Initializers:**  

There are no initializers.

**Methods:**  

This method adds attributes. 

<pre><code class="language-java">public Attributes add(String key, String value)</code></pre>



---

This method retrieves a value of an attribute. 

<pre><code class="language-java">public HashMap&lt;String, String&gt; getProperties()</code></pre>



---

<!-- reusable-table-boundary --> 

---
---

### ClientEventData
<!-- reusable-table-boundary -->

Event data model.

**Declared In:**  
`com.synerise.sdk.client.model.events.ClientEventData`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-65">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-65-0" data-tab-group="tabgrp-65" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-65-1" data-tab-group="tabgrp-65">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-65-0" data-tab-group="tabgrp-65" data-tab-active="true">

```Java
public class ClientEventData
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-65-1" data-tab-group="tabgrp-65">

```Kotlin
class ClientEventData
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **time** | String | no | - | Event time |
| **action** | String | no | - | Event action |
| **label** | String | no | - | Can't be empty. This value isn't saved in persistent storage and can't be used in Decision Hub or Automation Hub. It isn't shown on a Profile card.  |
| **client** | HashMap<String, Object> | no | - | Profiles |



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties above are accessible by using getters and setters.

</div></div></div>


**Initializers:**  

There are no initializers.

**Methods:**  

This method returns the value of the `email` attribute from the profile hashmap.


<pre><code class="language-java">public String getClientEmail()</code></pre>


---

This method returns the `uuid` attribute from the profile hashmap.


<pre><code class="language-java">public String getClientUuid()</code></pre>


---

This method returns the `clientId` attribute from the profile hashmap.


<pre><code class="language-java">public int getClientId()</code></pre>


---

<!-- reusable-table-boundary --> 

---
---

### ClientEventQuery
<!-- reusable-table-boundary -->

Class responsible for creating a query to get events.

**Declared In:**  
`com.synerise.sdk.client.model.client.ClientEventsQuery`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-66">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-66-0" data-tab-group="tabgrp-66" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-66-1" data-tab-group="tabgrp-66">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-66-0" data-tab-group="tabgrp-66" data-tab-active="true">

```Java
public class ClientEventsQuery
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-66-1" data-tab-group="tabgrp-66">

```Kotlin
class ClientEventsQuery
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **actions** | List<String> | yes | - | Event action |
| **timeFrom** | Date | yes | - | Event time |
| **label** | String | yes | - | This value is currently unused |
| **limit** | int | yes | 1000 | Event limit |



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties above are accessible by using setters.

</div></div></div>


**Initializers:**  

There are no initializers.

**Methods:**  

There are no methods.

---

<!-- reusable-table-boundary --> 

---
---

### TokenPayload
<!-- reusable-table-boundary -->

TokenPayload model.

**Declared In:**  
`com.synerise.sdk.core.types.model.TokenPayload`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-67">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-67-0" data-tab-group="tabgrp-67" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-67-1" data-tab-group="tabgrp-67">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-67-0" data-tab-group="tabgrp-67" data-tab-active="true">

```Java
public class TokenPayload
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-67-1" data-tab-group="tabgrp-67">

```Kotlin
class TokenPayload
```

</div>
</div>

  
**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **tokenString** | String | no | Token as a raw string |
| **expirationDate** | Date | no | Token's expiration time |
| **creationDate** | Date | no | Token's creation time |
| **rlm** | [TokenRLM](/developers/mobile-sdk/class-reference/android/client#tokenrlm) | no | Token's RLM |
| **origin** | [TokenOrigin](/developers/mobile-sdk/class-reference/android/client#tokenorigin) | no | Token's origin |
| **uuid** | String | no | Customer's UUID |
| **clientId** | String | no | Customer's ID |
| **customId** | String | yes | Customer's custom ID |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties above are accessible by using getters.

</div></div></div>


**Initializers:**  
There are no initializers.

**Methods:**  
There are only getters for the above properties.

---

<!-- reusable-table-boundary -->

---
---

### Token
<!-- reusable-table-boundary -->

Token model.

**Declared In:**  
`com.synerise.sdk.core.types.model.Token`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-68">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-68-0" data-tab-group="tabgrp-68" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-68-1" data-tab-group="tabgrp-68">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-68-0" data-tab-group="tabgrp-68" data-tab-active="true">

```Java
public class Token
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-68-1" data-tab-group="tabgrp-68">

```Kotlin
class Token
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **rawJwt** | String | no | - | Raw JWT token string |
| **expirationUnixTime** | long | no | - | Parsed expiration time in UNIX format |
| **signKey** | String | no | - | Encrypted signing key |
| **tokenRLM** | [TokenRLM](/developers/mobile-sdk/class-reference/android/client#tokenrlm) | no | - | Token scope |
| **tokenOrigin** | [TokenOrigin](/developers/mobile-sdk/class-reference/android/client#tokenorigin) | no | - | Token source origin |
| **clientId** | String | no | - | Token customer ID |
| **customId** | String | no | - | Token customId |



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties above are accessible by using getters.

</div></div></div>


**Initializers:**  


<pre><code class="language-java">public static Token createToken(String signKey, String rawJwt, long expirationUnixTime, String rlm, String origin)</code></pre>


---

<!-- reusable-table-boundary --> 

---
---

### TokenOrigin
<!-- reusable-table-boundary -->

This enum contains values for a token origin.

**Declared In:**  
`com.synerise.sdk.core.types.model.Token.TokenOrigin`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-69">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-69-0" data-tab-group="tabgrp-69" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-69-1" data-tab-group="tabgrp-69">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-69-0" data-tab-group="tabgrp-69" data-tab-active="true">

```Java
public enum TokenOrigin
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-69-1" data-tab-group="tabgrp-69">

```Kotlin
public enum TokenOrigin
```

</div>
</div>


**Values:**

| Property | Value | Description |
| --- | --- | --- |
| **SYNERISE** | "SYNERISE" | Token comes from Synerise |
| **SIMPLE_AUTH** | "SIMPLE_AUTH" | Token comes from Synerise Simple Profile Authentication |
| **FACEBOOK** | "FACEBOOK" | Token comes from Facebook |
| **OAUTH** | "OAUTH" | Token comes from OAuth |
| **UNKNOWN** | "UNKNOWN" | Unknown token source |


**Methods:**  

This method retrieves the value of the `origin` parameter.


<pre><code class="language-java">public String getOrigin()</code></pre>


---

This method retrieves the value of the `origin` parameter.


<pre><code class="language-java">public static TokenOrigin getOrigin(String rlm)</code></pre>


---

<!-- reusable-table-boundary -->

---
---

### TokenRLM
<!-- reusable-table-boundary -->

This enum contains values for a token realm.

**Declared In:**  
`com.synerise.sdk.core.types.model.Token.TokenRLM`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-70">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-70-0" data-tab-group="tabgrp-70" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-70-1" data-tab-group="tabgrp-70">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-70-0" data-tab-group="tabgrp-70" data-tab-active="true">

```Java
public enum TokenRLM
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-70-1" data-tab-group="tabgrp-70">

```Kotlin
public enum TokenRLM
```

</div>
</div>


**Values:**

| Property | Value | Description |
| --- | --- | --- |
| **ANONYMOUS** | "anonymous_client" | Anonymous profile |
| **CLIENT** | "client" | Recognized profile |


**Methods:**  

This method retrieves the value of the `rlm` parameter.


<pre><code class="language-java">public String getRlm()</code></pre>


---

This method retrieves the value of the `rlm` parameter.


<pre><code class="language-java">public static TokenRLM getRlm(String rlm)</code></pre>


---

<!-- reusable-table-boundary -->





# iOS

## Class reference - iOS


# Installation and configuration


In this section, you will find out how to install, configure, and initialize SDK in the Android, iOS and React Native mobile applications.

## Contents


# React Native

## Method reference - React Native






















# React Native

## Class reference - React Native




# Events


### TrackerParams
Represents custom parameters that may be added to tracked events.
  
**Declared In:**  
Headers/SNRTrackerParams.h  
  
**Related To:**  
[Event](/developers/mobile-sdk/class-reference/ios/events#event)
  
**Inherits From:**  
[NSObject](https://developer.apple.com/documentation/objectivec/nsobject)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-246">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-246-0" data-tab-group="tabgrp-246" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-246-1" data-tab-group="tabgrp-246">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-246-0" data-tab-group="tabgrp-246" data-tab-active="true">

```Swift
class TrackerParams: NSObject
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-246-1" data-tab-group="tabgrp-246">

```Objective-C
@interface SNRTrackerParams : NSObject
```

</div>
</div>

  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-247">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-247-0" data-tab-group="tabgrp-247" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-247-1" data-tab-group="tabgrp-247">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-247-0" data-tab-group="tabgrp-247" data-tab-active="true">

```Swift
static func makeWithBuilder(_: ((TrackerParamsBuilder) -> ()))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-247-1" data-tab-group="tabgrp-247">

```Objective-C
+ (instancetype)makeWithBuilder:(nonnull void (^)(SNRTrackerParamsBuilder *builder))buildBlock
```

</div>
</div>


---
---

### TrackerParamsBuilder
Object that is used to create parameters for the event classes.
  
**Declared In:**  
Headers/SNRTrackerParamsBuilder.h  
  
**Related To:**  
[TrackerParams](/developers/mobile-sdk/class-reference/ios/events#trackerparams)  
[Event](/developers/mobile-sdk/class-reference/ios/events#event)  
  
**Inherits From:**  
[NSObject](https://developer.apple.com/documentation/objectivec/nsobject)  
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-248">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-248-0" data-tab-group="tabgrp-248" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-248-1" data-tab-group="tabgrp-248">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-248-0" data-tab-group="tabgrp-248" data-tab-active="true">

```Swift
class TrackerParamsBuilder: NSObject
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-248-1" data-tab-group="tabgrp-248">

```Objective-C
@interface SNRTrackerParamsBuilder : NSObject
```

</div>
</div>

  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-249">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-249-0" data-tab-group="tabgrp-249" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-249-1" data-tab-group="tabgrp-249">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-249-0" data-tab-group="tabgrp-249" data-tab-active="true">

```Swift
init()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-249-1" data-tab-group="tabgrp-249">

```Objective-C
- (instancetype)init
```

</div>
</div>


**Methods:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-250">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-250-0" data-tab-group="tabgrp-250" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-250-1" data-tab-group="tabgrp-250">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-250-0" data-tab-group="tabgrp-250" data-tab-active="true">

```Swift
func setString(_: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-250-1" data-tab-group="tabgrp-250">

```Objective-C
- (void)setString:(nonnull NSString *)string forKey:(nonnull NSString *)key
```

</div>
</div>


---


<div class="content-tabs code-tabs" data-tab-group="tabgrp-251">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-251-0" data-tab-group="tabgrp-251" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-251-1" data-tab-group="tabgrp-251">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-251-0" data-tab-group="tabgrp-251" data-tab-active="true">

```Swift
func setInt(_: Int)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-251-1" data-tab-group="tabgrp-251">

```Objective-C
- (void)setInt:(NSInteger)integer forKey:(nonnull NSString *)key
```

</div>
</div>


---


<div class="content-tabs code-tabs" data-tab-group="tabgrp-252">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-252-0" data-tab-group="tabgrp-252" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-252-1" data-tab-group="tabgrp-252">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-252-0" data-tab-group="tabgrp-252" data-tab-active="true">

```Swift
func setDouble(_: Double)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-252-1" data-tab-group="tabgrp-252">

```Objective-C
- (void)setDouble:(double)doubleValue forKey:(nonnull NSString *)key
```

</div>
</div>


---


<div class="content-tabs code-tabs" data-tab-group="tabgrp-253">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-253-0" data-tab-group="tabgrp-253" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-253-1" data-tab-group="tabgrp-253">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-253-0" data-tab-group="tabgrp-253" data-tab-active="true">

```Swift
func setFloat(_: Float)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-253-1" data-tab-group="tabgrp-253">

```Objective-C
- (void)setFloat:(float)floatValue forKey:(nonnull NSString *)key
```

</div>
</div>


---


<div class="content-tabs code-tabs" data-tab-group="tabgrp-254">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-254-0" data-tab-group="tabgrp-254" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-254-1" data-tab-group="tabgrp-254">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-254-0" data-tab-group="tabgrp-254" data-tab-active="true">

```Swift
func setBool(_: Bool)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-254-1" data-tab-group="tabgrp-254">

```Objective-C
- (void)setBool:(BOOL)boolValue forKey:(nonnull NSString *)key
```

</div>
</div>


---


<div class="content-tabs code-tabs" data-tab-group="tabgrp-255">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-255-0" data-tab-group="tabgrp-255" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-255-1" data-tab-group="tabgrp-255">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-255-0" data-tab-group="tabgrp-255" data-tab-active="true">

```Swift
func setObject(_: AnyClass)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-255-1" data-tab-group="tabgrp-255">

```Objective-C
- (void)setObject:(nonnull id)object forKey:(nonnull NSString *)key
```

</div>
</div>


---
---

### Event
Main event abstract class for inheriting classes.
  

<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This is an abstract class and it is not meant to be instantiated directly. You should use concrete `Event` subclasses instead.

</div></div></div>

  
**Declared In:**  
Headers/SNREvent.h
  
**Related To:**  
[TrackerParams](/developers/mobile-sdk/class-reference/ios/events#trackerparams)  
[TrackerParamsBuilder](/developers/mobile-sdk/class-reference/ios/events#trackerparamsbuilder)  
  
**Inherits From:**  
[NSObject](https://developer.apple.com/documentation/objectivec/nsobject)
  
**Conforms To:**  
[NSCopying](https://developer.apple.com/documentation/foundation/nscopying)
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-256">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-256-0" data-tab-group="tabgrp-256" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-256-1" data-tab-group="tabgrp-256">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-256-0" data-tab-group="tabgrp-256" data-tab-active="true">

```Swift
class Event: NSObject
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-256-1" data-tab-group="tabgrp-256">

```Objective-C
@interface SNREvent : NSObject
```

</div>
</div>

  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-257">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-257-0" data-tab-group="tabgrp-257" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-257-1" data-tab-group="tabgrp-257">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-257-0" data-tab-group="tabgrp-257" data-tab-active="true">

```Swift
init(label: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-257-1" data-tab-group="tabgrp-257">

```Objective-C
- (instancetype)initWithLabel:(nonnull NSString *)label
```

</div>
</div>


---


<div class="content-tabs code-tabs" data-tab-group="tabgrp-258">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-258-0" data-tab-group="tabgrp-258" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-258-1" data-tab-group="tabgrp-258">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-258-0" data-tab-group="tabgrp-258" data-tab-active="true">

```Swift
init(label: String, params: TrackerParams)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-258-1" data-tab-group="tabgrp-258">

```Objective-C
- (instancetype)initWithLabel:(nonnull NSString *)label andParams:(nullable SNRTrackerParams *)params
```

</div>
</div>


---
---

### CustomEvent

<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

DO NOT send `transaction.charge` events as custom events.<br>
Transactions must be tracked with these endpoints:
- [`/v4/transactions`](https://hub.synerise.com/api-reference/data-management#tag/Events/operation/CreateATransaction) (single transaction)
- [`/v4/transactions/batch`](https://hub.synerise.com/api-reference/data-management#tag/Events/operation/BatchAddOrUpdateTransactions) (multiple transactions)

</div></div></div>

Represents a custom event.
  
**Declared In:**  
Headers/SNRCustomEvent.h
  
**Related To:**  
[TrackerParams](/developers/mobile-sdk/class-reference/ios/events#trackerparams)  
[TrackerParamsBuilder](/developers/mobile-sdk/class-reference/ios/events#trackerparamsbuilder)  

**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/ios/events#event)

**Conforms To:**  
[NSCopying](https://developer.apple.com/documentation/foundation/nscopying)

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-259">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-259-0" data-tab-group="tabgrp-259" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-259-1" data-tab-group="tabgrp-259">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-259-0" data-tab-group="tabgrp-259" data-tab-active="true">

```Swift
class CustomEvent: Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-259-1" data-tab-group="tabgrp-259">

```Objective-C
@interface SNRCustomEvent : SNREvent
```

</div>
</div>

  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-260">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-260-0" data-tab-group="tabgrp-260" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-260-1" data-tab-group="tabgrp-260">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-260-0" data-tab-group="tabgrp-260" data-tab-active="true">

```Swift
init(type: String, label: String, action: String, params: TrackerParams?)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-260-1" data-tab-group="tabgrp-260">

```Objective-C
- (instancetype)initWithType:(nonnull NSString *)type label:(nonnull NSString *)label action:(nonnull NSString *)action andParams:(nullable SNRTrackerParams *)params
```

</div>
</div>


<br>


<div class="content-tabs code-tabs" data-tab-group="tabgrp-261">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-261-0" data-tab-group="tabgrp-261" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-261-1" data-tab-group="tabgrp-261">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-261-0" data-tab-group="tabgrp-261" data-tab-active="true">

```Swift
init(label: String, action: String, params: TrackerParams?)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-261-1" data-tab-group="tabgrp-261">

```Objective-C
- (instancetype)initWithLabel:(nonnull NSString *)label action:(nonnull NSString *)action andParams:(nullable SNRTrackerParams *)params
```

</div>
</div>


<br>


<div class="content-tabs code-tabs" data-tab-group="tabgrp-262">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-262-0" data-tab-group="tabgrp-262" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-262-1" data-tab-group="tabgrp-262">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-262-0" data-tab-group="tabgrp-262" data-tab-active="true">

```Swift
init(label: String, action: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-262-1" data-tab-group="tabgrp-262">

```Objective-C
- (instancetype)initWithLabel:(nonnull NSString *)label action:(nonnull NSString *)action
```

</div>
</div>


---
---

### PushViewedEvent
Represents a 'client viewed push' event.
  
This event is used for push message interaction tracking.
  
**Declared In:**  
Headers/SNRPushViewedEvent.h  
  
**Related To:**  
[TrackerParams](/developers/mobile-sdk/class-reference/ios/events#trackerparams)  
[TrackerParamsBuilder](/developers/mobile-sdk/class-reference/ios/events#trackerparamsbuilder)  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/ios/events#event)
  
**Conforms To:**  
[NSCopying](https://developer.apple.com/documentation/foundation/nscopying)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-263">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-263-0" data-tab-group="tabgrp-263" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-263-1" data-tab-group="tabgrp-263">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-263-0" data-tab-group="tabgrp-263" data-tab-active="true">

```Swift
class PushViewedEvent: Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-263-1" data-tab-group="tabgrp-263">

```Objective-C
@interface SNRPushViewedEvent : SNREvent
```

</div>
</div>


---
---

### PushClickedEvent
Represents a 'client clicked push' event.
  
This event is used for push message interaction tracking.
  
**Declared In:**  
Headers/SNRPushClickedEvent.h  
  
**Related To:**  
[TrackerParams](/developers/mobile-sdk/class-reference/ios/events#trackerparams)  
[TrackerParamsBuilder](/developers/mobile-sdk/class-reference/ios/events#trackerparamsbuilder)  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/ios/events#event)
  
**Conforms To:**  
[NSCopying](https://developer.apple.com/documentation/foundation/nscopying)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-264">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-264-0" data-tab-group="tabgrp-264" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-264-1" data-tab-group="tabgrp-264">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-264-0" data-tab-group="tabgrp-264" data-tab-active="true">

```Swift
class PushClickedEvent: Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-264-1" data-tab-group="tabgrp-264">

```Objective-C
@interface SNRPushClickedEvent : SNREvent
```

</div>
</div>


---
---

### PushCancelledEvent
Represents a 'client viewed push' event.
  
This event is used for push message interaction tracking.
  
**Declared In:**  
Headers/SNRCancelledPushEvent.h  
  
**Related To:**  
[TrackerParams](/developers/mobile-sdk/class-reference/ios/events#trackerparams)  
[TrackerParamsBuilder](/developers/mobile-sdk/class-reference/ios/events#trackerparamsbuilder)  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/ios/events#event)
  
**Conforms To:**  
[NSCopying](https://developer.apple.com/documentation/foundation/nscopying)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-265">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-265-0" data-tab-group="tabgrp-265" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-265-1" data-tab-group="tabgrp-265">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-265-0" data-tab-group="tabgrp-265" data-tab-active="true">

```Swift
class CancelledPushEvent: Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-265-1" data-tab-group="tabgrp-265">

```Objective-C
@interface SNRCancelledPushEvent : SNREvent
```

</div>
</div>


---
---

### CartEvent
Main cart action abstract class for inheriting classes.
  

<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This is an abstract class and it is not meant to be instantiated directly. You should use concrete `CartEvent` subclasses instead.

</div></div></div>

  
**Declared In:**  
Headers/SNRCartEvent.h  
  
**Related To:**  
[TrackerParams](/developers/mobile-sdk/class-reference/ios/events#trackerparams)   
[TrackerParamsBuilder](/developers/mobile-sdk/class-reference/ios/events#trackerparamsbuilder)   
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/ios/events#event)  
  
**Conforms To:**  
[NSCopying](https://developer.apple.com/documentation/foundation/nscopying)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-266">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-266-0" data-tab-group="tabgrp-266" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-266-1" data-tab-group="tabgrp-266">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-266-0" data-tab-group="tabgrp-266" data-tab-active="true">

```Swift
class CartEvent: Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-266-1" data-tab-group="tabgrp-266">

```Objective-C
@interface SNRCartEvent : SNREvent
```

</div>
</div>

  
**Initializers:**
  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-267">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-267-0" data-tab-group="tabgrp-267" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-267-1" data-tab-group="tabgrp-267">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-267-0" data-tab-group="tabgrp-267" data-tab-active="true">

```Swift
init(label: String, sku String, finalPrice: UnitPrice, quantity: Int, params: TrackerParams?)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-267-1" data-tab-group="tabgrp-267">

```Objective-C
- (instancetype)initWithLabel:(nonnull NSString *)label sku:(nonnull NSString *)sku finalPrice:(nonnull SNRUnitPrice *)unitPrice quantity:(NSInteger)quantity andParams:(nullable SNRTrackerParams *)params
```

</div>
</div>


---


<div class="content-tabs code-tabs" data-tab-group="tabgrp-268">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-268-0" data-tab-group="tabgrp-268" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-268-1" data-tab-group="tabgrp-268">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-268-0" data-tab-group="tabgrp-268" data-tab-active="true">

```Swift
init(label: String, sku: String, finalPrice: UnitPrice, quantity: Int)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-268-1" data-tab-group="tabgrp-268">

```Objective-C
- (instancetype)initWithLabel:(nonnull NSString *)label sku:(nonnull NSString *)sku finalPrice:(nonnull SNRUnitPrice *)unitPrice quantity:(NSInteger)quantity
```

</div>
</div>



**Methods:** 

This method sets a value for the `name` parameter.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-269">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-269-0" data-tab-group="tabgrp-269" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-269-1" data-tab-group="tabgrp-269">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-269-0" data-tab-group="tabgrp-269" data-tab-active="true">

```Swift
func setName(_: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-269-1" data-tab-group="tabgrp-269">

```Objective-C
- (void)setName:(nonnull NSString *)name
```

</div>
</div>


---

This method sets a value for the `category` parameter.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-270">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-270-0" data-tab-group="tabgrp-270" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-270-1" data-tab-group="tabgrp-270">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-270-0" data-tab-group="tabgrp-270" data-tab-active="true">

```Swift
func setCategory(_: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-270-1" data-tab-group="tabgrp-270">

```Objective-C
- (void)setCategory:(nonnull NSString *)category
```

</div>
</div>


---

This method sets values for the `categories` parameter.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-271">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-271-0" data-tab-group="tabgrp-271" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-271-1" data-tab-group="tabgrp-271">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-271-0" data-tab-group="tabgrp-271" data-tab-active="true">

```Swift
func setCategories(_: [String])
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-271-1" data-tab-group="tabgrp-271">

```Objective-C
- (void)setCategories:(nonnull NSArray<NSString *> *)categories
```

</div>
</div>


---

This method sets a value for the `offline` parameter.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-272">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-272-0" data-tab-group="tabgrp-272" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-272-1" data-tab-group="tabgrp-272">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-272-0" data-tab-group="tabgrp-272" data-tab-active="true">

```Swift
func setOffline(_: Bool)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-272-1" data-tab-group="tabgrp-272">

```Objective-C
- (void)setOffline:(BOOL)isOffline
```

</div>
</div>


---

This method sets the value of the `regularPrice` parameter.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-273">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-273-0" data-tab-group="tabgrp-273" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-273-1" data-tab-group="tabgrp-273">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-273-0" data-tab-group="tabgrp-273" data-tab-active="true">

```Swift
func setRegularPrice(_: UnitPrice)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-273-1" data-tab-group="tabgrp-273">

```Objective-C
- (void)setRegularPrice:(nonnull SNRUnitPrice *)price
```

</div>
</div>


---

This method sets the value of the `discountedPrice` parameter.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-274">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-274-0" data-tab-group="tabgrp-274" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-274-1" data-tab-group="tabgrp-274">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-274-0" data-tab-group="tabgrp-274" data-tab-active="true">

```Swift
func setDiscountedPrice(_: UnitPrice)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-274-1" data-tab-group="tabgrp-274">

```Objective-C
- (void)setDiscountedPrice:(nonnull SNRUnitPrice *)price
```

</div>
</div>


---

This method sets the value of the `url` parameter.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-275">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-275-0" data-tab-group="tabgrp-275" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-275-1" data-tab-group="tabgrp-275">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-275-0" data-tab-group="tabgrp-275" data-tab-active="true">

```Swift
func setURL(_: URL)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-275-1" data-tab-group="tabgrp-275">

```Objective-C
- (void)setURL:(nonnull NSURL *)url
```

</div>
</div>


---

This method sets the value of the `producer` parameter (producer can signify a brand of the item).

<div class="content-tabs code-tabs" data-tab-group="tabgrp-276">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-276-0" data-tab-group="tabgrp-276" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-276-1" data-tab-group="tabgrp-276">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-276-0" data-tab-group="tabgrp-276" data-tab-active="true">

```Swift
func setProducer(_: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-276-1" data-tab-group="tabgrp-276">

```Objective-C
- (void)setProducer:(nonnull NSString *)producer
```

</div>
</div>


---
---

### UnitPrice
**Declared In:**  
Headers/SNRUnitPrice.h  
  
**Inherits From:**  
[NSObject](https://developer.apple.com/documentation/objectivec/nsobject)
  
**Conforms To:**  
[NSCopying](https://developer.apple.com/documentation/foundation/nscopying)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-277">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-277-0" data-tab-group="tabgrp-277" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-277-1" data-tab-group="tabgrp-277">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-277-0" data-tab-group="tabgrp-277" data-tab-active="true">

```Swift
class UnitPrice: NSObject
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-277-1" data-tab-group="tabgrp-277">

```Objective-C
@interface SNRUnitPrice : NSObject
```

</div>
</div>

  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-278">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-278-0" data-tab-group="tabgrp-278" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-278-1" data-tab-group="tabgrp-278">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-278-0" data-tab-group="tabgrp-278" data-tab-active="true">

```Swift
init(amount: Float)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-278-1" data-tab-group="tabgrp-278">

```Objective-C
- (instancetype)initWithAmount:(float)amount
```

</div>
</div>


---


<div class="content-tabs code-tabs" data-tab-group="tabgrp-279">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-279-0" data-tab-group="tabgrp-279" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-279-1" data-tab-group="tabgrp-279">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-279-0" data-tab-group="tabgrp-279" data-tab-active="true">

```Swift
init(amount: Float, locale: NSLocale)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-279-1" data-tab-group="tabgrp-279">

```Objective-C
- (instancetype)initWithAmount:(float)amount locale:(nonnull NSLocale *)locale
```

</div>
</div>


---
---

### ProductAddedToCartEvent
Represents a 'client added product to cart' event.
  
**Declared In:**  
Headers/SNRProductAddedToCartEvent.h

**Related To:**  
[TrackerParams](/developers/mobile-sdk/class-reference/ios/events#trackerparams)  
[TrackerParamsBuilder](/developers/mobile-sdk/class-reference/ios/events#trackerparamsbuilder)  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/ios/events#event)
[CartEvent](/developers/mobile-sdk/class-reference/ios/events#cartevent)
  
**Conforms To:**  
[NSCopying](https://developer.apple.com/documentation/foundation/nscopying)
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-280">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-280-0" data-tab-group="tabgrp-280" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-280-1" data-tab-group="tabgrp-280">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-280-0" data-tab-group="tabgrp-280" data-tab-active="true">

```Swift
class ProductAddedToCartEvent: CartEvent
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-280-1" data-tab-group="tabgrp-280">

```Objective-C
@interface SNRProductAddedToCartEvent : SNRCartEvent
```

</div>
</div>


---
---

### ProductRemovedFromCartEvent
Represents a 'client removed product from cart' event.
  
**Declared In:**  
Headers/SNRProductRemovedFromCartEvent.h
  
**Related To:**  
[TrackerParams](/developers/mobile-sdk/class-reference/ios/events#trackerparams)  
[TrackerParamsBuilder](/developers/mobile-sdk/class-reference/ios/events#trackerparamsbuilder)  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/ios/events#event)
[CartEvent](/developers/mobile-sdk/class-reference/ios/events#cartevent)
  
**Conforms To:**  
[NSCopying](https://developer.apple.com/documentation/foundation/nscopying)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-281">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-281-0" data-tab-group="tabgrp-281" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-281-1" data-tab-group="tabgrp-281">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-281-0" data-tab-group="tabgrp-281" data-tab-active="true">

```Swift
class ProductRemovedFromCartEvent: CartEvent
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-281-1" data-tab-group="tabgrp-281">

```Objective-C
@interface SNRProductRemovedFromCartEvent : SNRCartEvent
```

</div>
</div>


---
---

### ProductViewedEvent
Represents a 'client viewed product' event.
  
**Declared In:**  
Headers/SNRProductViewedEvent.h  
  
**Related To:**  
[TrackerParams](/developers/mobile-sdk/class-reference/ios/events#trackerparams)  
[TrackerParamsBuilder](/developers/mobile-sdk/class-reference/ios/events#trackerparamsbuilder)  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/ios/events#event)
  
**Conforms To:**  
[NSCopying](https://developer.apple.com/documentation/foundation/nscopying)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-282">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-282-0" data-tab-group="tabgrp-282" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-282-1" data-tab-group="tabgrp-282">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-282-0" data-tab-group="tabgrp-282" data-tab-active="true">

```Swift
class ProductViewedEvent: Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-282-1" data-tab-group="tabgrp-282">

```Objective-C
@interface SNRProductViewedEvent : SNREvent
```

</div>
</div>

  
**Initializers:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-283">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-283-0" data-tab-group="tabgrp-283" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-283-1" data-tab-group="tabgrp-283">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-283-0" data-tab-group="tabgrp-283" data-tab-active="true">

```Swift
init(label: String, productName: String, productId: String, params: TrackerParams?)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-283-1" data-tab-group="tabgrp-283">

```Objective-C
- (instancetype)initWithLabel:(nonnull NSString *)label productName:(nonnull NSString *)productName productId:(nonnull NSString *)productId andParams:(nullable SNRTrackerParams *)params
```

</div>
</div>


**Methods:**
Sets if a product is recommended or not.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-284">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-284-0" data-tab-group="tabgrp-284" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-284-1" data-tab-group="tabgrp-284">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-284-0" data-tab-group="tabgrp-284" data-tab-active="true">

```Swift
func setIsRecommended(_: Bool)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-284-1" data-tab-group="tabgrp-284">

```Objective-C
- (void)setIsRecommended:(BOOL)isRecommended
```

</div>
</div>


---

This method sets a value for the `category` parameter.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-285">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-285-0" data-tab-group="tabgrp-285" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-285-1" data-tab-group="tabgrp-285">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-285-0" data-tab-group="tabgrp-285" data-tab-active="true">

```Swift
func setCategory(_: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-285-1" data-tab-group="tabgrp-285">

```Objective-C
- (void)setCategory:(NSString *)category
```

</div>
</div>


---

This method sets the value of the `url` parameter.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-286">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-286-0" data-tab-group="tabgrp-286" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-286-1" data-tab-group="tabgrp-286">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-286-0" data-tab-group="tabgrp-286" data-tab-active="true">

```Swift
func setURL(_: URL)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-286-1" data-tab-group="tabgrp-286">

```Objective-C
- (void)setURL:(NSURL *)url
```

</div>
</div>


---
---

### ProductAddedToFavoritesEvent
Represents a 'client added product to favorites' event.
  
**Declared In:**  
Headers/SNRProductAddedToFavoritesEvent.h
  
**Related To:**  
[TrackerParams](/developers/mobile-sdk/class-reference/ios/events#trackerparams)  
[TrackerParamsBuilder](/developers/mobile-sdk/class-reference/ios/events#trackerparamsbuilder)  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/ios/events#event)
  
**Conforms To:**  
[NSCopying](https://developer.apple.com/documentation/foundation/nscopying)
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-287">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-287-0" data-tab-group="tabgrp-287" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-287-1" data-tab-group="tabgrp-287">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-287-0" data-tab-group="tabgrp-287" data-tab-active="true">

```Swift
class ProductAddedToFavoritesEvent: Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-287-1" data-tab-group="tabgrp-287">

```Objective-C
@interface SNRProductAddedToFavoritesEvent : SNREvent
```

</div>
</div>


---
---

### LoggedInEvent
Represents a 'client logged in' event.
  
**Declared In:**  
Headers/SNRLoggedInEvent.h
  
**Related To:**  
[TrackerParams](/developers/mobile-sdk/class-reference/ios/events/#trackerparams)  
[TrackerParamsBuilder](/developers/mobile-sdk/class-reference/ios/events/#trackerparamsbuilder)  
  
**Inherits From:**
[Event](/developers/mobile-sdk/class-reference/ios/events/#event)
  
**Conforms To:**
[NSCopying](https://developer.apple.com/documentation/foundation/nscopying)
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-288">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-288-0" data-tab-group="tabgrp-288" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-288-1" data-tab-group="tabgrp-288">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-288-0" data-tab-group="tabgrp-288" data-tab-active="true">

```Swift
class LoggedInEvent: Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-288-1" data-tab-group="tabgrp-288">

```Objective-C
@interface SNRLoggedInEvent : SNREvent
```

</div>
</div>


---
---

### LoggedOutEvent
Represents a 'client logged out' event.
  
**Declared In:**  
Headers/SNRLoggedOutEvent.h
  
**Related To:**  
[TrackerParams](/developers/mobile-sdk/class-reference/ios/events#trackerparams)  
[TrackerParamsBuilder](/developers/mobile-sdk/class-reference/ios/events#trackerparamsbuilder)  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/ios/events#event)
  
**Conforms To:**  
[NSCopying](https://developer.apple.com/documentation/foundation/nscopying)
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-289">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-289-0" data-tab-group="tabgrp-289" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-289-1" data-tab-group="tabgrp-289">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-289-0" data-tab-group="tabgrp-289" data-tab-active="true">

```Swift
class LoggedOutEvent: Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-289-1" data-tab-group="tabgrp-289">

```Objective-C
@interface SNRLoggedOutEvent : SNREvent
```

</div>
</div>


---
---

### RegisteredEvent
Represents a 'client registered' event.
  
**Declared In:**  
Headers/SNRCancelledPushEvent.h  
  
**Related To:**  
[TrackerParams](/developers/mobile-sdk/class-reference/ios/events#trackerparams)  
[TrackerParamsBuilder](/developers/mobile-sdk/class-reference/ios/events#trackerparamsbuilder)  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/ios/events#event)
  
**Conforms To:**  
[NSCopying](https://developer.apple.com/documentation/foundation/nscopying)
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-290">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-290-0" data-tab-group="tabgrp-290" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-290-1" data-tab-group="tabgrp-290">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-290-0" data-tab-group="tabgrp-290" data-tab-active="true">

```Swift
class RegisteredEvent: Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-290-1" data-tab-group="tabgrp-290">

```Objective-C
@interface SNRRegisteredEvent : SNREvent
```

</div>
</div>


---
---

### RecommendationEvent
Main recommendation abstract class for inheriting classes.
  

<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This is an abstract class and it is not meant to be instantiated directly. You should use concrete `RecommendationEvent` subclasses instead.

</div></div></div>

  
**Declared In:**  
Headers/SNRRecommendationEvent.h  
  
**Related To:**  
[TrackerParams](/developers/mobile-sdk/class-reference/ios/events#trackerparams)   
[TrackerParamsBuilder](/developers/mobile-sdk/class-reference/ios/events#trackerparamsbuilder)   
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/ios/events#event)  
  
**Conforms To:**  
[NSCopying](https://developer.apple.com/documentation/foundation/nscopying)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-291">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-291-0" data-tab-group="tabgrp-291" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-291-1" data-tab-group="tabgrp-291">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-291-0" data-tab-group="tabgrp-291" data-tab-active="true">

```Swift
class RecommendationEvent: Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-291-1" data-tab-group="tabgrp-291">

```Objective-C
@interface SNRRecommendationEvent : SNREvent
```

</div>
</div>


---
---

### RecommendationViewEvent
Represents a 'client viewed a recommendation' event.
  
**Declared In:**  
Headers/SNRRecommendationViewEvent.h  
  
**Related To:**  
[TrackerParams](/developers/mobile-sdk/class-reference/ios/events#trackerparams)  
[TrackerParamsBuilder](/developers/mobile-sdk/class-reference/ios/events#trackerparamsbuilder)  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/ios/events#event)
[RecommendationEvent](/developers/mobile-sdk/class-reference/ios/events#recommendationevent)
  
**Conforms To:**  
[NSCopying](https://developer.apple.com/documentation/foundation/nscopying)
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-292">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-292-0" data-tab-group="tabgrp-292" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-292-1" data-tab-group="tabgrp-292">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-292-0" data-tab-group="tabgrp-292" data-tab-active="true">

```Swift
class RecommendationViewEvent: RecommendationEvent
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-292-1" data-tab-group="tabgrp-292">

```Objective-C
@interface SNRRecommendationViewEvent : SNRRecommendationEvent
```

</div>
</div>

  
**Initializers:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-293">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-293-0" data-tab-group="tabgrp-293" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-293-1" data-tab-group="tabgrp-293">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-293-0" data-tab-group="tabgrp-293" data-tab-active="true">

```Swift
init(label: String, campaignID: String, campaignHash: String, correlationId: String, params: TrackerParams?)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-293-1" data-tab-group="tabgrp-293">

```Objective-C
- (instancetype)initWithLabel:(NSString *)label campaignID:(NSString *)campaignID campaignHash:(NSString *)campaignHash correlationId:(NSString *)correlationId andParams:(nullable SNRTrackerParams *)params
```

</div>
</div>

  
---
  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-294">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-294-0" data-tab-group="tabgrp-294" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-294-1" data-tab-group="tabgrp-294">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-294-0" data-tab-group="tabgrp-294" data-tab-active="true">

```Swift
init(label: String, items: [String], campaignID: String, campaignHash: String, correlationId: String, params: TrackerParams?)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-294-1" data-tab-group="tabgrp-294">

```Objective-C
- (instancetype)initWithLabel:(NSString *)label items:(nullable NSArray<NSString *> *)items campaignID:(NSString *)campaignID campaignHash:(NSString *)campaignHash correlationId:(NSString *)correlationId andParams:(nullable SNRTrackerParams *)params
```

</div>
</div>


**Methods:**  
This method sets a value for the `items` parameter.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-295">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-295-0" data-tab-group="tabgrp-295" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-295-1" data-tab-group="tabgrp-295">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-295-0" data-tab-group="tabgrp-295" data-tab-active="true">

```Swift
func setItems(_ items: [String])
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-295-1" data-tab-group="tabgrp-295">

```Objective-C
- (void)setItems:(NSArray<NSString *> *)items
```

</div>
</div>


---
---

### RecommendationSeenEvent
Represents a 'client saw a recommendation' event.
  
**Declared In:**  
Headers/SNRRecommendationSeenEvent.h  
  
**Related To:**  
[TrackerParams](/developers/mobile-sdk/class-reference/ios/events#trackerparams)  
[TrackerParamsBuilder](/developers/mobile-sdk/class-reference/ios/events#trackerparamsbuilder)  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/ios/events#event)
[RecommendationEvent](/developers/mobile-sdk/class-reference/ios/events#recommendationevent)
  
**Conforms To:**  
[NSCopying](https://developer.apple.com/documentation/foundation/nscopying)
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-296">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-296-0" data-tab-group="tabgrp-296" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-296-1" data-tab-group="tabgrp-296">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-296-0" data-tab-group="tabgrp-296" data-tab-active="true">

```Swift
class RecommendationSeenEvent: RecommendationEvent
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-296-1" data-tab-group="tabgrp-296">

```Objective-C
@interface SNRRecommendationSeenEvent : SNRRecommendationEvent
```

</div>
</div>

  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-297">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-297-0" data-tab-group="tabgrp-297" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-297-1" data-tab-group="tabgrp-297">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-297-0" data-tab-group="tabgrp-297" data-tab-active="true">

```Swift
init(label: String, productName: String, productId: String, campaignID: String, campaignHash: String, params: TrackerParams?)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-297-1" data-tab-group="tabgrp-297">

```Objective-C
- (instancetype)initWithLabel:(nonnull NSString *)label productName:(nonnull NSString *)productName productId:(nonnull NSString *)productId campaignID:(nonnull NSString *)campaignID campaignHash:(nonnull NSString *)campaignHash andParams:(nullable SNRTrackerParams *)params
```

</div>
</div>



**Methods:** 
Set a product's category.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-298">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-298-0" data-tab-group="tabgrp-298" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-298-1" data-tab-group="tabgrp-298">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-298-0" data-tab-group="tabgrp-298" data-tab-active="true">

```Swift
func setCategory(_: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-298-1" data-tab-group="tabgrp-298">

```Objective-C
- (void)setCategory:(nonnull NSString *)category
```

</div>
</div>


---

Set a product's URL.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-299">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-299-0" data-tab-group="tabgrp-299" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-299-1" data-tab-group="tabgrp-299">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-299-0" data-tab-group="tabgrp-299" data-tab-active="true">

```Swift
func setURL(_: URL)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-299-1" data-tab-group="tabgrp-299">

```Objective-C
- (void)setURL:(nonnull NSURL *)url
```

</div>
</div>


---
---

### RecommendationClickEvent
Represents a 'client clicked a recommendation' event.
  
**Declared In:**  
Headers/SNRRecommendationSeenEvent.h  
  
**Related To:**  
[TrackerParams](/developers/mobile-sdk/class-reference/ios/events#trackerparams)  
[TrackerParamsBuilder](/developers/mobile-sdk/class-reference/ios/events#trackerparamsbuilder)  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/ios/events#event)  
[RecommendationEvent](/developers/mobile-sdk/class-reference/ios/events#recommendationevent)  
  
**Conforms To:**  
[NSCopying](https://developer.apple.com/documentation/foundation/nscopying)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-300">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-300-0" data-tab-group="tabgrp-300" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-300-1" data-tab-group="tabgrp-300">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-300-0" data-tab-group="tabgrp-300" data-tab-active="true">

```Swift
class RecommendationClickEvent: RecommendationEvent
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-300-1" data-tab-group="tabgrp-300">

```Objective-C
@interface SNRRecommendationClickEvent : SNRRecommendationEvent
```

</div>
</div>

  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-301">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-301-0" data-tab-group="tabgrp-301" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-301-1" data-tab-group="tabgrp-301">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-301-0" data-tab-group="tabgrp-301" data-tab-active="true">

```Swift
init(label: String, productName: String, productId: String, campaignID: String, campaignHash: String, params: TrackerParams?)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-301-1" data-tab-group="tabgrp-301">

```Objective-C
- (instancetype)initWithLabel:(nonnull NSString *)label productName:(nonnull NSString *)productName productId:(nonnull NSString *)productId campaignID:(nonnull NSString *)campaignID campaignHash:(nonnull NSString *)campaignHash andParams:(nullable SNRTrackerParams *)params
```

</div>
</div>



**Methods:** 
Set a product's category.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-302">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-302-0" data-tab-group="tabgrp-302" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-302-1" data-tab-group="tabgrp-302">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-302-0" data-tab-group="tabgrp-302" data-tab-active="true">

```Swift
func setCategory(_: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-302-1" data-tab-group="tabgrp-302">

```Objective-C
- (void)setCategory:(nonnull NSString *)category
```

</div>
</div>


---

Set a product's URL.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-303">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-303-0" data-tab-group="tabgrp-303" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-303-1" data-tab-group="tabgrp-303">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-303-0" data-tab-group="tabgrp-303" data-tab-active="true">

```Swift
func setURL(_: URL)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-303-1" data-tab-group="tabgrp-303">

```Objective-C
- (void)setURL:(nonnull NSURL *)url
```

</div>
</div>


---
---

### VisitedScreenEvent
Represents a 'client visited screen' event.
  
This can be used for mobile screen usage tracking.
  
**Declared In:**  
Headers/SNRVisitedScreenEvent.h  
  
**Related To:**  
[TrackerParams](/developers/mobile-sdk/class-reference/ios/events#trackerparams)  
[TrackerParamsBuilder](/developers/mobile-sdk/class-reference/ios/events#trackerparamsbuilder)  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/ios/events#event)
  
**Conforms To:**  
[NSCopying](https://developer.apple.com/documentation/foundation/nscopying)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-304">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-304-0" data-tab-group="tabgrp-304" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-304-1" data-tab-group="tabgrp-304">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-304-0" data-tab-group="tabgrp-304" data-tab-active="true">

```Swift
class VisitedScreenEvent: Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-304-1" data-tab-group="tabgrp-304">

```Objective-C
@interface SNRVisitedScreenEvent : SNREvent
```

</div>
</div>

  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-305">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-305-0" data-tab-group="tabgrp-305" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-305-1" data-tab-group="tabgrp-305">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-305-0" data-tab-group="tabgrp-305" data-tab-active="true">

```Swift
init(label: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-305-1" data-tab-group="tabgrp-305">

```Objective-C
- (instancetype)initWithLabel:(nonnull NSString *)label
```

</div>
</div>


---


<div class="content-tabs code-tabs" data-tab-group="tabgrp-306">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-306-0" data-tab-group="tabgrp-306" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-306-1" data-tab-group="tabgrp-306">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-306-0" data-tab-group="tabgrp-306" data-tab-active="true">

```Swift
init(label: String, params: TrackerParams?)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-306-1" data-tab-group="tabgrp-306">

```Objective-C
- (instancetype)initWithLabel:(nonnull NSString *)label andParams:(nullable SNRTrackerParams *)params
```

</div>
</div>


---
---

### HitTimerEvent
Represents a 'client hit timer' event.
  
This could be used for profiling or activity time monitoring - you can send a `HitTimerEvent` when a client starts doing something and send it once again when they finish, but this time with the different time signature. Then you can use our analytics engine to measure, for example, average activity time.
  
**Declared In:**  
Headers/SNRHitTimerEvent.h
  
**Related To:**  
[TrackerParams](/developers/mobile-sdk/class-reference/ios/events#trackerparams)  
[TrackerParamsBuilder](/developers/mobile-sdk/class-reference/ios/events#trackerparamsbuilder)  
  
**Inherits From:**
[Event](/developers/mobile-sdk/class-reference/ios/events#event)
  
**Conforms To:**
[NSCopying](https://developer.apple.com/documentation/foundation/nscopying)
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-307">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-307-0" data-tab-group="tabgrp-307" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-307-1" data-tab-group="tabgrp-307">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-307-0" data-tab-group="tabgrp-307" data-tab-active="true">

```Swift
class HitTimerEvent: Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-307-1" data-tab-group="tabgrp-307">

```Objective-C
@interface SNRHitTimerEvent : SNREvent
```

</div>
</div>

  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-308">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-308-0" data-tab-group="tabgrp-308" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-308-1" data-tab-group="tabgrp-308">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-308-0" data-tab-group="tabgrp-308" data-tab-active="true">

```Swift
init(label: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-308-1" data-tab-group="tabgrp-308">

```Objective-C
- (instancetype)initWithLabel:(nonnull NSString *)label
```

</div>
</div>


---


<div class="content-tabs code-tabs" data-tab-group="tabgrp-309">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-309-0" data-tab-group="tabgrp-309" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-309-1" data-tab-group="tabgrp-309">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-309-0" data-tab-group="tabgrp-309" data-tab-active="true">

```Swift
init(label: String, params: TrackerParams?)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-309-1" data-tab-group="tabgrp-309">

```Objective-C
- (instancetype)initWithLabel:(nonnull NSString *)label andParams:(nullable SNRTrackerParams *)params
```

</div>
</div>


---
---

### SearchedEvent
Represents a 'client searched' event.
  
**Declared In:**  
Headers/SNRSearchedEvent.h  
  
**Related To:**  
[TrackerParams](/developers/mobile-sdk/class-reference/ios/events#trackerparams)  
[TrackerParamsBuilder](/developers/mobile-sdk/class-reference/ios/events#trackerparamsbuilder)  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/ios/events#event)  
  
**Conforms To:**  
[NSCopying](https://developer.apple.com/documentation/foundation/nscopying)
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-310">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-310-0" data-tab-group="tabgrp-310" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-310-1" data-tab-group="tabgrp-310">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-310-0" data-tab-group="tabgrp-310" data-tab-active="true">

```Swift
class SearchedEvent: Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-310-1" data-tab-group="tabgrp-310">

```Objective-C
@interface SNRSearchedEvent : SNREvent
```

</div>
</div>

  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-311">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-311-0" data-tab-group="tabgrp-311" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-311-1" data-tab-group="tabgrp-311">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-311-0" data-tab-group="tabgrp-311" data-tab-active="true">

```Swift
init(label: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-311-1" data-tab-group="tabgrp-311">

```Objective-C
- (instancetype)initWithLabel:(nonnull NSString *)label
```

</div>
</div>


---


<div class="content-tabs code-tabs" data-tab-group="tabgrp-312">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-312-0" data-tab-group="tabgrp-312" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-312-1" data-tab-group="tabgrp-312">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-312-0" data-tab-group="tabgrp-312" data-tab-active="true">

```Swift
init(label: String, params: TrackerParams?)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-312-1" data-tab-group="tabgrp-312">

```Objective-C
- (instancetype)initWithLabel:(nonnull NSString *)label andParams:(nullable SNRTrackerParams *)params
```

</div>
</div>


---
---

### SharedEvent
Represents a 'client shared' event.
  
**Declared In:**  
Headers/SNRSharedEvent.h  
  
**Related To:**  
[TrackerParams](/developers/mobile-sdk/class-reference/ios/events#trackerparams)  
[TrackerParamsBuilder](/developers/mobile-sdk/class-reference/ios/events#trackerparamsbuilder)  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/ios/events#event)  
  
**Conforms To:**  
[NSCopying](https://developer.apple.com/documentation/foundation/nscopying)  
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-313">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-313-0" data-tab-group="tabgrp-313" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-313-1" data-tab-group="tabgrp-313">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-313-0" data-tab-group="tabgrp-313" data-tab-active="true">

```Swift
class SharedEvent: Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-313-1" data-tab-group="tabgrp-313">

```Objective-C
@interface SNRSharedEvent : SNREvent
```

</div>
</div>

  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-314">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-314-0" data-tab-group="tabgrp-314" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-314-1" data-tab-group="tabgrp-314">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-314-0" data-tab-group="tabgrp-314" data-tab-active="true">

```Swift
init(label: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-314-1" data-tab-group="tabgrp-314">

```Objective-C
- (instancetype)initWithLabel:(nonnull NSString *)label
```

</div>
</div>


---


<div class="content-tabs code-tabs" data-tab-group="tabgrp-315">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-315-0" data-tab-group="tabgrp-315" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-315-1" data-tab-group="tabgrp-315">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-315-0" data-tab-group="tabgrp-315" data-tab-active="true">

```Swift
init(label: String, params: TrackerParams?)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-315-1" data-tab-group="tabgrp-315">

```Objective-C
- (instancetype)initWithLabel:(nonnull NSString *)label andParams:(nullable SNRTrackerParams *)params
```

</div>
</div>


---
---

### AppearedInLocationEvent
Represents a 'client appeared in location' event.
  
**Declared In:**  
Headers/SNRAppearedInLocationEvent.h  
  
**Related To:**  
[CCLocation](https://developer.apple.com/documentation/corelocation/cllocation)  
[TrackerParams](/developers/mobile-sdk/class-reference/ios/events#trackerparams)  
[TrackerParamsBuilder](/developers/mobile-sdk/class-reference/ios/events#trackerparamsbuilder)  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/ios/events#event)  
  
**Conforms To:**  
[NSCopying](https://developer.apple.com/documentation/foundation/nscopying)  
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-316">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-316-0" data-tab-group="tabgrp-316" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-316-1" data-tab-group="tabgrp-316">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-316-0" data-tab-group="tabgrp-316" data-tab-active="true">

```Swift
class AppearedInLocationEvent: Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-316-1" data-tab-group="tabgrp-316">

```Objective-C
@interface SNRAppearedInLocationEvent : SNREvent
```

</div>
</div>

  
**Initializers:**


<div class="content-tabs code-tabs" data-tab-group="tabgrp-317">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-317-0" data-tab-group="tabgrp-317" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-317-1" data-tab-group="tabgrp-317">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-317-0" data-tab-group="tabgrp-317" data-tab-active="true">

```Swift
init(label: String, location: CCLocation)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-317-1" data-tab-group="tabgrp-317">

```Objective-C
- (instancetype)initWithLabel:(nonnull NSString *)label andLocation:(nonnull CLLocation *)location
```

</div>
</div>


---


<div class="content-tabs code-tabs" data-tab-group="tabgrp-318">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-318-0" data-tab-group="tabgrp-318" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-318-1" data-tab-group="tabgrp-318">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-318-0" data-tab-group="tabgrp-318" data-tab-active="true">

```Swift
init(label: String, location: CCLocation, params: TrackerParams?)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-318-1" data-tab-group="tabgrp-318">

```Objective-C
- (instancetype)initWithLabel:(nonnull NSString *)label andLocation:(nonnull CLLocation *)location andParams:(nullable SNRTrackerParams *)params
```

</div>
</div>


---
---

### CrashEvent
Represents an 'application crashed' event.
  
**Declared In:**  
Headers/SNRCrashEvent.h
  
**Related To:**  
[TrackerParams](/developers/mobile-sdk/class-reference/ios/events#trackerparams)  
[TrackerParamsBuilder](/developers/mobile-sdk/class-reference/ios/events#trackerparamsbuilder)  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/ios/events#event)

**Conforms To:**  
[NSCopying](https://developer.apple.com/documentation/foundation/nscopying)
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-319">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-319-0" data-tab-group="tabgrp-319" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-319-1" data-tab-group="tabgrp-319">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-319-0" data-tab-group="tabgrp-319" data-tab-active="true">

```Swift
class CrashEvent: Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-319-1" data-tab-group="tabgrp-319">

```Objective-C
@interface SNRCrashEvent : SNREvent
```

</div>
</div>

  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-320">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-320-0" data-tab-group="tabgrp-320" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-320-1" data-tab-group="tabgrp-320">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-320-0" data-tab-group="tabgrp-320" data-tab-active="true">

```Swift
init(label: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-320-1" data-tab-group="tabgrp-320">

```Objective-C
- (instancetype)initWithLabel:(nonnull NSString *)label
```

</div>
</div>


<br>


<div class="content-tabs code-tabs" data-tab-group="tabgrp-321">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-321-0" data-tab-group="tabgrp-321" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-321-1" data-tab-group="tabgrp-321">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-321-0" data-tab-group="tabgrp-321" data-tab-active="true">

```Swift
init(label: String, params: TrackerParams?)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-321-1" data-tab-group="tabgrp-321">

```Objective-C
- (instancetype)initWithLabel:(nonnull NSString *)label andParams:(nullable SNRTrackerParams *)params
```

</div>
</div>



**Methods:**

This method sets the exception's `name` parameter.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-322">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-322-0" data-tab-group="tabgrp-322" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-322-1" data-tab-group="tabgrp-322">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-322-0" data-tab-group="tabgrp-322" data-tab-active="true">

```Swift
func setExceptionName(_: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-322-1" data-tab-group="tabgrp-322">

```Objective-C
- (void)setExceptionName:(nonnull NSString *)exceptionName
```

</div>
</div>


---

This method sets the exception's `reason` parameter.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-323">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-323-0" data-tab-group="tabgrp-323" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-323-1" data-tab-group="tabgrp-323">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-323-0" data-tab-group="tabgrp-323" data-tab-active="true">

```Swift
func setExceptionReason(_: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-323-1" data-tab-group="tabgrp-323">

```Objective-C
- (void)setExceptionReason:(nonnull NSString *)exceptionReason
```

</div>
</div>


---

This method sets the exception's `stacktrace` parameter.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-324">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-324-0" data-tab-group="tabgrp-324" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-324-1" data-tab-group="tabgrp-324">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-324-0" data-tab-group="tabgrp-324" data-tab-active="true">

```Swift
func setExceptionStacktrace(_: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-324-1" data-tab-group="tabgrp-324">

```Objective-C
- (void)setExceptionStacktrace:(nonnull NSString *)exceptionStacktrace
```

</div>
</div>



# Silent push


## Overview
---
Silent push is a hidden notification that is delivered to the app. It does not cause any interaction with the user like a typical push. Silent notifications quietly deliver a certain set of data to the app so you may use it to notify that new content is available or inform about changes in the content. This kind of campaign does not affect your UI.

Within the silent push campaign, the SDK provides features such as remote sign out or acquiring location by using a silent push command. Read more in the [SDK Commands](#sdk-commands) section.

## Configuration
---
Silent push campaign is served by push notifications. See:
- [Configuring push notifications - Android](/developers/mobile-sdk/configuring-push-notifications/android)
- [Configuring push notifications - iOS](/developers/mobile-sdk/configuring-push-notifications/ios)
- [Configuring push notifications - React Native](/developers/mobile-sdk/configuring-push-notifications/react-native)
- [Configuring push notifications - Flutter](/developers/mobile-sdk/configuring-push-notifications/flutter)

Additionally, check possible available configuration options in the [Settings](/developers/mobile-sdk/settings#notifications).

## Checking custom notification payloads
---
The silent push campaign is designed to send notifications with your own payload and in this case should not be passed to the SDK. However, the campaign allows sending any data in payload including [SDK commands](#sdk-commands). Then, the notification must be handled correctly. You may use the samples below.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-32">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-32-0" data-tab-group="tabgrp-32" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-32-1" data-tab-group="tabgrp-32">Swift</button><button class="tab-button" data-tab-id="tabgrp-32-2" data-tab-group="tabgrp-32">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-32-0" data-tab-group="tabgrp-32" data-tab-active="true">

```Java
@Override
public void onMessageReceived(RemoteMessage remoteMessage) {
  super.onMessageReceived(remoteMessage);

  Map<String, String> data = remoteMessage.getData();
  if (Injector.isSynerisePush(data)) {
    if (Injector.isSilentCommand(data)) {
      try {
        SilentCommand silentCommand = Injector.getSilentCommand(data);
        <<your logic here>>
      } catch (ValidationException e) {
        e.printStackTrace(); 
      }
    }
  } else {
    <<notification is not from Synerise>>
  }
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-32-1" data-tab-group="tabgrp-32">

```Swift
extension NotificationService: UNUserNotificationCenterDelegate {
  func userNotificationCenter(_ center: UNUserNotificationCenter, willPresent notification: UNNotification, withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void) {
    let userInfo = notification.userInfo

    let isSyneriseNotification: Bool = Synerise.isSyneriseNotification(userInfo)
    if (isSyneriseNotification == true) {
      let isSyneriseSilentCommand: Bool = Synerise.isSyneriseSilentCommand(userInfo)
      if isSyneriseSilentCommand {
        <<your logic here>>
      }
    } else {
      <<notification is not from Synerise>>
    }

    completionHandler(.alert)
  }
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-32-2" data-tab-group="tabgrp-32">

```JavaScript
Synerise.onReady(function() {
  onNotification: function(payload, actionIdentifier) {
    let isSyneriseNotification = Synerise.Notifications.isSyneriseNotification(payload);
    if (isSyneriseNotification == true) {
      let isSyneriseSilentCommand = Synerise.Notifications.isSilentCommand(payload);
      if (isSyneriseSilentCommand == true) {
        <<your logic here>>
      } else {
        <<notification is not from Synerise>>
      }
    }
  }
});
```

</div>
</div>



## Payload 
---
<br/>

<div class="content-tabs" data-tab-group="tabgrp-33">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-33-0" data-tab-group="tabgrp-33" data-tab-active="true">Android</button><button class="tab-button" data-tab-id="tabgrp-33-1" data-tab-group="tabgrp-33">iOS</button></div>

<div class="tab-panel" data-tab-id="tabgrp-33-0" data-tab-group="tabgrp-33" data-tab-active="true">

<pre><code class="language-json">{
  "data": {
    &lt;&lt;campaign content&gt;&gt;
  }
}</code></pre>

</div>

<div class="tab-panel" data-tab-id="tabgrp-33-1" data-tab-group="tabgrp-33">

<pre><code class="language-json">{
  "aps": {
    "content-available": 1
  },
  &lt;&lt;campaign content&gt;&gt;
}</code></pre>

</div>
</div>


## SDK Commands
---

### SIGN_OUT {id=sdk-commands-sign-out}

<div class="content-tabs" data-tab-group="tabgrp-34">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-34-0" data-tab-group="tabgrp-34" data-tab-active="true">Android</button><button class="tab-button" data-tab-id="tabgrp-34-1" data-tab-group="tabgrp-34">iOS</button></div>

<div class="tab-panel" data-tab-id="tabgrp-34-0" data-tab-group="tabgrp-34" data-tab-active="true">

<pre><code class="language-json">{
  "data": {
    "issuer": "Synerise",
    "message-type": "dynamic-content",
    "content-type": "silent-sdk-command",
    "content": {
      "class_name": "com.synerise.sdk.injector.Injector",
      "method_name": "SIGN_OUT",
      "method_parameters": []
    }
  }
}</code></pre>

</div>

<div class="tab-panel" data-tab-id="tabgrp-34-1" data-tab-group="tabgrp-34">

<pre><code class="language-json">{
  "aps": {
    "content-available": 1
  },
  "issuer": "Synerise",
  "message-type": "dynamic-content",
  "content-type": "silent-sdk-command",
  "content": {
    "class_name": "com.synerise.sdk.injector.Injector",
    "method_name": "SIGN_OUT",
    "method_parameters": []
  }
}</code></pre>

</div>
</div>


### GET_LOCATION {id=sdk-commands-get-location}

<div class="content-tabs" data-tab-group="tabgrp-35">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-35-0" data-tab-group="tabgrp-35" data-tab-active="true">Android</button><button class="tab-button" data-tab-id="tabgrp-35-1" data-tab-group="tabgrp-35">iOS</button></div>

<div class="tab-panel" data-tab-id="tabgrp-35-0" data-tab-group="tabgrp-35" data-tab-active="true">

<pre><code class="language-json">{
  "data": {
    "issuer": "Synerise",
    "message-type": "dynamic-content",
    "content-type": "silent-sdk-command",
    "content": {
      "class_name": "com.synerise.sdk.injector.Injector",
      "method_name": "GET_LOCATION",
      "method_parameters": []
    }
  }
}</code></pre>

</div>

<div class="tab-panel" data-tab-id="tabgrp-35-1" data-tab-group="tabgrp-35">

<pre><code class="language-json">{
  "aps": {
    "content-available": 1
  },
  "issuer": "Synerise",
  "message-type": "dynamic-content",
  "content-type": "silent-sdk-command",
  "content": {
    "class_name": "com.synerise.sdk.injector.Injector",
    "method_name": "GET_LOCATION",
    "method_parameters": []
  }
}</code></pre>

</div>
</div>





# React Native

## React Native listeners

#### Initialization {id=initialization}
A listener to handle the SDK lifecycle events.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-720">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-720-0" data-tab-group="tabgrp-720" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-720-0" data-tab-group="tabgrp-720" data-tab-active="true">

```JavaScript
Synerise.onReady(function() {
  ...
});

Synerise.onError(function(error) {
  ...
})
```

</div>
</div>


---
---

#### NotificationsListener {id=notifications-listener}
A listener to handle actions from the notifications module.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-721">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-721-0" data-tab-group="tabgrp-721" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-721-0" data-tab-group="tabgrp-721" data-tab-active="true">

```JavaScript
Synerise.Notifications.setListener({
  // The following method is called when Synerise receives a registration token from the native part of application
  // It is optional function
    onRegistrationToken: function(token) {
      ...
  },
  // The following method is called when registration for Push Notifications is needed.
  // It is optional function
  onNotification: function(payload) {
    ...
  },
  // The following method is called when Synerise receives a notification's payload from the native part of application.
  // It is optional function
  onRegistrationRequired: function() {
    ...
  }
});
```

</div>
</div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

After invoking **onRegistrationRequired()** function, you must invoke the [Synerise.Notifications.registerForNotifications(registrationToken, mobileAgreement, onSuccess, onError)](/developers/mobile-sdk/method-reference/react-native/campaigns#register-for-push-notifications) method again.

</div></div></div>


---
---

#### ClientStateListener {id=client-state-listener}
A listener to handle customer's sign-in state changes.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-722">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-722-0" data-tab-group="tabgrp-722" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-722-0" data-tab-group="tabgrp-722" data-tab-active="true">

```JavaScript
Synerise.Client.setClientStateListener({
  // The following method is called when a customer signs in.
  // It is optional function
  onClientSignedIn: function() {
    ...
  },
  // The following method is called when a customer signs out
  // It is optional function
  onClientSignedOut: function(reason) {
    ...
  }
});
```

</div>
</div>


---
---

#### InjectorListener {id=injector-listener}
A listener to handle URL and deeplink actions from the injector module.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-723">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-723-0" data-tab-group="tabgrp-723" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-723-0" data-tab-group="tabgrp-723" data-tab-active="true">

```JavaScript
Synerise.Injector.setListener({
  // The following method is called when Synerise handles URL action from campaign activities
  // It is required function
  onOpenUrl: function(url) {
      ...
  },
  // The following method is called when Synerise handles deep link action from campaign activities
  // It is required function
  onDeepLink: function(deepLink) {
    ...
  }
});
```

</div>
</div>


---
---

#### InjectorInAppMessageListener {id=injector-in-app-message-listener}
A listener to handle the states of [in-app messages](/developers/mobile-sdk/campaigns/in-app-message).


<div class="content-tabs code-tabs" data-tab-group="tabgrp-724">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-724-0" data-tab-group="tabgrp-724" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-724-0" data-tab-group="tabgrp-724" data-tab-active="true">

```JavaScript
Synerise.Injector.setInAppMessageListener({
  shouldPresent: function(data) {
    return true;
  },
  // The following method is called after an in-app message appears
  onPresent: function (data) {
    ...
  },
  // The following method is called after an in-app message disappears
  onHide: function(data) {
    ...
  },
  // This method is called when a individual context for an in-app message is needed
  contextIsNeeded: function(data) {
    return {}
  },
  // This method is called when the SRInApp.openUrl(url) method is used in an in-app message.
  onOpenUrl: function (data, url) {
      ...
  },
  // This method is called when the SRInApp.openDeeplink(url) method is used in an in-app message.
  onDeepLink: function (data, deepLink) {
    ...
  },
  // This method is called when the
  // SRInApp.handleCustomAction(name, params) method is used in an in-app message.
  onCustomAction: function(data, name, parameters) {

  }
})
```

</div>
</div>


---
---

### InjectorWalkthroughListener {id=injector-walkthrough-listener}


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**InjectorWalkthroughListener** was removed in SDK version 1.0.0..

</div></div></div>


---
---

### InjectorBannerListener {id=injector-banner-listener}


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**InjectorBannerListener** was removed in SDK version 1.0.0..

</div></div></div>



# Settings


This article describes options that allow you to change some SDK behaviors.
It contains all settings you can configure to change some SDK behaviors. The settings are divided into groups:

- [General](/developers/mobile-sdk/settings#general) - This group contains options related to the general functioning of mobile SDK.
- [Notifications](/developers/mobile-sdk/settings#notifications) - This group contains options related to push notifications.
- [In-app messaging](/developers/mobile-sdk/settings#in-app-messaging) - This group contains options related to the [in-app messages](/docs/campaign/in-app-messages) feature.
- [Tracker](/developers/mobile-sdk/settings#tracker) - This group contains options related to tracking the customer activities in a mobile application.
- [Injector](/developers/mobile-sdk/settings#injector) - This group contains options related to displaying [campaigns](/docs/campaign/Mobile). 


## Pre-initialization settings
Some of the pre-initialization settings are optional. If you want to use them, they must be configured before Synerise SDK is initialized, before invoking the following methods:
- Synerise.Builder.build() (Android)
- [Synerise.initialize(apiKey:)](/developers/mobile-sdk/method-reference/ios/lifecycle#initialization) (iOS)
  
**Pre-initialization settings:**
- [Set up App Group Identifier](#set-up-app-group-identifier) (iOS only)
- [Set up Keychain Group Identifier](#set-up-keychain-group-identifier) (iOS only)
- [Maintaining customer session on different API keys](#maintaining-customer-session-on-different-api-keys)
- [Turn on/turn off notification encryption](#turn-onturn-off-notification-encryption)

**The rest of the options can be changed dynamically anytime.**


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

See advanced initialization example with all settings options for:
- [Advanced initialization - Android](/developers/mobile-sdk/installation-and-configuration/android#initialization)
- [Advanced initialization - iOS](/developers/mobile-sdk/installation-and-configuration/ios#advanced-initialization)
- [Advanced initialization - React Native](/developers/mobile-sdk/installation-and-configuration/react-native#advanced-initialization)

</div></div></div>


## General

### Enable/disable SDK
---
This parameter specifies if the SDK is enabled.

If the SDK is disabled, it means:
- the SDK does not send any events
- the SDK does not handle notifications
- the SDK does not show in-app messages
  
Available on: **Android**, **iOS**, **React Native**, **Flutter**.


<div class="content-tabs" data-tab-group="tabgrp-1268">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1268-0" data-tab-group="tabgrp-1268" data-tab-active="true">Android</button><button class="tab-button" data-tab-id="tabgrp-1268-1" data-tab-group="tabgrp-1268">iOS</button><button class="tab-button" data-tab-id="tabgrp-1268-2" data-tab-group="tabgrp-1268">React Native</button><button class="tab-button" data-tab-id="tabgrp-1268-3" data-tab-group="tabgrp-1268">Flutter</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1268-0" data-tab-group="tabgrp-1268" data-tab-active="true">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.sdk.enabled` | `Boolean` | true |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1268-1" data-tab-group="tabgrp-1268">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.sdk.enabled` | `Bool` | true |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1268-2" data-tab-group="tabgrp-1268">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.Settings.sdk.enabled`| `boolean` | true |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1268-3" data-tab-group="tabgrp-1268">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.sdk.enabled`| `bool` | true |

</div>
</div>



### Minimum time interval to refresh token
---
This parameter sets a time interval (in seconds) counting backwards from the expiration time. Within this time, the authorization token will be automatically refreshed by the SDK.
  
Available on: **Android**, **iOS**, **React Native**, **Flutter**.


<div class="content-tabs" data-tab-group="tabgrp-1269">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1269-0" data-tab-group="tabgrp-1269" data-tab-active="true">Android</button><button class="tab-button" data-tab-id="tabgrp-1269-1" data-tab-group="tabgrp-1269">iOS</button><button class="tab-button" data-tab-id="tabgrp-1269-2" data-tab-group="tabgrp-1269">React Native</button><button class="tab-button" data-tab-id="tabgrp-1269-3" data-tab-group="tabgrp-1269">Flutter</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1269-0" data-tab-group="tabgrp-1269" data-tab-active="true">

| Method | Type | Default | Minimum |
| --- | --- | --- | --- |
| `Synerise.settings.sdk.setMinTokenRefreshInterval(value)` | `TimeInterval` | 1800 | 1800 |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1269-1" data-tab-group="tabgrp-1269">

| Parameter | Type | Default | Minimum |
| --- | --- | --- | --- |
| `Synerise.settings.sdk.minTokenRefreshInterval` | `TimeInterval` | 1800 | 1800 |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1269-2" data-tab-group="tabgrp-1269">

| Parameter | Type | Default | Minimum |
| --- | --- | --- | --- |
| `Synerise.Settings.sdk.minTokenRefreshInterval` | `number` | 1800 | 1800 |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1269-3" data-tab-group="tabgrp-1269">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.sdk.minTokenRefreshInterval`| `double` | 1800 |

</div>
</div>



### Maintaining customer session on different API keys
---
This parameter specifies if a session is destroyed after the Profile API (formerly Client) key changes.


<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This option must be configured when Synerise SDK is initialized.

</div></div></div>

  
Available on: **Android**, **iOS**, **React Native**, **Flutter**.


<div class="content-tabs" data-tab-group="tabgrp-1270">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1270-0" data-tab-group="tabgrp-1270" data-tab-active="true">Android</button><button class="tab-button" data-tab-id="tabgrp-1270-1" data-tab-group="tabgrp-1270">iOS</button><button class="tab-button" data-tab-id="tabgrp-1270-2" data-tab-group="tabgrp-1270">React Native</button><button class="tab-button" data-tab-id="tabgrp-1270-3" data-tab-group="tabgrp-1270">Flutter</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1270-0" data-tab-group="tabgrp-1270" data-tab-active="true">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.sdk.shouldDestroySessionOnApiKeyChange` | `Boolean` | true |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1270-1" data-tab-group="tabgrp-1270">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.sdk.shouldDestroySessionOnApiKeyChange` | `Bool` | true |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1270-2" data-tab-group="tabgrp-1270">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.Settings.sdk.shouldDestroySessionOnApiKeyChange` | `boolean` | true |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1270-3" data-tab-group="tabgrp-1270">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.sdk.shouldDestroySessionOnApiKeyChange`| `bool` | true |

</div>
</div>




<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This option works only if you change the Profile (formerly Client) API key within one workspace.

To change the API key from a different workspace, use the following method:
- for Android [Client.changeApiKey](/developers/mobile-sdk/method-reference/android/lifecycle#change-profile-api-key-dynamically)
- for iOS [Synerise.changeApiKey](/developers/mobile-sdk/method-reference/ios/lifecycle#change-profile-api-key-dynamically)
- for React Native [Synerise.changeApiKey](/developers/mobile-sdk/method-reference/react-native/lifecycle#change-profile-api-key-dynamically)
- for Flutter [Synerise.changeApiKey](/developers/mobile-sdk/method-reference/flutter/lifecycle#change-profile-api-key-dynamically)

</div></div></div>



### Set up App Group Identifier
---
This parameter identifies the user default group applications and extensions belong to.


<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This option must be configured when Synerise SDK is initialized, before invoking the [Synerise.initialize(apiKey:)](/developers/mobile-sdk/method-reference/ios/lifecycle#initialization) method.

</div></div></div>


Available on: **iOS**, **React Native (iOS)**, **Flutter (iOS)**.


<div class="content-tabs" data-tab-group="tabgrp-1271">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1271-0" data-tab-group="tabgrp-1271" data-tab-active="true">iOS</button><button class="tab-button" data-tab-id="tabgrp-1271-1" data-tab-group="tabgrp-1271">React Native</button><button class="tab-button" data-tab-id="tabgrp-1271-2" data-tab-group="tabgrp-1271">Flutter</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1271-0" data-tab-group="tabgrp-1271" data-tab-active="true">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.sdk.appGroupIdentifier` | `String` | nil |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1271-1" data-tab-group="tabgrp-1271">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.Settings.sdk.appGroupIdentifier` | `string` | null |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1271-2" data-tab-group="tabgrp-1271">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.sdk.appGroupIdentifier`| `String` | null |

</div>
</div>


Synerise SDK requires this parameter to be configured for storing your non-sensitive data and sharing it between your app and extensions.

Your App Group must be registered on the [Apple Developer](https://developer.apple.com/) portal. It is recommended to use reverse-domain name style and prefix it with `group.` by default. For example, your App Group can be `group.com.synerise.sdk.sample`.  
When your App Group is registered, add it as a capability on the [Apple Developer](https://developer.apple.com/) portal in App ID Configuration and in Xcode in the **Signing&Capabilities** tab.

Documentation is available at [Apple Developer - App Groups](https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_application-groups).

Once configured, you need to set it up in the SDK:

#### Example

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1265">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1265-0" data-tab-group="tabgrp-1265" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1265-1" data-tab-group="tabgrp-1265">Objective-C</button><button class="tab-button" data-tab-id="tabgrp-1265-2" data-tab-group="tabgrp-1265">JavaScript</button><button class="tab-button" data-tab-id="tabgrp-1265-3" data-tab-group="tabgrp-1265">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1265-0" data-tab-group="tabgrp-1265" data-tab-active="true">

```Swift
Synerise.settings.sdk.appGroupIdentifier = "group.com.synerise.sdk.sample"
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1265-1" data-tab-group="tabgrp-1265">

```Objective-C
SNRSynerise.settings.sdk.appGroupIdentifier = @"group.com.synerise.sdk.sample";
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1265-2" data-tab-group="tabgrp-1265">

```JavaScript
Synerise.Settings.sdk.appGroupIdentifier = "group.com.synerise.sdk.sample";
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1265-3" data-tab-group="tabgrp-1265">

```Dart
Synerise.settings.sdk.appGroupIdentifier = "group.com.synerise.sdk.sample";
```

</div>
</div>


### Set up Keychain Group Identifier
---
This parameter identifies the keychain group used by applications, extensions and services that your app belongs to.


<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This option must be configured when Synerise SDK is initialized, before invoking the [Synerise.initialize(apiKey:)](/developers/mobile-sdk/method-reference/ios/lifecycle#initialization) method.

</div></div></div>

  
Available on: **iOS**, **React Native (iOS)**, **Flutter (iOS)**.


<div class="content-tabs" data-tab-group="tabgrp-1272">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1272-0" data-tab-group="tabgrp-1272" data-tab-active="true">iOS</button><button class="tab-button" data-tab-id="tabgrp-1272-1" data-tab-group="tabgrp-1272">React Native</button><button class="tab-button" data-tab-id="tabgrp-1272-2" data-tab-group="tabgrp-1272">Flutter</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1272-0" data-tab-group="tabgrp-1272" data-tab-active="true">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.sdk.keychainGroupIdentifier` | `String` | nil |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1272-1" data-tab-group="tabgrp-1272">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.Settings.sdk.keychainGroupIdentifier` | `string` | null |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1272-2" data-tab-group="tabgrp-1272">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.sdk.keychainGroupIdentifier`| `String` | null |

</div>
</div>


Synerise SDK requires that parameter to be configured for storing your data safely and sharing it between your app and extensions.

Your Keychain Group Identifier is made of:
- your Keychain Group
- your $(AppIdentifierPrefix), also called Team ID.

For example, if your Keychain Group is set to `SharedItems` and your Team ID is `ABC1234DEF`, the complete literal that you should set as Keychain Group Identifier is `ABC1234DEF.SharedItems`.

Documentation is available at [Apple Developer - Sharing Access to Keychain Items Among a Collection of Apps](https://developer.apple.com/documentation/security/keychain_services/keychain_items/sharing_access_to_keychain_items_among_a_collection_of_apps).

Once configured, you need to set it up in the SDK:

#### Example

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1266">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1266-0" data-tab-group="tabgrp-1266" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1266-1" data-tab-group="tabgrp-1266">Objective-C</button><button class="tab-button" data-tab-id="tabgrp-1266-2" data-tab-group="tabgrp-1266">JavaScript</button><button class="tab-button" data-tab-id="tabgrp-1266-3" data-tab-group="tabgrp-1266">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1266-0" data-tab-group="tabgrp-1266" data-tab-active="true">

```Swift
Synerise.settings.sdk.keychainGroupIdentifier = "ABC1234DEF.SharedItems"
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1266-1" data-tab-group="tabgrp-1266">

```Objective-C
SNRSynerise.settings.sdk.keychainGroupIdentifier = @"ABC1234DEF.SharedItems";
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1266-2" data-tab-group="tabgrp-1266">

```JavaScript
Synerise.Settings.sdk.keychainGroupIdentifier = "ABC1234DEF.SharedItems";
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1266-3" data-tab-group="tabgrp-1266">

```Dart
Synerise.settings.sdk.keychainGroupIdentifier = "ABC1234DEF.SharedItems";
```

</div>
</div>


### Localize some strings occurring in the SDK
---
This parameter specifies the localization of some strings occurring in the SDK.
  
When this option isn't used, the SDK uses default strings.
  
Available on: **iOS**, **React Native (iOS)**, **Flutter (iOS)**.


<div class="content-tabs" data-tab-group="tabgrp-1273">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1273-0" data-tab-group="tabgrp-1273" data-tab-active="true">iOS</button><button class="tab-button" data-tab-id="tabgrp-1273-1" data-tab-group="tabgrp-1273">React Native</button><button class="tab-button" data-tab-id="tabgrp-1273-2" data-tab-group="tabgrp-1273">Flutter</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1273-0" data-tab-group="tabgrp-1273" data-tab-active="true">

| Parameter | Type | Default | Min. SDK version |
| --- | --- | --- | --- |
| `Synerise.settings.sdk.localizable` | `[LocalizableStringKey: String]` | nil | 4.14.12 |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1273-1" data-tab-group="tabgrp-1273">

| Parameter | Type | Default | Min. SDK version |
| --- | --- | --- | --- |
| `Synerise.Settings.sdk.localizable` | `object` | null | 0.19.0 |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1273-2" data-tab-group="tabgrp-1273">

| Parameter | Type | Default | Min. SDK version |
| --- | --- | --- | --- |
| `Synerise.settings.sdk.localizable` | `Map<String, String>` | null | 1.0.0 |

</div>
</div>



<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

We recommend updating the property when you change the language in the Host App.

</div></div></div>


## Notifications

### Enable/disable notifications
---
This parameter specifies if handling notifications by the SDK is enabled.
  
Available on: **Android**, **iOS**, **React Native**, **Flutter**.


<div class="content-tabs" data-tab-group="tabgrp-1274">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1274-0" data-tab-group="tabgrp-1274" data-tab-active="true">Android</button><button class="tab-button" data-tab-id="tabgrp-1274-1" data-tab-group="tabgrp-1274">iOS</button><button class="tab-button" data-tab-id="tabgrp-1274-2" data-tab-group="tabgrp-1274">React Native</button><button class="tab-button" data-tab-id="tabgrp-1274-3" data-tab-group="tabgrp-1274">Flutter</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1274-0" data-tab-group="tabgrp-1274" data-tab-active="true">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.notifications.enabled` | `Boolean` | true |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1274-1" data-tab-group="tabgrp-1274">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.notifications.enabled` | `Bool` | true |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1274-2" data-tab-group="tabgrp-1274">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.Settings.notifications.enabled` | `boolean` | true |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1274-3" data-tab-group="tabgrp-1274">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.notifications.enabled` | `bool` | true |

</div>
</div>


### Turn on/turn off notification encryption
---
This parameter specifies if encryption for push notifications is enabled.  


<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This option must be configured when Synerise SDK is initialized.

</div></div></div>

  
Available on: **Android**, **iOS**, **React Native**, **Flutter**.


<div class="content-tabs" data-tab-group="tabgrp-1275">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1275-0" data-tab-group="tabgrp-1275" data-tab-active="true">Android</button><button class="tab-button" data-tab-id="tabgrp-1275-1" data-tab-group="tabgrp-1275">iOS</button><button class="tab-button" data-tab-id="tabgrp-1275-2" data-tab-group="tabgrp-1275">React Native</button><button class="tab-button" data-tab-id="tabgrp-1275-3" data-tab-group="tabgrp-1275">Flutter</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1275-0" data-tab-group="tabgrp-1275" data-tab-active="true">

| Method | Type | Default |
| --- | --- | --- |
| `Synerise.settings.notifications.setEncryption(value)` | `Boolean` | false |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1275-1" data-tab-group="tabgrp-1275">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.notifications.encryption` | `Bool` | false |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1275-2" data-tab-group="tabgrp-1275">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.Settings.notifications.encryption` | `boolean` | false |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1275-3" data-tab-group="tabgrp-1275">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.notifications.encryption` | `bool` | false |

</div>
</div>



<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Encryption must be enabled in the [workspace settings](https://app.synerise.com/spa/modules/old-settings/setting/integration), in the Firebase integration section.

</div></div></div>



<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The application must be properly configured and implemented for notification encryption:
- [Configure Notification Encryption for Android.](/developers/mobile-sdk/configuring-push-notifications/android#configure-notification-encryption) 
- [Configure Notification Encryption for iOS.](/developers/mobile-sdk/configuring-push-notifications/ios#configure-notification-encryption)
- [Configure Notification Encryption for React Native.](/developers/mobile-sdk/configuring-push-notifications/react-native#configure-notification-encryption)
- [Configure Notification Encryption for Flutter.](/developers/mobile-sdk/configuring-push-notifications/flutter#configure-notification-encryption)

</div></div></div>


### Enable/disable notification in-app alerts
---
This parameter determines whether the SDK displays an additional alert in the application right after a notification is delivered.

If you have your own notification implementation, or you do not want to display alerts with notification content, you should disable in-app notification alerts from the Synerise SDK.
  
Also, read [here](/developers/mobile-sdk/campaigns/simple-push#additional-in-app-alert-when-simple-push-is-received).

Available on: **iOS**, **React Native (iOS)**, **Flutter (iOS)**.


<div class="content-tabs" data-tab-group="tabgrp-1276">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1276-0" data-tab-group="tabgrp-1276" data-tab-active="true">iOS</button><button class="tab-button" data-tab-id="tabgrp-1276-1" data-tab-group="tabgrp-1276">React Native</button><button class="tab-button" data-tab-id="tabgrp-1276-2" data-tab-group="tabgrp-1276">Flutter</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1276-0" data-tab-group="tabgrp-1276" data-tab-active="true">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.notifications.disableInAppAlerts` | `Bool` | false |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1276-1" data-tab-group="tabgrp-1276">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.Settings.notifications.disableInAppAlerts` | `boolean` | false |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1276-2" data-tab-group="tabgrp-1276">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.notifications.disableInAppAlerts` | `bool` | false |

</div>
</div>


## In-app messaging

### Check Global Control Groups when fetching definitions
---
This parameter specifies if global control groups should be checked immediately after in-app definitions are fetched.
  
Available on: **Android**, **iOS**, **React Native**, **Flutter**.


<div class="content-tabs" data-tab-group="tabgrp-1277">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1277-0" data-tab-group="tabgrp-1277" data-tab-active="true">Android</button><button class="tab-button" data-tab-id="tabgrp-1277-1" data-tab-group="tabgrp-1277">iOS</button><button class="tab-button" data-tab-id="tabgrp-1277-2" data-tab-group="tabgrp-1277">React Native</button><button class="tab-button" data-tab-id="tabgrp-1277-3" data-tab-group="tabgrp-1277">Flutter</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1277-0" data-tab-group="tabgrp-1277" data-tab-active="true">

| Parameter | Type | Default | Min. SDK version |
| --- | --- | --- | --- |
| `Synerise.settings.inAppMessaging.checkGlobalControlGroupsOnDefinitionsFetch` | `Boolean` | false | 5.15.0 |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1277-1" data-tab-group="tabgrp-1277">

| Parameter | Type | Default | Min. SDK version |
| --- | --- | --- | --- |
| `Synerise.settings.inAppMessaging.checkGlobalControlGroupsOnDefinitionsFetch` | `Bool` | false | 4.15.0 |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1277-2" data-tab-group="tabgrp-1277">

| Parameter | Type | Default | Min. SDK version |
| --- | --- | --- | --- |
| `Synerise.Settings.notifications.checkGlobalControlGroupsOnDefinitionsFetch` | `boolean` | false | 0.19.0 |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1277-3" data-tab-group="tabgrp-1277">

| Parameter | Type | Default | Min. SDK version |
| --- | --- | --- | --- |
| `Synerise.settings.inAppMessaging.checkGlobalControlGroupsOnDefinitionsFetch` | `bool` | false | 0.8.3 |

</div>
</div>



### Maximum time interval between in-app definition updates
---
This parameter sets the maximum interval (in seconds) between automatic [in-app message](/docs/campaign/in-app-messages) definition updates.
  
Available on: **Android**, **iOS**, **React Native**, **Flutter**.


<div class="content-tabs" data-tab-group="tabgrp-1278">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1278-0" data-tab-group="tabgrp-1278" data-tab-active="true">Android</button><button class="tab-button" data-tab-id="tabgrp-1278-1" data-tab-group="tabgrp-1278">iOS</button><button class="tab-button" data-tab-id="tabgrp-1278-2" data-tab-group="tabgrp-1278">React Native</button><button class="tab-button" data-tab-id="tabgrp-1278-3" data-tab-group="tabgrp-1278">Flutter</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1278-0" data-tab-group="tabgrp-1278" data-tab-active="true">

| Method | Type | Default | Minimum | Min. SDK version |
| --- | --- | --- | --- | --- |
| `Synerise.settings.inAppMessaging.setMaxDefinitionUpdateIntervalLimit(value)` | `TimeInterval` | 600.0 | 600.0 | 4.7.0 |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1278-1" data-tab-group="tabgrp-1278">

| Parameter | Type | Default | Minimum | Min. SDK version |
| --- | --- | --- | --- | --- |
| `Synerise.settings.inAppMessaging.maxDefinitionUpdateIntervalLimit` | `TimeInterval` | 600.0 | 600.0 | 4.6.0 |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1278-2" data-tab-group="tabgrp-1278">

| Parameter | Type | Default | Minimum | Min. SDK version |
| --- | --- | --- | --- | --- |
| `Synerise.Settings.inAppMessaging.maxDefinitionUpdateIntervalLimit` | `number` | 600.0 | 600.0 | 0.12.0 |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1278-3" data-tab-group="tabgrp-1278">

| Parameter | Type | Default | Minimum | Min. SDK version |
| --- | --- | --- | --- | --- |
| `Synerise.settings.inAppMessaging.maxDefinitionUpdateIntervalLimit` | `double` | 600.0 | 600.0 | 0.4.0 |

</div>
</div>


### Content base URL for in-app message
---
This parameter defines the base URL for loading external resources (such as JavaScript files, CSS stylesheets, images, or fonts) within your in-app content. This is particularly useful when resources are hosted on your own server and you have set up **CORS (Cross-Origin Resource Sharing) policies**.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Thanks to the base URL, the app will know where to look for all external resources that are loaded dynamically. This helps avoid specifying full URLs each time a resource is requested and ensures that resources are consistently loaded from the correct location.

</div></div></div>


Available on: **Android**, **iOS**, **React Native**, **Flutter**.


<div class="content-tabs" data-tab-group="tabgrp-1279">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1279-0" data-tab-group="tabgrp-1279" data-tab-active="true">Android</button><button class="tab-button" data-tab-id="tabgrp-1279-1" data-tab-group="tabgrp-1279">iOS</button><button class="tab-button" data-tab-id="tabgrp-1279-2" data-tab-group="tabgrp-1279">React Native</button><button class="tab-button" data-tab-id="tabgrp-1279-3" data-tab-group="tabgrp-1279">Flutter</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1279-0" data-tab-group="tabgrp-1279" data-tab-active="true">

| Parameter | Type | Default | Min. SDK version |
| --- | --- | --- | --- |
| `Synerise.settings.inAppMessaging.contentBaseUrl` | `String` | null | 5.21.0 |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1279-1" data-tab-group="tabgrp-1279">

| Parameter | Type | Default | Min. SDK version |
| --- | --- | --- | --- |
| `Synerise.settings.inAppMessaging.contentBaseUrl` | `String` | nil | 4.21.0 |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1279-2" data-tab-group="tabgrp-1279">

| Parameter | Type | Default | Min. SDK version |
| --- | --- | --- | --- |
| `Synerise.Settings.inAppMessaging.contentBaseUrl` | `string` | null | 0.24.0 |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1279-3" data-tab-group="tabgrp-1279">

| Parameter | Type | Default | Min. SDK version |
| --- | --- | --- | --- |
| `Synerise.settings.inAppMessaging.contentBaseUrl` | `String` | null | 1.4.0 |

</div>
</div>

  
#### Example
You should set `contentBaseUrl` to the root URL of the server hosting your resources. This is especially important when hosting assets such as fonts, images, or scripts from a specific domain or server.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-1267">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1267-0" data-tab-group="tabgrp-1267" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1267-1" data-tab-group="tabgrp-1267">Objective-C</button><button class="tab-button" data-tab-id="tabgrp-1267-2" data-tab-group="tabgrp-1267">JavaScript</button><button class="tab-button" data-tab-id="tabgrp-1267-3" data-tab-group="tabgrp-1267">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1267-0" data-tab-group="tabgrp-1267" data-tab-active="true">

```Swift
Synerise.settings.inAppMessaging.contentBaseUrl = "https://www.synerise.com"
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1267-1" data-tab-group="tabgrp-1267">

```Objective-C
SNRSynerise.settings.inAppMessaging.contentBaseUrl = @"https://www.synerise.com";
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1267-2" data-tab-group="tabgrp-1267">

```JavaScript
Synerise.Settings.inAppMessaging.contentBaseUrl = "https://www.synerise.com"
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1267-3" data-tab-group="tabgrp-1267">

```Dart
Synerise.settings.inAppMessaging.contentBaseUrl = "https://www.synerise.com"
```

</div>
</div>


### Maximum time for in-app message rendering
---
This parameter sets a timeout (in seconds) for in-app message rendering.
  
Available on: **Android**, **iOS**, **React Native**, **Flutter**.


<div class="content-tabs" data-tab-group="tabgrp-1280">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1280-0" data-tab-group="tabgrp-1280" data-tab-active="true">Android</button><button class="tab-button" data-tab-id="tabgrp-1280-1" data-tab-group="tabgrp-1280">iOS</button><button class="tab-button" data-tab-id="tabgrp-1280-2" data-tab-group="tabgrp-1280">React Native</button><button class="tab-button" data-tab-id="tabgrp-1280-3" data-tab-group="tabgrp-1280">Flutter</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1280-0" data-tab-group="tabgrp-1280" data-tab-active="true">

| Parameter | Type | Default | Minimum | Min. SDK version |
| --- | --- | --- | --- | --- |
| `Synerise.settings.inAppMessaging.renderingTimeout` | `TimeInterval` | 2.0 | - | 4.7.0 |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1280-1" data-tab-group="tabgrp-1280">

| Parameter | Type | Default | Minimum | Min. SDK version |
| --- | --- | --- | --- | --- |
| `Synerise.settings.inAppMessaging.renderingTimeout` | `TimeInterval` | 5.0 | 1.0 | 4.6.0 |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1280-2" data-tab-group="tabgrp-1280">

| Parameter | Type | Default | Minimum | Min. SDK version |
| --- | --- | --- | --- | --- |
| `Synerise.Settings.inAppMessaging.renderingTimeout` | `number` | 2.0 (Android)<br/>5.0 (iOS) | - (Android)<br/>1.0 (iOS) | 0.12.0 |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1280-3" data-tab-group="tabgrp-1280">

| Parameter | Type | Default | Minimum | Min. SDK version |
| --- | --- | --- | --- | --- |
| `Synerise.settings.inAppMessaging.renderingTimeout` | `double` | 2.0 (Android)<br/>5.0 (iOS) | - (Android)<br/>1.0 (iOS) | 0.4.0 |

</div>
</div>



### Enable/disable sending inApp.capping event
---
This parameter specifies if the SDK should send the `inApp.capping` event.
  
Available on: **Android**, **iOS**, **React Native**, **Flutter**.


<div class="content-tabs" data-tab-group="tabgrp-1281">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1281-0" data-tab-group="tabgrp-1281" data-tab-active="true">Android</button><button class="tab-button" data-tab-id="tabgrp-1281-1" data-tab-group="tabgrp-1281">iOS</button><button class="tab-button" data-tab-id="tabgrp-1281-2" data-tab-group="tabgrp-1281">React Native</button><button class="tab-button" data-tab-id="tabgrp-1281-3" data-tab-group="tabgrp-1281">Flutter</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1281-0" data-tab-group="tabgrp-1281" data-tab-active="true">

| Parameter | Type | Default | Min. SDK version |
| --- | --- | --- | --- |
| `Synerise.settings.inAppMessaging.shouldSendInAppCappingEvent` | `Boolean` | true | 5.10.1 |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1281-1" data-tab-group="tabgrp-1281">

| Parameter | Type | Default | Min. SDK version |
| --- | --- | --- | --- |
| `Synerise.settings.inAppMessaging.shouldSendInAppCappingEvent` | `Bool` | true | 4.14.8 |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1281-2" data-tab-group="tabgrp-1281">

| Parameter | Type | Default | Min. SDK version |
| --- | --- | --- | --- |
| `Synerise.Settings.inAppMessaging.shouldSendInAppCappingEvent` | `boolean` | true | 0.16.0 |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1281-3" data-tab-group="tabgrp-1281">

| Parameter | Type | Default | Min. SDK version |
| --- | --- | --- | --- |
| `Synerise.settings.inAppMessaging.shouldSendInAppCappingEvent` | `bool` | true | 0.7.2 |

</div>
</div>


## Tracker

### Enable/disable declarative tracking
---
This parameter specifies if the [declarative tracking](/developers/mobile-sdk/event-tracking#declarative-tracking) feature is enabled.
  
Available on: **Android**, **iOS**.


<div class="content-tabs" data-tab-group="tabgrp-1282">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1282-0" data-tab-group="tabgrp-1282" data-tab-active="true">Android</button><button class="tab-button" data-tab-id="tabgrp-1282-1" data-tab-group="tabgrp-1282">iOS</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1282-0" data-tab-group="tabgrp-1282" data-tab-active="true">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.tracker.tracking.enabled` | `Boolean` | true |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1282-1" data-tab-group="tabgrp-1282">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.tracker.tracking.enabled` | `Bool` | true |

</div>
</div>


### Enable/disable auto-tracking
---


<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Autotracking is **NOT** available when building apps with Jetpack Compose (Android) and SwiftUI (iOS).

</div></div></div>


This parameter specifies if the [auto-tracking feature](/developers/mobile-sdk/event-tracking#auto-tracking) is enabled.
  
Available on: **Android**, **iOS**.


<div class="content-tabs" data-tab-group="tabgrp-1283">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1283-0" data-tab-group="tabgrp-1283" data-tab-active="true">Android</button><button class="tab-button" data-tab-id="tabgrp-1283-1" data-tab-group="tabgrp-1283">iOS</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1283-0" data-tab-group="tabgrp-1283" data-tab-active="true">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.tracker.autoTracking.enabled` | `Boolean` | true |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1283-1" data-tab-group="tabgrp-1283">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.tracker.autoTracking.enabled` | `Bool` | true |

</div>
</div>


### Require/do not require backend time synchronization to send events
---
This parameter specifies if events are sent when the server time synchronization has failed.
  
Available on: **Android**, **iOS**, **React Native**, **Flutter**.


<div class="content-tabs" data-tab-group="tabgrp-1284">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1284-0" data-tab-group="tabgrp-1284" data-tab-active="true">Android</button><button class="tab-button" data-tab-id="tabgrp-1284-1" data-tab-group="tabgrp-1284">iOS</button><button class="tab-button" data-tab-id="tabgrp-1284-2" data-tab-group="tabgrp-1284">React Native</button><button class="tab-button" data-tab-id="tabgrp-1284-3" data-tab-group="tabgrp-1284">Flutter</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1284-0" data-tab-group="tabgrp-1284" data-tab-active="true">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.tracker.isBackendTimeSyncRequired` | `Boolean` | true |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1284-1" data-tab-group="tabgrp-1284">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.tracker.isBackendTimeSyncRequired` | `Bool` | true |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1284-2" data-tab-group="tabgrp-1284">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.Settings.tracker.isBackendTimeSyncRequired` | `Bool` | true |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1284-3" data-tab-group="tabgrp-1284">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.tracker.isBackendTimeSyncRequired` | `bool` | true |

</div>
</div>


### Minimum number of events in queue
---
This parameter sets the minimum number of events in queue required to send the queue.
  
Available on: **Android**, **iOS**, **React Native**, **Flutter**.


<div class="content-tabs" data-tab-group="tabgrp-1285">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1285-0" data-tab-group="tabgrp-1285" data-tab-active="true">Android</button><button class="tab-button" data-tab-id="tabgrp-1285-1" data-tab-group="tabgrp-1285">iOS</button><button class="tab-button" data-tab-id="tabgrp-1285-2" data-tab-group="tabgrp-1285">React Native</button><button class="tab-button" data-tab-id="tabgrp-1285-3" data-tab-group="tabgrp-1285">Flutter</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1285-0" data-tab-group="tabgrp-1285" data-tab-active="true">

| Method | Type | Default | Minimum | Maximum |
| --- | --- | --- | --- | --- |
| `Synerise.settings.tracker.setMinimumBatchSize(value)` | `Integer` | 10 | 1 | 100 |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1285-1" data-tab-group="tabgrp-1285">

| Parameter | Type | Default | Minimum | Maximum |
| --- | --- | --- | --- | --- |
| `Synerise.settings.tracker.minBatchSize` | `Int` | 10 | 1 | 100 |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1285-2" data-tab-group="tabgrp-1285">

| Parameter | Type | Default | Minimum | Maximum |
| --- | --- | --- | --- | --- |
| `Synerise.Settings.tracker.minBatchSize` | `number` | 10 | 1 | 100 |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1285-3" data-tab-group="tabgrp-1285">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.tracker.minBatchSize` | `int` | 10 | 1 | 100 |

</div>
</div>




<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

If the [timer](/developers/mobile-sdk/settings#timeout-to-send-events-automatically) runs out, events are sent even if the queue is smaller than defined in **minBatchSize**.

</div></div></div>


### Maximum number of events in queue
---
This parameter sets the maximum number of events which may be sent in a single batch.
  
Available on: **Android**, **iOS**, **React Native**, **Flutter**.


<div class="content-tabs" data-tab-group="tabgrp-1286">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1286-0" data-tab-group="tabgrp-1286" data-tab-active="true">Android</button><button class="tab-button" data-tab-id="tabgrp-1286-1" data-tab-group="tabgrp-1286">iOS</button><button class="tab-button" data-tab-id="tabgrp-1286-2" data-tab-group="tabgrp-1286">React Native</button><button class="tab-button" data-tab-id="tabgrp-1286-3" data-tab-group="tabgrp-1286">Flutter</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1286-0" data-tab-group="tabgrp-1286" data-tab-active="true">

| Method | Type | Default | Minimum | Maximum |
| --- | --- | --- | --- | --- |
| `Synerise.settings.tracker.setMaximumBatchSize(value)` | `Integer` | 100 | 1 | 100 |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1286-1" data-tab-group="tabgrp-1286">

| Parameter | Type | Default | Minimum | Maximum |
| --- | --- | --- | --- | --- |
| `Synerise.Settings.tracker.maxBatchSize` | `number` | 100 | 1 | 100 |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1286-2" data-tab-group="tabgrp-1286">

| Parameter | Type | Default | Minimum | Maximum |
| --- | --- | --- | --- | --- |
| `Synerise.Settings.tracker.maxBatchSize` | `number` | 100 | 1 | 100 |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1286-3" data-tab-group="tabgrp-1286">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.tracker.maxBatchSize` | `int` | 100 | 1 | 100 |

</div>
</div>


### Timeout to send events automatically
---
This parameter sets the time (in milliseconds for Android, in seconds for other SDKs) required before an attempt is made to send the queue.
  
Available on: **Android**, **iOS**, **React Native**, **Flutter**.


<div class="content-tabs" data-tab-group="tabgrp-1287">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1287-0" data-tab-group="tabgrp-1287" data-tab-active="true">Android</button><button class="tab-button" data-tab-id="tabgrp-1287-1" data-tab-group="tabgrp-1287">iOS</button><button class="tab-button" data-tab-id="tabgrp-1287-2" data-tab-group="tabgrp-1287">React Native</button><button class="tab-button" data-tab-id="tabgrp-1287-3" data-tab-group="tabgrp-1287">Flutter</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1287-0" data-tab-group="tabgrp-1287" data-tab-active="true">

| Method | Type | Default | Minimum | Maximum |
| --- | --- | --- | --- | --- |
| `Synerise.settings.tracker.setAutoFlushTimeout(value)` | `TimeInterval` | 5000 | 50 | - |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1287-1" data-tab-group="tabgrp-1287">

| Parameter | Type | Default | Minimum | Maximum |
| --- | --- | --- | --- | --- |
| `Synerise.settings.tracker.autoFlushTimeout` | `TimeInterval` | 5.0 | 0.5 | - |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1287-2" data-tab-group="tabgrp-1287">

| Parameter | Type | Default | Minimum | Maximum |
| --- | --- | --- | --- | --- |
| `Synerise.Settings.tracker.autoFlushTimeout` | `number` | 5.0 | 0.5 | - |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1287-3" data-tab-group="tabgrp-1287">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.tracker.autoFlushTimeout` | `double` | 5.0 | 0.5 | - |

</div>
</div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

If the [minimum queue size](/developers/mobile-sdk/settings#minimum-number-of-events-in-queue) is met, events are sent even if the timer has not run out.

</div></div></div>


### Events triggering flush mechanism
---
This parameter sets an array of event 'action' values which trigger the flush mechanism.

The list can be modified or cleared - including removing the default values.
  
Available on: **Android** (5.17.0 or newer), **iOS** (4.17.0 or newer).


<div class="content-tabs" data-tab-group="tabgrp-1288">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1288-0" data-tab-group="tabgrp-1288" data-tab-active="true">Android</button><button class="tab-button" data-tab-id="tabgrp-1288-1" data-tab-group="tabgrp-1288">iOS</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1288-0" data-tab-group="tabgrp-1288" data-tab-active="true">

| Parameter | Type | Default | Min. SDK version |
| --- | --- | --- | --- |
| `Synerise.settings.tracker.eventsTriggeringFlush` | `List<String>` | ["push.click", "push.view", "push.notView", "push.button.click", "push.dismiss"] | 5.17.0 |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1288-1" data-tab-group="tabgrp-1288">

<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

In iOS, `push.view` events are handled by the Notification Service Extension and always sent immediately, regardless of this setting.

</div></div></div>


| Parameter | Type | Default | Min. SDK version |
| --- | --- | --- | --- |
| `Synerise.settings.tracker.eventsTriggeringFlush` | `[String]` | ["push.openInApp", "push.click", "push.button.click", "push.dismiss"] | 4.17.0 |

</div>
</div>


### Automatic location event sending
---
This parameter specifies if location events are sent automatically.
  
Available on: **Android**, **iOS**.


<div class="content-tabs" data-tab-group="tabgrp-1289">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1289-0" data-tab-group="tabgrp-1289" data-tab-active="true">Android</button><button class="tab-button" data-tab-id="tabgrp-1289-1" data-tab-group="tabgrp-1289">iOS</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1289-0" data-tab-group="tabgrp-1289" data-tab-active="true">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.tracker.locationAutomatic` | `Boolean` | false |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1289-1" data-tab-group="tabgrp-1289">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.tracker.locationAutomatic` | `Bool` | false |

</div>
</div>


### Auto-tracking mode
---
This parameter parameter defines the [auto-tracking](/developers/mobile-sdk/event-tracking#auto-tracking-configuration) mode.
  
Available on: **Android**, **iOS**.


<div class="content-tabs" data-tab-group="tabgrp-1290">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1290-0" data-tab-group="tabgrp-1290" data-tab-active="true">Android</button><button class="tab-button" data-tab-id="tabgrp-1290-1" data-tab-group="tabgrp-1290">iOS</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1290-0" data-tab-group="tabgrp-1290" data-tab-active="true">

- `PLAIN` - listeners are set to track screen visits only.
- `FINE`  - listeners are attached to nearly everything that is clickable in your app, including screen visits.

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.tracker.autoTracking.trackMode` | TrackMode | FINE |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1290-1" data-tab-group="tabgrp-1290">

- `.disabled` - listeners are disabled (default).
- `.plain` - listeners are set to on-click only.
- `.fine` - listeners are attached to nearly everything in your app (even to activities and `viewDidAppear`, the method that records [**VisitedScreen**](/developers/mobile-sdk/class-reference/ios/events#visitedscreenevent) events).

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.tracker.autoTracking.mode` | `TrackerAutoTrackMode` | .disabled |

</div>
</div>


### Classes excluded from auto-tracking
---
This parameter excludes classes from auto-tracking.
  
Available on: **Android**, **iOS**.


<div class="content-tabs" data-tab-group="tabgrp-1291">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1291-0" data-tab-group="tabgrp-1291" data-tab-active="true">Android</button><button class="tab-button" data-tab-id="tabgrp-1291-1" data-tab-group="tabgrp-1291">iOS</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1291-0" data-tab-group="tabgrp-1291" data-tab-active="true">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.tracker.autoTracking.excludedClasses` | `List<Object>` | [] |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1291-1" data-tab-group="tabgrp-1291">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.tracker.autoTracking.excludedClasses` | `[AnyClass]` | [] |

</div>
</div>


### View Tags excluded from auto-tracking
---
This parameter excludes view tags from [auto-tracking](/developers/mobile-sdk/event-tracking#auto-tracking-configuration).
  
Available on: **iOS**.


<div class="content-tabs" data-tab-group="tabgrp-1292">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1292-0" data-tab-group="tabgrp-1292" data-tab-active="true">iOS</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1292-0" data-tab-group="tabgrp-1292" data-tab-active="true">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.tracker.autoTracking.excludedViewTags` | `[Int]` | [] |

</div>
</div>


## Injector

### Enable/disable automatic starting of mobile campaigns (deprecated)
---
This parameter specifies if walkthrough is processed automatically or not. - **DEPRECATED**
  
Available on: **Android**, **iOS**, **React Native**, **Flutter**.


<div class="content-tabs" data-tab-group="tabgrp-1293">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1293-0" data-tab-group="tabgrp-1293" data-tab-active="true">Android</button><button class="tab-button" data-tab-id="tabgrp-1293-1" data-tab-group="tabgrp-1293">iOS</button><button class="tab-button" data-tab-id="tabgrp-1293-2" data-tab-group="tabgrp-1293">React Native</button><button class="tab-button" data-tab-id="tabgrp-1293-3" data-tab-group="tabgrp-1293">Flutter</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1293-0" data-tab-group="tabgrp-1293" data-tab-active="true">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.injector.automatic` | `Boolean` | false |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1293-1" data-tab-group="tabgrp-1293">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.injector.automatic` | `Bool` | false |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1293-2" data-tab-group="tabgrp-1293">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.Settings.injector.automatic` | `boolean` | false |

</div>

<div class="tab-panel" data-tab-id="tabgrp-1293-3" data-tab-group="tabgrp-1293">

| Parameter | Type | Default |
| --- | --- | --- |
| `Synerise.settings.injector.automatic` | `bool` | false |

</div>
</div>







# Client


### ClientIdentityProvider
**Declared In:**  
lib/enums/client/identity_provider.dart
  
**Declaration:**  

<pre><code class="language-Dart">enum IdentityProvider {
  synerise('SYNERISE'),
  facebook('FACEBOOK'),
  google('GOOGLE'),
  oauth('OAUTH'),
  apple('APPLE'),
  unknown('UNKNOWN');
  }</code></pre>


---
---

### ClientAuthContext
<!-- reusable-table-boundary -->

**Declared In:**  
lib/model/client/client_auth_context.dart
  
**Related To:**  
[ClientAgreements](/developers/mobile-sdk/class-reference/flutter/client#clientagreements)  
  
**Declaration:**

<pre><code class="language-Dart">class ClientAuthContext</code></pre>

  
**Properties:**
| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **authId** | String | yes | null | Optional identifier of authorization |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/flutter/client#clientagreements) | yes | null | Object that stores all agreements of a customer |
| **attributes** | HashMap<String, Object> | yes | null | Additional custom attributes of a customer |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authId** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>


**Initializers:**

<pre><code class="language-Dart">ClientAuthContext({this.authId, this.agreements, this.attributes})</code></pre>


**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-152">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-152-0" data-tab-group="tabgrp-152" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-152-0" data-tab-group="tabgrp-152" data-tab-active="true">

```Dart
ClientAuthContext clientAuthContext = ClientAuthContext(
authId: 'AUTH_ID', 
agreements: agreements, 
attributes: attributes
);
```

</div>
</div>


<!-- reusable-table-boundary -->

---
---

### ClientConditionalAuthContext
<!-- reusable-table-boundary -->

**Declared In:**  
lib/model/client/client_conditional_auth_context.dart
  
**Related To:**  
[ClientAgreements](/developers/mobile-sdk/class-reference/flutter/client#clientagreements)  

**Declaration:**

<pre><code class="language-Dart">class ClientCondtitionalAuthContext {</code></pre>

  
**Properties:**
Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/flutter/client#clientagreements) | yes | Object that stores all agreements of a customer |
| **attributes** | Map<String, Object> | yes | Additional custom attributes of a customer |
  
**Initializers:**

<pre><code class="language-Dart">ClientCondtitionalAuthContext({this.agreements, this.attributes});</code></pre>


<!-- reusable-table-boundary -->

---
---

### ClientAccountInformation
<!-- reusable-table-boundary -->

Model representating the customer information.
  

<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This is a read-only class and it is not meant to be instantiated directly.

</div></div></div>


**Declared In:**  
lib/model/client/client_account_information.dart   
  
**Related To:**  
[ClientSex](/developers/mobile-sdk/class-reference/flutter/client#clientsex)  
[ClientAgreements](/developers/mobile-sdk/class-reference/flutter/client#clientagreements)  
  
**Declaration:**  

<pre><code class="language-Dart">class ClientAccountInformation</code></pre>

  
**Properties:** 
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **clientId** | int | no | Customer's ID |
| **email** | String | no | Customer's email |
| **phone** | String | yes | Customer's phone |
| **customId** | String | yes | Customer's custom ID |
| **uuid** | String | no | Customer's UUID |
| **firstName** | String | yes | Customer's first name |
| **lastName** | String | yes | Customer's last name |
| **displayName** | String | yes | Customer's display name |
| **sex** | [ClientSex](/developers/mobile-sdk/class-reference/flutter/client#clientsex) | no | Customer's sex |
| **company** | String | yes | Customer's company |
| **address** | String | yes | Customer's address |
| **city** | String | yes | Customer's city |
| **province** | String | yes | Customer's province |
| **zipCode** | String | yes | Customer's ZIP code |
| **countryCode** | String | yes | Customer's country code |
| **birthDate** | String | yes | Customer's birthdate |
| **lastActivityDate** | Date | no | Customer's last activity date |
| **avatarUrl** | String | yes | Customer's avatar URL |
| **anonymous** | bool | no | Customer's anonymous flag |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/flutter/client#clientagreements) | no | Customer's agreements |
| **attributes** | HashMap<String, Object> | yes | Customer's attributes |
| **tags** | List<String> | yes | Customer's tags |

<!-- reusable-table-boundary -->

---
---

### ClientAccountUpdateBasicInformationContext
<!-- reusable-table-boundary -->

**Declared In:**  
lib/model/client/client_account_update_basic_information_context.dart  
  
**Related To:**  
[ClientSex](/developers/mobile-sdk/class-reference/flutter/client#clientsex)  
[ClientAgreements](/developers/mobile-sdk/class-reference/flutter/client#clientagreements)  
  
**Declaration:**

<pre><code class="language-Dart">class ClientAccountUpdateBasicInformationContext</code></pre>


**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **firstName** | String | yes | Customer's first name |
| **lastName** | String | yes | Customer's last name |
| **displayName** | String | yes | Customer's display name |
| **sex** | [ClientSex](/developers/mobile-sdk/class-reference/flutter/client#clientsex) | yes | Customer's sex |
| **phone** | String | yes | Customer's phone number |
| **company** | String | yes | Customer's company |
| **address** | String | yes | Customer's address |
| **city** | String | yes | Customer's city |
| **province** | String | yes | Customer's province |
| **zipCode** | String | yes | Customer's ZIP code |
| **countryCode** | String | yes | Customer's country code |
| **birthDate** | String | yes | Customer's birthdate |
| **avatarUrl** | String | yes | Customer's avatar URL |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/flutter/client#clientagreements) | yes | Customer's agreements |
| **attributes** | HashMap<String, Object> | yes | Customer's attributes |
  
**Initializers:**

<pre><code class="language-Dart">ClientAccountUpdateBasicInformationContext({
  this.firstName,
  this.lastName,
  this.displayName,
  this.sex,
  this.phone,
  this.company,
  this.address,
  this.city,
  this.province,
  this.zipcode,
  this.countrycode,
  this.agreements,
  this.attributes
});</code></pre>


**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-153">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-153-0" data-tab-group="tabgrp-153" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-153-0" data-tab-group="tabgrp-153" data-tab-active="true">

```Dart
ClientAccountUpdateBasicInformationContext context = ClientAccountUpdateBasicInformationContext(
  firstName: firstName,
  lastName: lastName,
  sex: sex,
  phone: phone,
  company: company,
  address: address,
  city: city,
  province: province,
  zipcode: zipcode,
  countrycode: countrycode);
```

</div>
</div>


<!-- reusable-table-boundary -->

---
---

### ClientAccountUpdateContext
<!-- reusable-table-boundary -->

**Declared In:**  
lib/model/client/client_account_update_context.dart  
  
**Related To:**  
[ClientSex](/developers/mobile-sdk/class-reference/flutter/client#clientsex)  
[ClientAgreements](/developers/mobile-sdk/class-reference/flutter/client#clientagreements)  
  
**Declaration:**

<pre><code class="language-Dart">class ClientAccountUpdateContext</code></pre>


**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **email** | String | yes | Customer's email |
| **customId** | String | yes | Customer's custom ID |
| **uuid** | String | yes | Customer's UUID |
| **firstName** | String | yes | Customer's first name |
| **lastName** | String | yes | Customer's last name |
| **displayName** | String | yes | Customer's display name |
| **sex** | [ClientSex](/developers/mobile-sdk/class-reference/flutter/client#clientsex) | yes | Customer's sex |
| **phone** | String | yes | Customer's phone number |
| **company** | String | yes | Customer's company |
| **address** | String | yes | Customer's address |
| **city** | String | yes | Customer's city |
| **province** | String | yes | Customer's province |
| **zipCode** | String | yes | Customer's ZIP code |
| **countryCode** | String | yes | Customer's country code |
| **birthDate** | String | yes | Customer's birthdate |
| **avatarUrl** | String | yes | Customer's avatar URL |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/flutter/client#clientagreements) | yes | Customer's agreements |
| **attributes** | HashMap<String, Object> | yes | Customer's attributes |
  
**Initializers:**

<pre><code class="language-Dart">ClientAccountUpdateContext({
  this.email,
  this.customId,
  this.uuid,
  this.firstName,
  this.lastName,
  this.sex,
  this.phone,
  this.company,
  this.address,
  this.city,
  this.province,
  this.zipcode,
  this.countrycode,
  this.agreements,
  this.attributes
});</code></pre>


**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-154">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-154-0" data-tab-group="tabgrp-154" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-154-0" data-tab-group="tabgrp-154" data-tab-active="true">

```Dart
ClientAccountUpdateContext clientAccountUpdateContext = ClientAccountUpdateContext(
  email: email,
  firstName: firstName,
  lastName: lastName,
  sex: sex,
  phone: phone,
  company: company,
  address: address,
  city: city,
  zipcode: zipcode,
  countrycode: countrycode,
  province: province);
```

</div>
</div>


<!-- reusable-table-boundary -->

---
---

### ClientAccountRegisterContext
<!-- reusable-table-boundary -->

**Declared In:**  
lib/model/client/client_account_register_context.dart  
  
**Related To:**  
[ClientSex](/developers/mobile-sdk/class-reference/flutter/client#clientsex)  
[ClientAgreements](/developers/mobile-sdk/class-reference/flutter/client#clientagreements)  
  
**Declaration:**

<pre><code class="language-Dart">class ClientAccountRegisterContext</code></pre>


**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **email** | String | no | Customer's email |
| **password** | String | no | Customer's password |
| **firstName** | String | yes | Customer's first name |
| **lastName** | String | yes | Customer's last name |
| **customId** | String | yes | Customer's custom ID |
| **sex** | [ClientSex](/developers/mobile-sdk/class-reference/flutter/client#clientsex) | yes | Customer's sex |
| **phone** | String | yes | Customer's phone |
| **company** | String | yes | Customer's company |
| **address** | String | yes | Customer's address |
| **city** | String | yes | Customer's city |
| **province** | String | yes | Customer's province code |
| **zipCode** | String | yes | Customer's ZIP code |
| **countryCode** | String | yes | Customer's country code |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/flutter/client#clientagreements) | yes | Customer's agreements |
| **attributes** | HashMap<String, Object> | yes | Customer's attributes |
  
**Initializers:**


<pre><code class="language-Dart">ClientAccountRegisterContext({
  required this.email,
  required this.password,
  this.firstName,
  this.lastName,
  this.sex,
  this.phone,
  this.company,
  this.address,
  this.city,
  this.zipcode,
  this.countrycode,
  this.province,
  this.uuid,
  this.customId,
  this.agreements,
  this.attributes
})</code></pre>

  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-155">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-155-0" data-tab-group="tabgrp-155" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-155-0" data-tab-group="tabgrp-155" data-tab-active="true">

```Dart
ClientAccountRegisterContext clientAccountRegisterContext = ClientAccountRegisterContext(email: "EMAIL", password: "PASSWORD");
```

</div>
</div>


<!-- reusable-table-boundary -->

---
---

### ClientSimpleAuthenticationData
<!-- reusable-table-boundary -->

**Declared In:**  
lib/model/client/client_simple_authentication_data.dart
  
**Related To:**  
[ClientSex](/developers/mobile-sdk/class-reference/flutter/client#clientsex)  
[ClientAgreements](/developers/mobile-sdk/class-reference/flutter/client#clientagreements)  
  
**Declaration:**  

<pre><code class="language-Dart">class ClientSimpleAuthenticationData</code></pre>


**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **email** | String | yes | Customer's email |
| **phone** | String | yes | Customer's phone |
| **customId** | String | yes | Customer's custom ID |
| **uuid** | String | yes | Customer's UUID |
| **firstName** | String | yes | Customer's first name |
| **lastName** | String | yes | Customer's last name |
| **displayName** | String | yes | Customer's display name |
| **sex** | [ClientSex](/developers/mobile-sdk/class-reference/flutter/client#clientsex) | yes | Customer's sex |
| **company** | String | yes | Customer's company |
| **address** | String | yes | Customer's address |
| **city** | String | yes | Customer's city |
| **province** | String | yes | Customer's province |
| **zipCode** | String | yes | Customer's ZIP code |
| **countryCode** | String | yes | Customer's country code |
| **birthDate** | String | yes | Customer's birthdate |
| **avatarUrl** | String | yes | Customer's avatar URL |
| **agreements** | [ClientAgreements](/developers/mobile-sdk/class-reference/flutter/client#clientagreements) | yes | Customer's agreements |
| **attributes** | Map<String, Object> | yes | Customer's attributes |
  

**Initializers:**

<pre><code class="language-Dart">ClientAccountUpdateContext({
  this.email,
  this.password,
  this.firstName,
  this.lastName,
  this.sex,
  this.phone,
  this.company,
  this.address,
  this.city,
  this.zipcode,
  this.countrycode,
  this.province,
  this.uuid,
  this.customId,
  this.agreements,
  this.attributes
});</code></pre>


<!-- reusable-table-boundary -->

---
---

### ClientSex
**Declared In:**  
lib/enums/client/client_sex.dart  
  
**Declaration:**  

<pre><code class="language-Dart">enum ClientSex {
  notSpecified('NOT_SPECIFIED'),
  male('MALE'),
  female('FEMALE'),
  other('OTHER');
}</code></pre>


---
---
### ClientAgreements
<!-- reusable-table-boundary -->

**Declared In:**  
lib/model/client/client_agreements.dart  
  
**Declaration:**

<pre><code class="language-Dart">class ClientAgreements</code></pre>


**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **email** | bool | no | Email agreement |
| **sms** | bool | no | SMS agreement |
| **push** | bool | no | Push notifications agreement |
| **bluetooth** | bool | no | Bluetooth agreement |
| **rfid** | bool | no | RFID agreement |
| **wifi** | bool | no | WIFI agreement |

**Initializers:**

<pre><code class="language-Dart">ClientAgreements({this.email, this.sms, this.push, this.bluetooth, this.rfid, this.wifi})</code></pre>


<!-- reusable-table-boundary -->

---
---
### Token
<!-- reusable-table-boundary -->

**Declared In:**  
lib/model/client/token.dart  
  
**Related To:**  
[TokenOrigin](/developers/mobile-sdk/class-reference/flutter/client#tokenorigin)  
  
**Declaration:**  

<pre><code class="language-Dart">class Token</code></pre>

  
**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **tokenString** | String | no | Token as a raw string |
| **origin** | [TokenOrigin](/developers/mobile-sdk/class-reference/flutter/client#tokenorigin) | no | Token's origin |
| **expirationDate** | DateTime | no | Token's expiration time |

<!-- reusable-table-boundary -->

---
---
### TokenOrigin
**Declared In:**  
lib/enums/client/token_origin.dart  
  
**Declaration:**  

<pre><code class="language-Dart">enum TokenOrigin {
  synerise('SYNERISE'),
  facebook('FACEBOOK'),
  google('GOOGLE'),
  oauth('OAUTH'),
  apple('APPLE'),
  simpleAuth('SIMPLE_AUTH'),
  anonymous('ANONYMOUS'),
  unknown('UNKNOWN');
}</code></pre>


---
---

### ClientConditionalAuthResult
<!-- reusable-table-boundary -->

**Declared In:**  
lib/model/client/client_conditional_auth_result.dart
    
**Declaration:**

<pre><code class="language-Dart">class ClientConditionalAuthResult</code></pre>


**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **status** | [ClientConditionalAuthStatus](/developers/mobile-sdk/class-reference/flutter/client#clientconditionalauthstatus) | no | Status of the authentication |
| **conditions** | List<Object> | yes | Authentication conditions |
  

<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties are read-only.

</div></div></div>


<!-- reusable-table-boundary -->

---
---

### ClientConditionalAuthStatus
**Declared In:**  
lib/enums/client/client_conditional_auth_status.dart
  
**Declaration:**

<pre><code class="language-Dart">enum ClientConditionalAuthStatus {
  success('SUCCESS'),
  unauthorized('UNAUTHORIZED'),
  activationRequired('ACTIVATION_REQUIRED'),
  registrationRequired('REGISTRATION_REQUIRED'),
  approvalRequired('APPROVAL_REQUIRED'),
  termsAcceptanceRequired('TERMS_ACCEPTANCE_REQUIRED'),
  mfaRequired('MFA_REQUIRED');
  }</code></pre>

  
**Functions:**
  
Converts from **ClientConditionalAuthStatus** to **String**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-156">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-156-0" data-tab-group="tabgrp-156" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-156-0" data-tab-group="tabgrp-156" data-tab-active="true">

```Dart
String getClientConditionalAuthStatusAsString() {
```

</div>
</div>


---

Converts from **String** to **ClientConditionalAuthStatus**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-157">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-157-0" data-tab-group="tabgrp-157" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-157-0" data-tab-group="tabgrp-157" data-tab-active="true">

```Dart
static ClientConditionalAuthStatus? getClientConditionalAuthStatusFromString(String string) {
```

</div>
</div>


---
---

### ClientSignOutMode
**Declared In:**  
lib/enums/client/client_sign_out_mode.dart

**Declaration:**

<pre><code class="language-Dart">enum ClientSignOutMode {
  signOut('SIGN_OUT'),
  signOutWithSessionDestroy('SIGN_OUT_WITH_SESSION_DESTROY');</code></pre>


**Functions:**
  
Converts from **ClientSignOutMode** to **String**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-158">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-158-0" data-tab-group="tabgrp-158" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-158-0" data-tab-group="tabgrp-158" data-tab-active="true">

```Dart
String clientSignOutModeAsString() {
```

</div>
</div>


---

Converts from **String** to **ClientSignOutMode**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-159">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-159-0" data-tab-group="tabgrp-159" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-159-0" data-tab-group="tabgrp-159" data-tab-active="true">

```Dart
static ClientSignOutMode? getClientSignOutModeFromString(String string) {
```

</div>
</div>





# Customer account management


---
## Get customer account information
---
This method gets a customer’s account information.
  
This method requires customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `API_PERSONAL_INFORMATION_CLIENT_READ` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Related To:**  
[ClientAccountInformation](/developers/mobile-sdk/class-reference/react-native/client#clientaccountinformation)
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public getAccount(onSuccess: (clientAccountInformation: ClientAccountInformation) =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

  
**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.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1198">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1198-0" data-tab-group="tabgrp-1198" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1198-0" data-tab-group="tabgrp-1198" data-tab-active="true">

```JavaScript
Synerise.Client.getAccount(function(clientAccountInformation) {
    //success
}, function(error) {
    //failure
});
```

</div>
</div>


<!-- reusable-table-boundary -->

## Update customer account basic information
---
<!-- reusable-table-boundary -->

This method updates a customer’s account’s basic information (without identification data: uuid, customId, email).
  
This method requires the context object with the customer’s account information. Omitted fields are not modified.
  
This method does not require customer authentication and can be used by anonymous profiles.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.22.0 | 5.21.0 | 0.24.0 | 1.4.0 |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `API_BASIC_INFORMATION_CLIENT_UPDATE` permission from the **Client** group.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Related To:**  
[ClientAccountBasicInformationUpdateContext](/developers/mobile-sdk/class-reference/react-native/client#clientaccountupdatebasicinformationcontext)
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public updateAccountBasicInformation(context: ClientAccountBasicInformationUpdateContext, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **context** | [ClientAccountBasicInformationUpdateContext](/developers/mobile-sdk/class-reference/react-native/client#clientaccountupdatebasicinformationcontext) | yes | - | Object with customer’s first name, phone, and other optional data |
| **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:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1199">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1199-0" data-tab-group="tabgrp-1199" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1199-0" data-tab-group="tabgrp-1199" data-tab-active="true">

```JavaScript
let context = new ClientAccountBasicInformationUpdateContext();
context.firstName = 'John';
context.lastName = 'Rise';
context.displayName = 'John Rise';
context.sex = ClientSex.Male;
context.phone = '123456789';
context.birthDate = '1989-08-03';
context.company = 'Synerise';
context.address = 'Marszałkowska';
context.city = 'Warszawa';
context.province = 'Mazowieckie';
context.zipCode = '00-000';
context.countryCode = '+48';
context.agreements = new ClientAgreements({
    email: true,
    sms: true,
    push: true,
    bluetooth: true,
    rfid: true,
    wifi: true
});
context.attributes = { ATTRIBUTE_1: 'ATTRIBUTE_1' }

Synerise.Client.updateAccountBasicInformation(context, function() {
  // success
}, function(error) {
  // failure
})
```

</div>
</div>


<!-- reusable-table-boundary -->

## Update customer account information
---
This method updates a customer’s account information.
  
This method requires the context object with the customer’s account information. Omitted fields are not modified.
  
This method requires customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `API_PERSONAL_INFORMATION_CLIENT_UPDATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Related To:**  
[ClientAccountUpdateContext](/developers/mobile-sdk/class-reference/react-native/client#clientaccountupdatecontext)
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public updateAccount(context: ClientAccountUpdateContext, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **context** | [ClientAccountUpdateContext](/developers/mobile-sdk/class-reference/react-native/client#clientaccountupdatecontext) | yes | - | Object with customer's email, password, and other optional data |
| **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:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1200">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1200-0" data-tab-group="tabgrp-1200" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1200-0" data-tab-group="tabgrp-1200" data-tab-active="true">

```JavaScript
let context = new ClientAccountUpdateContext();
context.email = 'hello@synerise.com';
context.phone = '123456789';
context.customId = '000111';
context.firstName = 'John';
context.lastName = 'Rise';
context.displayName = 'John Rise';
context.sex = ClientSex.Male;
context.birthDate = '1989-08-03';
context.company = 'Synerise';
context.address = 'Marszałkowska';
context.city = 'Warszawa';
context.province = 'Mazowieckie';
context.zipCode = '00-000';
context.countryCode = '+48';
context.agreements = new ClientAgreements({
    email: true,
    sms: true,
    push: true,
    bluetooth: true,
    rfid: true,
    wifi: true
});
context.attributes = { ATTRIBUTE_1: 'ATTRIBUTE_1' }

Synerise.Client.updateAccount(context, function() {
  // success
}, function(error) {
  // failure
})
```

</div>
</div>


<!-- reusable-table-boundary -->

## Change customer's account password
---
This method changes a customer’s password.
  
This method requires customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 403 status code if the provided old password is invalid.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CHANGE_PASSWORD_CLIENT_UPDATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public changePassword(oldPassword: string, newPassword: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **newPassword** | string | yes | - | Customer's new password |
| **oldPassword** | string | yes | - | Customer's old password |
| **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:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1201">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1201-0" data-tab-group="tabgrp-1201" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1201-0" data-tab-group="tabgrp-1201" data-tab-active="true">

```JavaScript
let newPassword = "NEW_PASSWORD";
let oldPassword = "OLD_PASSWORD";

Synerise.Client.changePassword(newPassword, oldPassword, function() {
  // success
}, function(error) {
  // failure
});
```

</div>
</div>


<!-- reusable-table-boundary -->

## Request password reset for customer account
---
This method requests a customer’s password reset with email. The customer will receive a token to the provided email address. That token is then used for the confirmation of password reset.
  
This method requires the customer’s email.
  
This method is a global operation and doesn't require customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_PASSWORD_RESET_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public requestPasswordReset(email: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | string | yes | - | Customer's email |
| **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:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1202">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1202-0" data-tab-group="tabgrp-1202" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1202-0" data-tab-group="tabgrp-1202" data-tab-active="true">

```JavaScript
Synerise.Client.requestPasswordReset("EMAIL", function() {
  // success
}, function(error) {
  // failure
});
```

</div>
</div>


<!-- reusable-table-boundary -->

## Confirm password reset for customer account
---
This method confirm a customer’s password reset with the new password and token provided by password reset request.  
  
This method requires the customer’s new password and the confirmation token received by e-mail.
  
This method is a global operation and doesn't require customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_PASSWORD_RESET_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public confirmPasswordReset(password: string, token: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **password** | string | yes | - | Customer's new password |
| **token** | string | yes | - | Customer's token provided in an email |
| **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:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1203">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1203-0" data-tab-group="tabgrp-1203" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1203-0" data-tab-group="tabgrp-1203" data-tab-active="true">

```JavaScript
Synerise.Client.confirmPasswordReset("PASSWORD", "TOKEN", function() {
  // success
}, function(error) {
  // failure
});
```

</div>
</div>


<!-- reusable-table-boundary -->

## Request email change for customer account
---
This method requests a customer's email change.
  
This method is a global operation and doesn't require customer authentication.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 403 status code if the provided token or the password is invalid.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CHANGE_EMAIL_CLIENT_UPDATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public requestEmailChange(email: string, password: string | null, externalToken: string | null, authID: string | null, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | string | yes | - | Customer's new email |
| **password** | string | yes | - | Customer's password |
| **externalToken** | AnyObject | no | - | Customer's token (if OAuth, Facebook, and so on) |
| **authID** | String | no | - | Optional identifier of authorization |
| **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:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1204">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1204-0" data-tab-group="tabgrp-1204" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1204-0" data-tab-group="tabgrp-1204" data-tab-active="true">

```JavaScript
Synerise.Client.requestEmailChange("EMAIL", "PASSWORD", function() {
  // success
}, function(error) {
  // failure
});
```

</div>
</div>


<!-- reusable-table-boundary -->

## Confirm email change for customer account
---
This method confirms an email change.
  
This method is a global operation and doesn't require customer authentication.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 403 status code if the provided token is invalid.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CHANGE_EMAIL_CLIENT_UPDATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public confirmEmailChange(token: string, newsletterAgreement: Boolean, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **token** | string | yes | - | Customer's token provided in an email |
| **newsletterAgreement** | boolean | yes | - | Agreement for sending newsletters to the provided email |
| **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:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1205">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1205-0" data-tab-group="tabgrp-1205" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1205-0" data-tab-group="tabgrp-1205" data-tab-active="true">

```JavaScript
Synerise.Client.confirmEmailChange("TOKEN", true, function() {
  // success
}, function(error) {
  // failure
});
```

</div>
</div>


<!-- reusable-table-boundary -->

## Request phone update on customer account
---
This method requests a customer's phone update. A confirmation code is sent to the phone number.
  
This method is a global operation and doesn't require customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `API_PERSONAL_PHONE_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public requestPhoneUpdate(phone: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **phone** | string | yes | - | Customer's new phone number |
| **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:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1206">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1206-0" data-tab-group="tabgrp-1206" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1206-0" data-tab-group="tabgrp-1206" data-tab-active="true">

```JavaScript
Synerise.Client.requestPhoneUpdate("PHONE", function() {
  // success
}, function(error) {
  // failure
});
```

</div>
</div>


<!-- reusable-table-boundary -->

## Confirm phone update on customer account
---
This method confirms a phone number update. This action requires the new phone number and confirmation code as parameters.
  
This method is a global operation and doesn't require customer authentication.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 403 status code if the provided UUID does not exist or the password is invalid.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `API_PERSONAL_PHONE_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public confirmPhoneUpdate(phone: string, confirmationCode: string, smsAgreement: Boolean, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **phone** | string | yes | - | New phone number |
| **confirmationCode** | string | yes | - | A confirmation code received by a text message |
| **smsAgreement** | boolean | yes | - | Agreement for sending SMS to the provided number |
| **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:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1207">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1207-0" data-tab-group="tabgrp-1207" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1207-0" data-tab-group="tabgrp-1207" data-tab-active="true">

```JavaScript
Synerise.Client.confirmPhoneUpdate("PHONE", "CONFIRMATION_CODE", true, function() {
  // success
}, function(error) {
  // failure
});
```

</div>
</div>


<!-- reusable-table-boundary -->

## Delete customer account by Identity Provider
---
This method deletes a customer's account.
  
This method requires customer authentication.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

HTTP 403 status code is returned if the provided password or token is invalid.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CLIENT_DELETE`, `SAUTH_OAUTH_CLIENT_DELETE`, `SAUTH_FACEBOOK_CLIENT_DELETE`, `SAUTH_APPLE_CLIENT_DELETE` permissions from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Related To:**  
[ClientIdentityProvider](/developers/mobile-sdk/class-reference/react-native/client#clientidentityprovider)
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public deleteAccountByIdentityProvider(clientAuthFactor: string, clientIdentityProvider: ClientIdentityProvider, authID: string | null, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **clientAuthFactor** | string | yes | - | Token retrieved from provider |
| **clientIdentityProvider** | [ClientIdentityProvider](/developers/mobile-sdk/class-reference/react-native/client#clientidentityprovider) | yes | - | Provider of your token |
| **authID** | string | no | null | Optional identifier of authorization |
| **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.

<!-- reusable-table-boundary -->

## Deprecated methods

### Delete customer account
---
<!-- reusable-table-boundary -->

This method deletes a customer's account.
  
This method requires customer authentication.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.6.11 | 3.6.13 | 0.9.12 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.6.19 | 3.6.19 | 0.14.0 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | n/a | n/a |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 403 status code is returned if the provided password is invalid.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CLIENT_DELETE` permission from the **Client** group.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public deleteAccount(password: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **password** | string | yes | - | Customer's password |
| **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:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1208">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1208-0" data-tab-group="tabgrp-1208" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1208-0" data-tab-group="tabgrp-1208" data-tab-active="true">

```JavaScript
let password = "PASSWORD";

Synerise.Client.deleteAccount(password, function(token) {
  // success
}, function(error) {
  // failure
});
```

</div>
</div>


<!-- reusable-table-boundary -->

### Delete customer account by OAuth
---
<!-- reusable-table-boundary -->

This method deletes a customer's account by OAuth.
  
This method requires customer authentication.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.6.11 | 3.6.13 | 0.9.12 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.6.19 | 3.6.19 | 0.14.0 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | n/a | n/a |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CLIENT_DELETE` and `SAUTH_OAUTH_CLIENT_DELETE` permissions from the **Client** group.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public deleteAccountByOAuth(accessToken: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **accessToken** | string | yes | - | OAuth Access Token |
| **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:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1209">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1209-0" data-tab-group="tabgrp-1209" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1209-0" data-tab-group="tabgrp-1209" data-tab-active="true">

```JavaScript
Synerise.Client.deleteAccountByOAuth(accessToken, function(token) {
  // success
}, function(error) {
  // failure
});
```

</div>
</div>


<!-- reusable-table-boundary -->

### Delete customer account by Facebook
---
<!-- reusable-table-boundary -->

This method deletes a customer's account by Facebook.
  
This method requires customer authentication.

| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.3.8 | 3.3.0 | 0.9.12 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.6.19 | 3.6.19 | 0.14.0 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | n/a | n/a |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CLIENT_DELETE` and `SAUTH_FACEBOOK_CLIENT_DELETE` permissions from the **Client** group.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public deleteAccountByFacebook(facebookToken: string, onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **facebookToken** | string | yes | - | Facebook Access Token |
| **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:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1210">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1210-0" data-tab-group="tabgrp-1210" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1210-0" data-tab-group="tabgrp-1210" data-tab-active="true">

```JavaScript
Synerise.Client.deleteAccountByFacebook(facebookToken, function(token) {
  // success
}, function(error) {
  // failure
});
```

</div>
</div>


<!-- reusable-table-boundary -->


# React Native

## Installation and configuration (React Native)

In this article, you will find out how to install and initialize the Synerise SDK in a React Native mobile application. While performing the actions from this guide, keep the presented order presented.


<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The [Settings](/developers/mobile-sdk/settings#pre-initialization-settings) article contains additional information about SDK behaviors you may need prior to configuration.

</div></div></div>
 


### Requirements
---
You need:  
* Access to a [workspace](/docs/settings/workspace)
* A Profile [API Key](/docs/settings/tool/api#adding-api-keys)  
  When creating the API key, use allowlisting or denylisting to only allow the events you intend to use.

#### Android {id=requirements-android}

* Recommended environment:
  - Minimum Android SDK version - 24
  - Supported targetSDKVersion - 34

#### iOS {id=requirements-ios}

* Recommended environment:
    - Xcode 16
    - iOS SDK 18
* Target deployment:
    - **iOS 13.0+** for SDK versions 1.0.0 and higher
    - **iOS 9.0+** for SDK versions lower than 1.0.0


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Bitcode is not supported in SDK version 1.0.0 and higher. Xcode ignores bitcode.

</div></div></div>
 

### Setting up Android
---

1. Install the module with npm:
   
   <pre><code class="language-plaintext">npm install react-native-synerise-sdk --save</code></pre>
  
2. Install dependencies:
    - **React Native 0.60 or lower:** In your `android` build.gradle top-level build file, add:
      
      <pre><code class="language-groovy">...
          allprojects {
              repositories {
                  google()
                  jcenter()
                  maven { url 'https://pkgs.dev.azure.com/Synerise/AndroidSDK/_packaging/prod/maven/v1' }
              }
          }</code></pre>

    - **React Native newer than 0.60**: Link the native dependency:  
      
      <pre><code class="language-plaintext">react-native link react-native-synerise-sdk</code></pre>
  
1. **If you DON'T use autolinking**: In your app's `build.gradle` file, add the following dependency: `implementation 'com.synerise.sdk.react:react-native-synerise-sdk:RN_SDK_VERSION'`  
    where `RN_SDK_VERSION` is the SDK version. You can check the latest version in our [Github repository](https://github.com/Synerise/react-native-synerise-sdk/blob/master/CHANGELOG.md).  
    Doing this together with autolinking causes a build error.
2. In the app's main class, to your list of packages, add `RNSyneriseSdkPackage`
  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-623">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-623-0" data-tab-group="tabgrp-623" data-tab-active="true">Java</button></div>

<div class="tab-panel" data-tab-id="tabgrp-623-0" data-tab-group="tabgrp-623" data-tab-active="true">

```Java
@Override
protected List<ReactPackage> getPackages() {
  @SuppressWarnings("UnnecessaryLocalVariable")
  List<ReactPackage> packages = new PackageList(this).getPackages();
  packages.add(new RNSyneriseSdkPackage());;

  return packages;
}
```

</div>
</div>


### Setting up iOS
---


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Starting from React Native 0.60, CocoaPods is the default integration approach for React Native iOS projects.

</div></div></div>


1. Install the module with npm:
   
   <pre><code class="language-plaintext">npm install react-native-synerise-sdk --save</code></pre>
  
2. Install dependencies:  
    - **React Native 0.60 or lower**: Install the native dependencies by using CocoaPods from your `ios` directory:
    
      <pre><code class="language-plaintext">pod install</code></pre>
  
    - **React Native newer than 0.60**: 
      1. Link the native dependency.
         <pre><code class="language-plaintext">react-native link react-native-synerise-sdk</code></pre>
  
      1. Install from your iOS:  
      
         <pre><code class="language-plaintext">pod install --repo-update</code></pre>

1. In your `ios/Podfile`, add the following dependency: `pod 'react-native-synerise-sdk', :path => '../node_modules/react-native-synerise-sdk'`  
    **Result**: Your Podfile looks as follows:
    
   <pre><code class="language-ruby">target 'YourTarget' do

       # Pods for your target
       pod 'React', :path =&gt; '../node_modules/react-native/'
       pod 'React-Core', :path =&gt; '../node_modules/react-native/React'
       # ... other React dependencies

       # Add react-native-synerise-sdk
       pod 'react-native-synerise-sdk', :path =&gt; '../node_modules/react-native-synerise-sdk'

       use_native_modules!

       end</code></pre>

3. From your `ios` directory, run `pod install`


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

If you prefer linking manually, check [React Native - Linking Libraries](https://reactnative.dev/docs/linking-libraries-ios/#manual-linking) to link your libraries that contain native code.

</div></div></div>


### Initialization
---

When you use the **react-native-synerise-sdk** module, use the following native **Synerise SDK** frameworks: 
- [Android](/developers/mobile-sdk/installation-and-configuration/android)  
- [iOS](/developers/mobile-sdk/installation-and-configuration/ios)

#### Importing Synerise SDK

You will need to import the **Synerise** object from the **react-native-synerise-sdk** module.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-624">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-624-0" data-tab-group="tabgrp-624" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-624-0" data-tab-group="tabgrp-624" data-tab-active="true">

```JavaScript
import { Synerise } from 'react-native-synerise-sdk';
```

</div>
</div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

You must always import suitable objects from the **react-native-synerise-sdk** module into the files that contain the code that relates to the Synerise SDK.

</div></div></div>


#### Basic initialization

Initialize the Synerise SDK and provide the [Profile API Key](/docs/settings/tool/api).  
  
You may initialize it wherever you want and when you need.  


<div class="content-tabs code-tabs" data-tab-group="tabgrp-625">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-625-0" data-tab-group="tabgrp-625" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-625-0" data-tab-group="tabgrp-625" data-tab-active="true">

```JavaScript
Synerise.Initializer()
  .withApiKey('YOUR_PROFILE_API_KEY') // 1
  .withRequestValidationSalt('YOUR_REQUEST_VALIDATION_SALT') // 2
  .withDebugModeEnabled(false) // 3
  .withCrashHandlingEnabled(true) // 4
  .init();
```

</div>
</div>


1. `.withApiKey('YOUR_PROFILE_API_KEY')` - Sets Profile API Key for Synerise SDK initialization.
2. `.withRequestValidationSalt('YOUR_REQUEST_VALIDATION_SALT')` - Sets salt string for request validation.
3. `.withDebugModeEnabled(false)` - Enables debug mode. See [Debug mode](/developers/mobile-sdk/installation-and-configuration/react-native#debug-mode) section for more information.
4. `.withCrashHandlingEnabled(true)` - Enables crash handling. Synerise SDK sends a crash event automatically when an uncaught exception occurs.

#### Initialization with custom API environment

You can change the base URL of the API for on-premise installations.  

Use the following initialization method:


<div class="content-tabs code-tabs" data-tab-group="tabgrp-626">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-626-0" data-tab-group="tabgrp-626" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-626-0" data-tab-group="tabgrp-626" data-tab-active="true">

```JavaScript
Synerise.Initializer()
  .withApiKey('YOUR_PROFILE_API_KEY')
  .withBaseUrl("YOUR_API_BASE_URL")
  .init();
```

</div>
</div>


#### Advanced initialization

This is an example of advanced initialization with:
- custom API base URL for on-premise installations
- request validation salt configured
- debug mode enabled
- crash handling enabled
- most settings options available
- initialization listeners set


<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Secure sensitive keys (for example, `clientApiKey` and `requestValidationSalt`) with mechanisms like string obfuscation or encryption.

</div></div></div>



<div class="content-tabs code-tabs" data-tab-group="tabgrp-627">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-627-0" data-tab-group="tabgrp-627" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-627-0" data-tab-group="tabgrp-627" data-tab-active="true">

```JavaScript
Synerise.Initializer()
  .withBaseUrl("YOUR_API_BASE_URL")
  .withApiKey('YOUR_PROFILE_API_KEY')
  .withRequestValidationSalt('YOUR_REQUEST_VALIDATION_SALT')
  .withDebugModeEnabled(true)
  .withCrashHandlingEnabled(true)
  .withSettings({
    sdk: {
      enabled: true,
      minTokenRefreshInterval: 5000,
      shouldDestroySessionOnApiKeyChange: true
    },
    notifications: {
      enabled: true,
      encryption: false,
    },
    injector: {
      automatic: true,
    },
    tracker: {
      isBackendTimeSyncRequired: true,
      minBatchSize: 20,
      maxBatchSize: 30,
      autoFlushTimeout: 60
    }
  })
  .init();

Synerise.onReady(function() {
  // This function is called when Synerise is fully initialized and ready.
});

Synerise.onError(function(error) {
  // This function is called when an error occurs during Synerise initialization.
});
```

</div>
</div>


### Debug mode
---

You can enable debug logs for Synerise SDK by using the `.withDebugModeEnabled(true)` method in `Synerise.Initializer` when you initialize the SDK.


<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Do not use debug mode in a release version of your application.

</div></div></div>


You can receive logs about:
- **Core**: push notifications
- **Tracker**: auto-tracked events, declarative events, sending process
- **Client**: customer state, authorization
- **Injector**: campaigns
- **Promotions**: promotions, vouchers
- **Content**: content widget, documents, recommendations

### Main Synerise listeners
---

You can handle Synerise SDK initialization result by two listener methods:
- `Synerise.onReady()` - This method is called when Synerise is initialized. 
- `Synerise.onError(error: Error)` - This method is called when an error occurs during Synerise initialization.


You can specify your custom action when a customer clicks a simple push, banner or walkthrough. Synerise SDK implements two main actions that a customer may invoke - open URL and Deeplink:
- `IInjectorListener.onOpenUrl(url: string)` - This method is called when Synerise handles the open URL action from campaign activities.
- `IInjectorListener.onDeepLink(deepLink: string)` - This method is called when Synerise handles the deeplink action from campaign activities.


  <div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

  For more information about handling actions from the Synerise SDK, see the [Campaigns](/developers/mobile-sdk/campaigns/action-handling#handling-actions-from-campaigns-in-react-native) section.

  </div></div></div>


  When you want to deal with Push Notifications:  
- `INotificationsListener.onRegistrationToken?(token: string)` - This method is called when a native part of the application passes a registration token.  
- `INotificationsListener.onRegistrationRequired?()` - This method is called when Synerise needs registration for Push Notifications. 
- `INotificationsListener.onNotification(payload: object)` - This method is called when a native part of the application passes a notification payload. 


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

- For more information about notifications in Android SDK, see [Configuring push notifications](/developers/mobile-sdk/configuring-push-notifications/android) section.
- For more information about notifications in iOS SDK, see [Configuring push notifications](/developers/mobile-sdk/configuring-push-notifications/ios) section.
- For more information about SDK listeners and delegates, see [Listeners and delegates](/developers/mobile-sdk/listeners-and-delegates/react-native-listeners) section.

</div></div></div>





# OAuth


This article contains instruction on authenticating a customer in a mobile application with your backend by an OAuth-like method. Prepare your backend for this solution and then you perform part of the configuration on a user interface in the Synerise platform (`app.synerise.com`). 


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This is the recommended authentication method.

</div></div></div>


<figure><img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/docs/settings/_gfx/oauth-diagram.png" class="full" alt="OAuth diagram"><figcaption>OAuth process diagram </figcaption></figure>

Additionally, in the Synerise platform (`app.synerise.com`) you can define the following settings:
- [Assignment of loyalty card](/docs/settings/tool/iam-for-apps/general#loyalty-card-assignment)
- [JWT longevity](/docs/settings/tool/iam-for-apps/general#jwt-lifetime)
- [Custom ID overwriting](/docs/settings/tool/iam-for-apps/general#custom-id-overwriting)
- [External ID overwriting](/docs/settings/tool/iam-for-apps/general#external-id-overwriting)


## Logic explained
---

The authentication process works in the following way:

1. A customer sign-in to the application generates an authentication request to your backend.
2. Your backend provides the application with an access token.
3. The access token is passed to Synerise by using the following methods:
4. Synerise passes that access token:
    - if the access token is JWT, to external JWK service for validation
    - if the access token isn't JWT, back to your backend in order to check if it's valid.
5. In response:
   - If authentication is successful, Synerise receives customer information such as the email, first name, last name, or other details* (the data can be mapped to fields in our system). For more information, check our [guide](/docs/settings/tool/iam-for-apps/oauth).
   - If the access token is not valid, the response type is different than HTTP 2xx.
6. If the authentication was successful, Synerise provides the application with our JWT access token for the customer (if this the first time this customer is authenticated, they are also registered with the provided information).

*You can declare on user interface in Synerise if you want to update the customer's data with each login or only during the first log-in.


## Authentication methods
---


 
<div class="admonition admonition-tip"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M9.663 17h4.673M12 3v1m6.364 1.636l-.707.707M21 12h-1M4 12H3m3.343-5.657l-.707-.707m2.828 9.9a5 5 0 117.072 0l-.548.547A3.374 3.374 0 0014 18.469V19a2 2 0 11-4 0v-.531c0-.895-.356-1.754-.988-2.386l-.548-.547z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Conditional authentication lets you verify if a customer exists. This way, you can display screens with agreements or processes necessary for the first log-in.

</div></div></div>


| OS           | Method                                                                                                                                                                                                                                                                                                                                                                                                                             |
|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Android      | - [Client.authenticate(token, provider, agreements, attributes, authId)](/developers/mobile-sdk/method-reference/android/client-authentication#authenticate-customer-by-identityprovider) <br> - [Client.authenticateConditionally(token, provider, agreements, attributes, authId)](/developers/mobile-sdk/method-reference/android/client-authentication#authenticate-customer-conditionally-by-identityprovider) |
| iOS          | - [Client.authenticate(token:clientIdentityProvider:authID:context:success:failure:)](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-conditionally-by-identityprovider) <br> - [Client.authenticateConditionally(token:clientIdentityProvider:authID:context:success:failure:)](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-conditionally-by-identityprovider) |
| React Native | - [Synerise.Client.authenticate(token, clientIdentityProvider, authID, context, onSuccess, onError)](/developers/mobile-sdk/method-reference/react-native/client-authentication#authenticate-customer-by-identityprovider) <br> - [Synerise.Client.authenticateConditionally(token, clientIdentityProvider, authID context, onSuccess, onError)](/developers/mobile-sdk/method-reference/react-native/client-authentication#authenticate-customer-conditionally-by-identityprovider) |
| Flutter      | - [Synerise.client.authenticate(clientAuthContext, clientIdentityProvider, token)](/developers/mobile-sdk/method-reference/flutter/client-authentication#authenticate-customer-by-identityprovider)) |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authId/authID** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>


## Other methods
---

### Check if a customer is signed in

This method checks if a customer is signed in through oAuth, Facebook, Sign in with Apple, or RaaS


<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This method returns `false` if a customer is authenticated through [Simple Profile Authentication](/developers/mobile-sdk/user-identification-and-authorization/simple-authentication).

</div></div></div>


| OS           | Method                                                                                                                                    |
|--------------|-------------------------------------------------------------------------------------------------------------------------------------------|
| Android      | [Client.isSignedIn()](/developers/mobile-sdk/method-reference/android/client-authentication#check-if-a-customer-is-signed-in-via-raas-oauth-facebook-apple)                |
| iOS          | [Client.isSignedIn()](/developers/mobile-sdk/method-reference/ios/client-authentication#check-if-a-customer-is-signed-in-via-raas-oauth-facebook-apple) |
| React Native | [Synerise.Client.isSignedIn()](/developers/mobile-sdk/method-reference/react-native/client-authentication#check-if-a-customer-is-signed-in-via-raas-oauth-facebook-apple)       |
| Flutter | [Synerise.client.isSignedIn()](/developers/mobile-sdk/method-reference/flutter/client-authentication#check-if-a-customer-is-signed-in-via-raas-oauth-facebook-apple)      |

### Customer sign out
If you want to provide the customer with a logout feature in your application, use this method. The method terminates the JWT token and ends the customer session.

| OS           | Method                                                                                                                |
|--------------|-----------------------------------------------------------------------------------------------------------------------|
| Android      | [Client.signOut()](/developers/mobile-sdk/method-reference/android/client-authentication#sign-out-customer)               |
| iOS          | [Client.signOut()](/developers/mobile-sdk/method-reference/ios/client-authentication#sign-out-customer)                     |
| React Native | [Synerise.Client.signOut()](/developers/mobile-sdk/method-reference/react-native/client-authentication#sign-out-a-customer) |
| Flutter | [Synerise.client.signOut()](/developers/mobile-sdk/method-reference/flutter/client-authentication#sign-out-a-customer) |

## What's next
---
When the customer's is signed in, you can implement [profile management methods](/developers/mobile-sdk/user-identification-and-authorization/identification-and-user-management#profile-management-methods) and [session management methods](/developers/mobile-sdk/user-identification-and-authorization/session-management).




# Events


### Event
Main event abstract class for inheriting classes.
  

<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This is an abstract class and it is not meant to be instantiated directly. You should use concrete `RecommendationEvent` subclasses instead.

</div></div></div>

  
**Declared In:**  
lib/classes/events/Event.js  
  
**Declaration:**  

<pre><code class="language-TypeScript">abstract class Event</code></pre>

  
**Initializers:**

<pre><code class="language-TypeScript">constructor(type: string, label: string, action: string | null, parameters: object)</code></pre>


---
---

### CustomEvent

<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

DO NOT send `transaction.charge` events as custom events.<br>
Transactions must be tracked with these endpoints:
- [`/v4/transactions`](https://hub.synerise.com/api-reference/data-management#tag/Events/operation/CreateATransaction) (single transaction)
- [`/v4/transactions/batch`](https://hub.synerise.com/api-reference/data-management#tag/Events/operation/BatchAddOrUpdateTransactions) (multiple transactions)

</div></div></div>

Represents a custom client event.  
  
**Declared In:**  
lib/classes/events/other/CustomEvent.js  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/react-native/events#event)  
  
**Declaration:**  

<pre><code class="language-TypeScript">class CustomEvent extends Event</code></pre>

  
**Initializers:**
  

<pre><code class="language-TypeScript">constructor(label: string, action: string, parameters?: Record&lt;string, any&gt;)</code></pre>


---
---

### PushViewedEvent
Represents a 'client viewed push' event.
  
This event is used for push message interaction tracking.
  
**Declared In:**  
lib/classes/events/push/ViewedPushEvent.js   
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/react-native/events#event)    
  
**Declaration:**

<pre><code class="language-TypeScript">class PushViewedEvent extends Event</code></pre>

  
**Initializers:**

<pre><code class="language-TypeScript">constructor(label: string, parameters?: object)</code></pre>


---
---

### PushClickedEvent
Represents a 'client clicked push' event.
  
This event is used for push message interaction tracking.
  
**Declared In:**  
lib/classes/events/push/ClickedPushEvent.js  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/react-native/events#event)  
  
**Declaration:**

<pre><code class="language-TypeScript">class PushClickedEvent extends Event</code></pre>

  
**Initializers:**

<pre><code class="language-TypeScript">constructor(label: string, parameters?: object)</code></pre>


---
---

### PushCancelledEvent
Represents a 'client viewed push' event.
  
This event is used for push message interaction tracking.
  
**Declared In:**  
lib/classes/events/push/CancelledPushEvent.js  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/react-native/events#event)   
  
**Declaration:**

<pre><code class="language-TypeScript">class PushCancelledEvent extends Event</code></pre>

  
**Initializers:**

<pre><code class="language-TypeScript">constructor(label: string, parameters?: object)</code></pre>


---
---

### CartEvent
Main cart action abstract class for inheriting classes.
  

<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This is an abstract class and it is not meant to be instantiated directly. You should use concrete `CartEvent` subclasses instead.

</div></div></div>

  
**Declared In:**  
lib/classes/events/cart/CartEvent.js  
  
**Inherits From:**
[Event](/developers/mobile-sdk/class-reference/react-native/events#event)  
  
**Declaration:**

<pre><code class="language-TypeScript">class CartEvent extends Event</code></pre>

  
**Initializers:**  

<pre><code class="language-TypeScript">constructor(type: string, label: string, sku: string, finalPrice: UnitPrice, quantity: number, parameters?: object)</code></pre>

  
**Methods:**

This method sets a value for the `name` parameter.

<pre><code class="language-TypeScript">public setName(name: string)</code></pre>


---

This method sets a value for the `category` parameter.

<pre><code class="language-TypeScript">public setCategory(category: string)</code></pre>


---

This method sets values for the `categories` parameter.

<pre><code class="language-TypeScript">public setCategories(categories: string[])</code></pre>


---

This method sets a value for the `offline` parameter.

<pre><code class="language-TypeScript">public setOffline(offline: boolean)</code></pre>


---

This method sets the value of the `regularPrice` parameter.

<pre><code class="language-TypeScript">public setRegularPrice(regularPrice: UnitPrice)</code></pre>


---

This method sets the value of the `discountedPrice` parameter.

<pre><code class="language-TypeScript">public setDiscountedPrice(discountedPrice: UnitPrice)</code></pre>


---

This method sets the value of the `url` parameter.

<pre><code class="language-TypeScript">public setUrl(url: string)</code></pre>


---

This method sets the value of the `producer` parameter (producer can signify a brand of the item).

<pre><code class="language-TypeScript">public setProducer(producer: string)</code></pre>


---
---

### UnitPrice
**Declared In:**  
lib/classes/events/cart/UnitPrice.js  
  
**Declaration:**

<pre><code class="language-TypeScript">class UnitPrice</code></pre>

  
**Initializers:**

<pre><code class="language-TypeScript">constructor(amount: number, currency: string)</code></pre>


---
---

### ProductAddedToCartEvent
Represents a 'client added product to cart' event.
  
**Declared In:**  
lib/classes/events/product/ProductAddedToCartEvent.js  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/react-native/events#event)  
  
**Declaration:**

<pre><code class="language-TypeScript">class ProductAddedToCartEvent extends CartEvent</code></pre>

  
**Initializers:**

<pre><code class="language-TypeScript">constructor(label: string, sku: string, finalPrice: UnitPrice, quantity: number, parameters?: object)</code></pre>


---
---

### ProductRemovedFromCartEvent
Represents a 'client removed product from cart' event.
  
**Declared In:**  
lib/classes/events/cart/RemovedFromCartEvent.js  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/react-native/events#event)  
  
**Declaration:**

<pre><code class="language-TypeScript">class ProductRemovedFromCartEvent extends CartEvent</code></pre>

  
**Initializers:**

<pre><code class="language-TypeScript">constructor(label: string, sku: string, finalPrice: UnitPrice, quantity: number, parameters?: object)</code></pre>


---
---

### ProductViewedEvent
Represents a 'client viewed product' event.
  
**Declared In:**  
lib/classes/events/product/ProductViewEvent.js  

**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/react-native/events#event)  
  
**Declaration:**  

<pre><code class="language-TypeScript">class ProductViewedEvent extends Event</code></pre>

  
**Initializers:**

<pre><code class="language-TypeScript">constructor(label: string, productId: string, name: string, parameters?: object)</code></pre>

  
**Methods:**

This method sets a value for the `category` parameter.

<pre><code class="language-TypeScript">public setCategory(category: string)</code></pre>


---

This method sets the value of the `url` parameter.

<pre><code class="language-TypeScript">public setUrl(url: string)</code></pre>


---
---

### ProductAddedToFavoritesEvent
Represents a 'client added product to favorites' event.
  
**Declared In:**  
lib/classes/events/product/ProductAddedToFavouritesEvent.js  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/react-native/events#event)  
  
**Declaration:**

<pre><code class="language-TypeScript">class ProductAddedToFavouritesEvent extends Event</code></pre>

  
**Initializers:**

<pre><code class="language-TypeScript">constructor(label: string, parameters?: object)</code></pre>


---
---

### LoggedInEvent
Represents a 'client logged in' event.
  
**Declared In:**  
lib/classes/events/auth/LoggedInEvent.js  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/react-native/events#event)  
  
**Declaration:**

<pre><code class="language-TypeScript">class LoggedInEvent extends Event</code></pre>


---
---

### LoggedOutEvent
Represents a 'client logged out' event.
  
**Declared In:**  
lib/classes/events/auth/LoggedOutEvent.js  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/react-native/events#event)  
  
**Declaration:**

<pre><code class="language-TypeScript">class LoggedOutEvent extends Event</code></pre>


---
---

### RegisteredEvent
Represents a 'client registered' event.
  
**Declared In:**  
lib/classes/events/auth/RegisteredEvent.js    
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/react-native/events#event)  
  
**Declaration:**  

<pre><code class="language-TypeScript">class RegisteredEvent extends Event</code></pre>

  
**Initializers:**

<pre><code class="language-TypeScript">constructor(label: string, parameters?: object)</code></pre>


---
---

## RecommendationEvent
Main recommendation abstract class for inheriting classes.
  

<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This is an abstract class and it is not meant to be instantiated directly. You should use concrete `RecommendationEvent` subclasses instead.

</div></div></div>

  
**Declared In:**  
lib/classes/events/recommendation/RecommendationEvent.js    
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/react-native/events#event)    
  
**Declaration:**  

<pre><code class="language-TypeScript">class RecommendationEvent extends Event</code></pre>

  
**Initializers:**

<pre><code class="language-TypeScript">constructor(type: string, label: string, productId: string, name: string, campaignId: string, campaignHash: string, parameters?: object)</code></pre>


---
---

### RecommendationSeenEvent
Represents a 'client saw a recommendation' event.
  
**Declared In:**  
lib/classes/events/recommendation/RecommendationSeenEvent.js   
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/react-native/events#event)  
  
**Declaration:**  

<pre><code class="language-TypeScript">class RecommendationSeenEvent extends RecommendationEvent</code></pre>

  
**Initializers:**  

<pre><code class="language-TypeScript">constructor(label: string, productId: string, name: string, campaignId: string, campaignHash: string, parameters?: object)</code></pre>


---
---

### RecommendationClickEvent
Represents a 'client clicked a recommendation' event.
  
**Declared In:**  
lib/classes/events/recommendation/RecommendationClickEvent.js  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/react-native/events#event)  
[RecommendationEvent](/developers/mobile-sdk/class-reference/react-native/events#recommendationevent)  
  
**Declaration:**

<pre><code class="language-TypeScript">class RecommendationClickEvent extends RecommendationEvent</code></pre>

  
**Initializers:**

<pre><code class="language-TypeScript">constructor(label: string, productId: string, name: string, campaignId: string, campaignHash: string, parameters?: object)</code></pre>


---
---

### VisitedScreenEvent
Represents a 'client visited screen' event.
  
This can be used for mobile screen usage tracking.
  
**Declared In:**  
lib/classes/events/other/VisitedScreenEvent.js  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/react-native/events#event)  
  
**Declaration:**

<pre><code class="language-TypeScript">class VisitedScreenEvent extends Event</code></pre>

  
**Initializers:**

<pre><code class="language-TypeScript">constructor(label: string, parameters?: object)</code></pre>


---
---

### HitTimerEvent
Represents a 'client hit timer' event.
  
This could be used for profiling or activity time monitoring - you can send a `HitTimerEvent` when your client starts doing something and send it once again when they finish, but this time with the different time signature. Then you can use our analytics engine to measure, for example, average activity time.
  
**Declared In:**  
lib/classes/events/other/HitTimerEvent.js  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/react-native/events#event)  

**Declaration:**

<pre><code class="language-TypeScript">class HitTimerEvent extends Event</code></pre>

  
**Initializers:**

<pre><code class="language-TypeScript">constructor(label: string, parameters?: object)</code></pre>


---
---

### SearchedEvent
Represents a 'client searched' event.
  
**Declared In:**  
lib/classes/events/other/SearchedEvent.js   
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/react-native/events#event)  
  
**Declaration:**

<pre><code class="language-TypeScript">class SearchedEvent extends Event</code></pre>

  
**Initializers:**

<pre><code class="language-TypeScript">constructor(label: string, parameters?: object)</code></pre>


---
---

### SharedEvent
Represents a 'client shared' event.
  
**Declared In:**  
lib/classes/events/other/SharedEvent.js  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/react-native/events#event)  
  
**Declaration:**

<pre><code class="language-TypeScript">class SharedEvent extends Event</code></pre>

  
**Initializers:**

<pre><code class="language-TypeScript">constructor(label: string, parameters?: object)</code></pre>


---
---

### AppearedInLocationEvent
Represents a 'client appeared in location' event.
  
**Declared In:**  
lib/classes/events/other/AppearedInLocationEvent.js  
  
**Inherits From:**
[Event](/developers/mobile-sdk/class-reference/react-native/events#event)  
  
**Declaration:**

<pre><code class="language-TypeScript">class AppearedInLocationEvent extends Event</code></pre>

  
**Initializers:**

<pre><code class="language-TypeScript">constructor(label: string, lat: number, lon: number, parameters?: object)</code></pre>




# Events


### Event
<!-- reusable-table-boundary -->

Class model for events.

**Declared In:**  
`com.synerise.sdk.event.Event`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-82">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-82-0" data-tab-group="tabgrp-82" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-82-1" data-tab-group="tabgrp-82">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-82-0" data-tab-group="tabgrp-82" data-tab-active="true">

```Java
public abstract class Event implements Serializable
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-82-1" data-tab-group="tabgrp-82">

```Kotlin
abstract class Event : Serializable
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **eventTime** | Date | no | - | Event time |
| **type** | String | no | - | Event type |
| **action** | String | no | - | Event action |
| **label** | String | no | - | Can't be empty. This value isn't saved in persistent storage and can't be used in Decision or Automation Hubs. It isn't shown on a Profile card. |
| **clientParams** | HashMap<String, Object> | no | - | Profile parameters |
| **params** | HashMap<String, Object> | no | - | Event params |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties above are accessible by using getters.

</div></div></div>


**Initializers:**  

There are no initializers.

**Methods:**  

This method retrieves the value of the `label` parameter.


<pre><code class="language-java">public String getLabel()</code></pre>


---

This method retrieves the value of the `action` parameter.


<pre><code class="language-java">public String getAction()</code></pre>


---

This method retrieves the values of the `clientParams` object.


<pre><code class="language-java">public HashMap&lt;String, Object&gt; getClientParams()</code></pre>


---

This method retrieves the value of the `eventTime` parameter.


<pre><code class="language-java">public Date getEventTime()</code></pre>


---

This method retrieves the value of the `type` parameter.


<pre><code class="language-java">public String getType()</code></pre>


---

This method retrieves the values of the `eventParams` object.


<pre><code class="language-java">public HashMap&lt;String, Object&gt; getParams()</code></pre>


---

<!-- reusable-table-boundary -->

---
---

### CustomEvent


<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

DO NOT send `transaction.charge` events as custom events.<br>
Transactions must be tracked with these endpoints:
- [`/v4/transactions`](https://hub.synerise.com/api-reference/data-management#tag/Events/operation/CreateATransaction) (single transaction)
- [`/v4/transactions/batch`](https://hub.synerise.com/api-reference/data-management#tag/Events/operation/BatchAddOrUpdateTransactions) (multiple transactions)

</div></div></div>


<!-- reusable-table-boundary -->

Class model for _custom_ event.

**Declared In:**  
`com.synerise.sdk.event.model.CustomEvent`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-83">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-83-0" data-tab-group="tabgrp-83" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-83-1" data-tab-group="tabgrp-83">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-83-0" data-tab-group="tabgrp-83" data-tab-active="true">

```Java
public class CustomEvent extends Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-83-1" data-tab-group="tabgrp-83">

```Kotlin
class CustomEvent : Event
```

</div>
</div>



**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **label** | String | no | - | Can't be empty. This value isn't saved in persistent storage and can't be used in Decision or Automation Hubs. It isn't shown on a Profile card. |
| **action** | String | no | - | Event action |
| **params** | TrackerParams | yes | - | Event tracker parameters |

**Initializers:**  

The following constructors are available:


<pre><code class="language-java">public CustomEvent(@NonNull String action, @NonNull String label)</code></pre>



<pre><code class="language-java">public CustomEvent(@NonNull String action, @NonNull String label, @Nullable TrackerParams params)</code></pre>



<pre><code class="language-java">public CustomEvent(@NonNull String type, @NonNull String action, @NonNull String label, @Nullable TrackerParams params)</code></pre>


**Methods:**  

There are no methods.

<!-- reusable-table-boundary -->

---
---

### AppStartedEvent
<!-- reusable-table-boundary -->

Class model for the application started event.

**Declared In:**  
`com.synerise.sdk.event.model.interaction.AppStartedEvent`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-84">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-84-0" data-tab-group="tabgrp-84" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-84-1" data-tab-group="tabgrp-84">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-84-0" data-tab-group="tabgrp-84" data-tab-active="true">

```Java
public class AppStartedEvent extends Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-84-1" data-tab-group="tabgrp-84">

```Kotlin
class AppStartedEvent : Event
```

</div>
</div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This event will be sent every time an application is started.

</div></div></div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **label** | String | no | - | Can't be empty. This value isn't saved in persistent storage and can't be used in Decision or Automation Hub. It isn't shown on a Profile card. |
| **params** | TrackerParams | yes | - | Event tracker parameters |

#### Parameters tracked

| Parameter |  Description |
| --- | --- |
| **currentSDKVersion** | Current SDK version |
| **lastSDKVersion** | Last SDK version |
| **sdkVersionCode** | Current SDK version code |
| **applicationName** | Application name |
| **version** | Application version |
| **appVersionCode** | Application version code |
| **deviceId** | Device ID. Can be null |
| **deviceModel** | Device model |
| **deviceManufacturer** | Device manufacturer |
| **deviceResolution** | Device resolution |
| **deviceType** | Device type |
| **os** | OS type |
| **osVersion** | OS version |
| **osLanguage** | System language |
| **systemPushConsent** | System push agreement |
| **networkType** | Network type |
| **origin** | Origin of SDK |
| **networkCountry** | Country of network |
| **cellType** | Cell type |
| **cellCarrier** | Cell carrier |
| **cellCountry** | Cell country |
| **cellRoaming** | Cell roaming |



**Initializers:**  

The following constructors are available:


<pre><code class="language-java">public AppStartedEvent(@NonNull String label)</code></pre>



<pre><code class="language-java">public AppStartedEvent(@NonNull String label, @Nullable TrackerParams params)</code></pre>



**Methods:**  

There are no methods.

<!-- reusable-table-boundary -->

---
---

### AutoTrackingEvent
Class model for _autotracking_ events.

**Declared In:**  
`com.synerise.sdk.event.model.interaction.AutoTrackingEvent`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-85">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-85-0" data-tab-group="tabgrp-85" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-85-1" data-tab-group="tabgrp-85">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-85-0" data-tab-group="tabgrp-85" data-tab-active="true">

```Java
public class AutoTrackingEvent extends Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-85-1" data-tab-group="tabgrp-85">

```Kotlin
class AutoTrackingEvent : Event
```

</div>
</div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This event is sent only by the Synerise SDK. Sending this event in your application on your own is **not recommended**.

</div></div></div>


**Properties:**  

There are no public properties.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The `screen.interaction` and `screen.view` events are sent by the [auto-tracking module](/developers/mobile-sdk/event-tracking#events-tracked-automatically).

</div></div></div>


**Initializers:**  

There are no public constructors.


**Methods:**  

There are no methods.

---
---

### ViewedPushEvent
<!-- reusable-table-boundary -->

Class model for the `push.view` event.


**Declared In:**  
`com.synerise.sdk.event.model.push.ViewedPushEvent`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-86">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-86-0" data-tab-group="tabgrp-86" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-86-1" data-tab-group="tabgrp-86">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-86-0" data-tab-group="tabgrp-86" data-tab-active="true">

```Java
public class ViewedPushEvent extends Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-86-1" data-tab-group="tabgrp-86">

```Kotlin
class ViewedPushEvent : Event
```

</div>
</div>



**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **label** | String | no | - | Can't be empty. This value isn't saved in persistent storage and can't be used in Decision or Automation Hubs. It isn't shown on a Profile card. |
| **params** | TrackerParams | yes | - | Event tracker parameters |


**Initializers:**  

The following constructors are available:


<pre><code class="language-java">public ViewedPushEvent(@NonNull String label)</code></pre>



<pre><code class="language-java">public ViewedPushEvent(@NonNull String label, @Nullable TrackerParams params)</code></pre>



**Methods:**  

There are no methods.

<!-- reusable-table-boundary -->

---
---

### ClickedPushEvent
<!-- reusable-table-boundary -->

Class model for the `push.click` event.


**Declared In:**  
`com.synerise.sdk.event.model.push.ClickedPushEvent`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-87">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-87-0" data-tab-group="tabgrp-87" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-87-1" data-tab-group="tabgrp-87">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-87-0" data-tab-group="tabgrp-87" data-tab-active="true">

```Java
public class ClickedPushEvent extends Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-87-1" data-tab-group="tabgrp-87">

```Kotlin
class ClickedPushEvent : Event
```

</div>
</div>



**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **label** | String | no | - | Can't be empty. This value isn't saved in persistent storage and can't be used in Decision or Automation Hub. It isn't shown on a Profile card. |
| **params** | TrackerParams | yes | - | Event tracker parameters |


**Initializers:**  

The following constructors are available:


<pre><code class="language-java">public ClickedPushEvent(@NonNull String label)</code></pre>



<pre><code class="language-java">public ClickedPushEvent(@NonNull String label, @Nullable TrackerParams params)</code></pre>



**Methods:**  

There are no methods.

<!-- reusable-table-boundary -->

---
---

### CancelledPushEvent
<!-- reusable-table-boundary -->

Class model for the cancel push event generated.


**Declared In:**  
`com.synerise.sdk.event.model.push.CancelledPushEvent`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-88">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-88-0" data-tab-group="tabgrp-88" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-88-1" data-tab-group="tabgrp-88">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-88-0" data-tab-group="tabgrp-88" data-tab-active="true">

```Java
public class CancelledPushEvent extends Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-88-1" data-tab-group="tabgrp-88">

```Kotlin
class CancelledPushEvent : Event
```

</div>
</div>



**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **label** | String | no | - | Can't be empty. This value isn't saved in persistent storage and can't be used in Decision or Automation Hub. It isn't shown on a Profile card. |
| **params** | TrackerParams | yes | - | Event tracker parameters |


**Initializers:**  

The following constructors are available:


<pre><code class="language-java">public CancelledPushEvent(@NonNull String label)</code></pre>



<pre><code class="language-java">public CancelledPushEvent(@NonNull String label, @Nullable TrackerParams params)</code></pre>



**Methods:**  

There are no methods.

<!-- reusable-table-boundary -->

---
---

### CartEvent
<!-- reusable-table-boundary -->

Class model for the events related to a cart.

**Declared In:**  
`com.synerise.sdk.event.model.products.cart.CartEvent`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-89">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-89-0" data-tab-group="tabgrp-89" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-89-1" data-tab-group="tabgrp-89">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-89-0" data-tab-group="tabgrp-89" data-tab-active="true">

```Java
public abstract class CartEvent extends Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-89-1" data-tab-group="tabgrp-89">

```Kotlin
abstract class CartEvent : Event
```

</div>
</div>


#### Inheriting classes
[AddedToCartEvent](/developers/mobile-sdk/class-reference/ios/events#productaddedtocartevent)
[RemovedFromCartEvent](/developers/mobile-sdk/class-reference/ios/events#productremovedfromcartevent)

**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **type** | String | no | - | Event type |
| **sku** | String | no | - | SKU of the item |
| **label** | String | no | - | Can't be empty. This value isn't saved in persistent storage and can't be used in Decision or Automation Hub. It isn't shown on a Profile card. |
| **finalPrice** | `UnitPrice` | no | - | Final price of the item |
| **quantity** | int | no | - | Quantity of the item |
| **params** | TrackerParams | yes | - | Event tracker parameters |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The following keys: `sku`, `name`, `category`, `categories`, `offline`, `regularUnitPrice`, `discountedUnitPrice`, `finalUnitPrice`, `url`, `producer`, `quantity` are reserved by Synerise for the `params` object.

</div></div></div>



**Initializers:**  


<pre><code class="language-java">CartEvent(@NonNull String type, @NonNull String label, @NonNull String sku, @NonNull UnitPrice finalPrice, int quantity,
              @Nullable TrackerParams params)</code></pre>


**Methods:**  

This method sets a value for the  `name` parameter.


<pre><code class="language-java">public void setName(String name)</code></pre>


---

This method sets a value for the `category` parameter.


<pre><code class="language-java">public void setCategory(String category)</code></pre>


---

This method sets values for the `categories` parameter.


<pre><code class="language-java">public void setCategories(List&lt;String&gt; categories)</code></pre>


---

This method sets a value for the `offline` parameter.


<pre><code class="language-java">public void setOffline(boolean offline)</code></pre>


---

This method sets the value of the `regularPrice` parameter.


<pre><code class="language-java">public void setRegularPrice(UnitPrice regularPrice)</code></pre>


---

This method sets the value of the `discountedPrice` parameter.


<pre><code class="language-java">public void setDiscountedPrice(UnitPrice discountedPrice)</code></pre>


---

This method sets the value of the `url` parameter.


<pre><code class="language-java">public void setUrl(String url)</code></pre>


---

This method sets the value of the `producer` parameter (producer can signify a brand of the item).


<pre><code class="language-java">public void setProducer(String producer)</code></pre>


---

<!-- reusable-table-boundary -->

---
---

### AddedToCartEvent
<!-- reusable-table-boundary -->

Class model for _add to cart_ event.

**Declared In:**  
`com.synerise.sdk.event.model.products.cart.AddedToCartEvent`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-90">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-90-0" data-tab-group="tabgrp-90" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-90-1" data-tab-group="tabgrp-90">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-90-0" data-tab-group="tabgrp-90" data-tab-active="true">

```Java
public class AddedToCartEvent extends CartEvent
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-90-1" data-tab-group="tabgrp-90">

```Kotlin
class AddedToCartEvent : CartEvent
```

</div>
</div>



**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **type** | String | no | - | Event type |
| **sku** | String | no | - | SKU of the product |
| **label** | String | no | - | Can't be empty. This value isn't saved in persistent storage and can't be used in Decision or Automation Hubs. It isn't shown on a Profile card. |
| **finalPrice** | UnitPrice | no | - | Final price of the product |
| **quantity** | int | no | - | Quantity of the product |
| **params** | TrackerParams | yes | - | Event tracker params |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The `"sku"`, `"name"`, `"category"`, `"categories"`, `"offline"` , `"regularUnitPrice"`, `"discountedUnitPrice"`, `"finalUnitPrice"`, `"url"`, `"producer"` , `"quantity"` keys are reserved by Synerise in params.

</div></div></div>



**Initializers:**  

The following constructors are available:


<pre><code class="language-java">public AddedToCartEvent(@NonNull String label, @NonNull String sku, @NonNull UnitPrice finalPrice, int quantity)</code></pre>



<pre><code class="language-java">public AddedToCartEvent(@NonNull String label, @NonNull String sku, @NonNull UnitPrice finalPrice, int quantity,
                            @Nullable TrackerParams params)</code></pre>


**Methods:**  

This method defines the value of the `name` parameter.


<pre><code class="language-java">public void setName(String name)</code></pre>


---

This method defines the value of the `category` parameter.


<pre><code class="language-java">public void setCategory(String category)</code></pre>


---

This method defines the values of the `categories` parameter.


<pre><code class="language-java">public void setCategories(List&lt;String&gt; categories)</code></pre>


---

This method defines the value of the `offline` parameter.

The offline parameter describes whether an event occurred outside website, for example in a cash register.


<pre><code class="language-java">public void setOffline(boolean offline)</code></pre>


---

This method defines the value of the `regularPrice` parameter.


<pre><code class="language-java">public void setRegularPrice(UnitPrice regularPrice)</code></pre>


---

This method defines the value of the `discountedPrice` parameter.


<pre><code class="language-java">public void setDiscountedPrice(UnitPrice discountedPrice)</code></pre>


---

This method defines the value of the `url` parameter.


<pre><code class="language-java">public void setUrl(String url)</code></pre>


---

This method defines the value of the `producer` parameter.

A producer is a manufacturer of the item.


<pre><code class="language-java">public void setProducer(String producer)</code></pre>


---

<!-- reusable-table-boundary -->

---
---

### RemovedFromCartEvent
<!-- reusable-table-boundary -->

Class model for _remove from cart_ event.

**Declared In:**  
`com.synerise.sdk.event.model.products.cart.RemovedFromCartEvent`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-91">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-91-0" data-tab-group="tabgrp-91" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-91-1" data-tab-group="tabgrp-91">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-91-0" data-tab-group="tabgrp-91" data-tab-active="true">

```Java
public class RemovedFromCartEvent extends CartEvent
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-91-1" data-tab-group="tabgrp-91">

```Kotlin
class RemovedFromCartEvent : CartEvent
```

</div>
</div>



**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **type** | String | no | - | Event type |
| **sku** | String | no | - | SKU of the product |
| **label** | String | no | - | Can't be empty. This value isn't saved in persistent storage and can't be used in Decision or Automation Hubs. It isn't shown on a Profile card. |
| **finalPrice** | `UnitPrice` | no | - | Final price of the product |
| **quantity** | int | no | - | Quantity of the product |
| **params** | TrackerParams | yes | - | Event tracker params |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The keys `"sku"`, `"name"`, `"category"`, `"categories"`, `"offline"` , `"regularUnitPrice"`, `"discountedUnitPrice"`, `"finalUnitPrice"`, `"url"`, `"producer"` , `"quantity"` are reserved by Synerise in params.

</div></div></div>



**Initializers:**  

The following constructors are available:


<pre><code class="language-java">public RemovedFromCartEvent(@NonNull String label, @NonNull String sku, @NonNull UnitPrice finalPrice, int quantity)</code></pre>



<pre><code class="language-java">public RemovedFromCartEvent(@NonNull String label, @NonNull String sku, @NonNull UnitPrice finalPrice, int quantity,
                            @Nullable TrackerParams params)</code></pre>


**Methods:**  

This method defines the value of the `name` parameter.


<pre><code class="language-java">public void setName(String name)</code></pre>


---

This method defines the value of the `category` parameter.


<pre><code class="language-java">public void setCategory(String category)</code></pre>


---

This method defines the values of the `categories` parameter.


<pre><code class="language-java">public void setCategories(List&lt;String&gt; categories)</code></pre>


---

This method defines the value of the `offline` parameter.

The offline parameter describes whether an event occurred outside website, for example in a cash register.


<pre><code class="language-java">public void setOffline(boolean offline)</code></pre>


---

This method defines the value of the `regularPrice` parameter.


<pre><code class="language-java">public void setRegularPrice(UnitPrice regularPrice)</code></pre>


---

This method defines the value of the `discountedPrice` parameter.


<pre><code class="language-java">public void setDiscountedPrice(UnitPrice discountedPrice)</code></pre>


---

This method defines the value of the `url` parameter.


<pre><code class="language-java">public void setUrl(String url)</code></pre>


---

This method defines the value of the `producer` parameter.

A producer is a manufacturer of the item.


<pre><code class="language-java">public void setProducer(String producer)</code></pre>


---

<!-- reusable-table-boundary -->

---
---

### ProductEvent
<!-- reusable-table-boundary -->

Class model for _product_ events.

**Declared In:**  
`com.synerise.sdk.event.model.ai.ProductEvent`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-92">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-92-0" data-tab-group="tabgrp-92" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-92-1" data-tab-group="tabgrp-92">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-92-0" data-tab-group="tabgrp-92" data-tab-active="true">

```Java
public class ProductEvent extends Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-92-1" data-tab-group="tabgrp-92">

```Kotlin
class ProductEvent : Event
```

</div>
</div>


#### Inheriting classes
ProductViewEvent

**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **name** | String | no | - | Product name |
| **type** | String | no | - | Event type |
| **productId** | String | no | - | Product ID |
| **label** | String | no | - | Can't be empty. This value isn't saved in persistent storage and can't be used in Decision or Automation Hubs. It isn't shown on a Profile card. |
| **params** | TrackerParams | yes | - | Event tracker params |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The `"productId"`, `"name"`, `"category"`, `"url"` keys are reserved by Synerise in params.

</div></div></div>



**Initializers:**  


<pre><code class="language-java">public ProductEvent(@NonNull String type, @NonNull String label, @NonNull String productId, @NonNull String name,
                        @Nullable TrackerParams params)</code></pre>


**Methods:**  

This method defines the value of the `category` parameter.


<pre><code class="language-java">public void setCategory(String category)</code></pre>


---

This method defines the value of the `url` parameter.


<pre><code class="language-java">public void setUrl(String url)</code></pre>


---

<!-- reusable-table-boundary -->

---
---

### ProductViewEvent
<!-- reusable-table-boundary -->

Class model for _the product view_ event.

**Declared In:**  
`com.synerise.sdk.event.model.ai.ProductViewEvent`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-93">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-93-0" data-tab-group="tabgrp-93" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-93-1" data-tab-group="tabgrp-93">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-93-0" data-tab-group="tabgrp-93" data-tab-active="true">

```Java
public class ProductViewEvent extends ProductEvent
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-93-1" data-tab-group="tabgrp-93">

```Kotlin
class ProductViewEvent : ProductEvent
```

</div>
</div>



**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **name** | String | no | - | Product name |
| **productId** | String | no | - | Product ID |
| **label** | String | no | - | Can't be empty. This value isn't saved in persistent storage and can't be used in Decision or Automation Hubs. It isn't shown on a Profile card. |
| **params** | TrackerParams | yes | - | Event tracker params |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The `"productId"`, `"name"`, `"category"`, `"url"` keys are reserved by Synerise in params.

</div></div></div>



**Initializers:**  

The following constructors are available:


<pre><code class="language-java">public ProductViewEvent(@NonNull String label, @NonNull String productId, @NonNull String name)</code></pre>



<pre><code class="language-java">public ProductViewEvent(@NonNull String label, @NonNull String productId, @NonNull String name,
                            @Nullable TrackerParams params)</code></pre>


**Methods:**  

There are no methods.

<!-- reusable-table-boundary -->

---
---

### AddedToFavoritesEvent
<!-- reusable-table-boundary -->

Class model for _add to favourites_ event.

**Declared In:**  
`com.synerise.sdk.event.model.products.AddedToFavoritesEvent`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-94">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-94-0" data-tab-group="tabgrp-94" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-94-1" data-tab-group="tabgrp-94">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-94-0" data-tab-group="tabgrp-94" data-tab-active="true">

```Java
public class AddedToFavoritesEvent extends Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-94-1" data-tab-group="tabgrp-94">

```Kotlin
class AddedToFavoritesEvent : Event
```

</div>
</div>



**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **label** | String | no | - | Can't be empty. This value isn't saved in persistent storage and can't be used in Decision or Automation Hubs. It isn't shown on a Profile card. |
| **params** | TrackerParams | yes | - | Event tracker params |


**Initializers:**  

The following constructors are available:


<pre><code class="language-java">public AddedToFavoritesEvent(@NonNull String label)</code></pre>



<pre><code class="language-java">public AddedToFavoritesEvent(@NonNull String label, @Nullable TrackerParams params)</code></pre>



**Methods:**  

There are no methods.

<!-- reusable-table-boundary -->

---
---

### LoggedInEvent
<!-- reusable-table-boundary -->

Class model for _Log in_ event.


**Declared In:**  
`com.synerise.sdk.event.model.session.LoggedInEvent`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-95">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-95-0" data-tab-group="tabgrp-95" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-95-1" data-tab-group="tabgrp-95">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-95-0" data-tab-group="tabgrp-95" data-tab-active="true">

```Java
public class LoggedInEvent extends Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-95-1" data-tab-group="tabgrp-95">

```Kotlin
class LoggedInEvent : Event
```

</div>
</div>



**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **label** | String | no | - | Can't be empty. This value isn't saved in persistent storage and can't be used in Decision or Automation Hubs. It isn't shown on a Profile card. |
| **params** | TrackerParams | yes | - | Event tracker params |


**Initializers:**  

The following constructors are available:


<pre><code class="language-java">public LoggedInEvent(@NonNull String label)</code></pre>



<pre><code class="language-java">public LoggedInEvent(@NonNull String label, @Nullable TrackerParams params)</code></pre>



**Methods:**  

There are no methods.

<!-- reusable-table-boundary -->

---
---

### LoggedOutEvent
<!-- reusable-table-boundary -->

Class model for _Log out_ event.


**Declared In:**  
`com.synerise.sdk.event.model.session.LoggedOutEvent`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-96">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-96-0" data-tab-group="tabgrp-96" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-96-1" data-tab-group="tabgrp-96">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-96-0" data-tab-group="tabgrp-96" data-tab-active="true">

```Java
public class LoggedOutEvent extends Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-96-1" data-tab-group="tabgrp-96">

```Kotlin
class LoggedOutEvent : Event
```

</div>
</div>



**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **label** | String | no | - | Can't be empty. This value isn't saved in persistent storage and can't be used in Decision or Automation Hubs. It isn't shown on a Profile card. |
| **params** | TrackerParams | yes | - | Event tracker params |


**Initializers:**  

The following constructors are available:


<pre><code class="language-java">public LoggedOutEvent(@NonNull String label)</code></pre>



<pre><code class="language-java">public LoggedOutEvent(@NonNull String label, @Nullable TrackerParams params)</code></pre>



**Methods:**  

There are no methods.

<!-- reusable-table-boundary -->

---
---

### RegisteredEvent
<!-- reusable-table-boundary -->

Class model for _client register_ event.
.

**Declared In:**  
`com.synerise.sdk.event.model.session.RegisteredEvent`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-97">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-97-0" data-tab-group="tabgrp-97" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-97-1" data-tab-group="tabgrp-97">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-97-0" data-tab-group="tabgrp-97" data-tab-active="true">

```Java
public class RegisteredEvent extends Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-97-1" data-tab-group="tabgrp-97">

```Kotlin
class RegisteredEvent : Event
```

</div>
</div>



**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **label** | String | no | - | Can't be empty. This value isn't saved in persistent storage and can't be used in Decision or Automation Hubs. It isn't shown on a Profile card. |
| **params** | TrackerParams | yes | - | Event tracker params |


**Initializers:**  

The following constructors are available:


<pre><code class="language-java">public RegisteredEvent(@NonNull String label)</code></pre>



<pre><code class="language-java">public RegisteredEvent(@NonNull String label, @Nullable TrackerParams params)</code></pre>



**Methods:**  

There are no methods.

<!-- reusable-table-boundary -->

---
---

### RecommendationEvent
<!-- reusable-table-boundary -->

Class model for _recommendation_ events.

**Declared In:**  
`com.synerise.sdk.event.model.ai.RecommendationEvent`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-98">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-98-0" data-tab-group="tabgrp-98" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-98-1" data-tab-group="tabgrp-98">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-98-0" data-tab-group="tabgrp-98" data-tab-active="true">

```Java
public class RecommendationEvent extends Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-98-1" data-tab-group="tabgrp-98">

```Kotlin
class RecommendationEvent : Event
```

</div>
</div>


#### Inheriting classes
RecommendationClickEvent  
RecommendationSeenEvent

**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **name** | String | no | - | Product name |
| **type** | String | no | - | Event type |
| **productId** | String | no | - | Product ID |
| **label** | String | no | - | Can't be empty. This value isn't saved in persistent storage and can't be used in Decision or Automation Hubs. It isn't shown on a Profile card. |
| **campaignId** | String | no | - | Recommendation campaign ID |
| **campaignHash** | String | no | - | Recommendation campaign hash |
| **params** | TrackerParams | yes | - | Event tracker params |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The `"productId"`, `"name"`, `"category"`, `"url"`, `"campaignId"` , `"campaignHash"` keys are reserved by Synerise in params.

</div></div></div>



**Initializers:**  


<pre><code class="language-java">public RecommendationEvent(@NonNull String type, @NonNull String label, @NonNull String productId, @NonNull String name,
                               @NonNull String campaignId, @NonNull String campaignHash,
                               @Nullable TrackerParams params)</code></pre>


**Methods:**  

This method defines the value of the `category` parameter.


<pre><code class="language-java">public void setCategory(String category)</code></pre>


---

This method defines the value of the `url` parameter.


<pre><code class="language-java">public void setUrl(String url)</code></pre>


---

<!-- reusable-table-boundary -->

---
---

### RecommendationViewEvent
<!-- reusable-table-boundary -->

Class model for _recommendation_ events.

**Declared In:**  
`com.synerise.sdk.event.model.ai.RecommendationViewEvent`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-99">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-99-0" data-tab-group="tabgrp-99" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-99-1" data-tab-group="tabgrp-99">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-99-0" data-tab-group="tabgrp-99" data-tab-active="true">

```Java
public class RecommendationViewEvent extends Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-99-1" data-tab-group="tabgrp-99">

```Kotlin
class RecommendationViewEvent : Event
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **productId** | String | no | - | Product ID. If this parameter is used, it is translated into a single-item `items` list automatically. If `items` is used, this parameter should be omitted. |
| **items** | `List<String>` | no | - | List of product IDs. If `productId` is used to define a single item in the event, this parameter should be omitted. |
| **correlationId** | String | no | - | Correlation ID of the recommendation |
| **campaignId** | String | no | - | Campaign ID |
| **campaignHash** | String | no | - | Campaign hash |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The `"items"`, `"correlationId"`, `"category"`, `"url"`, `"campaignId"` , `"campaignHash"` keys are reserved by Synerise in params.

</div></div></div>



**Initializers:**  


<pre><code class="language-java">public RecommendationViewEvent(@NonNull String productId, @NonNull String correlationId,
                                   @NonNull String campaignId, @NonNull String campaignHash)

public RecommendationViewEvent(@NonNull String label, @NonNull String productId, @NonNull String correlationId,
                                   @NonNull String campaignId, @NonNull String campaignHash, @Nullable TrackerParams params)
    
public RecommendationViewEvent(@NonNull List&lt;String&gt; items, @NonNull String correlationId,
                                   @NonNull String campaignId, @NonNull String campaignHash)

public RecommendationViewEvent(@NonNull String label, @NonNull List&lt;String&gt; items, @NonNull String correlationId,
                                   @NonNull String campaignId, @NonNull String campaignHash, @Nullable TrackerParams params)</code></pre>


**Methods:**  

This method defines the value of the `category` parameter.


<pre><code class="language-java">public void setCategory(String category)</code></pre>


---

This method defines the value of the `url` parameter.


<pre><code class="language-java">public void setUrl(String url)</code></pre>


---

<!-- reusable-table-boundary -->

---
---

### RecommendationSeenEvent
<!-- reusable-table-boundary -->

Class model for _recommendation seen_ event.

**Declared In:**  
`com.synerise.sdk.event.model.ai.RecommendationSeenEvent`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-100">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-100-0" data-tab-group="tabgrp-100" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-100-1" data-tab-group="tabgrp-100">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-100-0" data-tab-group="tabgrp-100" data-tab-active="true">

```Java
public class RecommendationSeenEvent extends RecommendationEvent
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-100-1" data-tab-group="tabgrp-100">

```Kotlin
class RecommendationSeenEvent : RecommendationEvent
```

</div>
</div>



**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **name** | String | no | - | Product name |
| **productId** | String | no | - | Product ID |
| **campaignId** | String | no | - | Recommendation campaign ID |
| **campaignHash** | String | no | - | Recommendation campaign hash |
| **label** | String | no | - | Can't be empty. This value isn't saved in persistent storage and can't be used in Decision or Automation Hubs. It isn't shown on a Profile card. |
| **params** | TrackerParams | yes | - | Event tracker params |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The `"productId"`, `"name"`, `"category"`, `"url"`, `"campaignId"` , `"campaignHash"` keys are reserved by Synerise in params.

</div></div></div>


**Initializers:**  

The following constructors are available:


<pre><code class="language-java">public RecommendationSeenEvent(@NonNull String label, @NonNull String productId, @NonNull String name,
                                   @NonNull String campaignId, @NonNull String campaignHash)</code></pre>



<pre><code class="language-java">public RecommendationSeenEvent(@NonNull String label, @NonNull String productId, @NonNull String name,
                                   @NonNull String campaignId, @NonNull String campaignHash, @Nullable TrackerParams params)</code></pre>


**Methods:**  

There are no methods.

<!-- reusable-table-boundary -->

---
---

### RecommendationClickEvent
<!-- reusable-table-boundary -->

Class model for _recommendation click_ event.

**Declared In:**  
`com.synerise.sdk.event.model.ai.RecommendationClickEvent`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-101">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-101-0" data-tab-group="tabgrp-101" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-101-1" data-tab-group="tabgrp-101">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-101-0" data-tab-group="tabgrp-101" data-tab-active="true">

```Java
public class RecommendationClickEvent extends RecommendationEvent
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-101-1" data-tab-group="tabgrp-101">

```Kotlin
class RecommendationClickEvent : RecommendationEvent
```

</div>
</div>



**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **name** | String | no | - | Product name |
| **productId** | String | no | - | Product ID |
| **campaignId** | String | no | - | Recommendation campaign ID |
| **campaignHash** | String | no | - | Recommendation campaign hash |
| **label** | String | no | - | Can't be empty. This value isn't saved in persistent storage and can't be used in Decision or Automation Hubs. It isn't shown on a Profile card. |
| **params** | TrackerParams | yes | - | Event tracker params |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The `"productId"`, `"name"`, `"category"`, `"url"`, `"campaignId"` , `"campaignHash"` keys are reserved by Synerise in params.

</div></div></div>


**Initializers:**  

The following constructors are available:


<pre><code class="language-java">public RecommendationClickEvent(@NonNull String label, @NonNull String productId, @NonNull String name,
                                    @NonNull String campaignId, @NonNull String campaignHash)</code></pre>



<pre><code class="language-java">public RecommendationClickEvent(@NonNull String label, @NonNull String productId, @NonNull String name,
                                    @NonNull String campaignId, @NonNull String campaignHash, @Nullable TrackerParams params)</code></pre>


**Methods:**  

There are no methods.

<!-- reusable-table-boundary -->

---
---

### VisitedScreenEvent
<!-- reusable-table-boundary -->

Class model for _visited screen_ event.

**Declared In:**  
`com.synerise.sdk.event.model.interaction.VisitedScreenEvent`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-102">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-102-0" data-tab-group="tabgrp-102" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-102-1" data-tab-group="tabgrp-102">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-102-0" data-tab-group="tabgrp-102" data-tab-active="true">

```Java
public class VisitedScreenEvent extends Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-102-1" data-tab-group="tabgrp-102">

```Kotlin
class VisitedScreenEvent : Event
```

</div>
</div>



**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **label** | String | no | - | Can't be empty. This value isn't saved in persistent storage and can't be used in Decision or Automation Hubs. It isn't shown on a Profile card. |
| **params** | TrackerParams | yes | - | Event tracker params |


**Initializers:**  

The following constructors are available:


<pre><code class="language-java">public VisitedScreenEvent(@NonNull String label)</code></pre>



<pre><code class="language-java">public VisitedScreenEvent(@NonNull String label, @Nullable TrackerParams params)</code></pre>



**Methods:**  

There are no methods.

<!-- reusable-table-boundary -->

---
---

### HitTimerEvent
<!-- reusable-table-boundary -->

Class model for _hit timer_ event.  
Record a "customer hit timer" event. This could be used for profiling or activity time monitoring - you can send "hit timer"
when your customer starts doing something and send it once again when they finish, but this time with a different time signature.
Then you can use [Decision Hub](/docs/analytics) to measure, for example, average activity time.

**Declared In:**  
`com.synerise.sdk.event.model.interaction.HitTimerEvent`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-103">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-103-0" data-tab-group="tabgrp-103" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-103-1" data-tab-group="tabgrp-103">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-103-0" data-tab-group="tabgrp-103" data-tab-active="true">

```Java
public class HitTimerEvent extends Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-103-1" data-tab-group="tabgrp-103">

```Kotlin
class HitTimerEvent : Event
```

</div>
</div>



**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **label** | String | no | - | Can't be empty. This value isn't saved in persistent storage and can't be used in Decision or Automation Hubs. It isn't shown on a Profile card. |
| **params** | TrackerParams | yes | - | Event tracker params |


**Initializers:**  

The following constructors are available:


<pre><code class="language-java">public HitTimerEvent(@NonNull String label)</code></pre>



<pre><code class="language-java">public HitTimerEvent(@NonNull String label, @Nullable TrackerParams params)</code></pre>



**Methods:**  

There are no methods.

<!-- reusable-table-boundary -->

---
---

### SearchedEvent
<!-- reusable-table-boundary -->

Class model for _client searched_ event.

**Declared In:**  
`com.synerise.sdk.event.model.interaction.SearchedEvent`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-104">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-104-0" data-tab-group="tabgrp-104" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-104-1" data-tab-group="tabgrp-104">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-104-0" data-tab-group="tabgrp-104" data-tab-active="true">

```Java
public class SearchedEvent extends Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-104-1" data-tab-group="tabgrp-104">

```Kotlin
class SearchedEvent : Event
```

</div>
</div>



**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **label** | String | no | - | Can't be empty. This value isn't saved in persistent storage and can't be used in Decision or Automation Hubs. It isn't shown on a Profile card. |
| **params** | TrackerParams | yes | - | Event tracker params |


**Initializers:**  

The following constructors are available:


<pre><code class="language-java">public SearchedEvent(@NonNull String label)</code></pre>



<pre><code class="language-java">public SearchedEvent(@NonNull String label, @Nullable TrackerParams params)</code></pre>



**Methods:**  

There are no methods.

<!-- reusable-table-boundary -->

---
---

### SharedEvent
<!-- reusable-table-boundary -->

Class model for _client shared_ event.

**Declared In:**  
`com.synerise.sdk.event.model.interaction.SharedEvent`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-105">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-105-0" data-tab-group="tabgrp-105" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-105-1" data-tab-group="tabgrp-105">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-105-0" data-tab-group="tabgrp-105" data-tab-active="true">

```Java
public class SharedEvent extends Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-105-1" data-tab-group="tabgrp-105">

```Kotlin
class SharedEvent : Event
```

</div>
</div>



**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **label** | String | no | - | Can't be empty. This value isn't saved in persistent storage and can't be used in Decision or Automation Hubs. It isn't shown on a Profile card. |
| **params** | TrackerParams | yes | - | Event tracker params |


**Initializers:**  

The following constructors are available:


<pre><code class="language-java">public SharedEvent(@NonNull String label)</code></pre>



<pre><code class="language-java">public SharedEvent(@NonNull String label, @Nullable TrackerParams params)</code></pre>



**Methods:**  

There are no methods.

<!-- reusable-table-boundary -->

---
---

### AppearedInLocationEvent
<!-- reusable-table-boundary -->

Class model for _appeared in location_ event.

**Declared In:**  
`com.synerise.sdk.event.model.interaction.AppearedInLocationEvent`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-106">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-106-0" data-tab-group="tabgrp-106" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-106-1" data-tab-group="tabgrp-106">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-106-0" data-tab-group="tabgrp-106" data-tab-active="true">

```Java
public class AppearedInLocationEvent extends Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-106-1" data-tab-group="tabgrp-106">

```Kotlin
class AppearedInLocationEvent : Event
```

</div>
</div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This event will be transformed into `client.location` in the database.

</div></div></div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **label** | String | no | - | Can't be empty. This value isn't saved in persistent storage and can't be used in Decision or Automation Hub. It isn't shown on a Profile card. |
| **params** | TrackerParams | yes | - | Event tracker params |
| **lon** | Double | no | - | Longitude |
| **lat** | Double | no | - | Latitude |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The `"lat"` and `"lon"` keys are reserved by Synerise in params.

</div></div></div>


**Initializers:**  

The following constructors are available:


<pre><code class="language-java">public AppearedInLocationEvent(@NonNull String label, double lat, double lon)</code></pre>



<pre><code class="language-java">public AppearedInLocationEvent(@NonNull String label, double lat, double lon, @Nullable TrackerParams params)</code></pre>



**Methods:**  

There are no methods.

<!-- reusable-table-boundary -->

---
---

### CrashEvent
<!-- reusable-table-boundary -->

Class model for _crash_ event.

**Declared In:**  
`com.synerise.sdk.event.model.crash.CrashEvent`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-107">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-107-0" data-tab-group="tabgrp-107" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-107-1" data-tab-group="tabgrp-107">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-107-0" data-tab-group="tabgrp-107" data-tab-active="true">

```Java
public class CrashEvent extends Event
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-107-1" data-tab-group="tabgrp-107">

```Kotlin
class CrashEvent : Event
```

</div>
</div>



**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **label** | String | no | - | Can't be empty. This value isn't saved in persistent storage and can't be used in Decision or Automation Hub. It isn't shown on a Profile card. |
| **params** | TrackerParams | yes | - | Event tracker params |

**Initializers:**  

There is a constructor.


<pre><code class="language-java">public CrashEvent(@NonNull String label, @NonNull TrackerParams params)</code></pre>



**Methods:**  

There are no methods.

<!-- reusable-table-boundary -->


# Customer authentication


## Set Client State Change listener
---
Set your own ClientStateChangeListener to get optional callbacks.
<!-- reusable-table-boundary -->

**Method name:**  
Client.setOnClientStateChangeListener(listener);
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-827">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-827-0" data-tab-group="tabgrp-827" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-827-1" data-tab-group="tabgrp-827">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-827-0" data-tab-group="tabgrp-827" data-tab-active="true">

```Java
public static void setOnClientStateChangeListener(OnClientStateChangeListener listener)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-827-1" data-tab-group="tabgrp-827">

```Kotlin
fun setOnClientStateChangeListener(listener:OnClientStateChangeListener)
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **listener** | OnClientStateChangeListener | yes | - | interface to handle client state change |


**Return Value:**  
No value is returned.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-828">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-828-0" data-tab-group="tabgrp-828" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-828-1" data-tab-group="tabgrp-828">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-828-0" data-tab-group="tabgrp-828" data-tab-active="true">

```Java
Client.setOnClientStateChangeListener(listener);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-828-1" data-tab-group="tabgrp-828">

```Kotlin
Client.setOnClientStateChangeListener(listener)
```

</div>
</div>


<!-- reusable-table-boundary -->

## Remove Client State Change listener
---
Remove your own ClientStateChangeListener.
**Method name:**  
Client.removeClientStateChangeListener();
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-829">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-829-0" data-tab-group="tabgrp-829" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-829-1" data-tab-group="tabgrp-829">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-829-0" data-tab-group="tabgrp-829" data-tab-active="true">

```Java
public static void removeClientStateChangeListener()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-829-1" data-tab-group="tabgrp-829">

```Kotlin
fun removeClientStateChangeListener()
```

</div>
</div>


**Parameters:**  
No parameters required.


**Return Value:**  
No value is returned.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-830">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-830-0" data-tab-group="tabgrp-830" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-830-1" data-tab-group="tabgrp-830">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-830-0" data-tab-group="tabgrp-830" data-tab-active="true">

```Java
Client.removeClientStateChangeListener();
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-830-1" data-tab-group="tabgrp-830">

```Kotlin
Client.removeClientStateChangeListener()
```

</div>
</div>


## Register customer account
---
This method registers a new customer with an email, password, and optional data.
  
This method requires the context object with a customer’s email, password, and optional data. Omitted fields are not modified.
  
Depending on the backend configuration, the account may require activation. For details, see  [customer registration](/developers/mobile-sdk/user-identification-and-authorization/overview).
  
Do not allow signing in again (or signing up) when a customer is already signed in. Sign the customer out first.
  
Do not create multiple instances nor call this method multiple times before execution.
  
This method is a global operation and doesn't require customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_REGISTER_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Method name:**  
Client.registerAccount(registerClient)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-831">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-831-0" data-tab-group="tabgrp-831" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-831-1" data-tab-group="tabgrp-831">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-831-0" data-tab-group="tabgrp-831" data-tab-active="true">

```Java
public static IApiCall registerAccount(@NonNull RegisterClient registerClient)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-831-1" data-tab-group="tabgrp-831">

```Kotlin
fun registerAccount(registerClient: RegisterClient): IApiCall
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default |
| --- | --- | --- | --- |
| **registerClient** | [RegisterClient](/developers/mobile-sdk/class-reference/android/client#registerclient) | yes | - |

**Return Value:**  
[IApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#iapicall) object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-832">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-832-0" data-tab-group="tabgrp-832" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-832-1" data-tab-group="tabgrp-832">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-832-0" data-tab-group="tabgrp-832" data-tab-active="true">

```Java
private IApiCall signUpCall;
private void signUp(RegisterClient registerClient) {
        if (signUpCall != null) signUpCall.cancel();
        signUpCall = Client.registerAccount(registerClient);
        signUpCall.onSubscribe(() -> toggleLoading(true))
                  .doFinally(() -> toggleLoading(false))
                  .execute(this::onSignUpSuccessful, this::onSignUpFailure);
    }
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-832-1" data-tab-group="tabgrp-832">

```Kotlin
private var signUpCall: IApiCall
    private fun signUp(registerClient: RegisterClient) {
        signUpCall!!.cancel()
        signUpCall = Client.registerAccount(registerClient)
        signUpCall!!.onSubscribe({ toggleLoading(true) })
            .doFinally({ toggleLoading(false) })
            .execute(({ this.onSignUpSuccessful() }), ({ this.onSignUpFailure() }))
    }
```

</div>
</div>


<!-- reusable-table-boundary -->

## Request customer account activation
---
This method requests sending an email with a URL that confirms the registration and activates the account.
  
This method is a global operation and doesn't require customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CONFIRMATION_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Method name:**  
Client.requestAccountActivation(email)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-833">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-833-0" data-tab-group="tabgrp-833" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-833-1" data-tab-group="tabgrp-833">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-833-0" data-tab-group="tabgrp-833" data-tab-active="true">

```java
public static IApiCall requestAccountActivation(String email)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-833-1" data-tab-group="tabgrp-833">

```kotlin
fun requestAccountActivation(email: String): IApiCall
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | String | yes | - |Customer's email|
  
**Return Value:**  
[IApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#iapicall) object to execute the request.
  
**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-834">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-834-0" data-tab-group="tabgrp-834" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-834-1" data-tab-group="tabgrp-834">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-834-0" data-tab-group="tabgrp-834" data-tab-active="true">

```java
private IApiCall call;
if (call != null) call.cancel();
            call = Client.requestAccountActivation(email);
            call.execute(this::onSuccess, this::onError);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-834-1" data-tab-group="tabgrp-834">

```kotlin
private val call: IApiCall? = null
            call.cancel();
            call = Client.requestAccountActivation(email);
            call.execute(this::onSuccess, this::onError);
```

</div>
</div>


<!-- reusable-table-boundary -->

## Confirm customer account activation
---
This method confirms a customer account with the confirmation token.
  
This method is a global operation and doesn't require customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 400 status code if the account is already confirmed or 404 if the account does not exist.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CONFIRMATION_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Method name:**  
Client.confirmAccountActivation(token)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-835">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-835-0" data-tab-group="tabgrp-835" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-835-1" data-tab-group="tabgrp-835">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-835-0" data-tab-group="tabgrp-835" data-tab-active="true">

```java
public static IApiCall confirmAccountActivation(String token)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-835-1" data-tab-group="tabgrp-835">

```kotlin
fun confirmAccountActivation(token: String): IApiCall
```

</div>
</div>



**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **token** | String | yes | - | Customer's token |

**Return Value:**  
[IApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#iapicall) object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-836">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-836-0" data-tab-group="tabgrp-836" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-836-1" data-tab-group="tabgrp-836">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-836-0" data-tab-group="tabgrp-836" data-tab-active="true">

```java
private IApiCall call;
if (call != null) call.cancel();
            call = Client.confirmAccountActivation(token);
            call.execute(this::onSuccess, this::onError);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-836-1" data-tab-group="tabgrp-836">

```kotlin
private val call: IApiCall? = null
            call.cancel();
            call = Client.confirmAccountActivation(token);
            call.execute(this::onSuccess, this::onError);
```

</div>
</div>


<!-- reusable-table-boundary -->

## Request customer account activation by pin
---
This method requests a customer's account registration process with the PIN code.
  
This method is a global operation and doesn't require customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_PIN_CODE_RESEND_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Method name:**  
Client.requestAccountActivationByPin(email)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-837">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-837-0" data-tab-group="tabgrp-837" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-837-1" data-tab-group="tabgrp-837">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-837-0" data-tab-group="tabgrp-837" data-tab-active="true">

```Java
public static IApiCall requestAccountActivationByPin(String email)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-837-1" data-tab-group="tabgrp-837">

```Kotlin
fun requestAccountActivationByPin(email:String):IApiCall
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | String | yes | - | Email to which the pinCode will be sent |

**Return Value:**  
[IApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#iapicall) object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-838">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-838-0" data-tab-group="tabgrp-838" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-838-1" data-tab-group="tabgrp-838">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-838-0" data-tab-group="tabgrp-838" data-tab-active="true">

```Java
IApiCall apiCall;
apiCall = Client.requestAccountActivationByPin(email);
apiCall.execute(this::onSuccess, this::onFailure);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-838-1" data-tab-group="tabgrp-838">

```Kotlin
val apiCall:IApiCall
apiCall = Client.requestAccountActivationByPin(email)
apiCall.execute(({ this.onSuccess() }), ({ this.onFailure() }))
```

</div>
</div>


<!-- reusable-table-boundary -->

## Confirm customer account activation by pin
---
This method confirms a customer's account registration process with the PIN code.
  
This method is a global operation and doesn't require customer authentication.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_PIN_CODE_RESEND_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Method name:**  
Client.confirmAccountActivationByPin(pinCode, email)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-839">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-839-0" data-tab-group="tabgrp-839" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-839-1" data-tab-group="tabgrp-839">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-839-0" data-tab-group="tabgrp-839" data-tab-active="true">

```Java
public static IApiCall confirmAccountActivationByPin(String pinCode, String email)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-839-1" data-tab-group="tabgrp-839">

```Kotlin
fun confirmAccountActivationByPin(pinCode: String, email:String):IApiCall
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **pinCode** | String | yes | - | Code sent to the customer's email |
| **email** | String | yes | - | Email used in the registration process |

**Return Value:**  
[IApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#iapicall) object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-840">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-840-0" data-tab-group="tabgrp-840" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-840-1" data-tab-group="tabgrp-840">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-840-0" data-tab-group="tabgrp-840" data-tab-active="true">

```Java
IApiCall apiCall;
apiCall = Client.confirmAccountActivationByPin(pinCode, email);
apiCall.execute(this::onSuccess, this::onFailure);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-840-1" data-tab-group="tabgrp-840">

```Kotlin
val apiCall:IApiCall
apiCall = Client.confirmAccountActivationByPin(pinCode, email)
apiCall.execute(({ this.onSuccess() }), ({ this.onFailure() }))
```

</div>
</div>


<!-- reusable-table-boundary -->

## Sign in a customer
---
This method signs a customer in to obtain a JSON Web Token (JWT) which can be used in subsequent requests.
  
The SDK will refresh the token before each call if it is about to expire (but not expired).
  
Do NOT allow signing in again (or signing up) when a customer is already signed in. First, sign the customer out.
  
Do NOT create multiple instances nor call this method multiple times before execution.
<!-- reusable-table-boundary -->

**Method name:**  
Client.signIn(email, password)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-841">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-841-0" data-tab-group="tabgrp-841" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-841-1" data-tab-group="tabgrp-841">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-841-0" data-tab-group="tabgrp-841" data-tab-active="true">

```Java
public static IApiCall signIn(@NonNull String email, @NonNull String password)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-841-1" data-tab-group="tabgrp-841">

```Kotlin
fun signIn(email: String, password: String): IApiCall
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | String | yes | - | Customer's email |
| **password** | String | yes | - | Customer's password |

**Return Value:**  
[IApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#iapicall) object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-842">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-842-0" data-tab-group="tabgrp-842" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-842-1" data-tab-group="tabgrp-842">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-842-0" data-tab-group="tabgrp-842" data-tab-active="true">

```Java
private IApiCall signInCall;
private void signIn(String login, String password) {
        if (signInCall != null) signInCall.cancel();
        signInCall = Client.signIn(login, password);
        signInCall.onSubscribe(() -> toggleLoading(true))
                  .execute(() -> onSignInSuccessful(login), () -> onSignInFailure());
    }
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-842-1" data-tab-group="tabgrp-842">

```Kotlin
private var signInCall: IApiCall
    private fun signIn(login: String, password: String) {
        signInCall!!.cancel()
        signInCall = Client.signIn(login, password)
        signInCall!!.onSubscribe({ toggleLoading(true) })
            .execute({ onSignInSuccessful(login) }, { onSignInFailure() })
    }
```

</div>
</div>


<!-- reusable-table-boundary -->

## Sign in a customer conditionally
---
<!-- reusable-table-boundary -->

This method signs a customer in to obtain a JSON Web Token (JWT) which can be used in subsequent requests.
  
The SDK will refresh the token before each call if it is about to expire (but not expired).
  
Do NOT allow signing in again (or signing up) when a customer is already signed in. First, sign the customer out.
  
Do NOT create multiple instances nor call this method multiple times before execution.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | n/a |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Method name:**  
Client.signInConditionally(email, password)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-843">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-843-0" data-tab-group="tabgrp-843" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-843-1" data-tab-group="tabgrp-843">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-843-0" data-tab-group="tabgrp-843" data-tab-active="true">

```java
public static IDataApiCall<AuthConditions> signInConditionally(@NonNull String email, @NonNull String password)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-843-1" data-tab-group="tabgrp-843">

```kotlin
fun signInConditionally(
        email: String,
        password: String,
        ): IDataApiCall<AuthConditions>
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | String | yes | - | Client's email |
| **password** | String | yes | - | Client's password |

**Return Value:**  
IDataApiCall<[AuthConditions](/developers/mobile-sdk/class-reference/android/client#authconditions)> object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-844">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-844-0" data-tab-group="tabgrp-844" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-844-1" data-tab-group="tabgrp-844">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-844-0" data-tab-group="tabgrp-844" data-tab-active="true">

```java
private IDataApiCall<AuthConditions> call;
if (call != null) call.cancel();
            call = Client.signInConditionally(email, password));
            call.execute(this::onSuccess, this::onFailure);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-844-1" data-tab-group="tabgrp-844">

```kotlin
val call:IDataApiCall<AuthConditions>
call.cancel()
call = Client.signInConditionally(email, password)
call.execute(({ this.onSuccess() }), ({ this.onFailure() }))
```

</div>
</div>


<!-- reusable-table-boundary -->

## Authenticate customer by IdentityProvider
---
<!-- reusable-table-boundary -->

This method authenticates a customer with OAuth, Facebook, Google, Apple, or Synerise.
  
If an account for the customer does not exist and the identity provider is different than Synerise, this request creates an account.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | 0.3.0 |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Method name:**  
Client.authenticate(token, clientIdentityProvider, agreements, attributes, authId)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-845">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-845-0" data-tab-group="tabgrp-845" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-845-1" data-tab-group="tabgrp-845">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-845-0" data-tab-group="tabgrp-845" data-tab-active="true">

```java
public static IApiCall authenticate(String token, ClientIdentityProvider provider, Agreements agreements, Attributes attributes, String authId)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-845-1" data-tab-group="tabgrp-845">

```kotlin
fun authenticate(
        token: String,
        provider: ClientIdentityProvider,
        agreements: Agreements?,
        attributes: Attributes?,
        authId: String?
    ): IApiCall
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **token** | String | yes | - | Token retrieved from provider |
| **provider** | [ClientIdentityProvider](/developers/mobile-sdk/class-reference/android/client#clientidentityprovider) | yes | - | Provider of your token |
| **agreements** | [Agreements](/developers/mobile-sdk/class-reference/android/client#agreements) | no | - | Optional agreements |
| **attributes** | [Attributes](/developers/mobile-sdk/class-reference/android/client#attributes) | no | - | Optional attributes |
| **authId** | String | no | - | Optional identifier of authorization |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authId** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>


**Return Value:**  
[IApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#iapicall) object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-846">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-846-0" data-tab-group="tabgrp-846" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-846-1" data-tab-group="tabgrp-846">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-846-0" data-tab-group="tabgrp-846" data-tab-active="true">

```java
private IApiCall call;
if (call != null) call.cancel();
            call = Client.authenticate(token, provider, null, null, null);
            call.execute(this::onSuccess, this::onFailure);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-846-1" data-tab-group="tabgrp-846">

```kotlin
val call:IApiCall
call.cancel()
call = Client.authenticate(token, provider, null, null, null)
call.execute(({ this.onSuccess() }), ({ this.onFailure() }))
```

</div>
</div>


<!-- reusable-table-boundary -->

## Authenticate customer conditionally by IdentityProvider
---
<!-- reusable-table-boundary -->

This method authenticates a customer with OAuth, Facebook, Google, Apple, or Synerise.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | n/a |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Method name:**  
Client.authenticateConditionally(token, clientIdentityProvider, agreements, attributes, authId)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-847">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-847-0" data-tab-group="tabgrp-847" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-847-1" data-tab-group="tabgrp-847">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-847-0" data-tab-group="tabgrp-847" data-tab-active="true">

```java
public static IDataApiCall<AuthConditions> authenticateConditionally(@NonNull String token, @NonNull ClientIdentityProvider provider, @Nullable Agreements agreements, @Nullable Attributes attributes, @Nullable String authId)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-847-1" data-tab-group="tabgrp-847">

```kotlin
fun authenticateConditionally(
        token: String,
        provider: ClientIdentityProvider,
        agreements: Agreements?,
        attributes: Attributes?,
        authId: String?
        ): IDataApiCall
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **token** | String | yes | - | Token retrieved from provider |
| **provider** | [ClientIdentityProvider](/developers/mobile-sdk/class-reference/android/client#clientidentityprovider) | yes | - | Provider of your token |
| **agreements** | [Agreements](/developers/mobile-sdk/class-reference/android/client#agreements) | no | - | Optional agreements |
| **attributes** | [Attributes](/developers/mobile-sdk/class-reference/android/client#attributes) | no | - | Optional attributes |
| **authId** | String | no | - | Optional identifier of authorization |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authId** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>


**Return Value:**  
IDataApiCall<[AuthConditions](/developers/mobile-sdk/class-reference/android/client#authconditions)> object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-848">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-848-0" data-tab-group="tabgrp-848" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-848-1" data-tab-group="tabgrp-848">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-848-0" data-tab-group="tabgrp-848" data-tab-active="true">

```java
private IDataApiCall<AuthConditions> call;
if (call != null) call.cancel();
            call = Client.authenticateConditionally(token, clientIdentityProvider, agreements, attributes, authId));
            call.execute(this::onSuccess, this::onFailure);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-848-1" data-tab-group="tabgrp-848">

```kotlin
val call:IDataApiCall<AuthConditions>
call.cancel()
call = Client.authenticateConditionally(token, clientIdentityProvider, agreements, attributes, authId)
call.execute(({ this.onSuccess() }), ({ this.onFailure() }))
```

</div>
</div>


<!-- reusable-table-boundary -->

## Authenticate customer with token payload
---
<!-- reusable-table-boundary -->

This method signs in a customer in with the provided token payload.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.15.0 | 5.15.0 | n/a | n/a |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Method name:**  
Client.authenticateWithTokenPayload()
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-849">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-849-0" data-tab-group="tabgrp-849" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-849-1" data-tab-group="tabgrp-849">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-849-0" data-tab-group="tabgrp-849" data-tab-active="true">

```Java
public static IApiCall authenticateWithTokenPayload(TokenPayload tokenPayload, @NonNull String authId)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-849-1" data-tab-group="tabgrp-849">

```Kotlin
fun authenticateWithTokenPayload(
        tokenPayload: TokenPayload,
        authId: String
        ): IApiCall
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **tokenPayload** | [TokenPayload](/developers/mobile-sdk/class-reference/android/client#tokenpayload) | yes | - | Object which contains a token's payload |
| **authId** | String | yes | - | Required customer's identifier of authorization |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authId** parameter is used for decreasion the number of UUID refreshes so it must be unique for every customer.

</div></div></div>


**Return Value:**  
[IApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#iapicall) object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-850">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-850-0" data-tab-group="tabgrp-850" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-850-1" data-tab-group="tabgrp-850">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-850-0" data-tab-group="tabgrp-850" data-tab-active="true">

```java
private IApiCall call;
if (call != null) call.cancel();
            call = Client.authenticateWithTokenPayload(tokenPayload, authId);
            call.execute(this::onSuccess, this::onFailure);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-850-1" data-tab-group="tabgrp-850">

```kotlin
val call:IApiCall
call.cancel()
call = Client.authenticateWithTokenPayload(tokenPayload, authId)
call.execute(({ this.onSuccess() }), ({ this.onFailure() }))
```

</div>
</div>


<!-- reusable-table-boundary -->

## Authenticate customer via Simple Profile Authentication
---
<!-- reusable-table-boundary -->

This method authenticates a customer with Simple Profile Authentication.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.14.0 | 5.7.1 | 0.15.0 | 0.7.0 |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

When you use this method, you must set a request validation salt by using the `Synerise.setRequestValidationSalt(_:)` method (if salt is enabled for Simple Profile Authentication).

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_SIMPLE_AUTH_CREATE` from the **Auth** group.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Method name:**  
Client.simpleAuthentication(clientData, authId)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-851">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-851-0" data-tab-group="tabgrp-851" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-851-1" data-tab-group="tabgrp-851">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-851-0" data-tab-group="tabgrp-851" data-tab-active="true">

```java
public static IApiCall simpleAuthentication(ClientData clientData, String authId)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-851-1" data-tab-group="tabgrp-851">

```kotlin
fun simpleAuthentication(
        clientData: ClientData,
        authId: String
    ): IApiCall
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **clientData** | [ClientData](/developers/mobile-sdk/class-reference/android/client#clientdata) | yes | - | Object which contains customer data |
| **authId** | String | yes | - | Required identifier of authorization |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authId** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>


**Return Value:**  
[IApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#iapicall) object to execute the request.

<!-- reusable-table-boundary -->

## Check if a customer is signed in (via RaaS, OAuth, Facebook, Apple)
---
This method checks if a customer is signed in (via Synerise Authentication - RaaS, OAuth, Facebook, Apple).
**Method name:**  
Client.isSignedIn()
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-852">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-852-0" data-tab-group="tabgrp-852" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-852-1" data-tab-group="tabgrp-852">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-852-0" data-tab-group="tabgrp-852" data-tab-active="true">

```Java
public static boolean isSignedIn()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-852-1" data-tab-group="tabgrp-852">

```Kotlin
fun isSignedIn():Boolean
```

</div>
</div>


**Parameters:**  
No parameters.

**Return Value:**  
Boolean defining whether a customer is signed in or not.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-853">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-853-0" data-tab-group="tabgrp-853" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-853-1" data-tab-group="tabgrp-853">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-853-0" data-tab-group="tabgrp-853" data-tab-active="true">

```Java
boolean isSignedIn = Client.isSignedIn()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-853-1" data-tab-group="tabgrp-853">

```Kotlin
var isSignedIn = Client.isSignedIn()
```

</div>
</div>


## Check if a customer is signed in (via Simple Profile Authentication)
---
<!-- reusable-table-boundary -->

This method checks if a customer is signed in (via Simple Profile Authentication).
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.14.0 | 5.7.1 | 0.15.0 | 0.7.0 |

<!-- reusable-table-boundary -->
**Method name:**  
Client.isSignedIn()
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-854">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-854-0" data-tab-group="tabgrp-854" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-854-1" data-tab-group="tabgrp-854">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-854-0" data-tab-group="tabgrp-854" data-tab-active="true">

```Java
public static boolean isSignedInViaSimpleAuthentication()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-854-1" data-tab-group="tabgrp-854">

```Kotlin
fun isSignedInViaSimpleAuthentication():Boolean
```

</div>
</div>


**Parameters:**  
No parameters.

**Return Value:**  
**true** if the customer is signed in (via Simple Profile Authentication), otherwise returns **false**.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-855">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-855-0" data-tab-group="tabgrp-855" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-855-1" data-tab-group="tabgrp-855">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-855-0" data-tab-group="tabgrp-855" data-tab-active="true">

```Java
boolean isSignedInViaSimpleAuthentication = Client.isSignedInViaSimpleAuthentication()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-855-1" data-tab-group="tabgrp-855">

```Kotlin
var isSignedInViaSimpleAuthentication = Client.isSignedInViaSimpleAuthentication()
```

</div>
</div>


## Sign out customer
---
This method signs out a customer out.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This method works with every authentication type (via Synerise, External Provider, OAuth or Simple Profile Authentication).

</div></div></div>

**Method name:**  
Client.signOut()
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-856">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-856-0" data-tab-group="tabgrp-856" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-856-1" data-tab-group="tabgrp-856">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-856-0" data-tab-group="tabgrp-856" data-tab-active="true">

```Java
public static void signOut()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-856-1" data-tab-group="tabgrp-856">

```Kotlin
fun signOut()
```

</div>
</div>


**Parameters:**  
No parameters.

**Return Value:**  
Nothing is returned.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-857">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-857-0" data-tab-group="tabgrp-857" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-857-1" data-tab-group="tabgrp-857">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-857-0" data-tab-group="tabgrp-857" data-tab-active="true">

```Java
Client.signOut();
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-857-1" data-tab-group="tabgrp-857">

```Kotlin
Client.signOut();
```

</div>
</div>


## Sign out customer with mode or from all devices
---
<!-- reusable-table-boundary -->

This method signs out a customer out with a chosen mode and Determines if the method should sign out all devices.

Available modes:
- `.signOut` mode signs out the customer.
- `.signOutWithSessionDestroy` mode signs out the customer and additionally, clears the anonymous session and regenerates the customer UUID.

The `fromAllDevices` parameter determines whether the method should notify the backend to sign out all devices.

**IMPORTANT: It is an asynchronous method.**
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.11.0 | 5.1.0 | 0.14.0 | 1.0.0 |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This method works with every authentication type (via Synerise, External Provider, OAuth or Simple Profile Authentication).

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Class:**  
[Client](/developers/mobile-sdk/class-reference/android/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-858">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-858-0" data-tab-group="tabgrp-858" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-858-1" data-tab-group="tabgrp-858">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-858-0" data-tab-group="tabgrp-858" data-tab-active="true">

```java
public static IApiCall signOut(ClientSignOutMode mode, Boolean signOutFromAllDevices)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-858-1" data-tab-group="tabgrp-858">

```kotlin
fun signOut(mode: ClientSignOutMode, signOutFromAllDevices: Boolean): IApiCall
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **mode** | [ClientSignOutMode](/developers/mobile-sdk/class-reference/android/client#clientsignoutmode) | yes | - | Client sign out mode |
| **signOutFromAllDevices** | Boolean | yes | - | Determines if the method should sign out all devices |

**Return Value:**  
Nothing is returned.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-859">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-859-0" data-tab-group="tabgrp-859" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-859-1" data-tab-group="tabgrp-859">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-859-0" data-tab-group="tabgrp-859" data-tab-active="true">

```java
private IApiCall signOutCall;
private void signOut() {
  if (signOutCall != null) signOutCall.cancel();
  signOutCall = Client.signOut(ClientSignOutMode.SIGN_OUT_WITH_SESSION_CLEARING, true);
  signOutCall.onSubscribe(() -> toggleLoading(true))
             .execute(() -> onSignOutSuccessful(login), () -> onSignOutFailure());
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-859-1" data-tab-group="tabgrp-859">

```kotlin
private var signOutCall: IApiCall
private fun signOut(login: String, password: String) {
  signOutCall!!.cancel()
  signOutCall = Client.signOut(.SIGN_OUT_WITH_SESSION_CLEARING, true)
  signOutCall!!.onSubscribe({ toggleLoading(true) })
              .execute({ onSignOutSuccessful(login) }, { onSignOutFailure() })
}
```

</div>
</div>


<!-- reusable-table-boundary -->

## Removed methods

### <del>Authenticate customer by OAuth with registration</del> {#authenticate-customer-by-oauth-with-registration}
---
<!-- reusable-table-boundary -->

This method authenticates a customer with OAuth.
  
If an account for the customer does not exist, this request creates an account.
  
| Available on | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.6.11 | 3.6.13 | 0.9.12 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | 1.0.0 | n/a |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 401 status code if the provided access token and/or API Key is invalid.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Method name:**  
Client.authenticateByOAuth(accessToken, agreements, attributes, authId)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-860">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-860-0" data-tab-group="tabgrp-860" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-860-1" data-tab-group="tabgrp-860">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-860-0" data-tab-group="tabgrp-860" data-tab-active="true">

```java
public static IApiCall authenticateByOAuth(@NonNull String accessToken, @Nullable Agreements agreements, @Nullable Attributes attributes, @Nullable String authId)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-860-1" data-tab-group="tabgrp-860">

```kotlin
fun authenticateByOAuth(
        accessToken: String,
        agreements: Agreements?,
        attributes: Attributes?,
        authId: String?
    ): IApiCall
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **accessToken** | String | yes | - | OAuth Access Token |
| **agreements** | [Agreements](/developers/mobile-sdk/class-reference/android/client#agreements) | no | --- | Optional agreements |
| **attributes** | [Attributes](/developers/mobile-sdk/class-reference/android/client#attributes) | no | --- | Optional attributes |
| **authId** | String | no | --- | Optional identifier of authorization |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authId** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>


**Return Value:**  
[IApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#iapicall) object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-861">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-861-0" data-tab-group="tabgrp-861" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-861-1" data-tab-group="tabgrp-861">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-861-0" data-tab-group="tabgrp-861" data-tab-active="true">

```java
private IApiCall call;
if (call != null) call.cancel();
            call = Client.authenticateByOAuth(token, null, null, null);
            call.execute(this::onSuccess, this::onFailure);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-861-1" data-tab-group="tabgrp-861">

```kotlin
val call:IApiCall
call.cancel()
call = Client.authenticateByOAuth(token, null, null, null)
call.execute(({ this.onSuccess() }), ({ this.onFailure() }))
```

</div>
</div>


<!-- reusable-table-boundary -->

### <del>Authenticate customer by OAuth without registration</del> {#authenticate-customer-by-oauth-without-registration}
---
<!-- reusable-table-boundary -->

This method authenticates a customer with OAuth.
  
| Available on | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.6.11 | 3.6.13 | 0.9.12 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | 1.0.0 | n/a |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 401 status code if the provided access token and/or API Key is invalid.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Method name:**  
Client.authenticateByOAuthIfRegistered(accessToken, authId)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-862">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-862-0" data-tab-group="tabgrp-862" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-862-1" data-tab-group="tabgrp-862">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-862-0" data-tab-group="tabgrp-862" data-tab-active="true">

```java
public static IApiCall authenticateByOAuthIfRegistered(@NonNull String accessToken, @Nullable String authId)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-862-1" data-tab-group="tabgrp-862">

```kotlin
fun authenticateByOAuthIfRegistered(
        accessToken: String,
        authId: String?
    ): IApiCall
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **accessToken** | String | yes | - | OAuth Access Token |
| **authId** | String | no | --- | Optional identifier of authorization |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authId** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>


**Return Value:**  
[IApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#iapicall) object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-863">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-863-0" data-tab-group="tabgrp-863" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-863-1" data-tab-group="tabgrp-863">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-863-0" data-tab-group="tabgrp-863" data-tab-active="true">

```java
private IApiCall call;
if (call != null) call.cancel();
            call = Client.authenticateByOAuthIfRegistered(token, null);
            call.execute(this::onSuccess, this::onFailure);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-863-1" data-tab-group="tabgrp-863">

```kotlin
val call:IApiCall
call.cancel()
call = Client.authenticateByOAuthIfRegistered(token, null)
call.execute(({ this.onSuccess() }), ({ this.onFailure() }))
```

</div>
</div>


<!-- reusable-table-boundary -->

### <del>Authenticate customer by Facebook with registration</del> {#authenticate-customer-by-facebook-with-registration}
---
<!-- reusable-table-boundary -->

This method authenticates a customer with Facebook.
  
If an account for the customer does not exist, this request creates an account.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.3.8 | 3.3.0 | 0.9.7 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | 1.0.0 | n/a |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 401 status code if the provided Facebook token and/or API Key is invalid.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Method name:**  
Client.authenticateByFacebook(facebookToken, agreements, attributes, authId)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-864">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-864-0" data-tab-group="tabgrp-864" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-864-1" data-tab-group="tabgrp-864">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-864-0" data-tab-group="tabgrp-864" data-tab-active="true">

```java
public static IApiCall authenticateByFacebook(@NonNull String facebookToken, @Nullable Agreements agreements, @Nullable Attributes attributes, @Nullable String authId)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-864-1" data-tab-group="tabgrp-864">

```kotlin
fun authenticateByFacebook(
        facebookToken: String,
        agreements: Agreements?,
        attributes: Attributes?,
        authId: String?
    ): IApiCall
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **facebookToken** | String | yes | - | Facebook Access Token |
| **agreements** | [Agreements](/developers/mobile-sdk/class-reference/android/client#agreements)| no | --- | Marketing agreements |
| **attributes** | [Attributes](/developers/mobile-sdk/class-reference/android/client#attributes) | no | --- | Additional attributes |
| **authId** | String | no | --- | Optional identifier of authorization |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authId** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>


**Return Value:**  
[IApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#iapicall) object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-865">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-865-0" data-tab-group="tabgrp-865" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-865-1" data-tab-group="tabgrp-865">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-865-0" data-tab-group="tabgrp-865" data-tab-active="true">

```Java
private IApiCall signInFacebookCall;
private void signInFacebook(String facebookToken) {
        if (signInFacebookCall != null) signInFacebookCall.cancel();
        signInFacebookCall = Client.authenticateByFacebook(facebookToken, null, null, null);
        signInFacebookCall.onSubscribe(() -> toggleFacebookLoading(true))
                          .execute(this::onSignInFacebookSuccess, this::onSignInFacebookError);
    }
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-865-1" data-tab-group="tabgrp-865">

```Kotlin
private var signInFacebookCall: IApiCall? = null
    private fun signInFacebook(facebookToken: String) {
        if (signInFacebookCall != null) signInFacebookCall!!.cancel()
        signInFacebookCall = Client.authenticateByFacebook(facebookToken, null, null, null)
        signInFacebookCall!!.onSubscribe({ toggleFacebookLoading(true) })
            .execute(({ this.onSignInFacebookSuccess() }), ({ this.onSignInFacebookError() }))
    }
```

</div>
</div>


<!-- reusable-table-boundary -->

### <del>Authenticate customer by Facebook without registration</del> {#authenticate-customer-by-facebook-without-registration}
---
<!-- reusable-table-boundary -->

This method authenticates a customer with Facebook.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.3.8 | 3.3.0 | 0.9.7 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.7.6 | 3.8.0 | 0.9.19 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | 1.0.0 | n/a |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 401 status code if the provided Facebook token and/or API Key is invalid.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Method name:**  
Client.authenticateByFacebookRegistered(facebookToken, authId)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-866">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-866-0" data-tab-group="tabgrp-866" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-866-1" data-tab-group="tabgrp-866">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-866-0" data-tab-group="tabgrp-866" data-tab-active="true">

```java
public static IApiCall authenticateByFacebookRegistered(@NonNull String facebookToken, @Nullable String authId)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-866-1" data-tab-group="tabgrp-866">

```kotlin
fun authenticateByFacebookRegistered(facebookToken: String, authId: String?): IApiCall
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **facebookToken** | String | yes | - | Facebook Access Token|
| **authId** | String | no | --- | Optional identifier of authorization |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authId** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>


**Return Value:**  
[IApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#iapicall) object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-867">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-867-0" data-tab-group="tabgrp-867" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-867-1" data-tab-group="tabgrp-867">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-867-0" data-tab-group="tabgrp-867" data-tab-active="true">

```java
private IApiCall signInFacebookRegisteredCall;
private void signInFacebookRegistered(String facebookToken) {
        if (signInFacebookRegisteredCall != null) signInFacebookRegisteredCall.cancel();
        signInFacebookRegisteredCall = Client.authenticateByFacebookRegistered(facebookToken, null);
        signInFacebookRegisteredCall.onSubscribe(() -> toggleFacebookLoading(true))
                          .execute(this::onSignInFacebookSuccess, this::onSignInFacebookError);
    }
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-867-1" data-tab-group="tabgrp-867">

```kotlin
private var signInFacebookRegisteredCall: IApiCall? = null
    private fun signInFacebook(facebookToken: String) {
        signInFacebookRegisteredCall!!.cancel()
        signInFacebookRegisteredCall = Client.authenticateByFacebookRegistered(facebookToken, null)
        signInFacebookRegisteredCall!!.onSubscribe({ toggleFacebookLoading(true) })
            .execute(({ this.onSignInFacebookSuccess() }), ({ this.onSignInFacebookError() }))
    }
```

</div>
</div>


<!-- reusable-table-boundary -->

### <del>Sign out customer with mode</del> {#sign-out-customer-with-mode}
---
<!-- reusable-table-boundary -->

This method signs out a customer out with a chosen mode:
- `.signOut` mode notifies the backend that the customer is signed out.
- `.signOutWithSessionDestroy` mode notifies the backend that the customer is signed out and additionally, clears the anonymous session and regenerates the customer UUID.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.4.0 | 4.6.0 | 0.12.0 | 0.7.0 |
| <span style="color:orange">Deprecated in:</span> | 4.11.0 | 5.1.0 | - | - |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | 0.14.0 | 1.0.0 |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This method works with every authentication type (via Synerise, External Provider, OAuth or Simple Profile Authentication).

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Class:**  
[Client](/developers/mobile-sdk/class-reference/android/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-868">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-868-0" data-tab-group="tabgrp-868" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-868-1" data-tab-group="tabgrp-868">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-868-0" data-tab-group="tabgrp-868" data-tab-active="true">

```java
public static void signOut(ClientSignOutMode mode)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-868-1" data-tab-group="tabgrp-868">

```kotlin
fun signOut()
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **mode** | [ClientSignOutMode](/developers/mobile-sdk/class-reference/android/client#clientsignoutmode) | yes | - | Client sign out mode |

**Return Value:**  
Nothing is returned.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-869">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-869-0" data-tab-group="tabgrp-869" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-869-1" data-tab-group="tabgrp-869">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-869-0" data-tab-group="tabgrp-869" data-tab-active="true">

```Java
Client.signOut(mode);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-869-1" data-tab-group="tabgrp-869">

```Kotlin
Client.signOut(mode);
```

</div>
</div>


<!-- reusable-table-boundary -->


 


# Customer account management


## Get customer account information
---
This method gets a customer’s account information.
  
This method requires customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `API_PERSONAL_INFORMATION_CLIENT_READ` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClient.h
  
**Related To:**  
[ClientAccountInformation](/developers/mobile-sdk/class-reference/ios/client#clientaccountinformation)
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1046">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1046-0" data-tab-group="tabgrp-1046" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1046-1" data-tab-group="tabgrp-1046">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1046-0" data-tab-group="tabgrp-1046" data-tab-active="true">

```Swift
static func getAccount(success: ((ClientAccountInformation) -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1046-1" data-tab-group="tabgrp-1046">

```Objective-C
+ (void)getAccountWithSuccess:(nonnull void (^)(SNRClientAccountInformation *accountInformation))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **success** | ((ClientAccountInformation) -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
    
**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1047">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1047-0" data-tab-group="tabgrp-1047" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1047-1" data-tab-group="tabgrp-1047">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1047-0" data-tab-group="tabgrp-1047" data-tab-active="true">

```Swift
Client.getAccount(success: { (clientAccountInformation) in
  // success
}) { (error) in
  // failure
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1047-1" data-tab-group="tabgrp-1047">

```Objective-C
[SNRClient getAccountWithSuccess:^(SNRClientAccountInformation *accountInformation) {
  // success
} failure:^(SNRApiError *error) {
  // failure
}];
```

</div>
</div>


<!-- reusable-table-boundary -->

## Get customer's events
---
This method retrieves events for an authenticated customer.
  
This method requires customer authentication.
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClient.h
  
**Related To:**  
[ClientEventsApiQuery](/developers/mobile-sdk/class-reference/ios/client#clienteventsapiquery)
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1048">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1048-0" data-tab-group="tabgrp-1048" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1048-1" data-tab-group="tabgrp-1048">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1048-0" data-tab-group="tabgrp-1048" data-tab-active="true">

```Swift
static func getEvents(apiQuery: ClientEventsApiQuery, success: (([ClientEventData]) -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1048-1" data-tab-group="tabgrp-1048">

```Objective-C
+ (void)getEventsWithApiQuery:(nonnull SNRClientEventsApiQuery *)apiQuery success:(nonnull void (^)(NSArray<SNRClientEventData *> *events))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **apiQuery** | [ClientEventsApiQuery](/developers/mobile-sdk/class-reference/ios/client#clienteventsapiquery) | yes | - | Object responsible for storing all query parameters |
| **success** | (([ClientEventData]) -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->

## Update customer account basic information
---
<!-- reusable-table-boundary -->

This method updates a customer’s account’s basic information (without identification data: uuid, customId, email).
  
This method requires the context object with the customer’s account information. Omitted fields are not modified.
  
This method does not require customer authentication and can be used by anonymous profiles.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.22.0 | 5.21.0 | 0.24.0 | 1.4.0 |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `API_BASIC_INFORMATION_CLIENT_UPDATE` permission from the **Client** group.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClient.h
  
**Related To:**  
[ClientUpdateAccountBasicInformationContext](/developers/mobile-sdk/class-reference/ios/client#clientupdateaccountbasicinformationcontext)
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1049">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1049-0" data-tab-group="tabgrp-1049" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1049-1" data-tab-group="tabgrp-1049">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1049-0" data-tab-group="tabgrp-1049" data-tab-active="true">

```Swift
static func updateAccountBasicInformation(context: ClientUpdateAccountBasicInformationContext, success: (() -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1049-1" data-tab-group="tabgrp-1049">

```Objective-C
+ (void)updateAccountBasicInformation:(nonnull SNRClientUpdateAccountBasicInformationContext *)context success:(nonnull void (^)(void))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **context** | [ClientUpdateAccountBasicInformationContext](/developers/mobile-sdk/class-reference/ios/client#clientupdateaccountbasicinformationcontext) | yes | - | Object with customer's basic information optional data |
| **success** | (() -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Since version 5.0.0, the **success** closure does NOT contain the `isSuccess` parameter.

</div></div></div>

  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->

## Update customer account information
---
This method updates a customer’s account information.
  
This method requires the context object with the customer’s account information. Omitted fields are not modified.
  
This method requires customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `API_PERSONAL_INFORMATION_CLIENT_UPDATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClient.h
  
**Related To:**  
[ClientUpdateAccountContext](/developers/mobile-sdk/class-reference/ios/client#clientupdateaccountcontext)
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1050">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1050-0" data-tab-group="tabgrp-1050" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1050-1" data-tab-group="tabgrp-1050">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1050-0" data-tab-group="tabgrp-1050" data-tab-active="true">

```Swift
static func updateAccount(context: ClientUpdateAccountContext, success: (() -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1050-1" data-tab-group="tabgrp-1050">

```Objective-C
+ (void)updateAccount:(nonnull SNRClientUpdateAccountContext *)context success:(nonnull void (^)(void))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **context** | [ClientUpdateAccountContext](/developers/mobile-sdk/class-reference/ios/client#clientupdateaccountcontext) | yes | - | Object with customer's email, password, and other optional data |
| **success** | (() -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Since version 5.0.0, the **success** closure does NOT contain the `isSuccess` parameter.

</div></div></div>

  
**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1051">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1051-0" data-tab-group="tabgrp-1051" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1051-1" data-tab-group="tabgrp-1051">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1051-0" data-tab-group="tabgrp-1051" data-tab-active="true">

```Swift
let agreements: ClientAgreements = ClientAgreements()
agreements.email = true
agreements.sms = true
agreements.push = true
agreements.bluetooth = true
agreements.rfid = true
agreements.wifi = true
let context: ClientUpdateAccountContext = ClientUpdateAccountContext()
context.email = "hello@synerise.com"
context.phone = "123-456-789"
context.customId = "CUSTOM_ID"
context.uuid = "UUID"
context.firstName = "FIRST_NAME"
context.lastName = "LAST_NAME"
context.displayName = "DISPLAY_NAME"
context.sex = .male
context.company = "Synerise"
context.address = "Lubostroń 1"
context.city = "Kraków"
context.province = "Małopolskie"
context.zipCode = "30-383"
context.countryCode = "+48"
context.birthDate = "01-01-2019"
context.avatarUrl = "http://www.synerise.com"
context.agreements = agreements
context.attributes = ["attribute1": "value1", "attribute2": "value2"]
context.tags = ["tag1", "tag2" "tag3"]
Client.updateAccount(context: context, success: {
  // success
}) { (error) in
  // failure
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1051-1" data-tab-group="tabgrp-1051">

```Objective-C
SNRClientAgreements *agreements = [SNRClientAgreements new];
agreements.email = true;
agreements.sms = true;
agreements.push = true;
agreements.bluetooth = true;
agreements.rfid = true;
agreements.wifi = true;
SNRClientUpdateAccountContext *context = [SNRClientUpdateAccountContext new];
context.email = @"hello@synerise.com"
context.phone = @"123-456-789";
context.customId = @"CUSTOM_ID"
context.firstName = @"FIRST_NAME";
context.lastName = @"LAST_NAME";
context.displayName = @"DISPLAY_NAME"
context.sex = SNRClientSexMale;
context.company = @"Synerise";
context.address = @"Lubostroń 1";
context.city = @"Kraków";
context.province = @"Małopolskie";
context.zipCode = @"30-383";
context.countryCode = @"+48";
context.birthDate = @"01-01-2019"
context.avatarUrl = @"http://www.synerise.com"
context.agreements = agreements;
context.attributes = @{@"attribute": @"value"};
context.tags = @[@"tag1", @"tag2" @"tag3"];
[SNRClient updateAccount:context success:^() {
  // success
} failure:^(NSError * _Nonnull error) {
  // failure
}];
```

</div>
</div>


<!-- reusable-table-boundary -->

## Change customer's account password
---
This method changes a customer’s password.
  
This method requires customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 403 status code if the provided old password is invalid.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CHANGE_PASSWORD_CLIENT_UPDATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClient.h
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1052">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1052-0" data-tab-group="tabgrp-1052" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1052-1" data-tab-group="tabgrp-1052">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1052-0" data-tab-group="tabgrp-1052" data-tab-active="true">

```Swift
static func changePassword(password: String, oldPassword: String, success: (() -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1052-1" data-tab-group="tabgrp-1052">

```Objective-C
+ (void)changePassword:(nonnull NSString *)password oldPassword:(nonnull NSString *)oldPassword success:(nonnull void (^)(void))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **password** | String | yes | - | Customer's new password |
| **oldPassword** | String | yes | - | Customer's old password |
| **success** | (() -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Since version 5.0.0, the **success** closure does NOT contain the `isSuccess` parameter.

</div></div></div>


**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1053">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1053-0" data-tab-group="tabgrp-1053" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1053-1" data-tab-group="tabgrp-1053">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1053-0" data-tab-group="tabgrp-1053" data-tab-active="true">

```Swift
let newPassword: String = "NEW_PASSWORD"
let oldPassword: String = "OLD_PASSWORD"
Client.changePassword(password: newPassword, oldPassword: oldPassword, success: {
  // success
}, failure: { (error) in
  // failure
})
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1053-1" data-tab-group="tabgrp-1053">

```Objective-C
NSString *newPassword = @"NEW_PASSWORD";
NSString *oldPassword = @"OLD_PASSWORD";
[SNRClient changePassword:newPassword oldPassword:oldPassword success:^() {
  // success
} failure:^(SNRApiError *error) {
  // failure
}];
```

</div>
</div>


<!-- reusable-table-boundary -->

## Request password reset for customer account
---
This method requests a customer’s password reset with email. The customer will receive a token to the provided email address. That token is then used for the confirmation of password reset.
  
This method requires the customer’s email.
  
This method is a global operation and doesn't require customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_PASSWORD_RESET_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClient.h
  
**Related To:**  
[ClientPasswordResetRequestContext](/developers/mobile-sdk/class-reference/ios/client#clientpasswordresetrequestcontext)
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1054">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1054-0" data-tab-group="tabgrp-1054" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1054-1" data-tab-group="tabgrp-1054">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1054-0" data-tab-group="tabgrp-1054" data-tab-active="true">

```Swift
static func requestPasswordReset(context: ClientPasswordResetRequestContext, success: (() -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1054-1" data-tab-group="tabgrp-1054">

```Objective-C
+ (void)requestPasswordReset:(nonnull SNRClientPasswordResetRequestContext *)context success:(nonnull void (^)(void))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **context** | [ClientPasswordResetRequestContext](/developers/mobile-sdk/class-reference/ios/client#clientpasswordresetrequestcontext) | yes | - | Object with the customer's email |
| **success** | (() -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Since version 5.0.0, the **success** closure does NOT contain the `isSuccess` parameter.

</div></div></div>

  
**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1055">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1055-0" data-tab-group="tabgrp-1055" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1055-1" data-tab-group="tabgrp-1055">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1055-0" data-tab-group="tabgrp-1055" data-tab-active="true">

```Swift
let email: String = "EMAIL"
let context: ClientPasswordResetRequestContext = ClientPasswordResetRequestContext(email: email)
Client.requestPasswordReset(context: context, success: {
  // success
}, failure: { (error) in
  // failure
})
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1055-1" data-tab-group="tabgrp-1055">

```Objective-C
NSString *email = @"EMAIL";
SNRClientPasswordResetRequestContext *context = [SNRClientPasswordResetRequestContext alloc] initWithEmail:email];
[SNRClient requestPasswordReset:context success:^() {
  // success
} failure:^(SNRApiError *error) {
  // failure
}];
```

</div>
</div>


<!-- reusable-table-boundary -->

## Confirm password reset for customer account
---
This method confirm a customer’s password reset with the new password and token provided by password reset request.  
  
This method requires the customer’s new password and the confirmation token received by e-mail.
  
This method is a global operation and doesn't require customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_PASSWORD_RESET_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClient.h
  
**Related To:**  
[ClientPasswordResetConfirmationContext](/developers/mobile-sdk/class-reference/ios/client#clientpasswordresetconfirmationcontext)
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1056">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1056-0" data-tab-group="tabgrp-1056" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1056-1" data-tab-group="tabgrp-1056">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1056-0" data-tab-group="tabgrp-1056" data-tab-active="true">

```Swift
static func confirmResetPassword(context: ClientPasswordResetConfirmationContext, success: (() -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1056-1" data-tab-group="tabgrp-1056">

```Objective-C
+ (void)confirmResetPassword:(nonnull SNRClientPasswordResetConfirmationContext *)context success:(nonnull void (^)(void))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **context** | [ClientPasswordResetConfirmationContext](/developers/mobile-sdk/class-reference/ios/client#clientpasswordresetconfirmationcontext) | yes | - | Object with customer's password and token |
| **success** | (() -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Since version 5.0.0, the **success** closure does NOT contain the `isSuccess` parameter.

</div></div></div>

  
**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1057">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1057-0" data-tab-group="tabgrp-1057" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1057-1" data-tab-group="tabgrp-1057">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1057-0" data-tab-group="tabgrp-1057" data-tab-active="true">

```Swift
let password: String = "PASSWORD"
let token: String = "TOKEN"
let context: ClientPasswordResetConfirmationContext = ClientPasswordResetConfirmationContext(password: password, token: token)
Client.confirmResetPassword(context: context, success: {
  // success
}, failure: { (error) in
  // failure
})
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1057-1" data-tab-group="tabgrp-1057">

```Objective-C
NSString *password = @"PASSWORD"
NSString *token = @"TOKEN"
SNRClientPasswordResetConfirmationContext *context = [[SNRClientPasswordResetConfirmationContext alloc] initWithPassword:password andToken:token];
[SNRClient confirmResetPassword:context success:^() {
  // success
} failure:^(NSError * _Nonnull error) {
  // failure
}];
```

</div>
</div>


<!-- reusable-table-boundary -->

## Request email change for customer account
---
This method requests a customer's email change.
  
This method is a global operation and doesn't require customer authentication.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 403 status code if the provided token or the password is invalid.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CHANGE_EMAIL_CLIENT_UPDATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClient.h
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1058">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1058-0" data-tab-group="tabgrp-1058" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1058-1" data-tab-group="tabgrp-1058">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1058-0" data-tab-group="tabgrp-1058" data-tab-active="true">

```Swift
static func requestEmailChange(email: String, password: String, externalToken: AnyObject?, authID: String?, success: (() -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1058-1" data-tab-group="tabgrp-1058">

```Objective-C
+ (void)requestEmailChange:(nonnull NSString *)email password:(NSString *)password externalToken:(id)externalToken authID:(NSString *)authID success:(nonnull void (^)(void))success failure:(nonnull void (^)(SNRApiError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | String | yes | - | Customer's new email |
| **password** | String | yes | - | Customer's password |
| **externalToken** | AnyObject | no | - | Customer's token (if OAuth, Facebook, and so on) |
| **authID** | String | no | - | Optional identifier of authorization |
| **success** | (() -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Since version 5.0.0, the **success** closure does NOT contain the `isSuccess` parameter.

</div></div></div>

  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->

## Confirm email change for customer account
---
This method confirms an email change.
  
This method is a global operation and doesn't require customer authentication.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 403 status code if the provided token is invalid.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CHANGE_EMAIL_CLIENT_UPDATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClient.h

**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1059">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1059-0" data-tab-group="tabgrp-1059" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1059-1" data-tab-group="tabgrp-1059">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1059-0" data-tab-group="tabgrp-1059" data-tab-active="true">

```Swift
static func confirmEmailChange(token: String, newsletterAgreement: Bool, success: (() -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1059-1" data-tab-group="tabgrp-1059">

```Objective-C
+ (void)confirmEmailChange:(nonnull NSString *)token newsletterAgreement:(BOOL)newsletterAgreement success:(nonnull void (^)(void))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **token** | String | yes | - | Customer's token provided in an email |
| **newsletterAgreement** | Bool | yes | - | Agreement for sending newsletters to the provided email |
| **success** | (() -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Since version 5.0.0, the **success** closure does NOT contain the `isSuccess` parameter.

</div></div></div>


**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1060">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1060-0" data-tab-group="tabgrp-1060" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1060-1" data-tab-group="tabgrp-1060">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1060-0" data-tab-group="tabgrp-1060" data-tab-active="true">

```Swift
let token: String = "TOKEN"
Client.confirmEmailChange(token: token, success: {
  // success
}) { (error) in
  // failure
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1060-1" data-tab-group="tabgrp-1060">

```Objective-C
NSString *token = @"TOKEN";
[SNRClient confirmEmailChange:token newsletterAgreement:YES success:^() {
  // success
} failure:^(SNRApiError *error) {
  // failure
}];
```

</div>
</div>


<!-- reusable-table-boundary -->

## Request phone update on customer account
---
This method requests a customer's phone update. A confirmation code is sent to the phone number.
  
This method is a global operation and doesn't require customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `API_PERSONAL_PHONE_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClient.h

**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1061">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1061-0" data-tab-group="tabgrp-1061" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1061-1" data-tab-group="tabgrp-1061">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1061-0" data-tab-group="tabgrp-1061" data-tab-active="true">

```Swift
static func requestPhoneUpdate(phone: String, success: (() -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1061-1" data-tab-group="tabgrp-1061">

```Objective-C
+ (void)requestPhoneUpdate:(nonnull NSString *)phone success:(nonnull void (^)(void))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **phone** | String | yes | - | Customer's new phone number |
| **success** | (() -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Since version 5.0.0, the **success** closure does NOT contain the `isSuccess` parameter.

</div></div></div>

  
**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1062">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1062-0" data-tab-group="tabgrp-1062" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1062-1" data-tab-group="tabgrp-1062">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1062-0" data-tab-group="tabgrp-1062" data-tab-active="true">

```Swift
let phone: String = "123-456-789"
Client.requestPhoneUpdate(phone: phone, success: {
  // success
}, failure: { (error) in
  // failure
})
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1062-1" data-tab-group="tabgrp-1062">

```Objective-C
NSString *phone = @"123-456-789";
[SNRClient requestPhoneUpdate:phone success:^() {
  // success
} failure:^(SNRApiError *error) {
  // failure 
}];
```

</div>
</div>


<!-- reusable-table-boundary -->

## Confirm phone update on customer account
---
This method confirms a phone number update. This action requires the new phone number and confirmation code as parameters.
  
This method is a global operation and doesn't require customer authentication.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 403 status code if the provided UUID does not exist or the password is invalid.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `API_PERSONAL_PHONE_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClient.h
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1063">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1063-0" data-tab-group="tabgrp-1063" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1063-1" data-tab-group="tabgrp-1063">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1063-0" data-tab-group="tabgrp-1063" data-tab-active="true">

```Swift
static func confirmPhoneUpdate(phone: String, confirmationCode: String, smsAgreement: Bool, success: (() -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1063-1" data-tab-group="tabgrp-1063">

```Objective-C
+ (void)confirmPhoneUpdate:(nonnull NSString *)phone confirmationCode:(nonnull NSString *)confirmationCode smsAgreement:(BOOL)smsAgreement success:(nonnull void (^)(void))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **phone** | String | yes | - | New phone number |
| **confirmationCode** | String | yes | - | A confirmation code received by a text message |
| **smsAgreement** | Bool | yes | - | Agreement for sending SMS to the provided number |
| **success** | (() -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Since version 5.0.0, the **success** closure does NOT contain the `isSuccess` parameter.

</div></div></div>


**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1064">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1064-0" data-tab-group="tabgrp-1064" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1064-1" data-tab-group="tabgrp-1064">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1064-0" data-tab-group="tabgrp-1064" data-tab-active="true">

```Swift
let phone: String = "123-456-789"
let confirmationCode: String = "CONFIRMATION_CODE"
Client.confirmPhoneUpdate(phone: phone, confirmationCode: confirmationCode, smsAgreement: true, success: {
  // success
}) { (error) in
  // failure
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1064-1" data-tab-group="tabgrp-1064">

```Objective-C
NSString *phone = @"123-456-789";
NSString *confirmationCode = @"CONFIRMATION_CODE";
[SNRClient confirmPhoneUpdate:phone confirmationCode:confirmationCode smsAgreement:YES success:^() {
  // success
} failure:^(SNRApiError *error) {
  // failure
}];
```

</div>
</div>


<!-- reusable-table-boundary -->

## Delete customer account by Identity Provider
---
This method deletes a customer's account.
  
This method requires customer authentication.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

HTTP 403 status code is returned if the provided password or token is invalid.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CLIENT_DELETE`, `SAUTH_OAUTH_CLIENT_DELETE`, `SAUTH_FACEBOOK_CLIENT_DELETE`, `SAUTH_APPLE_CLIENT_DELETE` permissions from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClient.h

**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1065">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1065-0" data-tab-group="tabgrp-1065" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1065-1" data-tab-group="tabgrp-1065">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1065-0" data-tab-group="tabgrp-1065" data-tab-active="true">

```Swift
static func deleteAccount(clientAuthFactor: String, clientIdentityProvider: ClientIdentityProvider, authID: String, success: (() -> Void), failure: ((ApiError) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1065-1" data-tab-group="tabgrp-1065">

```Objective-C
+ (void)deleteAccount:(nonnull id)clientAuthFactor
clientIdentityProvider:(SNRClientIdentityProvider)clientIdentityProvider authID:(nullable NSString *)authID success:(nonnull void (^)(void))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **clientAuthFactor** | String | yes | - | Customer's token from the identity provider |
| **clientIdentityProvider** | [ClientIdentityProvider](/developers/mobile-sdk/class-reference/ios/client#clientidentityprovider) | yes | - | Customer's identity provider |
| **authID** | String | no | - | Optional identifier of authorization |
| **success** | (() -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Since version 5.0.0, the **success** closure does NOT contain the `isSuccess` parameter.

</div></div></div>

  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->

## Removed methods

### <del>Request email change for customer account by Facebook</del> {#request-email-change-for-customer-account-by-facebook}
---
This method requests a customer's email change by Facebook.
  
This method is a global operation and doesn't require customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CHANGE_EMAIL_CLIENT_UPDATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Replaced By:**  
[Request email change for customer account](/developers/mobile-sdk/method-reference/ios/client-account#request-email-change-for-customer-account)

**Declared In:**  
Headers/SNRClient.h
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1066">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1066-0" data-tab-group="tabgrp-1066" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1066-1" data-tab-group="tabgrp-1066">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1066-0" data-tab-group="tabgrp-1066" data-tab-active="true">

```Swift
static func requestEmailChangeByFacebook(email: String, success: ((Bool) -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1066-1" data-tab-group="tabgrp-1066">

```Objective-C
+ (void)requestEmailChangeByFacebook:(nonnull NSString *)email success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | String | yes | - | Customer's new email |
| **success** | ((Bool) -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  
**Return Value:**  
No value is returned.

**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1067">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1067-0" data-tab-group="tabgrp-1067" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1067-1" data-tab-group="tabgrp-1067">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1067-0" data-tab-group="tabgrp-1067" data-tab-active="true">

```Swift
let email: String = "EMAIL"
Client.requestEmailChange(email: email, success: { success in
  // success
}) { (error) in
  // failure
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1067-1" data-tab-group="tabgrp-1067">

```Objective-C
NSString *email = @"EMAIL";
[SNRClient requestEmailChangeByFacebook:email success:^(BOOL isSuccess) {
  // success
} failure:^(SNRApiError *error) {
  // failure
}];
```

</div>
</div>


<!-- reusable-table-boundary -->

### <del>Delete customer account</del> {#delete-customer-account}
---
<!-- reusable-table-boundary -->

This method deletes a customer's account.
  
This method requires customer authentication.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.6.11 | 3.6.13 | 0.9.12 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.6.19 | 3.6.19 | 0.14.0 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | n/a | n/a |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 403 status code is returned if the provided password is invalid.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CLIENT_DELETE` permission from the **Client** group.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Replaced By:**  
[Delete customer account by Identity Provider](/developers/mobile-sdk/method-reference/ios/client-account#delete-customer-account-by-identity-provider)

**Declared In:**  
Headers/SNRClient.h
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1068">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1068-0" data-tab-group="tabgrp-1068" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1068-1" data-tab-group="tabgrp-1068">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1068-0" data-tab-group="tabgrp-1068" data-tab-active="true">

```Swift
static func deleteAccount(password: String, success: ((Bool) -> Void), failure: ((ApiError) -> Void))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1068-1" data-tab-group="tabgrp-1068">

```Objective-C
+ (void)deleteAccount:(nonnull NSString *)password success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **password** | String | yes | - | Customer's password |
| **success** | ((Bool) -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  
**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1069">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1069-0" data-tab-group="tabgrp-1069" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1069-1" data-tab-group="tabgrp-1069">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1069-0" data-tab-group="tabgrp-1069" data-tab-active="true">

```Swift
let password: String = "PASSWORD"
Client.deleteAccount(password: password, success: { (success) in
  // success
}) { (error) in
  // failure
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1069-1" data-tab-group="tabgrp-1069">

```Objective-C
NSString *password = "PASSWORD";
[SNRClient deleteAccount:password success:^(BOOL isSuccess) {
  // success
} failure:^(SNRApiError *error) {
  // failure
}];
```

</div>
</div>


<!-- reusable-table-boundary -->

### <del>Delete customer account by OAuth</del> {#delete-customer-account-by-oauth}
---
<!-- reusable-table-boundary -->

This method deletes a customer's account by OAuth.
  
This method requires customer authentication.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.6.11 | 3.6.13 | 0.9.12 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.6.19 | 3.6.19 | 0.14.0 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | n/a | n/a |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CLIENT_DELETE` and `SAUTH_OAUTH_CLIENT_DELETE` permissions from the **Client** group.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Replaced By:**  
[Delete customer account by Identity Provider](/developers/mobile-sdk/method-reference/ios/client-account#delete-customer-account-by-identity-provider)

**Declared In:**  
Headers/SNRClient.h
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1070">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1070-0" data-tab-group="tabgrp-1070" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1070-1" data-tab-group="tabgrp-1070">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1070-0" data-tab-group="tabgrp-1070" data-tab-active="true">

```Swift
static func deleteAccountByOAuth(accessToken: String, success: ((Bool) -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1070-1" data-tab-group="tabgrp-1070">

```Objective-C
+ (void)deleteAccountByOAuth:(nonnull NSString *)accessToken success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **accessToken** | String | yes | - | OAuth Access Token |
| **success** | ((Bool) -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->

### <del>Delete customer account by Facebook</del> {#delete-customer-account-by-facebook}
---
<!-- reusable-table-boundary -->

This method deletes a customer's account by Facebook.
  
This method requires customer authentication.

| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.3.8 | 3.3.0 | 0.9.12 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.6.19 | 3.6.19 | 0.14.0 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | n/a | n/a |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CLIENT_DELETE` and `SAUTH_FACEBOOK_CLIENT_DELETE` permissions from the **Client** group.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Replaced By:**  
[Delete customer account by Identity Provider](/developers/mobile-sdk/method-reference/ios/client-account#delete-customer-account-by-identity-provider)

**Declared In:**  
Headers/SNRClient.h
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1071">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1071-0" data-tab-group="tabgrp-1071" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1071-1" data-tab-group="tabgrp-1071">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1071-0" data-tab-group="tabgrp-1071" data-tab-active="true">

```Swift
static func deleteAccountByFacebook(facebookToken: String, success: ((Bool) -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1071-1" data-tab-group="tabgrp-1071">

```Objective-C
+ (void)deleteAccountByFacebook:(nonnull NSString *)facebookToken success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **facebookToken** | String | yes | - | Token from an active Facebook session |
| **success** | ((Bool) -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  
**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1072">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1072-0" data-tab-group="tabgrp-1072" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1072-1" data-tab-group="tabgrp-1072">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1072-0" data-tab-group="tabgrp-1072" data-tab-active="true">

```Swift
guard let facebookToken = FBSDKAccessToken.current()?.tokenString else {
    return
}
Client.deleteAccountByFacebookToken(facebookToken: facebookToken, success: { (success) in
  // success
}, failure: { (error) in
  // failure
})
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1072-1" data-tab-group="tabgrp-1072">

```Objective-C
NSString *facebookToken =  [FBSDKAccessToken currentAccessToken].tokenString;
[SNRClient deleteAccountByFacebook:facebookToken success:^(BOOL isSuccess) {
  // success
} failure:^(SNRApiError *error) {
  // failure
}];
```

</div>
</div>


<!-- reusable-table-boundary -->

### <del>Delete customer account by Apple Sign In</del> {#delete-customer-account-by-apple-sign-in}
---
<!-- reusable-table-boundary -->

This method deletes a customer's account information by Sign In With Apple.
  
This method requires customer authentication.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.6.11 | 3.6.13 | 0.9.12 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.6.19 | 3.6.19 | 0.14.0 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | n/a | n/a | n/a |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CLIENT_DELETE` and `SAUTH_APPLE_CLIENT_DELETE` permissions from the **Client** group.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Replaced By:**  
[Delete customer account by Identity Provider](/developers/mobile-sdk/method-reference/ios/client-account#delete-customer-account-by-identity-provider)

**Declared In:**  
Headers/SNRClient.h
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1073">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1073-0" data-tab-group="tabgrp-1073" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1073-1" data-tab-group="tabgrp-1073">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1073-0" data-tab-group="tabgrp-1073" data-tab-active="true">

```Swift
static func deleteAccountByAppleSignIn(identityToken: Data, success: ((Bool) -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1073-1" data-tab-group="tabgrp-1073">

```Objective-C
+ (void)deleteAccountByAppleSignIn:(nonnull NSData *)identityToken success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **identityToken** | Data | yes | - |  Token from Sign In With Apple session |
| **success** | ((Bool) -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->


# Customer account management


---
## Get customer account information
---
This method gets a customer’s account information.
  
This method requires customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `API_PERSONAL_INFORMATION_CLIENT_READ` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/client/client_impl.dart
  
**Related To:**  
[ClientAccountInformation](/developers/mobile-sdk/class-reference/flutter/client#clientaccountinformation)  
  
**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)
  

<div class="content-tabs" data-tab-group="tabgrp-950">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-950-0" data-tab-group="tabgrp-950" data-tab-active="true">SDK &gt;= 1.0.0</button><button class="tab-button" data-tab-id="tabgrp-950-1" data-tab-group="tabgrp-950">Legacy SDK</button></div>

<div class="tab-panel" data-tab-id="tabgrp-950-0" data-tab-group="tabgrp-950" data-tab-active="true">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; getAccount({required void Function(ClientAccountInformation) onSuccess, required void Function(SyneriseError) onError}) async</code></pre>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **onSuccess** | Function([ClientAccountInformation](/developers/mobile-sdk/class-reference/flutter/client#clientaccountinformation) clientAccountInformation) | yes | - | Function to be executed when the operation is completed successfully |
| **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error |

**Return Value:**  
No value is returned. 
  
**Example:**

<pre><code class="language-Dart">await Synerise.client.getAccount(onSuccess: (ClientAccountInformation result) {
  //onSuccess handling
}, onError: (SyneriseError error) {
  //onError handling
});</code></pre>

</div>

<div class="tab-panel" data-tab-id="tabgrp-950-1" data-tab-group="tabgrp-950">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;ClientAccountInformation&gt; getAccount() async</code></pre>

  
**Return Value:**   
[ClientAccountInformation](/developers/mobile-sdk/class-reference/flutter/client#clientaccountinformation)   
  
**Example:**

<pre><code class="language-Dart">final ClientAccountInformation clientAccountInformation = await Synerise.client.getAccount().catchError((error)</code></pre>

</div>
</div>


<!-- reusable-table-boundary -->

## Update customer account basic information
---
<!-- reusable-table-boundary -->

This method updates a customer’s account’s basic information (without identification data: uuid, customId, email).
  
This method requires the context object with the customer’s account information. Omitted fields are not modified.
  
This method does not require customer authentication and can be used by anonymous profiles.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.22.0 | 5.21.0 | 0.24.0 | 1.4.0 |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `API_BASIC_INFORMATION_CLIENT_UPDATE` permission from the **Client** group.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/client/client_impl.dart

**Related To:**  
[ClientAccountUpdateBasicInformationContext](/developers/mobile-sdk/class-reference/flutter/client#clientaccountupdatebasicinformationcontext)

**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; updateAccountBasicInformation(ClientAccountUpdateBasicInformationContext context,
      {required void Function() onSuccess,
      required void Function(SyneriseError error) onError}) async</code></pre>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **context** | [ClientAccountUpdateBasicInformationContext](/developers/mobile-sdk/class-reference/flutter/client#clientaccountupdatebasicinformationcontext) | yes | - | Object with customer’s first name, phone, and other optional data |
| **onSuccess** | Function() | yes | - | Function to be executed when the operation is completed successfully |
| **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error |

**Return Value:**  
No value is returned.

**Example:**  

<pre><code class="language-Dart">ClientAccountUpdateBasicInformationContext context = ClientAccountUpdateBasicInformationContext(
        email: email,
        password: password,
        firstName: firstName,
        lastName: lastName,
        sex: ClientSex.getClientSexFromString(sex));

    await Synerise.client.updateAccountBasicInformation(clientAccountUpdateContext, onSuccess: () {
      //onSuccess handling
    }, onError: (SyneriseError error) {
      //onError handling
    });</code></pre>


<!-- reusable-table-boundary -->

## Update customer account information
---
This method updates a customer’s account information.
  
This method requires the context object with the customer’s account information. Omitted fields are not modified.
  
This method requires customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `API_PERSONAL_INFORMATION_CLIENT_UPDATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/client/client_impl.dart

**Related To:**  
[ClientAccountUpdateContext](/developers/mobile-sdk/class-reference/flutter/client#clientaccountupdatecontext)

**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)


<div class="content-tabs" data-tab-group="tabgrp-951">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-951-0" data-tab-group="tabgrp-951" data-tab-active="true">SDK &gt;= 1.0.0</button><button class="tab-button" data-tab-id="tabgrp-951-1" data-tab-group="tabgrp-951">Legacy SDK</button></div>

<div class="tab-panel" data-tab-id="tabgrp-951-0" data-tab-group="tabgrp-951" data-tab-active="true">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; updateAccount(ClientAccountUpdateContext context,
      {required void Function() onSuccess,
      required void Function(SyneriseError error) onError}) async</code></pre>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **context** | [ClientAccountUpdateContext](/developers/mobile-sdk/class-reference/flutter/client#clientaccountupdatecontext) | yes | - | Object with customer's email, password, and other optional data |
| **onSuccess** | Function() | yes | - | Function to be executed when the operation is completed successfully |
| **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error |

**Return Value:**  
No value is returned.

**Example:**  

<pre><code class="language-Dart">ClientAccountUpdateContext clientAccountUpdateContext = ClientAccountUpdateContext(
        email: email,
        password: password,
        firstName: firstName,
        lastName: lastName,
        sex: ClientSex.getClientSexFromString(sex));

    await Synerise.client.updateAccount(clientAccountUpdateContext, onSuccess: () {
      //onSuccess handling
    }, onError: (SyneriseError error) {
      //onError handling
    });</code></pre>

</div>

<div class="tab-panel" data-tab-id="tabgrp-951-1" data-tab-group="tabgrp-951">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; updateAccount(ClientAccountUpdateContext context) async</code></pre>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **context** | [ClientAccountUpdateContext](/developers/mobile-sdk/class-reference/flutter/client#clientaccountupdatecontext) | yes | - | Object with customer's email, password, and other optional data |

**Return Value:**  
No value is returned.

**Example:**  

<pre><code class="language-Dart">ClientAccountUpdateContext clientAccountUpdateContext = ClientAccountUpdateContext(
        email: email,
        password: password,
        firstName: firstName,
        lastName: lastName,
        sex: ClientSex.getClientSexFromString(sex));

    await Synerise.client.updateAccount(clientAccountUpdateContext).catchError((error) {
      //onError handling
    });</code></pre>

</div>
</div>


<!-- reusable-table-boundary -->

## Change customer's account password
---
This method changes a customer’s password.
  
This method requires customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 403 status code if the provided old password is invalid.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CHANGE_PASSWORD_CLIENT_UPDATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/client/client_impl.dart  
  
**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)


<div class="content-tabs" data-tab-group="tabgrp-952">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-952-0" data-tab-group="tabgrp-952" data-tab-active="true">SDK &gt;= 1.0.0</button><button class="tab-button" data-tab-id="tabgrp-952-1" data-tab-group="tabgrp-952">Legacy SDK</button></div>

<div class="tab-panel" data-tab-id="tabgrp-952-0" data-tab-group="tabgrp-952" data-tab-active="true">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; changePassword(String oldPassword, String newPassword,
    {required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **oldPassword** | String | yes | - | Customer’s old password |
| **newPassword** | String | yes | - | Customer’s new password |
| **onSuccess** | Function() | yes | - | Function to be executed when the operation is completed successfully |
| **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error |

**Return Value:**  
No value is returned.
  
**Example:**  

<pre><code class="language-Dart">await Synerise.client.changePassword(oldPassword, newPassword, onSuccess: () {
      //onSuccess handling
    }, onError: (SyneriseError error) {
      //onError handling
    });</code></pre>

</div>

<div class="tab-panel" data-tab-id="tabgrp-952-1" data-tab-group="tabgrp-952">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; changePassword(String oldPassword,  String password) async</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **newPassword** | String | yes | - | Customer’s new password |
| **oldPassword** | String | yes | - | Customer’s old password |
  
**Return Value:**  
No value is returned.
  
**Example:**  

<pre><code class="language-Dart">await  Synerise.client.changePassword(oldPassword, password).catchError((error)</code></pre>

</div>
</div>


<!-- reusable-table-boundary -->

## Request password reset for customer account
---
This method requests a customer’s password reset with email. The customer will receive a token to the provided email address. That token is then used for the confirmation of password reset.
  
This method requires the customer’s email.
  
This method is a global operation and doesn't require customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_PASSWORD_RESET_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/client/client_impl.dart
  
**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)
  

<div class="content-tabs" data-tab-group="tabgrp-953">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-953-0" data-tab-group="tabgrp-953" data-tab-active="true">SDK &gt;= 1.0.0</button><button class="tab-button" data-tab-id="tabgrp-953-1" data-tab-group="tabgrp-953">Legacy SDK</button></div>

<div class="tab-panel" data-tab-id="tabgrp-953-0" data-tab-group="tabgrp-953" data-tab-active="true">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; requestPasswordReset(String email, {required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | String | yes | - | Customer’s email |
| **onSuccess** | Function() | yes | - | Function to be executed when the operation is completed successfully |
| **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error |
  
**Return Value:**  
No value is returned.
  
**Example:**  

<pre><code class="language-Dart">await Synerise.client.requestPasswordReset(email, onSuccess: () {
  //onSuccess handling
}, onError: (SyneriseError error) {
  //onError handling
});</code></pre>

</div>

<div class="tab-panel" data-tab-id="tabgrp-953-1" data-tab-group="tabgrp-953">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; requestPasswordReset(String email) async</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | String | yes | - | Customer’s email |
  
**Return Value:**  
No value is returned.
  
**Example:**  

<pre><code class="language-Dart">await  Synerise.client.requestPasswordReset(email).catchError((error)</code></pre>

</div>
</div>


<!-- reusable-table-boundary -->

## Confirm password reset for customer account
---
This method confirm a customer’s password reset with the new password and token provided by password reset request.  
  
This method requires the customer’s new password and the confirmation token received by e-mail.
  
This method is a global operation and doesn't require customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_PASSWORD_RESET_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/client/client_impl.dart  
  
**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)


<div class="content-tabs" data-tab-group="tabgrp-954">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-954-0" data-tab-group="tabgrp-954" data-tab-active="true">SDK &gt;= 1.0.0</button><button class="tab-button" data-tab-id="tabgrp-954-1" data-tab-group="tabgrp-954">Legacy SDK</button></div>

<div class="tab-panel" data-tab-id="tabgrp-954-0" data-tab-group="tabgrp-954" data-tab-active="true">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; confirmPasswordReset(String password, String token, {required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **password** | String | yes | - | New password for the customer |
| **token** | String | yes | - | Customer's token provided in an email |
| **onSuccess** | Function() | yes | - | Function to be executed when the operation is completed successfully |
| **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error |

**Return Value:**  
No value is returned.
  
**Example:**  

<pre><code class="language-Dart">await Synerise.client.confirmPasswordReset(password, token, onSuccess: () {
  //onSuccess handling
}, onError: (SyneriseError error) {
  //onError handling
});</code></pre>

</div>

<div class="tab-panel" data-tab-id="tabgrp-954-1" data-tab-group="tabgrp-954">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; confirmPasswordReset(String password, String token) async</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | String | yes | - | Customer’s email |
| **token** | String | yes | - | Customer's token provided in an email |
  
**Return Value:**  
No value is returned.
  
**Example:**  

<pre><code class="language-Dart">await  Synerise.client.confirmPasswordReset(email, token).catchError((error)</code></pre>

</div>
</div>


<!-- reusable-table-boundary -->

## Delete customer account
---
<!-- reusable-table-boundary -->

This method deletes a customer's account.
  
This method requires customer authentication.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.6.11 | 3.6.13 | 0.9.12 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.6.19 | 3.6.19 | 0.14.0 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | n/a | n/a |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 403 status code is returned if the provided password is invalid.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CLIENT_DELETE` permission from the **Client** group.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/client/client_impl.dart

**Related To:**  
[ClientIdentityProvider](/developers/mobile-sdk/class-reference/flutter/client#clientidentityprovider)  

**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)


<div class="content-tabs" data-tab-group="tabgrp-955">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-955-0" data-tab-group="tabgrp-955" data-tab-active="true">SDK &gt;= 1.0.0</button><button class="tab-button" data-tab-id="tabgrp-955-1" data-tab-group="tabgrp-955">Legacy SDK</button></div>

<div class="tab-panel" data-tab-id="tabgrp-955-0" data-tab-group="tabgrp-955" data-tab-active="true">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; deleteAccount(String clientAuthFactor, IdentityProvider identityProvider, {String? authId, required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **clientAuthFactor** | String | yes | - | Customer’s password or token from the identity provider |
| **identityProvider** | [ClientIdentityProvider](/developers/mobile-sdk/class-reference/flutter/client#clientidentityprovider) | yes | - | Customer's identity provider |
| **authID** | String | no | null | Optional identifier of authorization |
| **onSuccess** | Function() | yes | - | Function to be executed when the operation is completed successfully |
| **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error |

**Return Value:**  
No value is returned.

**Example:**  

<pre><code class="language-Dart">await Synerise.client.deleteAccount(clientAuthFactor, identityProvider, authId, onSuccess: () {
  //onSuccess handling
}, onError: (SyneriseError error) {
  //onError handling
});</code></pre>

</div>

<div class="tab-panel" data-tab-id="tabgrp-955-1" data-tab-group="tabgrp-955">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; deleteAccount(String clientAuthFactor,  IdentityProvider identityProvider,  String? authId) async</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **clientAuthFactor** | String | yes | - | Customer’s password or token from the identity provider |
| **identityProvider** | [ClientIdentityProvider](/developers/mobile-sdk/class-reference/flutter/client#clientidentityprovider) | yes | - | Customer's identity provider |
| **authID** | String | yes | null | Optional identifier of authorization |

**Return Value:**  
No value is returned.

**Example:**  

<pre><code class="language-Dart">await  Synerise.client.deleteAccount(clientAuthFactor, identityProvider, authId).catchError((error)</code></pre>

</div>
</div>


<!-- reusable-table-boundary -->

## Request email change for customer account
---
This method requests a customer's email change.
  
This method is a global operation and doesn't require customer authentication.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 403 status code if the provided token or the password is invalid.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CHANGE_EMAIL_CLIENT_UPDATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/client/client_impl.dart
  
**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)
  

<div class="content-tabs" data-tab-group="tabgrp-956">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-956-0" data-tab-group="tabgrp-956" data-tab-active="true">SDK &gt;= 1.0.0</button><button class="tab-button" data-tab-id="tabgrp-956-1" data-tab-group="tabgrp-956">Legacy SDK</button></div>

<div class="tab-panel" data-tab-id="tabgrp-956-0" data-tab-group="tabgrp-956" data-tab-active="true">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; requestEmailChange(String email, String password, {String? externalToken, String? authID, required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

    
**Parameters:**  
| Parameter | Type | Mandatory | Description |
| --- | --- | --- | --- |
| **email** | String | yes | Customer's new email |
| **password** | String | yes | Customer's password |
| **externalToken** | String | no | Customer's token (if OAuth, Facebook, and so on) |
| **authID** | String | no | Optional identifier of authorization |
| **onSuccess** | Function() | yes | - | Function to be executed when the operation is completed successfully |
| **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error |
  
**Return Value:**  
No value is returned.

**Example:**

<pre><code class="language-Dart">await Synerise.client.requestEmailChange(email, password, externalToken: externalToken, authID: authID, onSuccess: () {
  //onSuccess handling
}, onError: (SyneriseError error) {
  //onError handling
});</code></pre>

</div>

<div class="tab-panel" data-tab-id="tabgrp-956-1" data-tab-group="tabgrp-956">

**Declared In:**  
lib/modules/client/client_impl.dart

**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)
  
**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; requestEmailChange(String email, String password, [String? externalToken, String? authID]) async</code></pre>

    
**Parameters:**  
| Parameter | Type | Mandatory | Description |
| --- | --- | --- | --- |
| **email** | String | yes | Customer's new email |
| **password** | String | yes | Customer's password |
| **externalToken** | String | no | Customer's token (if OAuth, Facebook, and so on) |
| **authID** | String | no | Optional identifier of authorization |
  
**Return Value:**  
No value is returned.

**Example:**

<pre><code class="language-Dart">await Synerise.client.requestEmailChange(email, password).catchError((error) {</code></pre>

</div>
</div>


<!-- reusable-table-boundary -->

## Confirm email change for customer account
---
This method confirms an email change.
  
This method is a global operation and doesn't require customer authentication.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 403 status code if the provided token is invalid.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CHANGE_EMAIL_CLIENT_UPDATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/client/client_impl.dart

**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)
  

<div class="content-tabs" data-tab-group="tabgrp-957">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-957-0" data-tab-group="tabgrp-957" data-tab-active="true">SDK &gt;= 1.0.0</button><button class="tab-button" data-tab-id="tabgrp-957-1" data-tab-group="tabgrp-957">Legacy SDK</button></div>

<div class="tab-panel" data-tab-id="tabgrp-957-0" data-tab-group="tabgrp-957" data-tab-active="true">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; confirmEmailChange(String token, bool newsletterAgreement,
      {required void Function() onSuccess,
      required void Function(SyneriseError error) onError}) async</code></pre>


**Parameters:**  
| Parameter | Type | Mandatory | Description |
| --- | --- | --- | --- |
| **token** | String | yes | Customer's token provided in an email |
| **newsletterAgreement** | bool | yes | Agreement for sending newsletters to the provided email |
| **onSuccess** | Function() | yes | Function to be executed when the operation is completed successfully |
| **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | Function to be executed when the operation is completed with an error |

**Return Value:**  
No value is returned.
  
**Example:**  

<pre><code class="language-Dart">await Synerise.client.confirmAccountActivationByPin(email, pinCode, onSuccess: () {
    //onSuccess handling
  }, onError: (SyneriseError error) {
    //onError handling
  });</code></pre>

</div>

<div class="tab-panel" data-tab-id="tabgrp-957-1" data-tab-group="tabgrp-957">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; confirmEmailChange(String token, bool newsletterAgreement) async</code></pre>


**Parameters:**  
| Parameter | Type | Mandatory | Description |
| --- | --- | --- | --- |
| **token** | String | yes | Customer's token provided in an email |
| **newsletterAgreement** | bool | yes | Agreement for sending newsletters to the provided email |

**Return Value:**  
No value is returned.
  
**Example:**

<pre><code class="language-Dart">await Synerise.client.confirmEmailChange(token, true).catchError((error) {</code></pre>

</div>
</div>


<!-- reusable-table-boundary -->

## Request phone update on customer account
---
This method requests a customer's phone update. A confirmation code is sent to the phone number.
  
This method is a global operation and doesn't require customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `API_PERSONAL_PHONE_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/client/client_impl.dart
  
**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)
  

<div class="content-tabs" data-tab-group="tabgrp-958">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-958-0" data-tab-group="tabgrp-958" data-tab-active="true">SDK &gt;= 1.0.0</button><button class="tab-button" data-tab-id="tabgrp-958-1" data-tab-group="tabgrp-958">Legacy SDK</button></div>

<div class="tab-panel" data-tab-id="tabgrp-958-0" data-tab-group="tabgrp-958" data-tab-active="true">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; requestPhoneUpdate(String phone, {required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

    
**Parameters:**  
| Parameter | Type | Mandatory | Description |
| --- | --- | --- | --- |
| **phone** | String | yes | Customer's new phone number |
| **onSuccess** | Function() | yes | - | Function to be executed when the operation is completed successfully |
| **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error |
  
**Return Value:**  
No value is returned.
  
**Example:**  

<pre><code class="language-Dart">await Synerise.client.requestPhoneUpdate(phone, onSuccess: () {
  //onSuccess handling
}, onError: (SyneriseError error) {
  //onError handling
});</code></pre>

</div>

<div class="tab-panel" data-tab-id="tabgrp-958-1" data-tab-group="tabgrp-958">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; requestPhoneUpdate(String phone) async</code></pre>

    
**Parameters:**  
| Parameter | Type | Mandatory | Description |
| --- | --- | --- | --- |
| **phone** | String | yes | Customer's new phone number |
  
**Return Value:**  
No value is returned.
  
**Example:**

<pre><code class="language-Dart">await Synerise.client.requestPhoneUpdate(phone).catchError((error) {</code></pre>

</div>
</div>


<!-- reusable-table-boundary -->

## Confirm phone update on customer account
---
This method confirms a phone number update. This action requires the new phone number and confirmation code as parameters.
  
This method is a global operation and doesn't require customer authentication.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 403 status code if the provided UUID does not exist or the password is invalid.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `API_PERSONAL_PHONE_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/client/client_impl.dart

**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)
  

<div class="content-tabs" data-tab-group="tabgrp-959">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-959-0" data-tab-group="tabgrp-959" data-tab-active="true">SDK &gt;= 1.0.0</button><button class="tab-button" data-tab-id="tabgrp-959-1" data-tab-group="tabgrp-959">Legacy SDK</button></div>

<div class="tab-panel" data-tab-id="tabgrp-959-0" data-tab-group="tabgrp-959" data-tab-active="true">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; confirmPhoneUpdate(String phone, String confirmationCode, bool smsAgreement, {required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Description |
| --- | --- | --- | --- |
| **phone** | String | yes | New phone number |
| **confirmationCode** | String | yes | A confirmation code received by a text message |
| **smsAgreement** | bool | yes | Agreement for sending SMS to the provided number |
| **onSuccess** | Function() | yes | Function to be executed when the operation is completed successfully |
| **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | Function to be executed when the operation is completed with an error |

**Return Value:**  
No value is returned.
  
**Example:**  

<pre><code class="language-Dart">await Synerise.client.confirmPhoneUpdate(phone, confirmationCode, smsAgreement, onSuccess: () {
  //onSuccess handling
}, onError: (SyneriseError error) {
  //onError handling
});</code></pre>

</div>

<div class="tab-panel" data-tab-id="tabgrp-959-1" data-tab-group="tabgrp-959">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; confirmPhoneUpdate(String phone, String confirmationCode, bool smsAgreement) async</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Description |
| --- | --- | --- | --- |
| **phone** | String | yes | New phone number |
| **confirmationCode** | String | yes | A confirmation code received by a text message |
| **smsAgreement** | bool | yes | Agreement for sending SMS to the provided number |

**Return Value:**  
No value is returned.
  
**Example:**

<pre><code class="language-Dart">await Synerise.client.confirmPhoneUpdate(phone, confirmationCode, true).catchError((error) {</code></pre>

</div>
</div>


<!-- reusable-table-boundary -->



# React Native

## Configuring push notifications (React Native)

### Configuring Firebase
---

Google Firebase Cloud Messaging is necessary to handle [push notifications](/docs/campaign/Mobile) sent from Synerise.

1. Follow the instructions in [this article](https://firebase.google.com/docs/storage/ios/start).
2. Integrate the Firebase project with Synerise. See [this article](/docs/settings/tool/firebase).

### Setting up - Android {id=setting-up-android}
---

#### Requirements {id=android-requirements}

After configuring Firebase, add the `google-services.json` file to your project/android/app catalog.

#### Firebase Cloud Messaging integration {id=android-firebase-cloud-messaging-integration}

1. Add the google-services dependency to your project's `build.gradle` file.
  
   <pre><code class="language-gradle">dependencies {
             ...
             classpath 'com.google.gms:google-services:4.3.3'
             ...
         }</code></pre>

2. Configure the application's `build.gradle` as follows:
  
   <pre><code class="language-gradle">dependencies {
         implementation fileTree(dir: "libs", include: ["*.jar"])
         implementation "com.facebook.react:react-native:+"  // from node_modules

         // FCM
         implementation "com.google.firebase:firebase-messaging:20.0.1"
         implementation "com.google.android.gms:play-services-base:17.1.0"
         implementation "com.google.firebase:firebase-core:17.2.1"
         implementation "com.google.firebase:firebase-analytics:17.2.1"
             ...
         }</code></pre>


1. Make sure that at the end of the application gradle file, you add plugin: 'com.google.gms.google-services'

1. In your MainApplication class, include `setPushListener` to listen for the changes of the Firebase token.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-550">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-550-0" data-tab-group="tabgrp-550" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-550-1" data-tab-group="tabgrp-550">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-550-0" data-tab-group="tabgrp-550" data-tab-active="true">

```Java
@Override
  public void onCreate() {
    super.onCreate();
    SoLoader.init(this, /* native exopackage */ false);
    getReactNativeHost().getReactInstanceManager().createReactContextInBackground();

    RNNotifications.setPushListener(new OnRegisterPushListener() {

      @Override
      public void onRegisterPushRequired() {
        FirebaseInstanceId.getInstance().getInstanceId().addOnSuccessListener(instanceIdResult -> {
          String refreshedToken = instanceIdResult.getToken();
          Log.d(TAG, "Refreshed token: " + refreshedToken);

          RNNotifications.setRegistrationToken(refreshedToken);
        });
      }
    });
  }
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-550-1" data-tab-group="tabgrp-550">

```Kotlin
fun onCreate() {
      super.onCreate()
      SoLoader.init(this, /* native exopackage */ false)
      getReactNativeHost().getReactInstanceManager().createReactContextInBackground()
      RNNotifications.setPushListener(object:OnRegisterPushListener() {
         fun onRegisterPushRequired() {
            FirebaseInstanceId.getInstance().getInstanceId().addOnSuccessListener({ instanceIdResult->
               val refreshedToken = instanceIdResult.getToken()
               Log.d(TAG, "Refreshed token: " + refreshedToken)
               RNNotifications.setRegistrationToken(refreshedToken)
       })
    }
  })
}
```

</div>
</div>



#### Receiving push notifications {id=android-receiving-push-notifications}

In order to handle Synerise push notifications, you must pass the incoming push payload to the Synerise SDK.

1. Create a class extending `FirebaseMessagingService`:
  
   <div class="content-tabs code-tabs" data-tab-group="tabgrp-551">
   <div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-551-0" data-tab-group="tabgrp-551" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-551-1" data-tab-group="tabgrp-551">Kotlin</button></div>

   <div class="tab-panel" data-tab-id="tabgrp-551-0" data-tab-group="tabgrp-551" data-tab-active="true">

   ```Java
   public class MyFirebaseMessagingService extends FirebaseMessagingService {

       private static final String TAG = MyFirebaseMessagingService.class.getSimpleName();

       @Override
       public void onMessageReceived(@NonNull RemoteMessage remoteMessage) {
           super.onMessageReceived(remoteMessage);
           Map<String, String> data = remoteMessage.getData();
           RNNotifications.onNotificationReceive(data);
       }

       @Override
       public void onNewToken(String refreshedToken) {
           super.onNewToken(refreshedToken);

           Log.d(TAG, "Refreshed token: " + refreshedToken);

           if (refreshedToken != null) {
               RNNotifications.setRegistrationToken(refreshedToken);
           }
       }
   }
   ```

   </div>

   <div class="tab-panel" data-tab-id="tabgrp-551-1" data-tab-group="tabgrp-551">

   ```Kotlin
   class MyFirebaseMessagingService:FirebaseMessagingService() {

     fun onMessageReceived(@NonNull remoteMessage:RemoteMessage) {
       super.onMessageReceived(remoteMessage)
       val data = remoteMessage.getData()
       RNNotifications.onNotificationReceive(data)
     }

     fun onNewToken(refreshedToken:String) {
       super.onNewToken(refreshedToken)
       Log.d(TAG, "Refreshed token: " + refreshedToken)
       if (refreshedToken != null)
       {
         RNNotifications.setRegistrationToken(refreshedToken)
       }
     }
   }
   ```

   </div>
   </div>

1. To enable banners, handle the intent when the app starts. You can do it in your `MainActivity` by calling `RNNotifications.onNotificationReceive` in your `onCreate` and `onNewIntent`.
  
   <div class="content-tabs code-tabs" data-tab-group="tabgrp-552">
   <div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-552-0" data-tab-group="tabgrp-552" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-552-1" data-tab-group="tabgrp-552">Kotlin</button></div>

   <div class="tab-panel" data-tab-id="tabgrp-552-0" data-tab-group="tabgrp-552" data-tab-active="true">

   ```Java
   @Override
       protected void onCreate(Bundle savedInstanceState) {
           super.onCreate(savedInstanceState);
           RNNotifications.onNotificationReceive(getIntent().getExtras());
       }

       @Override
       public void onNewIntent(Intent intent) {
           super.onNewIntent(intent);
           RNNotifications.onNotificationReceive(intent.getExtras());
       }
   ```

   </div>

   <div class="tab-panel" data-tab-id="tabgrp-552-1" data-tab-group="tabgrp-552">

   ```Kotlin
   protected fun onCreate(savedInstanceState:Bundle) {
     super.onCreate(savedInstanceState)
     RNNotifications.onNotificationReceive(getIntent().getExtras())
   }
   fun onNewIntent(intent:Intent) {
     super.onNewIntent(intent)
     RNNotifications.onNotificationReceive(intent.getExtras())
   }
   ```

   </div>
   </div>


### Setting up - iOS {id=setting-up-ios}
---

#### Requirements {id=ios-requirements}

Configure handling Push Notifications in your application. See [Apple Notifications](https://developer.apple.com/notifications/).

#### Firebase Cloud Messaging integration {id=ios-firebase-cloud-messaging-integration}

1. Import `RNNotifications.h`
   
   <div class="content-tabs code-tabs" data-tab-group="tabgrp-553">
   <div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-553-0" data-tab-group="tabgrp-553" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-553-1" data-tab-group="tabgrp-553">Objective-C</button></div>

   <div class="tab-panel" data-tab-id="tabgrp-553-0" data-tab-group="tabgrp-553" data-tab-active="true">

   ```Swift
   import react-native-synerise-sdk
   ```

   </div>

   <div class="tab-panel" data-tab-id="tabgrp-553-1" data-tab-group="tabgrp-553">

   ```Objective-C
   #import <react-native-synerise-sdk/RNNotifications.h>
   ```

   </div>
   </div>

2. Extend the Firebase Messaging Delegate so our SDK can receive the Firebase token that is required to deliver push notifications from Synerise.
   
   <div class="content-tabs code-tabs" data-tab-group="tabgrp-554">
   <div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-554-0" data-tab-group="tabgrp-554" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-554-1" data-tab-group="tabgrp-554">Objective-C</button></div>

   <div class="tab-panel" data-tab-id="tabgrp-554-0" data-tab-group="tabgrp-554" data-tab-active="true">

   ```Swift
   func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
       FirebaseApp.configure()
       Messaging.messaging().delegate = self

       if #available(iOS 10, *) {
         UNUserNotificationCenter.current().requestAuthorization(options: [.alert, .badge, .sound]) { (granted, error) in

         }
       } else {
         let settings = UIUserNotificationSettings(types: [.alert, .badge, .sound], categories: nil)
         application.registerUserNotificationSettings(settings)
       }

       application.registerForRemoteNotifications()
      }

      // MARK: - MessagingDelegate

      func messaging(_ messaging: Messaging, didReceiveRegistrationToken fcmToken: String) {
       RNNotifications.didChangeRegistrationToken(fcmToken)
      }
   ```

   </div>

   <div class="tab-panel" data-tab-id="tabgrp-554-1" data-tab-group="tabgrp-554">

   ```Objective-C
   - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
       [FIRApp configure];
       [FIRMessaging messaging].delegate = self;

       if (@available(iOS 10, *)) {
         [UNUserNotificationCenter currentNotificationCenter].delegate = self;
         UNAuthorizationOptions authOptions = (UNAuthorizationOptionAlert | UNAuthorizationOptionSound | UNAuthorizationOptionBadge);
         [[UNUserNotificationCenter currentNotificationCenter] requestAuthorizationWithOptions:authOptions completionHandler:^(BOOL granted, NSError *error) {

         }];
       } else {
         UIUserNotificationType allNotificationTypes = (UIUserNotificationTypeSound | UIUserNotificationTypeAlert | UIUserNotificationTypeBadge);
         UIUserNotificationSettings *settings = [UIUserNotificationSettings settingsForTypes:allNotificationTypes categories:nil];

         [[UIApplication sharedApplication] registerUserNotificationSettings:settings];
       }

       [[UIApplication sharedApplication] registerForRemoteNotifications];
      }

      #pragma mark - FIRMessagingDelegate

      - (void)messaging:(FIRMessaging *)messaging didReceiveRegistrationToken:(NSString *)fcmToken {
         [RNNotifications didChangeRegistrationToken:fcmToken];
      }
   ```

   </div>
   </div>


   
     <div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

     Make sure that the Firebase token is always up-to-date. When it changes, use `RNNotifications.didChangeRegistrationToken(registrationToken:)` again.

     </div></div></div>


#### Receiving push notifications {id=ios-receiving-push-notifications}

The following code shows how to receive push notifications in the `AppDelegate.h` and pass these to the React Native part of the application:


<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

To properly receive notifications, all of these methods must be implemented.

</div></div></div>



<div class="content-tabs code-tabs" data-tab-group="tabgrp-555">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-555-0" data-tab-group="tabgrp-555" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-555-1" data-tab-group="tabgrp-555">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-555-0" data-tab-group="tabgrp-555" data-tab-active="true">

```Swift
// iOS 9
// Push Notifications
// Silent Push Notifications

func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable : Any], fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) {
  RNNotifications.didReceiveNotification(userInfo)
  completionHandler(.noData)
}

func application(_ application: UIApplication, handleActionWithIdentifier identifier: String?, forRemoteNotification userInfo: [AnyHashable : Any], completionHandler: @escaping () -> Void) {
  RNNotifications.didReceiveNotification(userInfo, actionIdentifier:identifier)
  completionHandler()
}

// iOS 10 and above
// Push Notifications

// MARK: - UNUserNotificationCenterDelegate

@available(iOS 10.0, *)
func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void) {
  RNNotifications.didReceiveNotification(response.notification.request.content.userInfo, actionIdentifier:response.actionIdentifier)
  completionHandler()
}

@available(iOS 10.0, *)
func userNotificationCenter(_ center: UNUserNotificationCenter, willPresent notification: UNNotification, withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void) {
  RNNotifications.didReceiveNotification(notification.request.content.userInfo)
  completionHandler(UNNotificationPresentationOptions.init(rawValue: 0))
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-555-1" data-tab-group="tabgrp-555">

```Objective-C
// iOS 9
// Push Notifications
// Silent Push Notifications

- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler {
  [RNNotifications didReceiveNotification:userInfo];
  completionHandler(UIBackgroundFetchResultNoData);
}

- (void)application:(UIApplication *)application handleActionWithIdentifier:(nullable NSString *)identifier forRemoteNotification:(NSDictionary *)userInfo completionHandler:(void(^)())completionHandler {
  [RNNotifications didReceiveNotification:userInfo actionIdentifier:identifier];
  completionHandler();
}

// iOS 10 and above
// Push Notifications

#pragma mark - UNUserNotificationCenterDelegate

- (void)userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void (^)(void))completionHandler NS_AVAILABLE_IOS(10) {
  [RNotifications didReceiveNotification:response.notification.request.content.userInfo actionIdentifier:response.actionIdentifier];
  completionHandler();
}

- (void)userNotificationCenter:(UNUserNotificationCenter *)center willPresentNotification:(UNNotification *)notification withCompletionHandler:(void (^)(UNNotificationPresentationOptions))completionHandler NS_AVAILABLE_IOS(10) {
  [RNNotifications didReceiveNotification:notification.request.content.userInfo];
  completionHandler(UNNotificationPresentationOptionAlert | UNNotificationPresentationOptionBadge | UNNotificationPresentationOptionSound);
}
```

</div>
</div>


#### Extensions for push notifications {id=ios-extensions-for-push-notifications}

##### Notification Service Extension {id=synerise-notification-service-extension-for-ios}

**Synerise Notification Service Extension** is an object that adds the notification functionality to the SDK.
  
It implements the following operations:
- Decrypting **Simple Push** communication data (if encryption is enabled).
- Tracking events from **Simple Push** communication.
- Adding action buttons to **Simple Push** communication (if the communication contains any).
- Improving the appearance of **Simple Push** communication (Rich Media - Single Image) with an image thumbnail.
  
**Notification Service Extension** should be implemented in the native part of the application. Follow the instructions in [this article](/developers/mobile-sdk/configuring-push-notifications/ios#synerise-notification-service-extension-configuration).

##### Rich Media Notification Content Extensions {id=synerise-notification-content-extension-for-ios}

**Synerise Rich Media Notification Content Extension** is an object that allows rendering your own appearance of a push notification when the notification is expanded (by tapping the notification).
  
**Synerise Rich Media Notification Content Extensions** should be implemented in the native part of the application. Follow the instructions in [this article](/developers/mobile-sdk/configuring-push-notifications/ios#rich-media-in-push-notifications).

### Set up Firebase FCM token registration for Synerise SDK
---
Get Firebase FCM token from the native part of the application so our SDK can receive the Firebase token that is required to deliver push notifications from Synerise. Make sure that the Firebase FCM token is always up-to-date by implementing the [onRegistrationRequired()](/developers/mobile-sdk/listeners-and-delegates/react-native-listeners#notifications-listener) method.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-556">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-556-0" data-tab-group="tabgrp-556" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-556-0" data-tab-group="tabgrp-556" data-tab-active="true">

```JavaScript
Synerise.Notifications.setListener({
  onRegistrationToken: function(token) {
    Synerise.Notifications.registerForNotifications(token, true, function() {
      // success
    }, function(error) {
      // failure
    });
  },
  onRegistrationRequired: function() {
    let registrationToken = getLastPushRegistrationToken();
    let mobilePushAgreement = true; // true or false, should depend on device permissions and customer's agreement in the application

    Synerise.Notifications.registerForNotifications(registrationToken, mobilePushAgreement, function() {
      // success
    }, function(error) {
      // failure
    });
  }
  //...
});
```

</div>
</div>



<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The second parameter of the registration method is the agreement for mobile push campaigns. In the Profile's card in Synerise, you can find it in the **Subscriptions** section (if you have the required access permission). Learn more about the [Synerise.Notifications.registerForNotifications(registrationToken:mobilePushAgreement:onSuccess:onError:) method in the method reference](/developers/mobile-sdk/method-reference/react-native/campaigns#register-for-push-notifications).

</div></div></div>



<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

You must always keep the Firebase token updated. In many cases in the application lifecycle, such as authorization, destroy session, user context change, and so on, the registration needs to be updated. In these situations, the SDK invokes the [onRegistrationRequired()](/developers/mobile-sdk/listeners-and-delegates/react-native-listeners#notifications-listener) method (see code snippet above).

</div></div></div>


### Configure Notification Encryption
---
#### Android {id=android-notification-encryption-configuration}
See [Configure Notification Encryption](/developers/mobile-sdk/configuring-push-notifications/android#configure-notification-encryption).

#### iOS {id=ios-notification-encryption-configuration}
See [Synerise Notification Service Extension](#synerise-notification-service-extension-for-ios) and [Configure Notification Encryption](/developers/mobile-sdk/configuring-push-notifications/ios#configure-notification-encryption).

#### Application implementation {id=application-notification-encryption-configuration}

In the application, you must set `encryption` to `true` in the SDK initializer or in the SDK settings. 


<div class="content-tabs code-tabs" data-tab-group="tabgrp-557">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-557-0" data-tab-group="tabgrp-557" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-557-0" data-tab-group="tabgrp-557" data-tab-active="true">

```JavaScript
// The first way
// WARNING: This option must be configured before Synerise SDK is initialized!
Synerise.Settings.notifications.encryption = true;

// The second way
Synerise.Initializer()
  .withApiKey('XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX')
  .withBaseUrl(null)
  .withDebugModeEnabled(true)
  .withCrashHandlingEnabled(true)
  .withSettings({
    notifications: {
      enabled: true,
      encryption: true
    }
    //...
  })
  .init()
```

</div>
</div>


### Handling incoming push notifications
---


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

You may disable handling push notifications in the SDK at any time. See [Enable/disable notifications](/developers/mobile-sdk/settings#enabledisable-notifications).

</div></div></div>


#### Synerise payload

The following code shows how to handle push notifications:


<div class="content-tabs code-tabs" data-tab-group="tabgrp-558">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-558-0" data-tab-group="tabgrp-558" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-558-0" data-tab-group="tabgrp-558" data-tab-active="true">

```JavaScript
Synerise.Notifications.setListener({
  //...
  onNotification: function(payload, actionIdentifier) {
    if (Synerise.Notifications.isSyneriseNotification(payload)) {
      Synerise.Notifications.handleNotification(payload, actionIdentifier);
    }
  }
  //...
});
```

</div>
</div>


#### Custom payload

You may send both custom push notifications and custom campaigns in [Synerise](https://app.synerise.com). The code below of one sample delegate method checks the notification origin and then handles it.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-559">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-559-0" data-tab-group="tabgrp-559" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-559-0" data-tab-group="tabgrp-559" data-tab-active="true">

```JavaScript
Synerise.Notifications.setListener({
  //...
  onNotification: function(payload, actionIdentifier) {
    if (Synerise.Notifications.isSyneriseNotification(payload)) {
      Synerise.Notifications.handleNotification(payload, actionIdentifier);
    } else {
      // Handle other notification in your own way
    }
  }
  //...
});
```

</div>
</div>


#### Encrypted payloads

If you handle the Synerise notification, you do not have to do anything. The SDK decrypts Synerise notification's payload:
- In [Notification Service Extension](#synerise-notification-service-extension-for-ios) for push notifications
- In the SDK, after invoking [`Synerise.Notifications.handleNotification(payload, actionIdentifier)`](/developers/mobile-sdk/method-reference/react-native/campaigns#handle-synerise-push-notification) for silent push notifications 
  
Otherwise, if it is a custom encrypted push notification sent by Synerise, or you need decrypt data from the push notification, there are two methods for dealing with it:
- [`Synerise.Notifications.isNotificationEncrypted(payload)`](/developers/mobile-sdk/method-reference/react-native/campaigns#check-if-push-notification-is-encrypted) - checks if the notification payload is encrypted by Synerise.
- [`Synerise.Notifications.decryptNotification(payload)`](/developers/mobile-sdk/method-reference/react-native/campaigns#decrypt-push-notification) - decrypts a notification payload.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-560">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-560-0" data-tab-group="tabgrp-560" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-560-0" data-tab-group="tabgrp-560" data-tab-active="true">

```JavaScript
Synerise.onReady(function() {
    //...
    onNotification: function(payload, actionIdentifier) {
      if (Synerise.Notifications.isSyneriseNotification(payload)) {
        let isNotificationEncrypted = Synerise.Notifications.isNotificationEncrypted(payload)
        var decryptedPayload
        if (isNotificationEncrypted) {
          decryptedPayload = Synerise.Notifications.decryptNotification(payload)
        } else {
          decryptedPayload = payload
        }
        Synerise.Notifications.handleNotification(decryptedPayload, actionIdentifier)
      }
    }
    //...
  })
})
```

</div>
</div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The `Synerise.Notifications.decryptNotification(payload)` method returns raw data when the payload is not encrypted. If the operation fails, the method returns null.

</div></div></div>


### Handling actions from push notifications
---
- [Read more about types of actions in campaigns](/developers/mobile-sdk/campaigns/action-handling#types-of-actions-in-campaigns)  
- [Read more about handling actions from push notifications](/developers/mobile-sdk/campaigns/action-handling#handling-actions-from-campaigns-in-react-native)  

### Additional in-app alert from push notifications
---
The React Native SDK on iOS devices can display an additional alert in the application after a push notification is received. See [this article](/developers/mobile-sdk/campaigns/simple-push#additional-in-app-alert-when-simple-push-is-received) to read more about this feature.

<figure><img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/developers/mobile-sdk/_gfx/ios-simple-push-in-app-alert.png" alt="Simple Push campaign with in-app alert" class="small"><figcaption>Simple Push campaign with in-app alert</figcaption></figure>

### Limitations compared to native platforms
---

Due to platform limitations, not all notification functionalities may work as in native SDKs.




# External providers


This article contains instruction to implement third parties approaches to authenticating a customer in a mobile application.

## Facebook Login
---
For those Applications that rely on Facebook Login as authentication, Synerise has a separate method that provides you with a Synerise JWT token based on Facebook login. Currently, there are no dedicated settings related to Facebook authentication on the user interface in the Synerise platform. You just have to implement RESTful API or SDK methods to authenticate through Facebook.



To authenticate a customer using Facebook, implement the following methods:

| OS           | Method                                                                                                                                                                                                                                                                                                                                                                                                                             |
|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Android      | - [Client.authenticate()](/developers/mobile-sdk/method-reference/android/client-authentication#authenticate-customer-by-identityprovider) |
| iOS          | - [Client.authenticate(token:clientIdentityProvider:authID:context:success:failure:)](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-by-identityprovider) <br> - [Client.authenticateConditionally(token:clientIdentityProvider:authID:context:success:failure:)](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-conditionally-by-identityprovider) |
| React Native | - [Synerise.Client.authenticate(token, clientIdentityProvider, authID, context, onSuccess, onError)](/developers/mobile-sdk/method-reference/react-native/client-authentication#authenticate-customer-by-identityprovider) <br> - [Synerise.Client.authenticateConditionally(token, clientIdentityProvider, authID context, onSuccess, onError)](/developers/mobile-sdk/method-reference/react-native/client-authentication#authenticate-customer-conditionally-by-identityprovider) |
| Flutter      | - [Synerise.client.authenticate(clientAuthContext, clientIdentityProvider, token)](/developers/mobile-sdk/method-reference/flutter/client-authentication#authenticate-customer-by-identityprovider)) |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**authId/authID** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>


Additionally, in the Synerise platform (`app.synerise.com`) you can define the following settings:
- [Assignment of loyalty card](/docs/settings/tool/iam-for-apps/general#loyalty-card-assignment)
- [JWT longevity](/docs/settings/tool/iam-for-apps/general#jwt-lifetime)
- [Custom ID overwriting](/docs/settings/tool/iam-for-apps/general#custom-id-overwriting)
- [External ID overwriting](/docs/settings/tool/iam-for-apps/general#external-id-overwriting)


## Sign in with Apple
---

For integrating with the Apple platform, Synerise has a separate method that returns a Synerise JWT token based on Sign in with Apple credentials. You can read more about the configuration of the Sign in with Apple option in the Synerise platform [here](/docs/settings/tool/iam-for-apps/third-party#apple).

In this case, the authentication process works in the following way:

1. A customer authenticates by Sign in with Apple.
2. Apple provides authentication credentials.
3. Your app uses these credentials and creates `ClientAppleSignInAuthenticationContext`.
4. The context is passed to Synerise by using:

    | OS           | Method                                                                                                                                                                                                                                                                                                                                                                                                                              |
    |--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
    | iOS          | - [Client.authenticate(token:clientIdentityProvider:authID:context:success:failure:)](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-conditionally-by-identityprovider) <br> - [Client.authenticateConditionally(token:clientIdentityProvider:authID:context:success:failure:)](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-conditionally-by-identityprovider) |
    | React Native | - [Synerise.Client.authenticate(token, clientIdentityProvider, authID, context, onSuccess, onError)](/developers/mobile-sdk/method-reference/react-native/client-authentication#authenticate-customer-by-identityprovider) <br> - [Synerise.Client.authenticateConditionally(token, clientIdentityProvider, authID context, onSuccess, onError)](/developers/mobile-sdk/method-reference/react-native/client-authentication#authenticate-customer-conditionally-by-identityprovider) |
    | Flutter      | - [Synerise.client.authenticate(clientAuthContext, clientIdentityProvider, token)](/developers/mobile-sdk/method-reference/flutter/client-authentication#authenticate-customer-by-identityprovider)) |


   <div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

   **authId/authID** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

   </div></div></div>


5. If the authentication was successful, Synerise provides your application with our JWT access token for the customer.

Additionally, in the Synerise platform (`app.synerise.com`) you can define the following settings:
- [Assignment of loyalty card](/docs/settings/tool/iam-for-apps/general#loyalty-card-assignment)
- [JWT longevity](/docs/settings/tool/iam-for-apps/general#jwt-lifetime)
- [Custom ID overwriting](/docs/settings/tool/iam-for-apps/general#custom-id-overwriting)
- [External ID overwriting](/docs/settings/tool/iam-for-apps/general#external-id-overwriting)

## The list of methods
---

### Check if a customer is signed in

This method checks if a customer is signed in through oAuth, Facebook, Sign in with Apple, or RaaS.


<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This method returns `false` if a customer is authenticated through [Simple Profile Authentication](/developers/mobile-sdk/user-identification-and-authorization/simple-authentication).

</div></div></div>


| OS           | Method                                                                                                                                    |
|--------------|-------------------------------------------------------------------------------------------------------------------------------------------|
| Android      | [Client.isSignedIn()](/developers/mobile-sdk/method-reference/android/client-authentication#check-if-a-customer-is-signed-in-via-raas-oauth-facebook-apple)                |
| iOS          | [Client.isSignedIn()](/developers/mobile-sdk/method-reference/ios/client-authentication#check-if-a-customer-is-signed-in-via-raas-oauth-facebook-apple) |
| React Native | [Synerise.Client.isSignedIn()](/developers/mobile-sdk/method-reference/react-native/client-authentication#check-if-a-customer-is-signed-in-via-raas-oauth-facebook-apple)       |
| Flutter | [Synerise.client.isSignedIn()](/developers/mobile-sdk/method-reference/flutter/client-authentication#check-if-a-customer-is-signed-in-via-raas-oauth-facebook-apple)      |

### Customer sign out
This method signs out the customer. The method terminates the JWT token and ends the customer session.

| OS           | Method                                                                                                                |
|--------------|-----------------------------------------------------------------------------------------------------------------------|
| Android      | - [Client.signOut()](/developers/mobile-sdk/method-reference/android/client-authentication#sign-out-customer) <br/> -  [Client.signOut(mode, signOutFromAllDevices)](/developers/mobile-sdk/method-reference/android/client-authentication#sign-out-customer-with-mode-or-from-all-devices) |
| iOS          | - [Client.signOut()](/developers/mobile-sdk/method-reference/ios/client-authentication#sign-out-customer) <br/> - [Client.signOut(mode:fromAllDevices:success:failure:)](/developers/mobile-sdk/method-reference/ios/client-authentication#sign-out-customer-with-mode-or-from-all-devices) |
| React Native | - [Synerise.Client.signOut()](/developers/mobile-sdk/method-reference/react-native/client-authentication#sign-out-a-customer) <br/> - [Synerise.Client.signOutWithMode(mode, fromAllDevices, onSuccess, onError)](/developers/mobile-sdk/method-reference/react-native/client-authentication#sign-out-customer-with-mode-or-from-all-devices) |
| Flutter | [Synerise.client.signOut()](/developers/mobile-sdk/method-reference/flutter/client-authentication#sign-out-a-customer) |

## What's next
---
When the customer's is signed in, you can implement [profile management methods](/developers/mobile-sdk/user-identification-and-authorization/identification-and-user-management#profile-management-methods) and [session management methods](/developers/mobile-sdk/user-identification-and-authorization/session-management).




# Campaigns


### SyneriseSource
**Declared In:**  
lib/enums/injector/synerise_source.dart

**Declaration:**

<pre><code class="language-Dart">enum SyneriseSource {
  notSpecified('NOT_SPECIFIED'),
  simplePush('SIMPLE_PUSH'),
  banner('BANNER'),
  walkthrough('WALKTHROUGH'),
  inAppMessage('IN_APP_MESSAGE');</code></pre>


**Functions:**
  
Converts from **String** to **SyneriseSource**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-151">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-151-0" data-tab-group="tabgrp-151" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-151-0" data-tab-group="tabgrp-151" data-tab-active="true">

```Dart
static SyneriseSource getSyneriseSourceFromString(String string)
```

</div>
</div>


---
---

### InAppMessageData
<!-- reusable-table-boundary -->

Model representing an in-app message data.
  

<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This is a read-only class and it is not meant to be instantiated directly.

</div></div></div>

  
**Declared In:**  
lib/model/in_app/in_app_message_data.dart  
  
**Declaration:**

<pre><code class="language-Dart">class InAppMessageData</code></pre>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **campaignHash** | String | no | Identifier of the in-app message campaign. |
| **variantIdentifier** | String | no | Identifier of the in-app message campaign variant. |
| **additionalParameters** | Map<String, String> | yes | Parameters additionally provided by the campaign. |
| **isTest** | bool | no | Specifies if the object is from a test campaign. |

<!-- reusable-table-boundary -->





# Campaigns


## SyneriseSource
<!-- reusable-table-boundary -->

| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 5.0.0 | 6.0.0 | 0.18.0 | 0.8.0 |

<!-- reusable-table-boundary -->
**Declared In:**  
Headers/SNRSyneriseSource.h  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-172">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-172-0" data-tab-group="tabgrp-172" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-172-1" data-tab-group="tabgrp-172">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-172-0" data-tab-group="tabgrp-172" data-tab-active="true">

```Swift
enum SyneriseSource: Int {
    simplePush,
    inAppMessage
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-172-1" data-tab-group="tabgrp-172">

```Objective-C
typedef NS_ENUM(NSInteger, SNRSyneriseSource) {
    SNRSyneriseActivitySimplePush,
    SNRSyneriseActivityInAppMessage
}
```

</div>
</div>


---
---

## NotificationInfo
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRNotificationInfo.h
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-173">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-173-0" data-tab-group="tabgrp-173" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-173-1" data-tab-group="tabgrp-173">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-173-0" data-tab-group="tabgrp-173" data-tab-active="true">

```Swift
class NotificationInfo: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-173-1" data-tab-group="tabgrp-173">

```Objective-C
@interface SNRNotificationInfo : SNRBaseModel
```

</div>
</div>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **campaignHashId** | String | no | Identifier of the notification campaign. |
| **campaignTitle** | String | no | Identifier of the notification title. |
| **payload** | [AnyHashable: Any] | yes | Payload of the notification. |
  

<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties are read-only.

</div></div></div>


<!-- reusable-table-boundary -->

---
---

## PushNotificationsRegistrationOrigin
**Declared In:**  
Headers/SNRSynerise.h  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-174">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-174-0" data-tab-group="tabgrp-174" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-174-1" data-tab-group="tabgrp-174">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-174-0" data-tab-group="tabgrp-174" data-tab-active="true">

```Swift
enum PushNotificationsRegistrationOrigin: Int {
    .appStarted,
    .clientContextChange,
    .securityReason,
    .periodicJob
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-174-1" data-tab-group="tabgrp-174">

```Objective-C
typedef NS_ENUM(NSUInteger, SNRPushNotificationsRegistrationOrigin) {
    SNRPushNotificationsRegistrationOriginAppStarted,
    SNRPushNotificationsRegistrationOriginClientContextChange,
    SNRPushNotificationsRegistrationOriginSecurityReason,
    SNRPushNotificationsRegistrationOriginPeriodicJob
}
```

</div>
</div>


---
---

## InAppMessageData
<!-- reusable-table-boundary -->

Model representing an in-app message data.
  

<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This is a read-only class and it is not meant to be instantiated directly.

</div></div></div>

  
**Declared In:**  
Headers/SNRInAppMessageData.h
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-175">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-175-0" data-tab-group="tabgrp-175" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-175-1" data-tab-group="tabgrp-175">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-175-0" data-tab-group="tabgrp-175" data-tab-active="true">

```Swift
class InAppMessageData: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-175-1" data-tab-group="tabgrp-175">

```Objective-C
@interface SNRInAppMessageData : SNRBaseModel
```

</div>
</div>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **campaignHash** | String | no | Identifier of the in-app message campaign. |
| **variantIdentifier** | String | no | Identifier of the in-app message campaign variant. |
| **additionalParameters** | [AnyHashable: Any] | yes | Parameters additionally provided by the campaign. |
| **isTest** | Bool | no | Specifies if the object is from a test campaign. |
  

<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties are read-only.

</div></div></div>


<!-- reusable-table-boundary -->

---
---

### SyneriseMethod

Enum with a list of SDK methods that can be called from JavaScript in an in-app.

See [Using in-app template builder](/docs/campaign/in-app-messages/creating-inapp-templates/creating-inapp-template#use-a-mobile-sdk-method)

## Deprecated symbols

### *SyneriseActivity*
<!-- reusable-table-boundary -->

| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:orange">Deprecated in:</span> | 5.0.0 | n/a | n/a | n/a |

<!-- reusable-table-boundary -->
**Declared In:**  
Headers/SNRSyneriseActivity.h  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-176">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-176-0" data-tab-group="tabgrp-176" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-176-1" data-tab-group="tabgrp-176">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-176-0" data-tab-group="tabgrp-176" data-tab-active="true">

```Swift
enum SyneriseActivity: Int {
    simplePush,
    banner,
    walkthrough,
    inAppMessage
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-176-1" data-tab-group="tabgrp-176">

```Objective-C
typedef NS_ENUM(NSInteger, SNRSyneriseActivity) {
    SNRSyneriseActivitySimplePush,
    SNRSyneriseActivityBanner,
    SNRSyneriseActivityWalkthrough,
    SNRSyneriseActivityInAppMessage
}
```

</div>
</div>


---
---

### *SyneriseActivityAction*
<!-- reusable-table-boundary -->

| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:orange">Deprecated in:</span> | 5.0.0 | n/a | n/a | n/a |

<!-- reusable-table-boundary -->
**Declared In:**  
Headers/SNRSynerise.h  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-177">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-177-0" data-tab-group="tabgrp-177" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-177-1" data-tab-group="tabgrp-177">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-177-0" data-tab-group="tabgrp-177" data-tab-active="true">

```Swift
enum SyneriseActivityAction: Int {
    none,
    hide
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-177-1" data-tab-group="tabgrp-177">

```Objective-C
typedef NS_ENUM(NSInteger, SNRSyneriseActivityAction) {
    SNRSyneriseActivityActionNone,
    SNRSyneriseActivityActionHide
}
```

</div>
</div>



# Customer session


---
## Refresh customer token
---
This method refreshes the customer’s current token.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns an error if the token has expired and cannot be refreshed.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public refreshToken(onSuccess: () =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

  
**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.
  
**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1227">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1227-0" data-tab-group="tabgrp-1227" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1227-0" data-tab-group="tabgrp-1227" data-tab-active="true">

```JavaScript
Synerise.Client.refreshToken(function(token) {
  // success
}, function(error) {
  // failure
});
```

</div>
</div>


<!-- reusable-table-boundary -->

## Retrieve customer token
---
This method retrieves the customer’s current, active token.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns an error if the token has expired and cannot be retrieved.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Related To:**  
[Token](/developers/mobile-sdk/class-reference/react-native/client#token)
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public retrieveToken(onSuccess: (token: Token) =&gt; void, onError: (error: Error) =&gt; void)</code></pre>

  
**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.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1228">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1228-0" data-tab-group="tabgrp-1228" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1228-0" data-tab-group="tabgrp-1228" data-tab-active="true">

```JavaScript
Synerise.Client.retrieveToken(function(token) {
  // success
}, function(error) {
  // failure
});
```

</div>
</div>


<!-- reusable-table-boundary -->

## Get current customer UUID
---
This method retrieves the customer’s current UUID.
**Declared In:**  
lib/main/modules/ClientModule.js
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public getUUID(): string</code></pre>

  
**Return Value:**  
The method returns the customer's UUID as string.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1229">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1229-0" data-tab-group="tabgrp-1229" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1229-0" data-tab-group="tabgrp-1229" data-tab-active="true">

```JavaScript
let uuid = Synerise.Client.getUUID();
```

</div>
</div>


## Regenerate customer
---
<!-- reusable-table-boundary -->

This method regenerates the UUID and clears the authentication token, login session, custom email, and custom identifier.
  
This operation works only if the customer is anonymous.

This operation clears the authentication token, login (if applicable), custom email, and custom identifier.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.3.10 | 3.3.5 | 0.9.0 | 0.7.0 |

<!-- reusable-table-boundary -->
**Declared In:**  
lib/main/modules/ClientModule.js
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public regenerateUUID()</code></pre>


**Return Value:**  
No value is returned.
  
**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1230">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1230-0" data-tab-group="tabgrp-1230" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1230-0" data-tab-group="tabgrp-1230" data-tab-active="true">

```JavaScript
Synerise.Client.regenerateUUID();
```

</div>
</div>


## Regenerate customer with identifier
---
<!-- reusable-table-boundary -->

This method regenerates the UUID and clears the authentication token, login session, custom email, and custom identifier.
  
This operation works only if the customer is anonymous.
  
This operation clears the authentication token, login (if applicable), custom email, and custom identifier
  
The optional `clientIdentifier` parameter is a seed for UUID generation.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.6.5 | 3.6.4 | 0.9.10 | 0.7.2 |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/ClientModule.js
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public regenerateUUIDWithClientIdentifier(clientIdentifier: string)</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **clientIdentifier** | string | no | - | Seed for UUID generation |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The **clientIdentifier** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>


**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->

## Destroy current session
---
This method destroys the session completely.

This method clears all session data (both client and anonymous) and removes cached data. Then, it regenerates the UUID and creates the new anonymous session.
**Declared In:**  
lib/main/modules/ClientModule.js
  
**Class:**  
[ClientModule](/developers/mobile-sdk/class-reference/react-native/modules#client)
  
**Declaration:**  

<pre><code class="language-TypeScript">public destroySession()</code></pre>

  
**Return Value:**  
No value is returned.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1231">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1231-0" data-tab-group="tabgrp-1231" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1231-0" data-tab-group="tabgrp-1231" data-tab-active="true">

```JavaScript
Synerise.Client.destroySession();
```

</div>
</div>



# Campaigns


### SyneriseSource
**Declared In:**  
lib/classes/models/Misc/SyneriseSource.js  
  
**Declaration:**  

<pre><code class="language-TypeScript">enum SyneriseSource {
  NotSpecified = 'NOT_SPECIFIED',
  SimplePush = 'SIMPLE_PUSH',
  Banner = 'BANNER',
  Walkthrough = 'WALKTHROUGH',
  InAppMessage = 'IN_APP_MESSAGE'
}</code></pre>

  
**Functions:**

Converts from **SyneriseSource** to **string**.

<pre><code class="language-TypeScript">function SyneriseSourceToString(source: SyneriseSourceToString): string</code></pre>


---

Converts from **string** to **SyneriseSource**.

<pre><code class="language-TypeScript">function SyneriseSourceFromString(string: string): SyneriseSource</code></pre>


---
---

### InAppMessageData
<!-- reusable-table-boundary -->

Model representing an in-app message data.
  

<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This is a read-only class and it is not meant to be instantiated directly.

</div></div></div>

  
**Declared In:**  
lib/classes/models/Misc/InAppMessageData.js  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel)  

**Declaration:**

<pre><code class="language-TypeScript">class InAppMessageData extends BaseModel</code></pre>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **campaignHash** | string | no | Identifier of the in-app message campaign. |
| **variantIdentifier** | string | no | Identifier of the in-app message campaign variant. |
| **additionalParameters** | Object | yes | Parameters additionally provided by the campaign. |
| **isTest** | boolean | no | Specifies if the object is from a test campaign. |

<!-- reusable-table-boundary -->





# Campaigns


### SyneriseSource
<!-- reusable-table-boundary -->

This enum contains values which describe the source of campaign.

**Declared In:**  
`com.synerise.sdk.injector.callback.SyneriseSource`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-39">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-39-0" data-tab-group="tabgrp-39" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-39-1" data-tab-group="tabgrp-39">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-39-0" data-tab-group="tabgrp-39" data-tab-active="true">

```Java
public enum SyneriseSource
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-39-1" data-tab-group="tabgrp-39">

```Kotlin
public enum SyneriseSource
```

</div>
</div>


**Values:**

| Property | Description |
| --- | --- |
| **SIMPLE_PUSH** | Simple push campaign |
| **IN_APP_MESSAGE** | In-app message campaign |

<!-- reusable-table-boundary -->

---
---

### Campaign
<!-- reusable-table-boundary -->

Class model for campaigns.

**Declared In:**  
`com.synerise.sdk.injector.net.model.Campaign`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-40">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-40-0" data-tab-group="tabgrp-40" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-40-1" data-tab-group="tabgrp-40">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-40-0" data-tab-group="tabgrp-40" data-tab-active="true">

```Java
public class Campaign implements Serializable
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-40-1" data-tab-group="tabgrp-40">

```Kotlin
class Campaign : Serializable
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **hashId** | String | no | - | Campaign hash ID |
| **variantId** | int | no | - | Campaign variant's ID |
| **title** | String | no | - | Campaign title |
| **type** | String | no | - | Campaign type |



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All the properties above are accessible by using getters.

</div></div></div>


**Initializers:**  

There are no initializers.

**Methods:**  

This method retrieves a value for the `hashId` parameter.


<pre><code class="language-java">public String getHashId()</code></pre>


---

This method retrieves a value for the `variantId` parameter.


<pre><code class="language-java">public int getVariantId()</code></pre>


---

This method retrieves a value for the `title` parameter.


<pre><code class="language-java">public String getTitle()</code></pre>


---

This method retrieves a value for the `type` parameter.


<pre><code class="language-java">public String getType()</code></pre>


---

<!-- reusable-table-boundary -->

---
---

### SynerisePushResponse
<!-- reusable-table-boundary -->

Class model for SynerisePushResponse.

**Declared In:**  
`com.synerise.sdk.injector.net.model.push.notification.SynerisePushResponse`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-41">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-41-0" data-tab-group="tabgrp-41" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-41-1" data-tab-group="tabgrp-41">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-41-0" data-tab-group="tabgrp-41" data-tab-active="true">

```Java
public class SynerisePushResponse
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-41-1" data-tab-group="tabgrp-41">

```Kotlin
class SynerisePushResponse
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **contentAvailable** | Boolean | no | - | Informs if content is available |
| **data** | SynerisePush | no | - | Synerise push data |
| **notification** | [SimpleNotification](/developers/mobile-sdk/class-reference/android/campaigns#simplenotification) | no | - | Synerise simple notification |



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All the properties above are accessible by using getters.

</div></div></div>


**Initializers:**  

There are no initializers.

**Methods:**  

This method checks if content is available.


<pre><code class="language-java">public boolean isContentAvailable()</code></pre>


---

This method retrieves a value for the `data` parameter.


<pre><code class="language-java">public SyneriseData getData()</code></pre>


---

This method retrieves a value for the `notification` parameter.


<pre><code class="language-java">public SimpleNotification getNotification()</code></pre>


---

This method checks if the push is a simple push.


<pre><code class="language-java">public boolean isSimplePush()</code></pre>


---

<!-- reusable-table-boundary -->

---
---

### SimpleNotification
<!-- reusable-table-boundary -->

Class model for simple notification.

**Declared In:**  
`com.synerise.sdk.injector.net.model.push.notification.SimpleNotification`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-42">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-42-0" data-tab-group="tabgrp-42" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-42-1" data-tab-group="tabgrp-42">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-42-0" data-tab-group="tabgrp-42" data-tab-active="true">

```Java
public class SimpleNotification implements Serializable
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-42-1" data-tab-group="tabgrp-42">

```Kotlin
class SimpleNotification : Serializable
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **title** | String | no | - | Notification title |
| **body** | String | no | - | Notification body |




<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All the properties above are accessible by using getters.

</div></div></div>


**Initializers:**  

There are no initializers.

**Methods:**  

This method checks if the notification has a title.


<pre><code class="language-java">public boolean hasTitle()</code></pre>


---

This method retrieves a value for the `title` parameter (notification title).


<pre><code class="language-java">public String getTitle()</code></pre>


---

This method checks if the notification has a body.


<pre><code class="language-java">public boolean hasBody()</code></pre>


---

This method retrieves a value for the `body` parameter (notification body).


<pre><code class="language-java">public String getBody()</code></pre>


---

<!-- reusable-table-boundary -->

---
---

### NotificationInfo
<!-- reusable-table-boundary -->

This enum contains values for a voucher code status.

**Declared In:**  
`com.synerise.sdk.injector.callback.model`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-43">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-43-0" data-tab-group="tabgrp-43" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-43-1" data-tab-group="tabgrp-43">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-43-0" data-tab-group="tabgrp-43" data-tab-active="true">

```Java
public class NotificationInfo
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-43-1" data-tab-group="tabgrp-43">

```Kotlin
public class NotificationInfo
```

</div>
</div>


#### Values

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **campaignHashId** | String | no | - | Identifier of the notification campaign. |
| **campaignTitle** | String | no | - | Identifier of the notification title. |
| **payload** | HashMap<String, String> | no | - | Payload of the notification. |

**Methods:**  

This method retrieves the value of the `campaignHashId` parameter.


<pre><code class="language-java">public String getCampaignHashId()</code></pre>


---

This method defines the value of the `campaignHashId` parameter.


<pre><code class="language-java">public void setCampaignHashId(String campaignHashId)</code></pre>


---

This method retrieves the value of the `CampaignTitle` parameter.


<pre><code class="language-java">public String getCampaignTitle()</code></pre>


---

This method defines the value of the `CampaignTitle` parameter.


<pre><code class="language-java">public void setCampaignTitle(String campaignTitle)</code></pre>


---

This method retrieves the contents of the `payload` parameter.


<pre><code class="language-java">public HashMap&lt;String, String&gt; getPayload()</code></pre>


---

This method defines the contents of the `payload` parameter.


<pre><code class="language-java">public void setPayload(HashMap&lt;String, String&gt; payload)</code></pre>


---

<!-- reusable-table-boundary -->

---
---

### PushRegistrationOrigin
<!-- reusable-table-boundary -->

This enum contains values for the `origin` parameter of push registration listener methods.

**Declared In:**  
`com.synerise.sdk.core.types.enums`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-44">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-44-0" data-tab-group="tabgrp-44" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-44-1" data-tab-group="tabgrp-44">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-44-0" data-tab-group="tabgrp-44" data-tab-active="true">

```Java
public enum PushRegistrationOrigin
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-44-1" data-tab-group="tabgrp-44">

```Kotlin
public enum PushRegistrationOrigin
```

</div>
</div>


**Values:**  

| Property | Value | Description |
| --- | --- | --- |
| **APP_STARTED** | "APP_STARTED" | After a `client.applicationStarted` event is sent. |
| **CLIENT_CONTEXT_CHANGE** | "CLIENT_CONTEXT_CHANGE" | After the client context changes. |
| **PERIODIC_JOB** | "PERIODIC_JOB" | After a periodic job of a background task starts. |
| **SECURITY_REASON** | "SECURITY_REASON" | After a security threat |

**Methods:**  
There are no methods.

---

<!-- reusable-table-boundary -->

---
---

### TemplateBanner
<!-- reusable-table-boundary -->

Class model for banners.

**Declared In:**  
`com.synerise.sdk.injector.net.model.push.banner.TemplateBanner`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-45">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-45-0" data-tab-group="tabgrp-45" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-45-1" data-tab-group="tabgrp-45">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-45-0" data-tab-group="tabgrp-45" data-tab-active="true">

```Java
public class TemplateBanner extends BasePageMapper implements Parcelable, Validable
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-45-1" data-tab-group="tabgrp-45">

```Kotlin
class TemplateBanner : BasePageMapper(), Parcelable, Validable
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **campaign** | [Campaign](/developers/mobile-sdk/class-reference/android/campaigns#campaign) | no | - | Campaign class |
| **trigger** | String | yes | - | Banner trigger |
| **notification** | [SimpleNotification](/developers/mobile-sdk/class-reference/android/campaigns#simplenotification) | no | - | Notification class |
| **autoDisappear** | [AutoDisappear](/developers/mobile-sdk/class-reference/android/campaigns#autodisappear) | no | - | Auto disappear |
| **page** | NetGenericPageData | yes | - | Page data |



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All the properties above are accessible by using getters.

</div></div></div>


**Initializers:**  

There are no initializers.

**Methods:**  

This method retrieves the value of the `campaign` parameter.


<pre><code class="language-java">public Campaign getCampaign()</code></pre>


---

This method retrieves the value of the `value` object.


<pre><code class="language-java">public Object getValue()</code></pre>


---

This method checks if a banner has a trigger.


<pre><code class="language-java">public boolean hasTrigger()</code></pre>


---

This method retrieves the `trigger` parameter from a banner.


<pre><code class="language-java">public String getTrigger()</code></pre>


---

This method retrieves the value of the `notification` parameter.


<pre><code class="language-java">public SimpleNotification getNotification()</code></pre>


---

This method retrieves the value of the `page` parameter.


<pre><code class="language-java">public PageItem getPage()</code></pre>


---

This method retrieves the value of the `autodisappear` parameter.


<pre><code class="language-java">public AutoDisappear getAutoDisappear()</code></pre>


---

<!-- reusable-table-boundary -->

---
---

### SilentCommand
<!-- reusable-table-boundary -->

Class model for silent command.

**Declared In:**  
`com.synerise.sdk.injector.SilentCommand`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-46">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-46-0" data-tab-group="tabgrp-46" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-46-1" data-tab-group="tabgrp-46">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-46-0" data-tab-group="tabgrp-46" data-tab-active="true">

```Java
public class SilentCommand implements Validable
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-46-1" data-tab-group="tabgrp-46">

```Kotlin
class SilentCommand : Validable
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **className** | String | no | - | Class name |
| **methodName** | String | no | - | Method name |
| **methodParameterList** | List<[MethodParameter](/developers/mobile-sdk/class-reference/android/campaigns#methodparameter)> | no | - | Method parameters |



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All the properties above are accessible by using getters.

</div></div></div>


**Initializers:**  

There are no initializers.

**Methods:**  

This method retrieves a value of the `className` parameter.


<pre><code class="language-java">public String getClassName()</code></pre>


---

This method retrieves a value of the `methodName` parameter.


<pre><code class="language-java">public String getMethodName()</code></pre>


---

This method retrieves a list of values of the `methodParameters` parameter.


<pre><code class="language-java">public List&lt;MethodParameter&gt; getMethodParameterList()</code></pre>


---

<!-- reusable-table-boundary -->

---
---

### MethodParameter
<!-- reusable-table-boundary -->

Class model for method parameter.

**Declared In:**  
`com.synerise.sdk.injector.MethodParameter`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-47">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-47-0" data-tab-group="tabgrp-47" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-47-1" data-tab-group="tabgrp-47">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-47-0" data-tab-group="tabgrp-47" data-tab-active="true">

```Java
public class MethodParameter implements Validable
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-47-1" data-tab-group="tabgrp-47">

```Kotlin
class MethodParameter : Validable
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **className** | String | no | - | Class name |
| **value** | Object | no | - | Parameter value |
| **position** | int | no | - | Parameter position |



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All the properties above are accessible by using getters.

</div></div></div>


**Initializers:**  

There are no initializers.

**Methods:**  

This method retrieves a value of the `className` parameter.


<pre><code class="language-java">public String getClassName()</code></pre>


---

This method retrieves a value of the `value` parameter.


<pre><code class="language-java">public Object getValue()</code></pre>


---

This method retrieves a value of the `position` parameter.


<pre><code class="language-java">public int getPosition()</code></pre>


---

<!-- reusable-table-boundary -->

---
---

### AutoDisappear
<!-- reusable-table-boundary -->

Class model for AutoDisappear.

**Declared In:**  
`com.synerise.sdk.injector.net.model.push.model.banner.AutoDisappear`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-48">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-48-0" data-tab-group="tabgrp-48" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-48-1" data-tab-group="tabgrp-48">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-48-0" data-tab-group="tabgrp-48" data-tab-active="true">

```Java
public class AutoDisappear implements Serializable
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-48-1" data-tab-group="tabgrp-48">

```Kotlin
class AutoDisappear : Serializable
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **isEnabled** | Boolean | no | - | Informs if auto disappear is enabled |
| **timeout** | int | no | - | Disappear timeout |




<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All the properties above are accessible by using getters.

</div></div></div>


**Initializers:**  

There are no initializers.

**Methods:**  

This method checks if auto disappear is enabled.


<pre><code class="language-java">public boolean isEnabled()</code></pre>


---

This method retrieves the value of the `timeout` parameter.


<pre><code class="language-java">public int getTimeout()</code></pre>


---

<!-- reusable-table-boundary -->

---
---

### InAppMessageData
<!-- reusable-table-boundary -->

Model for in-app messaging communication. 

**Declared In:**  
com.synerise.sdk.injector.inapp.InAppMessageData

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-49">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-49-0" data-tab-group="tabgrp-49" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-49-1" data-tab-group="tabgrp-49">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-49-0" data-tab-group="tabgrp-49" data-tab-active="true">

```Java
public InAppMessageData(String campaignHash, String variantId, HashMap<String, Object> additionalParameters, Boolean isTest)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-49-1" data-tab-group="tabgrp-49">

```Kotlin
public InAppMessageData(campaignHash: String, variantId: String, additionalParameters: HashMap<String, Object> , isTest: Boolean)
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **campaignHash** | String | no | Identifier of the in-app message campaign. | | **variantId** | String | no | Identifier of the in-app message campaign variant. |
| **additionalParameters** | HashMap<String, Object> | yes | Parameters additionally provided by the campaign. | | **url** | URL | yes | URL value from the action of the activity. |
| **deeplink** | String | yes | Deep link value from the action of the activity. | | **isTest** | Bool | no | Specifies if the object is from a test campaign. |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All the properties above are accessible by using getters.

</div></div></div>


**Methods:**  
There are only getters for the above properties.

<!-- reusable-table-boundary -->

---
---

### SyneriseMethod

Enum with a list of SDK methods that can be called from JavaScript in an in-app.

See [Using in-app template builder](/docs/campaign/in-app-messages/creating-inapp-templates/creating-inapp-template#use-a-mobile-sdk-method)


# Flutter

## Flutter listeners

#### NotificationsListener {id=notifications-listener}
A listener to handle actions from the notifications module.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-665">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-665-0" data-tab-group="tabgrp-665" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-665-0" data-tab-group="tabgrp-665" data-tab-active="true">

```Dart
Synerise.notifications.listener((listener) {
  // The following method is called when registration for Push Notifications is needed.
  listener.onRegistrationRequired = () {
    ...
  };
});
```

</div>
</div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

After invoking **onRegistrationRequired()** function, you must invoke the [Synerise.notifications.registerForNotifications(registrationToken, mobileAgreement)](/developers/mobile-sdk/method-reference/flutter/campaigns#register-for-push-notifications) method again.

</div></div></div>


---
---

#### InjectorListener {id=injector-listener}
A listener to handle URL and deeplink actions from the injector module.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-666">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-666-0" data-tab-group="tabgrp-666" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-666-0" data-tab-group="tabgrp-666" data-tab-active="true">

```Dart
Synerise.injector.listener((listener) {
  // The following method is called when Synerise handles URL action from campaign activities
  // It is required function
  listener.onOpenUrl = (url) {
      ...
  };
  // The following method is called when Synerise handles deep link action from campaign activities
  // It is required function
  listener.onDeepLink = (deepLink) {
    ...
  };
});
```

</div>
</div>


---
---

#### InjectorInAppMessageListener {id=injector-in-app-message-listener}
A listener to handle the states of [in-app messages](/developers/mobile-sdk/campaigns/in-app-message).


<div class="content-tabs code-tabs" data-tab-group="tabgrp-667">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-667-0" data-tab-group="tabgrp-667" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-667-0" data-tab-group="tabgrp-667" data-tab-active="true">

```Dart
Synerise.injector.inAppMessageListener((listener) {
  // The following method is called after an in-app message appears
  listener.onPresent = (data) {
    ...
  };
  // The following method is called after an in-app message disappears
  listener.onHide = (data) {
    ...
  };
  // This method is called when the SRInApp.openUrl(url) method is used in an in-app message.
  listener.onOpenUrl = (data, url) {
      ...
  };
  // This method is called when the SRInApp.openDeeplink(url) method is used in an in-app message.
  listener.onDeepLink = (data, deepLink) {
    ...
  };
  // This method is called when the
  // SRInApp.handleCustomAction(name, params) method is used in an in-app message.
  listener.onCustomAction = (data, name, parameters) {
    ...
  };
})
```

</div>
</div>


---
---

### InjectorWalkthroughListener {id=injector-walkthrough-listener}


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**InjectorWalkthroughListener** was removed in SDK version 2.0.0.

</div></div></div>


---
---

### InjectorBannerListener {id=injector-banner-listener}


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

**InjectorBannerListener** was removed in SDK version 2.0.0.

</div></div></div>



# Flutter

## Configuring push notifications (Flutter)

### Prerequisites
---

#### Firebase Cloud Messaging
Google Firebase Cloud Messaging is necessary to handle [push notifications](/docs/campaign/Mobile) sent from Synerise.

1. Follow the instructions in [this article](https://firebase.google.com/docs/flutter/setup) and integrate the Firebase plugin with your application.
2. Follow the instructions in [this article](https://firebase.flutter.dev/docs/messaging/overview/) and integrate cloud messaging in your application.
3. Integrate Firebase with Synerise. See [Integration](/docs/settings/tool/firebase) section.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

It's important that the Firebase plugin is initialized as early as possible in the application lifecycle and also after the Synerise SDK. Late initialization may cause compilation problems.

</div></div></div>


### Setting up - Android {id=setting-up-android}
---

#### Requirements {id=android-requirements}

1. After configuring Firebase, add the `google-services.json` file to your project.

2. Add the google-services dependency to your project's `build.gradle` file.
  
   <pre><code class="language-gradle">dependencies {
       ...
       classpath 'com.google.gms:google-services:4.3.3'
       ...
     }</code></pre>


### Setting up - iOS {id=setting-up-ios}
---

#### Requirements {id=ios-requirements}

1. Configure handling Push Notifications in your application. See [Apple Notifications](https://developer.apple.com/notifications/).

2. After configuring Firebase, add the `GoogleService-Info.plist` file to your project.

3. Make sure your `Info.plist` file contains the following snippet:
```xml
<key>FirebaseAppDelegateProxyEnabled</key><true/>
```

#### Extensions for push notifications {id=ios-extensions-for-push-notifications}

##### Notification Service Extension {id=synerise-notification-service-extension-for-ios}

**Synerise Notification Service Extension** is an object that adds the notification functionality to the SDK.
  
It implements the following operations:
- Decrypting **Simple Push** communication data (if encryption is enabled).
- Tracking events from **Simple Push** communication.
- Adding action buttons to **Simple Push** communication (if the communication contains any).
- Improving the appearance of **Simple Push** communication (Rich Media - Single Image) with an image thumbnail.
  
**Notification Service Extension** should be implemented in the native part of the application. Follow the instructions in [this article](/developers/mobile-sdk/configuring-push-notifications/ios#synerise-notification-service-extension-configuration).

##### Rich Media Notification Content Extensions {id=synerise-notification-content-extension-for-ios}

**Synerise Rich Media Notification Content Extension** is an object that allows rendering your own appearance of a push notification when the notification is expanded (by tapping the notification).
  
**Synerise Rich Media Notification Content Extensions** should be implemented in the native part of the application. Follow the instructions in [this article](/developers/mobile-sdk/configuring-push-notifications/ios#rich-media-in-push-notifications).

### Set up Firebase Cloud Messaging for Synerise SDK
---
The following code example explains how to implement Firebase Cloud Messaging integration with Synerise:

1. Define a top-level function for handling notifications when the app is in the terminated state.
2. Request permissions from the user.  
3. Set presentation options for foreground state.  
4. Get Firebase FCM token and set it to deliver push notifications from Synerise.  
5. Make sure that the Firebase FCM token is always up-to-date.  
6. Set Firebase listener method for handling notifications when the app is in the foreground.  
7. Set Firebase listener method for handling notification clicks when the app is in the background.  
8. Invoke method for handling notification clicks when a user opens a notification in the app’s closed state.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-533">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-533-0" data-tab-group="tabgrp-533" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-533-0" data-tab-group="tabgrp-533" data-tab-active="true">

```Dart
class InitialViewState extends State<InitialView> {
  @override
  void initState() {
    // Initialize Synerise SDK
    initializeSynerise();

    // Setup notifications with Firebase
    setupNotifications();

    // 8. Invoke method for handling notification clicks when a user opens a notification in the app’s closed state (see below for definition of the method).
    checkForInitialNotificationMessage();

    super.initState();
  }

  Future<void> initializeSynerise() async {
    Synerise.initializer()
      .withApiKey('YOUR_PROFILE_API_KEY')
      .withBaseUrl("YOUR_API_BASE_URL")
      .withDebugModeEnabled(true)
      .init();
  }

  Future<void> setupNotifications() async {
    await Firebase.initializeApp();

    // 1. Define a top-level function for handling notifications when the app is in the terminated state (see below for definition of the method).
    FirebaseMessaging.onBackgroundMessage(backgroundHandlerForFCM);

    // 2. Request permissions from the user
    await FirebaseMessaging.instance.requestPermission(
      alert: true,
      announcement: false,
      badge: true,
      carPlay: false,
      criticalAlert: false,
      provisional: false,
      sound: true,
    );

    // 3. Set presentation options for the foreground state
    await FirebaseMessaging.instance.setForegroundNotificationPresentationOptions(
      alert: true,
      badge: true,
      sound: true,
    );

    // 4. Get Firebase FCM token and set it to deliver push notifications from Synerise
    FirebaseMessaging.instance.getToken().then((token) {
      if (token != null) {
        Synerise.notifications.registerForNotifications(token, true);
      }
    });

    // 5. Make sure that the Firebase FCM token is always up-to-date
    FirebaseMessaging.instance.onTokenRefresh.listen((event) {
      FirebaseMessaging.instance.getToken().then((token) {
        if (token != null) {
            Synerise.notifications.registerForNotifications(
              firebaseToken!,
              mobileAgreement: true, // true or false, should depend on device permissions and customer's agreement in the application
              onSuccess: () {},
              onError: (error) {},
            );
        }
      });
    });

    Synerise.notifications.listener((listener) {
      listener.onRegistrationRequired = () {
        FirebaseMessaging.instance.getToken().then((token) {
          if (token != null) {
            Synerise.notifications.registerForNotifications(
              firebaseToken!,
              mobileAgreement: true, // true or false, should depend on device permissions and customer's agreement in the application
              onSuccess: () {},
              onError: (error) {},
            );
          }
        });
      };
    });

    // 6. Set Firebase listener method for handling notifications when the app is in the foreground
    FirebaseMessaging.onMessage.listen((RemoteMessage message) async {
      Map messageMap = message.toMap();
      bool isSyneriseNotification = await Synerise.notifications.isSyneriseNotification(messageMap);
      if (isSyneriseNotification == true) {
        Synerise.notifications.handleNotification(messageMap);
      }      
    });

    // 7. Set Firebase listener method for handling notification clicks when the app is in the background
    FirebaseMessaging.onMessageOpenedApp.listen((RemoteMessage message) async {
      Map messageMap = message.toMap();
      bool isSyneriseNotification = await Synerise.notifications.isSyneriseNotification(messageMap);
      if (isSyneriseNotification == true) {
        Synerise.notifications.handleNotificationClick(messageMap);
      }
    });
  }

  @pragma('vm:entry-point')
  Future<void> backgroundHandlerForFCM(RemoteMessage message) async {
    await Firebase.initializeApp();
    await initializeSynerise();

    Map<String, dynamic> messageMap = message.toMap();
    bool isSyneriseNotification = await Synerise.notifications.isSyneriseNotification(messageMap);
    if (isSyneriseNotification) {
      Synerise.notifications.handleNotification(remoteMessageMap);
    }
  }

  Future<void> checkForInitialNotificationMessage() async {
    await Firebase.initializeApp();
    RemoteMessage? message = await FirebaseMessaging.instance.getInitialMessage();
    if (message != null) {
      Map messageMap = message.toMap();
      bool isSyneriseNotification = await Synerise.notifications.isSyneriseNotification(messageMap);
      if (isSyneriseNotification == true) {
        Synerise.notifications.handleNotificationClick(messageMap);
      }
    }
  }

  //...
}
```

</div>
</div>



<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The second parameter of the registration method is the agreement for mobile push campaigns. In the Profile's card in Synerise, you can find it in the **Subscriptions** section (if you have the required access permission). Learn more about the [Synerise.notifications.registerForNotifications(registrationToken, mobileAgreement) method in the method reference](/developers/mobile-sdk/method-reference/flutter/campaigns#register-for-push-notifications).

</div></div></div>



<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

You must always keep the Firebase token updated. In many cases in the application lifecycle, such as authorization, destroy session, user context change, and so on, the registration needs to be updated. In these situations, the SDK invokes the [onRegistrationRequired()](/developers/mobile-sdk/listeners-and-delegates/flutter-listeners#notifications-listener) method (see code snippet above).

</div></div></div>


### Configure Notification Encryption
---
#### Android {id=android-notification-encryption-configuration}
See [Configure Notification Encryption](/developers/mobile-sdk/configuring-push-notifications/android#configure-notification-encryption).

#### iOS {id=ios-notification-encryption-configuration}
See [Synerise Notification Service Extension](#synerise-notification-service-extension-for-ios) and [Configure Notification Encryption](/developers/mobile-sdk/configuring-push-notifications/ios#configure-notification-encryption).

#### Application implementation {id=application-notification-encryption-configuration}

In the application, you must set `encryption` to `true` in the SDK initializer or in the SDK settings. 


<div class="content-tabs code-tabs" data-tab-group="tabgrp-534">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-534-0" data-tab-group="tabgrp-534" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-534-0" data-tab-group="tabgrp-534" data-tab-active="true">

```JavaScript
// WARNING: This option must be configured before Synerise SDK is initialized!
Synerise.settings.notifications.encryption = true;
```

</div>
</div>


### Handling incoming push notifications
---


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

You may disable handling push notifications in the SDK at any time. See [Enable/disable notifications](/developers/mobile-sdk/settings#enabledisable-notifications).

</div></div></div>


#### Synerise payload

The following sample code shows how to handle notifications and check if they are from Synerise:
 

<div class="content-tabs code-tabs" data-tab-group="tabgrp-535">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-535-0" data-tab-group="tabgrp-535" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-535-0" data-tab-group="tabgrp-535" data-tab-active="true">

```Dart
//...
FirebaseMessaging.onMessage.listen((RemoteMessage message) {
  Map messageMap = message.toMap();
  bool isSyneriseNotification = await Synerise.notifications.isSyneriseNotification(messageMap);
  if (isSyneriseNotification == true) {
    Synerise.notifications.handleNotification(messageMap);
  }    
});
FirebaseMessaging.onMessageOpenedApp.listen((RemoteMessage message) {
  Map messageMap = message.toMap();
  bool isSyneriseNotification = await Synerise.notifications.isSyneriseNotification(messageMap);
  if (isSyneriseNotification == true) {
    Synerise.notifications.handleNotificationClick(messageMap);
  }    
});
//...
```

</div>
</div>


#### Custom payload

You may send both custom push notifications and custom campaigns in [Synerise](https://app.synerise.com). The code below of one sample Firebase listener method checks the notification origin and then handles it:


<div class="content-tabs code-tabs" data-tab-group="tabgrp-536">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-536-0" data-tab-group="tabgrp-536" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-536-0" data-tab-group="tabgrp-536" data-tab-active="true">

```Dart
//...
FirebaseMessaging.onMessage.listen((RemoteMessage message) {
  Map messageMap = message.toMap();
  bool isSyneriseNotification = await Synerise.notifications.isSyneriseNotification(messageMap);
  if (isSyneriseNotification == true) {
    Synerise.notifications.handleNotification(messageMap);
  } else {
    // Handle other notifications in your own way
  } 
});
//...
```

</div>
</div>


### Handling actions from push notifications
---
- [Read more about types of actions in campaigns](/developers/mobile-sdk/campaigns/action-handling#types-of-actions-in-campaigns)  
- [Read more about handling actions from push notifications](/developers/mobile-sdk/campaigns/action-handling#handling-actions-from-campaigns-in-flutter)  

### Additional in-app alert from push notifications
---
The Flutter SDK on iOS devices can display an additional alert in the application after a push notification is received. See [this article](/developers/mobile-sdk/campaigns/simple-push#additional-in-app-alert-when-simple-push-is-received) to read more about this feature.

<figure><img src="/api/docs/image/1feaba7a61cfa27310b1012bd8eb2c1f623b7b5a/developers/mobile-sdk/_gfx/ios-simple-push-in-app-alert.png" alt="Simple Push campaign with in-app alert" class="small"><figcaption>Simple Push campaign with in-app alert</figcaption></figure>

### Limitations compared to native platforms
---

Due to platform limitations, not all notification functionalities may work as in native SDKs.
  
- **iOS only**: Native-configured button from a Simple Push campaign always invokes the default action (if configured) or displays an in-app alert with buttons to choose.



# Customer session


---
## Refresh customer token
---
This method refreshes the customer’s current token.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns an error if the token has expired and cannot be refreshed.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/client/client_impl.dart
  
**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)


<div class="content-tabs" data-tab-group="tabgrp-974">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-974-0" data-tab-group="tabgrp-974" data-tab-active="true">SDK &gt;= 1.0.0</button><button class="tab-button" data-tab-id="tabgrp-974-1" data-tab-group="tabgrp-974">Legacy SDK</button></div>

<div class="tab-panel" data-tab-id="tabgrp-974-0" data-tab-group="tabgrp-974" data-tab-active="true">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; refreshToken({required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **onSuccess** | Function() | yes | - | Function to be executed when the operation is completed successfully |
| **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error |
  
**Return Value:**  
No value is returned.
  
**Example:**  

<pre><code class="language-Dart">await Synerise.client.refreshToken(onSuccess: () {
  //onSuccess handling
}, onError: (SyneriseError error) {
  //onError handling
});</code></pre>

</div>

<div class="tab-panel" data-tab-id="tabgrp-974-1" data-tab-group="tabgrp-974">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;bool&gt; refreshToken() async</code></pre>

  
**Return Value:**  
**true** if the operation is success, otherwise it throws an error.
  
**Example:**  

<pre><code class="language-Dart">await  Synerise.client.refreshToken().catchError((error)</code></pre>

</div>
</div>


<!-- reusable-table-boundary -->

## Retrieve customer token
---
This method retrieves the customer’s current, active token.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns an error if the token has expired and cannot be retrieved.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/client/client_impl.dart

**Related To:**  
[Token](/developers/mobile-sdk/class-reference/flutter/client#token)

**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)
  

<div class="content-tabs" data-tab-group="tabgrp-975">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-975-0" data-tab-group="tabgrp-975" data-tab-active="true">SDK &gt;= 1.0.0</button><button class="tab-button" data-tab-id="tabgrp-975-1" data-tab-group="tabgrp-975">Legacy SDK</button></div>

<div class="tab-panel" data-tab-id="tabgrp-975-0" data-tab-group="tabgrp-975" data-tab-active="true">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; retrieveToken({required void Function(Token) onSuccess, required void Function(SyneriseError) onError}) async</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Description |
| --- | --- | --- | --- |
| **onSuccess** | Function([Token](/developers/mobile-sdk/class-reference/flutter/client#token) token) | yes | - | Function to be executed when the operation is completed successfully |
| **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error |
  
**Return Value:**  
No value is returned.
  
**Example:**  

<pre><code class="language-Dart">await Synerise.client.retrieveToken(onSuccess: (Token token) {
  //onSuccess handling
}, onError: (SyneriseError error) {
  //onError handling
});</code></pre>

</div>

<div class="tab-panel" data-tab-id="tabgrp-975-1" data-tab-group="tabgrp-975">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;Token&gt; retrieveToken() async</code></pre>

  
**Return Value:**  
[Token](/developers/mobile-sdk/class-reference/flutter/client#token)
  
**Example:**  

<pre><code class="language-Dart">Token token = await  Synerise.client.retrieveToken().catchError((error)</code></pre>

</div>
</div>


<!-- reusable-table-boundary -->

## Get current customer UUID
---
This method retrieves the customer’s current UUID.
**Declared In:**  
lib/modules/client/client_impl.dart

**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)


<div class="content-tabs" data-tab-group="tabgrp-976">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-976-0" data-tab-group="tabgrp-976" data-tab-active="true">SDK &gt;= 1.0.0</button><button class="tab-button" data-tab-id="tabgrp-976-1" data-tab-group="tabgrp-976">Legacy SDK</button></div>

<div class="tab-panel" data-tab-id="tabgrp-976-0" data-tab-group="tabgrp-976" data-tab-active="true">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;String&gt; getUUID() async</code></pre>


**Return Value:**  
String

**Example:**  

<pre><code class="language-Dart">await Synerise.client
        .getUUID()
        .then((result) =&gt; {
        //result handling
        });</code></pre>

</div>

<div class="tab-panel" data-tab-id="tabgrp-976-1" data-tab-group="tabgrp-976">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;String&gt; getUUID() async</code></pre>


**Return Value:**  
String

**Example:**  

<pre><code class="language-Dart">String uuid = await  Synerise.client.getUUID().catchError((error)</code></pre>

</div>
</div>


## Regenerate customer
---
<!-- reusable-table-boundary -->

This method regenerates the UUID and clears the authentication token, login session, custom email, and custom identifier.
  
This operation works only if the customer is anonymous.

This operation clears the authentication token, login (if applicable), custom email, and custom identifier.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.3.10 | 3.3.5 | 0.9.0 | 0.7.0 |

<!-- reusable-table-boundary -->
**Declared In:**  
lib/modules/client/client_impl.dart
  
**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)
  
**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; regenerateUUID() async</code></pre>

  
**Return Value:**  
No value is returned.
  
**Example:**  

<pre><code class="language-Dart">await Synerise.client
        .regenerateUUID()
        .then((result) =&gt; {
        //result handling
        });</code></pre>


## Regenerate customer with identifier
---
<!-- reusable-table-boundary -->

This method regenerates the UUID and clears the authentication token, login session, custom email, and custom identifier.
  
This operation works only if the customer is anonymous.
  
This operation clears the authentication token, login (if applicable), custom email, and custom identifier
  
The optional `clientIdentifier` parameter is a seed for UUID generation.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.6.5 | 3.6.4 | 0.9.10 | 0.7.2 |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/client/client_impl.dart

**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)
  
**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; regenerateUUIDWithClientIdentifier(String clientIdentifier) async</code></pre>


**Parameters:**  
| Parameter | Type | Mandatory | Description |
| --- | --- | --- | --- |
| **clientIdentifier** | String | no | Seed for UUID generation |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The **clientIdentifier** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>

  
**Return Value:**  
No value is returned.

**Example:**

<pre><code class="language-Dart">await Synerise.client
        .regenerateUUIDWithClientIdentifier(clientIdentifier)
        .then((result) =&gt; {
        //result handling
        });</code></pre>


<!-- reusable-table-boundary -->

## Destroy current session
---
This method destroys the session completely.

This method clears all session data (both client and anonymous) and removes cached data. Then, it regenerates the UUID and creates the new anonymous session.
<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/client/client_impl.dart

**Class:**  
[ClientImpl](/developers/mobile-sdk/class-reference/flutter/modules#client)


<div class="content-tabs" data-tab-group="tabgrp-977">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-977-0" data-tab-group="tabgrp-977" data-tab-active="true">SDK &gt;= 1.0.0</button><button class="tab-button" data-tab-id="tabgrp-977-1" data-tab-group="tabgrp-977">Legacy SDK</button></div>

<div class="tab-panel" data-tab-id="tabgrp-977-0" data-tab-group="tabgrp-977" data-tab-active="true">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; destroySession({required void Function() onSuccess, required void Function(SyneriseError) onError}) async</code></pre>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **onSuccess** | Function() | yes | - | Function to be executed when the operation is completed successfully |
| **onError** | Function([SyneriseError](/developers/mobile-sdk/class-reference/flutter/miscellaneous#syneriseerror) error) | yes | - | Function to be executed when the operation is completed with an error |

**Return Value:**  
No value is returned.

**Example:**  

<pre><code class="language-Dart">await Synerise.client.destroySession(onSuccess: () {
  //onSuccess handling
}, onError: (SyneriseError error) {
  //onError handling
});</code></pre>

</div>

<div class="tab-panel" data-tab-id="tabgrp-977-1" data-tab-group="tabgrp-977">

**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; destroySession() async</code></pre>

  
**Return Value:**  
No value is returned.

**Example:**  

<pre><code class="language-Dart">await  Synerise.client.destroySession().catchError((error)</code></pre>

</div>
</div>


<!-- reusable-table-boundary -->


# Huawei integration in Flutter SDK


## Enable integration in the Synerise platform

Before you start integrating Huawei services in your app, you must configure the integration in Synerise platform. For instructions, see ["Huawei integration"](/docs/settings/tool/huawei-integration).

## Configuration

In order to integrate Huawei Mobile Services (HMS) with Synerise, you must add `.setMesaggingServiceType(MessagingServiceType.hms)` to your `Synerise.initializer`.

We recommend passing `MessagingServiceType.hms` as an argument when you build the app for AppGallery.


<div class="admonition admonition-tip"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M9.663 17h4.673M12 3v1m6.364 1.636l-.707.707M21 12h-1M4 12H3m3.343-5.657l-.707-.707m2.828 9.9a5 5 0 117.072 0l-.548.547A3.374 3.374 0 0014 18.469V19a2 2 0 11-4 0v-.531c0-.895-.356-1.754-.988-2.386l-.548-.547z" /></svg></div><div class="admonition-body"><div class="admonition-content">

More information about `Synerise.initializer` is available in ["Initialization"](/developers/mobile-sdk/installation-and-configuration/flutter#initialization).

</div></div></div>


## Implementing Huawei notifications in applications

1. Add the Huawei push library as a dependency and integrate it: [https://pub.dev/packages/huawei_push](https://pub.dev/packages/huawei_push).
2. Add an `onTokenEvent` callback to receive the HMS token. In the callback, send the token to Synerise by using [`Synerise.notifications.registerForNotifications`](/developers/mobile-sdk/method-reference/flutter/campaigns#register-for-push-notifications) method:  
    
   <pre><code class="language-js">void _onTokenEvent(String event) {
       // Requested tokens can be obtained here
       setState(() {
         _token = event;
       });
       if (event != null &amp;&amp; event.isNotEmpty) {
         Synerise.notifications.registerForNotifications(
           event,
           mobileAgreement: true,
           onSuccess: () {},
           onError: (error) {},
         );
         print("TokenEvent: " + _token);
       }
     }</code></pre>

3. Add a listener to trigger `getToken()` from the Huawei push library whenever the [`onRegistrationRequired`](/developers/mobile-sdk/listeners-and-delegates/flutter-listeners#notifications-listener) callback is called:  
    
   <pre><code class="language-js">Synerise.notifications.listener((listener) {
         listener.onRegistrationRequired = () {
           getToken();
         };
       });</code></pre>

4. Add the `onMessageReceived` callback from the Huawei push library and pass the data to Synerise SDK:  
    
   <pre><code class="language-js">Future&lt;void&gt; _onMessageReceived(RemoteMessage remoteMessage) async {
       // Called when a data message is received
       Map&lt;String, String&gt;? data = remoteMessage.getDataOfMap;
       if (data != null) {
         bool isSyneriseNotification =
         await Synerise.notifications.isSyneriseNotification(data);
         if (isSyneriseNotification == true) {
           Synerise.notifications.handleNotification(data);
           bool isSyneriseNotificationEncrypted = await Synerise.notifications
               .isNotificationEncrypted(data);
           if (isSyneriseNotificationEncrypted) {
             Map decryptedPayload =
             await Synerise.notifications.decryptNotification(data);
             developer.log(decryptedPayload.toString());
           }
         }
       }
     }</code></pre>

5. To make sure your callbacks work, use streams:  
    
   <pre><code class="language-js">Future&lt;void&gt; initTokenStream() async {
       if (!mounted) return;
       Push.getTokenStream.listen(_onTokenEvent, onError: _onTokenError);
     }

     void getToken() {
       // Call this method to request for a token
       Push.getToken("");
     }

     Future&lt;void&gt; initMessageStream() async {
       if (!mounted) return;
       Push.onMessageReceivedStream
           .listen(_onMessageReceived, onError: _onMessageReceiveError);
     }</code></pre>


## Links and Deep Links

In order to implement links and deep links, refer to [this](/developers/mobile-sdk/campaigns/action-handling#handling-actions-from-campaigns-in-android) instruction.

## Configuring notification encryption

Instructions for encrypting push notifications are available [here](/developers/mobile-sdk/configuring-push-notifications/flutter#configure-notification-encryption).


# Inline in-app


An inline in-app message is a component that you embed directly into your app's view hierarchy — for example, a banner between list sections, a tile on the home screen, a menu, or even an entire view. They allow you to manipulate content in the application without changing the code of the app.

## Trigger modes
---

Inline in-app campaigns support three trigger modes, configured in the campaign settings:

- **Automatic** — the in-app message is rendered automatically when a view with the associated placement (container ID) appears on the screen.
- **On demand** — the in-app message is rendered when the application calls the SDK method.
- **Event** — the in-app message is rendered when a specified event occurs in the application.

In terms of the SDK behavior:
- For **Automatic**, the SDK shows the content as soon as the component is added to the view hierarchy.
- For **On demand**, the application calls [`render()`](/developers/mobile-sdk/method-reference/android/campaigns#render-inline-in-app-view) to trigger content rendering.
- For **Event**, if a component for the placement is already embedded, the SDK updates its content. Otherwise, the SDK creates a new component and delivers it through the global listener/delegate.

## Multiple views and campaign priority
---

Several `InlineInAppView` instances can share the same placement key. Each instance receives the campaign independently — `inApp.show` and `inApp.discard` events are reported per view, while capping is counted once per display.

When more than one campaign matches a placement, the campaign with the highest priority wins (lower number = higher priority). A campaign that is already displayed is not replaced by another campaign of equal or lower priority.

## Controlling behavior and actions
---

Inline in-app messages use two types of callbacks:

- **Per-component listener/delegate** handles the lifecycle of an individual component: loading, updating, size changes, and removal requests. You set it on each `InlineInAppView` instance.
- **Global listener/delegate** handles action callbacks: URL, deeplink, custom action, custom method; and delivers SDK-created components for event-based triggers. You set it once at the application level.

You can handle the per-component lifecycle using:
- [OnInlineInAppViewListener](/developers/mobile-sdk/listeners-and-delegates/android-listeners#on-inline-in-app-view-listener) methods for Android
- [InlineInAppViewDelegate](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#inline-in-app-view-delegate) methods for iOS

You can handle actions and event-based delivery using:
- [OnInlineInAppListener](/developers/mobile-sdk/listeners-and-delegates/android-listeners#on-inline-in-app-listener) methods for Android
- [InjectorInlineInAppMessageDelegate](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#injector-inline-in-app-message-delegate) methods for iOS

See the following code samples for the per-component delegate/listener:


<div class="content-tabs code-tabs" data-tab-group="tabgrp-25">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-25-0" data-tab-group="tabgrp-25" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-25-1" data-tab-group="tabgrp-25">Kotlin</button><button class="tab-button" data-tab-id="tabgrp-25-2" data-tab-group="tabgrp-25">Swift</button></div>

<div class="tab-panel" data-tab-id="tabgrp-25-0" data-tab-group="tabgrp-25" data-tab-active="true">

```Java
inlineView.setOnInlineInAppViewListener(new OnInlineInAppViewListener() {
  // This method is called when the SDK starts processing a campaign for this component.
  @Override
  public void onProcessingStarted() {
    //...
  }

  // This method is called when the inline in-app message content is loaded for the first time.
  @Override
  public void onLoaded(InlineInAppMessageData data) {
    //...
  }

  // This method is called when the inline in-app message content is updated with a new campaign.
  @Override
  public void onUpdated(InlineInAppMessageData data) {
    //...
  }

  // This method is called when the inline in-app message content fails to load or render.
  @Override
  public void onFailed(InlineInAppMessageData data, String error) {
    //...
  }

  // This method is called when the in-app message content requests a size change
  // via the SRInApp.setComponentSize(width, height) JS method.
  @Override
  public void onSizeChanged(InlineInAppMessageData data, InlineInAppSize size) {
    //...
  }

  // 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.
  @Override
  public void onRemove(InlineInAppMessageData data) {
    //...
  }
});
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-25-1" data-tab-group="tabgrp-25">

```Kotlin
inlineView.setOnInlineInAppViewListener(object : OnInlineInAppViewListener {
  // This method is called when the SDK starts processing a campaign for this component.
  override fun onProcessingStarted() {
    //...
  }

  // This method is called when the inline in-app message content is loaded for the first time.
  override fun onLoaded(data: InlineInAppMessageData) {
    //...
  }

  // This method is called when the inline in-app message content is updated with a new campaign.
  override fun onUpdated(data: InlineInAppMessageData) {
    //...
  }

  // This method is called when the inline in-app message content fails to load or render.
  override fun onFailed(data: InlineInAppMessageData, error: String) {
    //...
  }

  // This method is called when the in-app message content requests a size change
  // via the SRInApp.setComponentSize(width, height) JS method.
  override fun onSizeChanged(data: InlineInAppMessageData, size: InlineInAppSize) {
    //...
  }

  // 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.
  override fun onRemove(data: InlineInAppMessageData) {
    //...
  }
})
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-25-2" data-tab-group="tabgrp-25">

```Swift
// MARK: - InlineInAppViewDelegate

// This method is called when the SDK starts processing a campaign for this component.
func snr_inlineInAppViewDidStartProcessing(view: InlineInAppView) {
  //...
}

// This method is called when the inline in-app message content is loaded for the first time.
func snr_inlineInAppViewDidLoad(view: InlineInAppView, data: InlineInAppMessageData) {
  //...
}

// This method is called when the inline in-app message content is updated with a new campaign.
func snr_inlineInAppViewDidUpdate(view: InlineInAppView, data: InlineInAppMessageData) {
  //...
}

// This method is called when the inline in-app message content fails to load or render.
func snr_inlineInAppViewDidFail(view: InlineInAppView, error: Error) {
  //...
}

// This method is called when the in-app message content requests a size change
// via the SRInApp.setComponentSize(width, height) JS method.
func snr_inlineInAppViewChangeSizeIsNeeded(view: InlineInAppView, data: InlineInAppMessageData, size: InlineInAppSize) {
  //...
}

// 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.
func snr_inlineInAppViewShouldBeRemoved(view: InlineInAppView, data: InlineInAppMessageData) {
  //...
}
```

</div>
</div>


See the following code samples for the global listener/delegate:


<div class="content-tabs code-tabs" data-tab-group="tabgrp-26">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-26-0" data-tab-group="tabgrp-26" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-26-1" data-tab-group="tabgrp-26">Kotlin</button><button class="tab-button" data-tab-id="tabgrp-26-2" data-tab-group="tabgrp-26">Swift</button></div>

<div class="tab-panel" data-tab-id="tabgrp-26-0" data-tab-group="tabgrp-26" data-tab-active="true">

```Java
Injector.setOnInlineInAppListener(new OnInlineInAppListener() {
  // 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.
  @Override
  public void onInlineInAppAvailable(InlineInAppView view, InlineInAppMessageData data) {
    //...
  }

  // This method is called when a per-message context is needed for rendering.
  @Override
  public Map<String, Object> onContextFromAppRequired(InAppMessageData data) {
    return new HashMap<>();
  }

  // This method is called when the SRInApp.openUrl(url) method is used in an in-app message.
  @Override
  public void onOpenedUrl(InlineInAppMessageData data, String url) {
    //...
  }

  // This method is called when the SRInApp.openDeeplink(url) method is used in an in-app message.
  @Override
  public void onOpenedDeepLink(InlineInAppMessageData data, String deepLink) {
    //...
  }

  // This method is called when the SRInApp.handleCustomAction(name, params) method is used in an in-app message.
  @Override
  public void onCustomAction(InlineInAppMessageData data, String name, Map<String, Object> params) {
    //...
  }

  // 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.
  @Override
  public void onCustomMethod(String name, HashMap<String, Object> params, InlineInAppMessageData data, InAppCustomMethodCompletion completion) {
    //...
  }
});
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-26-1" data-tab-group="tabgrp-26">

```Kotlin
Injector.setOnInlineInAppListener(object : OnInlineInAppListener {
  // 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.
  override fun onInlineInAppAvailable(view: InlineInAppView, data: InlineInAppMessageData) {
    //...
  }

  // This method is called when a per-message context is needed for rendering.
  override fun onContextFromAppRequired(data: InAppMessageData): MutableMap<String, Any> {
    return HashMap()
  }

  // This method is called when the SRInApp.openUrl(url) method is used in an in-app message.
  override fun onOpenedUrl(data: InlineInAppMessageData, url: String) {
    //...
  }

  // This method is called when the SRInApp.openDeeplink(url) method is used in an in-app message.
  override fun onOpenedDeepLink(data: InlineInAppMessageData, deepLink: String) {
    //...
  }

  // This method is called when the SRInApp.handleCustomAction(name, params) method is used in an in-app message.
  override fun onCustomAction(data: InlineInAppMessageData, name: String, params: Map<String, Any>) {
    //...
  }

  // 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.
  override fun onCustomMethod(name: String, params: HashMap<String, Any>, data: InlineInAppMessageData, completion: InAppCustomMethodCompletion) {
    //...
  }
})
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-26-2" data-tab-group="tabgrp-26">

```Swift
// MARK: - InjectorInlineInAppMessageDelegate

// 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.
func snr_inlineInAppMessageDidBecomeAvailable(view: InlineInAppView, data: InlineInAppMessageData) {
  //...
}

// This method is called when a per-message context is needed for rendering.
func snr_inlineInAppMessageContextIsNeeded(data: InlineInAppMessageData) -> [AnyHashable: Any]? {
  return nil
}

// This method is called when the SRInApp.openUrl(url) method is used in an in-app message.
func snr_inlineInAppMessageHandledAction(data: InlineInAppMessageData, url: URL) {
  //...
}

// This method is called when the SRInApp.openDeeplink(url) method is used in an in-app message.
func snr_inlineInAppMessageHandledAction(data: InlineInAppMessageData, deepLink: String) {
  //...
}

// This method is called when the SRInApp.handleCustomAction(name, params) method is used in an in-app message.
func snr_inlineInAppMessageHandledCustomAction(data: InlineInAppMessageData, name: String, parameters: [AnyHashable: Any]) {
  //...
}

// 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.
func snr_inlineInAppMessageHandledCustomMethod(data: InlineInAppMessageData, name: String, parameters: [AnyHashable: Any], completion: InAppCustomMethodCompletion) {
  //...
}
```

</div>
</div>


## Placement-based integration
---

In this approach, you create a component for a known placement, attach a per-component delegate/listener, and embed the view in your UI.

1. Create the component with [`Injector.createInlineInAppView`](/developers/mobile-sdk/method-reference/android/campaigns#create-inline-in-app-view).
2. Set the per-component delegate/listener on the created view.
3. Add the view to your view hierarchy.
4. For campaigns with the automatic trigger, the SDK requests content as soon as the view is in the hierarchy. For on-demand campaigns, call [`render()`](/developers/mobile-sdk/method-reference/android/campaigns#render-inline-in-app-view).


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The component has no default size — the application must set its dimensions. The in-app message content is automatically pinned to all edges of the component.

</div></div></div>



<div class="content-tabs code-tabs" data-tab-group="tabgrp-27">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-27-0" data-tab-group="tabgrp-27" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-27-1" data-tab-group="tabgrp-27">Kotlin</button><button class="tab-button" data-tab-id="tabgrp-27-2" data-tab-group="tabgrp-27">Swift</button></div>

<div class="tab-panel" data-tab-id="tabgrp-27-0" data-tab-group="tabgrp-27" data-tab-active="true">

```Java
InlineInAppView inlineView = Injector.createInlineInAppView(this, "home_top_banner");
inlineView.setOnInlineInAppViewListener(viewListener);

FrameLayout container = findViewById(R.id.banner_container);
container.addView(inlineView, new FrameLayout.LayoutParams(
    FrameLayout.LayoutParams.MATCH_PARENT,
    FrameLayout.LayoutParams.MATCH_PARENT));
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-27-1" data-tab-group="tabgrp-27">

```Kotlin
val inlineView = Injector.createInlineInAppView(this, "home_top_banner")
inlineView.setOnInlineInAppViewListener(viewListener)

val container: FrameLayout = findViewById(R.id.banner_container)
container.addView(inlineView, FrameLayout.LayoutParams(
    FrameLayout.LayoutParams.MATCH_PARENT,
    FrameLayout.LayoutParams.MATCH_PARENT))
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-27-2" data-tab-group="tabgrp-27">

```Swift
guard let inlineView = Injector.createInlineInAppView(placementKey: "home_top_banner") else {
    return
}

inlineView.delegate = self
inlineView.translatesAutoresizingMaskIntoConstraints = false
view.addSubview(inlineView)

NSLayoutConstraint.activate([
    inlineView.topAnchor.constraint(equalTo: view.safeAreaLayoutGuide.topAnchor),
    inlineView.leadingAnchor.constraint(equalTo: view.leadingAnchor),
    inlineView.trailingAnchor.constraint(equalTo: view.trailingAnchor),
    inlineView.heightAnchor.constraint(equalToConstant: 100)
])
```

</div>
</div>


## Event-based integration
---

In this approach, a campaign is triggered by an event (sent through `Tracker.send`), not by embedding a view. The behavior depends on whether a component for the given placement is already in the view hierarchy:

- **Component already embedded** — the SDK updates the existing view's content. The per-component delegate/listener receives `onUpdated`/`snr_inlineInAppViewDidUpdate`. The global listener/delegate is not called.
- **No existing component** — the SDK creates a new `InlineInAppView` and delivers it through the global listener/delegate (`onInlineInAppAvailable`/`snr_inlineInAppMessageDidBecomeAvailable`). The application must embed the delivered view in the appropriate place.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-28">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-28-0" data-tab-group="tabgrp-28" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-28-1" data-tab-group="tabgrp-28">Kotlin</button><button class="tab-button" data-tab-id="tabgrp-28-2" data-tab-group="tabgrp-28">Swift</button></div>

<div class="tab-panel" data-tab-id="tabgrp-28-0" data-tab-group="tabgrp-28" data-tab-active="true">

```Java
@Override
public void onInlineInAppAvailable(InlineInAppView view, InlineInAppMessageData data) {
    ViewGroup container = containerForPlacementKey(data.getPlacementKey());
    if (container == null) {
        return;
    }
    view.setOnInlineInAppViewListener(this);
    container.addView(view, new FrameLayout.LayoutParams(
        FrameLayout.LayoutParams.MATCH_PARENT,
        FrameLayout.LayoutParams.MATCH_PARENT));
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-28-1" data-tab-group="tabgrp-28">

```Kotlin
override fun onInlineInAppAvailable(view: InlineInAppView, data: InlineInAppMessageData) {
    val container = containerForPlacementKey(data.placementKey) ?: return
    view.setOnInlineInAppViewListener(this)
    container.addView(view, FrameLayout.LayoutParams(
        FrameLayout.LayoutParams.MATCH_PARENT,
        FrameLayout.LayoutParams.MATCH_PARENT))
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-28-2" data-tab-group="tabgrp-28">

```Swift
func snr_inlineInAppMessageDidBecomeAvailable(view: InlineInAppView, data: InlineInAppMessageData) {
    guard let container = container(forPlacementKey: data.placementKey) else {
        return
    }

    view.delegate = self
    view.translatesAutoresizingMaskIntoConstraints = false
    container.addSubview(view)

    NSLayoutConstraint.activate([
        view.topAnchor.constraint(equalTo: container.topAnchor),
        view.bottomAnchor.constraint(equalTo: container.bottomAnchor),
        view.leadingAnchor.constraint(equalTo: container.leadingAnchor),
        view.trailingAnchor.constraint(equalTo: container.trailingAnchor)
    ])
}
```

</div>
</div>


## Dynamic sizing
---

The in-app message content can read the current size of the hosting component by calling `SRInApp.getComponentSize()` from the JS interface. This returns an object with `width` and `height` properties in dp (CSS pixels).

The content can request a size change at any time by calling `SRInApp.setComponentSize(width, height)`. The SDK communicates this request through the per-component delegate/listener. The application is responsible for updating the component's layout.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-29">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-29-0" data-tab-group="tabgrp-29" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-29-1" data-tab-group="tabgrp-29">Kotlin</button><button class="tab-button" data-tab-id="tabgrp-29-2" data-tab-group="tabgrp-29">Swift</button></div>

<div class="tab-panel" data-tab-id="tabgrp-29-0" data-tab-group="tabgrp-29" data-tab-active="true">

```Java
@Override
public void onSizeChanged(InlineInAppMessageData data, InlineInAppSize size) {
    if (inlineView == null) {
        return;
    }
    ViewGroup.LayoutParams layoutParams = inlineView.getLayoutParams();
    layoutParams.height = size.getHeightPx();

    ViewGroup parent = (ViewGroup) inlineView.getParent();
    if (parent != null) {
        TransitionManager.beginDelayedTransition(parent, new AutoTransition());
    }
    inlineView.setLayoutParams(layoutParams);
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-29-1" data-tab-group="tabgrp-29">

```Kotlin
override fun onSizeChanged(data: InlineInAppMessageData, size: InlineInAppSize) {
    val view = inlineView ?: return
    val layoutParams = view.layoutParams
    layoutParams.height = size.heightPx

    (view.parent as? ViewGroup)?.let {
        TransitionManager.beginDelayedTransition(it, AutoTransition())
    }
    view.layoutParams = layoutParams
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-29-2" data-tab-group="tabgrp-29">

```Swift
func snr_inlineInAppViewChangeSizeIsNeeded(view: InlineInAppView, data: InlineInAppMessageData, size: InlineInAppSize) {
    heightConstraint?.constant = CGFloat(size.heightPt)
    UIView.animate(withDuration: 0.2) {
        self.view.layoutIfNeeded()
    }
}
```

</div>
</div>


## Removing the view
---

When the in-app message content calls `SRInApp.close()` or `SRInApp.closeAndTrigger(action, params, label)` from the JS interface, the SDK sends an `inApp.discard` event (with `closedBy=user`). In the case of `closeAndTrigger`, the SDK additionally sends a custom event through Tracker. The SDK then requests removal through the per-component delegate/listener.

On Android, call [`release()`](/developers/mobile-sdk/method-reference/android/campaigns#release-inline-in-app-view) before removing the view from the hierarchy to clean up the WebView and unregister the component from the SDK.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-30">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-30-0" data-tab-group="tabgrp-30" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-30-1" data-tab-group="tabgrp-30">Kotlin</button><button class="tab-button" data-tab-id="tabgrp-30-2" data-tab-group="tabgrp-30">Swift</button></div>

<div class="tab-panel" data-tab-id="tabgrp-30-0" data-tab-group="tabgrp-30" data-tab-active="true">

```Java
@Override
public void onRemove(InlineInAppMessageData data) {
    if (inlineView == null) {
        return;
    }
    inlineView.release();

    ViewGroup parent = (ViewGroup) inlineView.getParent();
    if (parent != null) {
        parent.removeView(inlineView);
    }
    inlineView = null;
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-30-1" data-tab-group="tabgrp-30">

```Kotlin
override fun onRemove(data: InlineInAppMessageData) {
    inlineView?.release()
    (inlineView?.parent as? ViewGroup)?.removeView(inlineView)
    inlineView = null
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-30-2" data-tab-group="tabgrp-30">

```Swift
func snr_inlineInAppViewShouldBeRemoved(view: InlineInAppView, data: InlineInAppMessageData) {
    heightConstraint?.constant = 0
    view.removeFromSuperview()
    if view === self.inlineView {
        self.inlineView = nil
    }
}
```

</div>
</div>




# Flutter

## Installation and configuration (Flutter)

In this article you will find out how to install and initialize SDK in a Flutter mobile application. While performing the actions from this guide, keep the order presented in this article.


<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The [Settings](/developers/mobile-sdk/settings#pre-initialization-settings) article contains additional information about SDK behaviors you may need prior to configuration.

</div></div></div>



### Requirements

You need:
* Access to [workspace](/docs/settings/workspace)
* A Profile [API Key](/docs/settings/tool/api#adding-api-keys)  
  When creating the API key, use allowlisting or denylisting to only allow the events you intend to use.
* Flutter configured on your machine - [Getting Started](https://docs.flutter.dev)
* VS Code / Android Studio / Xcode

### Android{id=requirements-android}

For the **Android** platform it uses the [Synerise Android SDK](https://github.com/Synerise/android-sdk).

The development and debugging can be done with Android Studio.

* Recommended environment:
  - Minimum Android SDK version - 24
  - Supported targetSDKVersion - 34

### iOS {id=requirements-ios}

For the **iOS** platform it uses the [Synerise iOS SDK](https://github.com/Synerise/synerise-ios-sdk).

The development and debugging can be done with Xcode.

* Recommended environment:
  - Xcode 16
  - iOS SDK 18
* Target deployment:
  * iOS 13.0+ for SDK versions 2.0.0 and higher
  * iOS 9.0+ for SDK versions lower than 2.0.0

---

### Installation

#### CLI

```shell
 $ flutter pub add synerise_flutter_sdk
```

This will add a line similar to this to your package's `pubspec.yaml` and run an implicit `flutter pub get`:

```yaml
dependencies:
  synerise_flutter_sdk: ^0.7.4
```

Alternatively, your editor might support `flutter pub get`. Check the docs for your editor to learn more.

#### Path dependency

First you will need to add the Synerise Flutter SDK to your mobile application. To do that you can use the path dependency method in your `pubspec.yaml` as follows:

via ssh:
```yaml
synerise_flutter_sdk: 
    git:
      url: git@github.com:Synerise/synerise-flutter-sdk.git
``` 

or 

via https:

```yaml
synerise_flutter_sdk: 
    git:
      url: https://github.com/Synerise/synerise-flutter-sdk.git
``` 

After that you can run `flutter pub get` to resolve the new dependency.

---

#### Importing Synerise SDK

You will need to import **Synerise.dart** from the **synerise_flutter_sdk** plugin.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-608">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-608-0" data-tab-group="tabgrp-608" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-608-0" data-tab-group="tabgrp-608" data-tab-active="true">

```Dart
import 'package:synerise_flutter_sdk/synerise.dart';
```

</div>
</div>



### Android gradle & configuration

1. In the Android part of your application, add  
``maven { url 'https://pkgs.dev.azure.com/Synerise/AndroidSDK/_packaging/prod/maven/v1' }``   
to the `android/build.gradle`:

2. Make sure you included the following repositories:  
`` 
    google()
    mavenCentral()
``

The whole build.gradle snippet must look as follows:

```groovy
repositories {
    google()
    mavenCentral()
    maven { url 'https://pkgs.dev.azure.com/Synerise/AndroidSDK/_packaging/prod/maven/v1' }
}

``` 

then in your MainActivity file add:



<div class="content-tabs code-tabs" data-tab-group="tabgrp-609">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-609-0" data-tab-group="tabgrp-609" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-609-0" data-tab-group="tabgrp-609" data-tab-active="true">

```Dart
public class MainActivity extends FlutterActivity {
@Override    
public void configureFlutterEngine(@NonNull FlutterEngine flutterEngine) {
    super.configureFlutterEngine(flutterEngine);        
    SyneriseMethodChannel.configureChannel(flutterEngine);    
}}
```

</div>
</div>


### iOS configuration

In iOS portion of your application (/ios) you will need to run
`pod update`

### Initialization
---

#### Basic initialization

Initialize the Synerise SDK and provide the [Profile API Key](/docs/settings/tool/api).  
  

<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Initialize Synerise SDK in the application workflow as early as possible.

</div></div></div>



<div class="content-tabs code-tabs" data-tab-group="tabgrp-610">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-610-0" data-tab-group="tabgrp-610" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-610-0" data-tab-group="tabgrp-610" data-tab-active="true">

```Dart
Synerise.initializer()
  .withApiKey("YOUR_PROFILE_API_KEY")  // 1
  .setRequestValidationSalt("YOUR_REQUEST_VALIDATION_SALT")  // 2
  .withDebugModeEnabled(false)  // 3
  .withCrashHandlingEnabled(true)  // 4
  .setMessagingServiceType(MessagingServiceType.SERVICE_TYPE) // 5
  .init();
```

</div>
</div>


1. `.withApiKey('YOUR_PROFILE_API_KEY')` - Sets Profile API Key for Synerise SDK initialization.
2. `.withRequestValidationSalt('YOUR_REQUEST_VALIDATION_SALT')` - Sets salt string for request validation.
3. `.withDebugModeEnabled(false)` - Enables debug mode. See [Debug mode](/developers/mobile-sdk/installation-and-configuration/react-native#debug-mode) section for more information.
4. `.withCrashHandlingEnabled(true)` - Enables crash handling. Synerise SDK sends a crash event automatically when an uncaught exception occurs.
5. `.setMessagingServiceType(MessagingServiceType.SERVICE_TYPE)` - defines the messaging services your app uses:
  - `gms` for Google Mobile Services. This is the default option.
  - `hms` for Huawei Mobile Services. This can only be used on Huawei devices.
  

<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Secure sensitive keys (for example, `apiKey` and `requestValidationSalt`) with mechanisms like string obfuscation or encryption.

</div></div></div>


#### Initialization with custom API environment

You can change the base URL of the API for on-premise installations.  

Use the following initialization method:


<div class="content-tabs code-tabs" data-tab-group="tabgrp-611">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-611-0" data-tab-group="tabgrp-611" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-611-0" data-tab-group="tabgrp-611" data-tab-active="true">

```Dart
Synerise.initializer()
  .withApiKey('YOUR_PROFILE_API_KEY')
  .withBaseUrl("YOUR_API_BASE_URL")
  .init();
```

</div>
</div>



### Running example app

-  Open project folder in selected IDE
- `flutter pub get` in the terminal (dependencies pull)
- select the device/emulator in your IDE (for ios part it is required to run `pod update` in example/ios directory)
- `cd example` and  `flutter run`

### Debug mode
---

You can enable debug logs for Synerise SDK by using the `.withDebugModeEnabled(true)` method in `Synerise.initializer` when you initialize the SDK.


<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Do not use debug mode in a release version of your application.

</div></div></div>


You can receive logs about:
- **Core**: push notifications
- **Tracker**: declarative events, sending process
- **Client**: customer state, authorization
- **Injector**: campaigns
- **Content**: content widget, documents, recommendations

### Main Synerise listeners
---

#### Injector Listeners

You can specify your custom action when a customer clicks on simple push, banner or walkthrough. Synerise SDK implements two main actions that a customer may invoke - open URL and Deeplink:

- listener.onOpenUrl = (url) - This method is called when Synerise handles URL action from campaign activities.
- listener.onDeepLink = (deepLink) - This method is called when Synerise handles deeplink action from campaign activities.
Note: For more information about handling actions from the Synerise SDK, see the Campaigns section.


<div class="content-tabs code-tabs" data-tab-group="tabgrp-612">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-612-0" data-tab-group="tabgrp-612" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-612-0" data-tab-group="tabgrp-612" data-tab-active="true">

```Dart
Synerise.injector.listener((listener) {
  listener.onOpenUrl = (url) {
    ...
  };
  listener.onDeepLink = (deepLink) {
    ...
  };
});

### Notifications Listeners

When you want to deal with Push Notifications:

- listener.onRegistrationRequired - This method is called when Synerise needs registration for Push Notifications.

Synerise.notifications.listener((listener) {
  listener.onRegistrationRequired = () {
    FirebaseMessaging.instance.getToken().then((value) {
      if (value != null) {
        Synerise.notifications.registerForNotifications(value, true);
      }
    });
  };
});
```

</div>
</div>



# Events


### Event
<!-- reusable-table-boundary -->

Main event abstract class for inheriting classes.
  

<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This is an abstract class and it is not meant to be instantiated directly. You should use concrete subclasses instead.

</div></div></div>

  
**Declared In:**  
lib/model/tracker/event.dart  
  
**Declaration:**

<pre><code class="language-Dart">abstract class Event</code></pre>

  
**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **type** | String | no | Event type |
| **label** | String | no | Can't be empty. This value isn't saved in persistent storage and can't be used in Decision or Automation Hubs. It isn't shown on a Profile card. |
| **action** | String | no | Event action |
| **parameters** | bool | no | Event parameters |

<!-- reusable-table-boundary -->

---
---

### CustomEvent


<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

DO NOT send `transaction.charge` events as custom events.<br>
Transactions must be tracked with these endpoints:
- [`/v4/transactions`](https://hub.synerise.com/api-reference/data-management#tag/Events/operation/CreateATransaction) (single transaction)
- [`/v4/transactions/batch`](https://hub.synerise.com/api-reference/data-management#tag/Events/operation/BatchAddOrUpdateTransactions) (multiple transactions)

</div></div></div>

Represents a custom client event.
  
**Declared In:**  
lib/model/tracker/custom_event.dart  
  
**Inherits From:**  
[Event](/developers/mobile-sdk/class-reference/flutter/events#event)  
  
**Declaration:**

<pre><code class="language-Dart">class CustomEvent extends Event</code></pre>


**Initializers:**

<pre><code class="language-Dart">CustomEvent(String label, String action, Map&lt;String, Object&gt; parameters)</code></pre>

  
**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-160">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-160-0" data-tab-group="tabgrp-160" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-160-0" data-tab-group="tabgrp-160" data-tab-active="true">

```Dart
final paramMap = <String, String>{
  "firstKeyCustomParam": "TEST_1",
  "secondKeyCustomParam": "TEST_2",
};
CustomEvent event = CustomEvent("LABEL", "ACTION", paramMap);
```

</div>
</div>


---
---

### PushViewedEvent
Represents a 'client viewed push' event.
  
This event is used for push message interaction tracking.
  
**Declared In:**  
lib/events/push/push_viewed_event.dart   
  
**Inherits From:**  
 [Event](/developers/mobile-sdk/class-reference/flutter/events#event)   
 [CustomEvent](/developers/mobile-sdk/class-reference/flutter/events#customevent)    
  
**Declaration:**

<pre><code class="language-Dart">class PushViewedEvent extends CustomEvent</code></pre>

  
**Initializers:**

<pre><code class="language-Dart">PushViewedEvent(
    String label,
    Map&lt;String, Object&gt;? parameters,
  )</code></pre>


---
---

### PushClickedEvent
Represents a 'client clicked push' event.
  
This event is used for push message interaction tracking.
  
**Declared In:**  
lib/events/push/push_clicked_event.dart 
  
**Inherits From:**  
 [Event](/developers/mobile-sdk/class-reference/flutter/events#event)   
 [CustomEvent](/developers/mobile-sdk/class-reference/flutter/events#customevent)  
  
**Declaration:**

<pre><code class="language-Dart">class PushClickedEvent extends CustomEvent</code></pre>

  
**Initializers:**

<pre><code class="language-Dart">PushClickedEvent(
    String label,
    Map&lt;String, Object&gt;? parameters,
  )</code></pre>


---
---

### PushCancelledEvent
Represents a 'client dismissed push' event.
  
This event is used for push message interaction tracking.
  
**Declared In:**  
lib/events/push/push_cancelled_event.dart
  
**Inherits From:**  
 [Event](/developers/mobile-sdk/class-reference/flutter/events#event)   
 [CustomEvent](/developers/mobile-sdk/class-reference/flutter/events#customevent)   
  
**Declaration:**

<pre><code class="language-Dart">class PushCancelledEvent extends CustomEvent</code></pre>

  
**Initializers:**

<pre><code class="language-Dart">PushCancelledEvent(
    String label,
    Map&lt;String, Object&gt;? parameters,
  )</code></pre>


---
---

### CartEvent
Main cart action abstract class for inheriting classes.
  

<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This is an abstract class and it is not meant to be instantiated directly. You should use concrete `CartEvent` subclasses instead.

</div></div></div>

  
**Declared In:**  
lib/events/cart/cart_event.dart 
  
**Inherits From:**
 [Event](/developers/mobile-sdk/class-reference/flutter/events#event)   
 [CustomEvent](/developers/mobile-sdk/class-reference/flutter/events#customevent)  
  
**Declaration:**

<pre><code class="language-Dart">class CartEvent extends CustomEvent</code></pre>

  
**Initializers:**  

<pre><code class="language-Dart">CartEvent(String label, String action, String sku, UnitPrice finalPrice, int quantity, Map&lt;String, Object&gt;? parameters)</code></pre>

  
**Methods:**

This method sets a value for the `name` parameter.

<pre><code class="language-Dart">void setName(String name)</code></pre>


---

This method sets a value for the `category` parameter.

<pre><code class="language-Dart">void setCategory(String category)</code></pre>


---

This method sets values for the `categories` parameter.

<pre><code class="language-Dart">void setCategories(List&lt;String&gt; categories)</code></pre>


---

This method sets a value for the `offline` parameter.

<pre><code class="language-Dart">void setOffline(bool offline)</code></pre>


---

This method sets the value of the `regularPrice` parameter.

<pre><code class="language-Dart">void setRegularPrice(UnitPrice regularPrice)</code></pre>


---

This method sets the value of the `discountedPrice` parameter.

<pre><code class="language-Dart">void setDiscountedPrice(UnitPrice discountedPrice)</code></pre>


---

This method sets the value of the `url` parameter.

<pre><code class="language-Dart">void setUrl(String url)</code></pre>


---

This method sets the value of the `producer` parameter (producer can signify a brand of the item).

<pre><code class="language-Dart">void setProducer(String producer)</code></pre>


---
---

### UnitPrice
**Declared In:**  
lib/model/tracker/unit_price.dart

**Declaration:**

<pre><code class="language-Dart">class UnitPrice</code></pre>

  
**Initializers:**

<pre><code class="language-Dart">UnitPrice(
   int amount,
   String currency)</code></pre>


---
---

### ProductAddedToCartEvent
Represents a 'client added product to cart' event.
  
**Declared In:**  
lib/events/cart/product_added_to_cart_event.dart
  
**Inherits From:**  
 [Event](/developers/mobile-sdk/class-reference/flutter/events#event)   
 [CustomEvent](/developers/mobile-sdk/class-reference/flutter/events#customevent)  
  
**Declaration:**

<pre><code class="language-Dart">class ProductAddedToCartEvent extends CartEvent</code></pre>

  
**Initializers:**

<pre><code class="language-Dart">ProductAddedToCartEvent(String label, String sku, UnitPrice finalPrice, int quantity, Map&lt;String, Object&gt;? parameters)</code></pre>


---
---

### ProductRemovedFromCartEvent
Represents a 'client removed product from cart' event.
  
**Declared In:**  
lib/events/cart/product_removed_from_cart_event.dart
  
**Inherits From:**  
 [Event](/developers/mobile-sdk/class-reference/flutter/events#event)   
 [CustomEvent](/developers/mobile-sdk/class-reference/flutter/events#customevent)  
  
**Declaration:**

<pre><code class="language-Dart">class ProductRemovedFromCartEvent extends CartEvent</code></pre>

  
**Initializers:**

<pre><code class="language-Dart">ProductRemovedFromCartEvent(String label, String sku, UnitPrice finalPrice, int quantity, Map&lt;String, Object&gt;? parameters)</code></pre>


---
---

### ProductViewedEvent
Represents a 'client viewed product' event.
  
**Declared In:**  
lib/events/product/product_viewed_event.dart  

**Inherits From:**  
 [Event](/developers/mobile-sdk/class-reference/flutter/events#event)   
 [CustomEvent](/developers/mobile-sdk/class-reference/flutter/events#customevent)  
  
**Declaration:**  

<pre><code class="language-Dart">class ProductViewedEvent extends CustomEvent</code></pre>

  
**Initializers:**

<pre><code class="language-Dart">ProductViewedEvent(
    String label,
    String productId,
    String name,
    Map&lt;String, Object&gt;? parameters,
  )</code></pre>

  
**Methods:**

This method sets a value for the `category` parameter.

<pre><code class="language-Dart">void setCategory(String category)</code></pre>


---

This method sets the value of the `url` parameter.

<pre><code class="language-Dart">void setUrl(String url)</code></pre>


---
---

### ProductAddedToFavoritesEvent
Represents a 'client added product to favorites' event.
  
**Declared In:**  
lib/events/product/product_added_to_favorites_event.dart
  
**Inherits From:**  
 [Event](/developers/mobile-sdk/class-reference/flutter/events#event)   
 [CustomEvent](/developers/mobile-sdk/class-reference/flutter/events#customevent)  
  
**Declaration:**

<pre><code class="language-Dart">class ProductAddedToFavouritesEvent extends CustomEvent</code></pre>

  
**Initializers:**

<pre><code class="language-Dart">ProductAddedToFavoritesEvent(
    String label,
    Map&lt;String, Object&gt;? parameters,
  )</code></pre>


---
---

### LoggedInEvent
Represents a 'client logged in' event.
  
**Declared In:**  
lib/events/auth/logged_in_event.dart  
  
**Inherits From:**  
 [Event](/developers/mobile-sdk/class-reference/flutter/events#event)   
 [CustomEvent](/developers/mobile-sdk/class-reference/flutter/events#customevent)  
  
**Declaration:**

<pre><code class="language-Dart">class LoggedInEvent extends CustomEvent</code></pre>



**Initializers:**

<pre><code class="language-Dart">LoggedInEvent(
    String label,
    Map&lt;String, Object&gt;? parameters,
  )</code></pre>


---
---

### LoggedOutEvent
Represents a 'client logged out' event.
  
**Declared In:**  
lib/events/auth/logged_out_event.dart 
  
**Inherits From:**  
 [Event](/developers/mobile-sdk/class-reference/flutter/events#event)   
 [CustomEvent](/developers/mobile-sdk/class-reference/flutter/events#customevent)  
  
**Declaration:**

<pre><code class="language-Dart">class LoggedOutEvent extends CustomEvent</code></pre>


**Initializers:**

<pre><code class="language-Dart">LoggedOutEvent(String label, Map&lt;String, Object&gt;? parameters)</code></pre>


---
---

### RegisteredEvent
Represents a 'client registered' event.
  
**Declared In:**  
lib/events/auth/registered_event.dart  
  
**Inherits From:**  
 [Event](/developers/mobile-sdk/class-reference/flutter/events#event)   
 [CustomEvent](/developers/mobile-sdk/class-reference/flutter/events#customevent)  
  
**Declaration:**  

<pre><code class="language-Dart">class RegisteredEvent extends CustomEvent</code></pre>

  
**Initializers:**

<pre><code class="language-Dart">RegisteredEvent(String label, Map&lt;String, Object&gt;? parameters)</code></pre>


---
---

### RecommendationEvent
Main recommendation abstract class for inheriting classes.
  

<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This is an abstract class and it is not meant to be instantiated directly. You should use concrete `RecommendationEvent` subclasses instead.

</div></div></div>

  
**Declared In:**  
lib/events/recommendation/recommendation_event.dart    
  
**Inherits From:**  
 [Event](/developers/mobile-sdk/class-reference/flutter/events#event)   
 [CustomEvent](/developers/mobile-sdk/class-reference/flutter/events#customevent)    
  
**Declaration:**  

<pre><code class="language-Dart">class RecommendationEvent extends CustomEvent</code></pre>

  
**Initializers:**

<pre><code class="language-Dart">RecommendationEvent(String label, String action, Map&lt;String, Object&gt;? parameters)</code></pre>


---
---

### RecommendationSeenEvent
Represents a 'client saw a recommendation' event.
  
**Declared In:**  
lib/events/recommendation/recommendation_seen_event.dart  
  
**Inherits From:**  
 [Event](/developers/mobile-sdk/class-reference/flutter/events#event)   
 [CustomEvent](/developers/mobile-sdk/class-reference/flutter/events#customevent)  
  
**Declaration:**  

<pre><code class="language-Dart">class RecommendationSeenEvent extends RecommendationEvent</code></pre>

  
**Initializers:**  

<pre><code class="language-Dart">RecommendationSeenEvent(String label, String action, String productId, String productName, String campaignId, String campaignHash, Map&lt;String, Object&gt;? parameters)</code></pre>


---
---

### RecommendationViewEvent
Represents a 'client viewed a recommendation' event.

**Declared In:**  
lib/events/recommendation/recommendation_view_event.dart

**Inherits From:**  
 [Event](/developers/mobile-sdk/class-reference/flutter/events#event)   
 [CustomEvent](/developers/mobile-sdk/class-reference/flutter/events#customevent)  

**Declaration:**  

<pre><code class="language-Dart">class RecommendationViewEvent extends RecommendationEvent</code></pre>


**Initializers:**  

<pre><code class="language-Dart">RecommendationViewEvent(String label, String action, List&lt;String&gt;? items, String campaignId, String campaignHash, String correlationId, Map&lt;String, Object&gt;? parameters)</code></pre>


---
---

### RecommendationClickEvent
Represents a 'client clicked a recommendation' event.
  
**Declared In:**  
lib/events/recommendation/recommendation_click_event.dart
  
**Inherits From:**  
 [Event](/developers/mobile-sdk/class-reference/flutter/events#event)   
 [CustomEvent](/developers/mobile-sdk/class-reference/flutter/events#customevent)  
 [RecommendationEvent](/developers/mobile-sdk/class-reference/flutter/events#recommendationevent)  
  
**Declaration:**

<pre><code class="language-Dart">class RecommendationClickEvent extends RecommendationEvent</code></pre>

  
**Initializers:**

<pre><code class="language-Dart">RecommendationClickEvent(String label, String action, String productId, String productName, String campaignId, String campaignHash,
      Map&lt;String, Object&gt;? parameters)</code></pre>


---
---

### VisitedScreenEvent
Represents a 'client visited screen' event.
  
This can be used for mobile screen usage tracking.
  
**Declared In:**  
lib/events/other/visited_screen_event.dart

**Inherits From:**  
 [Event](/developers/mobile-sdk/class-reference/flutter/events#event)   
 [CustomEvent](/developers/mobile-sdk/class-reference/flutter/events#customevent)  
  
**Declaration:**

<pre><code class="language-Dart">class VisitedScreenEvent extends CustomEvent</code></pre>

  
**Initializers:**

<pre><code class="language-Dart">VisitedScreenEvent(
    String label,
    Map&lt;String, Object&gt;? parameters,
  )</code></pre>


---
---

### HitTimerEvent
Represents a 'client hit timer' event.
  
This could be used for profiling or activity time monitoring - you can send a `HitTimerEvent` when your client starts doing something and send it once again when they finish, but this time with the different time signature. Then you can use our analytics engine to measure, for example, average activity time.
  
**Declared In:**  
lib/events/other/hit_timer_event.dart
  
**Inherits From:**  
 [Event](/developers/mobile-sdk/class-reference/flutter/events#event)   
 [CustomEvent](/developers/mobile-sdk/class-reference/flutter/events#customevent)  

**Declaration:**

<pre><code class="language-Dart">class HitTimerEvent extends CustomEvent</code></pre>

  
**Initializers:**

<pre><code class="language-Dart">HitTimerEvent(
    String label,
    Map&lt;String, Object&gt;? parameters,
  )</code></pre>


---
---

### SearchedEvent
Represents a 'client searched' event.
  
**Declared In:**  
lib/events/other/searched_event.dart  
  
**Inherits From:**  
 [Event](/developers/mobile-sdk/class-reference/flutter/events#event)   
 [CustomEvent](/developers/mobile-sdk/class-reference/flutter/events#customevent)  
  
**Declaration:**

<pre><code class="language-Dart">class SearchedEvent extends CustomEvent</code></pre>

  
**Initializers:**

<pre><code class="language-Dart">SearchedEvent(
    String label,
    Map&lt;String, Object&gt;? parameters,
  )</code></pre>


---
---

### SharedEvent
Represents a 'client shared' event.
  
**Declared In:**  
lib/events/other/shared_event.dart  
  
**Inherits From:**  
 [Event](/developers/mobile-sdk/class-reference/flutter/events#event)   
 [CustomEvent](/developers/mobile-sdk/class-reference/flutter/events#customevent)  
  
**Declaration:**

<pre><code class="language-Dart">class SharedEvent extends CustomEvent</code></pre>

  
**Initializers:**

<pre><code class="language-Dart">SharedEvent(
    String label,
    Map&lt;String, Object&gt;? parameters,
  )</code></pre>


---
---

### AppearedInLocationEvent
Represents a 'client appeared in location' event.
  
**Declared In:**  
lib/events/other/appeared_in_location_event.dart
  
**Inherits From:**
[Event](/developers/mobile-sdk/class-reference/flutter/events#event)  
[CustomEvent](/developers/mobile-sdk/class-reference/flutter/events#customevent)  
  
**Declaration:**

<pre><code class="language-Dart">class AppearedInLocationEvent extends CustomEvent</code></pre>

  
**Initializers:**

<pre><code class="language-Dart">AppearedInLocationEvent(
    String label,
    double lat,
    double lon,
    Map&lt;String, Object&gt;? parameters,
  )</code></pre>



# Flutter

## Method reference - Flutter






















# Flutter

## Class reference - Flutter




# Configuring push notifications


In this section, you will learn how to implement push notifications in your mobile application.


# Customer account management


## Get customer account information
---
This method gets a customer’s account information.
  
This method requires customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `API_PERSONAL_INFORMATION_CLIENT_READ` permission from the **Client** group.

</div></div></div>

**Method name:**  
Client.getAccount()
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-797">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-797-0" data-tab-group="tabgrp-797" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-797-1" data-tab-group="tabgrp-797">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-797-0" data-tab-group="tabgrp-797" data-tab-active="true">

```Java
public static IDataApiCall<GetAccountInformation> getAccount()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-797-1" data-tab-group="tabgrp-797">

```Kotlin
fun getAccount():IDataApiCall<GetAccountInformation>
```

</div>
</div>


**Parameters:**  
No parameters required.

**Return Value:**  
[IDataApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#idataapicall)<[GetAccountInformation](/developers/mobile-sdk/class-reference/android/client#getaccountinformation)> object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-798">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-798-0" data-tab-group="tabgrp-798" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-798-1" data-tab-group="tabgrp-798">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-798-0" data-tab-group="tabgrp-798" data-tab-active="true">

```Java
private IDataApiCall<GetAccountInformation> getAccountCall;
private void getAccount(boolean isFacebook) {
        if (getAccountCall != null) getAccountCall.cancel();
        getAccountCall = Client.getAccount();
        getAccountCall.execute(({ this.onGetAccountSuccessful() }), ({ this.onGetAccountFailure() });
    }
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-798-1" data-tab-group="tabgrp-798">

```Kotlin
private val getAccountCall:IDataApiCall<GetAccountInformation>
private fun getAccount(isFacebook:Boolean) {
  if (getAccountCall != null) getAccountCall.cancel()
  getAccountCall = Client.getAccount()
  getAccountCall.execute(({ this.onGetAccountSuccessful() }), ({ this.onGetAccountFailure() })
}
```

</div>
</div>


## Get customer's events
---
This method retrieves events for an authenticated customer.
  
This method requires customer authentication.
<!-- reusable-table-boundary -->

**Method name:**  
Client.getEvents(clientEventsQuery)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-799">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-799-0" data-tab-group="tabgrp-799" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-799-1" data-tab-group="tabgrp-799">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-799-0" data-tab-group="tabgrp-799" data-tab-active="true">

```Java
public static IDataApiCall<List<ClientEventData>> getEvents(ClientEventsQuery clientEventsQuery)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-799-1" data-tab-group="tabgrp-799">

```Kotlin
fun getEvents(clientEventsQuery:ClientEventsQuery):IDataApiCall<List<ClientEventData>>
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **clientEventsQuery** | ClientEventsQuery | yes | - | Object to create clientEvent query |

**Return Value:**  
[IDataApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#idataapicall)<List<[ClientEventData](/developers/mobile-sdk/class-reference/android/client#clienteventdata)>> object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-800">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-800-0" data-tab-group="tabgrp-800" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-800-1" data-tab-group="tabgrp-800">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-800-0" data-tab-group="tabgrp-800" data-tab-active="true">

```Java
private IDataApiCall<List<ClientEventData>> getEventClientsCall;
    if (getEventClientsCall != null) getEventClientsCall.cancel();
    getEventClientsCall = Client.getEvents(clientEventsQuery);
    getEventClientsCall.execute(({ this.onSuccess() }), ({ this.onFailure() });
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-800-1" data-tab-group="tabgrp-800">

```Kotlin
private val getEventClientsCall:IDataApiCall<List<ClientEventData>>
  if (getEventClientsCall != null) getEventClientsCall.cancel()
  getEventClientsCall = Client.getEvents(clientEventsQuery)
  getEventClientsCall.execute(({ this.onSuccess() }), ({ this.onFailure() })
```

</div>
</div>


<!-- reusable-table-boundary -->

## Update customer account basic information
---
<!-- reusable-table-boundary -->

This method updates a customer’s account’s basic information (without identification data: uuid, customId, email).
  
This method requires the context object with the customer’s account information. Omitted fields are not modified.
  
This method does not require customer authentication and can be used by anonymous profiles.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.22.0 | 5.21.0 | 0.24.0 | 1.4.0 |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `API_BASIC_INFORMATION_CLIENT_UPDATE` permission from the **Client** group.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Method name:**  
Client.updateAccountBasicInformation(accountInformation)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-801">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-801-0" data-tab-group="tabgrp-801" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-801-1" data-tab-group="tabgrp-801">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-801-0" data-tab-group="tabgrp-801" data-tab-active="true">

```Java
public static IApiCall updateAccountBasicInformation(@NonNull UpdateAccountBasicInformation accountInformation)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-801-1" data-tab-group="tabgrp-801">

```Kotlin
fun updateAccountBasicInformation(@NonNull accountInformation:UpdateAccountBasicInformation):IApiCall
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **accountInformation** | [UpdateAccountBasicInformation](/developers/mobile-sdk/class-reference/android/client#updateaccountbasicinformation) | yes | - | Builder Pattern object with the Customer's basic account information |

**Return Value:**  
[IApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#iapicall) object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-802">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-802-0" data-tab-group="tabgrp-802" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-802-1" data-tab-group="tabgrp-802">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-802-0" data-tab-group="tabgrp-802" data-tab-active="true">

```Java
if (apiCall != null) apiCall.cancel();
            apiCall = Client.updateAccountBasicInformation(accountInformation);
            apiCall.execute(this::onSuccess, this::onFailure);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-802-1" data-tab-group="tabgrp-802">

```Kotlin
if (apiCall != null) apiCall.cancel()
apiCall = Client.updateAccountBasicInformation(accountInformation)
apiCall.execute(({ this.onSuccess() }), ({ this.onFailure() }))
```

</div>
</div>


<!-- reusable-table-boundary -->

## Update customer account information
---
This method updates a customer’s account information.
  
This method requires the context object with the customer’s account information. Omitted fields are not modified.
  
This method requires customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `API_PERSONAL_INFORMATION_CLIENT_UPDATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Method name:**  
Client.updateAccount(accountInformation)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-803">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-803-0" data-tab-group="tabgrp-803" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-803-1" data-tab-group="tabgrp-803">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-803-0" data-tab-group="tabgrp-803" data-tab-active="true">

```Java
public static IApiCall updateAccount(@NonNull UpdateAccountInformation accountInformation)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-803-1" data-tab-group="tabgrp-803">

```Kotlin
fun updateAccount(@NonNull accountInformation:UpdateAccountInformation):IApiCall
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **accountInformation** | [UpdateAccountInformation](/developers/mobile-sdk/class-reference/android/client#updateaccountinformation)  | yes | - | Builder Pattern object with the Customer's account information |

**Return Value:**  
[IApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#iapicall) object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-804">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-804-0" data-tab-group="tabgrp-804" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-804-1" data-tab-group="tabgrp-804">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-804-0" data-tab-group="tabgrp-804" data-tab-active="true">

```Java
if (apiCall != null) apiCall.cancel();
            apiCall = Client.updateAccount(accountInformation);
            apiCall.execute(this::onSuccess, this::onFailure);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-804-1" data-tab-group="tabgrp-804">

```Kotlin
if (apiCall != null) apiCall.cancel()
apiCall = Client.updateAccount(accountInformation)
apiCall.execute(({ this.onSuccess() }), ({ this.onFailure() }))
```

</div>
</div>


<!-- reusable-table-boundary -->

## Change customer's account password
---
This method changes a customer’s password.
  
This method requires customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 403 status code if the provided old password is invalid.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CHANGE_PASSWORD_CLIENT_UPDATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Method name:**  
Client.changePassword(oldPassword, password)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-805">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-805-0" data-tab-group="tabgrp-805" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-805-1" data-tab-group="tabgrp-805">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-805-0" data-tab-group="tabgrp-805" data-tab-active="true">

```java
public static IApiCall changePassword(@NonNull String oldPassword, @NonNull String password)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-805-1" data-tab-group="tabgrp-805">

```kotlin
fun changePassword(@NonNull oldPassword:String, @NonNull password:String):IApiCall
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **oldPassword** | String | yes | - | Client's old password |
| **password** | String | yes | --- | Client's new password |

**Return Value:**  
[IApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#iapicall) object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-806">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-806-0" data-tab-group="tabgrp-806" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-806-1" data-tab-group="tabgrp-806">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-806-0" data-tab-group="tabgrp-806" data-tab-active="true">

```java
private IApiCall apiCall;
if (apiCall != null) apiCall.cancel();
            apiCall = Client.changePassword(oldPassword, password);
            apiCall.execute(this::onSuccess, this::onFailure);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-806-1" data-tab-group="tabgrp-806">

```kotlin
val apiCall:IApiCall
if (apiCall != null) apiCall.cancel()
apiCall = Client.changePassword(oldPassword, password)
apiCall.execute(({ this.onSuccess() }), ({ this.onFailure() }))
```

</div>
</div>


<!-- reusable-table-boundary -->

## Request password reset for customer account
---
This method requests a customer’s password reset with email. The customer will receive a token to the provided email address. That token is then used for the confirmation of password reset.
  
This method requires the customer’s email.
  
This method is a global operation and doesn't require customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_PASSWORD_RESET_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Method name:**  
Client.requestPasswordReset(resetRequest)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-807">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-807-0" data-tab-group="tabgrp-807" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-807-1" data-tab-group="tabgrp-807">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-807-0" data-tab-group="tabgrp-807" data-tab-active="true">

```Java
public static IApiCall requestPasswordReset(@NonNull PasswordResetRequest resetRequest)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-807-1" data-tab-group="tabgrp-807">

```Kotlin
fun requestPasswordReset(@NonNull resetRequest:PasswordResetRequest):IApiCall
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **resetRequest** | PasswordResetRequest | yes | - | PasswordResetRequest object with the Client's email. |


**Return Value:**  
[IApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#iapicall) object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-808">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-808-0" data-tab-group="tabgrp-808" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-808-1" data-tab-group="tabgrp-808">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-808-0" data-tab-group="tabgrp-808" data-tab-active="true">

```Java
if (call != null) call.cancel();
        call = Client.requestPasswordReset(new PasswordResetRequest(email));
        EspressoTestingIdlingResource.increment();
        call.execute(this::onSuccess, this::onFailure);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-808-1" data-tab-group="tabgrp-808">

```Kotlin
if (call != null) call.cancel()
call = Client.requestPasswordReset(PasswordResetRequest(email))
call.execute(({ this.onSuccess() }), ({ this.onFailure() }))
```

</div>
</div>


<!-- reusable-table-boundary -->

## Confirm password reset for customer account
---
This method confirm a customer’s password reset with the new password and token provided by password reset request.  
  
This method requires the customer’s new password and the confirmation token received by e-mail.
  
This method is a global operation and doesn't require customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_PASSWORD_RESET_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Method name:**  
Client.confirmPasswordReset(resetConfirmation)
  
**Declaration:**  


<div class="content-tabs code-tabs" data-tab-group="tabgrp-809">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-809-0" data-tab-group="tabgrp-809" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-809-1" data-tab-group="tabgrp-809">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-809-0" data-tab-group="tabgrp-809" data-tab-active="true">

```java
public static IApiCall confirmPasswordReset(@NonNull PasswordResetConfirmation resetConfirmation)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-809-1" data-tab-group="tabgrp-809">

```kotlin
fun confirmPasswordReset(@NonNull resetConfirmation:PasswordResetConfirmation):IApiCall
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **resetConfirmation** | PasswordResetConfirmation | yes | - | PasswordResetConfirmation object with the Client's new password and confirmation token. |

**Return Value:**  
[IApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#iapicall) object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-810">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-810-0" data-tab-group="tabgrp-810" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-810-1" data-tab-group="tabgrp-810">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-810-0" data-tab-group="tabgrp-810" data-tab-active="true">

```Java
private IApiCall call;
if (call != null) call.cancel();
            call = Client.confirmPasswordReset(confirmation);
            call.execute(this::onSuccess, this::onFailure);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-810-1" data-tab-group="tabgrp-810">

```Kotlin
val call:IApiCall
if (call != null) call.cancel()
call = Client.confirmPasswordReset(confirmation)
call.execute(({ this.onSuccess() }), ({ this.onFailure() }))
```

</div>
</div>


<!-- reusable-table-boundary -->

## Request email change for customer account
---
This method requests a customer's email change.
  
This method is a global operation and doesn't require customer authentication.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 403 status code if the provided token or the password is invalid.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CHANGE_EMAIL_CLIENT_UPDATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Method name:**  
Client.requestEmailChange(email, password, externalToken, authId)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-811">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-811-0" data-tab-group="tabgrp-811" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-811-1" data-tab-group="tabgrp-811">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-811-0" data-tab-group="tabgrp-811" data-tab-active="true">

```Java
public static IApiCall requestEmailChange(String email, String password, @Nullable String externalToken, @Nullable String authId)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-811-1" data-tab-group="tabgrp-811">

```Kotlin
fun requestEmailChange(email:String, password:String, @Nullable externalToken:String, @Nullable authId: String):IApiCall
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | String | yes | - | Customer's email |
| **password** | String | yes | -| Customer's password |
| **externalToken** | String | no | - | ExternalToken should be used for Facebook, Oauth. For Synerise account, pass null |
| **authId** | String | no | - | Optional identifier of authorization. For Synerise account, pass null. |

**Return Value:**  
[IApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#iapicall) object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-812">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-812-0" data-tab-group="tabgrp-812" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-812-1" data-tab-group="tabgrp-812">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-812-0" data-tab-group="tabgrp-812" data-tab-active="true">

```Java
IApiCall apiCall;
apiCall = Client.requestEmailChange(email, password, null, null);
            apiCall.execute(this::onSuccess, this::onFailure);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-812-1" data-tab-group="tabgrp-812">

```Kotlin
val apiCall:IApiCall
apiCall = Client.requestEmailChange(email, password, null, null)
apiCall.execute(({ this.onSuccess() }), ({ this.onFailure() }))
```

</div>
</div>


<!-- reusable-table-boundary -->

## Confirm email change for customer account
---
This method confirms an email change.
  
This method is a global operation and doesn't require customer authentication.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 403 status code if the provided token is invalid.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CHANGE_EMAIL_CLIENT_UPDATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Method name:**  
Client.confirmEmailChange(token, newsletterAgreement)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-813">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-813-0" data-tab-group="tabgrp-813" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-813-1" data-tab-group="tabgrp-813">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-813-0" data-tab-group="tabgrp-813" data-tab-active="true">

```java
public static IApiCall confirmEmailChange(String token, boolean newsletterAgreement)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-813-1" data-tab-group="tabgrp-813">

```kotlin
fun confirmEmailChange(token:String, newsletterAgreement:Boolean):IApiCall
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **token** | String | yes | - | Token from customer's email |
| **newsletterAgreement** | boolean | yes | - | Newsletter agreement |

**Return Value:**  
[IApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#iapicall) object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-814">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-814-0" data-tab-group="tabgrp-814" data-tab-active="true">java</button><button class="tab-button" data-tab-id="tabgrp-814-1" data-tab-group="tabgrp-814">kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-814-0" data-tab-group="tabgrp-814" data-tab-active="true">

```java
IApiCall apiCall;
apiCall = Client.confirmEmailChange(token, newsletterAgreement.isChecked());
            apiCall.execute(this::onSuccess, this::onFailure);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-814-1" data-tab-group="tabgrp-814">

```kotlin
val apiCall:IApiCall
apiCall = Client.confirmEmailChange(token, newsletterAgreement.isChecked())
apiCall.execute(({ this.onSuccess() }), ({ this.onFailure() }))
```

</div>
</div>


<!-- reusable-table-boundary -->

## Request phone update on customer account
---
This method requests a customer's phone update. A confirmation code is sent to the phone number.
  
This method is a global operation and doesn't require customer authentication.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `API_PERSONAL_PHONE_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Method name:**  
Client.requestPhoneUpdate(phone)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-815">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-815-0" data-tab-group="tabgrp-815" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-815-1" data-tab-group="tabgrp-815">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-815-0" data-tab-group="tabgrp-815" data-tab-active="true">

```Java
public static IApiCall requestPhoneUpdate(String phone)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-815-1" data-tab-group="tabgrp-815">

```Kotlin
fun requestPhoneUpdate(phone:String):IApiCall
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **phone** | String | yes | - | Customer's phone number. |

**Return Value:**  
[IApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#iapicall) object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-816">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-816-0" data-tab-group="tabgrp-816" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-816-1" data-tab-group="tabgrp-816">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-816-0" data-tab-group="tabgrp-816" data-tab-active="true">

```Java
IApiCall apiCall;
apiCall = Client.requestPhoneUpdate(phone);
        apiCall.execute(this::onSuccess, this::onFailure);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-816-1" data-tab-group="tabgrp-816">

```Kotlin
val apiCall:IApiCall
apiCall = Client.requestPhoneUpdate(phone)
apiCall.execute(({ this.onSuccess() }), ({ this.onFailure() }))
```

</div>
</div>


<!-- reusable-table-boundary -->

## Confirm phone update on customer account
---
This method confirms a phone number update. This action requires the new phone number and confirmation code as parameters.
  
This method is a global operation and doesn't require customer authentication.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 403 status code if the provided UUID does not exist or the password is invalid.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `API_PERSONAL_PHONE_CLIENT_CREATE` permission from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Method name:**  
Client.confirmPhoneUpdate(phone, confirmationCode, smsAgreement)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-817">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-817-0" data-tab-group="tabgrp-817" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-817-1" data-tab-group="tabgrp-817">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-817-0" data-tab-group="tabgrp-817" data-tab-active="true">

```Java
public static IApiCall confirmPhoneUpdate(String phone, String confirmationCode, @Nullable Boolean smsAgreement)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-817-1" data-tab-group="tabgrp-817">

```Kotlin
fun confirmPhoneUpdate(phone:String, confirmationCode:String, @Nullable smsAgreement:Boolean):IApiCall
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **phone** | String | yes | - | Phone number that will be confirmed |
| **confirmationCode** | String | yes | - | Code received in SMS |
| **smsAgreement** | Boolean | no | - | Optional SMS marketing agreement |

**Return Value:**  
[IApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#iapicall) object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-818">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-818-0" data-tab-group="tabgrp-818" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-818-1" data-tab-group="tabgrp-818">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-818-0" data-tab-group="tabgrp-818" data-tab-active="true">

```Java
IApiCall apiCall;
apiCall = Client.confirmPhoneUpdate(phone, code, enableAgreement.isChecked() ? null : smsAgreement.isChecked());
            apiCall.execute(this::onSuccess, this::onFailure);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-818-1" data-tab-group="tabgrp-818">

```Kotlin
val apiCall:IApiCall
apiCall = Client.confirmPhoneUpdate(phone, code, if (enableAgreement.isChecked()) null else smsAgreement.isChecked())
apiCall.execute(({ this.onSuccess() }), ({ this.onFailure() }))
```

</div>
</div>


<!-- reusable-table-boundary -->

## Delete customer account by Identity Provider
---
This method deletes a customer's account.
  
This method requires customer authentication.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

HTTP 403 status code is returned if the provided password or token is invalid.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CLIENT_DELETE`, `SAUTH_OAUTH_CLIENT_DELETE`, `SAUTH_FACEBOOK_CLIENT_DELETE`, `SAUTH_APPLE_CLIENT_DELETE` permissions from the **Client** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Method name:**  
Client.deleteAccount(clientAuthFactor, clientIdentityProvider, authId)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-819">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-819-0" data-tab-group="tabgrp-819" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-819-1" data-tab-group="tabgrp-819">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-819-0" data-tab-group="tabgrp-819" data-tab-active="true">

```Java
public static IApiCall deleteAccount(String clientAuthFactor, ClientIdentityProvider clientIdentityProvider, @Nullable String authId)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-819-1" data-tab-group="tabgrp-819">

```Kotlin
fun deleteAccount(clientAuthFactor:String, clientIdentityProvider:ClientIdentityProvider, authId:String):IApiCall
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **clientAuthFactor** | String | yes | - | In case of oauth, fb, or google this is token. If you have synerise account this is password. |
| **clientIdentityProvider** | [ClientIdentityProvider](/developers/mobile-sdk/class-reference/android/client#clientidentityprovider) | yes | - | Provider of your account. Example:  FACEBOOK, OAUTH, SYNERISE, GOOGLE |
| **authId** | String | no | - | Customer's optional unique identifier |

**Return Value:**  
[IApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#iapicall) object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-820">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-820-0" data-tab-group="tabgrp-820" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-820-1" data-tab-group="tabgrp-820">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-820-0" data-tab-group="tabgrp-820" data-tab-active="true">

```Java
IApiCall deleteCall = Client.deleteAccount(password, ClientIdentityProvider.SYNERISE, null);
            deleteCall.execute(this::onSuccess, this::onFailure);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-820-1" data-tab-group="tabgrp-820">

```Kotlin
val deleteCall = Client.deleteAccount(password, ClientIdentityProvider.SYNERISE, null)
deleteCall.execute(({ this.onSuccess() }), ({ this.onFailure() }))
```

</div>
</div>


<!-- reusable-table-boundary -->

## Removed methods

### <del>Delete customer account</del> {#delete-customer-account}
---
<!-- reusable-table-boundary -->

This method deletes a customer's account.
  
This method requires customer authentication.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.6.11 | 3.6.13 | 0.9.12 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.6.19 | 3.6.19 | 0.14.0 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | n/a | n/a |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns the HTTP 403 status code is returned if the provided password is invalid.

</div></div></div>



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CLIENT_DELETE` permission from the **Client** group.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Replaced By:**  
[Delete customer account by Identity Provider](/developers/mobile-sdk/method-reference/android/client-account#delete-customer-account-by-identity-provider)
  
**Method name:**  
Client.deleteAccount(password)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-821">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-821-0" data-tab-group="tabgrp-821" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-821-1" data-tab-group="tabgrp-821">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-821-0" data-tab-group="tabgrp-821" data-tab-active="true">

```Java
public static IApiCall deleteAccount(String password)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-821-1" data-tab-group="tabgrp-821">

```Kotlin
fun deleteAccount(password:String):IApiCall
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **password** | String | yes | - | Customer's current password. |


**Return Value:**  
[IApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#iapicall) object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-822">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-822-0" data-tab-group="tabgrp-822" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-822-1" data-tab-group="tabgrp-822">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-822-0" data-tab-group="tabgrp-822" data-tab-active="true">

```Java
IApiCall deleteCall = Client.deleteAccount(password);
            deleteCall.execute(this::onSuccess, this::onFailure);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-822-1" data-tab-group="tabgrp-822">

```Kotlin
val deleteCall = Client.deleteAccount(password)
deleteCall.execute(({ this.onSuccess() }), ({ this.onFailure() }))
```

</div>
</div>


<!-- reusable-table-boundary -->

### <del>Delete customer account by OAuth</del> {#delete-customer-account-by-oauth}
---
<!-- reusable-table-boundary -->

This method deletes a customer's account by OAuth.
  
This method requires customer authentication.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.6.11 | 3.6.13 | 0.9.12 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.6.19 | 3.6.19 | 0.14.0 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | n/a | n/a |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CLIENT_DELETE` and `SAUTH_OAUTH_CLIENT_DELETE` permissions from the **Client** group.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Replaced By:**  
[Delete customer account by Identity Provider](/developers/mobile-sdk/method-reference/android/client-account#delete-customer-account-by-identity-provider)
  
**Method name:**  
Client.deleteAccountByOAuth(accessToken, uuid)

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-823">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-823-0" data-tab-group="tabgrp-823" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-823-1" data-tab-group="tabgrp-823">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-823-0" data-tab-group="tabgrp-823" data-tab-active="true">

```Java
public static IApiCall deleteAccountByOAuth(String accessToken, @Nullable String uuid)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-823-1" data-tab-group="tabgrp-823">

```Kotlin
fun deleteAccountByOAuth(accessToken:String, @Nullable uuid:String):IApiCall
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **accessToken** | String | yes | - | user's token |
| **uuid** | String | no | --- | Optional Customer UUID, internal UUID is used if this parameter is null |

**Return Value:**  
[IApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#iapicall) object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-824">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-824-0" data-tab-group="tabgrp-824" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-824-1" data-tab-group="tabgrp-824">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-824-0" data-tab-group="tabgrp-824" data-tab-active="true">

```Java
IApiCall deleteCall = Client.deleteAccountByOAuth(accessToken, uuid)
            deleteCall.execute(this::onSuccess, this::onFailure);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-824-1" data-tab-group="tabgrp-824">

```Kotlin
val deleteCall = Client.deleteAccountByOAuth(accessToken, uuid)
deleteCall.execute(({ this.onSuccess() }), ({ this.onFailure() }))
```

</div>
</div>


<!-- reusable-table-boundary -->

### <del>Delete customer account by Facebook</del> {#delete-customer-account-by-facebook}
---
<!-- reusable-table-boundary -->

This method deletes a customer's account by Facebook.
  
This method requires customer authentication.

| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.3.8 | 3.3.0 | 0.9.12 | n/a |
| <span style="color:orange">Deprecated in:</span> | 3.6.19 | 3.6.19 | 0.14.0 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | n/a | n/a |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `SAUTH_CLIENT_DELETE` and `SAUTH_FACEBOOK_CLIENT_DELETE` permissions from the **Client** group.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Replaced By:**  
[Delete customer account by Identity Provider](/developers/mobile-sdk/method-reference/android/client-account#delete-customer-account-by-identity-provider)
  
**Method name:**  
Client.deleteAccountByFacebook(facebookToken, uuid)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-825">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-825-0" data-tab-group="tabgrp-825" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-825-1" data-tab-group="tabgrp-825">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-825-0" data-tab-group="tabgrp-825" data-tab-active="true">

```Java
public static IApiCall deleteAccountByFacebook(String facebookToken, @Nullable String uuid)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-825-1" data-tab-group="tabgrp-825">

```Kotlin
fun deleteAccountByFacebook(facebookToken:String, @Nullable uuid:String):IApiCall
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **facebookToken** | String | yes | - | Customer's facebook token |
| **uuid** | String | no | --- | Optional Customer UUID, internal UUID is used if this parameter is null |

**Return Value:**  
[IApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#iapicall) object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-826">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-826-0" data-tab-group="tabgrp-826" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-826-1" data-tab-group="tabgrp-826">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-826-0" data-tab-group="tabgrp-826" data-tab-active="true">

```Java
IApiCall deleteCall = Client.deleteAccountByFacebook(facebookToken, uuid)
            deleteCall.execute(this::onSuccess, this::onFailure);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-826-1" data-tab-group="tabgrp-826">

```Kotlin
val deleteCall = Client.deleteAccountByFacebook(facebookToken, uuid)
deleteCall.execute(({ this.onSuccess() }), ({ this.onFailure() }))
```

</div>
</div>


<!-- reusable-table-boundary -->






# Customer session


## Refresh customer token
---
This method refreshes the customer’s current token.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns an error if the token has expired and cannot be refreshed.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClient.h
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1114">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1114-0" data-tab-group="tabgrp-1114" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1114-1" data-tab-group="tabgrp-1114">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1114-0" data-tab-group="tabgrp-1114" data-tab-active="true">

```Swift
static func refreshToken(success: (() -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1114-1" data-tab-group="tabgrp-1114">

```Objective-C
+ (void)refreshTokenWithSuccess:(nonnull void (^)(void))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **success** | (() -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  
**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1115">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1115-0" data-tab-group="tabgrp-1115" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1115-1" data-tab-group="tabgrp-1115">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1115-0" data-tab-group="tabgrp-1115" data-tab-active="true">

```Swift
Client.refreshToken(success: { _ in
    Client.retrieveToken(success: { (token) in
      // success
        let tokenString: String = token.tokenString
        let tokenOrigin: TokenOrigin = token.tokenOrigin
    }, failure: { (error) in
      // failure
    })
}, failure: { (error) in
  // failure
})
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1115-1" data-tab-group="tabgrp-1115">

```Objective-C
[SNRClient refreshTokenWithSuccess:^() {
    [SNRClient retrieveTokenWithSuccess:^(SNRToken *token) {
      // success

        NSString *tokenString = token.tokenString;
        SNRTokenOrigin tokenOrigin = token.tokenOrigin;
    } failure:^(SNRApiError *error) {
      // failure
    }];
} failure:^(SNRApiError *error) {
  // failure
}];
```

</div>
</div>


<!-- reusable-table-boundary -->

## Retrieve customer token
---
This method retrieves the customer’s current, active token.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns an error if the token has expired and cannot be retrieved.

</div></div></div>

**Declared In:**  
Headers/SNRClient.h
  
**Related To:**  
[Token](/developers/mobile-sdk/class-reference/ios/client#token)
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1116">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1116-0" data-tab-group="tabgrp-1116" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1116-1" data-tab-group="tabgrp-1116">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1116-0" data-tab-group="tabgrp-1116" data-tab-active="true">

```Swift
static func retrieveToken(success: ((Token) -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1116-1" data-tab-group="tabgrp-1116">

```Objective-C
+ (void)retrieveTokenWithSuccess:(nonnull void (^)(SNRToken *token))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| **success** | ((Token) -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  
**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1117">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1117-0" data-tab-group="tabgrp-1117" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1117-1" data-tab-group="tabgrp-1117">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1117-0" data-tab-group="tabgrp-1117" data-tab-active="true">

```Swift
Client.retrieveToken(success: { (token) in
  // success
    let tokenString: String = token.tokenString
    let tokenOrigin: TokenOrigin = token.tokenOrigin
}, failure: { (error) in
  // failure
})
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1117-1" data-tab-group="tabgrp-1117">

```Objective-C
[SNRClient retrieveTokenWithSuccess:^(SNRToken *token) {
  // success

    NSString *tokenString = token.tokenString;
    SNRTokenOrigin tokenOrigin = token.tokenOrigin;
} failure:^(SNRApiError *error) {
  // failure
}];
```

</div>
</div>


## Get current customer UUID
---
This method retrieves the customer’s current UUID.
**Declared In:**  
Headers/SNRClient.h
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1118">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1118-0" data-tab-group="tabgrp-1118" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1118-1" data-tab-group="tabgrp-1118">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1118-0" data-tab-group="tabgrp-1118" data-tab-active="true">

```Swift
static func getUUID() -> String
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1118-1" data-tab-group="tabgrp-1118">

```Objective-C
+ (NSString *)getUUID;
```

</div>
</div>

    
**Return Value:**  
The method returns the customer's UUID as string.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1119">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1119-0" data-tab-group="tabgrp-1119" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1119-1" data-tab-group="tabgrp-1119">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1119-0" data-tab-group="tabgrp-1119" data-tab-active="true">

```Swift
let clientUUID: String = Client.getUUID()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1119-1" data-tab-group="tabgrp-1119">

```Objective-C
NSString *clientUUID = [SNRClient getUUID];
```

</div>
</div>


## Get customer UUID for use in authentication
---
<!-- reusable-table-boundary -->

This method retrieves the current UUID or generates a new one from a seed.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.15.0 | 5.15.0 | n/a | n/a |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This operation doesn't affect the customer session in the SDK.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClient.h
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1120">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1120-0" data-tab-group="tabgrp-1120" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1120-1" data-tab-group="tabgrp-1120">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1120-0" data-tab-group="tabgrp-1120" data-tab-active="true">

```Swift
static func getUUIDForAuthentication(authID: String) -> String
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1120-1" data-tab-group="tabgrp-1120">

```Objective-C
+ (NSString *)getUUIDForAuthenticationWithAuthID:(NSString *)authID
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **authID** | String | yes | - | Seed for UUID generation |

**Return Value:**  
The method returns the UUID for use in authentication as a string.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1121">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1121-0" data-tab-group="tabgrp-1121" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1121-1" data-tab-group="tabgrp-1121">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1121-0" data-tab-group="tabgrp-1121" data-tab-active="true">

```Swift
let clientUUID: String = Client.getUUIDForAuthentication(authID: "AUTH_ID")
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1121-1" data-tab-group="tabgrp-1121">

```Objective-C
NSString *clientUUID = [SNRClient getUUIDForAuthenticationWithAuthID:@"AUTH_ID"];
```

</div>
</div>


<!-- reusable-table-boundary -->

## Regenerate customer
---
<!-- reusable-table-boundary -->

This method regenerates the UUID and clears the authentication token, login session, custom email, and custom identifier.
  
This operation works only if the customer is anonymous.

This operation clears the authentication token, login (if applicable), custom email, and custom identifier.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.3.10 | 3.3.5 | 0.9.0 | 0.7.0 |

<!-- reusable-table-boundary -->
**Declared In:**  
Headers/SNRClient.h

**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1122">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1122-0" data-tab-group="tabgrp-1122" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1122-1" data-tab-group="tabgrp-1122">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1122-0" data-tab-group="tabgrp-1122" data-tab-active="true">

```Swift
static func regenerateUUID() -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1122-1" data-tab-group="tabgrp-1122">

```Objective-C
+ (void)regenerateUUID;
```

</div>
</div>

  
**Return Value:**  
No value is returned.

## Regenerate customer with identifier
---
<!-- reusable-table-boundary -->

This method regenerates the UUID and clears the authentication token, login session, custom email, and custom identifier.
  
This operation works only if the customer is anonymous.
  
This operation clears the authentication token, login (if applicable), custom email, and custom identifier
  
The optional `clientIdentifier` parameter is a seed for UUID generation.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.6.5 | 3.6.4 | 0.9.10 | 0.7.2 |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClient.h
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1123">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1123-0" data-tab-group="tabgrp-1123" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1123-1" data-tab-group="tabgrp-1123">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1123-0" data-tab-group="tabgrp-1123" data-tab-active="true">

```Swift
static func regenerateUUID(clientIdentifier: String?) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1123-1" data-tab-group="tabgrp-1123">

```Objective-C
+ (void)regenerateUUIDWithClientIdentifier:(NSString *)clientIdentifier;
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **clientIdentifier** | String | no | - | Seed for UUID generation |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The **clientIdentifier** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>

  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->

## Destroy current session
---
This method destroys the session completely.

This method clears all session data (both client and anonymous) and removes cached data. Then, it regenerates the UUID and creates the new anonymous session.
**Declared In:**  
Headers/SNRClient.h

**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1124">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1124-0" data-tab-group="tabgrp-1124" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1124-1" data-tab-group="tabgrp-1124">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1124-0" data-tab-group="tabgrp-1124" data-tab-active="true">

```Swift
static func destroySession()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1124-1" data-tab-group="tabgrp-1124">

```Objective-C
+ (void)destroySession
```

</div>
</div>

  
**Return Value:**  
No value is returned.
  
**Example:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1125">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1125-0" data-tab-group="tabgrp-1125" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1125-1" data-tab-group="tabgrp-1125">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1125-0" data-tab-group="tabgrp-1125" data-tab-active="true">

```Swift
Client.destroySession()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1125-1" data-tab-group="tabgrp-1125">

```Objective-C
[SNRClient destroySession];
```

</div>
</div>



# Promotions and Vouchers


## Promotions
---

### PromotionResponse
<!-- reusable-table-boundary -->

**Declared In:**  
lib/classes/models/Promotions/PromotionResponse.js   

**Related To:**  
[Promotion](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotion)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel)  
  
**Declaration:**

<pre><code class="language-TypeScript">class PromotionResponse extends BaseModel</code></pre>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **totalCount** | number | no | Total count of promotions |
| **totalPages** | number | no | Total count of pages |
| **page** | number | no | Current page |
| **limit** | number | no | Limit of promotions per page |
| **code** | number | no | HTTP code of the response |
| **items** | [Array<Promotion>](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotion) | no | List of promotion items |

<!-- reusable-table-boundary -->

---
---

### Promotion
<!-- reusable-table-boundary -->

**Declared In:**  
lib/classes/models/Promotions/Promotion.js  
  
**Related To:**  
[PromotionResponse](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotionresponse)  
[PromotionStatus](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotionstatus)  
[PromotionType](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotiontype)  
[PromotionDetails](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotiondetails)  
[PromotionItemScope](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotionitemscope)  
[PromotionDiscountType](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotiondiscounttype)  
[PromotionDiscountMode](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotiondiscountmode)  
[PromotionDiscountModeDetails](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotiondiscountmodedetails)  
[PromotionImage](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotionimage) 

**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel)  
  
**Declaration:**

<pre><code class="language-TypeScript">class Promotion extends BaseModel</code></pre>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **uuid** | string | no | Promotion's UUID |
| **code** | string | no | Promotion's code |
| **status** | [PromotionStatus](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotionstatus) | yes | Promotion's status |
| **type** | [PromotionType](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotiontype) | yes | Promotion's type |
| **details** | [PromotionDetails](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotiondetails) | yes | Promotion's details |
| **redeemLimitPerClient** | number | yes | Redemption limit per customer |
| **redeemQuantityPerActivation** | number | yes | Redemption quantity per activation |
| **currentRedeemedQuantity** | number | no | Current redemption quantity |
| **currentRedeemLimit** | number | no | Current redemption limit |
| **activationCounter** | number | no | Promotion's activation counter |
| **possibleRedeems** | number | no | Maximum number of promotion redemptions |
| **requireRedeemedPoints** | number | yes | Required redeemed points |
| **discountType** | [PromotionDiscountType](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotiondiscounttype) | yes |  Discount type |
| **discountValue** | number | no | Discount value |
| **discountMode** | [PromotionDiscountMode](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotiondiscountmode) | no | Discount mode |
| **discountModeDetails** | [PromotionDiscountModeDetails](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotiondiscountmodedetails) | yes | Discount mode details |
| **priority** | number | no | Promotion's priority |
| **price** | number | no | Item price |
| **itemScope** | [PromotionItemScope](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotionitemscope) | no | Promotion's item scope |
| **minBasketValue** | number | yes | Minimum basket value |
| **maxBasketValue** | number | yes | Maximum basket value  |
| **name** | string | no | Promotion's name |
| **headline** | string | yes | Promotion's headline |
| **descriptionText** | string | yes | Promotion's description |
| **images** | [Array<[PromotionImage](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotionimage)> | yes | List of promotion images |
| **startAt** | Date | yes | Start time of a promotion |
| **expireAt** | Date | yes | Expiration time of the promotion |
| **lastingAt** | Date | yes | Date when the promotion expires for the current profile |
| **lastingTime** | number | yes | Duration of the promotion in seconds |
| **displayFrom** | string | yes | Date as a string when the promotion starts being displayed |
| **displayTo** | string | yes | Date as a string when the promotions ends being displayed |
| **catalogIndexItems** | Array<string> | yes | List of item indexes |
| **params** | object | yes | Promotion's custom parameters |
| **tags** | Array<object> | yes | Promotion's custom tags |

<!-- reusable-table-boundary -->

---
---

### PromotionStatus
**Declared In:**  
lib/classes/models/Promotions/PromotionStatus.js  
  
**Related To:**  
[Promotion](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotion)  

**Declaration:**  

<pre><code class="language-TypeScript">enum PromotionStatus {
  None = 'NONE',
  Active = 'ACTIVE',
  Assigned = 'ASSIGNED',
  Redeemed = 'REDEEMED',
}</code></pre>

  
**Functions:**

Converts from **PromotionStatus** to **string**.

<pre><code class="language-TypeScript">function PromotionStatusToString(promotionStatus: PromotionStatus): string</code></pre>


---

Converts from **string** to **PromotionStatus**.

<pre><code class="language-TypeScript">function PromotionStatusFromString(string: string): PromotionStatus</code></pre>


---
---

### PromotionType 
**Declared In:**  
lib/classes/models/Promotions/PromotionType.js  

**Related To:**  
[Promotion](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotion)  
  
**Declaration:**

<pre><code class="language-TypeScript">enum PromotionType {
  Unknown = 'UNKNOWN',
  MembersOnly = 'MEMBERS_ONLY',
  Custom = 'CUSTOM',
  General = 'GENERAL',
}</code></pre>

  
**Functions:**

Converts from **PromotionType** to **string**.

<pre><code class="language-TypeScript">function PromotionTypeToString(promotionType: PromotionType): string</code></pre>


---

Converts from **string** to **PromotionType**.

<pre><code class="language-TypeScript">function PromotionTypeFromString(string: string): PromotionType</code></pre>


---
---

### PromotionItemScope
**Declared In:**  
lib/classes/models/Promotions/PromotionItemScope.js  
  
**Related To:**  
[Promotion](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotion)  
  
**Declaration:**  

<pre><code class="language-TypeScript">enum PromotionItemScope {
    LineItem = 'LINE_ITEM',
    Basket = 'BASKET'
}</code></pre>

  
**Functions:**  
Converts from **PromotionItemScope** to **string**.

<pre><code class="language-TypeScript">function PromotionItemScopeToString(promotionItemScope: PromotionItemScope): string</code></pre>


---

Converts from **string** to **PromotionItemScope**.

<pre><code class="language-TypeScript">function PromotionItemScopeFromString(string: string): PromotionItemScope</code></pre>


---
---

### PromotionDetails
<!-- reusable-table-boundary -->

**Declared In:**  
lib/classes/models/Promotions/PromotionDetails.js  
  
**Related To:**  
[PromotionDiscountTypeDetails](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotiondiscounttypedetails)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel) 

**Declaration:**  

<pre><code class="language-TypeScript">class PromotionDetails extends BaseModel {
  discountType: PromotionDiscountTypeDetails;
}</code></pre>

  
**Properties:**  
Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **discountType** | [PromotionDiscountTypeDetails](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotiondiscounttypedetails) | yes | Discount details |

<!-- reusable-table-boundary -->

---
---

### PromotionDiscountTypeDetails
<!-- reusable-table-boundary -->

**Declared In:**  
lib/classes/models/Promotions/PromotionDiscountTypeDetails.js  
  
**Related To:**  
[PromotionDetails](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotiondetails)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel) 
  
**Declaration:**  

<pre><code class="language-TypeScript">class PromotionDiscountTypeDetails extends BaseModel {
  name: string;
  outerScope: boolean;
  requiredItemsCount: number;
  discountedItemsCount: number;
}</code></pre>

  
**Properties:**
Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **name** | string | no | Discount’s name |
| **outerScope** | boolean | no | When `true`, the items required to trigger the promotion are different than the items included in that promotion. |
| **requiredItemsCount** | number | no | Number of items required to qualify for the discount |
| **discountedItemsCount** | number | no | Number of discounted items |

<!-- reusable-table-boundary -->

---
---

### PromotionDiscountMode
**Declared In:**  
lib/classes/models/Promotions/PromotionDiscountMode.js  
  
**Related To:**  
[Promotion](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotion)  
  
**Declaration:**  

<pre><code class="language-TypeScript">enum PromotionDiscountMode {
    Static = 'STATIC',
    Step = 'STEP'
}</code></pre>

  
**Functions:**  
Converts from **PromotionDiscountMode** to **string**.

<pre><code class="language-TypeScript">function PromotionDiscountModeToString(promotionDiscountMode: PromotionDiscountMode): string</code></pre>


---

Converts from **string** to **PromotionDiscountMode**.

<pre><code class="language-TypeScript">function PromotionDiscountModeFromString(string: string): PromotionDiscountMode</code></pre>


---
---

### PromotionDiscountModeDetails
<!-- reusable-table-boundary -->

**Declared In:**  
lib/classes/models/Promotions/PromotionDiscountModeDetails.js  
  
**Related To:**  
[PromotionDiscountStep](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotiondiscountstep)  
[PromotionDiscountUsageTrigger](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotiondiscountusagetrigger)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel) 
  
**Declaration:**  

<pre><code class="language-TypeScript">class PromotionDiscountModeDetails extends BaseModel {
  discountSteps: Array&lt;PromotionDiscountStep&gt;;
  discountUsageTrigger: PromotionDiscountUsageTrigger;
}</code></pre>

  
**Properties:**
Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **discountSteps** | Array<[PromotionDiscountStep](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotiondiscountstep)> | no | List of discount steps |
| **discountUsageTrigger** | [PromotionDiscountUsageTrigger](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotiondiscountusagetrigger) | no | Usage trigger for the discount |

<!-- reusable-table-boundary -->

---
---

### PromotionDiscountStep
<!-- reusable-table-boundary -->

**Declared In:**  
lib/classes/models/Promotions/PromotionDiscountStep.js  
  
**Related To:**  
[PromotionDiscountModeDetails](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotiondiscountmodedetails)  

**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel) 
  
**Declaration:**  

<pre><code class="language-TypeScript">class PromotionDiscountStep extends BaseModel {
  discountValue: number;
  usageThreshold: number;
}</code></pre>

  
**Properties:**
Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **discountValue** | number | no | Value of the discount |
| **usageThreshold** | number | no | Usage threshold |

<!-- reusable-table-boundary -->

---
---

### PromotionDiscountUsageTrigger
**Declared In:**  
lib/classes/models/Promotions/PromotionDiscountUsageTrigger.js  
  
**Related To:**  
[Promotion](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotion)  
  
**Declaration:**  

<pre><code class="language-TypeScript">enum PromotionDiscountUsageTrigger {
    Transaction = 'TRANSACTION',
    Redeem = 'REDEEM'
}</code></pre>

  
**Functions:**  
Converts from **PromotionDiscountUsageTrigger** to **string**.

<pre><code class="language-TypeScript">function PromotionDiscountUsageTriggerToString(promotionDiscountUsageTrigger: PromotionDiscountUsageTrigger): string</code></pre>


---

Converts from **string** to **PromotionDiscountUsageTrigger**.

<pre><code class="language-TypeScript">function PromotionDiscountUsageTriggerFromString(string: string): PromotionDiscountUsageTrigger</code></pre>


---
---

### PromotionImage 
<!-- reusable-table-boundary -->

**Declared In:**  
lib/classes/models/Promotions/PromotionImage.js  
  
**Related To:**  
[Promotion](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotion)  
[PromotionImageType](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotionimagetype)  

**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel) 

**Declaration:**  

<pre><code class="language-TypeScript">class PromotionImage extends BaseModel {
  url: string;
  type: PromotionImageType;
}</code></pre>

  
**Properties:**  
Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **url** | string | no | URL of the image |
| **type** | [PromotionImageType](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotionimagetype) | no | Image type |

<!-- reusable-table-boundary -->

---
---

### PromotionImageType
**Declared In:**  
lib/classes/models/Promotions/PromotionImageType.js  
  
**Related To:**  
[PromotionImage](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotionimage)  
  
**Declaration:**  

<pre><code class="language-TypeScript">enum PromotionImageType {
  Image = 'image',
  Thumbnail = 'thumbnail'
}</code></pre>

  
**Functions:**  
Converts from **PromotionImageType** to **string**.

<pre><code class="language-TypeScript">function PromotionImageTypeToString(promotionImageType: PromotionImageType): string</code></pre>


---

Converts from **string** to **PromotionImageType**.

<pre><code class="language-TypeScript">function PromotionImageTypeFromString(string: string): PromotionImageType</code></pre>


---
---

### PromotionDiscountType
**Declared In:**  
lib/classes/models/Promotions/PromotionDiscountType.js  

**Related To:**  
[Promotion](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotion)  

**Declaration:**  

<pre><code class="language-TypeScript">enum PromotionDiscountType {
  None = 'NONE',
  Percent = 'PERCENT',
  Amount = 'AMOUNT',
  TwoForOne = '2_FOR_1',
  Points = 'POINTS',
  Multibuy = 'MULTIBUY',
}</code></pre>

  
**Functions:**

Converts from **PromotionDiscountType** to **string**.

<pre><code class="language-TypeScript">function PromotionDiscountTypeToString(promotionDiscountType: PromotionDiscountType): string</code></pre>


---

Converts from **string** to **PromotionDiscountType**.

<pre><code class="language-TypeScript">function PromotionDiscountTypeFromString(string: string): PromotionDiscountType</code></pre>


---
---

### PromotionIdentifier
<!-- reusable-table-boundary -->

**Declared In:**  
lib/classes/models/Promotions/PromotionIdentifier.js  
  
**Declaration:**  

<pre><code class="language-TypeScript">class PromotionIdentifier {
  key: string;
  value: string;
}</code></pre>

  
**Properties:**

Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **key** | string | yes |  | Promotion identifier type (see [PromotionIdentifierKey enum](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotionidentifierkey))|
| **value** | string | yes |  | Promotion identifier value |

**Initializers:**

<pre><code class="language-TypeScript">constructor(key: PromotionIdentifierKey, value: string)</code></pre>


<!-- reusable-table-boundary -->

---
---

### PromotionIdentifierKey
**Declared In:**  
lib/classes/models/Promotions/PromotionIdentifierKey.js  
  
**Declaration:**  

<pre><code class="language-TypeScript">enum PromotionIdentifierKey {
  Uuid = 'UUID',
  Code = 'CODE',
}</code></pre>


---
---

### PromotionsApiQuery
<!-- reusable-table-boundary -->

Object for setting parameters to facilitate fetching promotions from the API.
  
**Declared In:**  
lib/classes/models/api_queries/PromotionsApiQuery.js  
  
**Related To:**  
[PromotionResponse](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotionresponse)  
[Promotion](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotion)  
  
**Inherits From:**  
[BaseApiQuery](/developers/mobile-sdk/class-reference/react-native/miscellaneous#baseapiquery)  
  
**Declaration:**

<pre><code class="language-TypeScript">class PromotionsApiQuery extends BaseApiQuery</code></pre>

  
**Properties:**
| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **statuses** | [Array<PromotionStatus>](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotionstatus) | no  | [] | List of promotion statuses for query |
| **types** | [Array<PromotionType>](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#promotiontype) | no  | [] | List of promotion types for query |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

- Check the list of promotion sorting keys available in [Loyalty - Promotion sorting options](/developers/mobile-sdk/loyalty#promotion-sorting-options) section.
- See [ApiQuerySortingOrderString](/developers/mobile-sdk/class-reference/react-native/miscellaneous#apiquerysortingorder) to check ordering options.

</div></div></div>


**Initializers:**

<pre><code class="language-TypeScript">constructor()</code></pre>


<!-- reusable-table-boundary -->

---
---

## Vouchers
---

### AssignVoucherResponse
<!-- reusable-table-boundary -->

**Declared In:**  
lib/classes/models/Vouchers/AssignVoucherResponse.js  
  
**Related To:**  
[AssignVoucherData](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#assignvoucherdata)
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel)
  
**Declaration:**

<pre><code class="language-TypeScript">class AssignVoucherResponse extends BaseModel</code></pre>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **message** | string | no | Message from the Voucher assignment response |
| **assignVoucherData** | [AssignVoucherData](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#assignvoucherdata) | yes | List of vouchers in a pool |

<!-- reusable-table-boundary -->

---
---

### VoucherCodesResponse
<!-- reusable-table-boundary -->

**Declared In:**  
lib/classes/models/Vouchers/VoucherCodesResponse.js   
  
**Related To:**  
[VoucherCodesData](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#vouchercodesdata)    
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel)  
  
**Declaration:**

<pre><code class="language-TypeScript">class VoucherCodesResponse extends BaseModel</code></pre>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **items** | Array<[VoucherCodesData](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#vouchercodesdata)> | no | List of voucher items |

<!-- reusable-table-boundary -->

---
---

### AssignVoucherData
<!-- reusable-table-boundary -->

**Declared In:**  
lib/classes/models/Vouchers/AssignVoucherData.js  
  
**Related To:**  
[AssignVoucherResponse](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#assignvoucherresponse)
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel)
  
**Declaration:**  

<pre><code class="language-TypeScript">class AssignVoucherData extends BaseModel</code></pre>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **code** | string | no | Voucher's code |
| **expireIn** | Date | yes | Voucher's expiration date |
| **redeemAt** | Date | yes | Voucher's redemption date |
| **assignedAt** | Date | yes | Voucher's assignment date |
| **createdAt** | Date | no | Voucher's creation date |
| **updatedAt** | Date | no | Voucher's update date |

<!-- reusable-table-boundary -->

---
---

### VoucherCodesData
<!-- reusable-table-boundary -->

**Declared In:**  
lib/classes/models/Vouchers/VoucherCodesData.js  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/react-native/miscellaneous#basemodel)  
  
**Declaration:**

<pre><code class="language-TypeScript">class VoucherCodesData extends BaseModel</code></pre>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **code** | string | no | Voucher's code |
| **status** | [VoucherCodeStatus](/developers/mobile-sdk/class-reference/react-native/promotions-and-vouchers#vouchercodestatus) | no | Voucher's status |
| **clientId** | string | no | ID of the customer to whom the voucher is assigned |
| **clientUuid** | string | no | UUID of the customer to whom the voucher is assigned |
| **poolUuid** | string | no | Voucher's pool ID |
| **expireIn** | string | no | Voucher's expiration date  |
| **redeemAt** | Date | no | Voucher's redemption date |
| **assignedAt** | Date | no | Voucher's assignment date |
| **createdAt** | Date | no | Voucher's creation date |
| **updatedAt** | Date | no | Voucher's update date|

<!-- reusable-table-boundary -->

---
---

### VoucherCodeStatus
**Declared In:**  
lib/classes/models/Vouchers/VoucherCodeStatus.js    
  
**Declaration:**  

<pre><code class="language-TypeScript">enum VoucherCodeStatus {
  Unassigned = 'UNASSIGNED',
  Assigned = 'ASSIGNED',
  Redeemed = 'REDEEMED',
  Canceled = 'CANCELED',
}</code></pre>

  
**Functions:**

Converts from **VoucherCodeStatus** to **string**.

<pre><code class="language-TypeScript">function VoucherCodeStatusToString(voucherCodeStatus: VoucherCodeStatus): string</code></pre>


---

Converts from **string** to **VoucherCodeStatus**.

<pre><code class="language-TypeScript">function VoucherCodeStatusFromString(string: string): VoucherCodeStatus</code></pre>





# Promotions and Vouchers


## Promotions
---

### PromotionResponse
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRPromotionResponse.h  
  
**Related To:**  
[PromotionResponseMetadata](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionresponsemetadata)  
[Promotion](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotion)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-475">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-475-0" data-tab-group="tabgrp-475" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-475-1" data-tab-group="tabgrp-475">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-475-0" data-tab-group="tabgrp-475" data-tab-active="true">

```Swift
class PromotionResponse: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-475-1" data-tab-group="tabgrp-475">

```Objective-C
@interface SNRPromotionResponse : SNRBaseModel
```

</div>
</div>

  
**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **metadata** | [PromotionResponseMetadata](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionresponsemetadata) | yes | Metadata of the promotion response |
| **items** | [[Promotion]](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers/#promotion) | no | List of promotion items |
  

<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties are read-only.

</div></div></div>


<!-- reusable-table-boundary -->

---
---

### PromotionResponseMetadata
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRPromotionResponseMetadata.h  
  
**Related To:**  
[PromotionResponse](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionresponse)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-476">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-476-0" data-tab-group="tabgrp-476" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-476-1" data-tab-group="tabgrp-476">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-476-0" data-tab-group="tabgrp-476" data-tab-active="true">

```Swift
class PromotionResponseMetadata: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-476-1" data-tab-group="tabgrp-476">

```Objective-C
@interface SNRPromotionResponseMetadata : SNRBaseModel
```

</div>
</div>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **totalCount** | Int | no | Total count of promotions |
| **totalPages** | Int | no | Total count of pages |
| **page** | Int | no | Current page |
| **limit** | Int | no | Limit of promotions per page |
| **code** | Int | no | HTTP code of the response |
  

<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties are read-only.

</div></div></div>


<!-- reusable-table-boundary -->

---
---

### Promotion
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRPromotion.h  
  
**Related To:**  
[PromotionResponse](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionresponse)  
[PromotionStatus](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionstatus)  
[PromotionType](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotiontype)  
[PromotionDetails](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotiondetails)  
[PromotionItemScope](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionitemscope) 
[PromotionDiscountType](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotiondiscounttype)  
[PromotionDiscountMode](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotiondiscountmode)  
[PromotionDiscountModeDetails](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotiondiscountmodedetails)  
[PromotionImage](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionimage)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-477">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-477-0" data-tab-group="tabgrp-477" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-477-1" data-tab-group="tabgrp-477">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-477-0" data-tab-group="tabgrp-477" data-tab-active="true">

```Swift
class Promotion: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-477-1" data-tab-group="tabgrp-477">

```Objective-C
@interface SNRPromotion : SNRBaseModel
```

</div>
</div>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **uuid** | String | no | Promotion's UUID |
| **code** | String | no | Promotion's code |
| **status** | [PromotionStatus](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionstatus) | no | Promotion's status |
| **type** | [PromotionType](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotiontype) | no | Promotion's type |
| **details** | [PromotionDetails](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotiondetails) | yes | Promotion's details |
| **redeemLimitPerClient** | NSNumber | yes | Redemption limit per customer |
| **redeemQuantityPerActivation** | NSNumber | yes | Redemption quantity per activation |
| **currentRedeemedQuantity** | NSNumber | no | Current redemption quantity |
| **currentRedeemLimit** | NSNumber | no | Current redemption limit |
| **activationCounter** | NSNumber | no | Promotion's activation counter |
| **possibleRedeems** | NSNumber | no | Maximum number of promotion redemptions |
| **requireRedeemedPoints** | NSNumber | yes | Required redeemed points |
| **discountType** | [PromotionDiscountType](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotiondiscounttype) | no |  Discount type |
| **discountValue** | NSNumber | no | Discount value |
| **discountMode** | [PromotionDiscountMode](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotiondiscountmode) | no | Discount mode |
| **discountModeDetails** | [PromotionDiscountModeDetails](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotiondiscountmodedetails) | yes | Discount mode details |
| **priority** | NSNumber | no | Promotion's priority |
| **price** | NSNumber | no | Item price |
| **itemScope** | [PromotionItemScope](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionitemscope) | no | Promotion's item scope |
| **minBasketValue** | NSNumber | yes | Minimum basket value |
| **maxBasketValue** | NSNumber | yes | Maximum basket value  |
| **name** | String | no | Promotion's name |
| **headline** | String | yes | Promotion's headline |
| **descriptionText** | String | yes | Promotion's description |
| **images** | [[PromotionImage](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionimage)] | yes | List of promotion images |
| **startAt** | Date | yes | Start time of a promotion |
| **expireAt** | Date | yes | Expiration time of the promotion |
| **lastingAt** | Date | yes | Date when the promotion expires for the current profile |
| **lastingTime** | NSNumber | yes | Duration of the promotion in seconds |
| **displayFrom** | String | yes | Date as a string when the promotion starts being displayed |
| **displayTo** | String | yes | Date as a string when the promotions ends being displayed |
| **catalogIndexItems** | [String] | yes | List of item indexes |
| **params** | [AnyHashable: Any] | yes | Promotion's custom parameters |
| **tags** | [AnyObject] | yes | Promotion's custom tags |
  

<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties are read-only.

</div></div></div>


<!-- reusable-table-boundary -->

---
---

### PromotionStatus
**Declared In:**  
Headers/SNRPromotionStatus.h  
  
**Related To:**  
[Promotion](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotion)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-478">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-478-0" data-tab-group="tabgrp-478" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-478-1" data-tab-group="tabgrp-478">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-478-0" data-tab-group="tabgrp-478" data-tab-active="true">

```Swift
enum PromotionStatus: Int {
    none,
    active,
    assigned,
    redeemed
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-478-1" data-tab-group="tabgrp-478">

```Objective-C
typedef NS_ENUM(NSUInteger, SNRPromotionStatus) {
    SNRPromotionStatusNone = 0,
    SNRPromotionStatusActive,
    SNRPromotionStatusAssigned,
    SNRPromotionStatusRedeemed
}
```

</div>
</div>

  
**Functions:**
Converts from **PromotionStatus** to **String**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-479">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-479-0" data-tab-group="tabgrp-479" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-479-1" data-tab-group="tabgrp-479">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-479-0" data-tab-group="tabgrp-479" data-tab-active="true">

```Swift
func SNR_PromotionStatusToString(_: PromotionStatus) -> String
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-479-1" data-tab-group="tabgrp-479">

```Objective-C
NSString * SNR_PromotionStatusToString(SNRPromotionStatus type)
```

</div>
</div>


---

Converts from **String** to **PromotionStatus**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-480">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-480-0" data-tab-group="tabgrp-480" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-480-1" data-tab-group="tabgrp-480">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-480-0" data-tab-group="tabgrp-480" data-tab-active="true">

```Swift
func SNR_StringToPromotionStatus(_: String) -> PromotionStatus
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-480-1" data-tab-group="tabgrp-480">

```Objective-C
SNRPromotionStatus SNR_StringToPromotionStatus(NSString * _Nullable string)
```

</div>
</div>


**Note:**  
The following string constants can be used in [PromotionsApiQuery](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionsapiquery) object:
- SNR_PROMOTION_STATUS_NONE
- SNR_PROMOTION_STATUS_ACTIVE
- SNR_PROMOTION_STATUS_ASSIGNED
- SNR_PROMOTION_STATUS_REDEEMED

---
---

### PromotionType 
**Declared In:**  
Headers/SNRPromotionType.h  
  
**Related To:**  
[Promotion](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotion)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-481">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-481-0" data-tab-group="tabgrp-481" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-481-1" data-tab-group="tabgrp-481">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-481-0" data-tab-group="tabgrp-481" data-tab-active="true">

```Swift
enum PromotionType: Int {
    unknown,
    membersOnly,
    custom,
    general,
    handbill
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-481-1" data-tab-group="tabgrp-481">

```Objective-C
typedef NS_ENUM(NSUInteger, SNRPromotionType) {
    SNRPromotionTypeUnknown = 0,
    SNRPromotionTypeMembersOnly,
    SNRPromotionTypeCustom,
    SNRPromotionTypeGeneral,
    SNRPromotionTypeHandbill
}
```

</div>
</div>

  
**Functions:**
Converts from **PromotionType** to **String**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-482">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-482-0" data-tab-group="tabgrp-482" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-482-1" data-tab-group="tabgrp-482">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-482-0" data-tab-group="tabgrp-482" data-tab-active="true">

```Swift
func SNR_PromotionTypeToString(_: PromotionType) -> String
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-482-1" data-tab-group="tabgrp-482">

```Objective-C
NSString * SNR_PromotionTypeToString(SNRPromotionType type)
```

</div>
</div>


---

Converts from **String** to **PromotionType**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-483">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-483-0" data-tab-group="tabgrp-483" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-483-1" data-tab-group="tabgrp-483">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-483-0" data-tab-group="tabgrp-483" data-tab-active="true">

```Swift
func SNR_StringToPromotionType(_: String) -> PromotionType
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-483-1" data-tab-group="tabgrp-483">

```Objective-C
SNRPromotionType SNR_StringToPromotionType(NSString * _Nullable string)
```

</div>
</div>


**Note:**  
The following string constants can be used in [PromotionsApiQuery](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionsapiquery) object:
- SNR_PROMOTION_TYPE_UNKNOWN
- SNR_PROMOTION_TYPE_MEMBERS_ONLY
- SNR_PROMOTION_TYPE_CUSTOM
- SNR_PROMOTION_TYPE_GENERAL

---
---

### PromotionItemScope
**Declared In:**  
Headers/SNRPromotionItemScope.h  
  
**Related To:**  
[Promotion](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotion)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-484">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-484-0" data-tab-group="tabgrp-484" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-484-1" data-tab-group="tabgrp-484">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-484-0" data-tab-group="tabgrp-484" data-tab-active="true">

```Swift
enum PromotionItemScope: Int {
    lineItem,
    basket
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-484-1" data-tab-group="tabgrp-484">

```Objective-C
typedef NS_ENUM(NSUInteger, SNRPromotionItemScope) {
    SNRPromotionItemScopeLineItem = 0,
    SNRPromotionItemScopeBasket
}
```

</div>
</div>

  
**Functions:**
Converts from **PromotionItemScope** to **String**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-485">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-485-0" data-tab-group="tabgrp-485" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-485-1" data-tab-group="tabgrp-485">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-485-0" data-tab-group="tabgrp-485" data-tab-active="true">

```Swift
func SNR_PromotionItemScopeToString(_: PromotionItemScope) -> String
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-485-1" data-tab-group="tabgrp-485">

```Objective-C
NSString * SNR_PromotionItemScopeToString(SNRPromotionItemScope scope)
```

</div>
</div>


---

Converts from **String** to **PromotionItemScope**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-486">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-486-0" data-tab-group="tabgrp-486" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-486-1" data-tab-group="tabgrp-486">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-486-0" data-tab-group="tabgrp-486" data-tab-active="true">

```Swift
func SNR_StringToPromotionItemScope(_: String) -> PromotionItemScope
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-486-1" data-tab-group="tabgrp-486">

```Objective-C
SNRPromotionItemScope SNR_StringToPromotionItemScope(NSString * _Nullable string)
```

</div>
</div>


---
---

### PromotionDetails
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRPromotionDetails.h  
  
**Related To:**  
[Promotion](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotion)  
[PromotionDiscountTypeDetails](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotiondiscounttypedetails)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-487">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-487-0" data-tab-group="tabgrp-487" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-487-1" data-tab-group="tabgrp-487">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-487-0" data-tab-group="tabgrp-487" data-tab-active="true">

```Swift
class PromotionDetails: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-487-1" data-tab-group="tabgrp-487">

```Objective-C
@interface SNRPromotionDetails : SNRBaseModel
```

</div>
</div>

  
**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **discountType** | [PromotionDiscountTypeDetails](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotiondiscounttypedetails) | no | Discount details |
  

<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties are read-only.

</div></div></div>


<!-- reusable-table-boundary -->

---
---

### PromotionDiscountTypeDetails
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRPromotionDiscountTypeDetails.h  
  
**Related To:**  
[PromotionDetails](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotiondetails)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-488">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-488-0" data-tab-group="tabgrp-488" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-488-1" data-tab-group="tabgrp-488">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-488-0" data-tab-group="tabgrp-488" data-tab-active="true">

```Swift
class PromotionDiscountTypeDetails: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-488-1" data-tab-group="tabgrp-488">

```Objective-C
@interface SNRPromotionDiscountTypeDetails : SNRBaseModel
```

</div>
</div>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **name** | String | no | Discount's name |
| **outerScope** | Bool | no | When `true`, the items required to trigger the promotion are different than the items included in that promotion. |
| **requiredItemsCount** | Int | no | Number of items required to qualify for the discount |
| **discountedItemsCount** | Int | no | Number of discounted items |
  

<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties are read-only.

</div></div></div>


<!-- reusable-table-boundary -->

---
---

### PromotionDiscountMode
**Declared In:**  
Headers/SNRPromotionDiscountType.h  
  
**Related To:**  
[Promotion](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotion)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-489">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-489-0" data-tab-group="tabgrp-489" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-489-1" data-tab-group="tabgrp-489">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-489-0" data-tab-group="tabgrp-489" data-tab-active="true">

```Swift
enum PromotionDiscountMode: Int {
    static,
    step
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-489-1" data-tab-group="tabgrp-489">

```Objective-C
typedef NS_ENUM(NSUInteger, SNRPromotionDiscountMode) {
    SNRPromotionDiscountModeStatic = 0,
    SNRPromotionDiscountModeStep
}
```

</div>
</div>

  
**Functions:**
Converts from **PromotionDiscountMode** to **String**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-490">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-490-0" data-tab-group="tabgrp-490" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-490-1" data-tab-group="tabgrp-490">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-490-0" data-tab-group="tabgrp-490" data-tab-active="true">

```Swift
func SNR_PromotionDiscountModeToString(_: PromotionDiscountMode) -> String
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-490-1" data-tab-group="tabgrp-490">

```Objective-C
NSString * SNR_PromotionDiscountModeToString(SNRPromotionDiscountMode mode)
```

</div>
</div>


---

Converts from **String** to **PromotionDiscountMode**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-491">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-491-0" data-tab-group="tabgrp-491" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-491-1" data-tab-group="tabgrp-491">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-491-0" data-tab-group="tabgrp-491" data-tab-active="true">

```Swift
func SNR_StringToPromotionDiscountMode(_: String) -> PromotionDiscountMode
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-491-1" data-tab-group="tabgrp-491">

```Objective-C
SNRPromotionDiscountMode SNR_StringToPromotionDiscountMode(NSString * _Nullable string)
```

</div>
</div>


---
---

### PromotionDiscountModeDetails
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRPromotionDiscountModeDetails.h  
  
**Related To:**  
[Promotion](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotion)  
[PromotionDiscountStep](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotiondiscountstep)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-492">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-492-0" data-tab-group="tabgrp-492" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-492-1" data-tab-group="tabgrp-492">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-492-0" data-tab-group="tabgrp-492" data-tab-active="true">

```Swift
class PromotionDiscountModeDetails: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-492-1" data-tab-group="tabgrp-492">

```Objective-C
@interface SNRPromotionDiscountModeDetails : SNRBaseModel
```

</div>
</div>

  
**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **discountSteps** | [[SNRPromotionDiscountStep]](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers/#promotion) | no | List of discount steps |
| **discountUsageTrigger** | [PromotionDiscountUsageTrigger](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotiondiscountusagetrigger) | no | Usage trigger for the discount |
  

<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties are read-only.

</div></div></div>


<!-- reusable-table-boundary -->

---
---

### PromotionDiscountStep
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRPromotionDiscountStep.h   
  
**Related To:**  
[PromotionDiscountModeDetails](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotiondiscountmodedetails)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-493">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-493-0" data-tab-group="tabgrp-493" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-493-1" data-tab-group="tabgrp-493">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-493-0" data-tab-group="tabgrp-493" data-tab-active="true">

```Swift
class PromotionDiscountStep: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-493-1" data-tab-group="tabgrp-493">

```Objective-C
@interface SNRPromotionDiscountStep : SNRBaseModel
```

</div>
</div>

  
**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **discountValue** | NSNumber | no | Value of the discount |
| **usageThreshold** | NSNumber | no | Usage threshold |
  

<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties are read-only.

</div></div></div>


<!-- reusable-table-boundary -->

---
---

### PromotionDiscountUsageTrigger
**Declared In:**  
Headers/SNRPromotionDiscountUsageTrigger.h  
  
**Related To:**  
[PromotionDiscountModeDetails](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotiondiscountmodedetails)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-494">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-494-0" data-tab-group="tabgrp-494" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-494-1" data-tab-group="tabgrp-494">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-494-0" data-tab-group="tabgrp-494" data-tab-active="true">

```Swift
enum PromotionDiscountUsageTrigger: Int {
    transaction,
    redeem
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-494-1" data-tab-group="tabgrp-494">

```Objective-C
typedef NS_ENUM(NSUInteger, SNRPromotionDiscountUsageTrigger) {
SNRPromotionDiscountUsageTriggerTransaction = 0,
SNRPromotionDiscountUsageTriggerRedeem
}
```

</div>
</div>

  
**Functions:**
Converts from **PromotionDiscountUsageTrigger** to **String**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-495">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-495-0" data-tab-group="tabgrp-495" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-495-1" data-tab-group="tabgrp-495">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-495-0" data-tab-group="tabgrp-495" data-tab-active="true">

```Swift
func SNR_PromotionDiscountUsageTriggerToString(_: PromotionDiscountUsageTrigger) -> String
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-495-1" data-tab-group="tabgrp-495">

```Objective-C
NSString * SNR_PromotionDiscountUsageTriggerToString(SNRPromotionDiscountUsageTrigger trigger)
```

</div>
</div>


---

Converts from **String** to **PromotionDiscountUsageTrigger**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-496">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-496-0" data-tab-group="tabgrp-496" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-496-1" data-tab-group="tabgrp-496">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-496-0" data-tab-group="tabgrp-496" data-tab-active="true">

```Swift
func SNR_StringToPromotionDiscountUsageTrigger(_: String) -> PromotionDiscountUsageTrigger
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-496-1" data-tab-group="tabgrp-496">

```Objective-C
SNRPromotionDiscountUsageTrigger SNR_StringToPromotionDiscountUsageTrigger(NSString * _Nullable string)
```

</div>
</div>


---
---

### PromotionImage 
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRPromotion.h  
  
**Related To:**  
[Promotion](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotion)  
[PromotionImageType](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionimagetype)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-497">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-497-0" data-tab-group="tabgrp-497" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-497-1" data-tab-group="tabgrp-497">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-497-0" data-tab-group="tabgrp-497" data-tab-active="true">

```Swift
class PromotionImage: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-497-1" data-tab-group="tabgrp-497">

```Objective-C
@interface SNRPromotionImage : SNRBaseModel
```

</div>
</div>

  
**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **url** | String | no | Image's URL |
| **type** | [PromotionImageType](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionimagetype) | no | Image type |
  

<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties are read-only.

</div></div></div>


<!-- reusable-table-boundary -->

---
---

### PromotionImageType
**Declared In:**  
Headers/SNRPromotionImageType.h
  
**Related To:**  
[Promotion](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotion)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-498">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-498-0" data-tab-group="tabgrp-498" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-498-1" data-tab-group="tabgrp-498">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-498-0" data-tab-group="tabgrp-498" data-tab-active="true">

```Swift
enum PromotionImageType: Int {
    image,
    thumbnail
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-498-1" data-tab-group="tabgrp-498">

```Objective-C
typedef NS_ENUM(NSUInteger, SNRPromotionImageType) {
    SNRPromotionImageTypeImage = 0,
    SNRPromotionImageTypeThumbnail
}
```

</div>
</div>

  
**Functions:**
Converts from **PromotionImageType** to **String**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-499">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-499-0" data-tab-group="tabgrp-499" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-499-1" data-tab-group="tabgrp-499">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-499-0" data-tab-group="tabgrp-499" data-tab-active="true">

```Swift
func SNR_PromotionImageTypeToString(_: PromotionImageType) -> String
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-499-1" data-tab-group="tabgrp-499">

```Objective-C
NSString * SNR_PromotionImageTypeToString(SNRPromotionImageType type)
```

</div>
</div>


---

Converts from **String** to **PromotionImageType**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-500">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-500-0" data-tab-group="tabgrp-500" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-500-1" data-tab-group="tabgrp-500">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-500-0" data-tab-group="tabgrp-500" data-tab-active="true">

```Swift
func SNR_StringToPromotionImageType(_: String) -> PromotionImageType
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-500-1" data-tab-group="tabgrp-500">

```Objective-C
SNRPromotionImageType SNR_StringToPromotionImageType(NSString * _Nullable string)
```

</div>
</div>


---
---

### PromotionDiscountType
**Declared In:**  
Headers/SNRPromotionDiscountType.h  
  
**Related To:**  
[Promotion](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotion)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-501">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-501-0" data-tab-group="tabgrp-501" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-501-1" data-tab-group="tabgrp-501">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-501-0" data-tab-group="tabgrp-501" data-tab-active="true">

```Swift
enum PromotionDiscountType: Int {
    none,
    percent,
    amount,
    2For1,
    points,
    multibuy,
    exactPrice
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-501-1" data-tab-group="tabgrp-501">

```Objective-C
typedef NS_ENUM(NSUInteger, SNRPromotionDiscountType) {
    SNRPromotionDiscountTypeNone = 0,
    SNRPromotionDiscountTypePercent,
    SNRPromotionDiscountTypeAmount,
    SNRPromotionDiscountType2For1,
    SNRPromotionDiscountTypePoints,
    SNRPromotionDiscountTypeMultibuy,
    SNRPromotionDiscountTypeExactPrice
}
```

</div>
</div>

  
**Functions:**
Converts from **PromotionDiscountType** to **String**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-502">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-502-0" data-tab-group="tabgrp-502" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-502-1" data-tab-group="tabgrp-502">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-502-0" data-tab-group="tabgrp-502" data-tab-active="true">

```Swift
func SNR_PromotionDiscountTypeToString(_: PromotionDiscountType) -> String
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-502-1" data-tab-group="tabgrp-502">

```Objective-C
NSString * SNR_PromotionDiscountTypeToString(SNRPromotionDiscountType type)
```

</div>
</div>


---

Converts from **String** to **PromotionDiscountType**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-503">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-503-0" data-tab-group="tabgrp-503" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-503-1" data-tab-group="tabgrp-503">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-503-0" data-tab-group="tabgrp-503" data-tab-active="true">

```Swift
func SNR_StringToPromotionDiscountType(_: String) -> PromotionDiscountType
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-503-1" data-tab-group="tabgrp-503">

```Objective-C
SNRPromotionDiscountType SNR_StringToPromotionDiscountType(NSString * _Nullable string)
```

</div>
</div>


---
---

### PromotionIdentifier
**Declared In:**  
Headers/SNRPromotionIdentifier.h  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-504">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-504-0" data-tab-group="tabgrp-504" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-504-1" data-tab-group="tabgrp-504">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-504-0" data-tab-group="tabgrp-504" data-tab-active="true">

```Swift
class PromotionIdentifier: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-504-1" data-tab-group="tabgrp-504">

```Objective-C
@interface SNRPromotionIdentifier : SNRBaseModel
```

</div>
</div>

  
**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-505">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-505-0" data-tab-group="tabgrp-505" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-505-1" data-tab-group="tabgrp-505">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-505-0" data-tab-group="tabgrp-505" data-tab-active="true">

```Swift
init(uuid: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-505-1" data-tab-group="tabgrp-505">

```Objective-C
- (instancetype)initWithUUID:(NSString *)UUID
```

</div>
</div>


---


<div class="content-tabs code-tabs" data-tab-group="tabgrp-506">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-506-0" data-tab-group="tabgrp-506" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-506-1" data-tab-group="tabgrp-506">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-506-0" data-tab-group="tabgrp-506" data-tab-active="true">

```Swift
init(code: String)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-506-1" data-tab-group="tabgrp-506">

```Objective-C
- (instancetype)initWithCode:(NSString *)code
```

</div>
</div>


---
---

### PromotionsApiQuery
<!-- reusable-table-boundary -->

Object for setting parameters to facilitate fetching promotions from the API.
  
**Declared In:**  
Headers/SNRPromotionsApiQuery.h
  
**Related To:**  
[PromotionResponse](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionresponse)  
[Promotion](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotion)  
[ApiQuerySortingOrderString](/developers/mobile-sdk/class-reference/ios/miscellaneous#apiquerysortingorder)
  
**Inherits From:**  
[NSObject](https://developer.apple.com/documentation/objectivec/nsobject)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-507">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-507-0" data-tab-group="tabgrp-507" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-507-1" data-tab-group="tabgrp-507">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-507-0" data-tab-group="tabgrp-507" data-tab-active="true">

```Swift
class PromotionsApiQuery: NSObject
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-507-1" data-tab-group="tabgrp-507">

```Objective-C
@interface SNRPromotionsApiQuery : NSObject
```

</div>
</div>

  
**Properties:**
| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **statuses** | [[SNRPromotionStatusString]](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers/#promotionstatus) | no  | [] | List of promotion statuses for query |
| **types** | [[SNRPromotionTypeString]](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers/#promotiontype) | no  | [] | List of promotion types for query |
| **sorting** | [[SNRPromotionSortingKey: SNRApiQuerySortingOrderString]] | yes | [] | Specifies sorting rules for items in the response |
| **limit** | Int | no | 100 | Limit of items per page in the response |
| **page** | Int | no | 1 | Page number |
| **includeMeta** | Bool | no | false | Specifies if meta data should be included in the response |
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

- Check the list of promotion sorting keys available in [Loyalty - Promotion sorting options](/developers/mobile-sdk/loyalty#promotion-sorting-options) section.
- See [ApiQuerySortingOrderString](/developers/mobile-sdk/class-reference/ios/miscellaneous#apiquerysortingorder) to check ordering options.

</div></div></div>


**Initializers:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-508">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-508-0" data-tab-group="tabgrp-508" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-508-1" data-tab-group="tabgrp-508">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-508-0" data-tab-group="tabgrp-508" data-tab-active="true">

```Swift
init()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-508-1" data-tab-group="tabgrp-508">

```Objective-C
- (instancetype)init
```

</div>
</div>


<!-- reusable-table-boundary -->

---
---

## Vouchers
---

### AssignVoucherResponse
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRAssignVoucherResponse.h
  
**Related To:**  
[AssignVoucherData](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#assignvoucherdata)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)  
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-509">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-509-0" data-tab-group="tabgrp-509" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-509-1" data-tab-group="tabgrp-509">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-509-0" data-tab-group="tabgrp-509" data-tab-active="true">

```Swift
class AssignVoucherResponse: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-509-1" data-tab-group="tabgrp-509">

```Objective-C
@interface SNRAssignVoucherResponse : SNRBaseModel
```

</div>
</div>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **message** | String | no | Message from the Voucher assignment response |
| **assignVoucherData** | [AssignVoucherData](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#assignvoucherdata) | yes | List of vouchers in a pool |
  

<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties are read-only.

</div></div></div>


<!-- reusable-table-boundary -->

---
---

### VoucherCodesResponse
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRVoucherCodesResponse.h  
  
**Related To:**  
[SNRVoucherCodesData](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#vouchercodesdata)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-510">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-510-0" data-tab-group="tabgrp-510" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-510-1" data-tab-group="tabgrp-510">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-510-0" data-tab-group="tabgrp-510" data-tab-active="true">

```Swift
class VoucherCodesResponse: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-510-1" data-tab-group="tabgrp-510">

```Objective-C
@interface SNRVoucherCodesResponse : SNRBaseModel
```

</div>
</div>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **items** | [[VoucherCodesData]](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers/#vouchercodesdata) | no | List of voucher items |
  

<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties are read-only.

</div></div></div>


<!-- reusable-table-boundary -->

---
---

### AssignVoucherData
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRAssignVoucherData.h  
  
**Related To:**  
[AssignVoucherResponse](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#assignvoucherresponse)  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)
  
**Declaration:**

<div class="content-tabs code-tabs" data-tab-group="tabgrp-511">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-511-0" data-tab-group="tabgrp-511" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-511-1" data-tab-group="tabgrp-511">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-511-0" data-tab-group="tabgrp-511" data-tab-active="true">

```Swift
class AssignVoucherData: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-511-1" data-tab-group="tabgrp-511">

```Objective-C
@interface SNRAssignVoucherData : SNRBaseModel
```

</div>
</div>

  
**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **code** | String | no | Voucher's code |
| **expireIn** | Date | yes | Voucher's expiration date |
| **redeemAt** | Date | yes | Voucher's redemption date |
| **assignedAt** | Date | yes | Voucher's assignment date |
| **createdAt** | Date | no | Voucher's creation date |
| **updatedAt** | Date | no | Voucher's update date |
  

<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties are read-only.

</div></div></div>


<!-- reusable-table-boundary -->

---
---

### VoucherCodesData
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRVoucherCodesData.h  
  
**Inherits From:**  
[BaseModel](/developers/mobile-sdk/class-reference/ios/miscellaneous#basemodel)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-512">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-512-0" data-tab-group="tabgrp-512" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-512-1" data-tab-group="tabgrp-512">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-512-0" data-tab-group="tabgrp-512" data-tab-active="true">

```Swift
class VoucherCodesData: BaseModel
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-512-1" data-tab-group="tabgrp-512">

```Objective-C
@interface SNRVoucherCodesData : SNRBaseModel
```

</div>
</div>

  
**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **code** | String | no | Voucher's code |
| **status** | [VoucherStatus](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#voucherstatus) | no | Voucher's status |
| **clientId** | String | no | ID of the customer to whom the voucher is assigned |
| **clientUuid** | String | no | UUID of the customer to whom the voucher is assigned |
| **poolUuid** | String | no | Voucher's pool ID |
| **expireIn** | Date | no | Voucher's expiration date  |
| **redeemAt** | Date | no | Voucher's redemption date |
| **assignedAt** | Date | no | Voucher's assignment date |
| **createdAt** | Date | no | Voucher's creation date |
| **updatedAt** | Date | no | Voucher's update date|
  

<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties are read-only.

</div></div></div>


<!-- reusable-table-boundary -->

---
---

### VoucherStatus
**Declared In:**  
Headers/SNRVoucherStatus.h  
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-513">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-513-0" data-tab-group="tabgrp-513" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-513-1" data-tab-group="tabgrp-513">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-513-0" data-tab-group="tabgrp-513" data-tab-active="true">

```Swift
enum VoucherStatus: Int {
    unassigned,
    assigned,
    redeemed,
    canceled
}
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-513-1" data-tab-group="tabgrp-513">

```Objective-C
typedef NS_ENUM(NSUInteger, SNRVoucherStatus) {
    SNRVoucherStatusUnassigned = 0,
    SNRVoucherStatusAssigned,
    SNRVoucherStatusRedeemed,
    SNRVoucherStatusCanceled
}
```

</div>
</div>

  
**Functions:**  
Converts from **VoucherStatus** to **String**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-514">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-514-0" data-tab-group="tabgrp-514" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-514-1" data-tab-group="tabgrp-514">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-514-0" data-tab-group="tabgrp-514" data-tab-active="true">

```Swift
func SNR_VoucherStatusToString(_: VoucherStatus) -> String
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-514-1" data-tab-group="tabgrp-514">

```Objective-C
NSString * SNR_VoucherStatusToString(SNRVoucherStatus type)
```

</div>
</div>


---

Converts from **String** to **VoucherStatus**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-515">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-515-0" data-tab-group="tabgrp-515" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-515-1" data-tab-group="tabgrp-515">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-515-0" data-tab-group="tabgrp-515" data-tab-active="true">

```Swift
func SNR_StringToVoucherStatus(_: String) -> VoucherStatus
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-515-1" data-tab-group="tabgrp-515">

```Objective-C
SNRVoucherStatus SNR_StringToVoucherStatus(NSString * _Nullable string)
```

</div>
</div>




# Promotions and Vouchers


## Promotions
---

### PromotionResponse
<!-- reusable-table-boundary -->

**Declared In:**  
lib/model/promotions/promotion_response.dart

**Related To:**  
[Promotion](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotion)  
  
**Declaration:**

<pre><code class="language-Dart">class PromotionResponse</code></pre>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **totalCount** | int | no | Total count of promotions |
| **totalPages** | int | no | Total count of pages |
| **page** | int | no | Current page |
| **limit** | int | no | Limit of promotions per page |
| **code** | int | no | HTTP code of the response |
| **items** | List<[Promotion](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotion)> | no | List of promotion items |

<!-- reusable-table-boundary -->

---
---

### Promotion
<!-- reusable-table-boundary -->

**Declared In:**  
lib/model/promotions/promotion.dart

**Related To:**  
[PromotionResponse](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotionresponse)  
[PromotionStatus](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotionstatus)  
[PromotionType](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotiontype) 
[PromotionDiscountType](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotiondiscounttype) 
  
**Declaration:**

<pre><code class="language-Dart">class Promotion</code></pre>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **uuid** | String | no | Promotion's UUID |
| **code** | String | no | Promotion's code |
| **status** | [PromotionStatus](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotionstatus) | yes | Promotion's status |
| **type** | [PromotionType](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotiontype) | yes | Promotion's type |
| **details** | [PromotionDetails](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotiondetails) | yes | Promotion's details |
| **redeemLimitPerClient** | int | yes | Redemption limit per customer |
| **redeemQuantityPerActivation** | int | yes | Redemption quantity per activation |
| **currentRedeemedQuantity** | int | no | Current redemption quantity |
| **currentRedeemLimit** | int | no | Current redemption limit |
| **activationCounter** | int | no | Promotion's activation counter |
| **possibleRedeems** | int | no | Maximum number of promotion redemptions |
| **requireRedeemedPoints** | int | yes | Required redeemed points |
| **discountType** | [PromotionDiscountType](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotiondiscounttype) | yes |  Discount type |
| **discountValue** | int | no | Discount value |
| **discountMode** | [PromotionDiscountMode](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotiondiscountmode) | no | Discount mode |
| **discountModeDetails** | [PromotionDiscountModeDetails](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotiondiscountmodedetails) | yes | Discount mode details |
| **priority** | int | no | Promotion's priority |
| **price** | int | no | Item price |
| **itemScope** | [PromotionItemScope](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotionitemscope) | no | Promotion's item scope |
| **minBasketValue** | int | yes | Minimum basket value |
| **maxBasketValue** | int | yes | Maximum basket value  |
| **name** | String | no | Promotion's name |
| **headline** | String | yes | Promotion's headline |
| **descriptionText** | String | yes | Promotion's description |
| **images** | List<[PromotionImage](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotiontype)>  | yes | List of promotion images |
| **startAt** | DateTime | yes | Start time of a promotion |
| **expireAt** | DateTime | yes | Expiration time of the promotion |
| **lastingAt** | DateTime | yes | Date when the promotion expires for the current profile |
| **lastingTime** | int | yes | Duration of the promotion in seconds |
| **displayFrom** | String | yes | DateTime as a String when the promotion starts being displayed |
| **displayTo** | String | yes | DateTime as a String when the promotions ends being displayed |
| **catalogIndexItems** | List&lt;String&gt; | yes | List of item indexes |
| **params** | Map<String, Object> | yes | Promotion's custom parameters |
| **tags** | List&lt;Object&gt; | yes | Promotion's custom tags |

<!-- reusable-table-boundary -->

---
---

### PromotionStatus
**Declared In:**  
lib/enums/promotions/promotion_status.dart

**Related To:**  
[Promotion](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotion)  

**Declaration:**  

<pre><code class="language-Dart">enum PromotionStatus {
  none('NONE'),
  active('ACTIVE'),
  assigned('ASSIGNED'),
  redeemed('REDEEMED');
}</code></pre>

  
**Functions:**

Converts from **PromotionStatus** to **String**.

<pre><code class="language-Dart">String promotionStatusAsString()</code></pre>


---

Converts from **String** to **PromotionStatus**.

<pre><code class="language-Dart">PromotionStatus getPromotionStatusFromString(String string)</code></pre>


---
---

### PromotionType 
**Declared In:**  
lib/enums/promotions/promotion_type.dart

**Related To:**  
[Promotion](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotion)  
  
**Declaration:**

<pre><code class="language-Dart">enum PromotionType {
  unknown('UNKNOWN'),
  membersOnly('MEMBERS_ONLY'),
  custom('CUSTOM'),
  general('GENERAL'),
  handbill('HANDBILL');
}</code></pre>

  
**Functions:**

Converts from **PromotionType** to **String**.

<pre><code class="language-Dart">String promotionTypeAsString() {</code></pre>


---

Converts from **String** to **PromotionType**.

<pre><code class="language-Dart">PromotionType getPromotionTypeFromString(String string) {</code></pre>


---
---

### PromotionDiscountType
**Declared In:**  
lib/enums/promotions/promotion_discount_type.dart  

**Related To:**  
[Promotion](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotion)  

**Declaration:**  

<pre><code class="language-Dart">enum PromotionDiscountType {
  none('NONE'),
  percent('PERCENT'),
  amount('AMOUNT'),
  twoForOne('2_FOR_1'),
  points('POINTS'),
  multibuy('MULTIBUY'),
  exactPrice('EXACT_PRICE');
}</code></pre>

  
**Functions:**

Converts from **String** to **PromotionDiscountType**.

<pre><code class="language-Dart">PromotionDiscountType getPromotionDiscountTypeFromString(String string)</code></pre>


---
---


### PromotionItemScope
**Declared In:**  
lib/enums/promotions/promotion_item_scope.dart
  
**Related To:**  
[Promotion](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotion)  
  
**Declaration:**  

<pre><code class="language-Dart">enum PromotionItemScope {
  lineItem('LINE_ITEM'),
  basket('BASKET');</code></pre>

  
**Functions:**
Converts from **PromotionItemScope** to **String**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-163">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-163-0" data-tab-group="tabgrp-163" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-163-0" data-tab-group="tabgrp-163" data-tab-active="true">

```Dart
String promotionItemScopeAsString()
```

</div>
</div>


---

Converts from **String** to **PromotionItemScope**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-164">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-164-0" data-tab-group="tabgrp-164" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-164-0" data-tab-group="tabgrp-164" data-tab-active="true">

```Dart
static PromotionItemScope getPromotionItemScopeFromString(String string)
```

</div>
</div>


---
---

### PromotionDetails
<!-- reusable-table-boundary -->

**Declared In:**  
lib/model/promotions/promotion_details.dart
  
**Related To:**  
[Promotion](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotion)  
[PromotionDiscountTypeDetails](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotiondiscounttypedetails)  
  
**Declaration:**  

<pre><code class="language-Dart">class PromotionDetails</code></pre>

  
**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **discountType** | [PromotionDiscountTypeDetails](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotiondiscounttypedetails) | no | Discount details |
  

<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties are read-only.

</div></div></div>


<!-- reusable-table-boundary -->

---
---

### PromotionDiscountTypeDetails
<!-- reusable-table-boundary -->

**Declared In:**  
lib/model/promotions/promotion_discount_type_details.dart

**Related To:**  
[PromotionDetails](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotiondetails)  
  
**Declaration:**  

<pre><code class="language-Dart">class PromotionDiscountTypeDetails</code></pre>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **name** | String | no | Discount's name |
| **outerScope** | bool | no | When `true`, the items required to trigger the promotion are different than the items included in that promotion. |
| **requiredItemsCount** | int | no | Number of items required to qualify for the discount |
| **discountedItemsCount** | int | no | Number of discounted items |
  

<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties are read-only.

</div></div></div>


<!-- reusable-table-boundary -->

---
---

### PromotionDiscountMode
**Declared In:**  
lib/enums/promotions/promotion_discount_mode.dart

**Related To:**  
[Promotion](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotion)  
  
**Declaration:**

<pre><code class="language-Dart">enum PromotionDiscountMode {
  staticMode('STATIC'),
  stepMode('STEP');</code></pre>

  
**Functions:**

Converts from **String** to **PromotionDiscountMode**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-165">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-165-0" data-tab-group="tabgrp-165" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-165-0" data-tab-group="tabgrp-165" data-tab-active="true">

```Dart
static PromotionDiscountMode getPromotionDiscountModeFromString(String string)
```

</div>
</div>


---
---

### PromotionDiscountModeDetails
<!-- reusable-table-boundary -->

**Declared In:**  
lib/model/promotions/promotion_discount_mode_details.dart

**Related To:**  
[Promotion](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotion)  
[PromotionDiscountStep](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotiondiscountstep)  
  
**Declaration:**

<pre><code class="language-Dart">class PromotionDiscountModeDetails</code></pre>


**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **discountSteps** | [PromotionDiscountStep](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotion) | no | List of discount steps |
| **discountUsageTrigger** | [PromotionDiscountUsageTrigger](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotiondiscountusagetrigger) | no | Usage trigger for the discount |
  

<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties are read-only.

</div></div></div>


<!-- reusable-table-boundary -->

---
---

### PromotionDiscountStep
<!-- reusable-table-boundary -->

**Declared In:**  
lib/model/promotions/promotion_discount_step.dart
  
**Related To:**  
[PromotionDiscountModeDetails](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotiondiscountmodedetails)  
  
**Declaration:**  

<pre><code class="language-Dart">class PromotionDiscountStep</code></pre>

  
**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **discountValue** | int | no | Value of the discount |
| **usageThreshold** | int | no | Usage threshold |
  

<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties are read-only.

</div></div></div>


<!-- reusable-table-boundary -->

---
---

### PromotionDiscountUsageTrigger
**Declared In:**  
lib/enums/promotions/promotion_discount_usage_trigger.dart 
  
**Related To:**  
[PromotionDiscountModeDetails](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotiondiscountmodedetails)  

**Declaration:**  

<pre><code class="language-Dart">enum PromotionDiscountUsageTrigger {
  transaction('TRANSACTION'),
  redeem('REDEEM');</code></pre>

  
**Functions:**
Converts from **PromotionDiscountUsageTrigger** to **String**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-166">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-166-0" data-tab-group="tabgrp-166" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-166-0" data-tab-group="tabgrp-166" data-tab-active="true">

```Dart
String promotionDiscountUsageTriggerAsString() {
```

</div>
</div>


---

Converts from **String** to **PromotionDiscountUsageTrigger**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-167">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-167-0" data-tab-group="tabgrp-167" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-167-0" data-tab-group="tabgrp-167" data-tab-active="true">

```Dart
static PromotionDiscountUsageTrigger getPromotionDiscountUsageTriggerFromString(String string) {
```

</div>
</div>


---
---

### PromotionImage 
<!-- reusable-table-boundary -->

**Declared In:**  
lib/model/promotions/promotion_image.dart
  
**Related To:**  
[Promotion](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotion)  
[PromotionImageType](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotionimagetype)  
  
**Declaration:**  

<pre><code class="language-Dart">class PromotionImage</code></pre>

  
**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **url** | String | no | Image's URL |
| **type** | [PromotionImageType](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotionimagetype) | no | Image type |
  

<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties are read-only.

</div></div></div>


<!-- reusable-table-boundary -->

---
---

### PromotionImageType
**Declared In:**  
lib/enums/promotions/promotion_image_type.dart
  
**Related To:**  
[Promotion](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotion)  
  
**Declaration:**  

<pre><code class="language-Dart">enum PromotionImageType {
  image('image'),
  thumbnail('thumbnail'),
  large('large'),
  unknown('UNKNOWN');</code></pre>

  
**Functions:**
Converts from **PromotionImageType** to **String**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-168">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-168-0" data-tab-group="tabgrp-168" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-168-0" data-tab-group="tabgrp-168" data-tab-active="true">

```Dart
String promotionImageTypeAsString() {
```

</div>
</div>


---

Converts from **String** to **PromotionImageType**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-169">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-169-0" data-tab-group="tabgrp-169" data-tab-active="true">Swift</button></div>

<div class="tab-panel" data-tab-id="tabgrp-169-0" data-tab-group="tabgrp-169" data-tab-active="true">

```Swift
static PromotionImageType getPromotionImageTypeFromString(String string)
```

</div>
</div>


---
---

### PromotionIdentifier
<!-- reusable-table-boundary -->

**Declared In:**  
lib/model/promotions/promotion_identifier.dart
  
**Declaration:**  

<pre><code class="language-Dart">class PromotionIdentifier {
  PromotionIdentifierKey key;
  String value;
}</code></pre>

  
**Properties:**

Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **key** | String | yes |  | Promotion identifier type (see [PromotionIdentifierKey enum](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotionidentifierkey))|
| **value** | String | yes |  | Promotion identifier value |

**Initializers:**

<pre><code class="language-Dart">PromotionIdentifier({required this.key, required this.value});</code></pre>


<!-- reusable-table-boundary -->

---
---

### PromotionIdentifierKey
**Declared In:**  
lib/enums/promotions/promotion_identifier_key.dart
  
**Declaration:**  

<pre><code class="language-Dart">enum PromotionIdentifierKey {
  uuid('UUID'),
  code('CODE');
}</code></pre>


---
---

### PromotionsApiQuery
<!-- reusable-table-boundary -->

Object for setting parameters to facilitate fetching promotions from the API.
  
**Declared In:**  
lib/model/promotions/promotions_api_query.dart

**Related To:**  
[PromotionResponse](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotionresponse)  
[Promotion](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotion)  
  
**Declaration:**

<pre><code class="language-Dart">class PromotionsApiQuery</code></pre>

  
**Properties:**
| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **statuses** | List<[PromotionStatus](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotionstatus)> | no  | [] | List of promotion statuses for query |
| **types** | List<[PromotionType](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#promotiontype)> | no  | [] | List of promotion types for query |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

- Check the list of promotion sorting keys available in [Loyalty - Promotion sorting options](/developers/mobile-sdk/loyalty#promotion-sorting-options) section.
- See [ApiQuerySortingOrderString](/developers/mobile-sdk/class-reference/flutter/miscellaneous#apiquerysortingorder) to check ordering options.

</div></div></div>


**Initializers:**

<pre><code class="language-Dart">PromotionsApiQuery(
      {required this.statuses,
      required this.types,
      required super.sorting,
      required super.limit,
      required super.page,
      required super.includeMeta});</code></pre>


<!-- reusable-table-boundary -->

---
---

## Vouchers
---

### AssignVoucherResponse
<!-- reusable-table-boundary -->

**Declared In:**  
lib/model/vouchers/assign_voucher_response.dart  
  
**Related To:**  
[AssignVoucherData](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#assignvoucherdata)
  
**Declaration:**

<pre><code class="language-Dart">class AssignVoucherResponse</code></pre>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **message** | String | no | Message from the Voucher assignment response |
| **assignVoucherData** | [AssignVoucherData](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#assignvoucherdata) | yes | List of vouchers in a pool |

<!-- reusable-table-boundary -->

---
---

### VoucherCodesResponse
<!-- reusable-table-boundary -->

**Declared In:**  
lib/model/vouchers/voucher_codes_response.dart

**Related To:**  
[VoucherCodesData](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#vouchercodesdata)    
  
**Declaration:**

<pre><code class="language-Dart">class VoucherCodesResponse</code></pre>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **items** | List<[VoucherCodesData](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#vouchercodesdata)> | no | List of voucher items |

<!-- reusable-table-boundary -->

---
---

### AssignVoucherData
<!-- reusable-table-boundary -->

**Declared In:**  
lib/model/vouchers/assign_voucher_data.dart  
  
**Related To:**  
[AssignVoucherResponse](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#assignvoucherresponse)

**Declaration:**  

<pre><code class="language-Dart">class AssignVoucherData</code></pre>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **code** | String | no | Voucher's code |
| **expireIn** | DateTime | yes | Voucher's expiration date |
| **redeemAt** | DateTime | yes | Voucher's redemption date |
| **assignedAt** | DateTime | yes | Voucher's assignment date |
| **createdAt** | DateTime | no | Voucher's creation date |
| **updatedAt** | DateTime | no | Voucher's update date |

<!-- reusable-table-boundary -->

---
---

### VoucherCodesData
<!-- reusable-table-boundary -->

**Declared In:**  
lib/model/vouchers/voucher_codes_data.dart
  
**Declaration:**

<pre><code class="language-Dart">class VoucherCodesData</code></pre>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **code** | String | no | Voucher's code |
| **status** | [VoucherCodeStatus](/developers/mobile-sdk/class-reference/flutter/promotions-and-vouchers#vouchercodestatus) | no | Voucher's status |
| **clientId** | String | no | ID of the customer to whom the voucher is assigned |
| **clientUuid** | String | no | UUID of the customer to whom the voucher is assigned |
| **poolUuid** | String | no | Voucher's pool ID |
| **expireIn** | String | no | Voucher's expiration date  |
| **redeemAt** | DateTime | no | Voucher's redemption date |
| **assignedAt** | DateTime | no | Voucher's assignment date |
| **createdAt** | DateTime | no | Voucher's creation date |
| **updatedAt** | DateTime | no | Voucher's update date|

<!-- reusable-table-boundary -->

---
---

### VoucherCodeStatus
**Declared In:**  
lib/enums/vouchers/voucher_code_status.dart

**Declaration:**  

<pre><code class="language-Dart">enum VoucherCodeStatus {
  unassigned('UNASSIGNED'),
  assigned('ASSIGNED'),
  redeemed('REDEEMED'),
  canceled('CANCELED');
}</code></pre>

  
**Functions:**

Converts from **VoucherCodeStatus** to **String**.

<pre><code class="language-Dart">String voucherCodeStatusAsString() {</code></pre>


---

Converts from **String** to **VoucherCodeStatus**.

<pre><code class="language-Dart">VoucherCodeStatus getVoucherCodeStatusFromString(String string) {</code></pre>





# Event tracking


---
## Set custom identifier for events
---
This method sets a custom identifier in the parameters of every event.

You can pass a custom identifier to match your customers in our database.
<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/tracker/tracker_impl.dart  
  
**Class:**  
[TrackerImpl](/developers/mobile-sdk/class-reference/flutter/modules#tracker)
  
**Declaration:**    

<pre><code class="language-Dart">Future&lt;void&gt; setCustomIdentifier(String customIdentifier)</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **identifier** | String | yes | - | Customer’s custom identifier |
  
**Return Value:**  
No value is returned.
  
**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-999">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-999-0" data-tab-group="tabgrp-999" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-999-0" data-tab-group="tabgrp-999" data-tab-active="true">

```Dart
await Synerise.tracker.setCustomIdentifier("CUSTOM_IDENTIFIER");
```

</div>
</div>


<!-- reusable-table-boundary -->

## Set custom email for events
---
This method sets a custom email in the parameters of every event.

You can pass a custom email to match your customers in our database.
<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/tracker/tracker_impl.dart  
  
**Class:**  
[TrackerImpl](/developers/mobile-sdk/class-reference/flutter/modules#tracker)
  
**Declaration:**    

<pre><code class="language-Dart">Future&lt;void&gt; setCustomEmail(String customEmail)</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | String | yes | - | Customer’s custom email |
  
**Return Value:**  
No value is returned.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1000">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1000-0" data-tab-group="tabgrp-1000" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1000-0" data-tab-group="tabgrp-1000" data-tab-active="true">

```Dart
await Synerise.tracker.setCustomEmail("CUSTOM_EMAIL");
```

</div>
</div>


<!-- reusable-table-boundary -->

## Send event
---
This method sends an event.


<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

DO NOT send `transaction.charge` events as custom events.<br>
Transactions must be tracked with these endpoints:
- [`/v4/transactions`](https://hub.synerise.com/api-reference/data-management#tag/Events/operation/CreateATransaction) (single transaction)
- [`/v4/transactions/batch`](https://hub.synerise.com/api-reference/data-management#tag/Events/operation/BatchAddOrUpdateTransactions) (multiple transactions)

</div></div></div>

  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

- The tracker caches and enqueues all your events locally, so they all will be sent eventually.
- The API key must have the `API_BATCH_EVENTS_CREATE` permission from the **Events** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/modules/tracker/tracker_impl.dart  
  
**Related To:**  
[Event](/developers/mobile-sdk/class-reference/flutter/events#event)  
[CustomEvent](/developers/mobile-sdk/class-reference/flutter/events#customevent)  
  
**Class:**  
[TrackerImpl](/developers/mobile-sdk/class-reference/flutter/modules#tracker)
  
**Declaration:**    

<pre><code class="language-Dart">Future&lt;void&gt; send(Event event)</code></pre>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **event** | [Event](/developers/mobile-sdk/class-reference/flutter/events#event) | yes | - | Event object |

**Return Value:**  
No value is returned.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1001">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1001-0" data-tab-group="tabgrp-1001" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1001-0" data-tab-group="tabgrp-1001" data-tab-active="true">

```Dart
final paramMap = <String, String>{"firstKeyCustomParam": "TEST"};
CustomEvent event = CustomEvent("label", "flutter", paramMap);
await Synerise.tracker.send(event);
```

</div>
</div>


<!-- reusable-table-boundary -->

## Flush events from Tracker
---
This method forces sending the events from the queue to the server.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `API_BATCH_EVENTS_CREATE` permission from the **Events** group.

</div></div></div>

**Declared In:**  
lib/modules/tracker/tracker_impl.dart  
  
**Related To:**  
[Event](/developers/mobile-sdk/class-reference/flutter/events#event)  
[CustomEvent](/developers/mobile-sdk/class-reference/flutter/events#customevent)  
  
**Class:**  
[TrackerImpl](/developers/mobile-sdk/class-reference/flutter/modules#tracker)
  
**Declaration:**  

<pre><code class="language-Dart">Future&lt;void&gt; flush()</code></pre>

  
**Return Value:**  
No value is returned.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1002">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1002-0" data-tab-group="tabgrp-1002" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1002-0" data-tab-group="tabgrp-1002" data-tab-active="true">

```Dart
await Synerise.tracker.flush();
```

</div>
</div>
 



# Event tracking


---
## Set custom identifier for events
---
This method sets a custom identifier in the parameters of every event.

You can pass a custom identifier to match your customers in our database.
<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/TrackerModule.js
  
**Class:**  
[TrackerModule](/developers/mobile-sdk/class-reference/react-native/modules#tracker)
  
**Declaration:**  

<pre><code class="language-TypeScript">public setCustomIdentifier(identifier: string)</code></pre>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **identifier** | string | yes | - | Customer's custom identifier |
  
**Return Value:**  
No value is returned.
  
**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1256">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1256-0" data-tab-group="tabgrp-1256" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1256-0" data-tab-group="tabgrp-1256" data-tab-active="true">

```JavaScript
Synerise.Tracker.setCustomIdentifier("CUSTOM_IDENTIFIER");
```

</div>
</div>


<!-- reusable-table-boundary -->

## Set custom email for events
---
This method sets a custom email in the parameters of every event.

You can pass a custom email to match your customers in our database.
<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/TrackerModule.js
  
**Class:**  
[TrackerModule](/developers/mobile-sdk/class-reference/react-native/modules#tracker)
  
**Declaration:**  

<pre><code class="language-TypeScript">public setCustomEmail(email: string)</code></pre>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **email** | string | yes | - | Customer's custom email |
  
**Return Value:**  
No value is returned.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1257">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1257-0" data-tab-group="tabgrp-1257" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1257-0" data-tab-group="tabgrp-1257" data-tab-active="true">

```JavaScript
Synerise.Tracker.setCustomEmail("CUSTOM_EMAIL");
```

</div>
</div>


<!-- reusable-table-boundary -->

## Send event
---
This method sends an event.


<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

DO NOT send `transaction.charge` events as custom events.<br>
Transactions must be tracked with these endpoints:
- [`/v4/transactions`](https://hub.synerise.com/api-reference/data-management#tag/Events/operation/CreateATransaction) (single transaction)
- [`/v4/transactions/batch`](https://hub.synerise.com/api-reference/data-management#tag/Events/operation/BatchAddOrUpdateTransactions) (multiple transactions)

</div></div></div>

  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

- The tracker caches and enqueues all your events locally, so they all will be sent eventually.
- The API key must have the `API_BATCH_EVENTS_CREATE` permission from the **Events** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/TrackerModule.js

**Related To:**  
[Event](/developers/mobile-sdk/class-reference/react-native/events#event)  
[CustomEvent](/developers/mobile-sdk/class-reference/react-native/events#customevent)  
  
**Class:**  
[TrackerModule](/developers/mobile-sdk/class-reference/react-native/modules#tracker)
  
**Declaration:**  

<pre><code class="language-TypeScript">public send(event: Event)</code></pre>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **event** | **Event** | yes | - | Event object |
  
**Return Value:**  
No value is returned.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1258">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1258-0" data-tab-group="tabgrp-1258" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1258-0" data-tab-group="tabgrp-1258" data-tab-active="true">

```JavaScript
let parameters = {
  "name": "John",
  "surname": "Rise",
  "company": "Synerise",
  "age": 25,
  "lastOrder": 380.50
};

let event = new CustomEvent("label", "my.action", parameters);
Synerise.Tracker.send(event);
```

</div>
</div>


<!-- reusable-table-boundary -->

## Flush events from Tracker
---
This method forces sending the events from the queue to the server.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `API_BATCH_EVENTS_CREATE` permission from the **Events** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
lib/main/modules/TrackerModule.js
  
**Class:**  
[TrackerModule](/developers/mobile-sdk/class-reference/react-native/modules#tracker)
  
**Declaration:**  

<pre><code class="language-TypeScript">public flushEvents(onSuccess: () =&gt; void)</code></pre>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **onSuccess** | Function | no | - | Function to be executed when the operation is completed successfully |

**Return Value:**  
No value is returned.
  
**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1259">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1259-0" data-tab-group="tabgrp-1259" data-tab-active="true">JavaScript</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1259-0" data-tab-group="tabgrp-1259" data-tab-active="true">

```JavaScript
Synerise.Tracker.flushEvents(function() {
  // success
});
```

</div>
</div>


<!-- reusable-table-boundary --> 



# Customer session


## Refresh customer token
---
This method refreshes the customer’s current token.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns an error if the token has expired and cannot be refreshed.

</div></div></div>

**Method name:**  
Client.refreshToken()
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-870">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-870-0" data-tab-group="tabgrp-870" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-870-1" data-tab-group="tabgrp-870">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-870-0" data-tab-group="tabgrp-870" data-tab-active="true">

```Java
public static IApiCall refreshToken()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-870-1" data-tab-group="tabgrp-870">

```Kotlin
fun refreshToken():IApiCall
```

</div>
</div>


**Parameters:**  
No parameters required.

**Return Value:**  
[IApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#iapicall) object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-871">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-871-0" data-tab-group="tabgrp-871" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-871-1" data-tab-group="tabgrp-871">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-871-0" data-tab-group="tabgrp-871" data-tab-active="true">

```Java
boolean success = Client.refreshToken();
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-871-1" data-tab-group="tabgrp-871">

```Kotlin
var success = Client.refreshToken()
```

</div>
</div>


## Retrieve customer token
---
This method retrieves the customer’s current, active token.
  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

Returns an error if the token has expired and cannot be retrieved.

</div></div></div>

**Method name:**  
Client.retrieveToken()


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This method replaces `Client.getToken()`.

</div></div></div>

  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-872">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-872-0" data-tab-group="tabgrp-872" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-872-1" data-tab-group="tabgrp-872">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-872-0" data-tab-group="tabgrp-872" data-tab-active="true">

```Java
public static IDataApiCall<Token> retrieveToken()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-872-1" data-tab-group="tabgrp-872">

```Kotlin
fun retrieveToken():IDataApiCall<Token>
```

</div>
</div>


**Parameters:**  
No parameters required.

**Return Value:**  
[IDataApiCall](/developers/mobile-sdk/method-reference/android/public-interfaces#idataapicall)<[Token](/developers/mobile-sdk/class-reference/android/client#token)> object to execute the request.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-873">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-873-0" data-tab-group="tabgrp-873" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-873-1" data-tab-group="tabgrp-873">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-873-0" data-tab-group="tabgrp-873" data-tab-active="true">

```Java
IDataApiCall retrieveTokenCall = Client.retrieveToken();
        retrieveTokenCall.execute(success -> onSuccess(), this::onFailure);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-873-1" data-tab-group="tabgrp-873">

```Kotlin
val retrieveTokenCall = Client.retrieveToken()
retrieveTokenCall.execute({ success-> onSuccess() }, ({ this.onFailure() }))
```

</div>
</div>


## Get current customer UUID
---
This method retrieves the customer’s current UUID.
**Method name:**  
Client.getUuid()
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-874">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-874-0" data-tab-group="tabgrp-874" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-874-1" data-tab-group="tabgrp-874">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-874-0" data-tab-group="tabgrp-874" data-tab-active="true">

```Java
public static String getUuid()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-874-1" data-tab-group="tabgrp-874">

```Kotlin
fun getUuid():String
```

</div>
</div>


**Parameters:**  
No parameters required.

**Return Value:**  
Customer's UUID as a string.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-875">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-875-0" data-tab-group="tabgrp-875" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-875-1" data-tab-group="tabgrp-875">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-875-0" data-tab-group="tabgrp-875" data-tab-active="true">

```Java
Client.getUuid()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-875-1" data-tab-group="tabgrp-875">

```Kotlin
Client.getUuid()
```

</div>
</div>


## Get customer UUID for use in authentication
---
<!-- reusable-table-boundary -->

This method retrieves the current UUID or generates a new one from a seed.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 4.15.0 | 5.15.0 | n/a | n/a |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This operation doesn't affect the customer session in the SDK.

</div></div></div>


<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Method name:**  
Client.getUuidForAuthentication()
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-876">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-876-0" data-tab-group="tabgrp-876" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-876-1" data-tab-group="tabgrp-876">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-876-0" data-tab-group="tabgrp-876" data-tab-active="true">

```Java
public static String getUuidForAuthentication(@NonNull String authId)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-876-1" data-tab-group="tabgrp-876">

```Kotlin
fun getUuidForAuthentication(
        authId: String
    ): String
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **authId** | String | yes | --- | Seed for UUID generation |

**Return Value:**  
The UUID for use in authentication as a string.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-877">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-877-0" data-tab-group="tabgrp-877" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-877-1" data-tab-group="tabgrp-877">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-877-0" data-tab-group="tabgrp-877" data-tab-active="true">

```Java
Client.getUuidForAuthentication(authId)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-877-1" data-tab-group="tabgrp-877">

```Kotlin
Client.getUuidForAuthentication(authId)
```

</div>
</div>


<!-- reusable-table-boundary -->

## Regenerate customer
---
<!-- reusable-table-boundary -->

This method regenerates the UUID and clears the authentication token, login session, custom email, and custom identifier.
  
This operation works only if the customer is anonymous.

This operation clears the authentication token, login (if applicable), custom email, and custom identifier.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.3.10 | 3.3.5 | 0.9.0 | 0.7.0 |

<!-- reusable-table-boundary -->
**Method name:**  
Client.regenerateUuid()
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-878">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-878-0" data-tab-group="tabgrp-878" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-878-1" data-tab-group="tabgrp-878">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-878-0" data-tab-group="tabgrp-878" data-tab-active="true">

```Java
public static boolean regenerateUuid()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-878-1" data-tab-group="tabgrp-878">

```Kotlin
fun regenerateUuid():Boolean
```

</div>
</div>


**Parameters:**  
No parameters required.

**Return Value:**  
Returns true if the current Customer is anonymous and the operation succeeds.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-879">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-879-0" data-tab-group="tabgrp-879" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-879-1" data-tab-group="tabgrp-879">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-879-0" data-tab-group="tabgrp-879" data-tab-active="true">

```Java
boolean success = Client.regenerateUuid();
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-879-1" data-tab-group="tabgrp-879">

```Kotlin
var success = Client.regenerateUuid()
```

</div>
</div>


## Regenerate customer with identifier
---
<!-- reusable-table-boundary -->

This method regenerates the UUID and clears the authentication token, login session, custom email, and custom identifier.
  
This operation works only if the customer is anonymous.
  
This operation clears the authentication token, login (if applicable), custom email, and custom identifier
  
The optional `clientIdentifier` parameter is a seed for UUID generation.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.6.5 | 3.6.4 | 0.9.10 | 0.7.2 |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

**Method name:**  
Client.regenerateUuid(clientIdentifier)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-880">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-880-0" data-tab-group="tabgrp-880" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-880-1" data-tab-group="tabgrp-880">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-880-0" data-tab-group="tabgrp-880" data-tab-active="true">

```Java
public static boolean regenerateUuid(clientIdentifier)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-880-1" data-tab-group="tabgrp-880">

```Kotlin
fun regenerateUuid(clientIdentifier):Boolean
```

</div>
</div>


**Parameters:**  
| Parameter | Type | Mandatory | Description |
| --- | --- | --- | --- |
| **clientIdentifier** | String | no | Seed for UUID generation |


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The **clientIdentifier** parameter is used for decreasing the number of UUID refreshes, so it must be unique for every customer.

</div></div></div>

  
**Return Value:**  
Returns true if the current Client is anonymous and the operation succeeds.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-881">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-881-0" data-tab-group="tabgrp-881" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-881-1" data-tab-group="tabgrp-881">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-881-0" data-tab-group="tabgrp-881" data-tab-active="true">

```Java
boolean success = Client.regenerateUuid(clientIdentifier);
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-881-1" data-tab-group="tabgrp-881">

```Kotlin
var success = Client.regenerateUuid(clientIdentifier)
```

</div>
</div>


<!-- reusable-table-boundary -->

## Destroy current session
---
This method destroys the session completely.

This method clears all session data (both client and anonymous) and removes cached data. Then, it regenerates the UUID and creates the new anonymous session.
**Method name:**  
Client.destroySession()
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-882">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-882-0" data-tab-group="tabgrp-882" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-882-1" data-tab-group="tabgrp-882">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-882-0" data-tab-group="tabgrp-882" data-tab-active="true">

```Java
public static void destroySession()
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-882-1" data-tab-group="tabgrp-882">

```Kotlin
fun destroySession()
```

</div>
</div>


**Parameters:**  
No parameters required.


**Return Value:**  
Method is void type.

**Example:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-883">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-883-0" data-tab-group="tabgrp-883" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-883-1" data-tab-group="tabgrp-883">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-883-0" data-tab-group="tabgrp-883" data-tab-active="true">

```Java
Client.destroySession();
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-883-1" data-tab-group="tabgrp-883">

```Kotlin
Client.destroySession()
```

</div>
</div>




# Profile identification, authentication, and management




# Promotions and Vouchers


## Promotions
---

### PromotionResponse
<!-- reusable-table-boundary -->

Class model for a promotion response.

**Declared In:**  
`com.synerise.sdk.promotions.model.promotion.PromotionResponse`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-130">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-130-0" data-tab-group="tabgrp-130" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-130-1" data-tab-group="tabgrp-130">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-130-0" data-tab-group="tabgrp-130" data-tab-active="true">

```Java
public class PromotionResponse
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-130-1" data-tab-group="tabgrp-130">

```Kotlin
class PromotionResponse
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **promotionMetadata** | [PromotionMetadata](/developers/mobile-sdk/class-reference/android/promotions-and-vouchers#promotionmetadata) | no | - | Metadata |
| **promotions** | List<[Promotion](/developers/mobile-sdk/class-reference/android/promotions-and-vouchers#promotion)> | no | - | List of promotions |



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All the properties above are accessible by using getters.

</div></div></div>


**Initializers:**  

There are no initializers.

**Methods:**  

This method retrieves the value of the `promotionMetadata` parameter.


<pre><code class="language-java">public PromotionMetadata getPromotionMetadata()</code></pre>


---

This method retrieves a list of promotions.


<pre><code class="language-java">public List&lt;Promotion&gt; getPromotions()</code></pre>


---

<!-- reusable-table-boundary -->

---
---

### SinglePromotionResponse
<!-- reusable-table-boundary -->

Class model for a single promotion response.

**Declared In:**  
`com.synerise.sdk.promotions.model.promotion.SinglePromotionResponse`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-131">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-131-0" data-tab-group="tabgrp-131" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-131-1" data-tab-group="tabgrp-131">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-131-0" data-tab-group="tabgrp-131" data-tab-active="true">

```Java
public class SinglePromotionResponse
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-131-1" data-tab-group="tabgrp-131">

```Kotlin
class SinglePromotionResponse
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **promotion** | [Promotion](/developers/mobile-sdk/class-reference/android/promotions-and-vouchers#promotion) | no | - | Promotion  |




<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All the properties above are accessible by using getters and setters.

</div></div></div>


**Initializers:**  

There are no initializers.

**Methods:**  

There are only getters and setters for the above properties.

This method retrieves the value of the `promotion` parameter. 


<pre><code class="language-java">public Promotion getPromotion()</code></pre>


---

This method defines the value of the `promotion` parameter.


<pre><code class="language-java">public void setPromotion(Promotion data)</code></pre>


---

<!-- reusable-table-boundary -->

---
---

### PromotionMetadata
<!-- reusable-table-boundary -->

Class model for a promotion metadata.

**Declared In:**  
`com.synerise.sdk.promotions.model.promotion.PromotionMetadata`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-132">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-132-0" data-tab-group="tabgrp-132" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-132-1" data-tab-group="tabgrp-132">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-132-0" data-tab-group="tabgrp-132" data-tab-active="true">

```Java
public class PromotionMetadata implements Serializable
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-132-1" data-tab-group="tabgrp-132">

```Kotlin
class PromotionMetadata : Serializable
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **totalCount** | int | no | - | Total count of promotions |
| **totalPages** | int | no | - | Total count of pages |
| **page** | int | no | - | Page |
| **limit** | int | no | - | Limit of promotions per page |
| **code** | int | no | - | Code |




<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All the properties above are accessible by using getters.

</div></div></div>


**Initializers:**  

There are no initializers.

**Methods:**  

This method retrieves the value of the `totalCount` parameter.


<pre><code class="language-java">public int getTotalCount()</code></pre>


---

This method retrieves the value of the `totalPages` parameter.


<pre><code class="language-java">public int getTotalPages()</code></pre>


---

This method retrieves the value of the `page` parameter.


<pre><code class="language-java">public int getPage()</code></pre>


---

This method retrieves the value of the `limit` parameter.


<pre><code class="language-java">public int getLimit()</code></pre>


---

This method retrieves the value of the `code` parameter.


<pre><code class="language-java">public int getCode()</code></pre>


---

<!-- reusable-table-boundary -->

---
---

### Promotion
<!-- reusable-table-boundary -->

Class model for a promotion.

**Declared In:**  
`com.synerise.sdk.promotions.model.promotion.Promotion`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-133">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-133-0" data-tab-group="tabgrp-133" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-133-1" data-tab-group="tabgrp-133">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-133-0" data-tab-group="tabgrp-133" data-tab-active="true">

```Java
public class Promotion extends BaseModel implements Serializable
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-133-1" data-tab-group="tabgrp-133">

```Kotlin
class Promotion : BaseModel, Serializable
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **uuid** | String | no | - | Promotion UUID |
| **code** | String | no | - | Promotion code |
| **status** | String | no | - | Promotion status |
| **type** | String | no | - | Promotion type |
| **redeemLimitPerClient** | int | no | - | Redemption limit per client |
| **redeemQuantityPerActivation** | int | no | - | Redemption quantity per activation |
| **currentRedeemedQuantity** | int | no | - | Current redeemed quantity |
| **currentRedeemLimit** | int | no | - | Current redemption limit |
| **activationCounter** | int | no | - | Activation counter |
| **discountType** | String | no | - | Discount type |
| **discountValue** | int | no | - | Discount value |
| **requireRedeemedPoints** | int | no | - | Required redeemed points |
| **name** | String | no | - | Promotion name |
| **headline** | String | no | - | Promotion headline |
| **description** | String | no | - | Promotion description |
| **images** | List<PromotionImage> | no | - | List of promotion images |
| **startAt** | Date | no | - | Start time of a promotion |
| **expireAt** | Date | no | - | Expiration time of a promotion |
| **lastingAt** | Date | no | - | How long a promotion lasts |
| **params** | HashMap<String, Object> | no | - | Promotion custom parameters |
| **catalogIndexItems** | List<String> | no | - | List of item indexes |
| **price** | long | no | - | Item price |
| **priority** | int | no | - | Promotion priority |



<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All the properties above are accessible by using getters.

</div></div></div>


**Initializers:**  

There are no initializers.

**Methods:**  

There are only getters for the above properties.

---

<!-- reusable-table-boundary -->

---
---

### PromotionStatus
<!-- reusable-table-boundary -->

This enum contains values for a promotion status.

**Declared In:**  
`com.synerise.sdk.promotions.model.promotion.PromotionStatus`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-134">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-134-0" data-tab-group="tabgrp-134" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-134-1" data-tab-group="tabgrp-134">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-134-0" data-tab-group="tabgrp-134" data-tab-active="true">

```Java
public enum PromotionStatus
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-134-1" data-tab-group="tabgrp-134">

```Kotlin
public enum PromotionStatus
```

</div>
</div>


**Values:**

| Property | Value | Description |
| --- | --- | --- |
| **ASSIGNED** | "ASSIGNED" | Promotion status |
| **ACTIVE** | "ACTIVE" | Promotion status |
| **REDEEMED** | "REDEEMED" | Promotion status |
| **UNKNOWN** | "UNKNOWN" | Promotion status |


**Methods:**  

This method retrieves a promotion status.


<pre><code class="language-java">public static PromotionStatus getByPromotionStatus(String status)</code></pre>


---

<!-- reusable-table-boundary -->

---
---

### PromotionType
<!-- reusable-table-boundary -->

This enum contains values for a promotion type.

**Declared In:**  
`com.synerise.sdk.promotions.model.promotion.PromotionType`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-135">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-135-0" data-tab-group="tabgrp-135" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-135-1" data-tab-group="tabgrp-135">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-135-0" data-tab-group="tabgrp-135" data-tab-active="true">

```Java
public enum PromotionType
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-135-1" data-tab-group="tabgrp-135">

```Kotlin
public enum PromotionType
```

</div>
</div>


**Values:**

| Property | Value | Description |
| --- | --- | --- |
| **GENERAL** | "GENERAL" | Promotion type |
| **CUSTOM** | "CUSTOM" | Promotion type |
| **MEMBERS_ONLY** | "MEMBERS_ONLY" | Promotion type |
| **UNKNOWN** | "UNKNOWN" | Promotion type |


**Methods:**  

This method retrieves a promotion type.


<pre><code class="language-java">public static PromotionType getByPromotionType(String type)</code></pre>


---

<!-- reusable-table-boundary -->

---
---

### PromotionIdentifier
<!-- reusable-table-boundary -->

Class model for a promotion identifier.

**Declared In:**  
`com.synerise.sdk.promotions.model.promotion.PromotionIdentifier`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-136">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-136-0" data-tab-group="tabgrp-136" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-136-1" data-tab-group="tabgrp-136">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-136-0" data-tab-group="tabgrp-136" data-tab-active="true">

```Java
public class PromotionIdentifier implements Serializable
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-136-1" data-tab-group="tabgrp-136">

```Kotlin
class PromotionIdentifier : Serializable
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **key** | String | no | - | Promotion key identifier |
| **value** | String | no | - | Promotion identifier value |


**Initializers:**  

There is a constructor.

**Methods:**  

There are no methods.

<!-- reusable-table-boundary -->

---
---

### PromotionsApiQuery
<!-- reusable-table-boundary -->

Class responsible for creating a promotion query.

**Declared In:**  
`com.synerise.sdk.promotions.model.promotion.PromotionsApiQuery`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-137">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-137-0" data-tab-group="tabgrp-137" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-137-1" data-tab-group="tabgrp-137">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-137-0" data-tab-group="tabgrp-137" data-tab-active="true">

```Java
public class PromotionsApiQuery
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-137-1" data-tab-group="tabgrp-137">

```Kotlin
class PromotionsApiQuery
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **statuses** | List<[PromotionStatus](/developers/mobile-sdk/class-reference/android/promotions-and-vouchers#promotionstatus)> | yes | - | List of promotion states |
| **types** | List<[PromotionType](/developers/mobile-sdk/class-reference/android/promotions-and-vouchers#promotiontype)> | yes | - | List of promotion types |
| **sortParameters** | LinkedHashMap<PromotionSortingKey, [ApiQuerySortingOrder](/developers/mobile-sdk/class-reference/android/miscellaneous#apiquerysortingorder)> | yes | - | Sort parameters. If you add more than one sorting attribute, the importance of each attribute depends on its position. The first one is the most important. |
| **limit** | int | no | 100 | Limit of promotions per page |
| **page** | int | no | 1 | Page number |
| **includeMeta** | Boolean | no | false | If true, the response includes metadata |




<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All the properties above are accessible by using setters.

</div></div></div>


**Initializers:**  

There are no initializers.

**Methods:**  

There are only setters for above properties.

<!-- reusable-table-boundary -->

---
---

## Vouchers
---

### AssignVoucherResponse
<!-- reusable-table-boundary -->

Class model of AssignVoucherResponse.

**Declared In:**  
`com.synerise.sdk.promotions.model.AssignVoucherResponse`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-138">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-138-0" data-tab-group="tabgrp-138" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-138-1" data-tab-group="tabgrp-138">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-138-0" data-tab-group="tabgrp-138" data-tab-active="true">

```Java
public class AssignVoucherResponse
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-138-1" data-tab-group="tabgrp-138">

```Kotlin
class AssignVoucherResponse
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **message** | String | no | - | Message  |
| **data** | [AssignVoucherData](/developers/mobile-sdk/class-reference/android/promotions-and-vouchers#assignvoucherdata) | no | - | Voucher data  |




<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All the properties above are accessible by using getters.

</div></div></div>


**Initializers:**  

There are no initializers.

**Methods:**  

There are only getters for the above properties.

This method retrieves the value of the `message` parameter. 


<pre><code class="language-java">public String getMessage()</code></pre>


---

This method retrieves the value of the `data` parameter.


<pre><code class="language-java">public AssignVoucherData getData()</code></pre>


---

<!-- reusable-table-boundary -->

---
---

### VoucherCodesResponse
<!-- reusable-table-boundary -->

Class model of VoucherCodesResponse.

**Declared In:**  
`com.synerise.sdk.promotions.model.VoucherCodesResponse`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-139">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-139-0" data-tab-group="tabgrp-139" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-139-1" data-tab-group="tabgrp-139">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-139-0" data-tab-group="tabgrp-139" data-tab-active="true">

```Java
public class VoucherCodesResponse
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-139-1" data-tab-group="tabgrp-139">

```Kotlin
class VoucherCodesResponse
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **data** | List<[VoucherCodesData](/developers/mobile-sdk/class-reference/android/promotions-and-vouchers#vouchercodesdata)> | no | - | Voucher data  |




<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All the properties above are accessible by using getters.

</div></div></div>


**Initializers:**  

There are no initializers.

**Methods:**  

There are only getters for the above properties.

This method retrieves the list of values of the `data` parameter.


<pre><code class="language-java">public List&lt;VoucherCodesData&gt; getData()</code></pre>


---

<!-- reusable-table-boundary -->

---
---

### AssignVoucherData
<!-- reusable-table-boundary -->

Class model of AssignVoucherData.

**Declared In:**  
`com.synerise.sdk.promotions.model.AssignVoucherData`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-140">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-140-0" data-tab-group="tabgrp-140" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-140-1" data-tab-group="tabgrp-140">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-140-0" data-tab-group="tabgrp-140" data-tab-active="true">

```Java
public class AssignVoucherData
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-140-1" data-tab-group="tabgrp-140">

```Kotlin
class AssignVoucherData
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **code** | String | no | - | Code  |
| **expireIn** | Date | no | - | Date of expiration  |
| **redeemAt** | Date | no | - | Redemption at date  |
| **assignedAt** | Date | no | - | Date of assigning voucher  |
| **createdAt** | Date | no | - | Date of creation  |
| **updatedAt** | Date | no | - | Date of voucher update  |




<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All the properties above are accessible by using getters.

</div></div></div>


**Initializers:**  

There are no initializers.

**Methods:**  

There are only getters for the above properties.

This method retrieves the value of the `code` parameter. 


<pre><code class="language-java">public String getCode()</code></pre>


---

This method retrieves the value of the `ExpireIn` parameter.


<pre><code class="language-java">public Date getExpireIn()</code></pre>


---

This method retrieves the value of the `RedeemAt` parameter.


<pre><code class="language-java">public Date getRedeemAt()</code></pre>


---

This method retrieves the value of the `AssignedAt` parameter.


<pre><code class="language-java">public Date getAssignedAt()</code></pre>


---

This method retrieves the value of the `CreatedAt` parameter.


<pre><code class="language-java">public Date getCreatedAt()</code></pre>


---

This method retrieves the value of the `UpdateAt` parameter.


<pre><code class="language-java">public Date getUpdatedAt()</code></pre>


---

<!-- reusable-table-boundary -->

---
---

### VoucherCodesData
<!-- reusable-table-boundary -->

Class model of VoucherCodesData.

**Declared In:**  
`com.synerise.sdk.promotions.model.VoucherCodesData`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-141">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-141-0" data-tab-group="tabgrp-141" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-141-1" data-tab-group="tabgrp-141">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-141-0" data-tab-group="tabgrp-141" data-tab-active="true">

```Java
public class VoucherCodesData
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-141-1" data-tab-group="tabgrp-141">

```Kotlin
class VoucherCodesData
```

</div>
</div>


**Properties:**  

| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **code** | String | no | - | Voucher code |
| **status** | String | no | - | Voucher status |
| **clientUuid** | String | no | - | Profile's UUID |
| **poolUuid** | String | no | - | Pool UUID |
| **expireIn** | Date | no | - | Voucher expiration date |
| **assignedAt** | Date | no | - | Voucher assignment date |
| **createdAt** | Date | no | - | Voucher creation date |
| **updatedAt** | Date | no | - | Voucher update date |




<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All the properties above are accessible by using getters.

</div></div></div>


**Initializers:**  

There are no initializers.

**Methods:**  

There are only getters for the above properties.

---

<!-- reusable-table-boundary -->

---
---

### VoucherCodesStatus
<!-- reusable-table-boundary -->

This enum contains values for a voucher code status.

**Declared In:**  
`com.synerise.sdk.client.model.client.VoucherCodeStatus`

**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-142">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-142-0" data-tab-group="tabgrp-142" data-tab-active="true">Java</button><button class="tab-button" data-tab-id="tabgrp-142-1" data-tab-group="tabgrp-142">Kotlin</button></div>

<div class="tab-panel" data-tab-id="tabgrp-142-0" data-tab-group="tabgrp-142" data-tab-active="true">

```Java
public enum VoucherCodeStatus
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-142-1" data-tab-group="tabgrp-142">

```Kotlin
public enum VoucherCodeStatus
```

</div>
</div>


**Values:**

| Property | Value | Description |
| --- | --- | --- |
| **ASSIGNED** | "ASSIGNED" | Assigned |
| **UNASSIGNED** | "UNASSIGNED" | Unassigned |
| **REDEEMED** | "REDEEMED" | Redeemed |
| **CANCELED** | "CANCELED" | Canceled |

**Methods:**  

This method retrieves the voucher status.


<pre><code class="language-java">public String getStatus()</code></pre>


---

This method retrieves the voucher status.


<pre><code class="language-java">public static VoucherCodeStatus getStatus(String status)</code></pre>


---

<!-- reusable-table-boundary -->


# Recommendations and Documents


## Recommendations
---

### RecommendationResponse
<!-- reusable-table-boundary -->

Model representing a response with recommendations.
  

<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This is a read-only class and it is not meant to be instantiated directly.

</div></div></div>

  
**Declared In:**  
lib/model/content/recommendation_response.dart  
  
**Related To:**  
[Recommendation](/developers/mobile-sdk/class-reference/flutter/recommendations-and-documents#recommendation)  
  
**Declaration:**

<pre><code class="language-Dart">class RecommendationResponse</code></pre>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **name** | String | no | Name of the recommendation campaign |
| **campaignHash** | String | no |  Hash (UUID) of the recommendation campaign |
| **campaignID** | String | no | ID of the recommendation campaign |
| **items** | List<[Recommendation](/developers/mobile-sdk/class-reference/flutter/recommendations-and-documents#recommendation)> | no | List of items in the recommendation |
| **correlationID** | String | no | Recommendation's correlation ID. It can be added to a `recommendation.click` event to associate it with the recommendation request |
| **schema** | String | no | Schema of the document which contains the recommendation |
| **slug** | String | no | Slug of the document |
| **uuid** | String | no | UUID of the document |

<!-- reusable-table-boundary -->

---
---

### Recommendation
<!-- reusable-table-boundary -->

Model representating a recommendation item data.
  

<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

This is a read-only class and it is not meant to be instantiated directly.

</div></div></div>

  
**Declared In:**  
lib/model/content/recommendation.dart  
  
**Related To:**  
[RecommendationResponse](/developers/mobile-sdk/class-reference/flutter/recommendations-and-documents#recommendationresponse)  
  
**Declaration:**

<pre><code class="language-Dart">class Recommendation</code></pre>


**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **itemID** | String | no | Product's GTIN |
| **attributes** | Map<String, Object> | no | Product's recommendation attributes |

<!-- reusable-table-boundary -->

---
---

### RecommendationOptions
<!-- reusable-table-boundary -->

**Declared In:**  
lib/model/content/recommendation_options.dart  

**Related To:**  
[RecommendationFiltersJoinerRule](/developers/mobile-sdk/class-reference/flutter/recommendations-and-documents#recommendationfiltersjoinerrule)  
  
**Declaration:**

<pre><code class="language-Dart">class RecommendationOptions</code></pre>


**Properties:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **slug** | String | no | Unique identifier of a document which includes a recommendation insert |
| **productID** | String | yes | Item identifier (for single ID) |
| **itemsIds** | List<String> | yes | List of item identifiers (for multiple IDs) |
| **itemsExcluded** | List<String> | yes | Items that will be excluded from the generated recommendations |
| **additionalFilters** | String | yes | Additional filters. These are merged with the campaign's own filters according to the logic in **filtersJoiner** |
| **filtersJoiner** | [RecommendationFiltersJoinerRule](/developers/mobile-sdk/class-reference/flutter/recommendations-and-documents#recommendationfiltersjoinerrule) | yes | Defines the logic of merging additionalFilters with the campaign's existing filters |
| **additionalElasticFilters** | String | yes | Additional elastic filters. These are merged with the campaign's own elastic filters according to the logic in **elasticFiltersJoiner** |
| **elasticFiltersJoiner** | [RecommendationFiltersJoinerRule](/developers/mobile-sdk/class-reference/flutter/recommendations-and-documents#recommendationfiltersjoinerrule) | yes | Defines the logic of merging **additionalElasticFilters** with the campaign's existing elastic filters |
| **displayAttribute** | List<String> | yes | An array of item attributes which value will be returned in a recommendation response |
| **includeContextItems** | bool | yes | When true, the recommendation response will include context item metadata |
  
**Initializers:**  

<pre><code class="language-Dart">RecommendationOptions recommendationOptions = RecommendationOptions(
        slug: slug,
        productID: productId);</code></pre>


<!-- reusable-table-boundary -->

---
---

### RecommendationFiltersJoinerRule
**Declared In:**  
lib/model/content/recommendation_options.dart

**Declaration:**  

<pre><code class="language-Dart">enum RecommendationFiltersJoinerRule {
  and('and'),
  or('or'),
  replace('replace');</code></pre>

  
**Functions:**
Converts from **RecommendationFiltersJoinerRule** to **String**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-170">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-170-0" data-tab-group="tabgrp-170" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-170-0" data-tab-group="tabgrp-170" data-tab-active="true">

```Dart
String recommendationFiltersJoinerRuleAsString()
```

</div>
</div>


Converts from **String** to **RecommendationFiltersJoinerRule**.

<div class="content-tabs code-tabs" data-tab-group="tabgrp-171">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-171-0" data-tab-group="tabgrp-171" data-tab-active="true">Dart</button></div>

<div class="tab-panel" data-tab-id="tabgrp-171-0" data-tab-group="tabgrp-171" data-tab-active="true">

```Dart
static RecommendationFiltersJoinerRule? getRecommendationFiltersJoinerRuleFromString(String string)
```

</div>
</div>


---
---

## Documents
---

---

### DocumentApiQuery
<!-- reusable-table-boundary -->

Object for setting parameters to facilitate fetching documents from the API.
  
**Declared In:**  
lib/model/content/document_api_query.dart
  
**Declaration:**

<pre><code class="language-Dart">class DocumentApiQuery</code></pre>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **slug** | String | no | Unique identifier of a document |

**Properties used only if the document includes a recommendation insert:**  
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **productId** | String | yes | Item identifier of the context item |
| **itemsIds** | List<string> | yes | List of item identifiers, used for multiple item context |
| **itemsExcluded** | List<string> | yes | Items that will be excluded from the generated recommendations |
| **additionalFilters** | String | yes | Additional filters. These are merged with the campaign's own filters according to the logic in **filtersJoiner** |
| **filtersJoiner** | [RecommendationFiltersJoinerRule](/developers/mobile-sdk/class-reference/flutter/recommendations-and-documents#recommendationfiltersjoinerrule) | no | Defines the logic of merging additionalFilters with the campaign's existing filters |
| **additionalElasticFilters** | String | yes | Additional elastic filters. These are merged with the campaign's own elastic filters according to the logic in **elasticFiltersJoiner** |
| **elasticFiltersJoiner** | [RecommendationFiltersJoinerRule](/developers/mobile-sdk/class-reference/flutter/recommendations-and-documents#recommendationfiltersjoinerrule) | no | Defines the logic of merging **additionalElasticFilters** with the campaign's existing elastic filters |
| **displayAttribute** | List<string> | yes | An array of item attributes which value will be returned in a recommendation response |
| **includeContextItems** | bool | yes | When true, the recommendation response will include context item metadata |
  
**Initializers:**

<pre><code class="language-TypeScript">DocumentApiQuery({
  required this.slug,
  this.productId,
  this.itemsIds,
  this.itemsExcluded,
  this.additionalFilters,
  this.filtersJoiner,
  this.additionalElasticFilters,
  this.elasticFiltersJoiner,
  this.displayAttribute,
  this.includeContextItems = false
});</code></pre>


<!-- reusable-table-boundary -->

---
---

### Document
<!-- reusable-table-boundary -->

**Declared In:**  
lib/model/content/document.dart
  
**Declaration:**  

<pre><code class="language-Dart">class Document</code></pre>

  
**Properties:**
| Property | Type | Optional | Description |
| --- | --- | --- | --- |
| **uuid** | String | no | Document's identifier (this parameter was called **identifier** before version 2.0.0)|
| **slug** | String | no | Document's slug |
| **schema** | String | no | Document's schema type |
| **content** | Map<String, Object> | yes | Document's content |
  

<div class="admonition admonition-important"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

All properties are read-only.

</div></div></div>


<!-- reusable-table-boundary -->

---
---

## Removed symbols
---

### <del>DocumentsApiQuery</del>{#documentsapiquery}
<!-- reusable-table-boundary -->

The object to set parameters easily for fetching documents from API.
  
| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.5.10 | 3.5.1 | 0.9.10 | 0.2.0 |
| <span style="color:orange">Deprecated in:</span> | 4.13.0 | 5.5.0 | 0.17.0 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | 1.0.0 | 2.0.0 |

<!-- reusable-table-boundary -->
<!-- reusable-table-boundary -->

The object to set parameters easily for fetching documents from API.

**Declared In:**  
lib/model/content/documents_api_query.dart  
  
**Related To:**  
[DocumentsApiQueryType](/developers/mobile-sdk/class-reference/flutter/recommendations-and-documents#documentsapiquerytype)  
  
**Declaration:**

<pre><code class="language-Dart">class DocumentsApiQuery</code></pre>

  
**Properties:**
| Property | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| **type** | [DocumentsApiQueryType](/developers/mobile-sdk/class-reference/flutter/recommendations-and-documents#documentsapiquerytype) | no | .bySchema | Query type |
| **typeValue** | String | no  | null | Value for query type |
| **version** | String | yes | null | Specifies the document version |
  
**Initializers:**

<pre><code class="language-Dart">DocumentsApiQuery({required this.type, required this.typeValue, this.version})</code></pre>


<!-- reusable-table-boundary -->

---
---

### <del>DocumentsApiQueryType</del>{#documentsapiquerytype}
<!-- reusable-table-boundary -->

| | **iOS SDK** | **Android SDK** | **React Native SDK** | **Flutter SDK** |
| --- | --- | --- | --- | --- |
| <span style="color:green">Introduced in:</span> | 3.5.10 | 3.5.1 | 0.9.10 | 0.2.0 |
| <span style="color:orange">Deprecated in:</span> | 4.13.0 | 5.5.0 | 0.17.0 | n/a |
| <span style="color:red">Removed in:</span> | 5.0.0 | 6.0.0 | 1.0.0 | 2.0.0 |

<!-- reusable-table-boundary -->
**Declared In:**  
lib/enums/content/documents_api_query_type.dart  
  
**Declaration:**

<pre><code class="language-Dart">enum DocumentsApiQueryType {
  schema('by-schema');
}</code></pre>



# Event tracking


## Set Tracker Delegate
---
This method sets an object for Tracker module delegate methods.
**Declared In:**  
Headers/SNRTracker.h
  
**Related To:**  
[TrackerDelegate](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#tracker-delegate)  
  
**Class:**  
[Tracker](/developers/mobile-sdk/class-reference/ios/modules#tracker)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1180">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1180-0" data-tab-group="tabgrp-1180" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1180-1" data-tab-group="tabgrp-1180">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1180-0" data-tab-group="tabgrp-1180" data-tab-active="true">

```Swift
static func setDelegate(_ delegate: TrackerDelegate)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1180-1" data-tab-group="tabgrp-1180">

```Objective-C
+ (void)setDelegate:(SNRTrackerDelegate *)delegate
```

</div>
</div>

  
**Discussion:**  
Learn more about the methods and the purpose of this listener [here](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#tracker-delegate). 

## Get customer's events
---
This method retrieves events for an authenticated customer.
  
This method requires customer authentication.
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRClient.h
  
**Related To:**  
[ClientEventsApiQuery](/developers/mobile-sdk/class-reference/ios/client#clienteventsapiquery)
  
**Class:**  
[Client](/developers/mobile-sdk/class-reference/ios/modules#client)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1181">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1181-0" data-tab-group="tabgrp-1181" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1181-1" data-tab-group="tabgrp-1181">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1181-0" data-tab-group="tabgrp-1181" data-tab-active="true">

```Swift
static func getEvents(apiQuery: ClientEventsApiQuery, success: (([ClientEventData]) -> Void), failure: ((ApiError) -> Void)) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1181-1" data-tab-group="tabgrp-1181">

```Objective-C
+ (void)getEventsWithApiQuery:(nonnull SNRClientEventsApiQuery *)apiQuery success:(nonnull void (^)(NSArray<SNRClientEventData *> *events))success failure:(nonnull void (^)(NSError *error))failure
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **apiQuery** | [ClientEventsApiQuery](/developers/mobile-sdk/class-reference/ios/client#clienteventsapiquery) | yes | - | Object responsible for storing all query parameters |
| **success** | (([ClientEventData]) -> Void) | yes | - | Closure/Block to be executed when the operation is completed successfully |
| **failure** | (([ApiError](/developers/mobile-sdk/class-reference/ios/miscellaneous#snrapierror)) -> Void) | yes | - | Closure/Block to be executed when the operation is completed with an error |
  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary --> 

## Set custom identifier for events
---
This method sets a custom identifier in the parameters of every event.

You can pass a custom identifier to match your customers in our database.
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRTracker.h
  
**Class:**  
[Tracker](/developers/mobile-sdk/class-reference/ios/modules#tracker)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1182">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1182-0" data-tab-group="tabgrp-1182" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1182-1" data-tab-group="tabgrp-1182">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1182-0" data-tab-group="tabgrp-1182" data-tab-active="true">

```Swift
static func setCustomIdentifier(customIdentifier: String?) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1182-1" data-tab-group="tabgrp-1182">

```Objective-C
+ (void)setCustomIdentifier:(nullable NSString *)customIdentifier;
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **customIdentifier** | String | no | - | Customer's custom identifier |
  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->

## Set custom email for events
---
This method sets a custom email in the parameters of every event.

You can pass a custom email to match your customers in our database.
<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRTracker.h
  
**Class:**  
[Tracker](/developers/mobile-sdk/class-reference/ios/modules#tracker)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1183">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1183-0" data-tab-group="tabgrp-1183" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1183-1" data-tab-group="tabgrp-1183">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1183-0" data-tab-group="tabgrp-1183" data-tab-active="true">

```Swift
static func setCustomEmail(customEmail: String?) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1183-1" data-tab-group="tabgrp-1183">

```Objective-C
+ (void)setCustomEmail:(nullable NSString *)customEmail;
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **customEmail** | String | no | - | Customer's custom email |
  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->

## Send event
---
This method sends an event.


<div class="admonition admonition-warning"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-2.5L13.732 4c-.77-.833-1.964-.833-2.732 0L4.082 16.5c-.77.833.192 2.5 1.732 2.5z" /></svg></div><div class="admonition-body"><div class="admonition-content">

DO NOT send `transaction.charge` events as custom events.<br>
Transactions must be tracked with these endpoints:
- [`/v4/transactions`](https://hub.synerise.com/api-reference/data-management#tag/Events/operation/CreateATransaction) (single transaction)
- [`/v4/transactions/batch`](https://hub.synerise.com/api-reference/data-management#tag/Events/operation/BatchAddOrUpdateTransactions) (multiple transactions)

</div></div></div>

  

<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

- The tracker caches and enqueues all your events locally, so they all will be sent eventually.
- The API key must have the `API_BATCH_EVENTS_CREATE` permission from the **Events** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRTracker.h
  
**Related To:**  
[Event](/developers/mobile-sdk/class-reference/ios/events#event)  
[TrackerParams](/developers/mobile-sdk/class-reference/ios/events#trackerparams)  
[TrackerParamsBuilder](/developers/mobile-sdk/class-reference/ios/events#trackerparamsbuilder)   
  
**Class:**  
[Tracker](/developers/mobile-sdk/class-reference/ios/modules#tracker)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1184">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1184-0" data-tab-group="tabgrp-1184" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1184-1" data-tab-group="tabgrp-1184">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1184-0" data-tab-group="tabgrp-1184" data-tab-active="true">

```Swift
static func send(_: Event) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1184-1" data-tab-group="tabgrp-1184">

```Objective-C
+ (void)send:(SNREvent *)event
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **event** | [Event](/developers/mobile-sdk/class-reference/ios/events#event) | yes | - | [Event](/developers/mobile-sdk/class-reference/ios/events#event) object |
  
**Return Value:**  
No value is returned.
  
**Example:**
You may use standard objects in SDK, for example `ProductAddedToCartEvent` that represents a 'customer added a product to cart' event:  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1185">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1185-0" data-tab-group="tabgrp-1185" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1185-1" data-tab-group="tabgrp-1185">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1185-0" data-tab-group="tabgrp-1185" data-tab-active="true">

```Swift
let event: ProductAddedToCartEvent = ProductAddedToCartEvent(label: "Product added!", sku: "12345", finalPrice: UnitPrice(amount: 100.0), quantity: 1)
event.setCategory("Smartphones")
event.setName("iPhone")
event.setProducer("Apple")
Tracker.send(event)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1185-1" data-tab-group="tabgrp-1185">

```Objective-C
SNRProductAddedToCartEvent *event = [[SNRProductAddedToCartEvent alloc] initWithLabel:@"Product added!" sku:@"12345" finalPrice:[[SNRUnitPrice alloc] initWithAmount:100.0f] quantity:1];
[event setCategory:@"Smartphones"];
[event setName:@"iPhone"];
[event setProducer:@"Apple"];
[SNRTracker send:event];
```

</div>
</div>

  
You can also pass additional parameters along with `ProductAddedToCartEvent` and other events, like in the example below:

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1186">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1186-0" data-tab-group="tabgrp-1186" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1186-1" data-tab-group="tabgrp-1186">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1186-0" data-tab-group="tabgrp-1186" data-tab-active="true">

```Swift
let params: TrackerParams = TrackerParams.make { (builder) in
    builder.setString("12345", forKey: "snr_sku")
    builder.setInt(1, forKey: "snr_quantity")
    builder.setDouble(100.0, forKey: "snr_finalPrice")
}
let event: ProductAddedToCartEvent = ProductAddedToCartEvent(label: "Product added!", sku: "12345", finalPrice: UnitPrice(amount: 100.0), quantity: 1, params: params)
event.setCategory("Smartphones")
event.setName("iPhone")
event.setProducer("Apple")
Tracker.send(event)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1186-1" data-tab-group="tabgrp-1186">

```Objective-C
SNRTrackerParams *params = [SNRTrackerParams makeWithBuilder:^(SNRTrackerParamsBuilder *builder) {
    [builder setString:@"12345" forKey:@"snr_sku"];
    [builder setInt:1 forKey:@"snr_quantity"];
    [builder setDouble:100.0f forKey:@"snr_finalPrice"];
}];
SNRProductAddedToCartEvent *event = [[SNRProductAddedToCartEvent alloc] initWithLabel:@"Product added!" sku:@"12345" finalPrice:[[SNRUnitPrice alloc] initWithAmount:100.0f] quantity:1 andParams:params];
[event setCategory:@"Smartphones"];
[event setName:@"iPhone"];
[event setProducer:@"Apple"];
[SNRTracker send:event];
```

</div>
</div>

  
If you want to track a fully customizable event, you should use `CustomEvent`:

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1187">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1187-0" data-tab-group="tabgrp-1187" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1187-1" data-tab-group="tabgrp-1187">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1187-0" data-tab-group="tabgrp-1187" data-tab-active="true">

```Swift
let params: TrackerParams = TrackerParams.make { (builder) in
    builder.setString("12345", forKey:"key_string");
    builder.setInt(1, forKey:"key_integer");
    builder.setDouble(1.0, forKey:"key_double");
    builder.setFloat(1.0, forKey:"key_float");
    builder.setBool(true, forKey:"key_bool");
    builder.setObject(["key": "value"], forKey:"key_object");
}
let event: CustomEvent = CustomEvent(label: "custom event", action: "custom event action", params: params)
Tracker.send(event)
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1187-1" data-tab-group="tabgrp-1187">

```Objective-C
SNRTrackerParams *params = [SNRTrackerParams makeWithBuilder:^(SNRTrackerParamsBuilder *builder) {
    [builder setString:@"string" forKey:@"key_string"];
    [builder setInt:1 forKey:@"key_integer"];
    [builder setDouble:1.0f forKey:@"key_double"];
    [builder setFloat:1.0f forKey:@"key_float"];
    [builder setBool:YES forKey:@"key_bool"];
    [builder setObject:@{ @"key" : @"value" } forKey:@"key_object"];
}];
SNRCustomEvent *event = [[SNRCustomEvent alloc] initWithLabel:"custom event" action:@"custom event action" andParams:params];
[SNRTracker send:event];
```

</div>
</div>


<!-- reusable-table-boundary -->

## Flush events from Tracker
---
This method forces sending the events from the queue to the server.


<div class="admonition admonition-note"><div class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2.5"><path stroke-linecap="round" stroke-linejoin="round" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg></div><div class="admonition-body"><div class="admonition-content">

The API key must have the `API_BATCH_EVENTS_CREATE` permission from the **Events** group.

</div></div></div>

<!-- reusable-table-boundary -->

**Declared In:**  
Headers/SNRTracker.h
  
**Related To:**  
[Event](/developers/mobile-sdk/class-reference/ios/events#event)  
[TrackerParams](/developers/mobile-sdk/class-reference/ios/events#trackerparams)  
[TrackerParamsBuilder](/developers/mobile-sdk/class-reference/ios/events#trackerparamsbuilder)  
  
**Class:**  
[Tracker](/developers/mobile-sdk/class-reference/ios/modules#tracker)
  
**Declaration:**  

<div class="content-tabs code-tabs" data-tab-group="tabgrp-1188">
<div class="tab-buttons"><button class="tab-button" data-tab-id="tabgrp-1188-0" data-tab-group="tabgrp-1188" data-tab-active="true">Swift</button><button class="tab-button" data-tab-id="tabgrp-1188-1" data-tab-group="tabgrp-1188">Objective-C</button></div>

<div class="tab-panel" data-tab-id="tabgrp-1188-0" data-tab-group="tabgrp-1188" data-tab-active="true">

```Swift
static func flushEvents(completionHandler: (() -> Void)?) -> Void
```

</div>

<div class="tab-panel" data-tab-id="tabgrp-1188-1" data-tab-group="tabgrp-1188">

```Objective-C
+ (void)flushEventsWithCompletionHandler:(nullable void (^)(void))completion
```

</div>
</div>

  
**Parameters:**  
| Parameter | Type | Mandatory | Default | Description |
| --- | --- | --- | --- | --- |
| **completionHandler** | (() -> Void) | no | - | Block/Closure to be executed when the tracker has finished flushing events to Synerise backend, no matter the result |
  
**Return Value:**  
No value is returned.

<!-- reusable-table-boundary -->