Constructor
# new Collection(id, token)
Parameters:
| Name | Type | Description |
|---|---|---|
id |
String | The id of the collection. |
token |
String | The very private collection token. |
- Source:
Methods
# (static) createNewCollection(params) → {Promise.<(Collection|Error)>}
creates a new image collection.
Parameters:
| Name | Type | Description |
|---|---|---|
params |
NewCollection | of course the new collection parameters. See NewCollection |
- Source:
Returns:
- Type
- Promise.<(Collection|Error)>
# editCollection(params)
Edits the collection.
Parameters:
| Name | Type | Description |
|---|---|---|
params |
EditCollection | The parameters for the collection edit. See EditCollection. |
- Source:
# fetchMeta() → {Promise.<(CollectionMeta|Error)>}
Fetches the meta data of the collection.
- Source:
Returns:
An instance of
CollectionMeta class.
- Type
- Promise.<(CollectionMeta|Error)>
# getId() → {String}
Get the ID of the collection.
- Source:
Returns:
ID of the collection.
- Type
- String
# getToken() → {String|null}
Get the token of the collection (if any).
- Source:
Returns:
The token of the collection, if none returns null.
- Type
- String | null