UnbluConversation

public protocol UnbluConversation : AnyObject

An object representing an Unblu conversation

  • id

    The id of the conversation

    Declaration

    Swift

    var id: String { get }

  • Returns true if the conversation is currently open, false otherwise.

    Declaration

    Swift

    var isOpen: Bool { get }

  • Opens this conversation. If the UnbluView is visible, the conversation will be displayed there. The previous open conversation will be replaced with this one.

    Declaration

    Swift

    func open(onComplete: @escaping (Result<Void, UnbluConversationError>) -> Void)

    Parameters

    onComplete

    A block returning a Result type, with an UnbluConversationError if the requires fails.

  • Closes this conversation If the UnbluView is visible, the conversation overview will be displayed.

    Declaration

    Swift

    func close(onComplete: @escaping (Result<Void, UnbluConversationError>) -> Void)

    Parameters

    onComplete

    A block returning a Result type, with an UnbluConversationError if the requires fails.

  • Returns true if a call is active for this conversation

    Declaration

    Swift

    var isCallActive: Bool { get }

  • Returns true if the call ui is open for this conversation

    Declaration

    Swift

    var isCallUiOpen: Bool { get }

  • Opens and starts an audio call for this conversation. The UnbluCallModule must be registered to use this function.

    Declaration

    Swift

    func startAudioCall(onComplete: @escaping (Result<Void, UnbluConversationError>) -> Void)

    Parameters

    onComplete

    A block returning a Result type, with an UnbluConversationError if the requires fails.

  • Opens and starts a video call for this conversation. The UnbluCallModule must be registered to use this function.

    Declaration

    Swift

    func startVideoCall(onComplete: @escaping (Result<Void, UnbluConversationError>) -> Void)

    Parameters

    onComplete

    A block returning a Result type, with an UnbluConversationError if the requires fails.

  • Returns true if mobile co-browsing is active for this conversation

    Declaration

    Swift

    var isMobileCoBrowsingActive: Bool { get }

  • Opens and starts mobile co-browsing for this conversation. The UnbluMobileCoBrowsingModule must be registered to use this function.

    Declaration

    Swift

    func startMobileCoBrowsing(onComplete: @escaping (Result<Void, UnbluConversationError>) -> Void)

    Parameters

    onComplete

    A block returning a Result type, with an UnbluConversationError if the requires fails.

  • Stops mobile co-browsing for this conversation. The UnbluMobileCoBrowsingModule must be registered to use this function.

    Declaration

    Swift

    func stopMobileCoBrowsing(onComplete: @escaping (Result<Void, UnbluConversationError>) -> Void)

    Parameters

    onComplete

    A block returning a Result type, with an UnbluConversationError if the requires fails.