The type of individual elements in the collection.
Creates a new collection endpoint.
The endpoint used to navigate to this one.
The URI of this endpoint relative to the referrer's. Add a ./ prefix here to imply a trailing slash in the referrer's URI.
Handles errors in responses.
The HTTP client used to communicate with the remote resource.
Extracts links from responses.
A cached copy of the last response.
Controls the serialization of entities sent to and received from the server.
The HTTP URI of the remote resource.
Shows whether the server has indicated that createAll is currently allowed. Uses cached data from last response.
true if the method is allowed, false if the method is not allowed, undefined if no request has been sent yet or the server did not specify allowed methods.
Shows whether the server has indicated that create is currently allowed. Uses cached data from last response.
true if the method is allowed, false if the method is not allowed, undefined if no request has been sent yet or the server did not specify allowed methods.
Shows whether the server has indicated that readAll is currently allowed. Uses cached data from last response.
true if the method is allowed, false if the method is not allowed, undefined if no request has been sent yet or the server did not specify allowed methods.
Shows whether the server has indicated that setAll is currently allowed. Uses cached data from last response.
true if the method is allowed, false if the method is not allowed, undefined if no request has been sent yet or the server did not specify allowed methods.
Determines whether the collection contains a specific element.
The ID identifying the entity or an entity to extract the ID from.
Adds a TEntity as a new element to the collection.
The new TEntity.
Used to cancel the request.
An endpoint for the newly created entity; undefined if the server returned neither a "Location" header nor an entity with an ID in the response body.
Adds (or updates) multiple TEntitys as elements in the collection.
The TEntitys to create or modify.
Used to cancel the request.
Deletes an existing element from the collection.
The ID identifying the entity or an entity to extract the ID from.
Performs an HttpMethod.Delete request on the uri. Sets HttpHeader.IfMatch if there is a cached HttpHeader.ETag to detect lost updates.
Used to cancel the request.
Returns an TElementEndpoint for a specific child element.
The ID identifying the entity or an entity to extract the ID from.
Performs an HttpMethod.Put request on the uri and caches the response if the server sends an HttpHeader.ETag.
Used to cancel the request.
Retrieves a link template with a specific relation type. Uses cached data from last response. Prefer linkTemplate when possible.
The relation type of the link template to look for.
Resolves all links with a specific relation type. Uses cached data from last response.
The relation type of the links to look for.
Handles various cross-cutting concerns regarding a response message such as discovering links and handling errors.
The response to process.
Handles allowed HTTP methods and other capabilities reported by the server.
Shows whether the server has indicated that a specific HTTP method is currently allowed. Uses cached data from last response.
The HTTP methods (e.g. GET, POST, ...) to check.
true if the method is allowed, false if the method is not allowed, undefined if no request has been sent yet or the server did not specify allowed methods.
Resolves a relative URI using this endpoint's URI as the base.
The relative URI to resolve. Prepend ./ to imply a trailing slash in the base URI even if it is missing there.
Resolves a single link with a specific relation type. Uses cached data from last response.
The relation type of the link to look for.
Resolves a link template with a specific relation type. Uses cached data from last response.
The relation type of the link template to look for.
Variables for resolving the template.
Modifies an existing element in the collection by merging changes on the server-side.
The TEntity data to merge with the existing element.
The TEntity as returned by the server, possibly with additional fields set. undefined if the server does not respond with a result entity.
Performs an HttpMethod.Put request on the uri. Sets HttpHeader.IfMatch if there is a cached HttpHeader.ETag to detect lost updates.
Used to cancel the request.
Returns all TEntitys in the collection.
Used to cancel the request.
Sends an HTTP request to this endpoint's URI. Handles various cross-cutting concerns regarding a response message such as discovering links and handling errors.
The HTTP method to use.
Used to cancel the request.
The HTTP headers to set.
The body to send.
Sets/replaces an existing element in the collection.
The new state of the element.
The TEntity as returned by the server, possibly with additional fields set. undefined if the server does not respond with a result entity.
Replaces the entire content of the collection with new TEntitys.
The TEntitys to create or modify.
Registers one or more default links for a specific relation type. These links are used when no links with this relation type are provided by the server. This should only be called during initial setup of the endpoint.
The relation type of the link to add.
The href of the link relative to this endpoint's URI. Leave unspecified to remove any previous entries for the relation type.
Registers a default link template for a specific relation type. This template is used when no template with this relation type is provided by the server. This should only be called during initial setup of the endpoint.
Adds a trailing slash to the URI if it does not already have one.
Generated using TypeDoc
Endpoint for a collection of
TEntitys addressable asElementEndpoint<TEntity>s.Use GenericCollectionEndpoint instead if you wish to customize the element endpoint type.