UnbluDocumentCoBrowsingModuleApi

public protocol UnbluDocumentCoBrowsingModuleApi : UnbluModule

The API for the document co-browsing module. Only usable if the corresponding module was registered in the configuration used.

  • Defines the current presentation mode for document co-browsing

    Declaration

    Swift

    var presentationMode: DocumentCoBrowsingPresentationMode { get set }

  • The delegate for events related to document co-browsing

    Declaration

    Swift

    var delegate: UnbluDocumentCoBrowsingModuleDelegate? { get set }

  • Checks whether document co-browsing is active

    Declaration

    Swift

    func isDocumentCoBrowsingActive(success: @escaping (Bool) -> Void)

    Parameters

    success

    Called with true if document co-browsing is active
    failure

    Called if the API isn’t initialized or the Collaboration Server doesn’t support document co-browsing

  • Stops the document co-browsing session

    Declaration

    Swift

    func stopDocumentCoBrowsing(stopLayer: Bool, success: @escaping (Bool) -> Void)

    Parameters

    stopLayer

    A Boolean indicating whether the associated document layer should also be stopped.
    success

    Returns false if document co-browsing is not supported or not active, and true in all other cases.

  • Checks whether the document co-browsing window is being dismissed

    Declaration

    Swift

    func isDocumentCobrowsingBeingDismissed(success: @escaping (Bool) -> Void)

    Parameters

    success

    A closure that’s called with a Boolean indicating whether the co-browsing UI is being dismissed (true) or not (false).

  • Presents (or re-presents) the document co-browsing UI to the user

    Declaration

    Swift

    func showDocumentCoBrowsing(success: @escaping (Bool) -> Void)

    Parameters

    success

    A closure that’s called with a Boolean indicating whether the co-browsing UI was shown successfully (true) or if an error/precondition prevented it (false).