com.contentful.java.cma

Class ModuleAssets

java.lang.Object

com.contentful.java.cma.ModuleAssets

public final class ModuleAssets
extends Object

Assets Module.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ModuleAssets.Async Async module.

Constructor Summary

Constructors

Constructor and Description
ModuleAssets(retrofit2.Retrofit retrofit, Executor callbackExecutor)

Method Summary

Modifier and Type	Method and Description
CMAAsset	archive(CMAAsset asset) Archive an Asset.
ModuleAssets.Async	async()
CMAAsset	create(String spaceId, CMAAsset asset) Create a new Asset.
protected com.contentful.java.cma.ServiceAssets	createService(retrofit2.Retrofit retrofit)
Integer	delete(String spaceId, String assetId) Delete an Asset.
CMAArray<CMAAsset>	fetchAll(String spaceId) Fetch all Assets from a Space.
CMAArray<CMAAsset>	fetchAll(String spaceId, Map<String,String> query) Fetch all Assets from a Space with query parameter.
CMAAsset	fetchOne(String spaceId, String assetId) Fetch an Asset with the given assetId from a Space.
Integer	process(CMAAsset asset, String locale) Process an Asset.
CMAAsset	publish(CMAAsset asset) Publish an Asset.
CMAAsset	unArchive(CMAAsset asset) Un-Archive an Asset.
CMAAsset	unPublish(CMAAsset asset) Un-Publish an Asset.
CMAAsset	update(CMAAsset asset) Update an Asset.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModuleAssets

public ModuleAssets(retrofit2.Retrofit retrofit,
                    Executor callbackExecutor)

Method Detail

createService

protected com.contentful.java.cma.ServiceAssets createService(retrofit2.Retrofit retrofit)

archive

public CMAAsset archive(CMAAsset asset)

Archive an Asset.

Parameters:

asset - Asset

Returns:

CMAAsset result instance

Throws:

IllegalArgumentException - if asset is null.

IllegalArgumentException - if asset id is null.

IllegalArgumentException - if asset space id is null.

create

public CMAAsset create(String spaceId,
                       CMAAsset asset)

Create a new Asset. In case the given asset has an ID associated with it, that ID will be used, otherwise the server will auto-generate an ID that will be contained in the response upon success.

Parameters:

spaceId - Space ID

asset - Asset

Returns:

CMAAsset result instance

Throws:

IllegalArgumentException - if asset is null.

IllegalArgumentException - if asset space id is null.

delete

public Integer delete(String spaceId,
                      String assetId)

Delete an Asset.

Parameters:

spaceId - Space ID

assetId - Asset ID

Returns:

An integer representing the result of the delete operation

Throws:

IllegalArgumentException - if spaceId is null.

IllegalArgumentException - if assetId is null.

fetchAll

public CMAArray<CMAAsset> fetchAll(String spaceId)

Fetch all Assets from a Space.

This fetch uses the default parameter defined in DefaultQueryParameter.FETCH

Parameters:

spaceId - Space ID

Returns:

CMAArray result instance

Throws:

IllegalArgumentException - if spaceId is null.

fetchAll

public CMAArray<CMAAsset> fetchAll(String spaceId,
                                   Map<String,String> query)

Fetch all Assets from a Space with query parameter.

Parameters:

spaceId - Space ID

query - specifying details about which assets to fetch.

Returns:

CMAArray result instance

Throws:

IllegalArgumentException - if spaceId is null.

fetchOne

public CMAAsset fetchOne(String spaceId,
                         String assetId)

Fetch an Asset with the given assetId from a Space.

Parameters:

spaceId - Space ID

assetId - Asset ID

Returns:

CMAAsset result instance

Throws:

IllegalArgumentException - if spaceId is null.

IllegalArgumentException - if assetId is null.

process

public Integer process(CMAAsset asset,
                       String locale)

Process an Asset.

Parameters:

asset - Asset

locale - Locale

Returns:

integer representing the success (204 = no content) of processing

Throws:

IllegalArgumentException - if asset is null.

IllegalArgumentException - if asset has no id.

IllegalArgumentException - if asset has no space.

IllegalArgumentException - if locale is null.

publish

public CMAAsset publish(CMAAsset asset)

Publish an Asset.

Parameters:

asset - Asset

Returns:

CMAAsset result instance

Throws:

IllegalArgumentException - if asset is null.

IllegalArgumentException - if asset has no id.

IllegalArgumentException - if asset has no space id.

unArchive

public CMAAsset unArchive(CMAAsset asset)

Un-Archive an Asset.

Parameters:

asset - Asset

Returns:

CMAAsset result instance

Throws:

IllegalArgumentException - if asset is null.

IllegalArgumentException - if asset id is empty.

IllegalArgumentException - if asset's space id is empty.

unPublish

public CMAAsset unPublish(CMAAsset asset)

Un-Publish an Asset.

Parameters:

asset - Asset

Returns:

CMAAsset result instance

Throws:

IllegalArgumentException - if asset is null.

IllegalArgumentException - if asset's id is not set.

IllegalArgumentException - if asset's space id is not set.

update

public CMAAsset update(CMAAsset asset)

Update an Asset.

Parameters:

asset - Asset

Returns:

CMAAsset result instance

Throws:

IllegalArgumentException - if asset is null.

IllegalArgumentException - if asset's id is null.

IllegalArgumentException - if asset's space id is null.

IllegalArgumentException - if asset's version is null.

async

public ModuleAssets.Async async()

Returns:

a module with a set of asynchronous methods.