Mixin: UserMetadataUrlHelperMixin

net~ UserMetadataUrlHelperMixin

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

Methods


addUserMetadataUrl( [userId])

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

Parameters:
Name Type Argument Description
userId number | 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

Returns:

the URL

Type
string

deleteUserMetadataUrl( [userId])

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

Parameters:
Name Type Argument Description
userId number | 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

Returns:

the URL

Type
string

replaceUserMetadataUrl( [userId])

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

Parameters:
Name Type Argument Description
userId number | 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

Returns:

the URL

Type
string

viewUserMetadataUrl( [userId])

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

Parameters:
Name Type Argument Description
userId number | Array.<number> | null <optional>

a specific user ID (or set of IDs); if not provided the userIds property of this class will be used; if null then get the metadata for the requesting user

Returns:

the URL

Type
string