Package com.zendesk.sdk.storage

Interface PushRegistrationResponseStorage

All Superinterfaces:

SdkStorage.UserStorage

All Known Implementing Classes:

StubPushRegistrationResponseStorage

public interface PushRegistrationResponseStorage
extends SdkStorage.UserStorage

Defines the behaviour for storing, querying, and deleting a PushRegistrationResponse on the device. This was implemented to prevent unnecessary/redundant repeated calls to the PushRegistrationProvider with the same identifier. It is used internally by the SDK and should not need to be touched by an integrator.

Method Summary

Modifier and Type	Method and Description
PushRegistrationResponse	getPushRegistrationResponse() Gets a PushRegistrationResponse or null from storage.
boolean	hasStoredPushRegistrationResponse() Returns true if there is a PushRegistrationResponse in storage, false if not.
void	removePushRegistrationResponse() Removes a stored PushRegistrationResponse, if any, from storage.
void	storePushRegistrationResponse(PushRegistrationResponse response) Puts a PushRegistrationResponse into storage in serialized form.

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

clearUserData, getCacheKey

Method Detail

storePushRegistrationResponse

void storePushRegistrationResponse(PushRegistrationResponse response)

Puts a PushRegistrationResponse into storage in serialized form. This method is called automatically by any successful call to com.zendesk.sdk.network.PushRegistrationProvider#registerDeviceWithIdentifier(String, Locale, ZendeskCallback) or com.zendesk.sdk.network.PushRegistrationProvider#registerDeviceWithUAChannelId(String, Locale, ZendeskCallback). Only one PushRegistrationResponse can be stored at a time. Each invocation of this method will overwrite any previously stored PushRegistrationResponse.

Parameters:

response - the PushRegistrationResponse to store.

getPushRegistrationResponse

PushRegistrationResponse getPushRegistrationResponse()

Gets a PushRegistrationResponse or null from storage. If a PushRegistrationResponse has previously been stored with PushRegistrationResponseStorage.storePushRegistrationResponse(PushRegistrationResponse) and it has not been removed from storage, the stored object will be the return value. If no PushRegistrationResponse has previously been stored, or storage has not been cleared by a 401 event or registration with a different identifier, this method will return null.

Returns:

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

hasStoredPushRegistrationResponse

boolean hasStoredPushRegistrationResponse()

Returns true if there is a PushRegistrationResponse in storage, false if not.

Returns:

true if there is a PushRegistrationResponse in storage, false if not.

removePushRegistrationResponse

void removePushRegistrationResponse()

Removes a stored PushRegistrationResponse, if any, from storage. This is called in the event of a call to com.zendesk.sdk.network.PushRegistrationProvider#registerDeviceWithIdentifier(String, Locale, ZendeskCallback) or com.zendesk.sdk.network.PushRegistrationProvider#registerDeviceWithUAChannelId(String, Locale, ZendeskCallback) with an identifier different to the one in the stored PushRegistrationResponse. It is also called in any "clear all storage" event, such as a 401 response from Zendesk.