com.kontakt.sdk.android.http.interfaces

Interface ActionsApiAccessor

All Known Subinterfaces:

IKontaktApiClient

All Known Implementing Classes:

KontaktApiClient

public interface ActionsApiAccessor

Actions API accessor provides interface describing interaction with API and Actions management.

Method Summary

Modifier and Type	Method and Description
HttpResult<IBrowserAction>	createBrowserAction(ActionData actionData) Create browser action.
void	createBrowserAction(ActionData actionData, ResultApiCallback<IBrowserAction> resultApiCallback) Create browser action.
HttpResult<IContentAction>	createContentAction(ActionData actionData, java.io.File contentFile)
void	createContentAction(ActionData actionData, java.io.File contentFile, ResultApiCallback<IContentAction> apiCallback)
int	deleteAction(java.util.UUID actionId) Deletes action.
void	deleteAction(java.util.UUID actionId, UpdateApiCallback apiCallback)
HttpResult<IAction>	getAction(java.util.UUID actionId)
void	getAction(java.util.UUID actionId, ResultApiCallback<IAction> resultApiCallback)
HttpResult<IAction>	getAction(java.util.UUID actionId, SDKOptional<ETag> eTag) Requests action by Id sending ETag in newHeader additionally.
void	getAction(java.util.UUID actionId, SDKOptional<ETag> etag, ResultApiCallback<IAction> resultApiCallback)
HttpResult<FileData>	getActionContent(java.util.UUID actionId, SDKOptional<ETag> eTagOptional) Requests action content.
void	getActionContent(java.util.UUID actionId, SDKOptional<ETag> eTagSDKOptional, ResultApiCallback<FileData> resultApiCallback)
HttpResult<java.util.List<IAction>>	getActionsForDevice(java.lang.String deviceUniqueId) Fetches actions for particular device
void	getActionsForDevice(java.lang.String deviceUniqueId, ResultApiCallback<java.util.List<IAction>> resultApiCallback) Fetches actions for particular device
int	updateAction(java.util.UUID actionId, java.io.File file) Updates Content action with new content of specified file.
void	updateAction(java.util.UUID actionId, java.io.File file, UpdateApiCallback callback)
int	updateAction(java.util.UUID actionId, java.lang.String url) Updates url action
void	updateAction(java.util.UUID actionId, java.lang.String url, UpdateApiCallback callback) Updates url action

Methods inherited from interface java.io.Closeable

close

Method Detail

createContentAction

HttpResult<IContentAction> createContentAction(ActionData actionData,
                                               java.io.File contentFile)
                                        throws ClientException

Parameters:

actionData - ActionData

contentFile - File file to upload

Returns:

ContentAction

Throws:

ClientException

createContentAction

void createContentAction(ActionData actionData,
                         java.io.File contentFile,
                         ResultApiCallback<IContentAction> apiCallback)

Parameters:

actionData - ActionData

contentFile - File file to upload

apiCallback - ResultApiCallback

createBrowserAction

HttpResult<IBrowserAction> createBrowserAction(ActionData actionData)
                                        throws ClientException

Create browser action.

Parameters:

actionData - the action

Returns:

the http result

Throws:

ClientException - the client exception

createBrowserAction

void createBrowserAction(ActionData actionData,
                         ResultApiCallback<IBrowserAction> resultApiCallback)

Create browser action.

Parameters:

actionData - the action

resultApiCallback - ResultApiCallback

getAction

HttpResult<IAction> getAction(java.util.UUID actionId,
                              SDKOptional<ETag> eTag)
                       throws ClientException

Requests action by Id sending ETag in newHeader additionally. If the ETag's value matches the latest one the code 304 (NOT MODIFIED) is returned.

Parameters:

actionId - the action id

eTag - the ETag optional value

Returns:

the action

Throws:

ClientException - the client exception

getAction

HttpResult<IAction> getAction(java.util.UUID actionId)
                       throws ClientException

Parameters:

actionId - UUID of action

Returns:

IAction

Throws:

ClientException

getAction

void getAction(java.util.UUID actionId,
               SDKOptional<ETag> etag,
               ResultApiCallback<IAction> resultApiCallback)

Parameters:

actionId - UUID of action

etag - ETag

resultApiCallback - ResultApiCallback

getAction

void getAction(java.util.UUID actionId,
               ResultApiCallback<IAction> resultApiCallback)

Parameters:

actionId - UUID of action

resultApiCallback - ResultApiCallback

updateAction

int updateAction(java.util.UUID actionId,
                 java.io.File file)
          throws ClientException

Updates Content action with new content of specified file.

Parameters:

actionId - the action id

file - the file

Returns:

http status code

Throws:

ClientException - is thrown if unexpected error has occured

updateAction

void updateAction(java.util.UUID actionId,
                  java.io.File file,
                  UpdateApiCallback callback)

Parameters:

actionId - the action id

file - the file

callback - UpdateApiCallback

updateAction

int updateAction(java.util.UUID actionId,
                 java.lang.String url)
          throws ClientException

Updates url action

Parameters:

actionId - the action id

url - desired url

Returns:

http status code

Throws:

ClientException

updateAction

void updateAction(java.util.UUID actionId,
                  java.lang.String url,
                  UpdateApiCallback callback)

Updates url action

Parameters:

actionId - the action id

url - desired url

callback - callback with http status code

deleteAction

int deleteAction(java.util.UUID actionId)
          throws ClientException

Deletes action.

Parameters:

actionId - the action id

Returns:

the Http Status. Successful deletion should return Http Status: 200.

Throws:

ClientException - is thrown if unexpected error has occured

deleteAction

void deleteAction(java.util.UUID actionId,
                  UpdateApiCallback apiCallback)

Parameters:

actionId - the action id

apiCallback - UpdateApiCallback

getActionContent

HttpResult<FileData> getActionContent(java.util.UUID actionId,
                                      SDKOptional<ETag> eTagOptional)
                               throws ClientException

Requests action content. If the ETag's value matches the latest one the code 304 (NOT MODIFIED) is returned.

Parameters:

actionId - the action id

eTagOptional - the e tag optional

Returns:

the action content

Throws:

ClientException - is thrown if unexpected error has occured

getActionContent

void getActionContent(java.util.UUID actionId,
                      SDKOptional<ETag> eTagSDKOptional,
                      ResultApiCallback<FileData> resultApiCallback)

Parameters:

actionId - the action id

eTagSDKOptional - the e tag optional

resultApiCallback - UpdateApiCallback

getActionsForDevice

HttpResult<java.util.List<IAction>> getActionsForDevice(java.lang.String deviceUniqueId)
                                                 throws ClientException

Fetches actions for particular device

Parameters:

deviceUniqueId - unique id of beacon

Returns:

list with actions, both Browser and Content

Throws:

ClientException - is thrown if unexpected error has occured

getActionsForDevice

void getActionsForDevice(java.lang.String deviceUniqueId,
                         ResultApiCallback<java.util.List<IAction>> resultApiCallback)

Fetches actions for particular device

Parameters:

deviceUniqueId - unique id of beacon

resultApiCallback - the api-callback