iOS

iOS delegates

SyneriseDelegate

A delegate to handle the SDK lifecycle events.

To set your object as delegate, you must use this method.

Synerise.setDelegate(YOUR_OBJECT)

[SNRSynerise setDelegate:YOUR_OBJECT];

snr_initialized()

This method is called when the Synerise SDK is initialized.

func snr_initialized() -> Void

- (void)SNR_initialized

snr_initializationError(error: NSError)

This method is called when an error occurs while initializing the Synerise SDK.

func snr_initializationError(error: NSError) -> Void

- (void)SNR_initializationError:(NSError *)error

snr_registerForPushNotificationsIsNeeded()

This method is called when Synerise needs registration for push notifications.

See Configuring push notifications for more details.

func snr_registerForPushNotificationsIsNeeded() -> Void

- (void)SNR_registerForPushNotificationsIsNeeded

snr_registerForPushNotificationsIsNeeded(origin: PushNotificationsRegistrationOrigin)

This method is called when Synerise needs registration for push notifications.

See Configuring push notifications for more details.

func snr_registerForPushNotificationsIsNeeded(origin: PushNotificationsRegistrationOrigin) -> Void

- (void)SNR_registerForPushNotificationsIsNeededByOrigin:(SNRPushNotificationsRegistrationOrigin)origin

snr_handledAction(url: URL)

This method is called when Synerise handles URL action from campaign activities.

func snr_handledAction(url: URL) -> Void

- (void)SNR_handledActionWithURL:(NSURL *)url

snr_handledAction(url: URL, source: SyneriseSource)

This method is called when Synerise handles URL action from campaign activities.

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

- (void)SNR_handledActionWithURL:(NSURL *)url source:(SNRSyneriseSource)source

snr_handledAction(url: URL, activity: SyneriseActivity, completionHandler: SyneriseActivityCompletionHandler)

snr_handledAction(deepLink: String)

This method is called when Synerise handles deeplink action from campaign activities.

func snr_handledAction(deepLink: String) -> Void

- (void)SNR_handledActionWithDeepLink:(NSString *)deepLink

snr_handledAction(deepLink: String, source: SyneriseSource)

This method is called when Synerise handles deeplink action from campaign activities.

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

- (void)SNR_handledActionWithDeepLink:(NSString *)deepLink source:(SNRSyneriseSource)source

snr_handledAction(deepLink: String, activity: SyneriseActivity, completionHandler: SyneriseActivityCompletionHandler)

NotificationDelegate

A delegate to handle events from Synerise notifications.

See Configuring push notifications for more details.

To set your object as delegate, you must use this method.

Synerise.setNotificationDelegate(YOUR_OBJECT)

[SNRSynerise setNotificationDelegate:YOUR_OBJECT];

snr_notificationDidReceive(notificationInfo: NotificationInfo)

This method is called when a Synerise notification is received.

snr_notificationDidReceive(notificationInfo: NotificationInfo)

- (void)SNR_notificationDidReceive:(SNRNotificationInfo *)notificationInfo

snr_notificationDidDismiss(notificationInfo: NotificationInfo)

This method is called when a Synerise notification is dismissed.

func snr_notificationDidDismiss(notificationInfo: NotificationInfo)

- (void)SNR_notificationDidDismiss:(SNRNotificationInfo *)notificationInfo

snr_notificationClicked(notificationInfo: NotificationInfo)

This method is called when a Synerise notification is clicked.

func snr_notificationClicked(notificationInfo: NotificationInfo)

- (void)SNR_notificationClicked:(SNRNotificationInfo *)notificationInfo

snr_notificationClicked(notificationInfo: NotificationInfo, actionButton: String)

This method is called when an action button is clicked in a Synerise notification.

func snr_notificationClicked(notificationInfo: NotificationInfo, actionButton: String)

- (void)SNR_notificationActionButtonClicked:(SNRNotificationInfo *)notificationInfo actionButton:(NSString *)actionButton

ClientStateDelegate

A delegate to handle customer's sign-in state changes.

To set your object as delegate, you must use this method.

Client.setClientStateDelegate(YOUR_OBJECT)

[SNRClient setClientStateDelegate:YOUR_OBJECT];

snr_clientIsSignedIn()

This method is called when a customer signs in.

func snr_clientIsSignedIn()

- (void)snr_clientIsSignedIn

snr_clientIsSignedOut(reason: ClientSessionEndReason)

This method is called when a customer signs out.

func snr_clientIsSignedOut(reason: ClientSessionEndReason)

- (void)snr_clientIsSignedOutWithReason:(SNRClientSessionEndReason)reason

InjectorInAppMessageDelegate

A delegate to handle the states of in-app message.

To set your object as delegate, you must use this method.

Injector.setInAppMessageDelegate(YOUR_OBJECT)

[SNRInjector setInAppMessageDelegate:YOUR_OBJECT];

snr_shouldInAppMessageAppear(data: InAppMessageData) -> Bool

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

- (BOOL)SNR_shouldInAppMessageAppear:(SNRInAppMessageData *)data

snr_inAppMessageDidAppear(data: InAppMessageData)

This method is called after an in-app message appears.

func snr_inAppMessageDidAppear(data: InAppMessageData)

- (void)SNR_inAppMessageDidAppear:(SNRInAppMessageData *)data

snr_inAppMessageDidDisappear(data: InAppMessageData)

This method is called after an in-app message disappears.

func snr_inAppMessageDidDisappear(data: InAppMessageData)

- (void)SNR_inAppMessageDidDisappear:(SNRInAppMessageData *)data

snr_inAppMessageDidChangeSize(rect: CGRect)

This method is called when an in-app message changes its size.

func snr_inAppMessageDidChangeSize(rect: CGRect)

- (void)SNR_inAppMessageDidChangeSize:(CGRect)rect

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

This method is called when an individual context (for example a profile ID, an item SKU) for an in-app message is needed.

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

- (nullable NSDictionary *)SNR_inAppMessageContextIsNeeded:(SNRInAppMessageData *)data

snr_inAppMessageHandledAction(data: InAppMessageData, deepLink: String)

This method is called when the SRInApp.openDeeplink(url) method is used in an in-app message.

func snr_inAppMessageHandledAction(data: InAppMessageData, deepLink: String)

- (void)SNR_inAppMessageHandledDeepLinkAction:(SNRInAppMessageData *)data deepLink:(NSString *)deepLink

snr_inAppMessageHandledAction(data: InAppMessageData, url: URL)

This method is called when the SRInApp.openUrl(url) method is used in an in-app message.

func snr_inAppMessageHandledAction(data: InAppMessageData, url: URL)

- (void)SNR_inAppMessageHandledURLAction:(SNRInAppMessageData *)data url:(NSURL *)url

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

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

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

InjectorInlineInAppMessageDelegate

A delegate to handle global events for inline in-app messages.

To set your object as delegate, you must use this method.

Injector.setInlineInAppMessageDelegate(YOUR_OBJECT)

[SNRInjector setInlineInAppMessageDelegate:YOUR_OBJECT];

snr_inlineInAppMessageDidBecomeAvailable(view: InlineInAppView, data: InlineInAppMessageData)

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)

- (void)SNR_inlineInAppMessageDidBecomeAvailable:(SNRInlineInAppView *)view data:(SNRInlineInAppMessageData *)data

snr_inlineInAppMessageContextIsNeeded(data: InlineInAppMessageData) -> [AnyHashable: Any]?

This method is called when a per-message context is needed for rendering.

func snr_inlineInAppMessageContextIsNeeded(data: InlineInAppMessageData) -> [AnyHashable: Any]?

- (nullable NSDictionary *)SNR_inlineInAppMessageContextIsNeeded:(SNRInlineInAppMessageData *)data

snr_inlineInAppMessageHandledAction(data: InlineInAppMessageData, url: URL)

This method is called when the SRInApp.openUrl(url) method is used in an in-app message.

func snr_inlineInAppMessageHandledAction(data: InlineInAppMessageData, url: URL)

- (void)SNR_inlineInAppMessageHandledURLAction:(SNRInlineInAppMessageData *)data url:(NSURL *)url

snr_inlineInAppMessageHandledAction(data: InlineInAppMessageData, deepLink: String)

This method is called when the SRInApp.openDeeplink(url) method is used in an in-app message.

func snr_inlineInAppMessageHandledAction(data: InlineInAppMessageData, deepLink: String)

- (void)SNR_inlineInAppMessageHandledDeepLinkAction:(SNRInlineInAppMessageData *)data deepLink:(NSString *)deepLink

snr_inlineInAppMessageHandledCustomAction(data: InlineInAppMessageData, name: String, parameters: [AnyHashable: Any])

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

- (void)SNR_inlineInAppMessageHandledCustomAction:(SNRInlineInAppMessageData *)data name:(NSString *)name parameters:(NSDictionary *)parameters

snr_inlineInAppMessageHandledCustomMethod(data: InlineInAppMessageData, name: String, parameters: [AnyHashable: Any], completion: InAppCustomMethodCompletion)

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)

- (void)SNR_inlineInAppMessageHandledCustomMethod:(SNRInlineInAppMessageData *)data name:(NSString *)name parameters:(NSDictionary *)parameters completion:(SNRInAppCustomMethodCompletion *)completion

InlineInAppViewDelegate

A per-component delegate to handle the lifecycle of an inline in-app message view.

snr_inlineInAppViewDidStartProcessing(view: InlineInAppView)

This method is called when the SDK starts processing a campaign for this component.

func snr_inlineInAppViewDidStartProcessing(view: InlineInAppView)

- (void)SNR_inlineInAppViewDidStartProcessing:(SNRInlineInAppView *)view

snr_inlineInAppViewDidLoad(view: InlineInAppView, data: InlineInAppMessageData)

This method is called when the inline in-app message content is loaded for the first time.

func snr_inlineInAppViewDidLoad(view: InlineInAppView, data: InlineInAppMessageData)

- (void)SNR_inlineInAppViewDidLoad:(SNRInlineInAppView *)view data:(SNRInlineInAppMessageData *)data

snr_inlineInAppViewDidUpdate(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)

- (void)SNR_inlineInAppViewDidUpdate:(SNRInlineInAppView *)view data:(SNRInlineInAppMessageData *)data

snr_inlineInAppViewDidFail(view: InlineInAppView, error: NSError)

This method is called when the inline in-app message content fails to load or render.

func snr_inlineInAppViewDidFail(view: InlineInAppView, error: NSError)

- (void)SNR_inlineInAppViewDidFail:(SNRInlineInAppView *)view error:(NSError *)error

snr_inlineInAppViewChangeSizeIsNeeded(view: InlineInAppView, data: InlineInAppMessageData, size: InlineInAppSize)

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.

func snr_inlineInAppViewChangeSizeIsNeeded(view: InlineInAppView, data: InlineInAppMessageData, size: InlineInAppSize)

- (void)SNR_inlineInAppViewChangeSizeIsNeeded:(SNRInlineInAppView *)view data:(SNRInlineInAppMessageData *)data size:(SNRInlineInAppSize *)size

snr_inlineInAppViewShouldBeRemoved(view: InlineInAppView, data: InlineInAppMessageData)

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)

- (void)SNR_inlineInAppViewShouldBeRemoved:(SNRInlineInAppView *)view data:(SNRInlineInAppMessageData *)data

TrackerDelegate

A delegate to handle events from the Tracker.

To set your object as delegate, you must use this method.

Tracker.setDelegate(YOUR_OBJECT)

[SNRTracker setDelegate:YOUR_OBJECT];

snr_locationUpdateRequired()

This method is called when the Tracker module requests a location update.

func snr_locationUpdateRequired()

- (void)snr_locationUpdateRequired

NotificationServiceExtensionDelegate

A delegate to handle events from Notification Extension Service.

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

NotificationServiceExtension.setDelegate(YOUR_OBJECT)

[SNRNotificationServiceExtension setDelegate:YOUR_OBJECT];

notificationServiceExtensionDidFailDecryption(error: NSError)

This method is called when the decryption process fails.

func notificationServiceExtensionDidFailDecryption(error: NSError)

- (void)notificationServiceExtensionDidFailDecryptionWithError:(NSError *)error

notificationServiceExtensionDidFailProcessing(error: NSError)

This method is called when the processing notification operation fails.

func notificationServiceExtensionDidFailProcessing(error: NSError)

- (void)notificationServiceExtensionDidFailProcessingWithError:(NSError *)error

ContentWidgetDelegate

A delegate to handle Content Widget actions.

To set your object as delegate, you must use this code below.

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

SNRContentWidget *widget = [[SNRContentWidget alloc] initWithOptions:options andAppearance:appearance];
widget.delegate = YOUR_OBJECT;

snr_widgetDidLoad(widget: ContentWidget)

This method is called after a widget is loaded.

func snr_widgetDidLoad(widget: ContentWidget)

- (void)SNR_widgetDidLoad:(SNRContentWidget *)widget

snr_widgetDidNotLoad(widget:ContentWidget error: Error)

This method is called when an error occurs while loading a widget.

func snr_widgetDidNotLoad(widget:ContentWidget error: Error)

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

snr_widgetDidReceiveClickAction(widget:ContentWidget model: BaseModel)

This method is called when the customer clicks a widget’s item.

func snr_widgetDidReceiveClickAction(widget:ContentWidget model: BaseModel)

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

snr_widgetIsLoading(widget: ContentWidget isLoading: Bool)

This method is called when the widget’s loading state changes.

func snr_widgetIsLoading(widget: ContentWidget isLoading: Bool)

- (void)SNR_widget:(SNRContentWidget *)widget isLoading:(BOOL)isLoading

snr_widgetDidChangeSize(widget: ContentWidget size: CGSize)

This method is called when the widget’s size changes.

func snr_widgetDidChangeSize(widget: ContentWidget size: CGSize)

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

InjectorWalkthroughDelegate

InjectorBannerDelegate