Protocols Reference


                    
                    
                    SMIAttachmentEntry

Attachment entry.

Declaration

Objective-C

@protocol
    SMIAttachmentEntry <SMIEntryPayload, SMIEntryTypeMessage, SMIAttachments>

Swift

protocol AttachmentEntry : Attachments, EntryPayload, EntryTypeMessage


                    
                    
                    SMIAttachments

Attachment entry.

Declaration

Objective-C

@protocol SMIAttachments

Swift

protocol Attachments


                    
                    
                    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


                    
                    
                    SMICarousel

A response type that represents a specific choice.

Declaration

Objective-C

@protocol SMICarousel <SMIEntryPayload, SMIMessageSelectable,
                       SMIEntryTypeMessage, SMIAttachments>

Swift

protocol Carousel : Attachments, EntryPayload, EntryTypeMessage, SMIMessageSelectable


                    
                    
                    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


                    
                    
                    SMICitation

Represents a citation.

Declaration

Objective-C

@protocol SMICitation <NSObject>

Swift

protocol Citation : NSObjectProtocol


                    
                    
                    SMICitationClaim

Represents the start and end locations of a given citation.

Declaration

Objective-C

@protocol SMICitationClaim <NSObject>

Swift

protocol CitationClaim : NSObjectProtocol


                    
                    
                    SMICitationContent

Represents the citations for a given text message entry.

Declaration

Objective-C

@protocol SMICitationContent <NSObject>

Swift

protocol CitationContent : NSObjectProtocol


                    
                    
                    SMICitedDetails

Represents the location data of a given citation.

Declaration

Objective-C

@protocol SMICitedDetails <NSObject>

Swift

protocol CitedDetails : NSObjectProtocol


                    
                    
                    SMICitedInlineMetadata

Represents the location data of a given citation.

Declaration

Objective-C

@protocol SMICitedInlineMetadata <NSObject>

Swift

protocol CitedInlineMetadata : NSObjectProtocol


                    
                    
                    SMICitedReference

Represents the link information of citation.

Declaration

Objective-C

@protocol SMICitedReference <NSObject>

Swift

protocol CitedReference : NSObjectProtocol


                    
                    
                    SMIComposedStreamingToken

Represents a conversation entry composed with a number of SMIStreamingToken.

Declaration

Objective-C

@protocol SMIComposedStreamingToken <SMIEntryPayload>

Swift

protocol ComposedStreamingToken : EntryPayload


                    
                    
                    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


                    
                    
                    SMIDataAsset

A Data asset.

Declaration

Objective-C

@protocol SMIDataAsset <SMIFileAsset>

Swift

protocol DataAsset : FileAsset


                    
                    
                    SMIEntryAck

Represents a single acknowledgement of an SMIConversationEntry.

Declaration

Objective-C

@protocol SMIEntryAck <SMIEntryPayload>

Swift

protocol EntryAck : EntryPayload


                    
                    
                    SMIEntryFormat

Undocumented

Declaration

Objective-C

@protocol SMIEntryFormat

@property (nonatomic, readonly, assign) SMIConversationFormatTypes type;

@end

Swift

protocol EntryFormat


                    
                    
                    SMIEntryFormatText

Undocumented

Declaration

Objective-C

@protocol SMIEntryFormatText <SMIEntryFormat>

@property (nonatomic, readonly, strong) NSString *text;

@end

Swift

protocol EntryFormatText : EntryFormat


                    
                    
                    SMIEntryPayload

Common interface for the content of an SMIConversationEntry object.

Declaration

Objective-C

@protocol SMIEntryPayload <NSCopying>

Swift

protocol EntryPayload : NSCopying


                    
                    
                    SMIEntryTypeFormMessage

Represents a secure form message within an SMIConversationEntry.

Declaration

Objective-C

@protocol SMIEntryTypeFormMessage <SMIEntryPayload, SMIEntryTypeMessage>

Swift

protocol EntryTypeFormMessage : EntryPayload, EntryTypeMessage


                    
                    
                    SMIEntryTypeFormResponseMessage

Represents a form response message within an SMIConversationEntry.

Declaration

Objective-C

@protocol SMIEntryTypeFormResponseMessage <SMIEntryPayload, SMIEntryTypeMessage>

Swift

protocol EntryTypeFormResponseMessage : EntryPayload, EntryTypeMessage


                    
                    
                    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


                    
                    
                    SMIFallbackMessage

The Terms and Condtions for prechat.

Declaration

Objective-C

@protocol SMIFallbackMessage <NSObject>

Swift

protocol FallbackMessage : NSObjectProtocol


                    
                    
                    SMIFileAsset

A file asset.

Declaration

Objective-C

@protocol SMIFileAsset

Swift

protocol FileAsset


                    
                    
                    SMIFormDatePickerInput

Represents a date input on a form.

Declaration

Objective-C

@protocol SMIFormDatePickerInput <SMIFormInput>

Swift

protocol FormDatePickerInput : FormInput


                    
                    
                    SMIFormErrorResult

Represents a failed SMIFormInputs submission.

Declaration

Objective-C

@protocol SMIFormErrorResult <SMIFormResult>

Swift

protocol FormErrorResult : FormResult


                    
                    
                    SMIFormInput

Represents an input on a form. The type of input is variable based on the form configuration.

Declaration

Objective-C

@protocol SMIFormInput <NSObject>

Swift

protocol FormInput : NSObjectProtocol


                    
                    
                    SMIFormInputSection

Represents a section of a form to collect user input.

Declaration

Objective-C

@protocol SMIFormInputSection <NSObject>

Swift

protocol FormInputSection : NSObjectProtocol


                    
                    
                    SMIFormInputValue

Represents a static form input value.

Declaration

Objective-C

@protocol SMIFormInputValue <NSObject>

Swift

protocol SMIFormInputValue : NSObjectProtocol


                    
                    
                    SMIFormInputs

Represents a form.

Declaration

Objective-C

@protocol SMIFormInputs <SMIEntryTypeFormMessage>

Swift

protocol FormInputs : EntryTypeFormMessage


                    
                    
                    SMIFormOptionPickerInput

Represents a selectable input on a form for a single selection.

Declaration

Objective-C

@protocol SMIFormOptionPickerInput <SMIFormInput>

Swift

protocol FormOptionPickerInput : FormInput


                    
                    
                    SMIFormRecordsResult

Represents a successful SMIFormResponseInputs submission.

Declaration

Objective-C

@protocol SMIFormRecordsResult <SMIFormResult>

Swift

protocol FormRecordsResult : FormResult


                    
                    
                    SMIFormResponseDateTimeValue

Represents a datetime value of an input response.

Declaration

Objective-C

@protocol SMIFormResponseDateTimeValue <SMIFormResponseValue>

Swift

protocol FormResponseDateTimeValue : FormResponseValue


                    
                    
                    SMIFormResponseDateValue

Represents a date value of an input response.

Declaration

Objective-C

@protocol SMIFormResponseDateValue <SMIFormResponseValue>

Swift

protocol FormResponseDateValue : FormResponseValue


                    
                    
                    SMIFormResponseDoubleValue

Represents a double value of an input response.

Declaration

Objective-C

@protocol SMIFormResponseDoubleValue <SMIFormResponseValue>

Swift

protocol FormResponseDoubleValue : FormResponseValue


                    
                    
                    SMIFormResponseInputs

Represents a form response.

Declaration

Objective-C

@protocol SMIFormResponseInputs <SMIEntryTypeFormResponseMessage>

Swift

protocol FormResponseInputs : EntryTypeFormResponseMessage


                    
                    
                    SMIFormResponseIntegerValue

Represents an integer value of an input response.

Declaration

Objective-C

@protocol SMIFormResponseIntegerValue <SMIFormResponseValue>

Swift

protocol FormResponseIntegerValue : FormResponseValue


                    
                    
                    SMIFormResponseResult

Represents a form response result message within an SMIConversationEntry.

Declaration

Objective-C

@protocol SMIFormResponseResult <SMIEntryTypeFormResponseMessage>

Swift

protocol FormResponseResult : EntryTypeFormResponseMessage


                    
                    
                    SMIFormResponseTextValue

Represents a text value of an input response.

Declaration

Objective-C

@protocol SMIFormResponseTextValue <SMIFormResponseValue>

Swift

protocol FormResponseTextValue : FormResponseValue


                    
                    
                    SMIFormResponseURLValue

Represents a URL value of an input response.

Declaration

Objective-C

@protocol SMIFormResponseURLValue <SMIFormResponseValue>

Swift

protocol FormResponseURLValue : FormResponseValue


                    
                    
                    SMIFormResponseValue

Represents a value of an input response.

Declaration

Objective-C

@protocol SMIFormResponseValue <NSObject>

Swift

protocol FormResponseValue : NSObjectProtocol


                    
                    
                    SMIFormResult

Represents a result of a SMIFormResponseInputs submission.

Declaration

Objective-C

@protocol SMIFormResult <NSObject>

Swift

protocol FormResult : NSObjectProtocol


                    
                    
                    SMIFormSelectInput

Represents a selectable input on a form for single or multiple selections.

Declaration

Objective-C

@protocol SMIFormSelectInput <SMIFormInput>

Swift

protocol FormSelectInput : FormInput


                    
                    
                    SMIFormSelectedOption

Represents a selected response of a multi-option form input.

Declaration

Objective-C

@protocol SMIFormSelectedOption <NSObject>

Swift

protocol SelectedOption : NSObjectProtocol


                    
                    
                    SMIFormSelectedOptionsInputValue

Represents the selected response values of a multi-option form input.

Declaration

Objective-C

@protocol SMIFormSelectedOptionsInputValue <SMIFormInputValue>

Swift

protocol FormSelectedOptionsInputValue : SMIFormInputValue


                    
                    
                    SMIFormSingleInputSection

Represents a section of a form to collect user input for a single value.

Declaration

Objective-C

@protocol SMIFormSingleInputSection <SMIFormInputSection>

Swift

protocol FormSingleInputSection : FormInputSection


                    
                    
                    SMIFormSingleInputValue

Represents a response of a single value form input.

Declaration

Objective-C

@protocol SMIFormSingleInputValue <SMIFormInputValue>

Swift

protocol FormSingleInputValue : SMIFormInputValue


                    
                    
                    SMIFormTextInput

Represents a text input on a form.

Declaration

Objective-C

@protocol SMIFormTextInput <SMIFormInput>

Swift

protocol FormTextInput : FormInput


                    
                    
                    SMIFormTitleInteractionItem

Represents an object containing SMIFormTitleItem and is used as an interactive element on a form.

Declaration

Objective-C

@protocol SMIFormTitleInteractionItem <NSObject>

Swift

protocol FormTitleInteractionItem : NSObjectProtocol


                    
                    
                    SMIFormTitleItem

Represents a title option displayed on components within a form.

Declaration

Objective-C

@protocol SMIFormTitleItem <NSObject>

Swift

protocol FormTitleItem : NSObjectProtocol


                    
                    
                    SMIFormTitleOptionItem

Represents a selectable option which contains a title.

Declaration

Objective-C

@protocol SMIFormTitleOptionItem <SMIFormTitleInteractionItem>

Swift

protocol FormInputOptionItem : FormTitleInteractionItem


                    
                    
                    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


                    
                    
                    SMIInlineMetadataCitedDetails

Represents the location data of a given citation.

Declaration

Objective-C

@protocol SMIInlineMetadataCitedDetails <SMICitedDetails>

Swift

protocol InlineMetadataCitedDetails : CitedDetails


                    
                    
                    SMILinkCitedReference

Represents the link information of citation.

Declaration

Objective-C

@protocol SMILinkCitedReference <SMICitedReference>

Swift

protocol LinkCitedReference : CitedReference


                    
                    
                    SMIListPicker

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

Declaration

Objective-C

@protocol SMIListPicker <SMIEntryPayload, SMIMessageSelectable,
                         SMIEntryTypeMessage, SMIMessageChoices>

Swift

protocol ListPicker : EntryPayload, EntryTypeMessage, SMIMessageChoices, SMIMessageSelectable


                    
                    
                    SMILogging

Contains information about logging.

Declaration

Objective-C

@protocol SMILogging

Swift

protocol LoggingProtocol


                    
                    
                    SMIMessageChoices

A message that has selectable choices.

Declaration

Objective-C

@protocol SMIMessageChoices

Swift

protocol SMIMessageChoices


                    
                    
                    SMIMessageSelectable

A message that has selectable choices.

Declaration

Objective-C

@protocol SMIMessageSelectable

Swift

protocol SMIMessageSelectable


                    
                    
                    SMIMessageStreamingToken

Represents an individual streamed token which contains part of a full message.

Declaration

Objective-C

@protocol SMIMessageStreamingToken <SMIStreamingToken>

Swift

protocol MessageStreamingToken : StreamingToken


                    
                    
                    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


                    
                    
                    SMIProgressIndicator

Represents a typing indicator within an SMIConversationEntry.

Declaration

Objective-C

@protocol SMIProgressIndicator <SMIEntryPayload>

Swift

protocol ProgressIndicator : EntryPayload


                    
                    
                    SMIQuickReply

Represents a quick reply message.

Declaration

Objective-C

@protocol SMIQuickReply <SMIEntryPayload, SMIMessageSelectable,
                         SMIEntryTypeMessage, SMIMessageChoices>

Swift

protocol QuickReply : EntryPayload, EntryTypeMessage, SMIMessageChoices, 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


                    
                    
                    SMIStreamingToken

Represents an individual streamed token which is part of a series of tokens each of which contain a fragment of a complete entry payload.

Declaration

Objective-C

@protocol SMIStreamingToken <SMIEntryPayload>

Swift

protocol StreamingToken : EntryPayload


                    
                    
                    SMIStreamingTokenValidation

Represents a validation event which is related to a SMIComposedStreamingToken containing the same targetMessageIdentifier This token is used as an indication as to whether the content of the stream has been validated as acceptable by the backend LLM.

Declaration

Objective-C

@protocol SMIStreamingTokenValidation <SMIStreamingToken>

Swift

protocol StreamingTokenValidation : StreamingToken


                    
                    
                    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


                    
                    
                    SMITermsAndConditions

The Terms and Condtions for prechat.

Declaration

Objective-C

@protocol SMITermsAndConditions <NSObject>

Swift

protocol TermsAndConditions : NSObjectProtocol


                    
                    
                    SMITextMessage

Represents a single text message within an SMIConversationEntry.

Declaration

Objective-C

@protocol SMITextMessage <SMIEntryPayload, SMIEntryTypeMessage>

Swift

protocol TextMessage : EntryPayload, EntryTypeMessage


                    
                    
                    SMITitleImageItem

Undocumented

Declaration

Objective-C

@protocol SMITitleImageItem <SMIFormTitleItem>

@property (nonatomic, readonly, strong) NSString *imageId;

@end

Swift

protocol TitleImageItem : FormTitleItem


                    
                    
                    SMITitleLinkItem

Representative of TitleLinkItem that will be used to respresent items in the chat feed.

Declaration

Objective-C

@protocol SMITitleLinkItem <NSObject>

Swift

protocol TitleLinkItem : NSObjectProtocol


                    
                    
                    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 <SMIFileAsset>

Swift

protocol UnknownAsset : FileAsset


                    
                    
                    SMIUnknownEntry

Represents an unknown conversation entry.

Declaration

Objective-C

@protocol SMIUnknownEntry <SMIEntryPayload>

Swift

protocol UnknownEntry : EntryPayload


                    
                    
                    SMIUserVerificationDelegate

Delegate that handles requests for user verification.

See

SMICoreClient

Declaration

Objective-C

@protocol SMIUserVerificationDelegate <NSObject>

Swift

protocol UserVerificationDelegate : NSObjectProtocol


                    
                    
                    SMIFormRecordResult

Represents a record that has been updated or created as a result of a SMIFormResponseInputs submission.

Declaration

Objective-C

@protocol SMIFormRecordResult <NSObject>

Swift

protocol FormRecordResult : NSObjectProtocol