Office.AppointmentCompose interface
Der Terminorganisationsmodus von Office.context.mailbox.item.
Wichtig: Dies ist ein internes Outlook-Objekt, das nicht direkt über vorhandene Schnittstellen verfügbar gemacht wird. Sie sollten dies als Modus behandeln Office.context.mailbox.item. Weitere Informationen finden Sie auf der Seite Objektmodell .
Übergeordnete Schnittstellen:
- Extends
Eigenschaften
| body | Ruft ein Objekt ab, das Methoden zum Bearbeiten des Textkörpers eines Elements bereitstellt. |
| end | Ruft Datum und Zeit für das Ende des Termins ab oder legt diese fest. Die Wenn Sie die Wichtig: Im Windows-Client können Sie diese Eigenschaft nicht verwenden, um das Ende einer Serie zu aktualisieren. |
| item |
Ruft den Typ des Elements ab, das eine Instanz darstellt. Die |
| location | Ruft den Ort eines Termins ab bzw. legt ihn fest. Die |
| optional |
Bietet Zugriff auf die optionalen Teilnehmer eines Ereignisses. Der Typ des Objekts und die Zugriffsebene hängen vom Modus des aktuellen Elements ab. Die |
| required |
Bietet Zugriff auf die erforderlichen Teilnehmer eines Ereignisses. Der Typ des Objekts und die Zugriffsebene hängen vom Modus des aktuellen Elements ab. Die |
| start | Ruft Datum und Zeit für den Beginn des Termins ab oder legt Datum und Uhrzeit fest. Die Wenn Sie die Wichtig: Im Windows-Client können Sie diese Eigenschaft nicht verwenden, um den Beginn einer Wiederholung zu aktualisieren. |
| subject | Ruft die Beschreibung ab, die im Betrefffeld eines Elements angezeigt wird, oder legt sie fest. Die Die |
Methoden
| add |
Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu. Die Anschließend können Sie den Bezeichner mit der Wichtig: In den letzten Builds von Outlook unter Windows wurde ein Fehler eingeführt, der fälschlicherweise einen |
| add |
Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu. Die Anschließend können Sie den Bezeichner mit der Wichtig: In den letzten Builds von Outlook unter Windows wurde ein Fehler eingeführt, der fälschlicherweise einen |
| add |
Fügt der Nachricht oder dem Termin ein Exchange-Objekt, wie z. B. eine Nachricht, als Anhang hinzu. Die Anschließend können Sie den Bezeichner mit der Wenn Ihr Office Add-In in Outlook im Web ausgeführt wird, kann die Methode |
| add |
Fügt der Nachricht oder dem Termin ein Exchange-Objekt, wie z. B. eine Nachricht, als Anhang hinzu. Die Anschließend können Sie den Bezeichner mit der Wenn Ihr Office Add-In in Outlook im Web ausgeführt wird, kann die Methode |
| load |
Lädt asynchron benutzerdefinierte Eigenschaften für dieses Add-In für das ausgewählte Element. Benutzerdefinierte Eigenschaften werden als Schlüssel-Wert-Paare pro App und Element gespeichert. Diese Methode gibt ein CustomProperties-Objekt im Rückruf zurück, das Methoden für den Zugriff auf die benutzerdefinierten Eigenschaften bereitstellt, die für das aktuelle Element und das aktuelle Add-In spezifisch sind. Benutzerdefinierte Eigenschaften werden für das Element nicht verschlüsselt, sodass dies nicht als sicherer Speicher verwendet werden sollte. Die benutzerdefinierten Eigenschaften werden als |
| remove |
Entfernt eine Anlage aus einer Nachricht oder einem Termin. Die |
| remove |
Entfernt eine Anlage aus einer Nachricht oder einem Termin. Die |
Details zur Eigenschaft
body
Ruft ein Objekt ab, das Methoden zum Bearbeiten des Textkörpers eines Elements bereitstellt.
body: Body;Eigenschaftswert
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Terminplaner
Beispiele
// This example gets the body of the item as plain text.
Office.context.mailbox.item.body.getAsync(
"text",
{ asyncContext: "This is passed to the callback" },
function callback(result) {
// Do something with the result.
});
// The following is an example of an object that is passed as the result parameter to the callback function.
{
"value": "TEXT of whole body (including threads below)",
"status": "succeeded",
"asyncContext": "This is passed to the callback"
}
end
Ruft Datum und Zeit für das Ende des Termins ab oder legt diese fest.
Die end -Eigenschaft ist ein Time-Objekt , das als UTC-Datums- und Uhrzeitwert (Coordinated Universal Time) ausgedrückt wird. Sie können die convertToLocalClientTime -Methode verwenden, um den end Eigenschaftswert in das lokale Datum und die lokale Uhrzeit des Clients zu konvertieren.
Wenn Sie die Time.setAsync-Methode verwenden, um die Endzeit im Verfassenmodus festzulegen, sollten Sie die convertToUtcClientTime-Methode verwenden, um die Ortszeit auf dem Client für den Server in UTC umzuwandeln.
Wichtig: Im Windows-Client können Sie diese Eigenschaft nicht verwenden, um das Ende einer Serie zu aktualisieren.
end: Time;Eigenschaftswert
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Terminplaner
Beispiele
// The following example sets the end time of an appointment in compose mode by
// using the `setAsync` method of the `Time` object.
const endTime = new Date("3/14/2015");
const options = {
// Pass information that can be used in the callback.
asyncContext: {verb: "Set"}
};
Office.context.mailbox.item.end.setAsync(endTime, options, function(result) {
if (result.error) {
console.debug(result.error);
} else {
// Access the asyncContext that was passed to the setAsync method.
console.debug("End Time " + result.asyncContext.verb);
}
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-end-appointment-organizer.yaml
Office.context.mailbox.item.end.getAsync((result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Appointment ends: ${result.value}`);
});
...
Office.context.mailbox.item.start.getAsync((result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Get start date failed with message ${result.error.message}`);
return;
}
const end = result.value; // Set end to current start date and time.
end.setDate(end.getDate() + 1); // Set end as 1 day later than start date.
Office.context.mailbox.item.end.setAsync(end, (result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Set end date failed with message ${result.error.message}`);
return;
}
console.log(`Successfully set end date and time to ${end}`);
});
});
itemType
Ruft den Typ des Elements ab, das eine Instanz darstellt.
Die itemType-Eigenschaft gibt einen der Werte der ItemType-Enumeration zurück, der angibt, ob es sich bei der item-Objektinstanz um eine Nachricht oder einen Termin handelt.
itemType: MailboxEnums.ItemType | string;Eigenschaftswert
Office.MailboxEnums.ItemType | string
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Terminplaner
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-item-type.yaml
const itemType = Office.context.mailbox.item.itemType;
switch (itemType) {
case Office.MailboxEnums.ItemType.Appointment:
console.log(`Current item is an ${itemType}.`);
break;
case Office.MailboxEnums.ItemType.Message:
console.log(`Current item is a ${itemType}. A message could be an email, meeting request, meeting response, or meeting cancellation.`);
break;
}
location
Ruft den Ort eines Termins ab bzw. legt ihn fest. Die location -Eigenschaft gibt ein Location-Objekt zurück, das Methoden bereitstellt, die zum Abrufen und Festlegen der Position des Termins verwendet werden.
location: Location;Eigenschaftswert
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Terminplaner
Beispiele
const userContext = { value : 1 };
Office.context.mailbox.item.location.getAsync( { context: userContext}, callback);
function callback(asyncResult) {
const context = asyncResult.context;
const location = asyncResult.value;
}
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-location-appointment-organizer.yaml
Office.context.mailbox.item.location.getAsync((result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Appointment location: ${result.value}`);
});
...
const location = "my office";
Office.context.mailbox.item.location.setAsync(location, (result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Successfully set location to ${location}`);
});
optionalAttendees
Bietet Zugriff auf die optionalen Teilnehmer eines Ereignisses. Der Typ des Objekts und die Zugriffsebene hängen vom Modus des aktuellen Elements ab.
Die optionalAttendees-Eigenschaft gibt ein Recipients-Objekt zurück, das Methoden zum Abrufen oder Aktualisieren der optionalen Teilnehmer für eine Besprechung bereitstellt. Je nach Client/Plattform (z. B. Windows, Mac usw.) gelten jedoch Grenzwerte für die Anzahl der Empfänger, die Sie abrufen oder aktualisieren können. Weitere Informationen finden Sie im Recipients-Objekt .
optionalAttendees: Recipients;Eigenschaftswert
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Terminplaner
Beispiele
Office.context.mailbox.item.optionalAttendees.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.optionalAttendees.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.optionalAttendees.getAsync(callback);
function callback(asyncResult) {
const arrayOfOptionalAttendeesRecipients = asyncResult.value;
}
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-optional-attendees-appointment-organizer.yaml
Office.context.mailbox.item.optionalAttendees.getAsync(function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
const apptOptionalAttendees = asyncResult.value;
for (let i = 0; i < apptOptionalAttendees.length; i++) {
console.log(
"Optional attendees: " +
apptOptionalAttendees[i].displayName +
" (" +
apptOptionalAttendees[i].emailAddress +
") - response: " +
apptOptionalAttendees[i].appointmentResponse
);
}
} else {
console.error(asyncResult.error);
}
});
...
const email = $("#emailOptional")
.val()
.toString();
const emailArray = [email];
Office.context.mailbox.item.optionalAttendees.setAsync(emailArray, function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log("Succeeded in setting optional attendees field.");
} else {
console.error(asyncResult.error);
}
});
requiredAttendees
Bietet Zugriff auf die erforderlichen Teilnehmer eines Ereignisses. Der Typ des Objekts und die Zugriffsebene hängen vom Modus des aktuellen Elements ab.
Die requiredAttendees-Eigenschaft gibt ein Recipients-Objekt zurück, das Methoden zum Abrufen oder Aktualisieren der erforderlichen Teilnehmer für eine Besprechung bereitstellt. Je nach Client/Plattform (z. B. Windows, Mac usw.) gelten jedoch Grenzwerte für die Anzahl der Empfänger, die Sie abrufen oder aktualisieren können. Weitere Informationen finden Sie im Recipients-Objekt .
requiredAttendees: Recipients;Eigenschaftswert
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Terminplaner
Beispiele
Office.context.mailbox.item.requiredAttendees.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.requiredAttendees.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.requiredAttendees.getAsync(callback);
function callback(asyncResult) {
const arrayOfRequiredAttendeesRecipients = asyncResult.value;
console.log(JSON.stringify(arrayOfRequiredAttendeesRecipients));
}
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-required-attendees-appointment-organizer.yaml
Office.context.mailbox.item.requiredAttendees.getAsync(function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
const apptRequiredAttendees = asyncResult.value;
for (let i = 0; i < apptRequiredAttendees.length; i++) {
console.log(
"Required attendees: " +
apptRequiredAttendees[i].displayName +
" (" +
apptRequiredAttendees[i].emailAddress +
") - response: " +
apptRequiredAttendees[i].appointmentResponse
);
}
} else {
console.error(asyncResult.error);
}
});
...
const email = $("#emailRequired")
.val()
.toString();
const emailArray = [email];
Office.context.mailbox.item.requiredAttendees.setAsync(emailArray, function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log("Succeeded in setting required attendees field.");
} else {
console.error(asyncResult.error);
}
});
start
Ruft Datum und Zeit für den Beginn des Termins ab oder legt Datum und Uhrzeit fest.
Die start -Eigenschaft ist ein Time-Objekt , das als UTC-Datums- und Uhrzeitwert (Coordinated Universal Time) ausgedrückt wird. Sie können die convertToLocalClientTime -Methode verwenden, um den Wert in das lokale Datum und die lokale Uhrzeit des Clients zu konvertieren.
Wenn Sie die Time.setAsync-Methode verwenden, um die Startzeit im Verfassenmodus festzulegen, sollten Sie die convertToUtcClientTime-Methode verwenden, um die Ortszeit auf dem Client für den Server in UTC umzuwandeln.
Wichtig: Im Windows-Client können Sie diese Eigenschaft nicht verwenden, um den Beginn einer Wiederholung zu aktualisieren.
start: Time;Eigenschaftswert
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Terminplaner
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-start-appointment-organizer.yaml
Office.context.mailbox.item.start.getAsync((result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Appointment starts: ${result.value}`);
});
...
const start = new Date(); // Represents current date and time.
start.setDate(start.getDate() + 2); // Add 2 days to current date.
Office.context.mailbox.item.start.setAsync(start, (result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Successfully set start date and time to ${start}`);
});
subject
Ruft die Beschreibung ab, die im Betrefffeld eines Elements angezeigt wird, oder legt sie fest.
Die subject-Eigenschaft ruft den gesamten Betreff des Elements ab oder legt ihn fest – so, wie er vom E-Mail-Server gesendet wird.
Die subject-Eigenschaft gibt ein Subject-Objekt zurück, das Methoden zum Abrufen und Festlegen des Betreffs bereitstellt.
subject: Subject;Eigenschaftswert
Hinweise
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Terminplaner
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-subject-compose.yaml
Office.context.mailbox.item.subject.getAsync((result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Subject: ${result.value}`);
});
...
let subject = "Hello World!";
Office.context.mailbox.item.subject.setAsync(subject, (result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Successfully set subject to ${subject}`);
});
Details zur Methode
addFileAttachmentAsync(uri, attachmentName, options, callback)
Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu.
Die addFileAttachmentAsync-Methode lädt die Datei am angegebenen URI hoch und fügt sie an das Element im Verfassenformular an.
Anschließend können Sie den Bezeichner mit der removeAttachmentAsync-Methode in der gleichen Sitzung zum Entfernen der Anlage verwenden.
Wichtig: In den letzten Builds von Outlook unter Windows wurde ein Fehler eingeführt, der fälschlicherweise einen Authorization: Bearer Header an diese Aktion anhängt (unabhängig davon, ob diese API oder die Outlook-Benutzeroberfläche verwendet wird). Um dieses Problem zu umgehen, können Sie versuchen, die API zu verwenden, die addFileAttachmentFromBase64 mit dem Anforderungssatz 1.8 eingeführt wurde.
addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;Parameter
- uri
-
string
Der URI, der den Speicherort der an die Nachricht oder den Termin anzuhängenden Datei angibt. Die maximale Länge ist 2048 Zeichen.
- attachmentName
-
string
Der Name der Anlage, der beim Hochladen der Anlage angezeigt wird. Die maximale Länge ist 255 Zeichen.
- options
-
Office.AsyncContextOptions & { isInline: boolean }
Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten. isInline: Wenn true, gibt an, dass die Anlage inline im Nachrichtentext angezeigt wird und nicht in der Anlagenliste angezeigt werden soll.
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Bei Erfolg wird der Anlagenbezeichner in der asyncResult.value-Eigenschaft bereitgestellt. Wenn beim Hochladen der Anlage ein Fehler auftritt, enthält das asyncResult-Objekt ein Error-Objekt mit einer Beschreibung des Fehlers.
Gibt zurück
void
Hinweise
Minimale Berechtigungsstufe: Element lesen/schreiben
Anwendbarer Outlook-Modus: Terminplaner
Fehler:
AttachmentSizeExceeded: Die Anlage ist größer als zulässig.FileTypeNotSupported: Die Anlage verfügt über eine Erweiterung, die nicht zulässig ist.NumberOfAttachmentsExceeded: Die Nachricht oder der Termin weist zu viele Anlagen auf.
Beispiele
function callback(result) {
if (result.error) {
console.log(result.error);
} else {
console.log("Attachment added");
}
}
function addAttachment() {
// The values in asyncContext can be accessed in the callback.
const options = { 'asyncContext': { var1: 1, var2: 2 } };
const attachmentURL = "https://contoso.com/rtm/icon.png";
Office.context.mailbox.item.addFileAttachmentAsync(attachmentURL, attachmentURL, options, callback);
}
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml
const attachmentUrl = $("#attachmentUrl").val();
Office.context.mailbox.item.addFileAttachmentAsync(
attachmentUrl,
getFileName(attachmentUrl),
{ "asyncContext" : { var1: 1, var2: true } },
function(result) { console.log(result); });
addFileAttachmentAsync(uri, attachmentName, callback)
Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu.
Die addFileAttachmentAsync-Methode lädt die Datei am angegebenen URI hoch und fügt sie an das Element im Verfassenformular an.
Anschließend können Sie den Bezeichner mit der removeAttachmentAsync-Methode in der gleichen Sitzung zum Entfernen der Anlage verwenden.
Wichtig: In den letzten Builds von Outlook unter Windows wurde ein Fehler eingeführt, der fälschlicherweise einen Authorization: Bearer Header an diese Aktion anhängt (unabhängig davon, ob diese API oder die Outlook-Benutzeroberfläche verwendet wird). Um dieses Problem zu umgehen, können Sie versuchen, die API zu verwenden, die addFileAttachmentFromBase64 mit dem Anforderungssatz 1.8 eingeführt wurde.
addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;Parameter
- uri
-
string
Der URI, der den Speicherort der an die Nachricht oder den Termin anzuhängenden Datei angibt. Die maximale Länge ist 2048 Zeichen.
- attachmentName
-
string
Der Name der Anlage, der beim Hochladen der Anlage angezeigt wird. Die maximale Länge ist 255 Zeichen.
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Bei Erfolg wird der Anlagenbezeichner in der asyncResult.value-Eigenschaft bereitgestellt. Wenn beim Hochladen der Anlage ein Fehler auftritt, enthält das asyncResult-Objekt ein Error-Objekt mit einer Beschreibung des Fehlers.
Gibt zurück
void
Hinweise
Minimale Berechtigungsstufe: Element lesen/schreiben
Anwendbarer Outlook-Modus: Terminplaner
Fehler:
AttachmentSizeExceeded: Die Anlage ist größer als zulässig.FileTypeNotSupported: Die Anlage verfügt über eine Erweiterung, die nicht zulässig ist.NumberOfAttachmentsExceeded: Die Nachricht oder der Termin weist zu viele Anlagen auf.
addItemAttachmentAsync(itemId, attachmentName, options, callback)
Fügt der Nachricht oder dem Termin ein Exchange-Objekt, wie z. B. eine Nachricht, als Anhang hinzu.
Die addItemAttachmentAsync -Methode fügt das Element mit dem angegebenen Exchange-Bezeichner an das Element im Verfassenformular an. Wenn Sie eine Rückruffunktion angeben, wird die Methode mit einem Parameter aufgerufen, asyncResultder entweder den Anlagenbezeichner oder einen Code enthält, der einen Fehler angibt, der beim Anfügen des Elements aufgetreten ist. Sie können den options -Parameter verwenden, um bei Bedarf Zustandsinformationen an die Rückruffunktion zu übergeben.
Anschließend können Sie den Bezeichner mit der removeAttachmentAsync-Methode in der gleichen Sitzung zum Entfernen der Anlage verwenden.
Wenn Ihr Office Add-In in Outlook im Web ausgeführt wird, kann die Methode addItemAttachmentAsync Elemente an andere Elemente anfügen als an das Element, das Sie gerade bearbeiten. Dies wird jedoch nicht unterstützt und nicht empfohlen.
addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;Parameter
- itemId
-
any
Der Exchange-Bezeichner des Objekts, das angehängt werden soll. Die maximale Länge beträgt 100 Zeichen.
- attachmentName
-
string
Der Name der Anlage, der beim Hochladen der Anlage angezeigt wird. Die maximale Länge ist 255 Zeichen.
- options
- Office.AsyncContextOptions
Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Optional. Wenn die Methode abgeschlossen ist, wird die im Rückrufparameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Bei Erfolg wird der Anlagenbezeichner in der asyncResult.value-Eigenschaft bereitgestellt. Wenn beim Hinzufügen der Anlage ein Fehler auftritt, enthält das asyncResult-Objekt ein Error-Objekt mit einer Beschreibung des Fehlers.
Gibt zurück
void
Hinweise
Minimale Berechtigungsstufe: Element lesen/schreiben
Anwendbarer Outlook-Modus: Terminplaner
Fehler:
NumberOfAttachmentsExceeded: Die Nachricht oder der Termin weist zu viele Anlagen auf.
Beispiele
// The following example adds an existing Outlook item as an attachment
// with the name `My Attachment`.
function callback(result) {
if (result.error) {
console.log(result.error);
} else {
console.log("Attachment added");
}
}
function addAttachment() {
// EWS ID of item to attach (shortened for readability).
const itemId = "AAMkADI1...AAA=";
// The values in asyncContext can be accessed in the callback.
const options = { 'asyncContext': { var1: 1, var2: 2 } };
Office.context.mailbox.item.addItemAttachmentAsync(itemId, "My Attachment", options, callback);
}
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml
const attachmentItemId = $("#attachmentItemId").val();
Office.context.mailbox.item.addItemAttachmentAsync(
attachmentItemId,
"My attachment",
{ "asyncContext" : { var3: 3, var4: false } },
function(result) { console.log(result); });
addItemAttachmentAsync(itemId, attachmentName, callback)
Fügt der Nachricht oder dem Termin ein Exchange-Objekt, wie z. B. eine Nachricht, als Anhang hinzu.
Die addItemAttachmentAsync -Methode fügt das Element mit dem angegebenen Exchange-Bezeichner an das Element im Verfassenformular an. Wenn Sie eine Rückruffunktion angeben, wird die Methode mit einem Parameter aufgerufen, asyncResultder entweder den Anlagenbezeichner oder einen Code enthält, der einen Fehler angibt, der beim Anfügen des Elements aufgetreten ist. Sie können den options -Parameter verwenden, um bei Bedarf Zustandsinformationen an die Rückruffunktion zu übergeben.
Anschließend können Sie den Bezeichner mit der removeAttachmentAsync-Methode in der gleichen Sitzung zum Entfernen der Anlage verwenden.
Wenn Ihr Office Add-In in Outlook im Web ausgeführt wird, kann die Methode addItemAttachmentAsync Elemente an andere Elemente anfügen als an das Element, das Sie gerade bearbeiten. Dies wird jedoch nicht unterstützt und nicht empfohlen.
addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;Parameter
- itemId
-
any
Der Exchange-Bezeichner des Objekts, das angehängt werden soll. Die maximale Länge beträgt 100 Zeichen.
- attachmentName
-
string
Der Name der Anlage, der beim Hochladen der Anlage angezeigt wird. Die maximale Länge ist 255 Zeichen.
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Optional. Wenn die Methode abgeschlossen ist, wird die im Rückrufparameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Bei Erfolg wird der Anlagenbezeichner in der asyncResult.value-Eigenschaft bereitgestellt. Wenn beim Hinzufügen der Anlage ein Fehler auftritt, enthält das asyncResult-Objekt ein Error-Objekt mit einer Beschreibung des Fehlers.
Gibt zurück
void
Hinweise
Minimale Berechtigungsstufe: Element lesen/schreiben
Anwendbarer Outlook-Modus: Terminplaner
Fehler:
NumberOfAttachmentsExceeded: Die Nachricht oder der Termin weist zu viele Anlagen auf.
loadCustomPropertiesAsync(callback, userContext)
Lädt asynchron benutzerdefinierte Eigenschaften für dieses Add-In für das ausgewählte Element.
Benutzerdefinierte Eigenschaften werden als Schlüssel-Wert-Paare pro App und Element gespeichert. Diese Methode gibt ein CustomProperties-Objekt im Rückruf zurück, das Methoden für den Zugriff auf die benutzerdefinierten Eigenschaften bereitstellt, die für das aktuelle Element und das aktuelle Add-In spezifisch sind. Benutzerdefinierte Eigenschaften werden für das Element nicht verschlüsselt, sodass dies nicht als sicherer Speicher verwendet werden sollte.
Die benutzerdefinierten Eigenschaften werden als CustomProperties-Objekt in der asyncResult.value-Eigenschaft bereitgestellt. Dieses Objekt kann verwendet werden, um benutzerdefinierte Eigenschaften aus dem E-Mail-Element abzurufen, festzulegen, zu speichern und zu entfernen.
loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any): void;Parameter
- callback
-
(asyncResult: Office.AsyncResult<Office.CustomProperties>) => void
Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen.
- userContext
-
any
Optional. Entwickler können ein beliebiges Objekt bereitstellen, auf das sie in der Callbackfunktion zugreifen möchten. Der Zugriff auf dieses Objekt kann über die asyncResult.asyncContext-Eigenschaft in der Callbackfunktion erfolgen.
Gibt zurück
void
Hinweise
Weitere Informationen zu benutzerdefinierten Eigenschaften finden Sie unter Abrufen und Festlegen von Add-In-Metadaten für ein Outlook-Add-In.
Mindestberechtigungsstufe: Element lesen
Anwendbarer Outlook-Modus: Terminplaner
Beispiele
// The following example shows how to use the loadCustomPropertiesAsync method
// to asynchronously load custom properties that are specific to the current item.
// The example also shows how to use the saveAsync method to save these properties
// back to the server. After loading the custom properties, the example uses the
// get method to read the custom property myProp, the set method to write the
// custom property otherProp, and then finally calls the saveAsync method to save
// the custom properties.
Office.initialize = function () {
// Checks for the DOM to load using the jQuery ready method.
$(document).ready(function () {
// After the DOM is loaded, add-in-specific code can run.
const mailbox = Office.context.mailbox;
mailbox.item.loadCustomPropertiesAsync(customPropsCallback);
});
};
function customPropsCallback(asyncResult) {
const customProps = asyncResult.value;
const myProp = customProps.get("myProp");
customProps.set("otherProp", "value");
customProps.saveAsync(saveCallback);
}
function saveCallback(asyncResult) {
}
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/15-item-custom-properties/load-set-get-save.yaml
Office.context.mailbox.item.loadCustomPropertiesAsync(function (result) {
if (result.status === Office.AsyncResultStatus.Succeeded) {
console.log("Loaded following custom properties:");
customProps = result.value;
const dataKey = Object.keys(customProps)[0];
const data = customProps[dataKey];
for (let propertyName in data)
{
let propertyValue = data[propertyName];
console.log(`${propertyName}: ${propertyValue}`);
}
}
else {
console.error(`loadCustomPropertiesAsync failed with message ${result.error.message}`);
}
});
removeAttachmentAsync(attachmentId, options, callback)
Entfernt eine Anlage aus einer Nachricht oder einem Termin.
Die removeAttachmentAsync-Methode entfernt die Anlage mit dem angegebenen Bezeichner aus dem Element. Als bewährte Vorgehensweise sollten Sie den Anlagenbezeichner nur dann zum Entfernen einer Anlage verwenden, wenn die gleiche Mail-App die Anlage in der gleichen Sitzung hinzugefügt hat. In Outlook im Web und auf mobilen Geräten ist der Anlagenbezeichner nur innerhalb derselben Sitzung gültig. Eine Sitzung ist beendet, wenn der Benutzer die App schließt, oder wenn der Benutzer mit der Erstellung eines Inlineformulars beginnt, dann wird das Formular anschließend eingeblendt, um in einem separaten Fenster fortzufahren.
removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parameter
- attachmentId
-
string
Der Bezeichner der zu entfernenden Anlage. Die maximale Zeichenfolgenlänge von attachmentId beträgt 200 Zeichen in Outlook im Web und unter Windows.
- options
- Office.AsyncContextOptions
Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Wenn beim Entfernen der Anlage ein Fehler auftritt, enthält die Eigenschaft asyncResult.error einen Fehlercode mit dem Grund für den Fehler.
Gibt zurück
void
Hinweise
Minimale Berechtigungsstufe: Element lesen/schreiben
Anwendbarer Outlook-Modus: Terminplaner
Fehler:
InvalidAttachmentId: Der Anlagenbezeichner ist nicht vorhanden.
Beispiele
// The following code removes an attachment with an identifier of '0'.
Office.context.mailbox.item.removeAttachmentAsync(
'0',
{ asyncContext : null },
function (asyncResult)
{
console.log(asyncResult.status);
}
);
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml
Office.context.mailbox.item.removeAttachmentAsync(
$("#attachmentId").val(),
{ asyncContext : null },
function(result)
{
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`${result.error.message}`);
} else {
console.log(`Attachment removed successfully.`);
}
}
);
removeAttachmentAsync(attachmentId, callback)
Entfernt eine Anlage aus einer Nachricht oder einem Termin.
Die removeAttachmentAsync-Methode entfernt die Anlage mit dem angegebenen Bezeichner aus dem Element. Als bewährte Vorgehensweise sollten Sie den Anlagenbezeichner nur dann zum Entfernen einer Anlage verwenden, wenn die gleiche Mail-App die Anlage in der gleichen Sitzung hinzugefügt hat. In Outlook im Web und auf mobilen Geräten ist der Anlagenbezeichner nur innerhalb derselben Sitzung gültig. Eine Sitzung ist beendet, wenn der Benutzer die App schließt, oder wenn der Benutzer mit der Erstellung eines Inlineformulars beginnt, dann wird das Formular anschließend eingeblendt, um in einem separaten Fenster fortzufahren.
removeAttachmentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parameter
- attachmentId
-
string
Der Bezeichner der zu entfernenden Anlage. Die maximale Zeichenfolgenlänge von attachmentId beträgt 200 Zeichen in Outlook im Web und unter Windows.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Wenn beim Entfernen der Anlage ein Fehler auftritt, enthält die Eigenschaft asyncResult.error einen Fehlercode mit dem Grund für den Fehler.
Gibt zurück
void
Hinweise
Minimale Berechtigungsstufe: Element lesen/schreiben
Anwendbarer Outlook-Modus: Terminplaner
Fehler:
InvalidAttachmentId: Der Anlagenbezeichner ist nicht vorhanden.
Office Add-ins
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für