Package | com.kongregate.air |
Interface | public interface IServices |
Method | Defined By | ||
---|---|---|---|
getGameAuthToken():String
Retrieves the game authentication token for the Kongregate user. | IServices | ||
getNotificationCount():Number
Gets the number of notifications for the current user. | IServices | ||
getUserId():Number
The Kongregate user ID of the current user. | IServices | ||
getUsername():String
The Kongregate username for the current user. | IServices | ||
hasKongPlus():Boolean
Determines if the user has a Kong+ account. | IServices | ||
hasUnreadGuildMessages():Boolean
Determines if the user has any unread guild chat messages. | IServices | ||
isGuest():Boolean
Determines if the user is a guest on Kongregate. | IServices | ||
setCharacterToken(characterToken:String):void
Updates the character token used for guild chat authentication. | IServices |
getGameAuthToken | () | method |
public function getGameAuthToken():String
Retrieves the game authentication token for the Kongregate user.
ReturnsString — The token
|
getNotificationCount | () | method |
public function getNotificationCount():Number
Gets the number of notifications for the current user.
ReturnsNumber — the number of notifications for current user
|
getUserId | () | method |
public function getUserId():Number
The Kongregate user ID of the current user.
ReturnsNumber — The user id, or 0 if the user is a guest
|
getUsername | () | method |
public function getUsername():String
The Kongregate username for the current user.
ReturnsString — The username
|
hasKongPlus | () | method |
public function hasKongPlus():Boolean
Determines if the user has a Kong+ account.
ReturnsBoolean — True if the user has a Kong+ account
|
hasUnreadGuildMessages | () | method |
public function hasUnreadGuildMessages():Boolean
Determines if the user has any unread guild chat messages.
ReturnsBoolean — true if the user has unread guild chat messages
|
isGuest | () | method |
public function isGuest():Boolean
Determines if the user is a guest on Kongregate.
ReturnsBoolean — True if the user is a guest
|
setCharacterToken | () | method |
public function setCharacterToken(characterToken:String):void
Updates the character token used for guild chat authentication. This should be generated on your server and signed using JWT.
Parameters
characterToken:String — The JWT signed token
|