com.kontakt.sdk.android.cloud.api

Class ConfigsApi

java.lang.Object

com.kontakt.sdk.android.cloud.api.ConfigsApi

public class ConfigsApi
extends java.lang.Object

An abstract representation of Configs API endpoint. Provides executors that can be used to handle all config-related requests.

Constructor Summary

Constructors

Constructor and Description
ConfigsApi(ConfigsService configsService) Constructs Configs API endpoint initialized with corresponding service class.

Method Summary

Modifier and Type	Method and Description
CreateConfigRequestExecutor	create(Config config) Provides executor that can be used to create new config.
DeletePendingConfigsRequestExecutor	delete(java.util.List<java.lang.String> uniqueIds) Provides executor that can be used to delete pending configs.
DeletePendingConfigsRequestExecutor	delete(java.lang.String... uniqueIds) Provides executor that can be used to delete pending configs.
ConfigsRequestExecutor	fetch() Provides executor that can be used to obtain configs.
ReadAllRequestExecutor	readAll() Provides executor that can be used to obtain READ_ALL secure command.
SecureConfigsRequestExecutor	secure() Provides executor that can be used to obtain secure configs.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigsApi

public ConfigsApi(ConfigsService configsService)

Constructs Configs API endpoint initialized with corresponding service class.

Parameters:

configsService - the configs API service.

Method Detail

fetch

public ConfigsRequestExecutor fetch()

Provides executor that can be used to obtain configs.

Returns:

the request executor.

secure

public SecureConfigsRequestExecutor secure()

Provides executor that can be used to obtain secure configs.

Returns:

the request executor.

readAll

public ReadAllRequestExecutor readAll()

Provides executor that can be used to obtain READ_ALL secure command.

Returns:

the request executor.

create

public CreateConfigRequestExecutor create(Config config)

Provides executor that can be used to create new config.

Parameters:

config - the new config.

Returns:

the request executor.

delete

public DeletePendingConfigsRequestExecutor delete(java.lang.String... uniqueIds)

Provides executor that can be used to delete pending configs.

Parameters:

uniqueIds - config unique identifiers.

Returns:

the request executor.

delete

public DeletePendingConfigsRequestExecutor delete(java.util.List<java.lang.String> uniqueIds)

Provides executor that can be used to delete pending configs.

Parameters:

uniqueIds - config unique identifiers.

Returns:

the request executor.