Sdílet prostřednictvím

Společná klientská knihovna Azure Communication pro JavaScript – verze 2.3.1

  • Článek

Tento balíček obsahuje společný kód pro knihovny služby Azure Communication Service.

Začínáme

Požadavky

Instalace

npm install @azure/communication-common

Podpora prohlížečů

JavaScript Bundle

Pokud chcete tuto klientskou knihovnu používat v prohlížeči, musíte nejprve použít nástroj bundler. Podrobnosti o tom, jak to udělat, najdete v naší dokumentaci k sdružování.

Klíčové koncepty

CommunicationTokenCredential a AzureCommunicationTokenCredential

Je CommunicationTokenCredential rozhraní sloužící k ověření uživatele pomocí komunikačních služeb, jako je chat nebo volání.

Nabízí AzureCommunicationTokenCredential pohodlný způsob, jak vytvořit přihlašovací údaje implementující uvedené rozhraní a umožňuje využít integrovanou logiku automatické aktualizace.

V závislosti na vašem scénáři můžete inicializovat AzureCommunicationTokenCredential následující:

  • statický token (vhodný pro krátkodobé klienty používané například k posílání jednorázových chatových zpráv) nebo
  • funkce zpětného volání, která zajišťuje nepřetržitý stav ověřování během komunikace (ideální například pro dlouhé relace volání).

Tokeny dodané do objektu AzureCommunicationTokenCredential prostřednictvím konstruktoru nebo prostřednictvím zpětného volání refresheru tokenů je možné získat pomocí knihovny Identit pro komunikaci Azure.

Příklady

Vytvoření přihlašovacích údajů se statickým tokenem

U krátkodobých klientů není aktualizace tokenu při vypršení platnosti nutná a AzureCommunicationTokenCredential instance může být vytvořena statickým tokenem.

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

Vytvoření přihlašovacích údajů se zpětným voláním

Zde předpokládáme, že máme funkci fetchTokenFromMyServerForUser , která vytvoří síťový požadavek na načtení řetězce tokenu JWT pro uživatele. Předáme ho do přihlašovacích údajů k načtení tokenu pro Boba z našeho vlastního serveru. Náš server by k vydávání tokenů používal knihovnu identit pro komunikaci Azure. Je nutné, aby fetchTokenFromMyServerForUser funkce vždy vracela platný token (s datem vypršení platnosti nastaveným v budoucnosti).

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

Vytvoření přihlašovacích údajů s proaktivní aktualizací

Nastavení refreshProactively na true zavolá funkci tokenRefresher , když se token blíží vypršení platnosti.

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

Vytvoření přihlašovacích údajů s proaktivní aktualizací a počátečním tokenem

Předání initialToken je volitelná optimalizace pro přeskočení prvního volání metody tokenRefresher. Můžete ho použít k oddělení spouštění od aplikace od následných cyklů aktualizace tokenů.

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

Poradce při potížích

  • Zadaný neplatný token: Ujistěte se, že token, který předáváte konstruktoru AzureCommunicationTokenCredential nebo zpětnému tokenRefresher volání, je holý řetězec tokenu JWT. Pokud například k získání tokenu používáte knihovnu identit pro komunikaci Azure nebo rozhraní REST API , ujistěte se, že předáváte jenom token část objektu odpovědi.

Další kroky

Přispívání

Pokud chcete přispívat do této knihovny, přečtěte si příručku pro přispívání , kde najdete další informace o tom, jak sestavit a otestovat kód.

Imprese