Managing full device mode

Learn how to promote a session to full device mode using the SDK, as per your requirements.

Managing 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:

await session.setFullDevice('requested')

[session setFullDevice:YES callback:^(NSError* err, CBIOSession* session) {
    // catch errors
}];

session.setFullDevice(true, (err, arg) -> {
    // handle error
});

await session.setFullDevice(true)

Session? session = await CobrowseIO.instance.currentSession();
if (session != null) {
    try {
        await session.setFullDevice(FullDeviceState.on);
    } on PlatformException catch (e) {
        // E.g. a network error
        log('Cannot update the full device state: ${e.message}');
    }
}

Session session = CobrowseIO.Instance.CurrentSession;
if (session != null)
{
    session.SetFullDeviceState(FullDeviceState.On, (err, session) =>
    {
        if (err != null)
        {
            // E.g. a network error
        }
        else
        {
            // Full device mode is activated
        }
    });
}

See this in action: https://github.com/cobrowseio/cobrowse-sdk-js-examples#full-device-mode-by-default.

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:

CobrowseIO.on('session.loaded', session => session.setFullDevice('requested'))

// note: you must have implmented the CobrowseIODelegate
- (void)cobrowseSessionDidLoad:(CBIOSession *)session {
    // ensure the screen share session is always in full device
    [session setFullDevice:YES callback: null];
}

// note: you must have implmented CobrowseIO.SessionLoadDelegate
@Override
public void sessionDidLoad(@NonNull Session session) {
    session.setFullDevice(true, null);
}

CobrowseIO.addListener('session.loaded', session => {
    console.log('A session was loaded', session)
    await session.setFullDevice(true)
})

CobrowseIO.instance.sessionDidLoad.listen((session) {
    try {
        await session.setFullDevice(FullDeviceState.on);
    } on PlatformException catch (e) {
        // E.g. a network error
        log('Cannot update the full device state: ${e.message}');
    }
});

CobrowseIO.Instance.SessionDidLoad += (sender, session) =>
{
    session.SetFullDeviceState(FullDeviceState.On, (err, session) =>
    {
        if (err != null)
        {
            // E.g. a network error
        }
        else
        {
            // Full device mode is activated
        }
    });
};

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.

PreviousFull device remote control NextAdvanced configuration

Last updated 6 days ago