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; ifnull
then add metadata to the requesting userReturns:
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; ifnull
then add metadata to the requesting userReturns:
the URL
- Type
- string
-
findUserMetadataUrl(filter)
-
Generate a URL for viewing the configured user's metadata via a
GET
request.Parameters:
Name Type Description filter
module:domain~UserMetadataFilter the search criteria
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; ifnull
then add metadata to the requesting userReturns:
the URL
- Type
- string
-
viewUserMetadataUrl( [userId])
-
Generate a URL for viewing a specific user's metadata via a
GET
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; ifnull
then view metadata of the requesting userReturns:
the URL
- Type
- string