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

Azure Communication Rooms ügyfélkódtár Pythonhoz – 1.0.0-s verzió

  • Cikk

Ez a csomag tartalmaz egy Python SDK-t Azure Communication Services a Szobákhoz. További információ a Azure Communication Services itt

Felelősséget kizáró nyilatkozat

Az Azure SDK Python-csomagok támogatása a Python 2.7-hez 2022. január 01-én véget ért. További információkért és kérdésekért lásd: https://github.com/Azure/azure-sdk-for-python/issues/20691

Fő fogalmak

Az Azure Communication Rooms csomag a következők végrehajtására szolgál:

  • Ütemezett értekezletek létrehozása
  • Felügyelt engedélyekkel rendelkező értekezletek létrehozása a résztvevők számára

Első lépések

A csomag telepítése

python -m pip install azure-communication-rooms

Prequisites

  • A csomag használatához Python 3.7 vagy újabb verzió szükséges.
  • A csomag használatához Azure-előfizetésre van szükség.
  • Üzembe helyezett Communication Services-erőforrás. A beállításához használhatja az Azure Portalt vagy a Azure PowerShell.

Ügyfél inicializálása

A Konferenciaügyfél inicializálásához a kapcsolati sztring használható a példányosításhoz.

from azure.communication.rooms import RoomsClient

client = RoomsClient.from_connection_string(conn_str='<connection_str>' )

Példák

Kulcsparaméterek

  • valid_from: Egy datetime objektum, amelyből a helyiség meg fog indulni
  • valid_until: Egy datetime objektum, amely után a helyiségértekezlet véget ér
  • participants: A helyiségbe meghívott MRI-ket tartalmazó lista RoomParticipant, valamint választható ParticipantRole. Ha ParticipantRole nincs megadva, akkor alapértelmezés szerint az lesz Attendee . A fenti attribútumok nem kötelezőek. A szolgáltatás a valid_until alapértelmezett értékeit biztosítja, és valid_from, ha hiányoznak. Az alapértelmezett érték azvalid_from aktuális dátum időpontja, az alapértelmezett valid_until értéke pedig valid_from + 180 daysa .

Helyiség létrehozása

Helyiség létrehozásához hívja meg a függvényt a create_room következőből: RoomsClient. A valid_from, valid_untilés participants argumentumok megadása nem kötelező.

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

client = RoomsClient.from_connection_string(conn_str='<connection_str>')
valid_from = datetime.now()
valid_until = valid_from + relativedelta(months=+1)
participants = []
participants.append(RoomParticipant(CommunicationUserIdentifier("<ACS User MRI identity 1>")))
participants.append(RoomParticipant(CommunicationUserIdentifier("<ACS User MRI identity 2>"), ParticipantRole.CONSUMER))
participants.append(RoomParticipant(CommunicationUserIdentifier("<ACS User MRI identity 3>"), ParticipantRole.PRESENTER))

try:
    create_room_response = client.create_room(
        valid_from=valid_from,
        valid_until=valid_until,
        participants=participants
    )
except HttpResponseError as ex:
    print(ex)

Helyiség frissítése

A valid_from létrehozott helyiség és valid_until tulajdonságai frissíthetők a update_room függvény a következőből RoomsClientvaló meghívásával: .

try:
    update_room_response = client.update_room(
        room_id="id of the room to be updated",
        valid_from=datetime.now(),
        valid_until=valid_from + timedelta(weeks=4)
    )
except HttpResponseError as e:
    print('service responds error: {}'.format(e))

Szoba beolvasása

A létrehozott helyiség lekérhető úgy, hogy meghívja a függvényt a get_room függvényből RoomsClient , és átadja a kapcsolódónak room_id.

try:
    get_room_response = client.get_room(room_id="id of the room to get")
except HttpResponseError as ex:
    print(ex)

Szobák listázása

Az ACS-erőforrással létrehozott összes érvényes helyiség lekéréséhez hívja meg a függvényt a list_rooms következőből: RoomsClient.

try:
    list_room_response = client.list_rooms()
except HttpResponseError as ex:
    print(ex)

Helyiség törlése

Helyiség törléséhez hívja meg a függvényt a delete_room RoomsClientből.

try:
    client.delete_room(
        room_id="id of the room to be deleted")
except HttpResponseError as e:
    print('service responds error: {}'.format(e))

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

Új résztvevők beszúrásához vagy meglévő résztvevők frissítéséhez hívja meg a függvényt a add_or_update_participants RoomsClientből.

participants = []
participants.append(RoomParticipant(CommunicationUserIdentifier("<ACS User MRI identity 1>")))
participants.append(RoomParticipant(CommunicationUserIdentifier("<ACS User MRI identity 2>"), ParticipantRole.ATTENDEE))
participants.append(RoomParticipant(CommunicationUserIdentifier("<ACS User MRI identity 3>"), ParticipantRole.CONSUMER))
try:
    response = client.add_or_update_participants(
        room_id="id of the room to be updated",
        participants=participants
    )
except HttpResponseError as e:
    print('service responds error: {}'.format(e))

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

Távolítsa el a résztvevőket egy szobából a függvényNek a remove_participants RoomsClientből való meghívásával.

communication_identifiers = [CommunicationUserIdentifier("<ACS User MRI identity 2>")]

try:
    remove_participants_response = client.remove_participants(
        room_id=room_id,
        participants=communication_identifiers
    )
except HttpResponseError as ex:
    print(ex)

Résztvevők listázása

Kérje le egy meglévő helyiség résztvevőinek listáját a room_idkövetkező hivatkozással:

try:
    participants = self.rooms_client.list_participants(room_id)
except HttpResponseError as ex:
    print(ex)

Hibaelhárítás

A helyiségműveletek kivételt jeleznek, ha a kiszolgálóra irányuló kérés meghiúsul. A Rooms-ügyfél kivételeket fog emelni az Azure Core-ban.

Következő lépések

További mintakód

Tekintse meg a mintakönyvtárat , amely részletesen bemutatja, hogyan hozhat létre és kezelhet helyiségeket ezzel a tárral.

Visszajelzés küldése

Ha hibába ütközik, vagy javaslatai vannak, jelentse be a problémát a projekt Problémák szakaszában

Közreműködés

A projektben szívesen fogadjuk a hozzájárulásokat és a javaslatokat. A legtöbb hozzájáruláshoz el kell fogadnia egy Közreműködői licencszerződést (CLA-t), amelyben kijelenti, hogy jogosult arra, hogy ránk ruházza hozzájárulása felhasználási jogát, és ezt ténylegesen meg is teszi. További részletekért lásd: https://cla.microsoft.com.

A lekéréses kérelmek elküldésekor egy CLA-robot automatikusan meghatározza, hogy kell-e biztosítania CLA-t, és megfelelően kitölti a lekéréses kérelmet (például címke, megjegyzés). Egyszerűen csak kövesse a robot által megadott utasításokat. Ezt csak egyszer kell elvégeznie az összes olyan tárházban, amely a CLA-t használja.

A projekt a Microsoft nyílt forráskódú projekteket szabályozó etikai kódexe, a Microsoft Open Source Code of Conduct hatálya alá esik. További információkért keresse fel a Viselkedési szabályzattal kapcsolatos gyakori kérdések oldalát, illetve küldje el kérdéseit vagy észrevételeit a következő címre: opencode@microsoft.com.