Office.SeriesTime interface

  • Referência
Pacote:
outlook

O SeriesTime objeto fornece métodos para obter e definir as datas e horários dos compromissos em uma série recorrente e obter as datas e horários das solicitações de reunião em uma série recorrente.

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

Métodos

getDuration()

Obtém a duração em minutos de uma instância usual em uma série de compromissos recorrentes.
getEndDate()

Obtém a data de término de um padrão de recorrência no seguinte formato de data ISO 8601 : "YYYYY-MM-DD".
getEndTime()

Obtém a hora final de uma instância de solicitação de compromisso ou de reunião usual de um padrão de recorrência em qualquer fuso horário que o usuário ou suplemento definir o padrão de recorrência usando o seguinte formato ISO 8601 : "THH:mm:ss:mmm".
getStartDate()

Obtém a data de início de um padrão de recorrência no seguinte formato de data ISO 8601 : "YYYYY-MM-DD".
getStartTime()

Obtém a hora de início de uma instância de compromisso usual de um padrão de recorrência em qualquer fuso horário que o usuário/suplemento definir o padrão de recorrência usando o seguinte formato ISO 8601 : "THH:mm:ss:mmm".
setDuration(minutes)

Define a duração de todos os compromissos em um padrão de recorrência. Isso também alterará a hora final do padrão de recorrência.
setEndDate(year, month, day)

Define a data de término de uma série de compromissos recorrentes.
setEndDate(date)

Define a data de término de uma série de compromissos recorrentes.
setStartDate(year, month, day)

Define a data de início de uma série de compromissos recorrentes.
setStartDate(date)

Define a data de início de uma série de compromissos recorrentes.
setStartTime(hours, minutes)

Define a hora de início de todas as instâncias de uma série de compromissos recorrentes em qualquer fuso horário que o padrão de recorrência for definido (o fuso horário do item é usado por padrão).
setStartTime(time)

Define a hora de início de todas as instâncias de uma série de compromissos recorrentes em qualquer fuso horário que o padrão de recorrência for definido (o fuso horário do item é usado por padrão).

Detalhes do método

getDuration()

Obtém a duração em minutos de uma instância usual em uma série de compromissos recorrentes.

getDuration(): number;

Retornos

number

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

// This example gets the duration of a usual instance in a recurring appointment series.
Office.context.mailbox.item.recurrence.getAsync(callback);

function callback(asyncResult) {
    const context = asyncResult.context;
    const recurrence = asyncResult.value;
    const duration = recurrence.seriesTime.getDuration();
}

getEndDate()

Obtém a data de término de um padrão de recorrência no seguinte formato de data ISO 8601 : "YYYYY-MM-DD".

getEndDate(): string;

Retornos

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

Exemplos

// This example gets the end date of a recurring appointment series.
Office.context.mailbox.item.recurrence.getAsync(callback);

function callback(asyncResult) {
    const context = asyncResult.context;
    const recurrence = asyncResult.value;
    const endDate = recurrence.seriesTime.getEndDate();
}

getEndTime()

Obtém a hora final de uma instância de solicitação de compromisso ou de reunião usual de um padrão de recorrência em qualquer fuso horário que o usuário ou suplemento definir o padrão de recorrência usando o seguinte formato ISO 8601 : "THH:mm:ss:mmm".

getEndTime(): string;

Retornos

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

Exemplos

// This example gets the end time of a usual instance in a recurring appointment series.
Office.context.mailbox.item.recurrence.getAsync(callback);

function callback(asyncResult) {
    const context = asyncResult.context;
    const recurrence = asyncResult.value;
    const endDate = recurrence.seriesTime.getEndTime();
}

getStartDate()

Obtém a data de início de um padrão de recorrência no seguinte formato de data ISO 8601 : "YYYYY-MM-DD".

getStartDate(): string;

Retornos

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

Exemplos

// This example gets the start date of a recurring appointment series.
Office.context.mailbox.item.recurrence.getAsync(callback);

function callback(asyncResult) {
    const context = asyncResult.context;
    const recurrence = asyncResult.value;
    const endDate = recurrence.seriesTime.getStartDate();
}

getStartTime()

Obtém a hora de início de uma instância de compromisso usual de um padrão de recorrência em qualquer fuso horário que o usuário/suplemento definir o padrão de recorrência usando o seguinte formato ISO 8601 : "THH:mm:ss:mmm".

getStartTime(): string;

Retornos

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

Exemplos

// This example gets the start time of a usual
// instance in a recurring appointment series.
const seriesTimeObject = new SeriesTime();
seriesTimeObject.setDuration(120);

setDuration(minutes)

Define a duração de todos os compromissos em um padrão de recorrência. Isso também alterará a hora final do padrão de recorrência.

setDuration(minutes: number): void;

Parâmetros

minutes

number

A duração do compromisso em minutos.

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

Exemplos

// This example sets the duration of each appointment
// in a recurring series to 2 hours.
Office.context.mailbox.item.recurrence.getAsync(callback);

function callback(asyncResult) {
    const context = asyncResult.context;
    const recurrence = asyncResult.value;
    const endDate = recurrence.seriesTime.getStartTime();
}

setEndDate(year, month, day)

Define a data de término de uma série de compromissos recorrentes.

setEndDate(year: number, month: number, day: number): void;

Parâmetros

year

number

O valor do ano da data de término.

month

number

O valor do mês da data de término. O intervalo válido é de 0 a 11, onde 0 representa o 1º mês e 11 representa o 12º mês.

day

number

O valor do dia da data de término.

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

Exemplos

// This example sets the end date of a recurring
// appointment series to November 2, 2017.
const seriesTimeObject = new SeriesTime();
seriesTimeObject.setEndDate(2017, 10, 2);

setEndDate(date)

Define a data de término de uma série de compromissos recorrentes.

setEndDate(date: string): void;

Parâmetros

date

string

Data de término da série de compromissos recorrente representada no formato de data ISO 8601 : "YYYYY-MM-DD".

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

Exemplos

// This example sets the end date of a
// recurring appointment series to November 2, 2017
// using ISO 8601 date standard.
const seriesTimeObject = new SeriesTime()
seriesTimeObject.setEndDate("2017-11-02");

setStartDate(year, month, day)

Define a data de início de uma série de compromissos recorrentes.

setStartDate(year:number, month:number, day:number): void;

Parâmetros

year

number

O valor do ano da data de início.

month

number

O valor do mês da data de início. O intervalo válido é de 0 a 11, onde 0 representa o 1º mês e 11 representa o 12º mês.

day

number

O valor do dia da data de início.

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

Exemplos

// This example sets the start date of a recurring
// appointment series to November 2, 2017.
const seriesTimeObject = new SeriesTime();
seriesTimeObject.setStartDate(2017, 10, 2);

setStartDate(date)

Define a data de início de uma série de compromissos recorrentes.

setStartDate(date:string): void;

Parâmetros

date

string

Data de início da série de compromissos recorrente representada no formato de data ISO 8601 : "YYYYY-MM-DD".

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

Exemplos

// This example sets the start date of a recurring
// appointment series to November 2, 2017
// using ISO 8601 date standard.
const seriesTimeObject = new SeriesTime()
seriesTimeObject.setStartDate("2017-11-02");

setStartTime(hours, minutes)

Define a hora de início de todas as instâncias de uma série de compromissos recorrentes em qualquer fuso horário que o padrão de recorrência for definido (o fuso horário do item é usado por padrão).

setStartTime(hours: number, minutes: number): void;

Parâmetros

hours

number

O valor da hora da hora de início. Intervalo válido: 0 a 24.

minutes

number

O valor de minuto da hora de início. Intervalo válido: 0 a 59.

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

Exemplos

// This example sets the start time of each instance
// of a recurring appointment series to 1:30 PM.
const seriesTimeObject = new SeriesTime();
seriesTimeObject.setStartTime(13, 30);

// This example sets the start time of each instance
// of a recurring appointment series to 11:30 AM.
seriesTimeObject.setStartTime(11, 30);

setStartTime(time)

Define a hora de início de todas as instâncias de uma série de compromissos recorrentes em qualquer fuso horário que o padrão de recorrência for definido (o fuso horário do item é usado por padrão).

setStartTime(time: string): void;

Parâmetros

time

string

Hora de início de todas as instâncias representadas pelo formato de cadeia de caracteres datetime padrão: "THH:mm:ss:mmm".

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

Exemplos

// This example sets the start time of each instance
// of a recurring appointment series to 11:30 PM.
const seriesTimeObject = new SeriesTime()
seriesTimeObject.setStartTime("T23:30:00");