com.contentful.java.cma

Class ModuleTags

java.lang.Object

com.contentful.java.cma.ModuleTags

public class ModuleTags
extends Object

Content tags Module.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ModuleTags.Async	async()
CMATag	create(String environmentId, String spaceId, String tagId, String name, CMAVisibility visibility) Create an tag using the given tag id.
protected com.contentful.java.cma.ServiceContentTags	createService(retrofit2.Retrofit retrofit)
Integer	delete(String spaceId, String environmentId, String tagId) Delete an tag.
CMAArray<CMATag>	fetchAll() Fetch all tags of the configured space.
CMAArray<CMATag>	fetchAll(String spaceId, String environmentId, Map<String,String> query) Fetch all tag of the given space with query
CMATag	fetchOne(String tagId) Fetch a tag with a given environmentId from the configured space.
CMATag	fetchOne(String spaceId, String environmentId, String tagId) Fetch a tag with a given environmentId and space.
CMATag	update(String name, String tagId) Update a tag.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleTags

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

Create tags 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.ServiceContentTags createService(retrofit2.Retrofit retrofit)

create

public CMATag create(String environmentId,
                     String spaceId,
                     String tagId,
                     String name,
                     CMAVisibility visibility)

Create an tag using the given tag id.

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

Returns:

CMATag result instance

Throws:

IllegalArgumentException - if space id is null.

delete

public Integer delete(String spaceId,
                      String environmentId,
                      String tagId)

Delete an tag.

Returns:

Integer representing the result (204, or an error code)

Throws:

IllegalArgumentException - if environment's space id is null.

IllegalArgumentException - if tag's id is null.

fetchAll

public CMAArray<CMATag> fetchAll()

Fetch all tags of the configured space.

Returns:

CMAArray result instance

Throws:

IllegalArgumentException - if configured space id is null.

See Also:

CMAClient.Builder.setSpaceId(String)

fetchAll

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

Fetch all tag of the given space with query

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

Parameters:

spaceId - space ID

Returns:

CMAArray result instance

Throws:

IllegalArgumentException - if environment's space id is null.

fetchOne

public CMATag fetchOne(String tagId)

Fetch a tag with a given environmentId from the configured space.

Parameters:

tagId - tag ID

Returns:

CMATag result instance

Throws:

IllegalArgumentException - if the configured space id is null.

IllegalArgumentException - if environment's id is null.

See Also:

CMAClient.Builder.setSpaceId(String)

fetchOne

public CMATag fetchOne(String spaceId,
                       String environmentId,
                       String tagId)

Fetch a tag with a given environmentId and space.

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

Parameters:

spaceId - space ID

environmentId - environment ID

Returns:

CMATag result instance

Throws:

IllegalArgumentException - if space id is null.

IllegalArgumentException - if environment's id is null.

update

public CMATag update(String name,
                     String tagId)

Update a tag.

Returns:

CMATag result instance

Throws:

IllegalArgumentException - if tag's name is null.

IllegalArgumentException - if tag's id is null.

async

public ModuleTags.Async async()

Returns:

a module with a set of asynchronous methods.