com.contentful.java.cma

Class ModuleEditorInterfaces

java.lang.Object

com.contentful.java.cma.ModuleEditorInterfaces

public class ModuleEditorInterfaces
extends Object

Editor Interfaces Module.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ModuleEditorInterfaces(retrofit2.Retrofit retrofit, Executor callbackExecutor, String spaceId, String environmentId, boolean environmentIdConfigured) Create this module.

Method Summary

Modifier and Type	Method and Description
ModuleEditorInterfaces.Async	async()
protected com.contentful.java.cma.ServiceEditorInterfaces	createService(retrofit2.Retrofit retrofit)
CMAEditorInterface	fetchOne(String contentTypeId) Return an editor interface by id using the configured space and environment.
CMAEditorInterface	fetchOne(String spaceId, String environmentId, String contentTypeId) Get the editor interface by id, using the given space and environment.
CMAEditorInterface	update(CMAEditorInterface editor) Update an editor interface.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleEditorInterfaces

public ModuleEditorInterfaces(retrofit2.Retrofit retrofit,
                              Executor callbackExecutor,
                              String spaceId,
                              String environmentId,
                              boolean environmentIdConfigured)

Create this module.

Parameters:

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

callbackExecutor - to tell on which thread it should run.

spaceId - the space to be used when not given.

environmentId - the environment to be used when not given.

environmentIdConfigured - internal helper to see if environment was set.

Method Detail

createService

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

fetchOne

public CMAEditorInterface fetchOne(String contentTypeId)

Return an editor interface by id using the configured space and environment.

Parameters:

contentTypeId - the contentTypeId this editor interface is valid on.

Returns:

the editor interface for a specific content type on a specific space.

Throws:

IllegalArgumentException - if configured space id is null.

IllegalArgumentException - if configured environment id is null.

IllegalArgumentException - if content type id is null.

See Also:

CMAClient.Builder.setSpaceId(String), CMAClient.Builder.setEnvironmentId(String)

fetchOne

public CMAEditorInterface fetchOne(String spaceId,
                                   String environmentId,
                                   String contentTypeId)

Get the editor interface by id, using the given space and environment.

This method will override the configuration specified through CMAClient.Builder.setSpaceId(String) and CMAClient.Builder.setEnvironmentId(String).

Parameters:

spaceId - the id of the space this environment is part of.

environmentId - the id of the environment this editor interface is valid on.

contentTypeId - the contentTypeId this editor interface is valid on.

Returns:

the editor interface for a specific content type on a specific space.

Throws:

IllegalArgumentException - if space id is null.

IllegalArgumentException - if environment id is null.

IllegalArgumentException - if content type id is null.

update

public CMAEditorInterface update(CMAEditorInterface editor)

Update an editor interface.

Parameters:

editor - the editor interface to be updated on Contentful.

Returns:

the updated editor interface.

Throws:

IllegalArgumentException - if editors spaceId is null.

IllegalArgumentException - if editors contentType is null.

IllegalArgumentException - if editors contentTypeId is null.

IllegalArgumentException - if editors version is not set.

async

public ModuleEditorInterfaces.Async async()

Returns:

a module with a set of asynchronous methods.