com.contentful.java.cma

Class ModuleUiExtensions

java.lang.Object

com.contentful.java.cma.ModuleUiExtensions

public final class ModuleUiExtensions
extends Object

Ui Extensions Module.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ModuleUiExtensions(retrofit2.Retrofit retrofit, Executor callbackExecutor) Create this module.

Method Summary

Modifier and Type	Method and Description
ModuleUiExtensions.Async	async()
CMAUiExtension	create(String spaceId, CMAUiExtension extension) Create a new ui extension.
protected com.contentful.java.cma.ServiceUiExtensions	createService(retrofit2.Retrofit retrofit)
Integer	delete(CMAUiExtension extension) Delete a ui extension.
CMAArray<CMAUiExtension>	fetchAll(String spaceId) Fetch ui extensions from a given space.
CMAArray<CMAUiExtension>	fetchAll(String spaceId, Map<String,String> query) Fetch all ui extensions from a given space.
CMAUiExtension	fetchOne(String spaceId, String extensionId)
CMAUiExtension	update(CMAUiExtension extension) Update a ui extension.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleUiExtensions

public ModuleUiExtensions(retrofit2.Retrofit retrofit,
                          Executor callbackExecutor)

Create this module.

Parameters:

retrofit - the retrofit instance to be used to create the service.

callbackExecutor - to tell on which thread it should run.

Method Detail

createService

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

fetchOne

public CMAUiExtension fetchOne(String spaceId,
                               String extensionId)

Parameters:

spaceId - the id of the space this is valid on.

extensionId - the id of the extension to be fetched.

Returns:

the ui extension for a specific space.

Throws:

IllegalArgumentException - if spaceId is null.

IllegalArgumentException - if extensionId is null.

fetchAll

public CMAArray<CMAUiExtension> fetchAll(String spaceId)

Fetch ui extensions from a given space.

Parameters:

spaceId - the id of the space this is valid on.

Returns:

all the ui extensions for a specific space.

Throws:

IllegalArgumentException - if spaceId is null.

fetchAll

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

Fetch all ui extensions from a given space.

Parameters:

spaceId - the id of the space this is valid on.

query - controls what to return.

Returns:

specific ui extensions for a specific space.

Throws:

IllegalArgumentException - if spaceId is null.

update

public CMAUiExtension update(CMAUiExtension extension)

Update a ui extension.

Parameters:

extension - the ui extension to be updated.

Returns:

the updated ui extension.

Throws:

IllegalArgumentException - if extension is null.

IllegalArgumentException - if extension's version is null.

IllegalArgumentException - if extension's id is null.

IllegalArgumentException - if extension's spaceId is null.

delete

public Integer delete(CMAUiExtension extension)

Delete a ui extension.

Parameters:

extension - the extension to be deleted.

Returns:

the http code of the action.

Throws:

IllegalArgumentException - if extension is null.

IllegalArgumentException - if extension's id is null.

IllegalArgumentException - if extension's version is null.

IllegalArgumentException - if extension's spaceId is null.

create

public CMAUiExtension create(String spaceId,
                             CMAUiExtension extension)

Create a new ui extension.

Parameters:

spaceId - the id of the space this ui extension should be created in.

extension - the ui extension to be added.

Returns:

the created ui extension.

Throws:

IllegalArgumentException - if spaceId is null.

IllegalArgumentException - if extension is null.

IllegalArgumentException - if extension's id is null.

IllegalArgumentException - if extension's version is null.

IllegalArgumentException - if extension's spaceId is null.

async

public ModuleUiExtensions.Async async()

Returns:

a module with a set of asynchronous methods.