Klientská knihovna Azure Communication Rooms pro Python – verze 1.0.0

Článek
06/14/2023

Tento balíček obsahuje sadu Python SDK pro Azure Communication Services for Rooms. Další informace o Azure Communication Services najdete tady.

Právní omezení

Podpora balíčků Azure SDK Python pro Python 2.7 skončila 1. ledna 2022. Další informace a dotazy najdete na https://github.com/Azure/azure-sdk-for-python/issues/20691

Klíčové koncepty

Balíček Azure Communication Rooms slouží k provedení následujících kroků:

Vytváření naplánovaných schůzek
Vytváření schůzek se spravovanými oprávněními pro účastníky

Začínáme

Instalace balíčku

python -m pip install azure-communication-rooms

Požadavky

K použití tohoto balíčku se vyžaduje Python 3.7 nebo novější.
K použití tohoto balíčku potřebujete předplatné Azure .
Nasazený prostředek komunikačních služeb K jeho nastavení můžete použít Azure Portal nebo Azure PowerShell.

Inicializace klienta

K inicializaci klienta Místnosti je možné k vytvoření instance použít připojovací řetězec.

from azure.communication.rooms import RoomsClient

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

Příklady

Klíčové parametry

valid_from: Objekt datetime, ze kterého začne místnost
valid_until: Objekt datetime, po kterém by schůzka v místnosti skončila
participants: Seznam RoomParticipantobsahující mri pozvaných účastníků do místnosti a volitelný ParticipantRole. Pokud ParticipantRole není zadaný, bude Attendee ve výchozím nastavení. Všechny výše uvedené atributy jsou volitelné. Služba poskytuje výchozí hodnoty valid_until a valid_from, pokud chybí. Výchozí hodnota provalid_from je aktuální datum a čas a výchozí hodnota pro valid_until je valid_from + 180 days.

Vytvoření místnosti

Pokud chcete vytvořit místnost, zavolejte create_room funkci z RoomsClient. Argumenty valid_from, valid_untila participants jsou volitelné.

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)

Aktualizace místnosti

Vlastnosti valid_from a valid_until vytvořené místnosti lze aktualizovat voláním update_room funkce z RoomsClient.

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

Získat místnost

Vytvořenou místnost lze načíst zavoláním get_room funkce z RoomsClient a předáním přidruženého room_idobjektu .

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

Výpis místností

Načtěte všechny platné místnosti vytvořené pomocí prostředku služby ACS zavoláním list_rooms funkce z RoomsClient.

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

Odstranění místnosti

Pokud chcete místnost odstranit, zavolejte delete_room funkci z RoomsClient.

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

Přidání nebo aktualizace účastníků v místnosti

Pokud chcete vložit nové účastníky nebo aktualizovat stávající účastníky, zavolejte add_or_update_participants funkci z RoomsClient.

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

Odebrání účastníků

Odeberte účastníky z místnosti zavoláním remove_participants funkce z RoomsClient.

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)

Vypsat účastníky

Načtěte seznam účastníků pro existující místnost odkazem na room_id:

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

Poradce při potížích

Operace místností vyvolají výjimku, pokud požadavek na server selže. Klient Rooms vyvolá výjimky definované v Azure Core.

Další kroky

Další vzorový kód

Podrobné příklady použití této knihovny k vytváření a správě místností najdete v adresáři samples .

Zadání zpětné vazby

Pokud narazíte na nějaké chyby nebo máte návrhy, nahlaste problém v části Problémy projektu.

Přispívání

Tento projekt vítá příspěvky a návrhy. Většina příspěvků vyžaduje souhlas s licenční smlouvou s přispěvatelem (CLA), která stanoví, že máte právo udělit nám práva k používání vašeho příspěvku a skutečně tak činíte. Podrobnosti najdete tady: https://cla.microsoft.com

Při odesílání žádosti o přijetí změn robot CLA automaticky určí, jestli je potřeba poskytnout smlouvu CLA, a příslušným způsobem žádost o přijetí změn upraví (např. přidáním jmenovky nebo komentáře). Stačí postupovat podle pokynů robota. Pro všechna úložiště používající naši smlouvu CLA to stačí udělat jenom jednou.

Tento projekt přijal pravidla chování pro Microsoft Open Source. Další informace najdete v nejčastějších dotazech k pravidlům chování. V případě jakýchkoli dotazů nebo připomínek kontaktujte opencode@microsoft.com.

Sdílet prostřednictvím