Edit

Share via

Excel.LinkedEntityDataDomainRefreshCompletedEventArgs 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.

Provides information about the linked entity data domain whose LinkedEntityCellValue objects were refreshed.

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Properties

errors

Gets any errors encountered during the request to refresh LinkedEntityCellValue objects of the linked entity data domain.
id

Gets the ID of the linked entity data domain whose LinkedEntityCellValue objects were refreshed. This ID is defined by Office Add-ins. This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
refreshed

Returns true if the LinkedEntityCellValue objects of the linked entity data domain were refreshed successfully, otherwise returns false.
serviceId

Gets the service ID of the linked entity data domain whose LinkedEntityCellValue objects were refreshed.
source

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

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

Property Details

errors

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 any errors encountered during the request to refresh LinkedEntityCellValue objects of the linked entity data domain.

errors?: string[];

Property Value

string[]

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

id

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 ID of the linked entity data domain whose LinkedEntityCellValue objects were refreshed. This ID is defined by Office Add-ins. This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.

id?: string;

Property Value

string

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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.

Returns true if the LinkedEntityCellValue objects of the linked entity data domain were refreshed successfully, otherwise returns false.

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.

Gets the service ID of the linked entity data domain whose LinkedEntityCellValue objects were refreshed.

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: "LinkedEntityDataDomainRefreshCompleted";

Property Value

"LinkedEntityDataDomainRefreshCompleted"

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]