CollectionEndpoint

Endpoint for a collection of TEntitys addressable as ElementEndpoints.

Use GenericCollectionEndpoint instead if you wish to customize the element endpoint type.

TEntity

The type of individual elements in the collection.

Properties

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

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

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

Shows whether the server has indicated that readRange is allowed.

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

Adds an entity as a new element to the collection.

abstract fun createAll(entities: Iterable<TEntity>)

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

abstract operator fun get(entity: TEntity): ElementEndpoint<TEntity>

Returns an ElementEndpoint for a specific child element.

abstract fun readAll(): List<TEntity>

Returns all entities in the collection.

Returns all entities within a specific range of the collection.

abstract fun setAll(entities: Iterable<TEntity>)

Replaces the entire content of the collection with new entities.