Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- activate(Callback<Error, Session>) - Method in class io.cobrowse.Session
-
Transitions a session from pending or authorizing to active, allowing frames to start streaming.
- agent() - Method in class io.cobrowse.Session
-
Gets the basic information about the support agent in the session, or null if no agent has joined yet
- Agent - Class in io.cobrowse
-
Represents a support agent viewing the cobrowsing session
- api() - Method in class io.cobrowse.CobrowseIO
- api(String) - Method in class io.cobrowse.CobrowseIO
-
Configure the SDK to use an enterprise deployment API
- attachInfo(Context, ProviderInfo) - Method in class io.cobrowse.CobrowseInitProvider
C
- call(E, T) - Method in interface io.cobrowse.Callback
- Callback<E extends Error,
T> - Interface in io.cobrowse - capabilities() - Method in class io.cobrowse.CobrowseIO
- capabilities(String[]) - Method in class io.cobrowse.CobrowseIO
-
Sets the available capabilities for a session.
- CobrowseAccessibilityService - Class in io.cobrowse
- CobrowseAccessibilityService() - Constructor for class io.cobrowse.CobrowseAccessibilityService
- CobrowseAccessibilitySetup - Class in io.cobrowse.ui
- CobrowseAccessibilitySetup() - Constructor for class io.cobrowse.ui.CobrowseAccessibilitySetup
- CobrowseActivity - Class in io.cobrowse.ui
-
This is the default UI we provide for generating 6 digit codes in your app.
- CobrowseActivity() - Constructor for class io.cobrowse.ui.CobrowseActivity
- CobrowseInitProvider - Class in io.cobrowse
-
Initializes Cobrowse.io internal APIs at app startup time.
- CobrowseInitProvider() - Constructor for class io.cobrowse.CobrowseInitProvider
- CobrowseIO - Class in io.cobrowse
- CobrowseIO.Delegate - Interface in io.cobrowse
-
Implement this interface to customise the behaviour of Cobrowse.
- CobrowseIO.FullDeviceRequestDelegate - Interface in io.cobrowse
-
Implement this interface on your delegate to implement your own logic for handling full device requests.
- CobrowseIO.Redacted - Interface in io.cobrowse
-
Implement this interface on your Activity subclasses to provide a list of views used in that activity that should be removed from the agents view.
- CobrowseIO.RedactionDelegate - Interface in io.cobrowse
-
Implement this interface on your delegate to redact certain views from the frames leaving the device
- CobrowseIO.RemoteControlRequestDelegate - Interface in io.cobrowse
-
Implement this interface on your delegate to override the default logic for handling remote control requests.
- CobrowseIO.SessionControlsDelegate - Interface in io.cobrowse
-
Implement this interface on your delegate to get callbacks for when to show or hide your custom session indicators and controls.
- CobrowseIO.SessionLoadDelegate - Interface in io.cobrowse
-
Implement this interface on your delegate to listen for session load events.
- CobrowseIO.SessionRequestDelegate - Interface in io.cobrowse
-
Implement this interface on your delegate to override the default logic for handling incoming session requests.
- CobrowseIO.Unredacted - Interface in io.cobrowse
-
Implement this interface on your Activity subclasses to provide a list of views used in that activity that should be shown on the agents view.
- CobrowseIO.UnredactionDelegate - Interface in io.cobrowse
-
Implement this interface on your delegate to unredact certain views from the frames leaving the device.
- CobrowseRegistrationJob() - Constructor for class io.cobrowse.DeviceRegistrationLoop.CobrowseRegistrationJob
- CobrowseService - Class in io.cobrowse
-
A service that becomes foregrounded when there is an active session.
- CobrowseService() - Constructor for class io.cobrowse.CobrowseService
- CobrowseService.Receiver - Class in io.cobrowse
- code() - Method in class io.cobrowse.Session
-
The six digit code that can be shared with an agent to allow them to join the screen share.
- CodeDisplay - Class in io.cobrowse.ui
- CodeDisplay() - Constructor for class io.cobrowse.ui.CodeDisplay
- configure(Application) - Static method in class io.cobrowse.integrations.Intercom
- createSession(Callback<Error, Session>) - Method in class io.cobrowse.CobrowseIO
-
Creates a new screenshare session.
- currentSession() - Method in class io.cobrowse.CobrowseIO
-
Gets the current screenshare session.
- customData() - Method in class io.cobrowse.CobrowseIO
- customData(Map<String, Object>) - Method in class io.cobrowse.CobrowseIO
-
Sets metadata attached to this device that will be displayed and filterable in the web dashboard.
D
- delete(Uri, String, String[]) - Method in class io.cobrowse.CobrowseInitProvider
- DEVICE_ID_KEY - Static variable in class io.cobrowse.CobrowseIO
- DEVICE_NAME_KEY - Static variable in class io.cobrowse.CobrowseIO
- deviceId() - Method in class io.cobrowse.CobrowseIO
-
Returns the unique device ID generated by the Cobrowse SDK
- deviceId(Application) - Method in class io.cobrowse.CobrowseIO
-
Deprecated.
- DeviceRegistrationLoop - Class in io.cobrowse
- DeviceRegistrationLoop() - Constructor for class io.cobrowse.DeviceRegistrationLoop
- DeviceRegistrationLoop.CobrowseRegistrationJob - Class in io.cobrowse
E
- email - Variable in class io.cobrowse.Agent
-
The email of the support agent, may be nil if account privacy settings restrict access to the agent email
- end(Callback<Error, Session>) - Method in class io.cobrowse.Session
-
Ends a session.
- endSessionClicked(View) - Method in class io.cobrowse.ui.CobrowseActivity
- ErrorView - Class in io.cobrowse.ui
- ErrorView() - Constructor for class io.cobrowse.ui.ErrorView
F
- fullDevice() - Method in class io.cobrowse.Session
-
Deprecated.
- fullDeviceState() - Method in class io.cobrowse.Session
-
Checks whether the session is allowed to capture screens from outside the app.
G
- getSession(String, Callback<Error, Session>) - Method in class io.cobrowse.CobrowseIO
-
Fetches a session by its ID or by a 6 digit code.
- getType(Uri) - Method in class io.cobrowse.CobrowseInitProvider
H
- handleFullDeviceRequest(Activity, Session) - Method in interface io.cobrowse.CobrowseIO.FullDeviceRequestDelegate
-
Called when an agent requests full device screensharing.
- handleRemoteControlRequest(Activity, Session) - Method in interface io.cobrowse.CobrowseIO.RemoteControlRequestDelegate
-
Called when an agent requests remote control.
- handleSessionRequest(Activity, Session) - Method in interface io.cobrowse.CobrowseIO.SessionRequestDelegate
-
Called when a session has been requested.
- hasAgent() - Method in class io.cobrowse.Session
-
An agent has joined the session
- hideSessionControls(Activity, Session) - Method in interface io.cobrowse.CobrowseIO.SessionControlsDelegate
-
Called when session controls should be hidden.
I
- id - Variable in class io.cobrowse.Agent
-
The id of the support agent
- id() - Method in class io.cobrowse.Session
-
The ID of a session.
- init(Application) - Static method in class io.cobrowse.integrations.Integration
- insert(Uri, ContentValues) - Method in class io.cobrowse.CobrowseInitProvider
- instance() - Static method in class io.cobrowse.CobrowseIO
-
The main CobrowseIO singleton API
- Integration - Class in io.cobrowse.integrations
- Integration() - Constructor for class io.cobrowse.integrations.Integration
- Intercom - Class in io.cobrowse.integrations
- Intercom() - Constructor for class io.cobrowse.integrations.Intercom
- io.cobrowse - package io.cobrowse
- io.cobrowse.integrations - package io.cobrowse.integrations
- io.cobrowse.ui - package io.cobrowse.ui
- isActive() - Method in class io.cobrowse.Session
-
Tests if the session is in an active state
- isAuthorizing() - Method in class io.cobrowse.Session
-
Tests if the session is in a authorizing state (waiting for user consent)
- isAvailable() - Static method in class io.cobrowse.integrations.Intercom
- isCobrowseNotification(Map<String, String>) - Static method in class io.cobrowse.CobrowseIO
-
Tests whether a push notification was generated by Cobrowse.
- isEnabled(Context) - Static method in class io.cobrowse.CobrowseAccessibilityService
- isEnded() - Method in class io.cobrowse.Session
-
Tests if the session is in an ended state (can no longer be used or updated)
- isPending() - Method in class io.cobrowse.Session
-
Tests if the session is in a pending state (waiting for an agent, or device)
- isRunning(Context) - Static method in class io.cobrowse.CobrowseAccessibilityService
L
- license() - Method in class io.cobrowse.CobrowseIO
- license(String) - Method in class io.cobrowse.CobrowseIO
-
Sets the Cobrowse license (available via the web dashboard).
M
- ManageSession - Class in io.cobrowse.ui
- ManageSession() - Constructor for class io.cobrowse.ui.ManageSession
N
- name - Variable in class io.cobrowse.Agent
-
The display name of the support agent
- name() - Static method in class io.cobrowse.integrations.Intercom
O
- Off - Enum constant in enum class io.cobrowse.Session.FullDeviceState
- Off - Enum constant in enum class io.cobrowse.Session.RemoteControlState
- On - Enum constant in enum class io.cobrowse.Session.FullDeviceState
- On - Enum constant in enum class io.cobrowse.Session.RemoteControlState
- onAccessibilityEvent(AccessibilityEvent) - Method in class io.cobrowse.CobrowseAccessibilityService
- onBind(Intent) - Method in class io.cobrowse.CobrowseService
- onCreate() - Method in class io.cobrowse.CobrowseInitProvider
- onCreate(Bundle) - Method in class io.cobrowse.ui.RemoteControlConsentDialogFragment
- onCreate(Bundle) - Method in class io.cobrowse.ui.SessionConsentDialogFragment
- onCreateDialog(Bundle) - Method in class io.cobrowse.ui.RemoteControlConsentDialogFragment
- onCreateDialog(Bundle) - Method in class io.cobrowse.ui.SessionConsentDialogFragment
- onCreateView(LayoutInflater, ViewGroup, Bundle) - Method in class io.cobrowse.ui.CodeDisplay
- onCreateView(LayoutInflater, ViewGroup, Bundle) - Method in class io.cobrowse.ui.ErrorView
- onCreateView(LayoutInflater, ViewGroup, Bundle) - Method in class io.cobrowse.ui.ManageSession
- onDestroy() - Method in class io.cobrowse.CobrowseAccessibilityService
- onDestroyView() - Method in class io.cobrowse.ui.RemoteControlConsentDialogFragment
- onDestroyView() - Method in class io.cobrowse.ui.SessionConsentDialogFragment
- onInterrupt() - Method in class io.cobrowse.CobrowseAccessibilityService
- onPushNotification(Map<String, String>) - Method in class io.cobrowse.CobrowseIO
-
Call this when your Firebase handler receives a push notification.
- onReceive(Context, Intent) - Method in class io.cobrowse.CobrowseService.Receiver
- onStartCommand(Intent, int, int) - Method in class io.cobrowse.CobrowseService
- onStartJob(JobParameters) - Method in class io.cobrowse.DeviceRegistrationLoop.CobrowseRegistrationJob
- onStopJob(JobParameters) - Method in class io.cobrowse.DeviceRegistrationLoop.CobrowseRegistrationJob
- openAccessibilitySettings(View) - Method in class io.cobrowse.ui.CobrowseAccessibilitySetup
Q
- query(Uri, String[], String, String[], String) - Method in class io.cobrowse.CobrowseInitProvider
R
- Receiver() - Constructor for class io.cobrowse.CobrowseService.Receiver
- redactedViews() - Method in interface io.cobrowse.CobrowseIO.Redacted
-
List the views that should be hidden from the agents view, except for the views specified in
CobrowseIO.Unredacted.unredactedViews(). - redactedViews() - Method in class io.cobrowse.CobrowseIO
- redactedViews(Activity) - Method in interface io.cobrowse.CobrowseIO.RedactionDelegate
-
Specify which views should be redacted before sending.
- redactedViews(String[]) - Method in class io.cobrowse.CobrowseIO
-
Sets the selectors which will be used to redact views.
- registerSessionListener(Session.Listener) - Method in class io.cobrowse.Session
-
Adds a listener to be notified of changes in a session
- registration() - Method in class io.cobrowse.CobrowseIO
- registration(boolean) - Method in class io.cobrowse.CobrowseIO
-
By default, when the SDK starts it will register the device to your account and share its connectivity state.
- Rejected - Enum constant in enum class io.cobrowse.Session.FullDeviceState
- Rejected - Enum constant in enum class io.cobrowse.Session.RemoteControlState
- remoteControl() - Method in class io.cobrowse.Session
- RemoteControlConsentDialogFragment - Class in io.cobrowse.ui
- RemoteControlConsentDialogFragment() - Constructor for class io.cobrowse.ui.RemoteControlConsentDialogFragment
- removeSessionListener(Session.Listener) - Method in class io.cobrowse.Session
-
Removes a session change listener
- render(View) - Method in class io.cobrowse.ui.CodeDisplay
- Requested - Enum constant in enum class io.cobrowse.Session.FullDeviceState
- Requested - Enum constant in enum class io.cobrowse.Session.RemoteControlState
S
- Session - Class in io.cobrowse
- Session.FullDeviceState - Enum Class in io.cobrowse
-
Describes the state of the full device feature in a
Session. - Session.Listener - Interface in io.cobrowse
-
Interface for subscribing to changes in Session state
- Session.RemoteControlState - Enum Class in io.cobrowse
-
Describes the state of the remote control feature in a
Session. - SessionConsentDialogFragment - Class in io.cobrowse.ui
- SessionConsentDialogFragment() - Constructor for class io.cobrowse.ui.SessionConsentDialogFragment
- sessionDidEnd(Session) - Method in interface io.cobrowse.Session.Listener
-
Called when a session ends and can no longer be modified
- sessionDidLoad(Session) - Method in interface io.cobrowse.CobrowseIO.SessionLoadDelegate
-
Called when a session has been loaded for the first time.
- sessionDidUpdate(Session) - Method in interface io.cobrowse.Session.Listener
-
Called whenever a session property changes
- setCapabilities(String[], Callback<Error, Session>) - Method in class io.cobrowse.Session
-
Sets the available capabilities for the session.
- setCode(String) - Method in class io.cobrowse.ui.CodeDisplay
- setDelegate(CobrowseIO.Delegate) - Method in class io.cobrowse.CobrowseIO
-
Sets the CobrowseIO.Delegate that enables you to customise many of the elements and behaviours of the CobrowseSDK
- setDeviceToken(Application, String) - Method in class io.cobrowse.CobrowseIO
-
Deprecated.The Application parameter is ignored. Use the parameterless
CobrowseIO.setDeviceToken(String)()} method instead. - setDeviceToken(String) - Method in class io.cobrowse.CobrowseIO
-
Sets the device native channel push notification token, i.e.
- setFullDevice(boolean, Callback<Error, Session>) - Method in class io.cobrowse.Session
-
Deprecated.
- setFullDeviceState(Session.FullDeviceState, Callback<Error, Session>) - Method in class io.cobrowse.Session
-
Whether the app should try to capture screens from outside the app or not.
- setRemoteControl(Session.RemoteControlState, Callback<Error, Session>) - Method in class io.cobrowse.Session
- show(Activity) - Method in class io.cobrowse.ui.RemoteControlConsentDialogFragment
- show(Activity) - Method in class io.cobrowse.ui.SessionConsentDialogFragment
- showSessionControls(Activity, Session) - Method in interface io.cobrowse.CobrowseIO.SessionControlsDelegate
-
Called when session controls should be shown.
- showSetup(Context) - Static method in class io.cobrowse.CobrowseAccessibilityService
- start() - Method in class io.cobrowse.CobrowseIO
-
Call start() when you have configured Cobrowse and would like to start accepting incoming session requests.
- start(Activity) - Method in class io.cobrowse.CobrowseIO
-
Deprecated.The Activity parameter is ignored. Use the parameterless
CobrowseIO.start()method instead. - start(Application) - Method in class io.cobrowse.CobrowseIO
-
Deprecated.The Application parameter is ignored. Use the parameterless
CobrowseIO.start()method instead. - state() - Method in class io.cobrowse.Session
-
The state of the session.
- stop() - Method in class io.cobrowse.CobrowseIO
-
Stops Cobrowse, de-registering the device from the server and closing any open connections.
U
- unredactedViews() - Method in interface io.cobrowse.CobrowseIO.Unredacted
-
List the views that should be shown on the agents view no matter what is specified in
CobrowseIO.Redacted.redactedViews(). - unredactedViews() - Method in class io.cobrowse.CobrowseIO
- unredactedViews(Activity) - Method in interface io.cobrowse.CobrowseIO.UnredactionDelegate
-
Specify which views should not be redacted before sending.
- unredactedViews(String[]) - Method in class io.cobrowse.CobrowseIO
-
Sets the selectors which will be used to unredact views.
- update(Uri, ContentValues, String, String[]) - Method in class io.cobrowse.CobrowseInitProvider
- update(Map<String, Object>, Callback<Error, Session>) - Method in class io.cobrowse.Session
- USER_EMAIL_KEY - Static variable in class io.cobrowse.CobrowseIO
- USER_ID_KEY - Static variable in class io.cobrowse.CobrowseIO
- USER_NAME_KEY - Static variable in class io.cobrowse.CobrowseIO
V
- valueOf(String) - Static method in enum class io.cobrowse.Session.FullDeviceState
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.cobrowse.Session.RemoteControlState
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.cobrowse.Session.FullDeviceState
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.cobrowse.Session.RemoteControlState
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- webviewRedactedViews() - Method in class io.cobrowse.CobrowseIO
- webviewRedactedViews(String[]) - Method in class io.cobrowse.CobrowseIO
-
Sets the CSS selectors which will be used to redact content within WebViews.
All Classes and Interfaces|All Packages|Constant Field Values
CobrowseIO.deviceId()method instead.