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)
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)
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)

Methods inherited from interface java.io.Closeable

close

Method Detail

createContentAction

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

Throws:

ClientException

createContentAction

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

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)

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

Throws:

ClientException

getAction

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

getAction

void getAction(java.util.UUID actionId,
               ResultApiCallback<IAction> 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:

the int

Throws:

ClientException - is thrown if unexpected error has occured

updateAction

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

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)

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)