OMCMessageAction Class Reference

Inherits from NSObject
Declared in OMCMessageAction.h

  actionId

The unique identifier representing the action.

@property (readonly, nullable) NSString *actionId

Declared In

OMCMessageAction.h

  type

The type of action.

@property (nullable) NSString *type

Discussion

Valid types include OMCMessageActionTypeLink for regular actions, and OMCMessageActionTypeBuy for buy actions.

Declared In

OMCMessageAction.h

  text

The text to display as a descriptor for the action.

@property (nullable) NSString *text

Discussion

May not be nil.

Declared In

OMCMessageAction.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 OMCMessageActionTypeLink or OMCMessageActionTypeWebview

Declared In

OMCMessageAction.h

  fallback

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

@property (nullable) NSURL *fallback

Declared In

OMCMessageAction.h

  size

The size of a webview

@property (nullable, copy) NSString *size

Discussion

May not be nil if message is of type OMCMessageActionTypeWebview

Declared In

OMCMessageAction.h

  isDefault

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

@property (readonly) BOOL isDefault

Discussion

Default value is NO

See Also

Declared In

OMCMessageAction.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

OMCMessageAction.h

  iconUrl

Icon to display with a reply

@property (nullable) NSString *iconUrl

Discussion

An icon to render next to the reply option

Declared In

OMCMessageAction.h

  payload

The payload of actions with type OMCMessageActionTypeReply or OMCMessageActionTypePostback

@property (nullable) NSString *payload

Discussion

The payload of actions with type OMCMessageActionTypeReply or OMCMessageActionTypePostback, if applicable. May be nil

Declared In

OMCMessageAction.h

  state

The purchase state of the action

@property (nullable) NSString *state

Discussion

This property is only non-nil for actions of type OMCMessageActionTypeBuy. Valid states include OMCMessageActionStateOffered and OMCMessageActionStatePaid.

Declared In

OMCMessageAction.h

  amount

The amount of money to charge for the action.

@property long amount

Discussion

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

Declared In

OMCMessageAction.h

  currency

The currency in which the amount is expressed.

@property (nullable) NSString *currency

Discussion

This property is only valid for actions of type OMCMessageActionTypeBuy.

Declared In

OMCMessageAction.h