Package com.zendesk.sdk.network.impl

Class StubPushRegistrationResponseStorage

java.lang.Object

com.zendesk.sdk.network.impl.StubPushRegistrationResponseStorage

All Implemented Interfaces:

PushRegistrationResponseStorage, SdkStorage.UserStorage

public class StubPushRegistrationResponseStorage
extends java.lang.Object
implements PushRegistrationResponseStorage

Constructor Summary

Constructors

Constructor and Description
StubPushRegistrationResponseStorage()

Method Summary

Modifier and Type	Method and Description
void	clearUserData() This method will be called when user data must be cleared
java.lang.String	getCacheKey() Gets the cache key for the user storage.
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StubPushRegistrationResponseStorage

public StubPushRegistrationResponseStorage()

Method Detail

storePushRegistrationResponse

public void storePushRegistrationResponse(PushRegistrationResponse response)

Description copied from interface: PushRegistrationResponseStorage

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.

Specified by:

storePushRegistrationResponse in interface PushRegistrationResponseStorage

Parameters:

response - the PushRegistrationResponse to store.

getPushRegistrationResponse

public PushRegistrationResponse getPushRegistrationResponse()

Description copied from interface: PushRegistrationResponseStorage

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.

Specified by:

getPushRegistrationResponse in interface PushRegistrationResponseStorage

Returns:

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

hasStoredPushRegistrationResponse

public boolean hasStoredPushRegistrationResponse()

Description copied from interface: PushRegistrationResponseStorage

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

Specified by:

hasStoredPushRegistrationResponse in interface PushRegistrationResponseStorage

Returns:

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

removePushRegistrationResponse

public void removePushRegistrationResponse()

Description copied from interface: PushRegistrationResponseStorage

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.

Specified by:

removePushRegistrationResponse in interface PushRegistrationResponseStorage

clearUserData

public void clearUserData()

Description copied from interface: SdkStorage.UserStorage

This method will be called when user data must be cleared

Specified by:

clearUserData in interface SdkStorage.UserStorage

getCacheKey

public java.lang.String getCacheKey()

Description copied from interface: SdkStorage.UserStorage

Gets the cache key for the user storage.

Specified by:

getCacheKey in interface SdkStorage.UserStorage

Returns:

the cache key for the user storage