KBMMessageAction Class Reference

Inherits from NSObject
Declared in KBMMessageAction.h

  actionId

The unique identifier representing the action.

@property (readonly, nullable) NSString *actionId

Declared In

KBMMessageAction.h

  type

The type of action.

@property (nullable) NSString *type

Discussion

Valid types include KBMMessageActionTypeLink for regular actions, and KBMMessageActionTypeBuy for buy actions.

Declared In

KBMMessageAction.h

  text

The text to display as a descriptor for the action.

@property (nullable) NSString *text

Discussion

May not be nil.

Declared In

KBMMessageAction.h

  uri

The URI to navigate to if the user interacts with the action.

@property (nullable) NSURL *uri

Discussion

May not be nil if message is of type KBMMessageActionTypeLink or KBMMessageActionTypeWebview

Declared In

KBMMessageAction.h

  fallback

Fallback URI to use for action types not supported by the SDK. May be nil.

@property (nullable) NSURL *fallback

Declared In

KBMMessageAction.h

  size

The size of a webview

@property (nullable, copy) NSString *size

Discussion

May not be nil if message is of type KBMMessageActionTypeWebview

Declared In

KBMMessageAction.h

  isDefault

Boolean value indicating whether this action is the default action for an KBMMessageItem

@property (readonly) BOOL isDefault

Discussion

Default value is NO

See Also

Declared In

KBMMessageAction.h

  metadata

Metadata associated with the action.

@property (nullable) NSDictionary *metadata

Discussion

A flat dictionary of metadata set through the REST API. May be nil.

Declared In

KBMMessageAction.h

  iconUrl

Icon to display with a reply

@property (nullable) NSString *iconUrl

Discussion

An icon to render next to the reply option

Declared In

KBMMessageAction.h

  payload

The payload of actions with type KBMMessageActionTypeReply or KBMMessageActionTypePostback

@property (nullable) NSString *payload

Discussion

The payload of actions with type KBMMessageActionTypeReply or KBMMessageActionTypePostback, if applicable. May be nil

Declared In

KBMMessageAction.h

  state

The purchase state of the action

@property (nullable) NSString *state

Discussion

This property is only non-nil for actions of type KBMMessageActionTypeBuy. Valid states include KBMMessageActionStateOffered and KBMMessageActionStatePaid.

Declared In

KBMMessageAction.h

  amount

The amount of money to charge for the action.

@property long amount

Discussion

This property is only valid for actions of type KBMMessageActionTypeBuy. For USD, this value is in cents.

Declared In

KBMMessageAction.h

  currency

The currency in which the amount is expressed.

@property (nullable) NSString *currency

Discussion

This property is only valid for actions of type KBMMessageActionTypeBuy.

Declared In

KBMMessageAction.h