Search Events

UiPath.MicrosoftOffice365.Activities.Calendar.SearchEvents

Description

Usa a API de lista de eventos do Microsoft Graph para recuperar os eventos correspondentes do calendário especificado (Calendar). Se a propriedade Calendário for deixada vazia, a atividade pesquisa seu calendário padrão por eventos.

Após realizar a pesquisa, a atividade retorna os objetos Event[] correspondentes (Eventos) que você pode usar como variável de entrada em atividades subsequentes (Modificar evento, Adicionar local, etc.).

Escopos

Essa atividade requer os seguintes escopos:

• Calendários.ReadWrite

OU

• Calendars.ReadWrite.Shared

Compatibilidade do projeto

Windows - Legado | Windows

Configuração

Propriedades

Comum

• NomeDeExibição — o nome de exibição da atividade. Essa propriedade é compatível com variáveis String e valores formatados de string.

Entrada

• Conta — (opcional) o endereço de email com o qual interagir. Isso pode incluir qualquer caixa de correio compartilhada à qual o usuário atual tenha direito de acesso. Se deixado em branco, a conta atual do usuário será utilizada. Essa propriedade é compatível com variáveis String e valores formatados de string.

  Observação:

  Account field is mandatory for ApplicationIdAndSecret authentication type.

• Calendário — o calendário no qual pesquisar. Isso pode ser recuperado usando a atividade Get Calendars . Se você não fornecer um valor, seu calendário padrão será usado. Este campo é compatível apenas com variáveis Calendar . Se estiver inserindo um valor, use uma variável de propriedade de saída da atividade Get Calendars (Calendar ou Default Calendar). Se você estiver usando a variável de propriedade de saída Calendário , especifique o item na matriz que você deseja usar (por exemplo, myCalendar(0)).

Diversos

• Particular — se selecionada, os valores de variáveis e argumentos não são mais registrados no nível Verbose. Esse campo aceita valores Booleanos.

Opções

• End Date - The end date of the events that you want to search. When specified, the search only returns events that occur before this date (events occurring on this date are not searched). This field supports only DateTime variables. Your DateTime value must be formatted as MM/DD/YYYY (e.g., 11/01/2019).
• ID do Evento - A ID do evento a ser procurado. Quando especificado, o parâmetro Conta é levado em consideração enquanto os outros parâmetros de filtro na categoria Opções são ignorados. Se o evento com a ID especificada for localizado, a matriz de saída contém exatamente um elemento. Se não for encontrado, a atividade lançará uma exceção. Essa propriedade é compatível com variáveis String e valores formatados de string.
• Max Results - The maximum amount of events that you want to be returned in your search results. This field supports only integer and Int32 variables. The default value is 50.
• Retornar Recorrente — se selecionado, eventos de uma série também serão retornados. Esse campo aceita valores Booleanos.
• Consulta de pesquisa — se fornecida, somente eventos cujo assunto, corpo, locais ou participantes contenham essa string serão retornados. Insira seu String usando os parâmetros de consulta do OData ou insira o título do evento (por exemplo, "Office365-Quickstart").
• Start Date - The start date of the events that you want to search. When specified, the search only returns events that occur after this date (events occurring on this date are not searched). This field supports only DateTime variables. Your DateTime value must be formatted as MM/DD/YYYY (e.g., 10/30/2019).

Saída

• Eventos - Uma matriz de eventos (objetos Event ) que correspondem ao seu valor da ConsultaDePesquisa . Este campo é compatível apenas com variáveis Event[] . Obrigatório se você planeja usar os dados de saída em atividades subsequentes. A variável que você cria para essa propriedade pode ser usada como uma variável de entrada em outras atividades, como Modificar Evento, Adicionar local, etc. Ao usar essa variável como um valor da propriedade de entrada, certifique-se de especificar o item na matriz que você deseja usar (por exemplo, myEvents(0)). O objeto Event inclui várias propriedades que você pode usar em outras atividades; nem todas as propriedades são compatíveis. A propriedade Body.Content é retornada apenas no formato HTML.

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.
2. Adicione a atividade Microsoft Office 365 Scope ao seu projeto.
3. (Opcional) Adicione uma atividade ou execute um processo externo que gere um objeto Calendar (por exemplo, Get Calendars).
4. Add the Search Events activity inside the Microsoft Office 365 Scope activity.
5. Insira valores para as propriedades de entrada.
6. Crie e insira uma variável Event[] para a propriedade Saída.
7. Execute a atividade.
   • Seus valores de propriedade de entrada são enviados para a API ListEvents .
   • A API retorna o valor Event[] para sua variável de propriedade de saída.