Azure Communication Rooms-clientbibliotheek voor Python - versie 1.0.0

Artikel
06/14/2023

Dit pakket bevat een Python-SDK voor Azure Communication Services for Rooms. Lees hier meer over Azure Communication Services

Disclaimer

Ondersteuning voor Azure SDK Python-pakketten voor Python 2.7 is beëindigd op 1 januari 2022. Voor meer informatie en vragen raadpleegt u https://github.com/Azure/azure-sdk-for-python/issues/20691

Belangrijkste concepten

Het Pakket Azure Communication Rooms wordt gebruikt om het volgende te doen:

Geplande vergaderingen maken
Vergaderingen maken met beheerde machtigingen voor de deelnemers

Aan de slag

Het pakket installeren

python -m pip install azure-communication-rooms

Vereisten

Python 3.7 of hoger is vereist voor het gebruik van dit pakket.
U hebt een Azure-abonnement nodig om dit pakket te kunnen gebruiken.
Een geïmplementeerde Communication Services-resource. U kunt azure portal of de Azure PowerShell gebruiken om het in te stellen.

Client initialisatie

Als u de Rooms-client wilt initialiseren, kunt u de connection string gebruiken om een instantie te maken.

from azure.communication.rooms import RoomsClient

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

Voorbeelden

Sleutelparameters

valid_from: Een datum/tijd-object van waaruit de ruimte begint te bestaan
valid_until: Een datum/tijd-object waarna de vergadering in de ruimte eindigt
participants: Een lijst met RoomParticipantMRI's van genodigden in de ruimte en optioneel ParticipantRole. Als ParticipantRole niet is opgegeven, is Attendee dit standaard. Alle bovenstaande kenmerken zijn optioneel. De service biedt standaardwaarden van valid_until en valid_from als deze ontbreken. De standaardwaarde voorvalid_from is de huidige datum/tijd en de standaardwaarde voor valid_until is valid_from + 180 days.

Een ruimte maken

Als u een ruimte wilt maken, roept u de create_room functie aan vanuit RoomsClient. De valid_fromargumenten , valid_untilen participants zijn allemaal optioneel.

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)

Een ruimte bijwerken

De valid_from eigenschappen en valid_until van een gemaakte ruimte kunnen worden bijgewerkt door de update_room functie aan te roepen vanuit 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))

Een kamer downloaden

Een gemaakte ruimte kan worden opgehaald door de get_room functie aan te roepen van RoomsClient en door te geven in de bijbehorende room_id.

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

Ruimten weergeven

Haal alle geldige ruimten op die zijn gemaakt met een ACS-resource door de list_rooms functie aan te roepen vanuit RoomsClient.

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

Een ruimte verwijderen

Als u een ruimte wilt verwijderen, roept u de delete_room functie aan vanuit RoomsClient.

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

Deelnemers aan een ruimte toevoegen of bijwerken

Als u nieuwe deelnemers wilt invoegen of bestaande deelnemers wilt bijwerken, roept u de add_or_update_participants functie aan vanuit 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))

Deelnemers verwijderen

Verwijder deelnemers uit een ruimte door de remove_participants functie aan te roepen vanuit 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)

Deelnemers weergeven

Haal de lijst met deelnemers voor een bestaande ruimte op door te verwijzen naar de room_id:

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

Problemen oplossen

Bewerkingen in ruimten genereren een uitzondering als de aanvraag naar de server mislukt. De Rooms-client genereert uitzonderingen die zijn gedefinieerd in Azure Core.

Volgende stappen

Meer voorbeeldcode

Bekijk de map met voorbeelden voor gedetailleerde voorbeelden van het gebruik van deze bibliotheek voor het maken en beheren van ruimten.

Feedback geven

Als u fouten tegenkomt of suggesties hebt, kunt u een probleem melden in de sectie Problemen van het project

Bijdragen

Wij verwelkomen bijdragen en suggesties voor dit project. Voor de meeste bijdragen moet u instemmen met een licentieovereenkomst voor bijdragers (CLA: Contributor License Agreement) waarin u verklaart dat u gerechtigd bent ons het recht te geven uw bijdrage te gebruiken, en dat u dit ook doet. Ga naar https://cla.microsoft.com voor meer informatie.

Wanneer u een pull-aanvraag indient, wordt met een CLA-bot automatisch bepaald of u een CLA moet verschaffen en wordt de pull-aanvraag dienovereenkomstig opgemaakt (bijvoorbeeld met een label of commentaar). Volg gewoon de instructies van de bot. U hoeft dit maar eenmaal te doen voor alle repo's waar gebruik wordt gemaakt van onze CLA.

Op dit project is de Microsoft Open Source Code of Conduct (Microsoft Open Source-gedragscode) van toepassing. Raadpleeg de Veelgestelde vragen over de gedragscode voor meer informatie of neem contact op met opencode@microsoft.com als u meer vragen of opmerkingen hebt.

Delen via