Office.SeriesTime interface

Paket:
outlook

Das SeriesTime Objekt stellt Methoden zum Abrufen und Festlegen der Datums- und Uhrzeitangaben von Terminen in einer Besprechungsserie sowie zum Abrufen der Datums- und Uhrzeitangaben von Besprechungsanfragen in einer Besprechungsserie bereit.

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

Verwendet von

Beispiele

// 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 = {
  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 as any, (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)}`);
});

Methoden

getDuration()

Ruft die Dauer einer üblichen Instance in einer Terminserie in Minuten ab.
getEndDate()

Ruft das Enddatum eines Serienmusters im folgenden ISO 8601-Datumsformat ab: "JJJJ-MM-TT".
getEndTime()

Ruft die Endzeit einer üblichen Termin- oder Besprechungsanfrage-Instance eines Serienmusters ab, unabhängig von der Zeitzone, in der der Benutzer oder das Add-In das Serienmuster mit dem folgenden ISO 8601-Format festgelegt hat: "THH:mm:ss:mmm".
getStartDate()

Ruft das Startdatum eines Serienmusters im folgenden ISO 8601-Datumsformat ab: "JJJJ-MM-TT".
getStartTime()

Ruft die Startzeit einer üblichen Termin-instance eines Serienmusters ab, in welcher Zeitzone der Benutzer/das Add-In das Serienmuster mit dem folgenden ISO 8601-Format festgelegt hat: "THH:mm:ss:mmm".
setDuration(minutes)

Legt die Dauer aller Termine in einem Serienmuster fest. Dadurch ändert sich auch die Endzeit des Serienmusters.
setEndDate(year, month, day)

Legt das Enddatum einer Terminserie fest.
setEndDate(date)

Legt das Enddatum einer Terminserie fest.
setStartDate(year, month, day)

Legt das Startdatum einer Terminserie fest.
setStartDate(date)

Legt das Startdatum einer Terminserie fest.
setStartTime(hours, minutes)

Legt die Startzeit aller Instanzen einer Terminserie in der Zeitzone fest, für die das Muster der Serie festgelegt ist (standardmäßig wird die Zeitzone des Elements verwendet).
setStartTime(time)

Legt die Startzeit aller Instanzen einer Terminserie in der Zeitzone fest, für die das Muster der Serie festgelegt ist (standardmäßig wird die Zeitzone des Elements verwendet).

Details zur Methode

getDuration()

Ruft die Dauer einer üblichen Instance in einer Terminserie in Minuten ab.

getDuration(): number;

Gibt zurück

number

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

Beispiele

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

Ruft das Enddatum eines Serienmusters im folgenden ISO 8601-Datumsformat ab: "JJJJ-MM-TT".

getEndDate(): string;

Gibt zurück

string

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

Beispiele

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

Ruft die Endzeit einer üblichen Termin- oder Besprechungsanfrage-Instance eines Serienmusters ab, unabhängig von der Zeitzone, in der der Benutzer oder das Add-In das Serienmuster mit dem folgenden ISO 8601-Format festgelegt hat: "THH:mm:ss:mmm".

getEndTime(): string;

Gibt zurück

string

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

Beispiele

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

Ruft das Startdatum eines Serienmusters im folgenden ISO 8601-Datumsformat ab: "JJJJ-MM-TT".

getStartDate(): string;

Gibt zurück

string

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

Beispiele

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

Ruft die Startzeit einer üblichen Termin-instance eines Serienmusters ab, in welcher Zeitzone der Benutzer/das Add-In das Serienmuster mit dem folgenden ISO 8601-Format festgelegt hat: "THH:mm:ss:mmm".

getStartTime(): string;

Gibt zurück

string

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

Beispiele

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

setDuration(minutes)

Legt die Dauer aller Termine in einem Serienmuster fest. Dadurch ändert sich auch die Endzeit des Serienmusters.

setDuration(minutes: number): void;

Parameter

minutes

number

Die Dauer des Termins in Minuten.

Gibt zurück

void

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Beispiele

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

Legt das Enddatum einer Terminserie fest.

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

Parameter

year

number

Der Jahreswert des Enddatums.

month

number

Der Monatswert des Enddatums. Gültiger Bereich ist 0-11, wobei 0 für den 1. Monat und 11 für den 12. Monat steht.

day

number

Der Tageswert des Enddatums.

Gibt zurück

void

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Beispiele

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

Legt das Enddatum einer Terminserie fest.

setEndDate(date: string): void;

Parameter

date

string

Enddatum der Terminserienserie im ISO 8601-Datumsformat : "JJJJ-MM-TT".

Gibt zurück

void

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Beispiele

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

Legt das Startdatum einer Terminserie fest.

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

Parameter

year

number

Der Jahreswert des Startdatums.

month

number

Der Monatswert des Startdatums. Gültiger Bereich ist 0-11, wobei 0 für den 1. Monat und 11 für den 12. Monat steht.

day

number

Der Tageswert des Startdatums.

Gibt zurück

void

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Beispiele

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

Legt das Startdatum einer Terminserie fest.

setStartDate(date:string): void;

Parameter

date

string

Startdatum der Terminserienserie im ISO 8601-Datumsformat : "JJJJ-MM-TT".

Gibt zurück

void

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Beispiele

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

Legt die Startzeit aller Instanzen einer Terminserie in der Zeitzone fest, für die das Muster der Serie festgelegt ist (standardmäßig wird die Zeitzone des Elements verwendet).

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

Parameter

hours

number

Der Stundenwert der Startzeit. Gültiger Bereich: 0-24.

minutes

number

Der Minutenwert der Startzeit. Gültiger Bereich: 0-59.

Gibt zurück

void

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Beispiele

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

Legt die Startzeit aller Instanzen einer Terminserie in der Zeitzone fest, für die das Muster der Serie festgelegt ist (standardmäßig wird die Zeitzone des Elements verwendet).

setStartTime(time: string): void;

Parameter

time

string

Startzeit aller Instanzen, dargestellt durch das standardmäßige datetime-Zeichenfolgenformat: "THH:mm:ss:mmm".

Gibt zurück

void

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Beispiele

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