Interface ICollectionEndpoint<TEntity, TElementEndpoint>

Namespace

TypedRest.Endpoints.Generic

Assembly

TypedRest.dll

Endpoint for a collection of TEntitys addressable as TElementEndpoints.

public interface ICollectionEndpoint<TEntity, out TElementEndpoint> : IIndexerEndpoint<TElementEndpoint>, IEndpoint where TEntity : class where TElementEndpoint : IElementEndpoint<TEntity>

Type Parameters

TEntity

The type of individual elements in the collection.

TElementEndpoint

The type of IElementEndpoint<TEntity> to provide for individual TEntitys.

Inherited Members

IIndexerEndpoint<TElementEndpoint>.this[string]

IEndpoint.Uri

IEndpoint.HttpClient

IEndpoint.Serializers

IEndpoint.ErrorHandler

IEndpoint.LinkExtractor

IEndpoint.GetLinks(string)

IEndpoint.Link(string)

IEndpoint.LinkTemplate(string, IDictionary<string, object>)

IEndpoint.LinkTemplate(string, object)

Extension Methods

CollectionEndpointExtensions.ContainsAsync<TEntity, TElementEndpoint>(ICollectionEndpoint<TEntity, TElementEndpoint>, TEntity, CancellationToken)

CollectionEndpointExtensions.DeleteAsync<TEntity, TElementEndpoint>(ICollectionEndpoint<TEntity, TElementEndpoint>, TEntity, CancellationToken)

CollectionEndpointExtensions.MergeAsync<TEntity, TElementEndpoint>(ICollectionEndpoint<TEntity, TElementEndpoint>, TEntity, CancellationToken)

CollectionEndpointExtensions.SetAsync<TEntity, TElementEndpoint>(ICollectionEndpoint<TEntity, TElementEndpoint>, TEntity, CancellationToken)

CollectionEndpointExtensions.ContainsAsync<TElementEndpoint>(IIndexerEndpoint<TElementEndpoint>, string, CancellationToken)

CollectionEndpointExtensions.DeleteAsync<TElementEndpoint>(IIndexerEndpoint<TElementEndpoint>, string, CancellationToken)

Remarks

Use the more constrained ICollectionEndpoint<TEntity> when possible.

Properties

CreateAllAllowed

Shows whether the server has indicated that CreateAllAllowed is currently allowed.

bool? CreateAllAllowed { get; }

Property Value

bool?

An indicator whether the verb is allowed. If no request has been sent yet or the server did not specify allowed verbs null is returned.

Remarks

Uses cached data from last response.

CreateAllowed

Shows whether the server has indicated that CreateAsync(TEntity, CancellationToken) is currently allowed.

bool? CreateAllowed { get; }

Property Value

bool?

true if the method is allowed, false if the method is not allowed, null If no request has been sent yet or the server did not specify allowed methods.

Remarks

Uses cached data from last response.

this[TEntity]

Returns an ElementEndpoint<TEntity> for a specific child element.

TElementEndpoint this[TEntity entity] { get; }

Parameters

entity TEntity

An existing entity to extract the ID from.

Property Value

TElementEndpoint

ReadAllAllowed

Shows whether the server has indicated that ReadAllAsync(CancellationToken) is currently allowed.

bool? ReadAllAllowed { get; }

Property Value

bool?

true if the method is allowed, false if the method is not allowed, null If no request has been sent yet or the server did not specify allowed methods.

Remarks

Uses cached data from last response.

ReadRangeAllowed

Shows whether the server has indicated that ReadRangeAsync(RangeItemHeaderValue, CancellationToken) is allowed.

bool? ReadRangeAllowed { get; }

Property Value

bool?

An indicator whether the method is allowed. If no request has been sent yet.

Remarks

Uses cached data from last response.

SetAllAllowed

Shows whether the server has indicated that SetAllAllowed is currently allowed.

bool? SetAllAllowed { get; }

Property Value

bool?

An indicator whether the verb is allowed. If no request has been sent yet or the server did not specify allowed verbs null is returned.

Remarks

Uses cached data from last response.

Methods

CreateAllAsync(IEnumerable<TEntity>, CancellationToken)

Adds (or updates) multiple entities as elements in the collection.

Task CreateAllAsync(IEnumerable<TEntity> entities, CancellationToken cancellationToken = default)

Parameters

entities IEnumerable<TEntity>

The entities to create or modify.

cancellationToken CancellationToken

Used to cancel the request.

Returns

Task

Remarks

Uses a link with the relation type bulk to determine the URI to POST to. Defaults to the relative URI bulk.

Exceptions

InvalidDataException

BadRequest

AuthenticationException

Unauthorized

UnauthorizedAccessException

Forbidden

InvalidOperationException

Conflict

HttpRequestException

Other non-success status code.

CreateAsync(TEntity, CancellationToken)

Adds a entity as a new element to the collection.

ITask<out TElementEndpoint?> CreateAsync(TEntity entity, CancellationToken cancellationToken = default)

Parameters

entity TEntity

The new entity.

cancellationToken CancellationToken

Used to cancel the request.

Returns

ITask<TElementEndpoint>

An endpoint for the newly created entity; null if the server returned neither a "Location" header nor an entity with an ID in the response body.

Exceptions

InvalidDataException

BadRequest

AuthenticationException

Unauthorized

UnauthorizedAccessException

Forbidden

InvalidOperationException

Conflict

HttpRequestException

Other non-success status code.

ReadAllAsync(CancellationToken)

Returns all entities in the collection.

Task<List<TEntity>> ReadAllAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Used to cancel the request.

Returns

Task<List<TEntity>>

Exceptions

AuthenticationException

Unauthorized

UnauthorizedAccessException

Forbidden

KeyNotFoundException

NotFound or Gone

HttpRequestException

Other non-success status code.

ReadRangeAsync(RangeItemHeaderValue, CancellationToken)

Returns all entities within a specific range of the collection.

Task<PartialResponse<TEntity>> ReadRangeAsync(RangeItemHeaderValue range, CancellationToken cancellationToken = default)

Parameters

range RangeItemHeaderValue

The range of entities to retrieve.

cancellationToken CancellationToken

Used to cancel the request.

Returns

Task<PartialResponse<TEntity>>

A subset of the entities and the range they come from. May not exactly match the request range.

Exceptions

AuthenticationException

Unauthorized

UnauthorizedAccessException

Forbidden

KeyNotFoundException

NotFound or Gone

InvalidOperationException

The requested range is not satisfiable.

HttpRequestException

Other non-success status code.

SetAllAsync(IEnumerable<TEntity>, CancellationToken)

Replaces the entire content of the collection with new entities.

Task SetAllAsync(IEnumerable<TEntity> entities, CancellationToken cancellationToken = default)

Parameters

entities IEnumerable<TEntity>

The new set of entities the collection shall contain.

cancellationToken CancellationToken

Used to cancel the request.

Returns

Task

Exceptions

InvalidDataException

BadRequest

AuthenticationException

Unauthorized

UnauthorizedAccessException

Forbidden

InvalidOperationException

The entities have changed since they were last retrieved with ReadAllAsync(CancellationToken). Your changes were rejected to prevent a lost update.

HttpRequestException

Other non-success status code.