Dela via

Azure RoomsApi-klientbibliotek för JavaScript – version 1.1.1

  • Artikel

Det här paketet innehåller en isomorf SDK (körs både i Node.js och i webbläsare) för Azure RoomsApi-klienten.

Klient för kommunikationsrum

| Package (NPM) | Exempel

Komma igång

Miljöer som stöds för närvarande

Förutsättningar

JavaScript-paket

Om du vill använda det här klientbiblioteket i webbläsaren måste du först använda en bundler. Mer information om hur du gör detta finns i vår paketeringsdokumentation.

Installera

npm install @azure/communication-rooms

Viktiga begrepp

RoomsApiClient

RoomsClient är det primära gränssnittet för utvecklare som använder Azure RoomsApi-klientbiblioteket. Utforska metoderna i det här klientobjektet för att förstå de olika funktionerna i Azure RoomsApi-tjänsten som du kan komma åt.

Exempel

Autentisering

Du kan hämta en nyckel och/eller anslutningssträng från din Communication Services-resurs i Azure-portalen. När du har en nyckel kan du autentisera RoomsClient med någon av följande metoder:

Skapa KeyCredential med AzureKeyCredential innan klienten initieras

import { AzureKeyCredential } from "@azure/core-auth";
import { RoomsClient } from "@azure/communication-rooms";

const credential = new AzureKeyCredential(KEY);
const client = new RoomsClient(ENDPOINT, credential);

Använda en anslutningssträng

import { RoomsClient } from "@azure/communication-rooms";

const connectionString = `endpoint=ENDPOINT;accessKey=KEY`;
const client = new RoomsClient(connectionString);

Använda en TokenCredential

import { DefaultAzureCredential } from "@azure/identity";
import { RoomsClient } from "@azure/communication-rooms";

const credential = new DefaultAzureCredential();
const client = new RoomsClient(ENDPOINT, credential);

Om du använder en nyckel för att initiera klienten måste du också ange rätt slutpunkt. Du kan hämta den här slutpunkten från din Communication Services-resurs i Azure Portal.

Användning

Skapa ett rum

Om du vill skapa ett rum anropar du metoden createRoom. Alla inställningar är valfria.

Om validFrom inte anges är den standardinställningen för aktuell datetime. Om validUntil inte anges är standardvärdet validFrom + 180 days.

Om role inte anges när participantsdefinieras blir det attendee som standard.

Från och med 1.1.0-versionen läggs PstnDialOutEnabled egenskap till för att aktivera eller inaktivera pstn-utringningsfunktionen i ett rum. PstnDialOutEnabled är en valfri egenskap. Om PstnDialOutEnabled inte anges är standardvärdet för PstnDialOutEnabled falskt.

// create users with CommunicationIdentityClient
const identityClient = new CommunicationIdentityClient(connectionString);
const user1 = await identityClient.createUserAndToken(["voip"]);

// create RoomsClient
const roomsClient: RoomsClient = new RoomsClient(CONNECTION_STRING);

const validFrom = new Date(Date.now());
const validForDays = 10;
const validUntil = new Date(validFrom.getTime());
validUntil.setDate(validFrom.getDate() + validForDays);
const pstnDialOutEnabled = true;

// options payload to create a room
const createRoomOptions: CreateRoomOptions = {
  validFrom,
  validUntil,
  pstnDialOutEnabled,
  participants: [
    {
      id: user1.user,
      role: "Attendee",
    },
  ],
};

// create room
const room = await roomsClient.createRoom(createRoomOptions);

Find CommunicationIdentityClient här

Uppdatera ett rum

Om du vill uppdatera inställningarna för validFrom och validUntil i ett rum använder du metoden updateRoom.

Från och med 1.1.0-versionen läggs PstnDialOutEnabled egenskap till för att aktivera eller inaktivera pstn-utringningsfunktionen i ett rum.

validForDays = 60;
validUntil.setDate(validFrom.getDate() + validForDays);
pstnDialOutEnabled = false;

const updateRoomOptions: UpdateRoomOptions = {
  validFrom,
  validUntil,
  pstnDialOutEnabled,
};

// update the room using the room id from the creation operation
const updatedRoom = await roomsClient.updateRoom(room.id, updateRoomOptions);

Skaffa ett rum

Om du vill hämta ett rum använder du metoden getRoom.

const roomId = "ROOM_ID";
room = await roomsClient.getRoom(roomId);

Visa en lista över rum

Visa en lista över alla rum med hjälp av metoden listRooms.

const roomsList = await roomsClient.listRooms();
for await (const currentRoom of roomsList) {
  // access room data
  console.log(`The room id is ${currentRoom.id}.`);
}

Lägga till eller uppdatera deltagare

Om du vill lägga till nya deltagare eller uppdatera befintliga deltagare använder du metoden addOrUpdateParticipants.

const user2 = await identityClient.createUserAndToken(["voip"]);
const updateParticipantsList: RoomParticipantPatch[] = [
  {
    id: user1.user,
    role: "Presenter",
  },
  {
    id: user2.user,
  },
];

// run addOrUpdate operation
await roomsClient.addOrUpdateParticipants(room.id, updateParticipantsList);

Ta bort deltagare

Om du vill ta bort deltagare anropar du metoden removeParticipants.

const participantsToRemove = [user1.user, user2.user];
await roomsClient.removeParticipants(room.id, participantsToRemove);

Få deltagare i ett rum

Om du vill visa en lista över alla deltagare i ett rum anropar du metoden listParticipants.

const participantsList = await roomsClient.listParticipants(room.id);
for await (const participant of participantsList) {
  // access participant data
  console.log(`The participant's role is ${participant.role}.`);
}

Ta bort ett rum

Använd metoden deleteRoom för att ta bort ett rum.

await roomsClient.deleteRoom(room.id);

Felsökning

Skogsavverkning

Aktivering av loggning kan hjälpa dig att hitta användbar information om fel. Om du vill se en logg med HTTP-begäranden och svar anger du AZURE_LOG_LEVEL miljövariabeln till info. Du kan också aktivera loggning vid körning genom att anropa setLogLevel i @azure/logger:

const { setLogLevel } = require("@azure/logger");
setLogLevel("info");

Mer detaljerade anvisningar om hur du aktiverar loggar finns i @azure/logger-paketdokumenten.

Nästa steg

Ta en titt på exempel katalog för detaljerade exempel på hur du använder det här biblioteket.

Bidragande

Om du vill bidra till det här biblioteket kan du läsa bidragsguide för att lära dig mer om hur du skapar och testar koden.

visningar