spContextManager : Client

Stellt Daten aus einem Widget Serviceportal für andere Anwendungen und Services auf einer Seite Serviceportal bereit. Übergeben Sie beispielsweise Widget-Daten an Mitarbeiterchat, wenn sie auf einer Seite Serviceportal ] geöffnet werden.

Die spContextManager- API ist ein AngularJS-Service, den Sie in Widget-Client-Skripts Serviceportal verwenden können.

An diese API übergebene Schlüssel sind pro Seite eindeutig. Wenn beispielsweise der Schlüssel „agent-chat“ bereits von einem anderen Widget auf der Seite über die Methode „addContext() “ initialisiert wurde, müssen Sie die Methode „ updateContextForKey() “ verwenden, um die Daten des Schlüssels zu aktualisieren. Verfügbare Schlüssel sind: agent-chat: Sendet Widget-Daten an Mitarbeiterchat.

Weitere Informationen zur Übergabe von Daten an Mitarbeiterchatfinden Sie unter Mitarbeiterchat im Serviceportal konfigurieren.

spContextManager: addContext(Zeichenfolgeschlüssel, Objektkontext)

Initialisiert einen Schlüssel und fügt Widget-Daten als Wert hinzu. Fügen Sie beispielsweise dem Schlüssel „agent-chat“ Daten hinzu, um sie für Mitarbeiterchatverfügbar zu machen.

Verwenden Sie diese Methode, wenn Daten zum ersten Mal zu einem bestimmten Schlüssel auf der Seite Serviceportal hinzugefügt werden. Wenn der Schlüssel bereits von einem anderen Widget auf der Seite verwendet wird, verwenden Sie stattdessen die Methode updateContextForKey().

Tabelle : 1. Parameter

Name	Typ	Beschreibung
key	Zeichenfolge	Name des Schlüssels zum Senden der Daten. Verfügbare Schlüssel sindagent-chat: Sendet Widget-Daten an Mitarbeiterchat, wenn es auf einer Seite Serviceportal ] geöffnet wird.
context	Objekt	Widget-Daten im JSON-Format, die an die im Schlüsselparameter angegebene Anwendung oder den angegebenen Service gesendet werden sollen. Beispiel: {'approval_count': 5}.

Tabelle : 2. Ergebnisse

Typ	Beschreibung
void

Übergeben Sie approval_count an Mitarbeiterchat. Wenn ein Benutzer eine Mitarbeiterchat-Konversation über die Serviceportal-Homepage initiiert, hängt das System &sysparm_approval_count=5 an die Mitarbeiterchat ifram-URL an.

function ($scope, spContextManager) {
    spContextManager.addContext('agent-chat', {
        'approval_count': 5       
    });
};

spContextManager – getContext ()

Gibt alle Schlüssel und zugehörigen Datenobjekte zurück, die von einem beliebigen Widget auf der Seite definiert wurden.

Die Verwendung dieser Methode kann sich auf die Leistung auswirken. Verwenden Sie diese Methode, um zu verstehen, welche Schlüssel auf der Seite initialisiert werden, und um ihre aktuellen Werte abzurufen. Wenn Sie wissen, auf welchen Schlüssel Sie zugreifen müssen, verwenden Sie stattdessen die Methode getContextForKey().

Tabelle : 3. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 4. Ergebnisse

Typ	Beschreibung
Objekt	Jeder Schlüssel und jedes zugehörige Datenobjekt, das auf der Seite definiert ist.

function ($scope, spContextManager) {
  spContextManager.getContext();
} 

spContextManager – getContextForKey(Zeichenfolge – Schlüssel, boolesches Rückgaberecht)

Gibt die Widget-Daten zurück, die einem Schlüssel zugeordnet sind.

Tabelle : 5. Parameter

Name	Typ	Beschreibung
key	Zeichenfolge	Name des Schlüssels, von dem der Kontext abgerufen werden soll. Verfügbare Schlüssel sind: agent-chat: Sendet Widget-Daten an Mitarbeiterchat.
Rückgabeversprechen	Boolean	Kennzeichnung, die bestimmt, ob die einem Schlüssel zugeordneten Daten als Zusage oder Objekt zurückgegeben werden sollen. Werte: Wahr: Gibt die Daten als Zusage zurück. Verwenden Sie diese Option, wenn ein anderes Widget auf der Seite die Methode „addContext() “ verwendet, um denselben Schlüssel zu initialisieren. Die Rückgabe einer Zusage verhindert die Rückgabe eines undefinierten Objekts, wenn der Schlüssel noch nicht initialisiert wurde. False: gibt ein Objekt zurück, das die dem Schlüssel zugeordneten Daten enthält.

Tabelle : 6. Ergebnisse

Typ	Beschreibung
Zusage	Wenn „returnPromise“ auf „wahr“ festgelegt ist, wird eine Zusage zurückgegeben, die erfüllt wird, wenn ein anderes Widget auf der Seite den Schlüssel initialisiert.
Objekt	Wenn für „returnPromise“ der Wert „false“ festgelegt ist, wird ein Objekt zurückgegeben, das die dem Schlüssel zugeordneten Daten enthält. Beispiel: {approval_count: 5}.

Übergeben Sie approval_count an Mitarbeiterchat. Wenn ein Benutzer eine Mitarbeiterchat-Konversation über die Serviceportal-Homepage initiiert, hängt das System &sysparm_approval_count=5 an die Mitarbeiterchat ifram-URL an.

function ($scope, spContextManager) {
  spContextManager.getContextForKey('agent-chat', true).then(function(context) {
    context = context || {};
    context.approval_count = 5; 
    spContextManager.updateContextForKey('agent-chat', context);
  });
} 

spContextManager – updateContextForKey(Zeichenfolgeschlüssel, Objektkontext)

Sendet Daten an einen vorhandenen Schlüssel. Wenn beispielsweise ein anderes Widget auf der Seite den Schlüssel „agent-chat“ verwendet, um Daten an die Konfiguration Mitarbeiterchat zu übergeben, müssen Sie den Kontext des Schlüssels aktualisieren, anstatt die Methode „addContext() “ zu verwenden.

Tabelle : 7. Parameter

Name	Typ	Beschreibung
key	Zeichenfolge	Name des Schlüssels zum Senden der Daten. Verfügbare Schlüssel sindagent-chat: Sendet Widget-Daten an Mitarbeiterchat, wenn es auf einer Seite Serviceportal ] geöffnet wird.
context	Objekt	Widget-Daten im JSON-Format, die an die im Schlüsselparameter angegebene Anwendung oder den angegebenen Service gesendet werden sollen. Beispiel: {'approval_count': 5}.

Tabelle : 8. Ergebnisse

Typ	Beschreibung
void

Übergeben Sie approval_count an Mitarbeiterchat. Wenn ein Benutzer eine Mitarbeiterchat-Konversation über die Serviceportal-Homepage initiiert, hängt das System &sysparm_approval_count=5 an die Mitarbeiterchat ifram-URL an.

function ($scope, spContextManager) {
  spContextManager.getContextForKey('agent-chat', true).then(function(context) {
    context = context || {};
    context.approval_count = 5; 
    spContextManager.updateContextForKey('agent-chat', context);
  });
}