Freigeben über

Allgemeine Azure Communication-Clientbibliothek für JavaScript– Version 2.3.1

  • Artikel

Dieses Paket enthält allgemeinen Code für Azure Communication Service-Bibliotheken.

Erste Schritte

Voraussetzungen

Installieren von

npm install @azure/communication-common

Browserunterstützung

JavaScript-Paket

Um diese Clientbibliothek im Browser verwenden zu können, müssen Sie zunächst einen Bundler verwenden. Ausführliche Informationen dazu finden Sie in unserer Bündelungsdokumentation.

Wichtige Begriffe

CommunicationTokenCredential und AzureCommunicationTokenCredential

ist CommunicationTokenCredential eine Schnittstelle, die zum Authentifizieren eines Benutzers mit Communication Services verwendet wird, z. B. Chat oder Anruf.

Bietet AzureCommunicationTokenCredential eine bequeme Möglichkeit, Anmeldeinformationen zu erstellen, die die besagte Schnittstelle implementieren, und ermöglicht es Ihnen, die integrierte Logik für die automatische Aktualisierung zu nutzen.

Abhängig von Ihrem Szenario können Sie die AzureCommunicationTokenCredential mit initialisieren:

  • ein statisches Token (geeignet für kurzlebige Clients, die z.B. einmalige Chatnachrichten senden) oder
  • eine Rückruffunktion, die einen kontinuierlichen Authentifizierungszustand während der Kommunikation sicherstellt (ideal z. B. für lange Anrufsitzungen).

Die Token, die AzureCommunicationTokenCredential entweder über den Konstruktor oder über den Tokenaktualisierungsrückruf für den bereitgestellt werden, können mithilfe der Azure Communication Identity-Bibliothek abgerufen werden.

Beispiele

Erstellen von Anmeldeinformationen mit einem statischen Token

Bei kurzlebigen Clients ist das Aktualisieren des Tokens nach Ablauf nicht erforderlich, und der AzureCommunicationTokenCredential kann mit einem statischen Token instanziiert werden.

const tokenCredential = new AzureCommunicationTokenCredential(
  "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjM2MDB9.adM-ddBZZlQ1WlN3pdPBOF5G4Wh9iZpxNP_fSvpF4cWs"
);

Erstellen von Anmeldeinformationen mit einem Rückruf

Hier wird davon ausgegangen, dass wir über eine Funktion fetchTokenFromMyServerForUser verfügen, die eine Netzwerkanforderung zum Abrufen einer JWT-Tokenzeichenfolge für einen Benutzer sendet. Wir übergeben es an die Anmeldeinformationen, um ein Token für Bob von unserem eigenen Server abzurufen. Unser Server verwendet die Azure Communication Identity-Bibliothek, um Token auszustellen. Es ist erforderlich, dass die fetchTokenFromMyServerForUser Funktion jederzeit ein gültiges Token (mit einem in der Zukunft festgelegten Ablaufdatum) zurückgibt.

const tokenCredential = new AzureCommunicationTokenCredential({
  tokenRefresher: async () => fetchTokenFromMyServerForUser("bob@contoso.com"),
});

Erstellen von Anmeldeinformationen mit proaktiver Aktualisierung

Wenn Sie auf true festlegen refreshProactively , wird Ihre tokenRefresher Funktion aufgerufen, wenn das Token kurz vor dem Ablauf steht.

const tokenCredential = new AzureCommunicationTokenCredential({
  tokenRefresher: async () => fetchTokenFromMyServerForUser("bob@contoso.com"),
  refreshProactively: true,
});

Erstellen von Anmeldeinformationen mit proaktiver Aktualisierung und einem anfänglichen Token

Das Übergeben initialToken ist eine optionale Optimierung, um den ersten Aufruf von zu tokenRefresherüberspringen. Sie können dies verwenden, um den Start von Ihrer Anwendung von nachfolgenden Tokenaktualisierungszyklen zu trennen.

const tokenCredential = new AzureCommunicationTokenCredential({
  tokenRefresher: async () => fetchTokenFromMyServerForUser("bob@contoso.com"),
  refreshProactively: true,
  token:
    "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjM2MDB9.adM-ddBZZlQ1WlN3pdPBOF5G4Wh9iZpxNP_fSvpF4cWs",
});

Problembehandlung

  • Ungültiges Token angegeben: Stellen Sie sicher, dass das Token, das Sie an den AzureCommunicationTokenCredential Konstruktor oder den tokenRefresher Rückruf übergeben, eine bloße JWT-Tokenzeichenfolge ist. Wenn Sie z. B. die Azure Communication Identity-Bibliothek oder REST-API zum Abrufen des Tokens verwenden, stellen Sie sicher, dass Sie nur den token Teil des Antwortobjekts übergeben.

Nächste Schritte

Mitwirken

Wenn Sie an dieser Bibliothek mitwirken möchten, lesen Sie die Anleitung für Mitwirkende, um mehr darüber zu erfahren, wie Sie den Code erstellen und testen können.

Aufrufe