Function: getForgeAppProperty()

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

Defined in: src/cloud/api/appProperties.ts:140

Returns the value of a Forge app's property.

Permissions required: Only Forge apps can make this request. 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.
options?	RequestOptions	-

Returns

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