TypedRest for .NET 1.3.6
build type-safe fluent-style REST API clients
TypedRest.Endpoints.Reactive.IStreamingCollectionEndpoint< TEntity, out out TElementEndpoint > Interface Template Reference

Endpoint for a collection of TEntity s observable as an append-only stream. More...

Inheritance diagram for TypedRest.Endpoints.Reactive.IStreamingCollectionEndpoint< TEntity, out out TElementEndpoint >:
TypedRest.Endpoints.Generic.ICollectionEndpoint< TEntity, TElementEndpoint >

Public Member Functions

IObservable< TEntity > GetObservable (long startIndex=0)
 Provides an observable stream of elements. The observable is cold; HTTP communication only starts on IObservable<T>.Subscribe. More...
 
- 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...
 

Additional Inherited Members

- 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...
 

Detailed Description

Endpoint for a collection of TEntity s observable as an append-only stream.

Use the more constrained IStreamingCollectionEndpoint<TEntity> when possible.

Template Parameters
TEntityThe type of entity the endpoint represents.
TElementEndpointThe type of IEndpoint to provide for individual TEntity s.
Type Constraints
TEntity :class 
TElementEndpoint :IElementEndpoint<TEntity> 

Member Function Documentation

◆ GetObservable()

IObservable< TEntity > TypedRest.Endpoints.Reactive.IStreamingCollectionEndpoint< TEntity, out out TElementEndpoint >.GetObservable ( long  startIndex = 0)

Provides an observable stream of elements. The observable is cold; HTTP communication only starts on IObservable<T>.Subscribe.

Parameters
startIndexThe index of the first element to return in the stream. Use negative values to start counting from the end of the stream.

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