Package com.unblu.sdk.module.mobilecobrowsing

Enum Class OutsideAppCaptureState

java.lang.Object
java.lang.Enum<OutsideAppCaptureState>
com.unblu.sdk.module.mobilecobrowsing.OutsideAppCaptureState
All Implemented Interfaces:
Serializable, Comparable<OutsideAppCaptureState>, Constable
public enum OutsideAppCaptureState extends Enum<OutsideAppCaptureState>
The state of out-of-app screen capture during mobile co-browsing (CoBrowsingCaptureMode.MEDIA_PROJECTION).

This state doesn't tell you whether co-browsing is active. In every state other than ACTIVE, co-browsing, if it's active, captures inside the app. To observe co-browsing itself, use UnbluConversation.isMobileCoBrowsingActive().

  • Enum Constant Details

    • INACTIVE

      public static final OutsideAppCaptureState INACTIVE
      The screen isn't being captured outside the app: co-browsing isn't running, the capture mode is CoBrowsingCaptureMode.SCREENSHOT, or a previous out-of-app capture ended with the session.

    • REQUESTING_PERMISSION

      public static final OutsideAppCaptureState REQUESTING_PERMISSION
      The system screen capture consent dialog is being shown. The next state is ACTIVE, DENIED, or FAILED.

    • ACTIVE

      public static final OutsideAppCaptureState ACTIVE
      The screen is being captured outside the app.

    • DENIED

      public static final OutsideAppCaptureState DENIED
      The user didn't grant screen capture consent, either by refusing or by dismissing the dialog. Co-browsing continues inside the app.

    • STOPPED

      public static final OutsideAppCaptureState STOPPED
      The user stopped screen capture from the system UI, or the system revoked it. Co-browsing continues inside the app.

    • FAILED

      public static final OutsideAppCaptureState FAILED
      Out-of-app capture couldn't be set up: screen capture isn't available on the device, or setup failed after the user granted consent.

  • Method Details

    • values

      public static OutsideAppCaptureState[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static OutsideAppCaptureState valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null