Office.Recurrence interface

  • Referência
Pacote:
outlook

O Recurrence objeto fornece métodos para obter e definir o padrão de recorrência de compromissos, mas apenas obter o padrão de recorrência de solicitações de reunião. Ele terá um dicionário com as seguintes chaves: seriesTime, recurrenceType, recurrencePropertiese recurrenceTimeZone (opcional).

Comentários

[ Conjunto de API: Caixa de correio 1.7 ]

Nível mínimo de permissão: item de leitura

Modo outlook aplicável: compor ou ler

Estados

Estado Editável? Visível?
Organizador de Compromissos – Série de composição Sim (setAsync) Sim (getAsync)
Organizador de Compromissos – Instância de Composição Não (setAsync retorna erro) Sim (getAsync)
Participante de compromisso – Série de leitura Não (setAsync não disponível) Sim (item.recorrência)
Participante de compromisso – Instância de leitura Não (setAsync não disponível) Sim (item.recorrência)
Solicitação de Reunião – Série de leitura Não (setAsync não disponível) Sim (item.recorrência)
Solicitação de Reunião – Instância de Leitura Não (setAsync não disponível) Sim (item.recorrência)

Propriedades

recurrenceProperties

Obtém ou define as propriedades da série de compromissos recorrentes.
recurrenceTimeZone

Obtém ou define as propriedades da série de compromissos recorrentes.
recurrenceType

Obtém ou define o tipo da série de compromissos recorrentes.
seriesTime

O objeto SeriesTime permite que você gerencie as datas de início e término da série de compromissos recorrentes e os horários de início e término habituais das instâncias. Esse objeto não está em tempo UTC. Em vez disso, ele é definido no fuso horário especificado pelo recurrenceTimeZone valor ou padrão para o fuso horário do item.

Métodos

getAsync(options, callback)

Retorna o objeto de recorrência atual de uma série de compromissos.

Esse método retorna todo Recurrence o objeto para a série de compromissos.
getAsync(callback)

Retorna o objeto de recorrência atual de uma série de compromissos.

Esse método retorna todo Recurrence o objeto para a série de compromissos.
setAsync(recurrencePattern, options, callback)

Define o padrão de recorrência de uma série de compromissos.

Observação: setAsync só deve estar disponível para itens de série e não para itens de instância.
setAsync(recurrencePattern, callback)

Define o padrão de recorrência de uma série de compromissos.

Observação: setAsync só deve estar disponível para itens de série e não para itens de instância.

Detalhes da propriedade

recurrenceProperties

Obtém ou define as propriedades da série de compromissos recorrentes.

recurrenceProperties?: RecurrenceProperties;

Valor da propriedade

Office.RecurrenceProperties

Comentários

[ Conjunto de API: Caixa de correio 1.7 ]

Nível mínimo de permissão: item de leitura

Modo outlook aplicável: compor ou ler

recurrenceTimeZone

Obtém ou define as propriedades da série de compromissos recorrentes.

recurrenceTimeZone?: RecurrenceTimeZone;

Valor da propriedade

Office.RecurrenceTimeZone

Comentários

[ Conjunto de API: Caixa de correio 1.7 ]

Nível mínimo de permissão: item de leitura

Modo outlook aplicável: compor ou ler

recurrenceType

Obtém ou define o tipo da série de compromissos recorrentes.

recurrenceType: MailboxEnums.RecurrenceType | string;

Valor da propriedade

Office.MailboxEnums.RecurrenceType | string

Comentários

[ Conjunto de API: Caixa de correio 1.7 ]

Nível mínimo de permissão: item de leitura

Modo outlook aplicável: compor ou ler

seriesTime

O objeto SeriesTime permite que você gerencie as datas de início e término da série de compromissos recorrentes e os horários de início e término habituais das instâncias. Esse objeto não está em tempo UTC. Em vez disso, ele é definido no fuso horário especificado pelo recurrenceTimeZone valor ou padrão para o fuso horário do item.

seriesTime: SeriesTime;

Valor da propriedade

Office.SeriesTime

Comentários

[ Conjunto de API: Caixa de correio 1.7 ]

Nível mínimo de permissão: item de leitura

Modo outlook aplicável: compor ou ler

Detalhes do método

getAsync(options, callback)

Retorna o objeto de recorrência atual de uma série de compromissos.

Esse método retorna todo Recurrence o objeto para a série de compromissos.

getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<Recurrence>) => void): void;

Parâmetros

options
Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades:- asyncContext: Os desenvolvedores podem fornecer qualquer objeto que desejam acessar na função de retorno de chamada.

callback

(asyncResult: Office.AsyncResult<Office.Recurrence>) => void

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto. A value propriedade do resultado é um Recurrence objeto.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.7 ]

Nível mínimo de permissão: item de leitura

Modo outlook aplicável: compor ou ler

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/50-recurrence/get-set-recurrence-appointment-organizer.yaml

Office.context.mailbox.item.recurrence.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const recurrence = asyncResult.value;
    if (recurrence === null) {
      console.log("This is a single appointment.");
    } else {
      console.log(`Recurrence pattern: ${JSON.stringify(recurrence)}`);
    }
  } else {
    console.error(asyncResult.error);
  }
});

getAsync(callback)

Retorna o objeto de recorrência atual de uma série de compromissos.

Esse método retorna todo Recurrence o objeto para a série de compromissos.

getAsync(callback?: (asyncResult: Office.AsyncResult<Recurrence>) => void): void;

Parâmetros

callback

(asyncResult: Office.AsyncResult<Office.Recurrence>) => void

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto. A value propriedade do resultado é um Recurrence objeto.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.7 ]

Nível mínimo de permissão: item de leitura

Modo outlook aplicável: compor ou ler

setAsync(recurrencePattern, options, callback)

Define o padrão de recorrência de uma série de compromissos.

Observação: setAsync só deve estar disponível para itens de série e não para itens de instância.

setAsync(recurrencePattern: Recurrence, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

recurrencePattern
Office.Recurrence

Um objeto de recorrência.

options
Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades:- asyncContext: Os desenvolvedores podem fornecer qualquer objeto que desejam acessar na função de retorno de chamada.

callback

(asyncResult: Office.AsyncResult<void>) => void

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.7 ]

Nível mínimo de permissão: item de leitura/gravação

Modo outlook aplicável: compose

Erros:

  • InvalidEndTime: a hora de término do compromisso é antes da hora de início.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/50-recurrence/get-set-recurrence-appointment-organizer.yaml

// Important: Can only set the recurrence pattern of an appointment series.

const currentDate = new Date();
let seriesTimeObject: Office.SeriesTime;
// Set series start date to tomorrow.
seriesTimeObject.setStartDate(currentDate.getFullYear(), currentDate.getMonth(), currentDate.getDay() + 1);
// Set series end date to one year from now.
seriesTimeObject.setEndDate(currentDate.getFullYear() + 1, currentDate.getMonth() + 1, currentDate.getDay());
// Set start time to 1:30 PM.
seriesTimeObject.setStartTime(13, 30);
// Set duration to 30 minutes.
seriesTimeObject.setDuration(30);

const pattern: Office.Recurrence = {
  seriesTime: seriesTimeObject,
  recurrenceType: Office.MailboxEnums.RecurrenceType.Yearly,
  recurrenceProperties: {
    interval: 1,
    dayOfWeek: Office.MailboxEnums.Days.Tue,
    weekNumber: Office.MailboxEnums.WeekNumber.Second,
    month: Office.MailboxEnums.Month.Sep
  },
  recurrenceTimeZone: { name: Office.MailboxEnums.RecurrenceTimeZone.PacificStandardTime }
};

Office.context.mailbox.item.recurrence.setAsync(pattern, (asyncResult) => {
  if (asyncResult.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Failed to set recurrence. Error: ${asyncResult.error.message}`);
    return;
  }
  console.log(`Succeeded in setting recurrence pattern ${JSON.stringify(pattern)}`);
});

setAsync(recurrencePattern, callback)

Define o padrão de recorrência de uma série de compromissos.

Observação: setAsync só deve estar disponível para itens de série e não para itens de instância.

setAsync(recurrencePattern: Recurrence, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

recurrencePattern
Office.Recurrence

Um objeto de recorrência.

callback

(asyncResult: Office.AsyncResult<void>) => void

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.7 ]

Nível mínimo de permissão: item de leitura/gravação

Modo outlook aplicável: compose

Erros:

  • InvalidEndTime: a hora de término do compromisso é antes da hora de início.