Excel.LinkedEntityDataDomainRefreshCompletedEventArgs interface

Paket:
excel

Enthält Informationen über die verknüpfte Entitätsdatendomäne, deren LinkedEntityCellValue Objekte aktualisiert wurden.

Hinweise

API-Satz: ExcelApi 1.19

Diese Schnittstelle wird in Excel im Web nicht unterstützt.

Verwendet von

Beispiele

// Registers an event handler for the onRefreshCompleted event.
await Excel.run(async (context) => {
    const dataDomains: Excel.LinkedEntityDataDomainCollection = context.workbook.linkedEntityDataDomains;
    dataDomains.onRefreshCompleted.add(onLinkedEntityDomainRefreshed);

    await context.sync();
});

async function onLinkedEntityDomainRefreshed(eventArgs: Excel.LinkedEntityDataDomainRefreshCompletedEventArgs): Promise<void> {
    console.log(`Linked entity domain refreshed: ${eventArgs.id}`);
    console.log(`Event type: ${eventArgs.type}`);
    console.log(`Event source: ${eventArgs.source}`);
    console.log(`Service ID: ${eventArgs.serviceId}`);
    console.log(`Refresh status: ${eventArgs.refreshed}`);
    console.log(`Refresh errors: ${eventArgs.errors}`);
}

Eigenschaften

errors

Ruft alle Fehler ab, die während der Anforderung zum Aktualisieren LinkedEntityCellValue von Objekten der verknüpften Entitätsdatendomäne aufgetreten sind.
id

Ruft die ID der verknüpften Entitätsdatendomäne ab, deren LinkedEntityCellValue Objekte aktualisiert wurden. Diese ID wird von Office-Add-Ins definiert. Diese ID gilt nicht für Datendomänen verknüpfter Entitäten, die von Dienstdatenanbietern wie Bing oder Power BI definiert wurden.
refreshed

Gibt zurück true , ob die LinkedEntityCellValue Objekte der verknüpften Entitätsdatendomäne erfolgreich aktualisiert wurden, andernfalls wird falsezurückgegeben.
serviceId

Ruft die Dienst-ID der verknüpften Entitätsdatendomäne ab, deren LinkedEntityCellValue Objekte aktualisiert wurden.
source

Ruft die Quelle des Ereignisses ab. Weitere Informationen findest du hier Excel.EventSource .
type

Ruft den Typ des Ereignisses ab. Weitere Informationen findest du hier Excel.EventType .

Details zur Eigenschaft

errors

Ruft alle Fehler ab, die während der Anforderung zum Aktualisieren LinkedEntityCellValue von Objekten der verknüpften Entitätsdatendomäne aufgetreten sind.

errors?: string[];

Eigenschaftswert

string[]

Hinweise

API-Satz: ExcelApi 1.19

Diese Eigenschaft wird in Excel im Web nicht unterstützt.

id

Ruft die ID der verknüpften Entitätsdatendomäne ab, deren LinkedEntityCellValue Objekte aktualisiert wurden. Diese ID wird von Office-Add-Ins definiert. Diese ID gilt nicht für Datendomänen verknüpfter Entitäten, die von Dienstdatenanbietern wie Bing oder Power BI definiert wurden.

id?: string;

Eigenschaftswert

string

Hinweise

API-Satz: ExcelApi 1.19

Diese Eigenschaft wird in Excel im Web nicht unterstützt.

refreshed

Gibt zurück true , ob die LinkedEntityCellValue Objekte der verknüpften Entitätsdatendomäne erfolgreich aktualisiert wurden, andernfalls wird falsezurückgegeben.

refreshed: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.19

Diese Eigenschaft wird in Excel im Web nicht unterstützt.

serviceId

Ruft die Dienst-ID der verknüpften Entitätsdatendomäne ab, deren LinkedEntityCellValue Objekte aktualisiert wurden.

serviceId: number;

Eigenschaftswert

number

Hinweise

API-Satz: ExcelApi 1.19

Diese Eigenschaft wird in Excel im Web nicht unterstützt.

source

Ruft die Quelle des Ereignisses ab. Weitere Informationen findest du hier Excel.EventSource .

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

Eigenschaftswert

Excel.EventSource | "Local" | "Remote"

Hinweise

API-Satz: ExcelApi 1.19

Diese Eigenschaft wird in Excel im Web nicht unterstützt.

type

Ruft den Typ des Ereignisses ab. Weitere Informationen findest du hier Excel.EventType .

type: "LinkedEntityDataDomainRefreshCompleted";

Eigenschaftswert

"LinkedEntityDataDomainRefreshCompleted"

Hinweise

API-Satz: ExcelApi 1.19

Diese Eigenschaft wird in Excel im Web nicht unterstützt.