com.kontakt.sdk.android.http.interfaces

Interface ConfigurationApiAccessor

All Known Subinterfaces:

IKontaktApiClient

All Known Implementing Classes:

KontaktApiClient

public interface ConfigurationApiAccessor

Configuration API accessor provides interface for Configs Profiles management.

Method Summary

Modifier and Type	Method and Description
HttpResult<ICloudConfig>	createCloudConfig(ConfigData configData) Creates cloud config.
void	createCloudConfig(ConfigData configData, ResultApiCallback<ICloudConfig> apiCallback) Create cloud config.
HttpResult<IConfig>	createConfig(ConfigData configData) Creates config.
void	createConfig(ConfigData configData, ResultApiCallback<IConfig> apiCallback) Create config.
HttpResult<ICloudConfig>	getCloudConfigForDevice(java.lang.String beaconUniqueId) Gets cloud config for device.
void	getCloudConfigForDevice(java.lang.String beaconUniqueId, ResultApiCallback<ICloudConfig> apiCallback) Gets cloud config for device.
HttpResult<ICloudConfig>	getCloudConfigForDevice(java.lang.String beaconUniqueId, SDKOptional<ETag> eTag) Gets cloud config for beacon.
void	getCloudConfigForDevice(java.lang.String beaconUniqueId, SDKOptional<ETag> eTag, ResultApiCallback<ICloudConfig> apiCallback) Gets cloud config for device.
HttpResult<IConfig>	getConfigForDevice(java.lang.String beaconUniqueId) Gets config for device.
void	getConfigForDevice(java.lang.String beaconUniqueId, ResultApiCallback<IConfig> apiCallback) Gets config for device.
HttpResult<IConfig>	getConfigForDevice(java.lang.String beaconUniqueId, SDKOptional<ETag> eTag) Gets config for beacon by beacon unique Id sending ETag's value in request newHeader additionally.
void	getConfigForDevice(java.lang.String beaconUniqueId, SDKOptional<ETag> etag, ResultApiCallback<IConfig> apiCallback) Gets config for device.
HttpResult<IPreset>	getPreset(java.lang.String profileName) Gets preset.
void	getPreset(java.lang.String profileName, ResultApiCallback<IPreset> apiCallback) Gets preset.
HttpResult<IPreset>	getPreset(java.lang.String profileName, SDKOptional<ETag> eTag) Requests profile by its name.
void	getPreset(java.lang.String profileName, SDKOptional<ETag> etag, ResultApiCallback<IPreset> apiCallback) Gets preset.
HttpResult<java.util.List<IPreset>>	getPresets() Gets presets.
void	getPresets(ResultApiCallback<java.util.List<IPreset>> apiCallback) Gets presets.
HttpResult<java.util.List<IPreset>>	getPresets(SDKOptional<ETag> eTag) Requests profiles sending ETag's value in request newHeader additionally.
void	getPresets(SDKOptional<ETag> eTag, ResultApiCallback<java.util.List<IPreset>> apiCallback) Gets presets.
HttpResult<java.util.List<ICloudConfig>>	listCloudConfigs() List cloud configs.
HttpResult<java.util.List<ICloudConfig>>	listCloudConfigs(RequestDescription requestDescription) List cloud configs.
void	listCloudConfigs(RequestDescription requestDescription, ResultApiCallback<java.util.List<ICloudConfig>> apiCallback) List cloud configs.
void	listCloudConfigs(ResultApiCallback<java.util.List<ICloudConfig>> apiCallback) List cloud configs.
HttpResult<java.util.List<IConfig>>	listConfigs() List configs.
HttpResult<java.util.List<IConfig>>	listConfigs(RequestDescription requestDescription) Gets config sending ETag's value in request newHeader additionally.
void	listConfigs(RequestDescription requestDescription, ResultApiCallback<java.util.List<IConfig>> apiCallback) List configs.
void	listConfigs(ResultApiCallback<java.util.List<IConfig>> apiCallback) List configs.
HttpResult<java.util.List<SecureSingleConfig>>	listSecureConfigs(java.util.Collection<java.lang.String> uniqueId, SDKOptional<ETag> eTag) Lists secure configs to apply on beacons with provided unique ids
void	listSecureConfigs(java.util.Collection<java.lang.String> uniqueId, SDKOptional<ETag> eTag, ResultApiCallback<java.util.List<SecureSingleConfig>> apiCallback) Lists secure configs to apply on beacons with provided unique ids
HttpResult<java.util.List<SecureSingleConfig>>	listSecureConfigs(RequestDescription requestDescription) Lists secure configs to apply on beacon
void	listSecureConfigs(RequestDescription requestDescription, ResultApiCallback<java.util.List<SecureSingleConfig>> apiCallback) Lists secure configs to apply on beacon
HttpResult<java.util.List<SecureSingleConfig>>	listSecureConfigs(SDKOptional<ETag> etag) Lists secure configs to apply on beacon
void	listSecureConfigs(SDKOptional<ETag> eTag, ResultApiCallback<java.util.List<SecureSingleConfig>> apiCallback) Lists secure configs to apply on beacon

Methods inherited from interface java.io.Closeable

close

Method Detail

listConfigs

HttpResult<java.util.List<IConfig>> listConfigs(RequestDescription requestDescription)
                                         throws ClientException

Gets config sending ETag's value in request newHeader additionally. If the ETag's value matches the latest one the code 304 is returned.

Parameters:

requestDescription - the request description

Returns:

the config

Throws:

ClientException - the client exception

listConfigs

HttpResult<java.util.List<IConfig>> listConfigs()
                                         throws ClientException

List configs.

Returns:

the http result

Throws:

ClientException - the client exception

listConfigs

void listConfigs(RequestDescription requestDescription,
                 ResultApiCallback<java.util.List<IConfig>> apiCallback)

List configs.

Parameters:

requestDescription - the request description

apiCallback - the api callback

listConfigs

void listConfigs(ResultApiCallback<java.util.List<IConfig>> apiCallback)

List configs.

Parameters:

apiCallback - the api callback

listCloudConfigs

HttpResult<java.util.List<ICloudConfig>> listCloudConfigs(RequestDescription requestDescription)
                                                   throws ClientException

List cloud configs.

Parameters:

requestDescription - the request description

Returns:

the http result

Throws:

ClientException - the client exception

listCloudConfigs

HttpResult<java.util.List<ICloudConfig>> listCloudConfigs()
                                                   throws ClientException

List cloud configs.

Returns:

the http result

Throws:

ClientException - the client exception

listCloudConfigs

void listCloudConfigs(RequestDescription requestDescription,
                      ResultApiCallback<java.util.List<ICloudConfig>> apiCallback)

List cloud configs.

Parameters:

requestDescription - the request description

apiCallback - the api callback

listCloudConfigs

void listCloudConfigs(ResultApiCallback<java.util.List<ICloudConfig>> apiCallback)

List cloud configs.

Parameters:

apiCallback - the api callback

getConfigForDevice

HttpResult<IConfig> getConfigForDevice(java.lang.String beaconUniqueId,
                                       SDKOptional<ETag> eTag)
                                throws ClientException

Gets config for beacon by beacon unique Id sending ETag's value in request newHeader additionally. If the ETag's value matches the latest one the code 304 is returned.

Parameters:

beaconUniqueId - the beacon unique id

eTag - the ETag optional

Returns:

the config for beacon

Throws:

ClientException - the client exception

getConfigForDevice

HttpResult<IConfig> getConfigForDevice(java.lang.String beaconUniqueId)
                                throws ClientException

Gets config for device.

Parameters:

beaconUniqueId - the beacon unique id

Returns:

the config for device

Throws:

ClientException - the client exception

getConfigForDevice

void getConfigForDevice(java.lang.String beaconUniqueId,
                        SDKOptional<ETag> etag,
                        ResultApiCallback<IConfig> apiCallback)

Gets config for device.

Parameters:

beaconUniqueId - the beacon unique id

etag - the etag

apiCallback - the api callback

getConfigForDevice

void getConfigForDevice(java.lang.String beaconUniqueId,
                        ResultApiCallback<IConfig> apiCallback)

Gets config for device.

Parameters:

beaconUniqueId - the beacon unique id

apiCallback - the api callback

getCloudConfigForDevice

HttpResult<ICloudConfig> getCloudConfigForDevice(java.lang.String beaconUniqueId,
                                                 SDKOptional<ETag> eTag)
                                          throws ClientException

Gets cloud config for beacon.

Parameters:

beaconUniqueId - the beacon unique id

eTag - the e tag

Returns:

the cloud config for beacon

Throws:

ClientException - the client exception

getCloudConfigForDevice

HttpResult<ICloudConfig> getCloudConfigForDevice(java.lang.String beaconUniqueId)
                                          throws ClientException

Gets cloud config for device.

Parameters:

beaconUniqueId - the beacon unique id

Returns:

the cloud config for device

Throws:

ClientException - the client exception

getCloudConfigForDevice

void getCloudConfigForDevice(java.lang.String beaconUniqueId,
                             SDKOptional<ETag> eTag,
                             ResultApiCallback<ICloudConfig> apiCallback)

Gets cloud config for device.

Parameters:

beaconUniqueId - the beacon unique id

eTag - the e tag

apiCallback - the api callback

getCloudConfigForDevice

void getCloudConfigForDevice(java.lang.String beaconUniqueId,
                             ResultApiCallback<ICloudConfig> apiCallback)

Gets cloud config for device.

Parameters:

beaconUniqueId - the beacon unique id

apiCallback - the api callback

createConfig

HttpResult<IConfig> createConfig(ConfigData configData)
                          throws ClientException

Creates config.

Parameters:

configData - the config data

Returns:

the result

Throws:

ClientException - is thrown if unexpected error occurs

createConfig

void createConfig(ConfigData configData,
                  ResultApiCallback<IConfig> apiCallback)

Create config.

Parameters:

configData - the config data

apiCallback - the api callback

createCloudConfig

HttpResult<ICloudConfig> createCloudConfig(ConfigData configData)
                                    throws ClientException

Creates cloud config.

Parameters:

configData - the config data

Returns:

the Http Status code

Throws:

ClientException - thrown if unexpected error occurs

createCloudConfig

void createCloudConfig(ConfigData configData,
                       ResultApiCallback<ICloudConfig> apiCallback)

Create cloud config.

Parameters:

configData - the config data

apiCallback - the api callback

getPresets

HttpResult<java.util.List<IPreset>> getPresets(SDKOptional<ETag> eTag)
                                        throws ClientException

Requests profiles sending ETag's value in request newHeader additionally. If the ETag's value matches the latest one the code 304 is returned.

Parameters:

eTag - the e tag

Returns:

the profiles

Throws:

ClientException - the client exception

getPresets

HttpResult<java.util.List<IPreset>> getPresets()
                                        throws ClientException

Gets presets.

Returns:

the presets

Throws:

ClientException - the client exception

getPresets

void getPresets(SDKOptional<ETag> eTag,
                ResultApiCallback<java.util.List<IPreset>> apiCallback)

Gets presets.

Parameters:

eTag - the e tag

apiCallback - the api callback

getPresets

void getPresets(ResultApiCallback<java.util.List<IPreset>> apiCallback)

Gets presets.

Parameters:

apiCallback - the api callback

getPreset

HttpResult<IPreset> getPreset(java.lang.String profileName,
                              SDKOptional<ETag> eTag)
                       throws ClientException

Requests profile by its name. If the ETag's value matches the latest one the code 304 is returned.

Parameters:

profileName - the profile name

eTag - the e tag

Returns:

the profile

Throws:

ClientException - the client exception

getPreset

HttpResult<IPreset> getPreset(java.lang.String profileName)
                       throws ClientException

Gets preset.

Parameters:

profileName - the profile name

Returns:

the preset

Throws:

ClientException - the client exception

getPreset

void getPreset(java.lang.String profileName,
               SDKOptional<ETag> etag,
               ResultApiCallback<IPreset> apiCallback)

Gets preset.

Parameters:

profileName - the profile name

etag - the etag

apiCallback - the api callback

getPreset

void getPreset(java.lang.String profileName,
               ResultApiCallback<IPreset> apiCallback)

Gets preset.

Parameters:

profileName - the profile name

apiCallback - the api callback

listSecureConfigs

HttpResult<java.util.List<SecureSingleConfig>> listSecureConfigs(RequestDescription requestDescription)
                                                          throws ClientException

Lists secure configs to apply on beacon

Parameters:

requestDescription - - request description

Returns:

List of configs to be applied

Throws:

ClientException

listSecureConfigs

void listSecureConfigs(RequestDescription requestDescription,
                       ResultApiCallback<java.util.List<SecureSingleConfig>> apiCallback)

Lists secure configs to apply on beacon

Parameters:

requestDescription - request description

apiCallback - api callback to receive list of configs to be applied

listSecureConfigs

HttpResult<java.util.List<SecureSingleConfig>> listSecureConfigs(SDKOptional<ETag> etag)
                                                          throws ClientException

Lists secure configs to apply on beacon

Parameters:

etag - Optional param, use SDKOptional.absent() instead of null value

Returns:

List of configs to be applied

Throws:

ClientException

listSecureConfigs

void listSecureConfigs(SDKOptional<ETag> eTag,
                       ResultApiCallback<java.util.List<SecureSingleConfig>> apiCallback)

Lists secure configs to apply on beacon

Parameters:

eTag - Optional param, use SDKOptional.absent() instead of null value

apiCallback - api callback to receive list of secure configs

listSecureConfigs

HttpResult<java.util.List<SecureSingleConfig>> listSecureConfigs(java.util.Collection<java.lang.String> uniqueId,
                                                                 SDKOptional<ETag> eTag)
                                                          throws ClientException

Lists secure configs to apply on beacons with provided unique ids

Parameters:

uniqueId - collection of unique ids

eTag - Optional param, use SDKOptional.absent() instead of null value

Returns:

List of configs to be applied

Throws:

ClientException

listSecureConfigs

void listSecureConfigs(java.util.Collection<java.lang.String> uniqueId,
                       SDKOptional<ETag> eTag,
                       ResultApiCallback<java.util.List<SecureSingleConfig>> apiCallback)

Lists secure configs to apply on beacons with provided unique ids

Parameters:

uniqueId - collection of unique ids

eTag - Optional param, use SDKOptional.absent() instead of null value

apiCallback - api callback to receive list of secure configs