# 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).

```Swift Synerise.setDelegate(YOUR_OBJECT) ```

```Objective-C [SNRSynerise setDelegate:YOUR_OBJECT]; ```

If optional methods for handling URL and deeplink are not implemented, SDK has a default behavior.

#### snr_initialized() {id=synerise-delegate-initialized} This method is called when the Synerise SDK is initialized.

```Swift func snr_initialized() -> Void ```

```Objective-C - (void)SNR_initialized ```

#### snr_initializationError(error: Error) {id=synerise-delegate-initialization-error} This method is called when an error occurs while initializing the Synerise SDK.

```Swift func snr_initializationError(error: Error) -> Void ```

```Objective-C - (void)SNR_initializationError:(NSError *)error ```

| 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.

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.

This method is invoked when the **snr_registerForPushNotificationsIsNeeded(origin:)** method is not implemented.

```Swift func snr_registerForPushNotificationsIsNeeded() -> Void ```

```Objective-C - (void)SNR_registerForPushNotificationsIsNeeded ```

#### 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.

```Swift func snr_registerForPushNotificationsIsNeeded(origin: PushNotificationsRegistrationOrigin) -> Void ```

```Objective-C - (void)SNR_registerForPushNotificationsIsNeededByOrigin:(SNRPushNotificationsRegistrationOrigin)origin ```

| 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.

This method is invoked when the **snr_handledAction(url:source:)** method is not implemented.

```Swift func snr_handledAction(url: URL) -> Void ```

```Objective-C - (void)SNR_handledActionWithURL:(NSURL *)url ```

| 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.

```Swift func snr_handledAction(url: URL, source: SyneriseSource) -> Void ```

```Objective-C - (void)SNR_handledActionWithURL:(NSURL *)url source:(SNRSyneriseSource)source ```

| 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.

This method was deprecated in SDK version 5.0.0.

```Swift func snr_handledAction(url: URL, activity: SyneriseActivity, completionHandler: SyneriseActivityCompletionHandler) -> Void ```

```Objective-C - (void)SNR_handledActionWithURL:(NSURL *)url activity:(SNRSyneriseActivity)activity completionHandler:(SNRSyneriseActivityCompletionHandler)completionHandler ```

| 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.

This method is invoked when the **snr_handledAction(deepLink:source:)** method is not implemented.

```Swift func snr_handledAction(deepLink: String) -> Void ```

```Objective-C - (void)SNR_handledActionWithDeepLink:(NSString *)deepLink ```

| 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.

```Swift func snr_handledAction(deepLink: String, source: SyneriseSource) -> Void ```

```Objective-C - (void)SNR_handledActionWithDeepLink:(NSString *)deepLink source:(SNRSyneriseSource)source ```

| 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.

This method was deprecated in SDK version 5.0.0.

```Swift func snr_handledAction(deepLink: String, activity: SyneriseActivity, completionHandler: SyneriseActivityCompletionHandler) -> Void ```

```Objective-C - (void)SNR_handledActionWithDeepLink:(NSString *)deepLink activity:(SNRSyneriseActivity)activity completionHandler:(SNRSyneriseActivityCompletionHandler)completionHandler ```

| 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.

**NotificationDelegate** is available from 4.10.0 SDK version. All methods are optional.

To set your object as delegate, you must use [this method](/developers/mobile-sdk/method-reference/ios/campaigns#set-notification-delegate).

```Swift Synerise.setNotificationDelegate(YOUR_OBJECT) ```

```Objective-C [SNRSynerise setNotificationDelegate:YOUR_OBJECT]; ```

#### snr_notificationDidReceive(notificationInfo: NotificationInfo) {id=notification-delegate-notification-did-receive} This method is called when a Synerise notification is received.

```Swift snr_notificationDidReceive(notificationInfo: NotificationInfo) ```

```Objective-C - (void)SNR_notificationDidReceive:(SNRNotificationInfo *)notificationInfo ```

| 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.

```Swift func snr_notificationDidDissmis(notificationInfo: NotificationInfo) ```

```Objective-C - (void)SNR_notificationDidDissmis:(SNRNotificationInfo *)notificationInfo ```

| 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.

```Swift func snr_notificationClicked(notificationInfo: NotificationInfo) ```

```Objective-C - (void)SNR_notificationClicked:(SNRNotificationInfo *)notificationInfo ```

| 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.

```Swift func snr_notificationClicked(notificationInfo: NotificationInfo, actionButton: String) ```

```Objective-C - (void)SNR_notificationActionButtonClicked:(SNRNotificationInfo *)notificationInfo actionButton:(NSString *)actionButton ```

| 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).

```Swift Client.setClientStateDelegate(YOUR_OBJECT) ```

```Objective-C [SNRClient setClientStateDelegate:YOUR_OBJECT]; ```

#### snr_clientIsSignedIn() {id=client-state-delegate-client-is-signed-in} This method is called when a customer signs in.

```Swift func snr_clientIsSignedIn() ```

```Objective-C - (void)SNR_clientIsSignedIn ```

#### snr_clientIsSignedOut(reason: ClientSessionEndReason) {id=client-state-delegate-client-is-signed-out} This method is called when a customer signs out.

```Swift func snr_clientIsSignedOut(reason: ClientSessionEndReason) ```

```Objective-C - (void)SNR_clientIsSignedOutWithReason:(SNRClientSessionEndReason)reason ```

| 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).

**InjectorInAppMessageDelegate** is available from 4.6.0 SDK version.

To set your object as delegate, you must use [this method](/developers/mobile-sdk/method-reference/ios/campaigns#set-in-app-message-delegate).

```Swift Injector.setInAppMessageDelegate(YOUR_OBJECT) ```

```Objective-C [SNRInjector setInAppMessageDelegate:YOUR_OBJECT]; ```

#### 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.

```Swift func snr_shouldInAppMessageAppear(data: InAppMessageData) -> Bool ```

```Objective-C - (BOOL)SNR_shouldInAppMessageAppear:(SNRInAppMessageData *)data ```

| 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.

```Swift func snr_inAppMessageDidAppear(data: InAppMessageData) ```

```Objective-C - (void)SNR_inAppMessageDidAppear:(SNRInAppMessageData *)data ```

| 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.

```Swift func snr_inAppMessageDidDisappear(data: InAppMessageData) ```

```Objective-C - (void)SNR_inAppMessageDidDisappear:(SNRInAppMessageData *)data ```

| 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.

```Swift func snr_inAppMessageDidChangeSize(rect: CGRect) ```

```Objective-C - (void)SNR_inAppMessageDidChangeSize:(CGRect)rect ```

| 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.

```Swift func snr_inAppMessageContextIsNeeded(data: InAppMessageData) -> [AnyHashable: Any]? ```

```Objective-C - (nullable NSDictionary *)SNR_inAppMessageContextIsNeeded:(SNRInAppMessageData *)data ```

| 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.

This method was renamed in 5.0.0 SDK version from `snr_inAppMessageHandledAction(data:deeplink:)`.

```Swift func snr_inAppMessageHandledAction(data: InAppMessageData, deepLink: String) ```

```Objective-C - (void)SNR_inAppMessageHandledDeeplinkAction:(SNRInAppMessageData *)data deepLink:(NSString *)deepLink ```

| 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.

```Swift func snr_inAppMessageHandledAction(data: InAppMessageData, url: URL) ```

```Objective-C - (void)SNR_inAppMessageHandledURLAction:(SNRInAppMessageData *)data url:(NSURL *)url ```

| 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.

```Swift func snr_inAppMessageHandledCustomAction(data: InAppMessageData, name: String, parameters: [AnyHashable: Any]) ```

```Objective-C - (void)SNR_inAppMessageHandledCustomAction:(SNRInAppMessageData *)data name:(NSString *)name parameters:(NSDictionary *)parameters ```

| 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. | --- --- ## 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).

```Swift Tracker.setDelegate(YOUR_OBJECT) ```

```Objective-C [SNRTracker setDelegate:YOUR_OBJECT]; ```

#### snr_locationUpdateRequired() {id=tracker-delegate-location-update-required} This method is called when the Tracker module requests a location update.

```Swift func snr_locationUpdateRequired() ```

```Objective-C - (void)SNR_locationUpdateRequired ```

--- --- ## NotificationServiceExtensionDelegate {id=notification-service-extension-delegate} A delegate to handle events from Notification Extension Service.

**NotificationServiceExtensionDelegate** is available from 4.0.0 SDK version.

To set your object as delegate, you must use this code in your Notification Service Extension.

```Swift NotificationServiceExtension.setDelegate(YOUR_OBJECT) ```

```Objective-C [SNRNotificationServiceExtension setDelegate:YOUR_OBJECT]; ```

#### notificationServiceExtensionDidFailDecryptionWithError(_: Error) {id=notification-service-extension-delegate-notification-service-extension-did-fail-decryption} This method is called when the decryption process fails.

```Swift func notificationServiceExtensionDidFailDecryptionWithError(_: Error) ```

```Objective-C - (void)notificationServiceExtensionDidFailDecryptionWithError:(NSError *)error ```

| 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.

```Swift func notificationServiceExtensionDidFailProcessingWithError(_: Error) ```

```Objective-C - (void)notificationServiceExtensionDidFailProcessingWithError:(NSError *)error ```

| 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.

```Swift let widget = ContentWidget(options: widgetOptions, appearance: widgetAppearance) widget.delegate = YOUR_OBJECT ```

```Objective-C SNRContentWidget *widget = [SNRContentWidget initWithOptions:options andAppearance:appearance]; widget.delegate = YOUR_OBJECT; ```

#### snr_widgetDidLoad(widget: ContentWidget) {id=content-widget-delegate-widget-did-load} This method is called after a widget is loaded.

```Swift func snr_widgetDidLoad(widget: ContentWidget) ```

```Objective-C - (void)SNR_widgetDidLoad:(SNRContentWidget *)widget ```

| 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.

```Swift func snr_widgetDidNotLoad(widget:ContentWidget error: Error) ```

```Objective-C - (void)SNR_widget:(SNRContentWidget *)widget didNotLoadWithError:(NSError *)error ```

| 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.

```Swift func snr_widgetDidReceiveClickAction(widget:ContentWidget model: BaseModel) ```

```Objective-C - (void)SNR_widget:(SNRContentWidget *)widget didReceiveClickActionForModel:(SNRBaseModel *)model ```

| 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.

```Swift func snr_widgetIsLoading(widget: ContentWidget isLoading: Bool) ```

```Objective-C - (void)SNR_widget:(SNRContentWidget *)widget isLoading:(BOOL)isLoading ```

| 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.

```Swift func snr_widgetDidChangeSize(widget: ContentWidget size: CGSize) ```

```Objective-C - (void)SNR_widget:(SNRContentWidget *)widget didChangeToSize:(CGSize)size ```

| 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}

**InjectorWalkthroughDelegate** was removed in 5.0.0 SDK version.

--- --- ## InjectorBannerDelegate {id=injector-banner-delegate}

**InjectorBannerDelegate** was removed in 5.0.0 SDK version.