net~ UserMetadataUrlHelperMixin

A mixin class that adds user metadata support to module:net~UrlHelper.

Source

Methods

addUserMetadataUrl(userIdopt) → {string}

Generate a URL for adding user metadata via a POST request.

Parameters:
NameTypeAttributesDescription
userIdnumber | null<optional>

a specific user ID; if not provided the userId property of this class will be used; if null then add metadata to the requesting user

Source
Returns:

the URL

Type: 
string

deleteUserMetadataUrl(userIdopt) → {string}

Generate a URL for deleting user metadata via a DELETE request.

Parameters:
NameTypeAttributesDescription
userIdnumber | null<optional>

a specific user ID; if not provided the userId property of this class will be used; if null then add metadata to the requesting user

Source
Returns:

the URL

Type: 
string

findUserMetadataUrl(filter) → {string}

Generate a URL for viewing the configured user's metadata via a GET request.

Parameters:
NameTypeDescription
filtermodule:domain~UserMetadataFilter

the search criteria

Source
Returns:

the URL

Type: 
string

replaceUserMetadataUrl(userIdopt) → {string}

Generate a URL for replacing user metadata via a PUT request.

Parameters:
NameTypeAttributesDescription
userIdnumber | null<optional>

a specific user ID; if not provided the userId property of this class will be used; if null then add metadata to the requesting user

Source
Returns:

the URL

Type: 
string

viewUserMetadataUrl(userIdopt) → {string}

Generate a URL for viewing a specific user's metadata via a GET request.

Parameters:
NameTypeAttributesDescription
userIdnumber | null<optional>

a specific user ID; if not provided the userId property of this class will be used; if null then view metadata of the requesting user

Source
Returns:

the URL

Type: 
string