Search Events

UiPath.MicrosoftOffice365.Activities.Calendar.SearchEvents

Description

Usa a API de eventos do Microsoft Graph List para recuperar os eventos correspondentes do calendário especificado (Calendar). Se a propriedade Calendário for deixada em branco, a atividade pesquisará eventos em seu calendário padrão.

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 e-mail com o qual interagir. Isso pode incluir qualquer caixa de correio compartilhada à qual o usuário atual tenha direitos de acesso. Se deixado em branco, a conta do usuário atual será assumida. Esta propriedade oferece suporte a variáveis String e valores formatados em string.
  Observação: O campoConta é obrigatório para o tipo de autenticação ApplicationIdAndSecret .
• 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 inserir um valor, use uma variável de propriedade de saída da atividade Get Calendars (Calendário ou Calendário Padrão). 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. Este campo aceita valores booleanos.

Opções

• Data final - A data final dos eventos que você deseja pesquisar. Quando especificado, a busca retorna apenas eventos ocorridos antes desta data (eventos ocorridos nesta data não são buscados). Este campo suporta apenas DateTime variáveis. Seu valor DateTime deve ser formatado como MM/DD/AAAA (por exemplo, 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 - A quantidade máxima de eventos que você deseja que sejam retornados em seus resultados de pesquisa. Este campo suporta apenas variáveis inteiras e Int32 . O valor padrão é 50.
• Retorno recorrente - Se selecionado, os eventos em uma série também são retornados. Este campo oferece suporte a valores booleanos.
• Consulta de pesquisa - Se fornecida, apenas os eventos cujo assunto, corpo, locais ou participantes contenham essa string serão retornados. Insira seu String usando os parâmetros de consulta OData ou insira o título do evento (por exemplo, "Office365-Quickstart").
• Data de Início - A data de início dos eventos que você deseja pesquisar. Quando especificado, a pesquisa retorna apenas eventos que ocorrem após esta data (eventos que ocorrem nesta data não são pesquisados). Este campo é compatível apenas com variáveis DateTime. Seu valor DateTime deve ser formatado como DD/MM/AAAA (por exemplo, 30/10/2019).

Saída

• Eventos - Uma matriz de eventos (objetosEvent ) 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ê criar para essa propriedade pode ser usada como variável de entrada em outras atividades, como Modify Event, Add Locationetc. 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. Adicione a atividade Search Events dentro da atividade Microsoft Office 365 Scope.
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.