Edit

Excel.RefreshRequestCompletedEventArgs interface

  • Reference
Package:
excel

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

The argument that is passed to the event handler upon completion of refresh request to an external service or link.

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Properties

refreshed

Indicates if the request to refresh was successful.
serviceId

The unique ID of the object whose refresh request was completed.
source

Gets the source of the event. See Excel.EventSource for details.
type

Gets the type of the event. See Excel.EventType for details.
warnings

An array that contains any warnings generated from the refresh request.

Property Details

refreshed

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Indicates if the request to refresh was successful.

refreshed: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

serviceId

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

The unique ID of the object whose refresh request was completed.

serviceId: number;

Property Value

number

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

source

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the source of the event. See Excel.EventSource for details.

source: Excel.EventSource | "Local" | "Remote";

Property Value

Excel.EventSource | "Local" | "Remote"

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

type

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the type of the event. See Excel.EventType for details.

type: "LinkedDataTypeRefreshRequestCompleted";

Property Value

"LinkedDataTypeRefreshRequestCompleted"

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

warnings

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

An array that contains any warnings generated from the refresh request.

warnings?: string[];

Property Value

string[]

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]