SDK Features
Agent-side integrations
Switching to full device mode
Controlling full device state from the agent UI
To switch to full device mode, the easiest way is to use the agent UI provided when in a Cobrowse session.
Toggle the "Full Device" switch to request access.
Controlling full device state from the SDKs
In some situations it is useful to be able to switch a Cobrowse session into full device mode using the SDK. For example, if you would like sessions to default to full device mode, or enforce full device mode is always (or never) used. We provide an API for doing this:
Web
iOS
Android
ReactNative
1
await session.setFullDevice(true)
Copied!
1
[session setFullDevice:YES callback:^(NSError* err, CBIOSession* session) {
2
// catch errors
3
}];
Copied!
1
session.setFullDevice(true, (err, arg) -> {
2
// handle error
3
});
Copied!
1
await session.setFullDevice(true)
Copied!
These APIs can be used in combination with our various delegate APIs to switch the session in and out of full device mode as your use case requires.
For example, to request full device is used by default, you can set the full device state when the session is first loaded by the SDK:
Web
iOS
Android
1
CobrowseIO.on('session.loaded', session => session.setFullDevice(true))
Copied!
1
// note: you must have implmented the CobrowseIODelegate
2
- (void)cobrowseSessionDidLoad:(CBIOSession *)session {
3
// ensure the screen share session is always in full device
4
[session setFullDevice:YES callback: null];
5
}
Copied!
1
// note: you must have implmented CobrowseIO.SessionLoadDelegate
2
@Override
3
public void sessionDidLoad(@NonNull Session session) {
4
session.setFullDevice(true, null);
5
}
Copied!
Controlling full device state from the Agent SDK
You may also set the full device state using the Agent SDK. See the Agent SDK API Reference for more details.
Last modified 3mo ago