Protocols Reference


                    
                    
                    SMIAttachmentEntry

Attachment entry.

Declaration

Objective-C

@protocol SMIAttachmentEntry <SMIEntryPayload, SMIEntryTypeMessage>

Swift

protocol AttachmentEntry : EntryPayload, EntryTypeMessage


                    
                    
                    SMIAuthorization

Authorization class.

Declaration

Objective-C

@protocol SMIAuthorization <NSObject, NSCopying>

Swift

protocol SMIAuthorization : NSCopying, NSObjectProtocol


                    
                    
                    SMIBusinessHours

Describes a set of business hours.

Declaration

Objective-C

@protocol SMIBusinessHours

Swift

protocol BusinessHours


                    
                    
                    SMIBusinessHoursInfo

The information needed to determine a deployment’s business hours.

Declaration

Objective-C

@protocol SMIBusinessHoursInfo

Swift

protocol BusinessHoursInfo


                    
                    
                    SMIChoice

A response type that represents a specific choice.

Declaration

Objective-C

@protocol SMIChoice <NSObject>

Swift

protocol Choice : NSObjectProtocol


                    
                    
                    SMIChoiceList

Describes a set of choice list values.

Declaration

Objective-C

@protocol SMIChoiceList <NSObject>

Swift

protocol ChoiceList : NSObjectProtocol


                    
                    
                    SMIChoiceListConfiguration

Information about choice lists that can appear in a pre-chat form. This object contains an array of choice lists, along with their dependencies.

Declaration

Objective-C

@protocol SMIChoiceListConfiguration <NSObject>

Swift

protocol ChoiceListConfiguration : NSObjectProtocol


                    
                    
                    SMIChoiceListDependency

Represents a dependency between a parent choice list and a child choice list.

Declaration

Objective-C

@protocol SMIChoiceListDependency <NSObject>

Swift

protocol ChoiceListDependency : NSObjectProtocol


                    
                    
                    SMIChoiceListValue

Represents a choice list value.

Declaration

Objective-C

@protocol SMIChoiceListValue <NSObject>

Swift

protocol ChoiceListValue : NSObjectProtocol


                    
                    
                    SMIChoicesResponse

Represents a list of choices within an SMIConversationEntry.

Declaration

Objective-C

@protocol SMIChoicesResponse <SMIEntryPayload, SMIEntryTypeMessage>

Swift

protocol ChoicesResponse : EntryPayload, EntryTypeMessage


                    
                    
                    SMIConversation

Protocol that represents a conversation.

Declaration

Objective-C

@protocol SMIConversation

Swift

protocol Conversation


                    
                    
                    SMIConversationClient

Class that allows you to perform actions related to a conversation and to listen for events using the associated delegate.

See

SMIConversationClientDelegate

Declaration

Objective-C

@protocol SMIConversationClient

Swift

protocol ConversationClient


                    
                    
                    SMIConversationClientDelegate

Delegate that handles events related to a conversation.

See

SMIConversationClient

Declaration

Objective-C

@protocol SMIConversationClientDelegate <NSObject>

Swift

protocol ConversationClientDelegate : NSObjectProtocol


                    
                    
                    SMIConversationEntry

Represents an entry in a conversation. An entry can be a permanent record in a conversation such as a message or a join event. Or it can represent more ephemeral events like a typing indicator.

Declaration

Objective-C

@protocol SMIConversationEntry <NSObject>

Swift

protocol ConversationEntry : NSObjectProtocol


                    
                    
                    SMICoreClient

Main entry point for the In-App Messaging core API. To create an instance of this class, use the SMICoreFactory class and provide an SMICoreConfiguration object.

Declaration

Objective-C

@protocol SMICoreClient

Swift

protocol CoreClient


                    
                    
                    SMICoreDelegate

Delegate used to receive events for the SMICoreClient framework. Use this protocol to listen for chat messages, receive message status changes, detect network status changes, and receive error messages.

See

SMICoreClient

See

-[SMICoreClient addDelegate:]

See

-[SMICoreClient addDelegate:queue:]

Declaration

Objective-C

@protocol SMICoreDelegate <NSObject>

Swift

protocol CoreDelegate : NSObjectProtocol


                    
                    
                    SMICoreFactory

This factory class allows you to create an instance of SMICoreClient using an SMICoreConfiguration config object.

Declaration

Objective-C

@protocol SMICoreFactory

Swift

protocol CoreFactoryProtocol


                    
                    
                    SMIEntryAck

Represents a single acknowledgement of an SMIConversationEntry.

Declaration

Objective-C

@protocol SMIEntryAck <SMIEntryPayload>

Swift

protocol EntryAck : EntryPayload


                    
                    
                    SMIEntryPayload

Common interface for the content of an SMIConversationEntry object.

Declaration

Objective-C

@protocol SMIEntryPayload

Swift

protocol EntryPayload


                    
                    
                    SMIEntryTypeMessage

This class provides additional details for the conversation entry when the entry type is SMIConversationEntryTypesMessage.

Declaration

Objective-C

@protocol SMIEntryTypeMessage <NSObject>

Swift

protocol EntryTypeMessage : NSObjectProtocol


                    
                    
                    SMIFileAsset

A file asset.

Declaration

Objective-C

@protocol SMIFileAsset

Swift

protocol FileAsset


                    
                    
                    SMIFileContent

Common interface for the content of an SMIConversationEntry object which manages files stored on disk.

Declaration

Objective-C

@protocol SMIFileContent

Swift

protocol FileContent


                    
                    
                    SMIHiddenPreChatDelegate

Delegate that handles requests for hidden pre-chat values.

See

SMICoreClient

Declaration

Objective-C

@protocol SMIHiddenPreChatDelegate

Swift

protocol HiddenPreChatDelegate


                    
                    
                    SMIHiddenPreChatField

A hidden pre-chat field.

Declaration

Objective-C

@protocol SMIHiddenPreChatField <SMIPreChatField>

Swift

protocol HiddenPreChatField : PreChatField


                    
                    
                    SMIImageAsset

Represents an image asset.

Declaration

Objective-C

@protocol SMIImageAsset <SMIFileAsset>

Swift

protocol ImageAsset : FileAsset


                    
                    
                    SMIListPicker

The entry type that allows you to pick an item from a list.

Declaration

Objective-C

@protocol
    SMIListPicker <SMIEntryPayload, SMIMessageSelectable, SMIEntryTypeMessage>

Swift

protocol ListPicker : EntryPayload, EntryTypeMessage, SMIMessageSelectable


                    
                    
                    SMILogging

Contains information about logging.

Declaration

Objective-C

@protocol SMILogging

Swift

protocol LoggingProtocol


                    
                    
                    SMIMessageSelectable

A message that has selectable choices.

Declaration

Objective-C

@protocol SMIMessageSelectable

Swift

protocol SMIMessageSelectable


                    
                    
                    SMIPDFAsset

A PDF asset.

Declaration

Objective-C

@protocol SMIPDFAsset <SMIFileAsset>

Swift

protocol PDFAsset : FileAsset


                    
                    
                    SMIParticipant

Represents a participant in a conversation.

Declaration

Objective-C

@protocol SMIParticipant

Swift

protocol Participant


                    
                    
                    SMIParticipantChanged

Represents a participant changed event. A participant changed event occurs whenever a participant joins or leaves a conversation.

Declaration

Objective-C

@protocol SMIParticipantChanged <SMIEntryPayload>

Swift

protocol ParticipantChanged : EntryPayload


                    
                    
                    SMIParticipantChangedOperation

Represents an operation that describes a participant change.

Declaration

Objective-C

@protocol SMIParticipantChangedOperation

Swift

protocol ParticipantChangedOperation


                    
                    
                    SMIParticipantClientMenu

Information about a participant client menu.

Declaration

Objective-C

@protocol SMIParticipantClientMenu

Swift

protocol ParticipantClientMenu


                    
                    
                    SMIParticipantClientMenuOption

Option associated with a participant client menu.

Declaration

Objective-C

@protocol SMIParticipantClientMenuOption <SMIChoice>

Swift

protocol ParticipantClientMenuOption : Choice


                    
                    
                    SMIPreChatChoiceListField

Represents a pre-chat choice list field.

Declaration

Objective-C

@protocol SMIPreChatChoiceListField <SMIPreChatField>

Swift

protocol PreChatChoiceListField : PreChatField


                    
                    
                    SMIPreChatConfiguration

Represents a pre-chat field.

Declaration

Objective-C

@protocol SMIPreChatConfiguration

Swift

protocol PreChatConfiguration


                    
                    
                    SMIPreChatField

Represents a pre-chat field.

Declaration

Objective-C

@protocol SMIPreChatField

Swift

protocol PreChatField


                    
                    
                    SMIQuickReply

Represents a quick reply message.

Declaration

Objective-C

@protocol
    SMIQuickReply <SMIEntryPayload, SMIMessageSelectable, SMIEntryTypeMessage>

Swift

protocol QuickReply : EntryPayload, EntryTypeMessage, SMIMessageSelectable


                    
                    
                    SMIRemoteConfiguration

Remote configuration information representing this embedded service deployment.

Declaration

Objective-C

@protocol SMIRemoteConfiguration

Swift

protocol RemoteConfiguration


                    
                    
                    SMIRichLinkMessage

Represents a rich link within an SMIConversationEntry.

Declaration

Objective-C

@protocol SMIRichLinkMessage <SMIEntryPayload, SMIEntryTypeMessage>

Swift

protocol RichLinkMessage : EntryPayload, EntryTypeMessage


                    
                    
                    SMIRoutingResult

Represents a routing result within an SMIConversationEntry.

Declaration

Objective-C

@protocol SMIRoutingResult <SMIEntryPayload>

Swift

protocol RoutingResult : EntryPayload


                    
                    
                    SMIRoutingWorkResult

Represents a routing work result within an SMIConversationEntry.

Declaration

Objective-C

@protocol SMIRoutingWorkResult <SMIEntryPayload>

Swift

protocol RoutingWorkResult : EntryPayload


                    
                    
                    SMITemplateable

Represents an array of parameters for a templateable URL used by the auto-response messaging component.

Declaration

Objective-C

@protocol SMITemplateable <NSObject>

Swift

protocol SMITemplateable : NSObjectProtocol


                    
                    
                    SMITemplatedURL

Represents a rich link within an SMIConversationEntry.

Declaration

Objective-C

@protocol SMITemplatedURL <SMIEntryPayload, SMIEntryTypeMessage>

Swift

protocol TemplatedURL : EntryPayload, EntryTypeMessage


                    
                    
                    SMITemplatedUrlDelegate

Delegate that handles requests for auto-response messaging component parameter values.

See

SMICoreClient

Declaration

Objective-C

@protocol SMITemplatedUrlDelegate

Swift

protocol TemplatedUrlDelegate


                    
                    
                    SMITextMessage

Represents a single text message within an SMIConversationEntry.

Declaration

Objective-C

@protocol SMITextMessage <SMIEntryPayload, SMIEntryTypeMessage>

Swift

protocol TextMessage : EntryPayload, EntryTypeMessage


                    
                    
                    SMITypingIndicator

Represents a typing indicator within an SMIConversationEntry.

Declaration

Objective-C

@protocol SMITypingIndicator <SMIEntryPayload>

Swift

protocol TypingIndicator : EntryPayload


                    
                    
                    SMIUnknownAsset

Describes an unknown asset.

Declaration

Objective-C

@protocol SMIUnknownAsset

Swift

protocol UnknownAsset


                    
                    
                    SMIUserVerificationDelegate

Delegate that handles requests for user verification.

See

SMICoreClient

Declaration

Objective-C

@protocol SMIUserVerificationDelegate <NSObject>

Swift

protocol UserVerificationDelegate : NSObjectProtocol