createSession (App-Profil-Manager)

Erstellt eine Sitzung basierend auf einer Sitzungsvorlage und gibt die eindeutige Kennung der Sitzung zurück.

Syntax

Microsoft.Apm.createSession(SessionInput);

Die Parameter

Name	Typ	Erforderlich	Description
Session-Eingabe	String	Yes	JSON-Eingabeeigenschaften der Sitzung, die erstellt werden soll.

Die Struktur des JSON-Parameters SessionInput sieht wie folgt aus:

{
        /**
         * Returns the name of the template used in the session
         */
        templateName: string;
        /**
         * additional information for session creation
         */
        sessionContext: Map<string, string>;
        /**
         * will focus after session is created
         */
        isFocused?: boolean;
        /**
         * Indicates whether the session should be restored after creation.
         * If set to true, the session is restored in the agent workspace. Else, the session is created without being restored.
         */
        shouldRestore?: boolean;
    }

Rückgabewert

Sitzungskennung als Zeichenfolge.

Examples

In diesen Beispielen wird die createSession Methode verwendet, um eine neue Sitzung zu erstellen, die einen Entitätsdatensatzbezeichner und eine Sitzungsvorlage als Parameter übergibt.

Erstellen einer Basissitzung

Erstellt eine neue Sitzung, in der der Vorfall als Entitätsname, die Vorfall-ID als entityId und der eindeutige Name der Sitzungsvorlage als templateName übergeben wird.

Hinweis

Der Benutzer, der diese Methoden aufruft, muss einem App-Profil zugewiesen sein, das die Sitzungsvorlage enthält.

x=new Map();
x.set("parametersStr", '[["entityName", "incident"], ["entityId", "11bb11bb-cc22-dd33-ee44-55ff55ff55ff"]]');
Microsoft.Apm.createSession({templateName: "case_entity_session_default_template", sessionContext: x});

Erstellen einer Sitzung, die nicht im Fokus ist

x=new Map(); 
x.set("parametersStr", '[["entityName", "incident"], ["entityId", "22cc22cc-dd33-ee44-ff55-66aa66aa66aa"]]'); 
Microsoft.Apm.createSession({templateName: "case_entity_session_default_template", sessionContext: x, isFocused: false});