TypedRest for .NET 1.3.5
build type-safe fluent-style REST API clients
TypedRest.Endpoints.Generic.CollectionEndpoint< TEntity, TElementEndpoint > Class Template Reference

Endpoint for a collection of TEntity s addressable as TElementEndpoint s. More...

Inheritance diagram for TypedRest.Endpoints.Generic.CollectionEndpoint< TEntity, TElementEndpoint >:
TypedRest.Endpoints.Generic.CachingEndpointBase TypedRest.Endpoints.Generic.ICollectionEndpoint< TEntity, TElementEndpoint > TypedRest.Endpoints.EndpointBase TypedRest.Endpoints.ICachingEndpoint TypedRest.Endpoints.IEndpoint TypedRest.Endpoints.IEndpoint TypedRest.Endpoints.Reactive.StreamingCollectionEndpoint< TEntity, TElementEndpoint >

Public Member Functions

 CollectionEndpoint (IEndpoint referrer, Uri relativeUri)
 Creates a new element collection endpoint. More...
 
 CollectionEndpoint (IEndpoint referrer, string relativeUri)
 Creates a new element collection endpoint. More...
 
virtual async Task< List< TEntity > > ReadAllAsync (CancellationToken cancellationToken=default)
 
virtual async Task< PartialResponse< TEntity > > ReadRangeAsync (RangeItemHeaderValue range, CancellationToken cancellationToken=default)
 
virtual async ITask< TElementEndpoint?> CreateAsync (TEntity entity, CancellationToken cancellationToken=default)
 
virtual async Task CreateAllAsync (IEnumerable< TEntity > entities, CancellationToken cancellationToken=default)
 
async Task SetAllAsync (IEnumerable< TEntity > entities, CancellationToken cancellationToken=default)
 
- Public Member Functions inherited from TypedRest.Endpoints.EndpointBase
void SetDefaultLink (string rel, string? href)
 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. More...
 
void SetDefaultLinkTemplate (string rel, string? href)
 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. More...
 
IReadOnlyList<(Uri uri, string? title)> GetLinks (string rel)
 Resolves all links with a specific relation type. Uses cached data from last response. More...
 
Uri Link (string rel)
 Resolves a single link with a specific relation type. Uses cached data from last response if possible. Tries lazy lookup with HTTP HEAD on cache miss. More...
 
UriTemplate GetLinkTemplate (string rel)
 Retrieves a link template with a specific relation type. Prefer IEndpoint.LinkTemplate(string,object) when possible. More...
 
Uri LinkTemplate (string rel, IDictionary< string, object > variables)
 Resolves a link template with a specific relation type. Uses cached data from last response if possible. Tries lazy lookup with HTTP HEAD on cache miss. More...
 
Uri LinkTemplate (string rel, object variables)
 Resolves a link template with a specific relation type. More...
 
override string ToString ()
 
- Public Member Functions inherited from TypedRest.Endpoints.Generic.ICollectionEndpoint< TEntity, TElementEndpoint >
Task< List< TEntity > > ReadAllAsync (CancellationToken cancellationToken=default)
 Returns all TEntity s in the collection. More...
 
Task< PartialResponse< TEntity > > ReadRangeAsync (RangeItemHeaderValue range, CancellationToken cancellationToken=default)
 Returns all TEntity s within a specific range of the collection. More...
 
ITask< TElementEndpoint?> CreateAsync (TEntity entity, CancellationToken cancellationToken=default)
 Adds a TEntity as a new element to the collection. More...
 
Task CreateAllAsync (IEnumerable< TEntity > entities, CancellationToken cancellationToken=default)
 Adds (or updates) multiple TEntity s as elements in the collection. More...
 
Task SetAllAsync (IEnumerable< TEntity > entities, CancellationToken cancellationToken=default)
 Replaces the entire content of the collection with new TEntity s. More...
 

Protected Member Functions

override void HandleCapabilities (HttpResponseMessage response)
 Handles allowed HTTP methods and other capabilities reported by the server. More...
 
- Protected Member Functions inherited from TypedRest.Endpoints.Generic.CachingEndpointBase
 CachingEndpointBase (IEndpoint referrer, Uri relativeUri)
 Creates a new endpoint with a relative URI. More...
 
 CachingEndpointBase (IEndpoint referrer, string relativeUri)
 Creates a new endpoint with a relative URI. More...
 
async Task< HttpContent > GetContentAsync (CancellationToken cancellationToken, [CallerMemberName] string caller="unknown")
 Performs an HTTP GET request on the IEndpoint.Uri and caches the response if the server sends an HttpResponseHeaders.ETag. More...
 
async Task< HttpResponseMessage > PutContentAsync (HttpContent content, CancellationToken cancellationToken, [CallerMemberName] string caller="unknown")
 Performs an HttpMethod.Put request on the IEndpoint.Uri. Sets HttpRequestHeaders.IfMatch if there is a cached HttpResponseHeader.ETag to detect lost updates. More...
 
async Task< HttpResponseMessage > DeleteContentAsync (CancellationToken cancellationToken, [CallerMemberName] string caller="unknown")
 Performs an HttpMethod.Delete request on the IEndpoint.Uri. Sets HttpRequestHeaders.IfMatch if there is a cached ETag to detect lost updates. More...
 
- Protected Member Functions inherited from TypedRest.Endpoints.EndpointBase
 EndpointBase (Uri uri, HttpClient httpClient, MediaTypeFormatter serializer, IErrorHandler errorHandler, ILinkExtractor linkExtractor)
 Creates a new endpoint with an absolute URI. More...
 
 EndpointBase (IEndpoint referrer, Uri relativeUri)
 Creates a new endpoint with a relative URI. More...
 
 EndpointBase (IEndpoint referrer, string relativeUri)
 Creates a new endpoint with a relative URI. More...
 
virtual async Task< HttpResponseMessage > HandleAsync (Func< Task< HttpResponseMessage > > request, [CallerMemberName] string caller="unknown")
 Handles various cross-cutting concerns regarding a response message such as discovering links and handling errors. More...
 
Activity? StartActivity ([CallerMemberName] string caller="unknown")
 Starts a new Activity if there is any listener registered (e.g. OpenTelemetry), returns null otherwise. More...
 
bool? IsMethodAllowed (HttpMethod method)
 Shows whether the server has indicated that a specific HTTP method is currently allowed. More...
 

Properties

virtual TElementEndpoint this[string id] [get]
 
virtual TElementEndpoint this[TEntity entity] [get]
 
bool? ReadAllAllowed [get]
 
string RangeUnit = "elements" [getset]
 The value used for RangeHeaderValue.Unit.
 
bool? ReadRangeAllowed [get]
 
bool? CreateAllowed [get]
 
bool? CreateAllAllowed [get]
 
bool? SetAllAllowed [get]
 
- Properties inherited from TypedRest.Endpoints.Generic.CachingEndpointBase
ResponseCacheResponseCache [getset]
 
- Properties inherited from TypedRest.Endpoints.EndpointBase
Uri Uri [get]
 
HttpClient HttpClient [get]
 
MediaTypeFormatter Serializer [get]
 
IErrorHandler ErrorHandler [get]
 
ILinkExtractor LinkExtractor [get]
 
- Properties inherited from TypedRest.Endpoints.IEndpoint
Uri Uri [get]
 The HTTP URI of the remote resource.
 
HttpClient HttpClient [get]
 The HTTP client used to communicate with the remote resource.
 
MediaTypeFormatter Serializer [get]
 Controls the serialization of entities sent to and received from the server.
 
IErrorHandler ErrorHandler [get]
 Handles errors in responses.
 
ILinkExtractor LinkExtractor [get]
 Extracts links from responses.
 
- Properties inherited from TypedRest.Endpoints.ICachingEndpoint
ResponseCacheResponseCache [getset]
 A cached copy of the last response.
 
- Properties inherited from TypedRest.Endpoints.Generic.ICollectionEndpoint< TEntity, TElementEndpoint >
TElementEndpoint this[TEntity entity] [get]
 Returns an ElementEndpoint<TEntity> for a specific child element. More...
 
bool? ReadAllAllowed [get]
 Shows whether the server has indicated that ReadAllAsync is currently allowed. More...
 
bool? ReadRangeAllowed [get]
 Shows whether the server has indicated that ReadRangeAsync is allowed. More...
 
bool? CreateAllowed [get]
 Shows whether the server has indicated that CreateAsync(TEntity,CancellationToken) is currently allowed. More...
 
bool? CreateAllAllowed [get]
 Shows whether the server has indicated that CreateAllAllowed is currently allowed. More...
 
bool? SetAllAllowed [get]
 Shows whether the server has indicated that SetAllAllowed is currently allowed. More...
 

Additional Inherited Members

- Static Protected Member Functions inherited from TypedRest.Endpoints.EndpointBase
static Func< IEndpoint, Uri, TEndpoint > GetConstructor< TEndpoint > ()
 Returns a constructor for TEndpoint as a function with a referrer an a relative URI as input. More...
 

Detailed Description

Endpoint for a collection of TEntity s addressable as TElementEndpoint s.

Template Parameters
TEntityThe type of individual elements in the collection.
TElementEndpointThe type of IElementEndpoint<TEntity> to provide for individual TEntity s. Must have a public constructor with an IEndpoint and an Uri or string parameter.
Type Constraints
TEntity :class 
TElementEndpoint :class 
TElementEndpoint :IElementEndpoint<TEntity> 

Constructor & Destructor Documentation

◆ CollectionEndpoint() [1/2]

TypedRest.Endpoints.Generic.CollectionEndpoint< TEntity, TElementEndpoint >.CollectionEndpoint ( IEndpoint  referrer,
Uri  relativeUri 
)
inline

Creates a new element collection endpoint.

Parameters
referrerThe endpoint used to navigate to this one.
relativeUriThe URI of this endpoint relative to the referrer 's.

◆ CollectionEndpoint() [2/2]

TypedRest.Endpoints.Generic.CollectionEndpoint< TEntity, TElementEndpoint >.CollectionEndpoint ( IEndpoint  referrer,
string  relativeUri 
)
inline

Creates a new element collection endpoint.

Parameters
referrerThe endpoint used to navigate to this one.
relativeUriThe URI of this endpoint relative to the referrer 's. Add a ./ prefix here to imply a trailing slash referrer 's URI.

Member Function Documentation

◆ HandleCapabilities()

override void TypedRest.Endpoints.Generic.CollectionEndpoint< TEntity, TElementEndpoint >.HandleCapabilities ( HttpResponseMessage  response)
inlineprotectedvirtual

Handles allowed HTTP methods and other capabilities reported by the server.

Reimplemented from TypedRest.Endpoints.EndpointBase.


The documentation for this class was generated from the following file: