Office.SeriesTime interface

  • Referencia
Paquete:
outlook

El SeriesTime objeto proporciona métodos para obtener y establecer las fechas y horas de las citas en una serie periódica y obtener las fechas y horas de las convocatorias de reunión en una serie periódica.

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción o lectura

Métodos

getDuration()

Obtiene la duración en minutos de una instancia habitual de una serie de citas periódicas.
getEndDate()

Obtiene la fecha de finalización de un patrón de periodicidad con el siguiente formato de fecha ISO 8601 : "AAAA-MM-DD".
getEndTime()

Obtiene la hora de finalización de una cita habitual o una instancia de convocatoria de reunión de un patrón de periodicidad en cualquier zona horaria en la que el usuario o el complemento establezcan el patrón de periodicidad con el siguiente formato ISO 8601 : "THH:mm:ss:mmm".
getStartDate()

Obtiene la fecha de inicio de un patrón de periodicidad con el siguiente formato de fecha ISO 8601 : "AAAA-MM-DD".
getStartTime()

Obtiene la hora de inicio de una instancia de cita habitual de un patrón de periodicidad en cualquier zona horaria en la que el usuario o el complemento establezcan el patrón de periodicidad con el siguiente formato ISO 8601 : "THH:mm:ss:mmm".
setDuration(minutes)

Establece la duración de todas las citas en un patrón de periodicidad. Esto también cambiará la hora de finalización del patrón de periodicidad.
setEndDate(year, month, day)

Establece la fecha de finalización de una serie de citas periódicas.
setEndDate(date)

Establece la fecha de finalización de una serie de citas periódicas.
setStartDate(year, month, day)

Establece la fecha de inicio de una serie de citas periódicas.
setStartDate(date)

Establece la fecha de inicio de una serie de citas periódicas.
setStartTime(hours, minutes)

Establece la hora de inicio de todas las instancias de una serie de citas periódicas en la zona horaria en la que se establece el patrón de periodicidad (la zona horaria del elemento se usa de forma predeterminada).
setStartTime(time)

Establece la hora de inicio de todas las instancias de una serie de citas periódicas en la zona horaria en la que se establece el patrón de periodicidad (la zona horaria del elemento se usa de forma predeterminada).

Detalles del método

getDuration()

Obtiene la duración en minutos de una instancia habitual de una serie de citas periódicas.

getDuration(): number;

Devoluciones

number

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción o lectura

Ejemplos

// 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()

Obtiene la fecha de finalización de un patrón de periodicidad con el siguiente formato de fecha ISO 8601 : "AAAA-MM-DD".

getEndDate(): string;

Devoluciones

string

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción o lectura

Ejemplos

// 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()

Obtiene la hora de finalización de una cita habitual o una instancia de convocatoria de reunión de un patrón de periodicidad en cualquier zona horaria en la que el usuario o el complemento establezcan el patrón de periodicidad con el siguiente formato ISO 8601 : "THH:mm:ss:mmm".

getEndTime(): string;

Devoluciones

string

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción o lectura

Ejemplos

// 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()

Obtiene la fecha de inicio de un patrón de periodicidad con el siguiente formato de fecha ISO 8601 : "AAAA-MM-DD".

getStartDate(): string;

Devoluciones

string

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción o lectura

Ejemplos

// 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()

Obtiene la hora de inicio de una instancia de cita habitual de un patrón de periodicidad en cualquier zona horaria en la que el usuario o el complemento establezcan el patrón de periodicidad con el siguiente formato ISO 8601 : "THH:mm:ss:mmm".

getStartTime(): string;

Devoluciones

string

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción o lectura

Ejemplos

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

setDuration(minutes)

Establece la duración de todas las citas en un patrón de periodicidad. Esto también cambiará la hora de finalización del patrón de periodicidad.

setDuration(minutes: number): void;

Parámetros

minutes

number

La duración de la cita en minutos.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Redacción

Ejemplos

// 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)

Establece la fecha de finalización de una serie de citas periódicas.

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

Parámetros

year

number

Valor del año de la fecha de finalización.

month

number

Valor del mes de la fecha de finalización. El intervalo válido es 0-11, donde 0 representa el primer mes y 11 representa el mes 12.

day

number

Valor de día de la fecha de finalización.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Redacción

Ejemplos

// 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)

Establece la fecha de finalización de una serie de citas periódicas.

setEndDate(date: string): void;

Parámetros

date

string

Fecha de finalización de la serie de citas periódicas representada en el formato de fecha ISO 8601 : "AAAA-MM-DD".

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Redacción

Ejemplos

// 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)

Establece la fecha de inicio de una serie de citas periódicas.

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

Parámetros

year

number

Valor del año de la fecha de inicio.

month

number

Valor del mes de la fecha de inicio. El intervalo válido es 0-11, donde 0 representa el primer mes y 11 representa el mes 12.

day

number

Valor de día de la fecha de inicio.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Redacción

Ejemplos

// 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)

Establece la fecha de inicio de una serie de citas periódicas.

setStartDate(date:string): void;

Parámetros

date

string

Fecha de inicio de la serie de citas periódicas representada en el formato de fecha ISO 8601 : "AAAA-MM-DD".

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Redacción

Ejemplos

// 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)

Establece la hora de inicio de todas las instancias de una serie de citas periódicas en la zona horaria en la que se establece el patrón de periodicidad (la zona horaria del elemento se usa de forma predeterminada).

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

Parámetros

hours

number

Valor de hora de la hora de inicio. Intervalo válido: 0-24.

minutes

number

Valor de minuto de la hora de inicio. Intervalo válido: 0-59.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Redacción

Ejemplos

// 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)

Establece la hora de inicio de todas las instancias de una serie de citas periódicas en la zona horaria en la que se establece el patrón de periodicidad (la zona horaria del elemento se usa de forma predeterminada).

setStartTime(time: string): void;

Parámetros

time

string

Hora de inicio de todas las instancias representadas por el formato de cadena datetime estándar: "THH:mm:ss:mmm".

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Redacción

Ejemplos

// 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");