Erstellen einer Raumressource

Voraussetzungen

• Ein Azure-Konto mit einem aktiven Abonnement. Sie können kostenlos ein Konto erstellen.
• Eine aktive Communication Services-Ressource und eine Verbindungszeichenfolge. Erstellen Sie eine Communication Services-Ressource.
• Installieren Sie die Azure-Befehlszeilenschnittstelle.
• Sie können die Verbindungszeichenfolge aus dem Azure-Portal abrufen, indem Sie in den Einstellungen auf die Schlüssel klicken.

Einrichten

Hinzufügen der Erweiterung

Fügen Sie die Azure Communication Services-Erweiterung für Azure CLI mithilfe des Befehls az extension hinzu.

az extension add --name communication

Anmelden bei der Azure-Befehlszeilenschnittstelle

Sie müssen sich bei der Azure-Befehlszeilenschnittstelle anmelden. Sie können sich anmelden, indem Sie den az login-Befehl im Terminal ausführen und Ihre Anmeldedaten eingeben.

Speichern der Verbindungszeichenfolge in einer Umgebungsvariablen

Sie können die Umgebungsvariable AZURE_COMMUNICATION_CONNECTION_STRING so konfigurieren, dass Azure CLI-Schlüsselvorgänge verwendet werden, ohne dass Sie --connection_string zum Übergeben der Verbindungszeichenfolge verwenden müssen. Öffnen Sie zum Konfigurieren einer Umgebungsvariablen ein Konsolenfenster, und wählen Sie über die folgenden Registerkarten Ihr Betriebssystem aus. Ersetzen Sie <connectionString> durch Ihre Verbindungszeichenfolge.

setx AZURE_COMMUNICATION_CONNECTION_STRING "<connectionString>"

export AZURE_COMMUNICATION_CONNECTION_STRING="<connectionString>"

export AZURE_COMMUNICATION_CONNECTION_STRING="<connectionString>"

Operationen

Erstellen eines Raums

Erstellen Sie mit dem rooms create-Befehl einen Raum.

az communication rooms create --presenter-participants "<participantId>" --consumer-participants "<participantId>" --attendee-participant "<participantId>" --valid-from "<valid-from>" --valid-until "<valid-until>" --pstn-dial-out-enabled "<pstn-dial-out-enabled>" --connection-string "<connection-string>"

• Verwenden Sie optional <participantId>, um den Typ des Teilnehmers als Presenter-Teilnehmer, Consumer-Teilnehmer oder einfachen Teilnehmer anzugeben. Wenn Sie keinen Wert angeben, ist der Standardwert leer.
• Ersetzen Sie <connection-string> durch Ihre Azure Communication Services-Verbindungszeichenfolge.
• Verwenden Sie optional <valid-from>, um den Zeitstempel, wenn der Raum für die Teilnahme geöffnet ist, im ISO8601-Format anzugeben, z. B.: 2022-07-14T10:21.
• Verwenden Sie optional <valid-until>, um den Zeitstempel, wenn kein Beitreten zum Raum mehr möglich ist, im ISO8601-Format anzugeben, z. B.: 2022-07-14T10:21.
• Verwenden Sie <pstn-dial-out-enabled> optional durch Setzen dieses Flags („True“ oder „False“), um die PSTN-Auswahl für einen Raum zu aktivieren oder zu deaktivieren. Standardmäßig ist dieses Kennzeichen beim Erstellen eines Raums auf „False“ festgelegt.

Wenn Sie die Verbindungszeichenfolge in Umgebungsvariablen speichern, müssen Sie sie nicht an den Befehl übergeben.

az communication rooms create 

Aktivieren der PSTN-Auswahlfunktion für einen Raum

Sie können die PSTN-Durchwahl während rooms create aktivieren, indem Sie den --pstn-dial-out-enabled Parameter als True definieren. Sie können diese Funktion während q rooms update ändern, indem Sie den --pstn-dial-out-enabled Parameter angeben.

az communication rooms create --pstn-dial-out-enabled "<pstn-dial-out-enabled>" --connection-string "<connection-string>"

az communication rooms update --pstn-dial-out-enabled "<pstn-dial-out-enabled>" --room "<roomId>"

• Setzen Sie das <pstn-dial-out-enabled>-Flag (True oder False), um die PSTN-Auswahl für einen Raum zu aktivieren oder zu deaktivieren.

Abrufen der Räume

Der rooms get-Befehl gibt die Attribute eines vorhandenen Raums zurück.

az communication rooms get --room "<roomId>" 

• Ersetzen Sie <roomId> durch Ihre Raum-ID.

Aktualisieren des Zeitraums für einen Raum

Sie können den Zeitstempel eines Raums aktualisieren. Stellen Sie vor dem Aufrufen des room update Befehls sicher, dass Sie einen neuen Raum mit einem gültigen Zeitrahmen erworben haben.

az communication rooms update --valid-from "<valid-from>" --valid-until "<valid-until>" --pstn-dial-out-enabled "<pstn-dial-out-enabled>" --room "<roomId>"

• Ersetzen Sie <valid-from> durch den Zeitstempel im ISO8601-Format (Beispiel: 2022-07-14T10:21), um anzugeben, wann der Raum für die Teilnahme geöffnet ist. Sollte zusammen mit --valid-until verwendet werden.
• Ersetzen Sie <valid-until> durch den Zeitstempel im ISO8601-Format (Beispiel: 2022-07-14T10:21), um anzugeben, wann ein Beitreten zum Raum nicht mehr möglich ist. Sollte zusammen mit --valid-from verwendet werden.
• Ersetzen Sie <pstn-dial-out-enabled>, um dieses Flag zu setzen („True“ oder „False“), um die PSTN-Auswahl für einen Raum zu aktivieren oder zu deaktivieren. Sollte zusammen mit --pstn-dial-out-enabled verwendet werden.
• Ersetzen Sie <roomId> durch Ihre Raum-ID.

Liste aller aktiven Räume

Der Befehl rooms list gibt alle aktiven Räume zurück, die zu Ihrer Azure Communication Services-Ressource gehören.

az communication rooms list

Hinzufügen neuer Teilnehmer oder Aktualisieren vorhandener Teilnehmer

Wenn Sie einen Raum erstellen, können Sie den Raum aktualisieren, indem Sie einen neuen Teilnehmer hinzufügen oder einen vorhandenen Teilnehmer darin aktualisieren. Stellen Sie vor dem Aufrufen des room participant add-or-update Befehls sicher, dass Sie einen neuen Benutzer erworben haben.

Verwenden Sie den identity user create-Befehl, um einen neuen Teilnehmer zu erstellen, der durch participantId bezeichnet wird.

az communication identity user create

Fügen Sie einen Benutzer zum Raum als Teilnehmer hinzu.

az communication rooms participant add-or-update --attendee-participant "<participantId>" --room "<roomId>"

• Ersetzen Sie <participantId> durch Ihre Teilnehmer-ID. Wenn <participantId> nicht im Raum vorhanden ist, wird die teilnehmende Person dem Raum in der Teilnehmerrolle hinzugefügt. Andernfalls wird die Rolle des Teilnehmers in eine Teilnehmerrolle aktualisiert.
• Ersetzen Sie <roomId> durch Ihre Raum-ID.

Abrufen der Teilnehmerliste in einem Raum

az communication rooms participant get --room "<roomId>"

• Ersetzen Sie <roomId> durch Ihre Raum-ID.

Entfernen eines Teilnehmers aus einem Raum

Sie können einen Raumteilnehmer aus einem Raum entfernen, indem Sie rooms participant -remove verwenden.

az communication rooms participant remove --room "<roomId>" --participants "<participant1>" "<participant2>" "<participant3>"

• Ersetzen Sie <roomId> durch Ihre Raum-ID.
• Ersetzen Sie <participant1>, <participant2>, <participant3> durch Ihre Benutzer-IDs, die Sie zuvor durch Ausführen des Befehls identity user create abgerufen haben.

Löschen eines Raums

Ähnlich wie beim Erstellen eines Raums können Sie einen Raum auch löschen.

Verwenden Sie den Befehl room delete, um den vorhandenen Raum zu löschen.

az communication rooms delete --room "<roomId>"

• Ersetzen Sie <roomId> durch Ihre Raum-ID.

Ein Raum ist ein serververwalteter Kommunikationsraum für eine bekannte, feste Gruppe von Teilnehmern für die Zusammenarbeit für eine vordefinierte Dauer. Weitere Informationen finden Sie unter "Räume-API für strukturierte Besprechungen".

Voraussetzungen

• Ein Azure-Konto mit einem aktiven Abonnement. Sie können kostenlos ein Konto erstellen.
• Eine aktive Communication Services-Ressource und eine Verbindungszeichenfolge. Erstellen Sie eine Communication Services-Ressource.
• Die aktuelle Version der .NET Core-Clientbibliothek für Ihr Betriebssystem.

Beispielcode

Überprüfen und laden Sie den Beispielcode für GitHub unter Räume-Schnellstart – .NET herunter.

Einrichten

Erstellen einer neuen C#-Anwendung

Verwenden Sie in einem Konsolenfenster (z. B. cmd, PowerShell oder Bash) den Befehl dotnet new zum Erstellen einer neuen Konsolen-App mit dem Namen RoomsQuickstart. Dieser Befehl erstellt ein einfaches C#-Projekt vom Typ „Hallo Welt“ mit einer einzelnen Quelldatei: program.cs.

dotnet new console -o RoomsQuickstart

Wechseln Sie zum neu erstellten App-Ordner, und verwenden Sie den Befehl dotnet build, um Ihre Anwendung zu kompilieren.

cd RoomsQuickstart
dotnet build

Installieren des Pakets

Installieren der .NET-Clientbibliothek für Räume von Azure Communication Services mit [NuGet][https://www.nuget.org/]:

dotnet add package Azure.Communication.Rooms

Verwenden Sie die Azure Communication Rooms-Clientbibliothek für .NET , Version 1.1.0 oder höher.

Einrichten des App-Frameworks

Fügen Sie in der Program.cs-Datei den folgenden Code hinzu, um die erforderlichen Namespaces zu importieren und die grundlegende Programmstruktur zu erstellen.

using System;
using Azure;
using Azure.Core;
using Azure.Communication.Rooms;

namespace RoomsQuickstart
{
    class Program
    {
        static async System.Threading.Tasks.Task Main(string[] args)
        {
            Console.WriteLine("Azure Communication Services - Rooms Quickstart");

            // Quickstart code goes here
        }
    }
}

Initialisieren eines Raumclients

Erstellen Sie ein neues RoomsClient-Objekt. Sie brauchen dies, um neue rooms zu erstellen und deren Eigenschaften und Lebenszyklus zu verwalten. Verwenden Sie die Verbindungszeichenfolge Ihres Kommunikationsdiensts, um die Anforderung zu authentifizieren. Weitere Informationen zu Verbindungszeichenfolgen finden Sie auf dieser Seite.

// Find your Communication Services resource in the Azure portal
var connectionString = "<connection_string>";
RoomsClient roomsClient = new RoomsClient(connectionString);

Erstellen eines Raums

Einrichten von Raumteilnehmern

Um einzurichten, wer einem Chatroom beitreten kann, müssen Sie über die Liste der Identitäten dieser Benutzer verfügen. Befolgen Sie die Anweisungen bei Zugriffstoken, um Benutzer zu erstellen und Zugriffstoken auszugeben. Alternativ können Sie die Benutzer bei Bedarf erstellen, indem Sie sie mit der Funktion CommunicationIdentityClient erstellen. Azure Communication Services Rooms unterstützen derzeit nur einen Raumteilnehmer des Typs CommunicationUserIdentifier. Die Verwendung anderer Typen von CommunicationIdentity führt zu einem Laufzeitfehler.

Um CommunicationIdentityClient zu verwenden, installieren Sie das folgende Paket:

dotnet add package Azure.Communication.Identity

Importieren Sie außerdem den Namespace des Pakets am Anfang der Program.cs-Datei:

using Azure.Communication.Identity;

Jetzt können Sie CommunicationIdentityClient initialisieren und verwenden, um Benutzer zu erstellen.

// Create identities for users who will join the room
CommunicationIdentityClient identityClient = new CommunicationIdentityClient(connectionString);
CommunicationUserIdentifier user1 = identityClient.CreateUser();
CommunicationUserIdentifier user2 = identityClient.CreateUser();

Erstellen Sie dann die Liste der Raumteilnehmer, indem Sie auf diese Benutzer verweisen:

List<RoomParticipant> participants = new List<RoomParticipant>()
{
    new RoomParticipant(user1) { Role = ParticipantRole.Presenter },
    new RoomParticipant(user2) // The default participant role is ParticipantRole.Attendee
};

Initialisieren des Raums

Erstellen Sie einen neuen Raum mithilfe des im vorherigen Codeausschnitt definierten participants.

// Create a room
DateTimeOffset validFrom = DateTimeOffset.UtcNow;
DateTimeOffset validUntil = validFrom.AddDays(1);
CancellationToken cancellationToken = new CancellationTokenSource().Token;

CommunicationRoom createdRoom = await roomsClient.CreateRoomAsync(validFrom, validUntil, participants, cancellationToken);

// CreateRoom or CreateRoomAsync methods can take CreateRoomOptions type as an input parameter.
bool pstnDialOutEnabled = false;
CreateRoomOptions createRoomOptions = new CreateRoomOptions()
{
    ValidFrom = validFrom,
    ValidUntil = validUntil,
    PstnDialOutEnabled = pstnDialOutEnabled,
    Participants = participants
};

createdRoom = await roomsClient.CreateRoomAsync(createRoomOptions, cancellationToken);
string roomId = createdRoom.Id;
Console.WriteLine("\nCreated room with id: " + roomId);

Da Räume serverseitige Entitäten sind, sollten Sie die roomId im Speichermedium Ihrer Wahl nachverfolgen und beibehalten. Sie können das roomId verwenden, um die Eigenschaften eines Raumobjekts anzuzeigen oder zu aktualisieren.

Aktivieren der PSTN-Auswahlfunktion für einen Raum

Für jeden Raum ist die PSTN-Auswahl standardmäßig deaktiviert. Sie können die PSTN-Auswahl für einen Raum bei der Erstellung aktivieren, indem Sie den Parameter pstnDialOutEnabled als „true“ definieren. Sie können diese Funktion für einen Raum ändern, indem Sie eine Aktualisierungsanforderung für den pstnDialOutEnabled Parameter ausgeben.

// Create a room
CancellationToken cancellationToken = new CancellationTokenSource().Token;

// CreateRoom or CreateRoomAsync methods to create a room with PSTN dial out capability
bool pstnDialOutEnabled = true;
CreateRoomOptions createRoomOptions = new CreateRoomOptions()
{
    PstnDialOutEnabled = pstnDialOutEnabled,
};

CommunicationRoom createdRoom = await roomsClient.CreateRoomAsync(createRoomOptions, cancellationToken);
Console.WriteLine("\nCreated a room with PSTN dial out enabled: " + createdRoom.PstnDialOutEnabled);

// UpdateRoom or UpdateRoomAsync methods can take UpdateRoomOptions to enable or disable PSTN dial out capability
pstnDialOutEnabled = false;
UpdateRoomOptions updateRoomOptions = new UpdateRoomOptions()
{
    PstnDialOutEnabled = pstnDialOutEnabled,
};

CommunicationRoom updatedRoom = await roomsClient.UpdateRoomAsync(roomId, updateRoomOptions, cancellationToken);
Console.WriteLine("\nUpdated a room with PSTN dial out enabled: " + updatedRoom.PstnDialOutEnabled);

Abrufen von Eigenschaften eines vorhandenen Raums

Um die Details eines vorhandenen Raums abzurufen, beziehen Sie sich auf roomId.

// Retrieve the room with corresponding ID
CommunicationRoom room = await roomsClient.GetRoomAsync(roomId);
Console.WriteLine("\nRetrieved room with id: " + room.Id);

Aktualisieren der Lebensdauer eines Raums

Sie können die Lebensdauer eines Chatrooms ändern, indem Sie eine Aktualisierungsanforderung für die ValidFrom und ValidUntil Parameter ausstellen. Ein Raum kann maximal sechs Monate lang gültig sein.

// Update room lifetime
DateTimeOffset updatedValidFrom = DateTimeOffset.UtcNow;
DateTimeOffset updatedValidUntil = DateTimeOffset.UtcNow.AddDays(10);
CommunicationRoom updatedRoom = await roomsClient.UpdateRoomAsync(roomId, updatedValidFrom, updatedValidUntil, cancellationToken);

// UpdateRoom or UpdateRoomAsync methods can take UpdateRoomOptions type as an input parameter.
bool pstnDialOutEnabled = true;
UpdateRoomOptions updateRoomOptions = new UpdateRoomOptions()
{
    ValidFrom = validFrom,
    ValidUntil = validUntil,
    PstnDialOutEnabled = pstnDialOutEnabled,
};

updatedRoom = await roomsClient.UpdateRoomAsync(roomId, updateRoomOptions, cancellationToken);
Console.WriteLine("\nUpdated room with validFrom: " + updatedRoom.ValidFrom + ", validUntil: " + updatedRoom.ValidUntil + " and pstnDialOutEnabled: " + updatedRoom.PstnDialOutEnabled);

Liste aller aktiven Räume

Um alle aktiven Räume abzurufen, verwenden Sie die GetRoomsAsync-Methode, die auf dem Client verfügbar gemacht wird.

// List all active rooms
AsyncPageable<CommunicationRoom> allRooms = roomsClient.GetRoomsAsync();
await foreach (CommunicationRoom currentRoom in allRooms)
{
    Console.WriteLine("\nFirst room id in all active rooms: " + currentRoom.Id);
    break;
}

Hinzufügen neuer Teilnehmer oder Aktualisieren vorhandener Teilnehmer

Um einem Raum neue Teilnehmer hinzuzufügen, verwenden Sie die AddParticipantsAsync Methode, die auf dem Client verfügbar gemacht wird.

List<RoomParticipant> addOrUpdateParticipants = new List<RoomParticipant>();
// Update participant2 from Attendee to Consumer
RoomParticipant participant2 = new RoomParticipant(user2) { Role = ParticipantRole.Consumer };
// Add participant3
CommunicationUserIdentifier user3 = identityClient.CreateUser();
RoomParticipant participant3 = new RoomParticipant(user3) { Role = ParticipantRole.Collaborator };
addOrUpdateParticipants.Add(participant2);
addOrUpdateParticipants.Add(participant3);

Response addOrUpdateParticipantsResponse = await roomsClient.AddOrUpdateParticipantsAsync(roomId, addOrUpdateParticipants);
Console.WriteLine("\nAdded or updated participants to room");

Wenn Sie Teilnehmer zu einem Chatroom hinzufügen, können sie an Anrufen teilnehmen. Aktualisierte teilnehmende Person sehen ihre neue role während des Anrufs.

Abrufen der Teilnehmerliste

Rufen Sie die Teilnehmerliste für einen vorhandenen Raum ab, indem Sie auf folgendes roomIdverweisen:

// Get list of participants in room
AsyncPageable<RoomParticipant> existingParticipants = roomsClient.GetParticipantsAsync(roomId);
Console.WriteLine("\nRetrieved participants from room: ");
await foreach (RoomParticipant participant in existingParticipants)
{
    Console.WriteLine($"{participant.CommunicationIdentifier.ToString()},  {participant.Role.ToString()}");
}

Entfernen von Teilnehmer*innen

Um einen Teilnehmer aus einem Chatroom zu entfernen und seinen Zugriff zu widerrufen, verwenden Sie die RemoveParticipantsAsync Methode.

// Remove user from room
List<CommunicationIdentifier> removeParticipants = new List<CommunicationIdentifier>();
removeParticipants.Add(user2);

Response removeParticipantsResponse = await roomsClient.RemoveParticipantsAsync(roomId, removeParticipants);
Console.WriteLine("\nRemoved participants from room");

Raum löschen

Wenn Sie einen vorhandenen Raum aufheben möchten, stellen Sie eine explizite Löschanforderung aus. Alle Räume und die zugehörigen Ressourcen werden automatisch am Ende ihrer Gültigkeit und einer Nachfrist gelöscht.

// Deletes the specified room
Response deleteRoomResponse = await roomsClient.DeleteRoomAsync(roomId);
Console.WriteLine("\nDeleted room with id: " + roomId);

Ausführen des Codes

Um den Code auszuführen, stellen Sie sicher, dass Sie sich im selben Verzeichnis wie die Program.cs Datei befinden.

dotnet run

In der erwarteten Ausgabe wird jede abgeschlossene Aktion beschrieben:

Azure Communication Services - Rooms Quickstart

Created a room with id: 99445276259151407

Retrieved room with id: 99445276259151407

Updated room with validFrom: 2023-05-11T22:11:46.784Z, validUntil: 2023-05-21T22:16:46.784Z and pstnDialOutEnabled: true

First room id in all active rooms: 99445276259151407

Added or updated participants to room

Retrieved participants from room:
8:acs:b6aada1f-0b1d-47ac-866f-91aae00a1d01_00000018-ac89-7c76-35f3-343a0d00e901, Presenter
8:acs:b6aada1f-0b1d-47ac-866f-91aae00a1d01_00000018-f00d-aa4b-0cf9-9c3a0d00543e, Consumer
8:acs:b6aada1f-0b1d-47ac-866f-91aae00a1d01_00000018-f00d-aaf2-0cf9-9c3a0d00543f, Collaborator

Removed participants from room

Deleted room with id: 99445276259151407

Referenzdokumentation

Lesen Sie mehr zu den vollständigen Funktionen von Azure Communication Services-Räumen in der .NET SDK-Referenz oder REST-API-Referenz.

Ein Raum ist ein serververwalteter Kommunikationsraum für eine bekannte, feste Gruppe von Teilnehmern für die Zusammenarbeit für eine vordefinierte Dauer. Weitere Informationen finden Sie unter "Räume-API für strukturierte Besprechungen".

Voraussetzungen

• Ein Azure-Konto mit einem aktiven Abonnement. Sie können kostenlos ein Konto erstellen.
• Eine aktive Communication Services-Ressource und eine Verbindungszeichenfolge. Erstellen Sie eine Communication Services-Ressource.
• Java Development Kit (JDK), Version 8 oder höher.
• Apache Maven

Beispielcode

Laden Sie den Beispielcode von GitHub unter Azure Communication Services - Räume - Java herunter und überprüfen Sie ihn.

Einrichten

Erstellen einer neuen Java-Anwendung

Verwenden Sie in einem Konsolenfenster (z. B. cmd, PowerShell oder Bash) den Befehl mvn zum Erstellen einer neuen Konsolen-App mit dem Namen rooms-quickstart. Dieser Befehl erstellt ein einfaches Java-Projekt vom Typ „Hallo Welt“ mit einer einzelnen Quelldatei: App.java.

mvn archetype:generate -DgroupId=com.communication.quickstart -DartifactId=communication-quickstart -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 -DinteractiveMode=false

Einschließen des Pakets

Sie müssen die Azure Communication Rooms-Clientbibliothek für Räume für Java Version 1.1.0 oder höher verwenden.

BOM-Datei einfügen

Fügen Sie azure-sdk-bom in Ihr Projekt ein, um die Abhängigkeit der allgemein verfügbaren Version der Bibliothek zu übernehmen. Ersetzen Sie im folgenden Codeausschnitt den Platzhalter {bom_version_to_target} durch die Versionsnummer.

Weitere Informationen zur Stückliste (Bill of Materials, BOM) finden Sie in der Azure SDK-BOM-Infodatei.

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>com.azure</groupId>
            <artifactId>azure-sdk-bom</artifactId>
            <version>{bom_version_to_target}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

Fügen Sie dann die direkte Abhängigkeitsangabe im Bereich "Abhängigkeiten" ohne das Versionstag ein.

<dependencies>
  <dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-communication-rooms</artifactId>
  </dependency>
</dependencies>

Direkte Abhängigkeiten einfügen

Wenn Sie eine Abhängigkeit von einer bestimmten Version der Bibliothek übernehmen möchten, die nicht in der BOM vorhanden ist, fügen Sie ihrem Projekt die direkte Abhängigkeit wie folgt hinzu.

<dependency>
  <groupId>com.azure</groupId>
  <artifactId>azure-communication-rooms</artifactId>
  <version>1.0.0-beta.1</version>
</dependency>

Einrichten des App-Frameworks

Wechseln Sie zum /src/main/java/com/communication/quickstart Verzeichnis, und öffnen Sie die App.java Datei. Fügen Sie den folgenden Code hinzu:

package com.communication.rooms.quickstart;

import com.azure.communication.common.*;
import com.azure.communication.identity.*;
import com.azure.communication.identity.models.*;
import com.azure.core.credential.*;
import com.azure.communication.rooms.*;

import java.io.IOException;
import java.time.*;
import java.util.*;

public class App
{
    public static void main( String[] args ) throws IOException
    {
        System.out.println("Azure Communication Services - Rooms Quickstart");
        // Quickstart code goes here
    }
}

Initialisieren eines Raumclients

Erstellen Sie ein neues RoomsClient Objekt, das Sie zum Erstellen neuer Räume und zum Verwalten ihrer Eigenschaften und des Lebenszyklus benötigen. Verwenden Sie die Verbindungszeichenfolge Ihres Kommunikationsdiensts, um die Anforderung zu authentifizieren. Weitere Informationen zu Verbindungszeichenfolgen finden Sie unter Erstellen einer Kommunikationsressource.

// Initialize the rooms client
// Find your Communication Services resource in the Azure portal
String connectionString = "<connection string>";
RoomsClient roomsClient = new RoomsClientBuilder().connectionString(connectionString).buildClient();

Erstellen eines Raums

Einrichten von Raumteilnehmern

Um einzurichten, wer einem Chatroom beitreten kann, müssen Sie über die Liste der Identitäten dieser Benutzer verfügen. Befolgen Sie die Anweisungen bei Access-Token , um Benutzer zu erstellen und Zugriffstoken auszugeben. Wenn Sie die Benutzer bei Bedarf erstellen möchten, können Sie sie auch mit CommunicationIdentityClient erstellen. Azure Communication Services Rooms unterstützt derzeit nur einen Raumteilnehmer vom Typ CommunicationUserIdentifier. Die Verwendung anderer Typen von CommunicationIdentity führt zu einem Laufzeitfehler.

Fügen Sie das folgende Paket hinzu, um CommunicationIdentityClient zu verwenden:

<dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-communication-identity</artifactId>
</dependency>

Importieren Sie das Paket oben in Ihre App.java-Datei:

import com.azure.communication.identity.CommunicationIdentityClient;
import com.azure.communication.identity.CommunicationIdentityClientBuilder;

Initialisieren Sie CommunicationIdentityClient und verwenden Sie es, um Benutzer zu erstellen.

CommunicationIdentityClient communicationIdentityClient = new CommunicationIdentityClientBuilder()
    .connectionString(connectionString)
    .buildClient();

CommunicationUserIdentifier user1 = communicationClient.createUser();
CommunicationUserIdentifier user2 = communicationClient.createUser();
CommunicationUserIdentifier user3 = communicationClient.createUser();

Erstellen Sie dann die Liste der Raumteilnehmer, indem Sie auf diese Benutzer verweisen:

//The default participant role is ParticipantRole.Attendee
RoomParticipant participant_1 = new RoomParticipant(user1);
RoomParticipant participant_2 = new RoomParticipant(user2);
RoomParticipant participant_3 = new RoomParticipant(user3);

List<RoomParticipant> roomParticipants = new ArrayList<RoomParticipant>();

roomParticipants.add(participant_1);
roomParticipants.add(participant_2.setRole(ParticipantRole.CONSUMER));

Initialisieren des Raums

Erstellen Sie einen neuen Raum mithilfe des im vorherigen Codeausschnitt definierten roomParticipants.

OffsetDateTime validFrom = OffsetDateTime.now();
OffsetDateTime validUntil = validFrom.plusDays(30);
boolean pstnDialOutEnabled = false;

CreateRoomOptions createRoomOptions = new CreateRoomOptions()
    .setValidFrom(validFrom)
    .setValidUntil(validUntil)
    .setPstnDialOutEnabled(pstnDialOutEnabled)
    .setParticipants(roomParticipants);

CommunicationRoom roomCreated = roomsClient.createRoom(createRoomOptions);

System.out.println("\nCreated a room with id: " + roomCreated.getRoomId());

Räume sind serverseitige Entitäten, daher sollten Sie die roomId nachverfolgen und auf dem Speichermedium Ihrer Wahl speichern. Sie können das roomId verwenden, um die Eigenschaften eines Raumobjekts anzuzeigen oder zu aktualisieren.

Aktivieren der PSTN-Auswahlfunktion für einen Raum

Für jeden Raum ist die PSTN-Auswahl standardmäßig deaktiviert. Die PSTN-Auswahl kann für einen Raum bei der Erstellung aktiviert werden, indem Sie den Parameter pstnDialOutEnabled als „true“ definieren. Sie können diese Funktion für einen Raum ändern, indem Sie eine Aktualisierungsanforderung für den pstnDialOutEnabled Parameter ausgeben.

boolean pstnDialOutEnabled = true;
// Create a room with PSTN dial out capability
CreateRoomOptions createRoomOptions = new CreateRoomOptions()
    .setPstnDialOutEnabled(pstnDialOutEnabled)

CommunicationRoom roomCreated = roomsClient.createRoom(createRoomOptions);
System.out.println("\nCreated a room with PSTN dial out enabled: " + roomCreated.getPstnDialOutEnabled());

// Update a room to enable or disable PSTN dial out capability
pstnDialOutEnabled = false;
UpdateRoomOptions updateRoomOptions = new UpdateRoomOptions()
    .setPstnDialOutEnabled(pstnDialOutEnabled);

CommunicationRoom roomUpdated = roomsClient.updateRoom(roomId, updateRoomOptions);
System.out.println("\nUpdated a room with PSTN dial out enabled: " + roomUpdated.getPstnDialOutEnabled());

Abrufen von Eigenschaften eines vorhandenen Raums

Rufen Sie die Details eines vorhandenen Raums ab, indem Sie auf folgendes roomIdverweisen:

// Retrieve the room with corresponding ID
CommunicationRoom roomResult = roomsClient.getRoom(roomId);

System.out.println("Retrieved room with id: " + roomResult.getRoomId());

Aktualisieren der Lebensdauer eines Raums

Sie können die Lebensdauer eines Chatrooms ändern, indem Sie eine Aktualisierungsanforderung für die ValidFrom und ValidUntil Parameter ausstellen. Ein Raum kann maximal sechs Monate lang gültig sein.

OffsetDateTime validFrom = OffsetDateTime.now().plusDays(1);
OffsetDateTime validUntil = validFrom.plusDays(1);
boolean pstnDialOutEnabled = true;

UpdateRoomOptions updateRoomOptions = new UpdateRoomOptions()
    .setValidFrom(validFrom)
    .setValidUntil(validUntil)
    .setPstnDialOutEnabled(pstnDialOutEnabled);

CommunicationRoom roomResult = roomsClient.updateRoom(roomId, updateRoomOptions);

System.out.println("Updated room with validFrom: " + roomResult.getValidFrom() + ", validUntil: " + roomResult.getValidUntil() + " and pstnDialOutEnabled: " + roomResult.getPstnDialOutEnabled());

Hinzufügen oder Aktualisieren von Teilnehmern

Um Teilnehmer zu einem Raum hinzuzufügen oder zu aktualisieren, verwenden Sie die addOrUpdateParticipants Methode, die auf dem Client verfügbar gemacht wird.

List<RoomParticipant> participantsToAddAOrUpdate = new ArrayList<>();

// Updating current participant
participantsToAddAOrUpdate.add(participant_1.setRole(ParticipantRole.PRESENTER));

// Adding new participant
 participantsToAddAOrUpdate.add(participant_3.setRole(ParticipantRole.COLLABORATOR));

AddOrUpdateParticipantsResult addOrUpdateParticipantsResult = roomsClient.addOrUpdateParticipants(roomId, participantsToAddAOrUpdate);

System.out.println("Participant(s) added/updated");

Nachdem Sie Teilnehmer zu einem Chatroom hinzugefügt haben, sind sie berechtigt, an Anrufen teilzunehmen.

Abrufen der Teilnehmerliste

Rufen Sie die Teilnehmerliste für einen vorhandenen Raum ab, indem Sie auf folgendes roomIdverweisen:

// Get list of participants
try {

PagedIterable<RoomParticipant> participants = roomsClient.listParticipants(roomId);

System.out.println("Participants:/n");

for (RoomParticipant participant : participants) {
    System.out.println(participant.getCommunicationIdentifier().getRawId() + " (" + participant.getRole() + ")");
   }
} catch (Exception ex) {
    System.out.println(ex);
}

Entfernen von Teilnehmer*innen

Um einen Teilnehmer aus einem Chatroom zu entfernen und seinen Zugriff zu widerrufen, verwenden Sie die removeParticipants Methode.

// Remove a participant from the room
List<CommunicationIdentifier> participantsToRemove = new ArrayList<>();

participantsToRemove.add(participant_3.getCommunicationIdentifier());

RemoveParticipantsResult removeParticipantsResult = roomsClient.removeParticipants(roomId,participantsToRemove);

System.out.println("Participant(s) removed");

Liste aller aktiven Räume

Rufen Sie alle aktiven Räume unter Ihrer Azure Communication Services-Ressource ab.

try {
    Iterable<PagedResponse<CommunicationRoom>> roomPages = roomsClient.listRooms().iterableByPage();

    System.out.println("Listing all the rooms IDs in the first two pages of the list of rooms:");

    int count = 0;
    for (PagedResponse<CommunicationRoom> page : roomPages) {
        for (CommunicationRoom room : page.getElements()) {
            System.out.println("\n" + room.getRoomId());
        }

        count++;
        if (count >= 2) {
            break;
        }
    }
} catch (Exception ex) {
    System.out.println(ex);
}

Raum löschen

Wenn Sie einen vorhandenen Raum aufheben möchten, stellen Sie eine explizite Löschanforderung aus. Alle Räume und die zugehörigen Ressourcen werden automatisch am Ende ihrer Gültigkeit und einer Nachfrist gelöscht.

// Deletes the specified room
roomsClient.deleteRoomWithResponse(roomId, Context.NONE);
System.out.println("\nDeleted the room with ID: " + roomId);

Ausführen des Codes

Navigieren Sie zum Ausführen des Codes zum Verzeichnis, das die pom.xml-Datei enthält, und kompilieren Sie das Programm.

mvn compile

Erstellen Sie dann das Paket:

mvn package

Führen Sie die Anwendung aus.

mvn exec:java -D"exec.mainClass"="com.communication.rooms.quickstart" -D"exec.cleanupDaemonThreads"="false"

In der erwarteten Ausgabe wird jede abgeschlossene Aktion beschrieben:

Azure Communication Services - Rooms Quickstart

Created a room with id:  99445276259151407

Retrieved room with id:  99445276259151407

Updated room with validFrom: 2023-05-11T22:11:46.784Z, validUntil: 2023-05-11T22:16:46.784Z and pstnDialOutEnabled: true

Participant(s) added/updated

Participants:
8:acs:b6aada1f-0b1d-47ac-866f-91aae00a1d01_00000018-ac89-7c76-35f3-343a0d00e901 (Presenter)
8:acs:b6aada1f-0b1d-47ac-866f-91aae00a1d01_00000018-ac89-7c76-35f3-343a0d00e902 (Consumer)
8:acs:b6aada1f-0b1d-47ac-866f-91aae00a1d01_00000018-ac89-7c76-35f3-343a0d00e903 (Collaborator)

Participant(s) removed

Listing all the rooms IDs in the first two pages of the list of rooms: 
99445276259151407
99445276259151408
99445276259151409

Deleted the room with ID:  99445276259151407

Referenzartikel

Lesen Sie mehr zu den vollständigen Funktionen von Azure Communication Services-Räumen in der Java SDK-Referenz oder REST-API-Referenz.

Ein Raum ist ein serververwalteter Kommunikationsraum für eine bekannte, feste Gruppe von Teilnehmern für die Zusammenarbeit für eine vordefinierte Dauer. Weitere Informationen finden Sie unter "Räume-API für strukturierte Besprechungen".

Voraussetzungen

• Ein Azure-Konto mit einem aktiven Abonnement. Sie können kostenlos ein Konto erstellen.
• Eine aktive Communication Services-Ressource und eine Verbindungszeichenfolge. Erstellen Sie eine Communication Services-Ressource.
• Python 3.7 oder höher für Ihr Betriebssystem

Beispielcode

Laden Sie den Beispielcode von GitHub unter Rooms Quickstart - Python herunter und überprüfen Sie ihn.

Einrichten

Erstellen einer neuen Python-Anwendung

Erstellen Sie in einem Terminal- oder Konsolenfenster einen neuen Ordner für Ihre Anwendung, und navigieren Sie zu diesem Verzeichnis.

mkdir acs-rooms-quickstart
cd acs-rooms-quickstart

Installieren des Pakets

Sie müssen die Azure Communication Rooms-Clientbibliothek für Räume für Python Version 1.1.0 oder höher verwenden.

Wechseln Sie in der Eingabeaufforderung der Konsole zum Verzeichnis, das die Datei „rooms.py“ enthält. Führen Sie dann den folgenden Befehl aus:

pip install azure-communication-rooms

Einrichten des App-Frameworks

Erstellen Sie eine neue Datei namens rooms-quickstart.py, und fügen Sie die grundlegende Programmstruktur hinzu.

import os
from datetime import datetime, timedelta
from azure.core.exceptions import HttpResponseError
from azure.communication.rooms import (
    RoomsClient,
    RoomParticipant,
    ParticipantRole
)

class RoomsQuickstart(object):
    print("Azure Communication Services - Rooms Quickstart")
    #room method implementations goes here

if __name__ == '__main__':
    rooms = RoomsQuickstart()

Initialisieren eines Raumclients

Erstellen Sie ein neues RoomsClient Objekt, das Sie zum Erstellen neuer Räume und zum Verwalten ihrer Eigenschaften und des Lebenszyklus benötigen. Verwenden Sie die Verbindungszeichenfolge Ihres Kommunikationsdiensts, um die Anforderung zu authentifizieren. Weitere Informationen zu Verbindungszeichenfolgen finden Sie unter Erstellen einer Kommunikationsressource.

#Find your Communication Services resource in the Azure portal
connection_string = '<connection_string>'
rooms_client = RoomsClient.from_connection_string(connection_string)

Erstellen eines Raums

Einrichten von Raumteilnehmern

Um einzurichten, wer einem Chatroom beitreten kann, benötigen Sie eine Liste der Identitäten dieser Benutzer. Befolgen Sie die Anweisungen bei Access-Token , um Benutzer zu erstellen und Zugriffstoken auszugeben. Alternativ können Sie die Benutzer bei Bedarf erstellen, indem Sie sie mit der Funktion CommunicationIdentityClient erstellen. Azure Communication Services-Räume unterstützen derzeit nur einen Raumteilnehmer vom Typ CommunicationUserIdentifier. Die Verwendung einer anderen Art von CommunicationIdentity verursacht einen Laufzeitfehler.

Um CommunicationIdentityClient zu verwenden, installieren Sie das folgende Paket:

pip install azure-communication-identity

Importieren Sie außerdem den Namespace des Pakets am Anfang der rooms-quickstart.py-Datei:

from azure.communication.identity import (
    CommunicationIdentityClient
)

Initialisieren Sie nun die CommunicationIdentityClient Und verwenden Sie sie zum Erstellen von Benutzern:

# Create identities for users who will join the room
identity_client = CommunicationIdentityClient.from_connection_string(connection_string)
user1 = identity_client.create_user()
user2 = identity_client.create_user()
user3 = identity_client.create_user()

Erstellen Sie dann die Liste der Raumteilnehmer, indem Sie auf diese Benutzer verweisen:

participant_1 = RoomParticipant(communication_identifier=user1, role=ParticipantRole.PRESENTER)
participant_2 = RoomParticipant(communication_identifier=user2, role=ParticipantRole.CONSUMER)
participants = [participant_1, participant_2]

Initialisieren des Raums

Erstellen Sie einen neuen Raum mithilfe des im vorherigen Codeausschnitt definierten participants.

# Create a room
valid_from = datetime.now()
valid_until = valid_from + timedelta(weeks=4)
pstn_dial_out_enabled = False

try:
    create_room = rooms_client.create_room(
        valid_from=valid_from,
        valid_until=valid_until,
        pstn_dial_out_enabled=pstn_dial_out_enabled,
        participants=participants
    )
    print("\nCreated a room with id: " + create_room.id)
except HttpResponseError as ex:
    print(ex)

Da Räume serverseitige Entitäten sind, sollten Sie die room.id im Speichermedium Ihrer Wahl nachverfolgen und beibehalten. Sie können das id verwenden, um die Eigenschaften eines Raumobjekts anzuzeigen oder zu aktualisieren.

Aktivieren der PSTN-Auswahlfunktion für einen Raum

Für jeden Raum ist die PSTN-Auswahl standardmäßig deaktiviert. Sie können die PSTN-Auswahl für einen Raum bei der Erstellung aktivieren, indem Sie den Parameter pstn_dial_out_enabled als „true“ definieren. Sie können diese Funktion für einen Raum ändern, indem Sie eine Aktualisierungsanforderung für den pstn_dial_out_enabled Parameter ausgeben.

# Create a room with PSTN dial out capability
pstn_dial_out_enabled = True
create_room = rooms_client.create_room(pstn_dial_out_enabled=pstn_dial_out_enabled)
print("\nCreated room with pstn_dial_out_enabled: " + updated_room.pstn_dial_out_enabled)

# Update a room to enable or disable PSTN dial out capability
pstn_dial_out_enabled= False
updated_room = rooms_client.update_room(room_id=room_id, pstn_dial_out_enabled=pstn_dial_out_enabled)
print("\nUpdated room with pstn_dial_out_enabled: " + updated_room.pstn_dial_out_enabled)

Abrufen von Eigenschaften eines vorhandenen Raums

Rufen Sie die Details eines vorhandenen room ab, indem Sie auf die id verweisen:

# Retrieves the room with corresponding ID
room_id = create_room.id
try:
    get_room = rooms_client.get_room(room_id=room_id)
    print("\nRetrieved room with id: ", get_room.id)
except HttpResponseError as ex:
    print(ex)

Aktualisieren der Lebensdauer eines Raums

Sie können die Lebensdauer eines Chatrooms ändern, indem Sie eine Aktualisierungsanforderung für die valid_from und valid_until Parameter ausstellen. Ein Raum kann maximal sechs Monate lang gültig sein.

# Update the lifetime of a room
valid_from =  datetime.now()
valid_until = valid_from + timedelta(weeks=7)
pstn_dial_out_enabled=True

try:
    updated_room = rooms_client.update_room(room_id=room_id, valid_from=valid_from, valid_until=valid_until, pstn_dial_out_enabled=pstn_dial_out_enabled)
     print("\nUpdated room with validFrom: " + updated_room.valid_from + ", validUntil: " + updated_room.valid_until + " and pstn_dial_out_enabled: " + updated_room.pstn_dial_out_enabled)
except HttpResponseError as ex:
    print(ex)

Liste aller aktiven Räume

Um alle aktiven Räume abzurufen, die unter Ihrer Ressource erstellt wurden, verwenden Sie die list_rooms-Methode, die auf dem Client verfügbar gemacht wird.

# List all active rooms
try:
    rooms = rooms_client.list_rooms()
    count = 0
    for room in rooms:
        if count == 1:
            break
        print("\nPrinting the first room in list"
            "\nRoom Id: " + room.id +
            "\nCreated date time: " + str(room.created_at) +
            "\nValid From: " + str(room.valid_from) + 
            "\nValid Until: " + str(room.valid_until) +
            "\nPSTN Dial-Out Enabled: " + str(room.pstn_dial_out_enabled))
        count += 1
except HttpResponseError as ex:
    print(ex)

Hinzufügen oder Aktualisieren von Teilnehmern

Um neue Teilnehmer hinzuzufügen oder vorhandene Teilnehmer in einem Raum zu aktualisieren, verwenden Sie die add_or_update_participants Methode, die auf dem Client verfügbar gemacht wird.

# Add or update participants in a room
try:
    # Update existing user2 from consumer to attendee
    participants = []
    participants.append(RoomParticipant(communication_identifier=user2, role=ParticipantRole.ATTENDEE))

    # Add new participant user3
    participants.append(RoomParticipant(communication_identifier=user3, role=ParticipantRole.COLLABORATOR))
    rooms_client.add_or_update_participants(room_id=room_id, participants=participants)
    print("\nAdd or update participants in room")

except HttpResponseError as ex:
    print('Error in adding or updating participants to room.', ex)

Wenn Sie Teilnehmer zu einem Chatroom hinzufügen, können sie an Anrufen teilnehmen.

Auflisten der Teilnehmer an einem Raum

Rufen Sie die Teilnehmerliste für einen vorhandenen Raum ab, indem Sie auf folgendes room_idverweisen:

# Get list of participants in room
try:
    participants = rooms_client.list_participants(room_id)
    print('\nParticipants in Room Id :', room_id)
    for p in participants:
        print(p.communication_identifier.properties['id'], p.role)
except HttpResponseError as ex:
    print(ex)

Entfernen von Teilnehmer*innen

Um einen Teilnehmer aus einem Chatroom zu entfernen und seinen Zugriff zu widerrufen, verwenden Sie die remove_participants Methode.

# Remove Participants
try:
    participants = [user2]
    rooms_client.remove_participants(room_id=room_id, participants=participants)
    print("\nRemoved participants from room")

except HttpResponseError as ex:
    print(ex)

Raum löschen

Wenn Sie einen vorhandenen Raum aufheben möchten, stellen Sie eine explizite Löschanforderung aus. Alle Räume und zugehörigen Ressourcen werden automatisch am Ende ihrer Gültigkeit und einer Nachfrist gelöscht.

# Delete Room

rooms_client.delete_room(room_id=room_id)
print("\nDeleted room with id: " + room_id)

Ausführen des Codes

Um den Code auszuführen, stellen Sie sicher, dass Sie sich im selben Verzeichnis wie Ihre rooms-quickstart.py Datei befinden.

python rooms-quickstart.py

In der erwarteten Ausgabe wird jede abgeschlossene Aktion beschrieben:

Azure Communication Services - Rooms Quickstart

Created a room with id:  99445276259151407

Retrieved room with id:  99445276259151407

Updated room with validFrom: 2023-05-03T00:00:00+00:00, validUntil: 2023-06-23T00:00:00+00:00 and pstn_dial_out_enabled: True

Printing the first room in list
Room Id: 99445276259151407
Created date time: 2023-05-03T00:00:00+00:00
Valid From: 2023-05-03T00:00:00+00:00
Valid Until: 2023-06-23T00:00:00+00:00
PSTN Dial-Out Enabled: True

Add or update participants in room

Participants in Room Id : 99445276259151407
8:acs:42a0ff0c-356d-4487-a288-ad0aad95d504_00000018-ef00-6042-a166-563a0d0051c1 Presenter
8:acs:42a0ff0c-356d-4487-a288-ad0aad95d504_00000018-ef00-6136-a166-563a0d0051c2 Consumer
8:acs:42a0ff0c-356d-4487-a288-ad0aad95d504_00000018-ef00-61fd-a166-563a0d0051c3 Collaborator

Removed participants from room

Deleted room with id: 99445276259151407

Referenzdokumentation

Lesen Sie mehr zu den vollständigen Funktionen von Azure Communication Services-Räumen in der Python SDK-Referenz oder REST-API-Referenz.

Ein Raum ist ein serververwalteter Kommunikationsraum für eine bekannte, feste Gruppe von Teilnehmern für die Zusammenarbeit für eine vordefinierte Dauer. Weitere Informationen finden Sie unter "Räume-API für strukturierte Besprechungen".

Voraussetzungen

• Ein Azure-Konto mit einem aktiven Abonnement. Sie können kostenlos ein Konto erstellen.
• Eine aktive Communication Services-Ressource und eine Verbindungszeichenfolge. Erstellen Sie eine Communication Services-Ressource.
• Die aktuellen Versionen von Node.js. Active LTS- und Maintenance LTS Versionen

Beispielcode

Überprüfen und laden Sie den Beispielcode von GitHub auf Rooms Quickstart - JavaScript herunter.

Einrichten

Erstellen einer neuen Webanwendung

Erstellen Sie in einem Terminal- oder Konsolenfenster einen neuen Ordner für Ihre Anwendung, und navigieren Sie zu diesem Verzeichnis.

mkdir acs-rooms-quickstart && cd acs-rooms-quickstart

Führen Sie npm init aus, um die Datei package.json mit den Standardeinstellungen zu erstellen.

npm init -y

Erstellen Sie eine neue Datei index.js , in der Sie den Code für dieses Beispiel hinzufügen.

Installieren der Pakete

Sie müssen die Azure Communication Rooms-Clientbibliothek für JavaScript Version 1.1.0 oder höher verwenden.

Verwenden Sie den npm install Befehl, um die folgenden Kommunikationsdienste-SDKs für JavaScript zu installieren.

npm install @azure/communication-rooms --save

Einrichten des App-Frameworks

Fügen Sie in der Datei index.js den folgenden Code hinzu. Fügen Sie den Code für dieses Beispiel in der main Funktion hinzu.

const { RoomsClient } = require('@azure/communication-rooms');

const main = async () => {
  console.log("Azure Communication Services - Rooms Quickstart")

  // Quickstart code goes here

};

main().catch((error) => {
  console.log("Encountered an error");
  console.log(error);
})

Initialisieren eines Raumclients

Erstellen Sie ein neues RoomsClient Objekt, das Sie zum Erstellen neuer Räume und zum Verwalten ihrer Eigenschaften und des Lebenszyklus benötigen. Verwenden Sie die Verbindungszeichenfolge Ihres Kommunikationsdiensts, um die Anforderung zu authentifizieren. Weitere Informationen zu Verbindungszeichenfolgen finden Sie unter Erstellen einer Kommunikationsressource.

Fügen Sie in index.js innerhalb der main-Funktion den folgenden Code hinzu.

const connectionString =
    process.env["COMMUNICATION_CONNECTION_STRING"] ||
    "endpoint=https://<resource-name>.communication.azure.com/;<access-key>";

// create RoomsClient
const roomsClient = new RoomsClient(connectionString);

Erstellen eines Raums

Einrichten von Raumteilnehmern

Um einzurichten, wer einem Chatroom beitreten kann, müssen Sie über die Liste der Identitäten dieser Benutzer verfügen. Befolgen Sie die Anweisungen in Access-Token , um Benutzer zu erstellen und Zugriffstoken auszugeben. Alternativ können Sie die Benutzer bei Bedarf erstellen, indem Sie sie mit der Funktion CommunicationIdentityClient erstellen. Azure Communication Services-Räume unterstützen derzeit nur einen Raumteilnehmer vom Typ CommunicationUserIdentifier. Die Verwendung anderer Typen von CommunicationIdentity führt zu einem Laufzeitfehler.

Um das CommunicationIdentityClientnpm-Paket zu verwenden, installieren Sie das folgende npm-Paket:

npm install @azure/communication-identity --save

Fügen Sie oben in der index.js Datei das folgende erforderliche Paket hinzu:

const { CommunicationIdentityClient } = require('@azure/communication-identity');

Initialisieren Sie nun den CommunicationIdentityClient und verwenden Sie ihn zum Erstellen von Benutzern:

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

Erstellen Sie dann die Liste der Raumteilnehmer, indem Sie auf diese Benutzer verweisen:

const participants = [
  {
      id: user1.user,
      role: "Presenter",
  },
  {
    id: user2.user,
    role: "Consumer",
  }
]

Initialisieren des Raums

Erstellen Sie einen neuen Raum mithilfe des im vorherigen Codeausschnitt definierten participants.

// Create a room
var validFrom = new Date(Date.now());
var validUntil = new Date(validFrom.getTime() + 60 * 60 * 1000);
var pstnDialOutEnabled = false;

const createRoomOptions = {
  validFrom,
  validUntil,
  pstnDialOutEnabled,
  participants
};

const createRoom = await roomsClient.createRoom(createRoomOptions);
const roomId = createRoom.id;
console.log("\nCreated a room with id: ", roomId);

Da Räume serverseitige Entitäten sind, sollten Sie die roomId im Speichermedium Ihrer Wahl nachverfolgen und beibehalten. Sie können auf die roomId verweisen, um die Eigenschaften eines room-Objekts anzuzeigen oder zu aktualisieren.

Aktivieren der PSTN-Auswahlfunktion für einen Raum

Für jede room ist die PSTN-Auswahl standardmäßig deaktiviert. Sie können die PSTN-Auswahl für einen Raum bei der Erstellung aktivieren, indem Sie den Parameter pstnDialOutEnabled als „true“ definieren. Sie können auch die Funktion für ein room ändern, indem Sie eine Aktualisierungsanforderung für den pstnDialOutEnabled Parameter ausgeben.

// Create a room with PSTN dial out capability
var pstnDialOutEnabled = true;
const createRoomOptions = {
  pstnDialOutEnabled,
};

const createRoom = await roomsClient.createRoom(createRoomOptions);
console.log("\nCreated a room with PSTN dial out enabled: ", createRoom.pstnDialOutEnabled);

// Update a room to enable or disable PSTN dial out capability
pstnDialOutEnabled = false;
const updateRoomOptions = {
  pstnDialOutEnabled,
};

const updateRoom = await roomsClient.updateRoom(roomId, updateRoomOptions);
console.log("\nUpdated a room with PSTN dial out enabled: ", updateRoom.pstnDialOutEnabled);

Abrufen von Eigenschaften eines vorhandenen Raums

Rufen Sie die Details eines vorhandenen Raums ab, indem Sie auf folgendes roomIdverweisen:

// Retrieve the room with corresponding ID
const getRoom = await roomsClient.getRoom(roomId);
console.log("\nRetrieved room with id: ", getRoom.id);

Aktualisieren der Lebensdauer eines Raums

Sie können die Lebensdauer eines Chatrooms ändern, indem Sie eine Aktualisierungsanforderung für die validFrom und validUntil Parameter ausstellen. Ein Raum kann maximal sechs Monate lang gültig sein.

// Update room lifetime
validFrom.setTime(validUntil.getTime());
validUntil.setTime(validFrom.getTime() + 5 * 60 * 1000);
pstnDialOutEnabled = true;
// request payload to update a room
const updateRoomOptions = {
  validFrom,
  validUntil,
  pstnDialOutEnabled,
};

const updateRoom = await roomsClient.updateRoom(roomId, updateRoomOptions);
console.log("\nUpdated room with validFrom: ", updateRoom.validFrom, ", validUntil: ", updateRoom.validUntil, " and pstnDialOutEnabled: ", updateRoom.pstnDialOutEnabled);

Abrufen der Liste der Räume

Rufen Sie Ihre Liste der Räume mithilfe der listRooms Methode ab:

const roomsList = await roomsClient.listRooms();
console.log("\nRetrieved list of rooms; printing first room:");
for await (const currentRoom of roomsList) {
  // access room data here
  console.log(currentRoom);
  break;
}

Hinzufügen oder Aktualisieren von Teilnehmern

Um einem Raum neue Teilnehmer hinzuzufügen, verwenden Sie die addOrUpdateParticipants Methode, die auf dem Client verfügbar gemacht wird. Diese Methode aktualisiert auch teilnehmende Personen, die bereits im Raum vorhanden sind.

// Add and update participants

const user3 = await identityClient.createUserAndToken(["voip"]);

// request payload to add and update participants
const addOUpdateParticipantsList = [
  {
      id: user1.user,
      role: "Presenter",
  },
  {
    id: user3.user,
    role: "Collaborator",
  }
]

// add user3 to the room and update user1 to Presenter role
await roomsClient.addOrUpdateParticipants(roomId, addOUpdateParticipantsList);
console.log("\nAdded and updated participants in the room");

Nachdem Sie Teilnehmer zu einem Chatroom hinzugefügt haben, sind sie berechtigt, an Anrufen teilzunehmen.

Abrufen der Teilnehmerliste

Rufen Sie die Teilnehmerliste für einen vorhandenen Raum ab, indem Sie auf folgendes roomIdverweisen:

const participantsList = await roomsClient.listParticipants(roomId);
console.log("\nRetrieved participants for room:");
for await (const participant of participantsList) {
  // access participant data here
  console.log(participant);
}

Entfernen von Teilnehmer*innen

Um einen Teilnehmer aus einem Chatroom zu entfernen und seinen Zugriff zu widerrufen, verwenden Sie die removeParticipants Methode.

// Remove both users from the room
const removeParticipantsList = [user1.user, user2.user]

// remove both users from the room with the request payload
await roomsClient.removeParticipants(roomId, removeParticipantsList);
console.log("\nRemoved participants from room");

Raum löschen

Wenn Sie einen vorhandenen Raum aufheben möchten, können Sie eine explizite Löschanforderung ausstellen. Alle Räume und die zugehörigen Ressourcen werden automatisch am Ende ihrer Gültigkeit und einer Nachfrist gelöscht.

// Deletes the specified room
await roomsClient.deleteRoom(roomId);
console.log("\nDeleted room with id: ", roomId)

Ausführen des Codes

Um den Code auszuführen, stellen Sie sicher, dass Sie sich im selben Verzeichnis wie Ihre index.js Datei befinden.

node index.js

In der erwarteten Ausgabe wird jede abgeschlossene Aktion beschrieben:

Azure Communication Services - Rooms QuickStart

Created a room with id:  99445276259151407

Retrieved room with id:  99445276259151407

Updated room with validFrom:  2023-05-11T22:11:46.784Z, validUntil:  2023-05-11T22:16:46.784Z and pstnDialOutEnabled: true

Retrieved list of rooms; printing first room:

{
  id: "99445276259151407",
  createdAt: "2023-05-11T22:11:50.784Z",
  validFrom: "2023-05-11T22:11:46.784Z",
  validUntil: "2023-05-11T22:16:46.784Z"
}

Added and updated participants in the room

Retrieved participants for room:
{
  id: {
    kind: 'communicationUser',
    communicationUserId: '8:acs:b6aada1f-0b1d-47ac-866f-91aae00a1d01_00000018-ac89-7c76-35f3-343a0d00e901'
  },
  role: 'Presenter'
}
{
  id: {
    kind: 'communicationUser',
    communicationUserId: '8:acs:b6aada1f-0b1d-47ac-866f-91aae00a1d01_00000018-ac89-7ccc-35f3-343a0d00e902'
  },
  role: 'Consumer'
}
{
  id: {
    kind: 'communicationUser',
    communicationUserId: '8:acs:b6aada1f-0b1d-47ac-866f-91aae00a1d01_00000018-ac89-7ccc-35f3-343a0d00e903'
  },
  role: 'Collaborator'
}

Removed participants from room

Deleted room with id:  99445276259151407

Referenzdokumentation

Lesen Sie mehr zu den vollständigen Funktionen von Azure Communication Services-Räumen in der JavaScript SDK-Referenz oder REST-API-Referenz.