Methods
-
addNodeMetadataUrl( [nodeId])
-
Generate a URL for adding metadata to a node via a
POST
request.Parameters:
Name Type Argument Description nodeId
number <optional>
a specific node ID to use; if not provided the
nodeId
property of this class will be usedReturns:
the URL
- Type
- string
-
deleteNodeMetadataUrl( [nodeId])
-
Generate a URL for deleting the metadata of a node via a
DELETE
request.Parameters:
Name Type Argument Description nodeId
number <optional>
a specific node ID to use; if not provided the
nodeId
property of this class will be usedReturns:
the URL
- Type
- string
-
findNodeMetadataUrl( [nodeId] [, sorts] [, pagination])
-
Generate a URL for searching for node metadata.
Parameters:
Name Type Argument Description nodeId
number | Array.<number> <optional>
a specific node ID, or array of node IDs, to use; if not provided the
nodeIds
property of this class will be used, unlessnull
is passed in which case no node IDs will be added to the URL so that all available node metadata objects will be returnedsorts
Array.<module:domain~SortDescriptor> <optional>
optional sort settings to use
pagination
module:domain~Pagination <optional>
optional pagination settings to use
Returns:
the URL
- Type
- string
-
replaceNodeMetadataUrl( [nodeId])
-
Generate a URL for setting the metadata of a node via a
PUT
request.Parameters:
Name Type Argument Description nodeId
number <optional>
a specific node ID to use; if not provided the
nodeId
property of this class will be usedReturns:
the URL
- Type
- string
-
viewNodeMetadataUrl( [nodeId])
-
Generate a URL for viewing the configured node's metadata.
Parameters:
Name Type Argument Description nodeId
number <optional>
a specific node ID to use; if not provided the
nodeId
property of this class will be usedReturns:
the URL
- Type
- string