Biblioteca de cliente das Salas de Comunicação do Azure para Python – versão 1.0.0

Artigo
06/14/2023

Este pacote contém um SDK Python para Azure Communication Services para Salas. Leia mais sobre Azure Communication Services aqui

Exclusão de Responsabilidade

O suporte de pacotes Python do SDK do Azure para Python 2.7 terminou a 01 de janeiro de 2022. Para obter mais informações e perguntas, veja https://github.com/Azure/azure-sdk-for-python/issues/20691

Conceitos-chave

O pacote Azure Communication Rooms é utilizado para fazer o seguinte:

Criar reuniões agendadas
Criar reuniões com permissões geridas para os participantes

Introdução

Instalar o pacote

python -m pip install azure-communication-rooms

Pré-requisitos

O Python 3.7 ou posterior é necessário para utilizar este pacote.
Precisa de uma subscrição do Azure para utilizar este pacote.
Um recurso do Communication Services implementado. Pode utilizar o Portal do Azure ou o Azure PowerShell para configurá-lo.

Inicialização do Cliente

Para inicializar o Cliente de Salas, a cadeia de ligação pode ser utilizada para instanciar.

from azure.communication.rooms import RoomsClient

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

Exemplos

Parâmetros principais

valid_from: um objeto datetime a partir do qual a sala irá começar a existir
valid_until: um objeto datetime após o qual a reunião da sala terminaria
participants: uma lista de RoomParticipantitens que contêm ressonâncias magnéticas de convidados para a sala, bem como opcional ParticipantRole. Se ParticipantRole não for especificado, será Attendee por predefinição. Todos os atributos acima são opcionais. O serviço fornece valores predefinidos de valid_until e valid_from se estiverem em falta. A predefinição paravalid_from é a data atual e a predefinição para valid_until é valid_from + 180 days.

Criar uma sala

Para criar uma sala, chame a create_room função de RoomsClient. Os valid_fromargumentos , valid_untile participants são todos opcionais.

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)

Atualizar uma sala

As valid_from propriedades e valid_until de uma sala criada podem ser atualizadas ao chamar a função de update_roomRoomsClient.

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

Obter uma sala

Uma sala criada pode ser obtida ao chamar a get_room função de RoomsClient e transmitir o associado room_id.

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

Listar salas

Obtenha todas as salas válidas criadas com um recurso ACS ao chamar a função de list_roomsRoomsClient.

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

Eliminar uma sala

Para eliminar uma sala, chame a delete_room função de RoomsClient.

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

Adicionar ou atualizar participantes numa sala

Para inserir novos participantes ou atualizar os participantes existentes, chame a add_or_update_participants função de 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))

Remover participantes

Remova os participantes de uma sala ao chamar a remove_participants função de 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)

Listar participantes

Obtenha a lista de participantes de uma sala existente ao referenciar :room_id

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

Resolução de problemas

As operações das salas irão gerar uma exceção se o pedido ao servidor falhar. O cliente Salas irá gerar exceções definidas no Azure Core.

Passos seguintes

Mais código de exemplo

Veja o diretório de exemplos para obter exemplos detalhados sobre como utilizar esta biblioteca para criar e gerir salas.

Enviar Comentários

Se encontrar erros ou tiver sugestões, submeta um problema na secção Problemas do projeto

Contribuir

Agradecemos todas as contribuições e sugestões para este projeto. A maioria das contribuições requerem que celebre um Contrato de Licença de Contribuição (CLA) no qual se declare que tem o direito de conceder e que, na verdade, concede-nos os direitos para utilizar a sua contribuição. Para mais detalhes, visite https://cla.microsoft.com.

Quando submete um pedido Pull, um bot do CLA determina automaticamente se tem de fornecer um CLA e decorar o PR de forma adequada (por exemplo, etiqueta, comentário). Só tem de seguir as instruções fornecidas pelo bot. Apenas terá de fazer isto uma vez em todos os repositórios com o nosso CLA.

Este projeto adotou o Microsoft Open Source Code of Conduct (Código de Conduta do Microsoft Open Source). Para obter mais informações, veja a Code of Conduct FAQ (FAQ do Código de Conduta) ou envie um e-mail para opencode@microsoft.com com quaisquer perguntas ou comentários adicionais.

Partilhar via