Function: getForgeAppProperty()

function getForgeAppProperty(client, parameters): Promise<{
[key: string]: unknown;
  key?: string;
  value?: Record<string, any>;
}>;

Defined in: src/v2/api/appProperties.ts:36

Gets a Forge app property by property key. This API can only be accessed using asApp() requests from Forge.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ propertyKey: string; }	-
parameters.propertyKey	string	The key of the property

Returns

Promise<{ [key: string]: unknown; key?: string; value?: Record<string, any>; }>