com.kongregate.android.api

Class KongregateEvent

java.lang.Object

com.kongregate.android.api.KongregateEvent

public class KongregateEvent
extends java.lang.Object

Kongregate API Event constants

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHARACTER_TOKEN_REQUEST Broadcast when the API needs a new character token for guild chat authentication.
static java.lang.String	CLOSED_KONGREGATE Broadcast when the Kongregate panel has closed
static java.lang.String	GAME_AUTH_TOKEN_CHANGED Broadcast when the user's game authentication token has changed.
static java.lang.String	LOGIN_COMPLETE Broadcast when a new user logs in
static java.lang.String	NOTIFICATION_COUNT_UPDATED Broadcast when the notifications count has been updated
static java.lang.String	OPEN_DEEP_LINK Broadcast when the app is openned using a deep link
static java.lang.String	OPENING_KONGREGATE Broadcast when the Kongregate panel is about to be opened.
static java.lang.String	PARAM_AMOUNT KONGREGATE_EVENT_PROMO_AWARD event parameter for the amount of currency to award.
static java.lang.String	PARAM_CURRENCY PROMO_AWARD event parameter for the currency type to award.
static java.lang.String	PARAM_INSTALL_URL PROMO event parameter for a link to open after giving an award.
static java.lang.String	PARAM_ITEM PROMO_AWARD event parameter for the item to award.
static java.lang.String	PARAM_PROMO_ID PROMO_AWARD event parameter for the promoID.
static java.lang.String	PROMO_AWARD Broadcast when a promotion event occurs and some item or currency should be awarded.
static java.lang.String	READY Broadcast when the API is initialized and ready to use
static java.lang.String	RECEIPT_VERIFICATION_COMPLETE Broadcast when a event verification is complete
static java.lang.String	SERVICE_UNAVAILABLE Broadcast when Kongregate is unavailable.
static java.lang.String	SWRVE_RESOURCES_UPDATES Broadcast when the Swrve resources have been updated
static java.lang.String	USER_CHANGED Broadcast when the user has changed
static java.lang.String	USER_INVENTORY Broadcast when the user's inventory is received
static java.lang.String	USER_LOGOUT Broadcast when a user logs out

Constructor Summary

Constructors

Constructor and Description
KongregateEvent()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

USER_CHANGED

public static final java.lang.String USER_CHANGED

Broadcast when the user has changed

See Also:

Constant Field Values

GAME_AUTH_TOKEN_CHANGED

public static final java.lang.String GAME_AUTH_TOKEN_CHANGED

Broadcast when the user's game authentication token has changed.

See Also:

Constant Field Values

READY

public static final java.lang.String READY

Broadcast when the API is initialized and ready to use

See Also:

Constant Field Values

OPENING_KONGREGATE

public static final java.lang.String OPENING_KONGREGATE

Broadcast when the Kongregate panel is about to be opened. You should pause your game state, mute sounds, etc.

See Also:

Constant Field Values

CLOSED_KONGREGATE

public static final java.lang.String CLOSED_KONGREGATE

Broadcast when the Kongregate panel has closed

See Also:

Constant Field Values

LOGIN_COMPLETE

public static final java.lang.String LOGIN_COMPLETE

Broadcast when a new user logs in

See Also:

Constant Field Values

USER_LOGOUT

public static final java.lang.String USER_LOGOUT

Broadcast when a user logs out

See Also:

Constant Field Values

USER_INVENTORY

public static final java.lang.String USER_INVENTORY

Broadcast when the user's inventory is received

See Also:

Constant Field Values

SERVICE_UNAVAILABLE

public static final java.lang.String SERVICE_UNAVAILABLE

Broadcast when Kongregate is unavailable. This may be due to network connectivity or Kongregate may be down for maintence.

See Also:

Constant Field Values

RECEIPT_VERIFICATION_COMPLETE

public static final java.lang.String RECEIPT_VERIFICATION_COMPLETE

Broadcast when a event verification is complete

See Also:

Constant Field Values

SWRVE_RESOURCES_UPDATES

public static final java.lang.String SWRVE_RESOURCES_UPDATES

Broadcast when the Swrve resources have been updated

See Also:

Constant Field Values

NOTIFICATION_COUNT_UPDATED

public static final java.lang.String NOTIFICATION_COUNT_UPDATED

Broadcast when the notifications count has been updated

See Also:

Constant Field Values

CHARACTER_TOKEN_REQUEST

public static final java.lang.String CHARACTER_TOKEN_REQUEST

Broadcast when the API needs a new character token for guild chat authentication. This generally happens when a previously valid character token expires. If you receive this event repeatedly after generating a new token you may need to double check your JWT implementation and ensure you are using the proper server API key to sign the token.

See Also:

Constant Field Values

OPEN_DEEP_LINK

public static final java.lang.String OPEN_DEEP_LINK

Broadcast when the app is openned using a deep link

See Also:

Constant Field Values

PROMO_AWARD

public static final java.lang.String PROMO_AWARD

Broadcast when a promotion event occurs and some item or currency should be awarded. Promotional events occur through the Swrve in-app message system. Parse the JSON in the event bundle to determine the award. The format of the JSON bundle will be: { "promoId": "promo_ebf", "item": "super_punch", "currency": "gold", "amount": 100 }

Once the award is complete, invoke AnalyticsServices.finishPromoAward(String) which will set a Swrve User Property that may be used to prevent the promo from appearing again

See Also:

Constant Field Values

PARAM_PROMO_ID

public static final java.lang.String PARAM_PROMO_ID

PROMO_AWARD event parameter for the promoID.

See Also:

Constant Field Values

PARAM_ITEM

public static final java.lang.String PARAM_ITEM

PROMO_AWARD event parameter for the item to award.

See Also:

Constant Field Values

PARAM_CURRENCY

public static final java.lang.String PARAM_CURRENCY

PROMO_AWARD event parameter for the currency type to award.

See Also:

Constant Field Values

PARAM_AMOUNT

public static final java.lang.String PARAM_AMOUNT

KONGREGATE_EVENT_PROMO_AWARD event parameter for the amount of currency to award.

See Also:

Constant Field Values

PARAM_INSTALL_URL

public static final java.lang.String PARAM_INSTALL_URL

PROMO event parameter for a link to open after giving an award.

See Also:

Constant Field Values

Constructor Detail

KongregateEvent

public KongregateEvent()