Biblioteka klienta usługi Azure Communication Rooms dla języka Python — wersja 1.0.0
Ten pakiet zawiera zestaw SDK języka Python dla Azure Communication Services dla pokoi. Dowiedz się więcej o Azure Communication Services tutaj
Zrzeczenie odpowiedzialności
Obsługa pakietów języka Python zestawu Azure SDK dla języka Python 2.7 została zakończona 01 stycznia 2022 r. Aby uzyskać więcej informacji i pytań, zapoznaj się z artykułem https://github.com/Azure/azure-sdk-for-python/issues/20691
Kluczowe pojęcia
Pakiet Usługi Azure Communication Rooms służy do wykonywania następujących czynności:
- Tworzenie zaplanowanych spotkań
- Tworzenie spotkań z uprawnieniami zarządzanymi dla uczestników
Wprowadzenie
Instalowanie pakietu
python -m pip install azure-communication-rooms
Wymagania wstępne
- Do korzystania z tego pakietu wymagany jest język Python w wersji 3.7 lub nowszej.
- Do korzystania z tego pakietu potrzebna jest subskrypcja platformy Azure .
- Wdrożony zasób usług komunikacyjnych. Aby go skonfigurować, możesz użyć witryny Azure Portal lub Azure PowerShell.
Inicjowanie klienta
Aby zainicjować klienta rooms, parametry połączenia można użyć do utworzenia wystąpienia.
from azure.communication.rooms import RoomsClient
client = RoomsClient.from_connection_string(conn_str='<connection_str>' )
Przykłady
Parametry klucza
valid_from
: obiekt daty/godziny, z którego pokój rozpocznie się od istniejącego miejscavalid_until
: Obiekt daty/godziny, po którym spotkanie w pokoju zakończy sięparticipants
: ListaRoomParticipant
elementów zawierających zaproszenia MRI do pokoju, a także opcjonalnąParticipantRole
. JeśliParticipantRole
nie zostanie określony, zostanieAttendee
on domyślnie określony. Wszystkie powyższe atrybuty są opcjonalne. Usługa udostępnia wartości domyślne valid_until i valid_from, jeśli ich brakuje. Wartość domyślnavalid_from
to bieżąca godzina daty i wartość domyślnavalid_until
tovalid_from + 180 days
.
Tworzenie pokoju
Aby utworzyć pokój, wywołaj create_room
funkcję na podstawie RoomsClient
polecenia . Argumenty valid_from
, valid_until
i participants
są opcjonalne.
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)
Aktualizowanie pokoju
Właściwości valid_from
i valid_until
utworzonego pokoju można zaktualizować, wywołując update_room
funkcję z RoomsClient
polecenia .
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))
Uzyskiwanie pokoju
Utworzony pokój można pobrać, wywołując get_room
funkcję z RoomsClient
obiektu i przekazując skojarzony element room_id
.
try:
get_room_response = client.get_room(room_id="id of the room to get")
except HttpResponseError as ex:
print(ex)
Wyświetlanie listy pomieszczeń
Pobierz wszystkie prawidłowe pokoje utworzone za pomocą zasobu ACS, wywołując list_rooms
funkcję z RoomsClient
polecenia .
try:
list_room_response = client.list_rooms()
except HttpResponseError as ex:
print(ex)
Usuwanie pokoju
Aby usunąć pokój, wywołaj delete_room
funkcję z obiektu RoomsClient.
try:
client.delete_room(
room_id="id of the room to be deleted")
except HttpResponseError as e:
print('service responds error: {}'.format(e))
Dodawanie lub aktualizowanie uczestników w pokoju
Aby wstawić nowych uczestników lub zaktualizować istniejących uczestników, wywołaj add_or_update_participants
funkcję z obiektu 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))
Usuwanie uczestników
Usuń uczestników z pokoju, wywołując remove_participants
funkcję z obiektu 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)
Wyświetlanie listy uczestników
Pobierz listę uczestników istniejącego pokoju, odwołując room_id
się do elementu :
try:
participants = self.rooms_client.list_participants(room_id)
except HttpResponseError as ex:
print(ex)
Rozwiązywanie problemów
Operacje w pokojach zgłaszają wyjątek, jeśli żądanie do serwera zakończy się niepowodzeniem. Klient Rooms zgłosi wyjątki zdefiniowane w usłudze Azure Core.
Następne kroki
Więcej przykładów kodu
Zapoznaj się z katalogiem przykładów , aby zapoznać się ze szczegółowymi przykładami użycia tej biblioteki do tworzenia pomieszczeń i zarządzania nimi.
Przekazywanie opinii
Jeśli wystąpią jakiekolwiek usterki lub sugestie, zgłoś problem w sekcji Problemy w projekcie
Współtworzenie
W tym projekcie zachęcamy do współtworzenia i zgłaszania sugestii. Współtworzenie w większości przypadków wymaga zgody na umowę licencyjną dotyczącą współautorów (CLA, Contributor License Agreement), zgodnie z którą współautor ma prawo udzielić i faktycznie udziela nam praw do używania wytworzonej przez siebie zawartości. Aby uzyskać szczegółowe informacje, odwiedź stronę https://cla.microsoft.com.
Po przesłaniu żądania ściągnięcia robot CLA automatycznie określi, czy musisz przekazać umowę CLA, i doda odpowiednie informacje do tego żądania (na przykład etykietę czy komentarz). Po prostu postępuj zgodnie z instrukcjami robota. Wystarczy zrobić to raz dla wszystkich repozytoriów, w przypadku których jest używana nasza umowa CLA.
W tym projekcie przyjęto Kodeks postępowania oprogramowania Open Source firmy Microsoft. Aby uzyskać więcej informacji, zobacz artykuł Code of Conduct FAQ (Często zadawane pytania dotyczące kodeksu postępowania). Jeśli będziesz mieć jeszcze jakieś pytania lub komentarze, wyślij wiadomość e-mail na adres opencode@microsoft.com.
Azure SDK for Python