canCreateSession (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.

Allows you to check if a new session can be created.

Syntax

Microsoft.CIFramework.canCreateSession().then(successCallback, errorCallback);

Parameters

Name Type Required Description
correlationId GUID No Used to group all related API calls together for diagnostic telemetry
successCallback Function No A function to call when the request for the current state of the panel is successful
errorCallback Function No A function to call when the request for the current state of the panel fails

Return value

Promise with the value as Boolean.

Example

Microsoft.CIFramework.canCreateSession(correlationId).then(
    function(result) {
        return Promise.resolve(result);
    },
    function(error) {
        return Promise.reject(error);
    });