Function: getAddonProperties()

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

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

Gets all the properties of an app. The reserved key connect_client_key_019cdff3-8bfb-71fe-9628-875b700aebb8 is not returned.

Permissions required: Only a Connect app whose key matches addonKey can make this request. Additionally, Forge apps can access Connect app properties (stored against the same app.connect.key).

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ addonKey: string; }	-
parameters.addonKey	string	The key of the app, as defined in its descriptor.
options?	RequestOptions	-

Returns

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