Structures

The following structures are available globally.

  • Represents all info about an agent.

    See more

    Declaration

    Swift

    public struct Agent
  • Details about a file type allowed to be uploaded

    See more

    Declaration

    Swift

    public struct AllowedFileType
  • Represents info about an uploaded attachment.

    See more

    Declaration

    Swift

    public struct Attachment
  • The various options for how a channel is configured.

    See more

    Declaration

    Swift

    public struct ChannelConfiguration
  • All information about a chat thread as well as the messages for the thread.

    See more

    Declaration

    Swift

    public struct ChatThread : Identifiable
  • Represents info about an attachment data to be uploaded.

    See more

    Declaration

    Swift

    public struct ContentDescriptor
  • Complex type with subelements represented as a multi-root tree data structure.

    UI element, on the application side, should present nodes as a nested list and send picker nodes element’s value; if necessary.

    See more

    Declaration

    Swift

    public struct CustomFieldHierarchical
    extension CustomFieldHierarchical: Equatable
  • A single element of the PreChatSurveyHierarchical/nodes represented as a tree data structure.

    See more

    Declaration

    Swift

    public struct CustomFieldHierarchicalNode
    extension CustomFieldHierarchicalNode: Equatable
  • A list/selector element type. It contains list of options which are selected via dropdown picker, table or related UI element.

    See more

    Declaration

    Swift

    public struct CustomFieldSelector
    extension CustomFieldSelector: Equatable
  • A textfield element which contains simple textfield or e-mail.

    In case of e-mail, detectable with isEmail property, BE requires proper e-mail validation on the application side.

    See more

    Declaration

    Swift

    public struct CustomFieldTextField
    extension CustomFieldTextField: Equatable
  • Represents information about a customer identity to be sent on events.

    See more

    Declaration

    Swift

    public struct CustomerIdentity
  • Details about file uploads allowed.

    See more

    Declaration

    Swift

    public struct FileRestrictions
  • Represents all info about a message in a chat.

    See more

    Declaration

    Swift

    public struct Message
    extension Message: Equatable
  • All info about a payload of a message.

    See more

    Declaration

    Swift

    public struct MessagePayload
  • Represents outbound message which is send to an agent.

    See more

    Declaration

    Swift

    public struct OutboundMessage
  • A list picker displays a list of items, and information about the items.

    It is a list of options, that customers can choose multiple times and are persistent in the conversation. The options/items are usually shown in overlay with richer formatting capabilities (icon, title, subtitle, sections, etc. in future) and with a bigger count than buttons or quick replies.

    See more

    Declaration

    Swift

    public struct MessageListPicker
  • Text message with buttons. After the customer clicks on one of the buttons, its content is sent as a reply.

    Usually, when a reply is sent, it is no more possible to click again on any button. You can have between two and five (depending on the channel) customizable choices, and the user can select only a single item.

    When a quick reply is tapped, the buttons are dismissed, and the title of the tapped button is posted to the conversation as a message.

    See more

    Declaration

    Swift

    public struct MessageQuickReplies
  • A reply button rich message sub element.

    See more

    Declaration

    Swift

    public struct MessageReplyButton : Hashable
  • It is a URL link with an image preview and a defined title.

    The customer is able to click on it to be forwarded to the particular page.

    See more

    Declaration

    Swift

    public struct MessageRichLink
  • A definition of the pre-chat form which should be answered by the user before the new thread is created.

    See more

    Declaration

    Swift

    public struct PreChatSurvey
  • A pre-chat survey field element which should be presented to user before chat thread is created.

    See more

    Declaration

    Swift

    public struct PreChatSurveyCustomField
  • Represents info abount a content of a proactive action data message.

    See more

    Declaration

    Swift

    public struct ProactiveActionDataMessageContent
  • Represents all info about details of a proactive action.

    See more

    Declaration

    Swift

    public struct ProactiveActionDetails
  • Information about the sender of a chat message.

    See more

    Declaration

    Swift

    public struct SenderInfo
  • Represents statistics about the user.

    See more

    Declaration

    Swift

    public struct UserStatistics