Braze iOS SDK
Documentation for the Braze iOS SDK
 All Classes Functions Properties
Instance Methods | List of all members
<ABKInAppMessageControllerDelegate> Protocol Referenceabstract

#import <ABKInAppMessageControllerDelegate.h>

Instance Methods

(ABKInAppMessageDisplayChoice) - beforeInAppMessageDisplayed:
 
(ABKInAppMessageDisplayChoice) - beforeControlMessageImpressionLogged:
 

Detailed Description

The in-app message delegate allows you to control the display of the Braze in-app message. For more detailed information on in-app message behavior, including when and how the delegate is used, see the documentation for the ABKInAppMessageDisplayChoice enum above for more detailed information.

This delegate is for those who are using the Core subspec and not integrating the In-App Message subspec. If you are using the In-App Message subspec, please use ABKInAppMessageUIDelegate.

Method Documentation

- (ABKInAppMessageDisplayChoice) beforeControlMessageImpressionLogged: (ABKInAppMessage *)  inAppMessage
optional
Parameters
inAppMessageThe control in-app message object being offered to the delegate method.
Returns
ABKInAppMessageDisplayChoice The control in-app message impression logging choice. For details refer to the documentation regarding the ENUM ABKInAppMessageDisplayChoice above. Logging a control message impression is an equivalent of displaying the message, except that no actual display occurs.

This delegate method defines the timing of when the control in-app message impression event should be logged: now, later, or discarded. Logging a control message impression is an equivalent of displaying the message, except that no actual display occurs.

If there are situations where you would not want the control in-app message impression to be logged, you can use this delegate to delay or discard it.

- (ABKInAppMessageDisplayChoice) beforeInAppMessageDisplayed: (ABKInAppMessage *)  inAppMessage
optional
Parameters
inAppMessageThe in-app message object being offered to the delegate method.
Returns
ABKInAppMessageDisplayChoice The in-app message display choice. For details refer to the documentation regarding the ENUM ABKInAppMessageDisplayChoice above.

This delegate method defines whether the in-app message will be displayed now, displayed later, or discarded.

If there are situations where you would not want the in-app message to appear (such as during a full screen game or on a loading screen), you can use this delegate to delay or discard pending in-app message messages.