Function: getPreference()

function getPreference(
   client, 
   parameters?, 
   options?
): Promise<string>;

Defined in: src/server/api/myPreferences.ts:12

Returns preference of the currently logged in user. Preference key must be provided as input parameter (key). The value is returned exactly as it is. If key parameter is not provided or wrong - status code 404. If value is found - status code 200.

Parameters

Parameter	Type	Description
client	Client	-
parameters?	{ key?: string; }	-
parameters.key?	string	Key of the preference to be returned.
options?	RequestOptions	-

Returns

Promise<string>