Package com.unblu.sdk.core.conversation

Interface UnbluConversation

  • public interface UnbluConversation

    • Method Detail

      • getId

        java.lang.String getId()
        Returns id value for this conversation
        Returns:
        String value of id

      • isOpen

        io.reactivex.rxjava3.core.Observable<java.lang.Boolean> isOpen()
        Triggered whenever this conversation opens/closes with Boolean value This Observable will always emit the current value
        Returns:
        Observable

      • isOpenValue

        java.lang.Boolean isOpenValue()
        Returns:
        true if this conversation is open

      • open

        void open​(SuccessVoidCallback success,
          OpenConversationExceptionCallback failure)
        Open this conversation. If the `UnbluView` is visible, the conversation will also be displayed there. The previous open conversation will be replaced with this one.
        Parameters:
        success - : A callback returning a void result when the conversation was successfully opened.
        failure - : A callback returning OpenConversationErrorType if the request fails.

      • isCallActiveValue

        boolean isCallActiveValue()
        Returns:
        true if a call is active for this conversation. If the `CallModule` is not registered, this will always return false.

      • isCallActive

        io.reactivex.rxjava3.core.Observable<java.lang.Boolean> isCallActive()
        Triggered when a call starts or stops for this conversation. It will always emit the current state once

        The `CallModule` must be registered to use this function. If not, this will always emit false once.

        Returns:
        Observable

      • isCallUiOpen

        io.reactivex.rxjava3.core.Observable<java.lang.Boolean> isCallUiOpen()
        Triggered when the call UI is open/closed for this conversation. It will always emit the current state once

        The `CallModule` must be registered to use this function.

        Returns:
        Observable

      • isCallUiOpenValue

        boolean isCallUiOpenValue()
        Returns:
        true if the call ui is open for this conversation. If the `CallModule` is not registered, this will always return false.

      • startAudioCall

        void startAudioCall​(@Nullable
                    SuccessVoidCallback success,
                    @Nullable
                    StartAudioCallExceptionCallback failure)
        Open and starts an audio call for this conversation. IMPORTANT: The `CallModule` must be registered to use this function.
        Parameters:
        success - : A callback returning a void type after the call has started
        failure - A callback returning StartAudioCallErrorType if the request fails.

      • startVideoCall

        void startVideoCall​(@Nullable
                    SuccessVoidCallback success,
                    @Nullable
                    StartVideoCallExceptionCallback failure)
        Open and starts a video call for this conversation. The `CallModule` must be registered to use this function.
        Parameters:
        success - : A callback returning a void type after the call has started
        failure - A callback returning StartVideoCallErrorType if the request fails.

      • isMobileCoBrowsingActiveValue

        boolean isMobileCoBrowsingActiveValue()
        Returns always false if the `MobileCoBrowsingModule` is not registered
        Returns:
        true if co-browsing is active for this conversation

      • isMobileCoBrowsingActive

        io.reactivex.rxjava3.core.Observable<java.lang.Boolean> isMobileCoBrowsingActive()
        Triggered when an mobile co-browsing session active state is changed for this conversation. The `MobileCoBrowsingModule` must be registered to use this function. It will always emit the current state once
        Returns:
        Observable

      • startMobileCoBrowsing

        void startMobileCoBrowsing​(@Nullable
                           SuccessVoidCallback success,
                           @Nullable
                           MobileCoBrowsingExceptionCallback failure)
        Opens the conversation and starts mobile co-browsing. IMPORTANT: The `MobileCoBrowsingModule` must be registered to use this function.
        Parameters:
        success - : A callback returning a void type.
        failure - A callback returning MobileCoBrowsingErrorType if the request fails.

      • stopMobileCoBrowsing

        void stopMobileCoBrowsing​(@Nullable
                          SuccessVoidCallback success,
                          @Nullable
                          MobileCoBrowsingExceptionCallback failure)
        Stops mobile co-browsing for this conversation. The `MobileCoBrowsingModule` must be registered to use this function.
        Parameters:
        success - : A callback returning a void type.
        failure - A callback returning MobileCoBrowsingErrorType if the request fails.