com.bynder.sdk.service

Interface CollectionService

All Known Implementing Classes:

CollectionServiceImpl

public interface CollectionService

Interface to represent operations that can be done to the Bynder Collections.

Method Summary

Modifier and Type	Method and Description
io.reactivex.Observable<retrofit2.Response<Void>>	addMediaToCollection(CollectionAddMediaQuery collectionAddMediaQuery) Adds media assets to a collection.
io.reactivex.Observable<retrofit2.Response<Void>>	createCollection(CollectionCreateQuery collectionCreateQuery) Creates a collection.
io.reactivex.Observable<retrofit2.Response<Void>>	deleteCollection(CollectionInfoQuery collectionInfoQuery) Deletes a collection.
io.reactivex.Observable<retrofit2.Response<Collection>>	getCollectionInfo(CollectionInfoQuery collectionInfoQuery) Gets all the information for a specific collection.
io.reactivex.Observable<retrofit2.Response<List<String>>>	getCollectionMediaIds(CollectionInfoQuery collectionInfoQuery) Gets a list of the media assets ids of a collection.
io.reactivex.Observable<retrofit2.Response<List<Collection>>>	getCollections(CollectionQuery collectionQuery) Gets a list of collections using query information.
io.reactivex.Observable<retrofit2.Response<Void>>	removeMediaFromCollection(CollectionRemoveMediaQuery collectionRemoveMediaQuery) Removes media assets from a collection.
io.reactivex.Observable<retrofit2.Response<Void>>	shareCollection(CollectionShareQuery collectionShareQuery) Shares a collection.

Method Detail

getCollections

io.reactivex.Observable<retrofit2.Response<List<Collection>>> getCollections(CollectionQuery collectionQuery)
                                                                      throws IllegalAccessException

Gets a list of collections using query information.

Parameters:

collectionQuery - Information to correctly filter/paginate collections.

Returns:

Observable with list of Collection.

Throws:

IllegalAccessException - Check Utils.convertField(Field, Object, Map) for more information.

getCollectionInfo

io.reactivex.Observable<retrofit2.Response<Collection>> getCollectionInfo(CollectionInfoQuery collectionInfoQuery)
                                                                   throws IllegalAccessException

Gets all the information for a specific collection.

Parameters:

collectionInfoQuery - Information about the collection we want to get the information from.

Returns:

Observable with Collection information.

Throws:

IllegalAccessException - Check Utils.convertField(Field, Object, Map) for more information.

createCollection

io.reactivex.Observable<retrofit2.Response<Void>> createCollection(CollectionCreateQuery collectionCreateQuery)
                                                            throws IllegalAccessException

Creates a collection.

Parameters:

collectionCreateQuery - Information about the collection we want to create.

Returns:

Observable with the request Response information.

Throws:

IllegalAccessException - Check Utils.convertField(Field, Object, Map) for more information.

deleteCollection

io.reactivex.Observable<retrofit2.Response<Void>> deleteCollection(CollectionInfoQuery collectionInfoQuery)
                                                            throws IllegalAccessException

Deletes a collection.

Parameters:

collectionInfoQuery - Information to identify the collection we want to delete.

Returns:

Observable with the request Response information.

Throws:

IllegalAccessException - Check Utils.convertField(Field, Object, Map) for more information.

getCollectionMediaIds

io.reactivex.Observable<retrofit2.Response<List<String>>> getCollectionMediaIds(CollectionInfoQuery collectionInfoQuery)

Gets a list of the media assets ids of a collection.

Parameters:

collectionInfoQuery - Information to identify the collection we want to retrieve media from.

Returns:

Observable with list of media assets ids.

addMediaToCollection

io.reactivex.Observable<retrofit2.Response<Void>> addMediaToCollection(CollectionAddMediaQuery collectionAddMediaQuery)
                                                                throws IllegalAccessException

Adds media assets to a collection.

Parameters:

collectionAddMediaQuery - Information needed to add media to a collection.

Returns:

Observable with the request Response information.

Throws:

IllegalAccessException - Check Utils.convertField(Field, Object, Map) for more information.

removeMediaFromCollection

io.reactivex.Observable<retrofit2.Response<Void>> removeMediaFromCollection(CollectionRemoveMediaQuery collectionRemoveMediaQuery)
                                                                     throws IllegalAccessException

Removes media assets from a collection.

Parameters:

collectionRemoveMediaQuery - Information needed to remove media from a collection.

Returns:

Observable with the request Response information.

Throws:

IllegalAccessException - Check Utils.convertField(Field, Object, Map) for more information.

shareCollection

io.reactivex.Observable<retrofit2.Response<Void>> shareCollection(CollectionShareQuery collectionShareQuery)
                                                           throws IllegalAccessException

Shares a collection.

Parameters:

collectionShareQuery - Information required for sharing a collection.

Returns:

Observable with the request Response information.

Throws:

IllegalAccessException - Check Utils.convertField(Field, Object, Map) for more information.