Excel.LinkedEntityLoadServiceResult interface

程序包:

excel

表示请求 @linkedEntityLoadService 自定义函数加载 LinkedEntityCellValue 对象的结果。

注解

API 集：ExcelApi 1.19

Excel Web 版不支持此界面。

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-linked-entity-load-service.yaml

/**
 * Loads the Contoso entities used by the Data types: Linked entities sample.
 * @customfunction
 * @linkedEntityLoadService
 * @param {unknown} request JSON containing the domain and entity identities requested by Excel.
 * @returns {any} Linked entities in the same order as the request.
 */
function contosoLoadService(request: unknown) {
    // Resolve a batch of identities while preserving each requested culture and the request order.
    try {
        if (typeof request !== "string") {
            throw new Error("The linked entity load service request must be JSON text.");
        }
        const parsedRequest: Excel.LinkedEntityLoadServiceRequest = JSON.parse(request);
        if (!parsedRequest || typeof parsedRequest.domainId !== "string" || !Array.isArray(parsedRequest.entities)) {
            throw new Error("The linked entity request must contain a domain ID and an entities array.");
        }
        const response: Excel.LinkedEntityLoadServiceResult = { entities: [] };
        for (const identity of parsedRequest.entities) {
            const entityIdentity: Excel.LinkedEntityIdCulture = identity;
            if (!entityIdentity || typeof entityIdentity.entityId !== "string" ||
                typeof entityIdentity.culture !== "string") {
                throw new Error("Each linked entity identity must contain an entity ID and culture.");
            }
            response.entities.push(makeLinkedEntity(parsedRequest.domainId, entityIdentity.entityId, entityIdentity.culture));
        }
        console.log(`Loaded ${response.entities.length} linked entities from ${parsedRequest.domainId}.`);
        return response;
    } catch (error) {
        console.error("Unable to load linked entities:", error);
        throw new CustomFunctions.Error(CustomFunctions.ErrorCode.notAvailable, "Unable to load the requested Contoso entity.");
    }
}

属性

entities

表示加载的 LinkedEntityCellValue 对象。 加载的对象必须按照与 entities 属性 LinkedEntityLoadServiceRequest相同的顺序返回。

属性详细信息

entities

表示加载的 LinkedEntityCellValue 对象。 加载的对象必须按照与 entities 属性 LinkedEntityLoadServiceRequest相同的顺序返回。

entities: LinkedEntityCellValue[];

属性值

Excel.LinkedEntityCellValue[]

注解

API 集：ExcelApi 1.19

Excel web 版不支持此属性。