UserMetadata

Classes

default

Defined in: recipe/usermetadata/index.ts:21

Constructors

Constructor

new default(): default;

Returns

default

Properties

Property	Modifier	Type	Default value	Defined in
init	static	(config?) => RecipeListFunction	Recipe.init	recipe/usermetadata/index.ts:22

Methods

clearUserMetadata()

static clearUserMetadata(userId, userContext?): Promise<{
  status: "OK";
}>;

Defined in: recipe/usermetadata/index.ts:39

Parameters

Parameter	Type
userId	string
userContext?	Record<string, any>

Returns

Promise<{ status: "OK"; }>

getUserMetadata()

static getUserMetadata(userId, userContext?): Promise<{
  metadata: any;
  status: "OK";
}>;

Defined in: recipe/usermetadata/index.ts:24

Parameters

Parameter	Type
userId	string
userContext?	Record<string, any>

Returns

Promise<{ metadata: any; status: "OK"; }>

updateUserMetadata()

static updateUserMetadata(
   userId, 
   metadataUpdate, 
   userContext?): Promise<{
  metadata: JSONObject;
  status: "OK";
}>;

Defined in: recipe/usermetadata/index.ts:31

Parameters

Parameter	Type
userId	string
metadataUpdate	JSONObject
userContext?	Record<string, any>

Returns

Promise<{ metadata: JSONObject; status: "OK"; }>

Variables

clearUserMetadata()

const clearUserMetadata: (userId, userContext?) => Promise<{
  status: "OK";
}> = Wrapper.clearUserMetadata;

Defined in: recipe/usermetadata/index.ts:50

Parameters

Parameter	Type
userId	string
userContext?	Record<string, any>

Returns

Promise<{ status: "OK"; }>

getUserMetadata()

const getUserMetadata: (userId, userContext?) => Promise<{
  metadata: any;
  status: "OK";
}> = Wrapper.getUserMetadata;

Defined in: recipe/usermetadata/index.ts:48

Parameters

Parameter	Type
userId	string
userContext?	Record<string, any>

Returns

Promise<{ metadata: any; status: "OK"; }>

init()

const init: (config?) => RecipeListFunction = Wrapper.init;

Defined in: recipe/usermetadata/index.ts:47

Parameters

Parameter	Type
config?	TypeInput

Returns

RecipeListFunction

updateUserMetadata()

const updateUserMetadata: (userId, metadataUpdate, userContext?) => Promise<{
  metadata: JSONObject;
  status: "OK";
}> = Wrapper.updateUserMetadata;

Defined in: recipe/usermetadata/index.ts:49

Parameters

Parameter	Type
userId	string
metadataUpdate	JSONObject
userContext?	Record<string, any>

Returns

Promise<{ metadata: JSONObject; status: "OK"; }>

References

JSONObject

Re-exports JSONObject

RecipeInterface

Re-exports RecipeInterface