IAM Handlers

// Function
/// Called per message to decide whether to show, discard or delay it.
@objc public func shouldDisplayMessage(_ callback: ((ActionContext) -> MessageDisplayChoice)?)

// Example
ActionManager.shared.shouldDisplayMessage { actionContext in
     // return the desired option
     return .show()
     return .discard()
     return .delay(seconds: 30)
     return .delayIndefinitely()
}

// remove handler
ActionManager.shared.shouldDisplayMessage(nil)

// Implement MessageDisplayController interface
interface MessageDisplayController {

  /**
   * Called per message to decide whether to show, discard or delay it.
   */
  fun shouldDisplayMessage(action: ActionContext): MessageDisplayChoice?

  /**
   * Called when there are multiple messages to be displayed.
   * We can order or remove any of them that we don't want to present.
   */
  fun prioritizeMessages(actions: List<ActionContext>, trigger: ActionsTrigger?): List<ActionContext>
}

// Example
object MessageDisplayControllerObject : MessageDisplayController {
    override fun shouldDisplayMessage(action: ActionContext) =
      MessageDisplayChoice.show()
      MessageDisplayChoice.discard()
      MessageDisplayChoice.delay(30)
      MessageDisplayChoice.delayIndefinitely()
}
// set the controller
LeanplumActions.setMessageDisplayController(MessageDisplayControllerObject)
  
// remove the controller
LeanplumActions.setMessageDisplayController(null)

/// Triggers all postponed messages when indefinite time was used with `MessageDisplayChoice`
@objc public func triggerDelayedMessages()

ActionManager.shared.triggerDelayedMessages()

/**
 * Method will trigger postponed messages when indefinite time was used with
 * [MessageDisplayController.shouldDisplayMessage]
 */
@JvmStatic
fun triggerDelayedMessages()

LeanplumActions.triggerDelayedMessages()

/// Called when there are multiple messages to be displayed. Messages are ordered by Priority.
/// Messages can be reordered or removed if desired. Removed messages will not be presented.
/// Messages will be presented one after another in the order returned.
///
/// - Note: If this function is not implemented, the first message is presented only.
///
/// - Parameters:
///     - callback: contexts - messages' contexts and trigger - the action trigger that triggered the messages
///
/// - Returns: the messages that should be presented in that order
@objc public func prioritizeMessages(_ callback: ((_ contexts: [ActionContext], _ trigger: ActionsTrigger?) -> [ActionContext])?)     

// Example
ActionManager.shared.prioritizeMessages { contexts, trigger in
    // return the contexts to be displayed
    return contexts
}

// remove handler
ActionManager.shared.prioritizeMessages(nil)

// Implement MessageDisplayController interface
interface MessageDisplayController {

  /**
   * Called per message to decide whether to show, discard or delay it.
   */
  fun shouldDisplayMessage(action: ActionContext): MessageDisplayChoice?

  /**
   * Called when there are multiple messages to be displayed.
   * We can order or remove any of them that we don't want to present.
   */
  fun prioritizeMessages(actions: List<ActionContext>, trigger: ActionsTrigger?): List<ActionContext>
}

// Example
object MessageDisplayControllerObject : MessageDisplayController {
  override fun prioritizeMessages(
    actions: List<ActionContext>,
    trigger: ActionsTrigger?) = actions // the actions to be presented
}

// set the controller
LeanplumActions.setMessageDisplayController(MessageDisplayControllerObject)
  
// remove the controller
LeanplumActions.setMessageDisplayController(null)

/// Called when the message is displayed.
@objc public func onMessageDisplayed(_ callback: @escaping (ActionContext) -> Void) 

/// Called when the message is dismissed.
@objc public func onMessageDismissed(_ callback: @escaping (ActionContext) -> Void) 

/// Called when a message action is executed.
@objc public func onMessageAction(_ callback: @escaping (_ actionName: String, _ context: ActionContext) -> Void)

// Example
ActionManager.shared.onMessageDisplayed { context in
    // code
}

ActionManager.shared.onMessageDismissed { context in
    // code
}

ActionManager.shared.onMessageAction { actionName, context in
    // code
}

// set the closures to nil to remove them

// Implement MessageDisplayListener interface
interface MessageDisplayListener {
  /**
   * Called when the message is displayed.
   */
  fun onMessageDisplayed(action: ActionContext)

  /**
   * Called when the message is dismissed.
   */
  fun onMessageDismissed(action: ActionContext)

  /**
   * Called when the message is clicked
   */
  fun onActionExecuted(name: String, action: ActionContext)
}

// Example
object MessageDisplayListenerObject : MessageDisplayListener {
  override fun onMessageDisplayed(action: ActionContext) {
    // code
  }

  override fun onMessageDismissed(action: ActionContext) {
    // code
  }

  override fun onActionExecuted(name: String, action: ActionContext) {
    // code
  }
}

// set the listener
LeanplumActions.setMessageDisplayListener(MessageDisplayListenerObject)

// remove the listener
LeanplumActions.setMessageDisplayListener(null)

// Pause
ActionManager.shared.isPaused = true

// Resume
ActionManager.shared.isPaused = false

// Pause
LeanplumActions.setQueuePaused(true)

// Resume
LeanplumActions.setQueuePaused(false)

// Disable
ActionManager.shared.isEnabled = false

// Enable
ActionManager.shared.isEnabled = true

// Disable
LeanplumActions.setQueueEnabled(false)

// Enable
LeanplumActions.setQueueEnabled(true)

ActionManager.shared.configuration = 
ActionManager.Configuration(dismissOnPushArrival: false, resumeOnEnterForeground: false)

LeanplumActions.setContinueOnActivityResumed(false)

LeanplumActions.setDismissOnPushOpened(false)