Get Messages

Visão geral

A atividade Get Messages chama a API ListChatMessages ou ListChannelMessages do Microsoft Graph

para recuperar todas as mensagens de um chat (ChatId) ou canal (ChannelId) e equipe (TeamID) especificados.

Após realizar a pesquisa, a atividade gera as propriedades em um objeto ChatMessage[] (Mensagem) que você pode usar como variáveis de entrada em atividades subsequentes (por exemplo, ChatMessage(0).Id em Obter Respostas de Mensagem, Responder Mensagem, etc.).

Como funciona

As etapas a seguir e o diagrama de sequência de mensagens são um exemplo de como a atividade funciona desde o tempo de design (ou seja, as dependências da atividade e as propriedades de entrada/saída) até o tempo de execução.

1. Conclua as etapas de Configuração .
2. Adicione a atividade Microsoft Teams Scope ao seu projeto.
3. Preencha uma das duas opções a seguir (A ou B):

A. Adicione uma atividade ou execute um processo externo que gere um valor Chat.Id (por exemplo, Get Chats).

B. Adicione uma atividade ou execute um processo externo que gere um valor Team.Id (por exemplo,Get Teams) E uma atividade ou processo externo que gere um valor Channel.Id (por exemplo, Get Channels).

1. Adicione a atividade Get Messages dentro da atividade Microsoft Teams Scope .
2. Insira valores para as propriedades do Canal OU Chat .
3. Crie e insira uma variável ChatMessage[] para sua propriedade Saída .

4. Execute a atividade.

   • Seus valores de propriedade de entrada são enviados para a API ListChatMessages ou ListChannelMessages .
   • A API retorna o valor ChatMessage[] para sua variável de propriedade de saída.
     
     

     

     
     

Propriedades

Os valores para as seguintes propriedades são especificados ao adicionar esta atividade ao seu projeto no UiPath Studio.

Comum

NomeDeExibição

O nome de exibição da atividade.

Atributos	Detalhes
Tipo	String
Required	Sim
Valor padrão	Get Messages
Valores permitidos	Insira uma variável String ou String .
Observações	N/A

Canal

Id da equipe

O ID do objeto Team que contém o canal do qual você quer obter mensagens.

Atributos	Detalhes
Tipo	String
Required	Sim (se ChatId estiver vazio)
Valor padrão	Vazio
Valores permitidos	Insira uma variável String ou String .
Observações	Para obter o valor Team.Id , use um processo ou atividade externa que inclua o valor Team.Id em sua saída (por exemplo, Get Teams ou chamada de API externa) (ChatId) ou (TeamId e ChannelId) são obrigatórios.

ID do canal

O ID do objeto Channel do qual você deseja obter a mensagem.

Atributos	Detalhes
Tipo	String
Required	Sim (se TeamId tiver um valor)
Valor padrão	Vazio
Valores permitidos	Insira uma variável String ou String .
Observações	Para obter o valor Channel.Id , use um processo ou atividade externa que inclua o valor Channel.Id em sua saída (por exemplo, Get Channels ou chamada de API externa) (ChatId) ou (TeamId e ChannelId) são obrigatórios.

Chat

ChatId

O ID do objeto Chat do qual você deseja obter as mensagens.

Atributos	Detalhes
Tipo	String
Required	Sim (se TeamId e ChannelId estiverem vazios)
Valor padrão	Vazio
Valores permitidos	Insira uma variável String ou String .
Observações	Para obter o valor Chat.Id , use um processo ou atividade externa que inclua o valor Chat.Id em sua saída (por exemplo, Get Chats ou chamada de API externa) (ChatId) ou (TeamId e ChannelId) são obrigatórios.

Opções

Limite

O número máximo de mensagens recentes a serem recuperadas.

Atributos	Detalhes
Tipo	Int32
Required	Sim
Valor padrão	Vazio
Valores permitidos	Insira uma variável Int32 ou Int32 .
Observações	N/A

Diversos

Particular

Se selecionado, os valores das variáveis e argumentos não são mais registrados no nível Verbose.

Atributos	Detalhes
Tipo	Caixa de seleção
Required	Não
Valor padrão	não selecionado
Valores permitidos	Selecionado ou Não Selecionado
Observações	N/A

Saída

Mensagens

Uma matriz de mensagens (objeto ChatMessage[] ) de um chat ou canal especificado.

Atributos	Detalhes
Tipo	ChatMessage[]
Required	Não (necessário se você planejar usar os dados de saída em atividades subsequentes)
Valor padrão	Vazio
Valores permitidos	Insira uma variável ChatMessage[] .
Observações	A variável que você criar para essa propriedade pode ser usada como variável de entrada em atividades subsequentes (por exemplo, ChatMessage(0).Id em Obter respostas de mensagem, Responder à mensagem etc.). * Ao usar essa variável como um valor da propriedade de entrada, especifique o item na matriz que você deseja usar (por exemplo, myMessages(0)). O objeto ChatMessage inclui várias propriedades que você pode usar em outras atividades. A imagem de exemplo abaixo mostra algumas das propriedades que você pode retornar. Observação - algumas propriedades listadas no designer não são aplicáveis ao objeto ChatMessage (por exemplo, ODatatType). Para obter uma lista das propriedades Team aplicáveis, visite os links acima.

Exemplo

A imagem a seguir mostra um exemplo do relacionamento de dependência de atividade e valores de propriedade de entrada/saída.

Para obter instruções passo a passo e exemplos, consulte os guias de início rápido .