Megosztás a következőn keresztül:

Azure RoomsApi ügyfélkódtár JavaScripthez – 1.1.0-s verzió

  • Cikk

Ez a csomag egy izomorf SDK-t tartalmaz (Node.js és böngészőkben is fut) az Azure RoomsApi-ügyfélhez.

Communication Rooms-ügyfél

Forráskód | Csomag (NPM) | Minták

Első lépések

Jelenleg támogatott környezetek

Előfeltételek

JavaScript-csomag

Ahhoz, hogy ezt az ügyfélkódtárat a böngészőben használhassa, először egy kötegelőt kell használnia. Ennek részleteiért tekintse meg a csomagküldő dokumentációt.

Telepítés

npm install @azure/communication-rooms

Fő fogalmak

RoomsApiClient

RoomsClient az Azure RoomsApi ügyfélkódtárat használó fejlesztők elsődleges felülete. Az ügyfélobjektum metódusainak megismerése az Azure RoomsApi szolgáltatás különböző elérhető funkcióinak megismeréséhez.

Példák

Hitelesítés

Kulcs és/vagy kapcsolati karakterlánc a Communication Services-erőforrásból az Azure Portalon szerezheti be. Miután rendelkezik egy kulccsal, az RoomsClient alábbi módszerek bármelyikével hitelesítheti a kulcsot:

KeyCredential Létrehozás az AzureKeyCredential ügyfél inicializálása előtt

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

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

Kapcsolati karakterlánc használata

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

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

Egy TokenCredential

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

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

Ha kulcs használatával inicializálja az ügyfelet, a megfelelő végpontot is meg kell adnia. Ezt a végpontot a Communication Services-erőforrásból szerezheti be az Azure Portalon.

Használat

szoba Létrehozás

Helyiség létrehozásához hívja meg a metódust createRoom . Az összes beállítás megadása nem kötelező.

Ha validFrom nincs megadva, az alapértelmezett érték az aktuális dátum/idő. Ha validUntil nincs megadva, az alapértelmezett érték a .validFrom + 180 days

A definiáláskor participants, ha role nincs megadva, akkor alapértelmezés szerint az lesz attendee .

Az 1.1.0-s kiadástól kezdve a rendszer hozzáadja a tulajdonságot a PstnDialOutEnabled PSTN kitárcsázási funkció engedélyezéséhez vagy letiltásához egy helyiségben. A PstnDialOutEnabled nem kötelező tulajdonság. Ha PstnDialOutEnabled nincs megadva, akkor az alapértelmezett érték PstnDialOutEnabled hamis.

// 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());
let validForDays = 10;
let validUntil = new Date(validFrom.getTime());
validUntil.setDate(validFrom.getDate() + validForDays);
let 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);

A CommunicationIdentityClient itt található

Helyiség frissítése

A helyiség és validUntil a validFrom beállítások frissítéséhez használja a metódustupdateRoom.

Az 1.1.0-s kiadástól kezdve a rendszer hozzáadja a tulajdonságot a PstnDialOutEnabled PSTN kitárcsázási funkció engedélyezéséhez vagy letiltásához egy helyiségben.

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);

Szoba beolvasása

Helyiség lekéréséhez használja a metódust getRoom .

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

Szobák listázása

Listázhatja az összes helyiséget a listRooms metódus használatával.

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

Résztvevők hozzáadása vagy frissítése

Új résztvevők hozzáadásához vagy meglévő résztvevők frissítéséhez használja a metódust addOrUpdateParticipants .

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

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

Résztvevők eltávolítása

A résztvevők eltávolításához hívja meg a metódust removeParticipants .

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

Résztvevők lekérése egy szobában

A helyiség összes résztvevőjének listázásához hívja meg a metódust 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}.`);
}

Helyiség törlése

deleteRoom A metódus használatával törölhet egy helyiséget.

await roomsClient.deleteRoom(room.id);

Hibaelhárítás

Naplózás

A naplózás engedélyezése segíthet a hibákról szóló hasznos információk feltárásában. A HTTP-kérések és válaszok naplójának megtekintéséhez állítsa a környezeti változót a AZURE_LOG_LEVEL értékre info. A naplózás futásidőben is engedélyezhető a következő hívással setLogLevel@azure/logger:

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

A naplók engedélyezésére vonatkozó részletesebb útmutatásért tekintse meg a @azure/logger csomag dokumentációt.

Következő lépések

A kódtár használatára vonatkozó részletes példákért tekintse meg a mintakönyvtárat.

Közreműködés

Ha hozzá szeretne járulni ehhez a kódtárhoz, olvassa el a közreműködői útmutatót , amelyből többet is megtudhat a kód összeállításáról és teszteléséről.

Megjelenések