session.unsubscribe Befehl

Syntax

/* Using event name */
{
  "method": "session.unsubscribe",
  "params": {
    "events": ["log.entryAdded"]
  }
}

/* Using subscription ID */
{
  "method": "session.unsubscribe",
  "params": {
    "subscriptions": ["a1b2c3d4-e5f6-7890-abcd-ef1234567890"]
  }
}

Parameter

Das params Feld enthält eines der folgenden Felder:

events

Ein Array von einem oder mehreren Strings, das Ereignisnamen speichert, um Abonnements zu kündigen. Jeder String kann entweder ein spezifischer Ereignisname (zum Beispiel, "log.entryAdded") oder ein Modulname (zum Beispiel, "log") sein, das den Client von allen Ereignissen in diesem Modul abmeldet. Nur globale Abonnements können mittels Ereignisnamen entfernt werden; solche, die mit contexts oder userContexts erstellt wurden, können dies nicht.

subscriptions

Ein Array von einer oder mehreren Abonnement-IDs, das die zu kündigenden Abonnements angibt, einschließlich sowohl globaler als auch kontextbezogener Abonnements.

Rückgabewert

Das result Feld in der Antwort ist ein leeres Objekt ({}).

Fehler

invalid argument

Wenn Sie IDs zum Abmelden verwenden, wird eine Abonnement-ID nicht gefunden. Wenn Sie Ereignisnamen zum Abmelden verwenden, ist das events Array leer oder fehlt, oder ein Ereignisname stimmt mit keinem aktiven globalen Abonnement überein.

Beispiele

Abmelden mittels einer Abonnement-ID

Mit einem aktiven Abonnement, senden Sie die folgende Nachricht, um es mittels ID zu kündigen:

{
  "id": 3,
  "method": "session.unsubscribe",
  "params": {
    "subscriptions": ["c7b7b3a2-1f4b-4b4e-8a1f-2a3b4c5d6e7f"]
  }
}

Nach der erfolgreichen Abmeldung antwortet der Browser wie folgt:

{
  "id": 3,
  "type": "success",
  "result": {}
}

Globales Abmelden von einem Ereignis mittels Ereignisname

Mit einem aktiven globalen Abonnement für log.entryAdded, senden Sie die folgende Nachricht, um den Empfang dieses Ereignisses zu stoppen:

{
  "id": 4,
  "method": "session.unsubscribe",
  "params": {
    "events": ["log.entryAdded"]
  }
}

Nach der erfolgreichen Abmeldung antwortet der Browser wie folgt:

{
  "id": 4,
  "type": "success",
  "result": {}
}

Globales Abmelden von mehreren Ereignissen mittels Ereignisnamen

Mit aktiven globalen Abonnements, senden Sie die folgende Nachricht, um sich von allen Ereignissen im log Modul und einem spezifischen Ereignis aus dem network Modul abzumelden:

{
  "id": 5,
  "method": "session.unsubscribe",
  "params": {
    "events": ["log", "network.beforeRequestSent"]
  }
}

Nach der erfolgreichen Abmeldung antwortet der Browser wie folgt:

{
  "id": 5,
  "type": "success",
  "result": {}
}

Spezifikationen

Browser-Kompatibilität

Siehe auch

• session.subscribe Befehl
• session.new Befehl
• session.end Befehl