Office.AsyncResult interface

Paket:

office

Ein Objekt, das das Ergebnis einer asynchronen Anforderung kapselt, einschließlich Status- und Fehlerinformationen, falls bei der Anforderung ein Fehler aufgetreten ist.

Wenn die Funktion, die Sie an den callback Parameter einer "Async"-Methode übergeben, ausgeführt wird, empfängt sie ein AsyncResult-Objekt, auf das Sie über den einzigen Parameter der callback Funktion zugreifen können.

Hinweise

Beispiele

// The following is an example applicable to content and task pane add-ins.
// The example shows a call to the getSelectedDataAsync method of the Document object.
Office.context.document.getSelectedDataAsync(
    Office.CoercionType.Text,
    {
        valueFormat: Office.ValueFormat.Unformatted,
        filterType: Office.FilterType.All
    },
    (result) => {
        if (result.status === Office.AsyncResultStatus.Succeeded) {
            const dataValue = result.value; // Get selected data.
            console.log('Selected data is ' + dataValue);
        } else {
            const err = result.error;
            console.log(err.name + ": " + err.message);
        }
    }
);
// The anonymous function passed as the callback argument ((result) => {...}) has a single 
// parameter named result that provides access to an AsyncResult object when the function executes.
// When the call to the getSelectedDataAsync method completes, the callback function executes, 
// and the following line of code accesses the value property of the AsyncResult object to 
// return the data selected in the document:
// const dataValue = result.value;
// Note that other lines of code in the function use the result parameter of the callback function 
// to access the status and error properties of the AsyncResult object.

Eigenschaften

asyncContext	Ruft das benutzerdefinierte Element ab, das an den optionalen asyncContext Parameter der aufgerufenen Methode in demselben Zustand übergeben wird, in dem es übergeben wurde. Dadurch wird das benutzerdefinierte Element (das einen beliebigen JavaScript-Typ aufweisen kann: String, Number, Boolean, Object, Array, Null oder Undefined) zurückgegeben, das an den optionalen asyncContext Parameter der aufgerufenen Methode übergeben wird. Gibt Undefined zurück, wenn kein Wert an den asyncContext-Parameter übergeben wurde.
diagnostics	Ruft ein -Objekt ab, das möglicherweise zusätzliche Informationen bereitstellt, wenn ein Fehler aufgetreten ist.
error	Ruft ein Office.Error-Objekt ab, das eine Beschreibung des Fehlers bereitstellt, falls ein Fehler aufgetreten ist.
status	Ruft den Office.AsyncResultStatus des asynchronen Vorgangs ab.
value	Ruft die Ladung oder den Inhalt dieses asynchronen Vorgangs ab, falls vorhanden.

Details zur Eigenschaft

asyncContext

Ruft das benutzerdefinierte Element ab, das an den optionalen asyncContext Parameter der aufgerufenen Methode in demselben Zustand übergeben wird, in dem es übergeben wurde. Dadurch wird das benutzerdefinierte Element (das einen beliebigen JavaScript-Typ aufweisen kann: String, Number, Boolean, Object, Array, Null oder Undefined) zurückgegeben, das an den optionalen asyncContext Parameter der aufgerufenen Methode übergeben wird. Gibt Undefined zurück, wenn kein Wert an den asyncContext-Parameter übergeben wurde.

asyncContext: any;

Eigenschaftswert

any

Beispiele

function getDataWithContext() {
    const format = "Your data: ";
    Office.context.document.getSelectedDataAsync(
        Office.CoercionType.Text, 
        { asyncContext: format }, 
        showDataWithContext);
}

function showDataWithContext(asyncResult) {
    write(asyncResult.asyncContext + asyncResult.value);
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

diagnostics

Ruft ein -Objekt ab, das möglicherweise zusätzliche Informationen bereitstellt, wenn ein Fehler aufgetreten ist.

diagnostics: any;

Eigenschaftswert

any

Hinweise

Diese Eigenschaft gibt zusätzliche Informationen zurück, wenn die folgenden Fehler bei diesen unterstützten APIs auftreten.

Unterstützte APIs

Office.context.mailbox.item.getCallbackTokenAsync, Office.context.mailbox.item.getUserIdentityTokenAsync

Unterstützte Fehler

AsyncResult.error.name	AsyncResult.error.message	Beschreibung des zurückgegebenen Diagnose Objekts
HTTPRequestFailure	Die Anforderung ist fehlgeschlagen. Den HTTP-Fehlercode finden Sie im Diagnoseobjekt.	Der HTTP-Fehlercode in einem JSON-Objekt, {"HTTPCode":"401"}z. B. .
InternalServerError	Der Exchange-Server hat einen Fehler zurückgegeben. Weitere Informationen finden Sie im Diagnoseobjekt.	Die Fehlermeldung vom Exchange-Server in einem JSON-Objekt, {"ErrorText": "The mailbox database is temporarily unavailable"}z. B. .

error

Ruft ein Office.Error-Objekt ab, das eine Beschreibung des Fehlers bereitstellt, falls ein Fehler aufgetreten ist.

error: Office.Error;

Eigenschaftswert

Office.Error

Beispiele

function getData() {
    Office.context.document.getSelectedDataAsync(Office.CoercionType.Table, function(asyncResult) {
        if (asyncResult.status == Office.AsyncResultStatus.Failed) {
            write(asyncResult.error.message);
        }
        else {
            write(asyncResult.value);
        }
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

status

Ruft den Office.AsyncResultStatus des asynchronen Vorgangs ab.

status: AsyncResultStatus;

Eigenschaftswert

Office.AsyncResultStatus

Beispiele

function getData() {
    Office.context.document.getSelectedDataAsync(Office.CoercionType.Table, function(asyncResult) {
        if (asyncResult.status == Office.AsyncResultStatus.Failed) {
            write(asyncResult.error.message);
        }
        else {
            write(asyncResult.value);
        }
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

value

Ruft die Ladung oder den Inhalt dieses asynchronen Vorgangs ab, falls vorhanden.

value: T;

Eigenschaftswert

T

Hinweise

Sie greifen auf das AsyncResult-Objekt in der Funktion zu, die als Argument an den Rückrufparameter einer "Async"-Methode übergeben wird, z. B. die getSelectedDataAsync Methoden und setSelectedDataAsync des Document-Objekts .

Hinweis: Was die Value-Eigenschaft für eine bestimmte "Async"-Methode zurückgibt, hängt vom Zweck und Kontext dieser Methode ab. To determine what is returned by the value property for an "Async" method, refer to the "Callback value" section of the method's topic.

Beispiele

function getData() {
    Office.context.document.getSelectedDataAsync(Office.CoercionType.Table, function(asyncResult) {
        if (asyncResult.status == Office.AsyncResultStatus.Failed) {
            write(asyncResult.error.message);
        }
        else {
            write(asyncResult.value);
        }
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}