Office.AsyncResult interface

Paquet:

office

Objet qui encapsule le résultat d’une requête asynchrone, y compris les informations d’état et d’erreur quand la demande a échoué.

Lorsque la fonction que vous passez au callback paramètre d’une méthode « Async » s’exécute, elle reçoit un objet AsyncResult auquel vous pouvez accéder à partir du seul paramètre de la callback fonction.

Remarques

Exemples

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

Propriétés

asyncContext	Obtient l’élément défini par l’utilisateur passé au paramètre facultatif asyncContext de la méthode appelée dans le même état qu’il a été transmis. Cela retourne l’élément défini par l’utilisateur (qui peut être de n’importe quel type JavaScript : String, Number, Boolean, Object, Array, Null ou Undefined) passé au paramètre facultatif asyncContext de la méthode appelée. Renvoie Undefined si vous n’avez rien transmis au paramètre asyncContext.
diagnostics	Obtient un objet qui peut fournir des informations supplémentaires si une erreur s’est produite.
error	Obtient un objet Office.Error qui fournit une description de l’erreur, si une erreur s’est produite.
status	Obtient l’objet Office.AsyncResultStatus de l’opération asynchrone.
value	Obtient la charge utile ou le contenu de l’opération asynchrone, le cas échéant.

Détails de la propriété

asyncContext

Obtient l’élément défini par l’utilisateur passé au paramètre facultatif asyncContext de la méthode appelée dans le même état qu’il a été transmis. Cela retourne l’élément défini par l’utilisateur (qui peut être de n’importe quel type JavaScript : String, Number, Boolean, Object, Array, Null ou Undefined) passé au paramètre facultatif asyncContext de la méthode appelée. Renvoie Undefined si vous n’avez rien transmis au paramètre asyncContext.

asyncContext: any;

Valeur de propriété

any

Exemples

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

Obtient un objet qui peut fournir des informations supplémentaires si une erreur s’est produite.

diagnostics: any;

Valeur de propriété

any

Remarques

Cette propriété retourne des informations supplémentaires si les erreurs suivantes se produisent avec ces API prises en charge.

API prises en charge

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

Erreurs prises en charge

AsyncResult.error.name	AsyncResult.error.message	Description de l’objet de diagnostic retourné
HTTPRequestFailure	La demande a échoué. Veuillez rechercher le code d’erreur HTTP dans l’objet de diagnostics.	Code d’erreur HTTP dans un objet JSON, par exemple, {"HTTPCode":"401"}
InternalServerError	Le serveur Exchange a renvoyé une erreur. Pour plus d’informations, veuillez consulter l’objet de diagnostics.	Message d’erreur du serveur Exchange dans un objet JSON, par exemple, {"ErrorText": "The mailbox database is temporarily unavailable"}

error

Obtient un objet Office.Error qui fournit une description de l’erreur, si une erreur s’est produite.

error: Office.Error;

Valeur de propriété

Office.Error

Exemples

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

Obtient l’objet Office.AsyncResultStatus de l’opération asynchrone.

status: AsyncResultStatus;

Valeur de propriété

Office.AsyncResultStatus

Exemples

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

Obtient la charge utile ou le contenu de l’opération asynchrone, le cas échéant.

value: T;

Valeur de propriété

T

Remarques

Vous accédez à l’objet AsyncResult dans la fonction passée en tant qu’argument au paramètre de rappel d’une méthode « Async », comme les getSelectedDataAsync méthodes et setSelectedDataAsync de l’objet Document .

Remarque : Ce que la propriété value retourne pour une méthode « Async » particulière varie en fonction de l’objectif et du contexte de cette méthode. To determine what is returned by the value property for an "Async" method, refer to the "Callback value" section of the method's topic.

Exemples

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; 
}