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)
HttpResult<IConfig>	createConfig(ConfigData configData) Creates config.
void	createConfig(ConfigData configData, ResultApiCallback<IConfig> apiCallback)
HttpResult<ICloudConfig>	getCloudConfigForDevice(java.lang.String beaconUniqueId)
void	getCloudConfigForDevice(java.lang.String beaconUniqueId, ResultApiCallback<ICloudConfig> apiCallback)
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)
HttpResult<IConfig>	getConfigForDevice(java.lang.String beaconUniqueId)
void	getConfigForDevice(java.lang.String beaconUniqueId, ResultApiCallback<IConfig> apiCallback)
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)
HttpResult<IProfile>	getProfile(java.lang.String profileName)
void	getProfile(java.lang.String profileName, ResultApiCallback<IProfile> apiCallback)
HttpResult<IProfile>	getProfile(java.lang.String profileName, SDKOptional<ETag> eTag) Requests profile by its name.
void	getProfile(java.lang.String profileName, SDKOptional<ETag> etag, ResultApiCallback<IProfile> apiCallback)
HttpResult<java.util.List<ICloudConfig>>	listCloudConfigs()
HttpResult<java.util.List<ICloudConfig>>	listCloudConfigs(RequestDescription requestDescription) List cloud configs.
void	listCloudConfigs(RequestDescription requestDescription, ResultApiCallback<java.util.List<ICloudConfig>> apiCallback)
void	listCloudConfigs(ResultApiCallback<java.util.List<ICloudConfig>> apiCallback)
HttpResult<java.util.List<IConfig>>	listConfigs()
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)
void	listConfigs(ResultApiCallback<java.util.List<IConfig>> apiCallback)
HttpResult<java.util.List<IProfile>>	listProfiles()
void	listProfiles(ResultApiCallback<java.util.List<IProfile>> apiCallback)
HttpResult<java.util.List<IProfile>>	listProfiles(SDKOptional<ETag> eTag) Requests profiles sending ETag's value in request newHeader additionally.
void	listProfiles(SDKOptional<ETag> eTag, ResultApiCallback<java.util.List<IProfile>> apiCallback)

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

Throws:

ClientException

listConfigs

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

listConfigs

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

listCloudConfigs

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

List cloud configs.

Returns:

the http result

Throws:

ClientException - the client exception

listCloudConfigs

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

Throws:

ClientException

listCloudConfigs

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

listCloudConfigs

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

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

Throws:

ClientException

getConfigForDevice

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

getConfigForDevice

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

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

Throws:

ClientException

getCloudConfigForDevice

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

getCloudConfigForDevice

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

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)

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)

listProfiles

HttpResult<java.util.List<IProfile>> listProfiles(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

listProfiles

HttpResult<java.util.List<IProfile>> listProfiles()
                                           throws ClientException

Throws:

ClientException

listProfiles

void listProfiles(SDKOptional<ETag> eTag,
                  ResultApiCallback<java.util.List<IProfile>> apiCallback)

listProfiles

void listProfiles(ResultApiCallback<java.util.List<IProfile>> apiCallback)

getProfile

HttpResult<IProfile> getProfile(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

getProfile

HttpResult<IProfile> getProfile(java.lang.String profileName)
                         throws ClientException

Throws:

ClientException

getProfile

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

getProfile

void getProfile(java.lang.String profileName,
                ResultApiCallback<IProfile> apiCallback)