Streaming Collection endpoint

Endpoint for a collection of entities observable as an append-only stream using long-polling.

Method	Input	Result	HTTP Verb	Description
Get observable	-	Entity stream	GET	Provides an observable stream of elements.
Get	ID / Entity	Endpoint	-	Get an Element endpoint for a specific child element.
Read all	-	Entities	GET	Returns all entities in the collection.
Read range	Range	Entities	GET	Returns all entities within a specific range of the collection.
Create	Entity	-	POST	Adds an entity as a new element to the collection.
Create All	Entities	-	PATCH	Adds (or updates) multiple entities as elements in the collection.
Set All	Entities	-	PUT	Replaces the entire content of the collection with new entities.

Extends Collection endpoint

Usage

C#JavaKotlin

var messages = new StreamingCollectionEndpoint<Message>(client, "messages");

// Subscribe to new messages
IObservable<Message> stream = messages.GetObservable();
stream.Subscribe(m => Console.WriteLine($"New message: {m.Text}"));

// Use as regular collection endpoint
List<Message> all = await messages.ReadAllAsync();
await messages.CreateAsync(new Message { Text = "Hello!" });

You can also configure CollectionEndpoint to use a custom type derived from ElementEndpoint for elements.

var messages = new StreamingCollectionEndpoint<Message, MessageEndpoint>(client, "messages");

StreamingCollectionEndpoint<Message> messages = new StreamingCollectionEndpointImpl<>(client, "messages", Message.class);

// Subscribe to new messages
Observable<Message> stream = messages.getObservable();
stream.subscribe(x -> System.out.println("New message: " + x.getText()));

// Use as regular collection endpoint
List<Message> all = messages.readAll();
messages.create(new Message("Hello!"));

You can also use GenericStreamingCollectionEndpointImpl to use a custom type derived from ElementEndpoint for elements.

GenericStreamingCollectionEndpoint<Message, MessageEndpoint> messages = new GenericStreamingCollectionEndpointImpl<>(client, "messages", Message.class, (ref, uri) -> new MessageEndpoint(ref, uri));

val messages = StreamingCollectionEndpointImpl(client, "messages", Message::class.java)

// Subscribe to new messages
val stream = messages.getObservable()
stream.subscribe { x -> println("New message: ${x.text}") }

// Use as regular collection endpoint
val all = messages.readAll()
messages.create(Message("Hello!"))

You can also use `GenericStreamingCollectionEndpointImpl` to use a custom type derived from `ElementEndpoint` for [elements](../generic/element.md).

```kotlin
val messages = GenericStreamingCollectionEndpoint(client, "messages", Message::class.java, ::MessageEndpoint)