com.contentful.java.cma

Class ModuleOrganizations

java.lang.Object

com.contentful.java.cma.ModuleOrganizations

public final class ModuleOrganizations
extends java.lang.Object

Organizations Module.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ModuleOrganizations(retrofit2.Retrofit retrofit, java.util.concurrent.Executor callbackExecutor, boolean environmentIdConfigured) Create the organizations module.

Method Summary

Modifier and Type	Method and Description
ModuleOrganizations.Async	async()
protected com.contentful.java.cma.ServiceOrganizations	createService(retrofit2.Retrofit retrofit)
CMAArray<CMAOrganization>	fetchAll() Fetch all organizations the token has access to.
CMAArray<CMAOrganization>	fetchAll(java.util.Map<java.lang.String,java.lang.String> query) Fetch specific organizations the token has access to.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleOrganizations

public ModuleOrganizations(retrofit2.Retrofit retrofit,
                           java.util.concurrent.Executor callbackExecutor,
                           boolean environmentIdConfigured)

Create the organizations module.

Parameters:

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

callbackExecutor - to tell on which thread it should run.

environmentIdConfigured - internal helper to see if environment was set.

Method Detail

createService

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

fetchAll

public CMAArray<CMAOrganization> fetchAll()

Fetch all organizations the token has access to.

Returns:

CMAOrganization result instance

fetchAll

public CMAArray<CMAOrganization> fetchAll(java.util.Map<java.lang.String,java.lang.String> query)

Fetch specific organizations the token has access to.

Parameters:

query - the criteria to narrow down the search result.

Returns:

CMAOrganization result instance

async

public ModuleOrganizations.Async async()

Returns:

a module with a set of asynchronous methods.