SMIConversation

Objective-C

@protocol SMIConversation

Swift

protocol Conversation

Protocol that represents a conversation.

  • The conversation ID, which is used to associate all messages and events with a given conversation.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSUUID *_Nonnull identifier;

    Swift

    var identifier: UUID { get }

  • The list of participants that are associated with a given conversation.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSArray<id<SMIParticipant>> *_Nonnull participants;

    Swift

    var participants: [any Participant] { get }

  • The list of active participants that are associated with a given conversation.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSArray<id<SMIParticipant>> *_Nonnull activeParticipants;

    Swift

    var activeParticipants: [any Participant] { get }

  • The list of pre-chat fields that are associated with a given conversation.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSArray<id<SMIPreChatField>> *_Nonnull preChatFields;

    Swift

    var preChatFields: [any PreChatField] { get }

  • The list of hidden pre-chat fields that are associated with a given conversation.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSArray<id<SMIHiddenPreChatField>> *_Nonnull hiddenPreChatFields;

    Swift

    var hiddenPreChatFields: [any HiddenPreChatField] { get }

  • The timestamp of the last pre-chat submission.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) NSDate *preChatSubmissionTimestamp;

    Swift

    var preChatSubmissionTimestamp: Date? { get }

  • Undocumented

    Declaration

    Objective-C

    @property (nullable, nonatomic, readonly, strong) NSDate *created

    Swift

    var created: Date? { get }

  • The Terms and Conditions.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) id<SMITermsAndConditions> termsAndConditions;

    Swift

    var termsAndConditions: (any TermsAndConditions)? { get }

  • The API name for the embedded service deployment associated with this configuration.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull developerName;

    Swift

    var developerName: String { get }

  • The current status of the conversation.

    See

    SMIConversationStatus

    Declaration

    Objective-C

    @property (nonatomic, readonly) SMIConversationStatus status;

    Swift

    var status: ConversationStatus { get }

  • Holds a reference to a SMIConversationEntry representing what has been marked as read by the consuming client.

    Note

    Outbound in this case refers to the direction of the read acknowledgement. It is the logical reverse of the direction of the message itself.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) id<SMIConversationEntry> outboundHighWaterMark;

    Swift

    var outboundHighWaterMark: (any ConversationEntry)? { get }

  • Holds a reference to a SMIConversationEntry representing what has been marked as read by the remote participant.

    Note

    Inbound in this case refers to the direction of the read acknowledgement. It is the logical reverse of the direction of the message itself.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) id<SMIConversationEntry> inboundHighWaterMark;

    Swift

    var inboundHighWaterMark: (any ConversationEntry)? { get }

  • Returns the last conversation entry which is considered to represent activity.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) id<SMIConversationEntry> lastActiveEntry;

    Swift

    var lastActiveEntry: (any ConversationEntry)? { get }

  • Returns the number of unread messages on the conversation.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSUInteger unreadMessageCount;

    Swift

    var unreadMessageCount: UInt { get }