CollectionApi 1.0.0-beta.9 API


public final class CollectionApi

Constructor Summary

Constructors
Constructor	Description
`CollectionApi(KtorClient api)`

Method Summary

Modifier and Type	Method	Description
`final Response<Unit>`	`addToCollection(UUID collectionId, List<UUID> ids)`	Adds items to a collection.
`final Response<CollectionCreationResult>`	`createCollection(String name, List<String> ids, UUID parentId, Boolean isLocked)`	Creates a new collection.
`final Response<Unit>`	`removeFromCollection(UUID collectionId, List<UUID> ids)`	Removes items from a collection.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CollectionApi
```
CollectionApi(KtorClient api)
```
- Method Detail
  - addToCollection
```
 final Response<Unit> addToCollection(UUID collectionId, List<UUID> ids)
```
    Adds items to a collection.
    
    Parameters:
    
    collectionId - The collection id.
    
    ids - Item ids, comma delimited.
  - createCollection
```
 final Response<CollectionCreationResult> createCollection(String name, List<String> ids, UUID parentId, Boolean isLocked)
```
    Creates a new collection.
    
    Parameters:
    
    name - The name of the collection.
    
    ids - Item Ids to add to the collection.
    
    parentId - Optional.
    
    isLocked - Whether or not to lock the new collection.
  - removeFromCollection
```
 final Response<Unit> removeFromCollection(UUID collectionId, List<UUID> ids)
```
    Removes items from a collection.
    
    Parameters:
    
    collectionId - The collection id.
    
    ids - Item ids, comma delimited.