com.kii.cloud.unity

Class AbstractGcmIntentService

java.lang.Object

IntentService

com.kii.cloud.unity.AbstractGcmIntentService

Direct Known Subclasses:

GcmIntentService

public abstract class AbstractGcmIntentService
extends IntentService

AbstractGcmIntentService is a base class for Services that handle GCM(Google Cloud Messaging). You can change a behavior when a push notification is received to override the onHandlePushMessage method.

Author:

noriyoshi.fukuzaki@kii.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractGcmIntentService.MessageType

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String[]	PUSH_TO_APP_FIELDS
protected static java.lang.String[]	PUSH_TO_USER_FIELDS

Constructor Summary

Constructors

Constructor and Description
AbstractGcmIntentService()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getAppName(Context context) Gets app name
protected int	getLargeIcon(Context context) Gets resource id of large launcher icon.
protected AbstractGcmIntentService.MessageType	getMessageType(JSONObject message)
protected java.lang.Integer	getNotificationColor(Context context) Get ARBG color for notification color
protected boolean	getResouceValueAsBoolean(java.lang.String key) Gets the boolean value to which the specified key is mapped, or false if resource file contains no mapping for the key.
protected int	getResouceValueAsInteger(java.lang.String key) Gets the int value to which the specified key is mapped, or 0 if resource file contains no mapping for the key.
protected java.lang.String	getResouceValueAsString(java.lang.String key) Gets the string value to which the specified key is mapped, or null if resource file contains no mapping for the key.
protected int	getSmallIcon(Context context) Gets resource id of small launcher icon.
protected int	getSound() Gets resource id of sound file.
protected java.lang.String	getText(JSONObject json, java.lang.String text, java.lang.String fallback)
protected boolean	isForeground() Checks if the application is on foreground.
protected void	onHandleIntent(Intent intent)
protected abstract boolean	onHandlePushMessage(Context context, AbstractGcmIntentService.MessageType messageType, JSONObject receivedMessage, boolean isForeground) Called by IntentService when service receives push notification.
protected java.lang.Integer	parseArgb(java.lang.String argbString) Convert string value which indicates color into the integer value.
protected void	showNotificationArea(Context context, JSONObject message, boolean useSound, java.lang.String ledColor, long vibrationMilliseconds, java.lang.String title, java.lang.String ticker, java.lang.String text) Shows a received message in the notification area.
protected JSONObject	toJson(Bundle bundle) Converts Bundle to JSONObject.

Methods inherited from class java.lang.Object

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

Field Detail

PUSH_TO_APP_FIELDS

protected static final java.lang.String[] PUSH_TO_APP_FIELDS

PUSH_TO_USER_FIELDS

protected static final java.lang.String[] PUSH_TO_USER_FIELDS

Constructor Detail

AbstractGcmIntentService

public AbstractGcmIntentService()

Method Detail

getAppName

protected java.lang.String getAppName(Context context)

Gets app name

Parameters:

context -

Returns:

getLargeIcon

protected int getLargeIcon(Context context)

Gets resource id of large launcher icon.

Parameters:

context -

Returns:

The associated resource identifier. Returns 0 if no such resource was found. (0 is not a valid resource ID.)

getMessageType

protected AbstractGcmIntentService.MessageType getMessageType(JSONObject message)

getNotificationColor

protected java.lang.Integer getNotificationColor(Context context)

Get ARBG color for notification color

Parameters:

context -

Returns:

returns negative value if notification color is not defined.

getResouceValueAsBoolean

protected boolean getResouceValueAsBoolean(java.lang.String key)

Gets the boolean value to which the specified key is mapped, or false if resource file contains no mapping for the key.

Parameters:

key -

Returns:

getResouceValueAsInteger

protected int getResouceValueAsInteger(java.lang.String key)

Gets the int value to which the specified key is mapped, or 0 if resource file contains no mapping for the key.

Parameters:

key -

Returns:

getResouceValueAsString

protected java.lang.String getResouceValueAsString(java.lang.String key)

Gets the string value to which the specified key is mapped, or null if resource file contains no mapping for the key.

Parameters:

key -

Returns:

getSmallIcon

protected int getSmallIcon(Context context)

Gets resource id of small launcher icon.

Parameters:

context -

Returns:

int The associated resource identifier. Returns 0 if no such resource was found. (0 is not a valid resource ID.)

getSound

protected int getSound()

Gets resource id of sound file.

Returns:

int The associated resource identifier. Returns 0 if no such resource was found. (0 is not a valid resource ID.)

getText

protected java.lang.String getText(JSONObject json,
                                   java.lang.String text,
                                   java.lang.String fallback)

Parameters:

json -

text - literal or JSONPath

fallback -

Returns:

isForeground

protected boolean isForeground()

Checks if the application is on foreground.

Returns:

onHandleIntent

protected void onHandleIntent(Intent intent)

onHandlePushMessage

protected abstract boolean onHandlePushMessage(Context context,
                                               AbstractGcmIntentService.MessageType messageType,
                                               JSONObject receivedMessage,
                                               boolean isForeground)

Called by IntentService when service receives push notification.

Parameters:

context -

messageType -

receivedMessage -

isForeground -

Returns:

Return true if you want to raise a receiving event to the Unity.

parseArgb

protected java.lang.Integer parseArgb(java.lang.String argbString)

Convert string value which indicates color into the integer value.

Parameters:

argbString - #AARRGGBB

Returns:

showNotificationArea

protected void showNotificationArea(Context context,
                                    JSONObject message,
                                    boolean useSound,
                                    java.lang.String ledColor,
                                    long vibrationMilliseconds,
                                    java.lang.String title,
                                    java.lang.String ticker,
                                    java.lang.String text)

Shows a received message in the notification area.

Parameters:

context -

message -

useSound -

ledColor - format is '#AARRGGBB'

vibrationMilliseconds - set 0 if you want to disable vibration.

title - Literal text or JsonPath

text - Literal text or JsonPath

toJson

protected JSONObject toJson(Bundle bundle)

Converts Bundle to JSONObject.

Parameters:

bundle -

Returns: