com.bynder.sdk.service

Interface AssetBankService

All Known Implementing Classes:

AssetBankServiceImpl

public interface AssetBankService

Interface to represent operations that can be done to the Bynder Asset Bank.

Method Summary

Modifier and Type	Method and Description
io.reactivex.Observable<retrofit2.Response<Usage>>	createUsage(UsageCreateQuery usageCreateQuery) Creates a usage record for a media asset.
io.reactivex.Observable<retrofit2.Response<Void>>	deleteMedia(MediaDeleteQuery mediaDeleteQuery) Deletes a media asset.
io.reactivex.Observable<retrofit2.Response<Void>>	deleteUsage(UsageDeleteQuery usageDeleteQuery) Deletes a usage record of a media asset.
io.reactivex.Observable<retrofit2.Response<List<Brand>>>	getBrands() Get Brands.
io.reactivex.Observable<retrofit2.Response<DownloadUrl>>	getMediaDownloadUrl(MediaDownloadQuery mediaDownloadQuery) Gets the download file URL for a specific media asset file.
io.reactivex.Observable<retrofit2.Response<Media>>	getMediaInfo(MediaInfoQuery mediaInfoQuery) Gets all the information for a specific media.
io.reactivex.Observable<retrofit2.Response<List<Media>>>	getMediaList(MediaQuery mediaQuery) Gets a list of media using query information.
io.reactivex.Observable<retrofit2.Response<Map<String,Metaproperty>>>	getMetaproperties(MetapropertyQuery metapropertyQuery) Get Metaproperties.
io.reactivex.Observable<retrofit2.Response<List<Smartfilter>>>	getSmartfilters() Get Smartfilters.
io.reactivex.Observable<retrofit2.Response<List<Tag>>>	getTags() Get Tags.
io.reactivex.Observable<retrofit2.Response<List<Usage>>>	getUsage(UsageQuery usageQuery) Gets all the media assets usage records.
io.reactivex.Observable<retrofit2.Response<Void>>	setMediaProperties(MediaPropertiesQuery mediaPropertiesQuery) Updates the properties of a media asset.
io.reactivex.Observable<SaveMediaResponse>	uploadFile(UploadQuery uploadQuery) Uploads a file with the information specified in the query parameter.
io.reactivex.Observable<UploadProgress>	uploadFileWithProgress(UploadQuery uploadQuery) Uploads a file with Progress Report.

Method Detail

getBrands

io.reactivex.Observable<retrofit2.Response<List<Brand>>> getBrands()

Get Brands.

Returns:

Observable with list of Brand.

getTags

io.reactivex.Observable<retrofit2.Response<List<Tag>>> getTags()

Get Tags.

Returns:

Observable with list of Tag.

getMetaproperties

io.reactivex.Observable<retrofit2.Response<Map<String,Metaproperty>>> getMetaproperties(MetapropertyQuery metapropertyQuery)
                                                                                 throws IllegalAccessException

Get Metaproperties.

Parameters:

metapropertyQuery - Information about if media count should be included in the metaproperty options or not.

Returns:

Observable with Map of String, Metaproperty key/value pairs.

Throws:

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

getMediaList

io.reactivex.Observable<retrofit2.Response<List<Media>>> getMediaList(MediaQuery mediaQuery)
                                                               throws IllegalAccessException

Gets a list of media using query information.

Parameters:

mediaQuery - Information to correctly filter/paginate media.

Returns:

Observable with list of Media.

Throws:

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

getMediaInfo

io.reactivex.Observable<retrofit2.Response<Media>> getMediaInfo(MediaInfoQuery mediaInfoQuery)
                                                         throws IllegalAccessException

Gets all the information for a specific media. This is needed to get the media items of a media asset.

Parameters:

mediaInfoQuery - Information about the media we want to get the information from.

Returns:

Observable with Media information.

Throws:

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

setMediaProperties

io.reactivex.Observable<retrofit2.Response<Void>> setMediaProperties(MediaPropertiesQuery mediaPropertiesQuery)
                                                              throws IllegalAccessException

Updates the properties of a media asset.

Parameters:

mediaPropertiesQuery - Information with the media asset properties new values to be updated.

Returns:

Observable with the request Response information.

Throws:

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

deleteMedia

io.reactivex.Observable<retrofit2.Response<Void>> deleteMedia(MediaDeleteQuery mediaDeleteQuery)
                                                       throws IllegalAccessException

Deletes a media asset.

Parameters:

mediaDeleteQuery - Information to identify the media asset we want to delete.

Returns:

Observable with the request Response information.

Throws:

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

getMediaDownloadUrl

io.reactivex.Observable<retrofit2.Response<DownloadUrl>> getMediaDownloadUrl(MediaDownloadQuery mediaDownloadQuery)

Gets the download file URL for a specific media asset file. If the media item id was not specified, it will return the download URL of the media specified by media id.

Parameters:

mediaDownloadQuery - Information with the media we want to get the URL from.

Returns:

Observable with the DownloadUrl information of the media asset file.

createUsage

io.reactivex.Observable<retrofit2.Response<Usage>> createUsage(UsageCreateQuery usageCreateQuery)
                                                        throws IllegalAccessException

Creates a usage record for a media asset.

Parameters:

usageCreateQuery - Information about the asset usage we want to create.

Returns:

Observable with Usage information.

Throws:

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

getUsage

io.reactivex.Observable<retrofit2.Response<List<Usage>>> getUsage(UsageQuery usageQuery)
                                                           throws IllegalAccessException

Gets all the media assets usage records.

Parameters:

usageQuery - Information about the asset usage we want to get the information from.

Returns:

Observable with list of Usage.

Throws:

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

deleteUsage

io.reactivex.Observable<retrofit2.Response<Void>> deleteUsage(UsageDeleteQuery usageDeleteQuery)
                                                       throws IllegalAccessException

Deletes a usage record of a media asset.

Parameters:

usageDeleteQuery - Information about the asset usage we want to delete.

Returns:

Observable with the request Response information.

Throws:

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

getSmartfilters

io.reactivex.Observable<retrofit2.Response<List<Smartfilter>>> getSmartfilters()

Get Smartfilters.

Returns:

Observable with List of Smartfilter;

uploadFile

io.reactivex.Observable<SaveMediaResponse> uploadFile(UploadQuery uploadQuery)

Uploads a file with the information specified in the query parameter.

Parameters:

uploadQuery - Upload query with the information to upload the file.

Returns:

Observable with the SaveMediaResponse information.

uploadFileWithProgress

io.reactivex.Observable<UploadProgress> uploadFileWithProgress(UploadQuery uploadQuery)

Uploads a file with Progress Report.

Parameters:

uploadQuery - Upload query with the information to upload the file.

Returns:

Observable with the UploadProgress information.