com.kongregate.android.api

Interface KongregateServices

public interface KongregateServices

Main interface for accessing Kongregate services

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GUEST_GAME_AUTH_TOKEN Game Auth for guest users
static long	GUEST_USER_ID User id for a guest user
static java.lang.String	GUEST_USERNAME Username for a guest user

Method Summary

Modifier and Type	Method and Description
java.lang.String	getGameAuthToken()
int	getNotificationCount()
long	getUserId()
java.lang.String	getUsername()
boolean	hasKongPlus()
boolean	hasUnreadGuildMessages()
boolean	isConnected()
boolean	isGuest()
void	setCharacterToken(java.lang.String characterToken) Updates the character token used for guild chat authentication.

Field Detail

GUEST_USERNAME

static final java.lang.String GUEST_USERNAME

Username for a guest user

See Also:

Constant Field Values

GUEST_USER_ID

static final long GUEST_USER_ID

User id for a guest user

See Also:

Constant Field Values

GUEST_GAME_AUTH_TOKEN

static final java.lang.String GUEST_GAME_AUTH_TOKEN

Game Auth for guest users

See Also:

Constant Field Values

Method Detail

getUsername

java.lang.String getUsername()

Returns:

The current user's username, or GUEST_USERNAME if the user is a guest

getUserId

long getUserId()

Returns:

The current user's user id, or GUEST_USER_ID if the user is a guest

isGuest

boolean isGuest()

Returns:

True if the user is a guest

isConnected

boolean isConnected()

Returns:

True if the API is connected to the back-end.

hasKongPlus

boolean hasKongPlus()

Returns:

True if the user has Kong Plus

getNotificationCount

int getNotificationCount()

Returns:

the number of unread notifications

hasUnreadGuildMessages

boolean hasUnreadGuildMessages()

Returns:

true if the user has unread guild chat messages

getGameAuthToken

java.lang.String getGameAuthToken()

Returns:

the game auth token for the current game

setCharacterToken

void setCharacterToken(java.lang.String characterToken)

Updates the character token used for guild chat authentication. This should be generated on your server and signed using JWT.

Parameters:

characterToken - The JWT signed token