Package com.zendesk.sdk.storage

Interface RequestStorage

All Superinterfaces:

SdkStorage.UserStorage

public interface RequestStorage
extends SdkStorage.UserStorage

Provides storage of Request IDs and Comment last read timestamps. Also defines the behaviour for storing, querying, and updating a RequestUpdates on the device. Only one RequestUpdates can be stored at a time. This was implemented to facilitate a time-based cache approach to querying for unread messages on a user's requests. When RequestUpdates are stored using RequestStorage.setRequestUpdates(RequestUpdates), the current timestamp is also recorded. This timestamp can be retrieved using RequestStorage.getRequestUpdatesTimestamp(). The @link RequestStorage.markRequestAsRead(String) method is called by the UI when a request is viewed, marking that request as "read" and removing it from the stored RequestUpdates.

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getCommentCount(java.lang.String requestId) Stores a comment count when this request was last read
RequestUpdates	getRequestUpdates() Gets the stored RequestUpdates object, or null if there isn't one.
long	getRequestUpdatesTimestamp() Gets the timestamp in milliseconds for when the stored RequestUpdates (if any) was stored.
java.util.List<java.lang.String>	getStoredRequestIds() Get the request IDs stored on the device.
boolean	hasStoredRequestUpdates() Check to see whether there is an RequestUpdates object in storage.
void	markRequestAsRead(java.lang.String requestId) Marks a request as read by removing it from the stored RequestUpdates.
void	setCommentCount(java.lang.String requestId, int commentCount) Gets the comment count of when the request was last read
void	setRequestUpdates(RequestUpdates requestUpdates) Stores a RequestUpdates in the storage, and records a timestamp of the event.
void	storeRequestId(java.lang.String requestId) Stores a request ID on the device

Methods inherited from interface com.zendesk.sdk.storage.SdkStorage.UserStorage

clearUserData, getCacheKey

Method Detail

getStoredRequestIds

java.util.List<java.lang.String> getStoredRequestIds()

Get the request IDs stored on the device.

Returns:

The list of request IDs stored on the device. If none are present or if storage was not initialised correctly it will return an empty list.

storeRequestId

void storeRequestId(java.lang.String requestId)

Stores a request ID on the device

Parameters:

requestId - The request ID to store on the device.

setCommentCount

void setCommentCount(java.lang.String requestId,
                     int commentCount)

Gets the comment count of when the request was last read

Parameters:

requestId - The request id

commentCount - The comment count when the request was last read

getCommentCount

java.lang.Integer getCommentCount(java.lang.String requestId)

Stores a comment count when this request was last read

Parameters:

requestId - The id of the request

Returns:

The timestamp that the request was last read

hasStoredRequestUpdates

boolean hasStoredRequestUpdates()

Check to see whether there is an RequestUpdates object in storage.

Returns:

true if there is an RequestUpdates in storage, false if not

getRequestUpdatesTimestamp

long getRequestUpdatesTimestamp()

Gets the timestamp in milliseconds for when the stored RequestUpdates (if any) was stored.

Returns:

the timestamp in milliseconds for when the stored RequestUpdates was stored, or -1 if there is no stored RequestUpdates.

setRequestUpdates

void setRequestUpdates(RequestUpdates requestUpdates)

Stores a RequestUpdates in the storage, and records a timestamp of the event.

Parameters:

requestUpdates - the RequestUpdates to store.

markRequestAsRead

void markRequestAsRead(java.lang.String requestId)

Marks a request as read by removing it from the stored RequestUpdates. If the request ID is not already a key in RequestUpdates.getRequestsWithUpdates(), or there is no RequestUpdates stored, then this will have no effect.

Parameters:

requestId - the ID of the request to remove from RequestUpdates

getRequestUpdates

RequestUpdates getRequestUpdates()

Gets the stored RequestUpdates object, or null if there isn't one.

Returns:

the stored RequestUpdates, or null if there isn't one.