Tutorial: system.getEntityInfo

system.getEntityInfo

Returns a frame info object relating to the entity specified by the uuid and name passed in. The possible types are 'window', 'iframe', 'external connection' or 'unknown'.

Example

const successCallback = (entityInfo) => console.log(entityInfo); // see return value below
const errorCallback = (errStr, err) => console.log(err);
const entityUuid = 'OpenfinPOC';
const entityName = '40c74b5d-ed98-40f7-853f-e3d3c2699175';

fin.desktop.System.getEntityInfo(entityUuid, entityName, successCallback, errorCallback);

// example info shape
{
    "uuid": "OpenfinPOC",
    "name": "40c74b5d-ed98-40f7-853f-e3d3c2699175",
    "parent": {
        "uuid": "OpenfinPOC",
        "name": "OpenfinPOC"
    },
    "entityType": "iframe"
}