Excel.LinkedEntityLoadServiceRequest interface

Paket:

excel

Stellt eine Anforderung an eine @linkedEntityLoadService benutzerdefinierte Funktion zum Laden LinkedEntityCellValue von Objekten dar.

Hinweise

API-Satz: ExcelApi 1.19

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

Beispiele

/**
 * Custom function that acts as the data provider for a LinkedEntityDataDomain.
 * Called on demand by Excel to resolve and refresh LinkedEntityCellValue objects.
 * @customfunction
 * @linkedEntityLoadService
 * @param {any} request Request to resolve and refresh LinkedEntityCellValue objects.
 * @return {any} Resolved or refreshed LinkedEntityCellValue objects that were requested in the passed-in request.
 */
function contosoLoadService(request: any): any {
    const notAvailableError = new CustomFunctions.Error(CustomFunctions.ErrorCode.notAvailable);

    try {
        // Parse the request that was passed-in by Excel.
        const parsedRequest: Excel.LinkedEntityLoadServiceRequest = JSON.parse(request);
        // Initialize result to populate and return to Excel.
        const result: Excel.LinkedEntityLoadServiceResult = { entities: [] };

        // Identify the domainId of the request and call the corresponding function to create
        // linked entity cell values for that linked entity data domain.
        const entities: Excel.LinkedEntityIdCulture[] = parsedRequest.entities;
        for (const { entityId } of entities) {
            let linkedEntityResult = null;
            switch (parsedRequest.domainId) {
                case "products": {
                    linkedEntityResult = makeProductLinkedEntity(entityId);
                    break;
                }
                case "categories": {
                    linkedEntityResult = makeCategoryLinkedEntity(entityId);
                    break;
                }
                default:
                    throw notAvailableError;
            }

            if (!linkedEntityResult) {
                // Throw an error to signify to Excel that the resolution or refresh of the requested linkedEntityId failed.
                throw notAvailableError;
            }

            result.entities.push(linkedEntityResult);
        }

        return result;
    } catch (error) {
        console.error(error);
        throw notAvailableError;
    }
}

Eigenschaften

domainId	Stellt die Domäne dar, die für den Dienst spezifisch ist, der zum Erstellen der LinkedEntityCellValue Objekte verwendet wird.
entities	Stellt die Entitäts-IDs und Kulturen der LinkedEntityCellValue zu ladenden Objekte dar.

Details zur Eigenschaft

domainId

Stellt die Domäne dar, die für den Dienst spezifisch ist, der zum Erstellen der LinkedEntityCellValue Objekte verwendet wird.

domainId: string;

Eigenschaftswert

string

Hinweise

API-Satz: ExcelApi 1.19

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

entities

Stellt die Entitäts-IDs und Kulturen der LinkedEntityCellValue zu ladenden Objekte dar.

entities: LinkedEntityIdCulture[];

Eigenschaftswert

Excel.LinkedEntityIdCulture[]

Hinweise

API-Satz: ExcelApi 1.19

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