Compartilhar via

Office.Recurrence interface

  • Referência
Pacote:
outlook

O Recurrence objeto fornece métodos para obter e definir o padrão de periodicidade dos compromissos, mas apenas obtém o padrão de periodicidade dos pedidos de reunião. 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: ler item

Modo Outlook aplicável: Compose ou Leitura

Estados

Estado Editável? Visualizável?
Organizador de Compromissos - Série Compose Sim (setAsync) Sim (getAsync)
Organizador de Compromissos - Instância do Compose Não (setAsync devolve o erro) Sim (getAsync)
Participante do Compromisso - Série de Leitura Não (setAsync não disponível) Sim (item.recurrence)
Participante do Compromisso - Instância de Leitura Não (setAsync não disponível) Sim (item.recurrence)
Pedido de Reunião - Série de Leitura Não (setAsync não disponível) Sim (item.recurrence)
Pedido de Reunião - Instância de Leitura Não (setAsync não disponível) Sim (item.recurrence)

Propriedades

recurrenceProperties

Obtém ou define as propriedades da série de compromissos periódicos.
recurrenceTimeZone

Obtém ou define as propriedades da série de compromissos periódicos.
recurrenceType

Obtém ou define o tipo de série de compromissos periódicos.
seriesTime

O objeto SeriesTime permite-lhe gerir as datas de início e de fim da série de compromissos recorrentes e as horas de início e de fim habituais das instâncias. Este objeto não está na hora UTC. Em vez disso, é definido no fuso horário especificado pelo recurrenceTimeZone valor ou predefinido para o fuso horário do item.

Métodos

getAsync(options, callback)

Devolve o objeto de periodicidade atual de uma série de compromissos.

Este método devolve o objeto completo Recurrence para a série de compromissos.
getAsync(callback)

Devolve o objeto de periodicidade atual de uma série de compromissos.

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

Define o padrão de periodicidade de uma série de compromissos.
setAsync(recurrencePattern, callback)

Define o padrão de periodicidade de uma série de compromissos.

Detalhes da propriedade

recurrenceProperties

Obtém ou define as propriedades da série de compromissos periódicos.

recurrenceProperties?: RecurrenceProperties;

Valor da propriedade

Office.RecurrenceProperties

Comentários

[ Conjunto de API: Caixa de Correio 1.7 ]

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

Modo Outlook aplicável: Compose ou Leitura

recurrenceTimeZone

Obtém ou define as propriedades da série de compromissos periódicos.

recurrenceTimeZone?: RecurrenceTimeZone;

Valor da propriedade

Office.RecurrenceTimeZone

Comentários

[ Conjunto de API: Caixa de Correio 1.7 ]

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

Modo Outlook aplicável: Compose ou Leitura

recurrenceType

Obtém ou define o tipo de série de compromissos periódicos.

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: ler item

Modo Outlook aplicável: Compose ou Leitura

seriesTime

O objeto SeriesTime permite-lhe gerir as datas de início e de fim da série de compromissos recorrentes e as horas de início e de fim habituais das instâncias. Este objeto não está na hora UTC. Em vez disso, é definido no fuso horário especificado pelo recurrenceTimeZone valor ou predefinido 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: ler item

Modo Outlook aplicável: Compose ou Leitura

Detalhes do método

getAsync(options, callback)

Devolve o objeto de periodicidade atual de uma série de compromissos.

Este método devolve o objeto completo Recurrence 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 programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.

callback

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

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro, asyncResult, que é 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: ler item

Modo Outlook aplicável: Compose ou Leitura

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)

Devolve o objeto de periodicidade atual de uma série de compromissos.

Este método devolve o objeto completo Recurrence 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 for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro, asyncResult, que é 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: ler item

Modo Outlook aplicável: Compose ou Leitura

setAsync(recurrencePattern, options, callback)

Define o padrão de periodicidade de uma série de compromissos.

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

Parâmetros

recurrencePattern
Office.Recurrence

Um objeto de periodicidade.

options
Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.

callback

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

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro, asyncResult, que é 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/escrita

Modo Outlook aplicável: Compose

Importante:

  • setAsync só está disponível para itens de série e não para itens de instância.

  • O setAsync método não é suportado numa mensagem atualmente carregada com o loadItemByIdAsync método . Para obter mais informações, consulte Ativar o seu suplemento do Outlook em várias mensagens.

Erros:

  • InvalidEndTime : a hora de fim do compromisso é anterior à 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 periodicidade de uma série de compromissos.

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

Parâmetros

recurrencePattern
Office.Recurrence

Um objeto de periodicidade.

callback

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

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro, asyncResult, que é 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/escrita

Modo Outlook aplicável: Compose

Importante:

  • setAsync só está disponível para itens de série e não para itens de instância.

  • O setAsync método não é suportado numa mensagem atualmente carregada com o loadItemByIdAsync método . Para obter mais informações, consulte Ativar o seu suplemento do Outlook em várias mensagens.

Erros:

  • InvalidEndTime : a hora de fim do compromisso é anterior à hora de início.