requestFocusSession (JavaScript API Reference) for Dynamics 365 Channel Integration Framework 2.0

Note

This content applies only to Dynamics 365 Channel Integration Framework version 2.0.

Note

Session management APIs allow you to integrate multisession experiences in Customer Service workspace app only.

Shows a notification indicator on the session whose Session Id is passed as a parameter, if the session belongs to the channel provider. The notification indicator draws the user's attention to switch between sessions.

Syntax

Microsoft.CIFramework.requestFocusSession(sessionId, correlationId).(successCallback, errorCallback);

Parameters

Name Type Required Description
sessionId String Yes Unique identifier of the current session
correlationId GUID No Used to group all related API calls together for diagnostic telemetry.
successCallback Function No A function to call when the request is successful
errorCallback Function No A function to call when the request fails

Return Value

None

Example

Microsoft.CIFramework.requestFocusSession("session-id-1", correlationId).then(
    function (result) {
        return Promise.resolve(result);
    },
    function (error) {
        return Promise.reject(error)
};