InAppMessageDismissReason

Package: com.salesforce.marketingcloud.inappmessagingfeature

Module: In App Messaging Feature Module v1.0.0

Overview 

An enumeration representing the reason an In-App Message was dismissed.

1enum InAppMessageDismissReason : Enum<InAppMessageCloseAction.InAppMessageDismissReason>

Enum Values 

AUTO 

1AUTO

The message was automatically dismissed, such as after a timeout period.

BUTTON 

1BUTTON

The user dismissed the message by tapping a button within the message.

CLOSED 

1CLOSED

The user explicitly closed the message using a close control.

UNKNOWN 

1UNKNOWN

The dismiss reason could not be determined.

Properties 

entries 

1val entries: EnumEntries<InAppMessageCloseAction.InAppMessageDismissReason>

An immutable list representation of all enum entries in declaration order.

value 

1val value: Int

Integer value used for analytics tracking or serialization purposes.

Methods 

valueOf 

1fun valueOf(value: String): InAppMessageCloseAction.InAppMessageDismissReason

Returns the enum constant matching the specified name string. The string must exactly match an enum constant identifier (no extra whitespace allowed).

Parameters:

  • value - The name of the enum constant to retrieve

Returns: The matching enum constant

values 

1fun values(): Array<InAppMessageCloseAction.InAppMessageDismissReason>

Returns an array of all enum constants in declaration order.

Returns: Array containing all enum constants