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)
String	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 a query.
CMAAsset	fetchOne(String spaceId, String assetId) Fetch an Asset with the given assetId from a Space.
String	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

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

delete

public String delete(String spaceId,
                     String assetId)

Delete an Asset.

Parameters:

spaceId - Space ID

assetId - Asset ID

Returns:

A string representing the result of the delete operation

fetchAll

public CMAArray<CMAAsset> fetchAll(String spaceId)

Fetch all Assets from a Space.

Parameters:

spaceId - Space ID

Returns:

CMAArray result instance

fetchAll

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

Fetch all Assets from a Space with a query.

Parameters:

spaceId - Space ID

query - Query

Returns:

CMAArray result instance

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

process

public String process(CMAAsset asset,
                      String locale)

Process an Asset.

Parameters:

asset - Asset

locale - Locale

Returns:

String representing the success (203) of processing

publish

public CMAAsset publish(CMAAsset asset)

Publish an Asset.

Parameters:

asset - Asset

Returns:

CMAAsset result instance

unArchive

public CMAAsset unArchive(CMAAsset asset)

Un-Archive an Asset.

Parameters:

asset - Asset

Returns:

CMAAsset result instance

unPublish

public CMAAsset unPublish(CMAAsset asset)

Un-Publish an Asset.

Parameters:

asset - Asset

Returns:

CMAAsset result instance

update

public CMAAsset update(CMAAsset asset)

Update an Asset.

Parameters:

asset - Asset

Returns:

CMAAsset result instance

async

public ModuleAssets.Async async()

Returns:

a module with a set of asynchronous methods.