This interface is used to retrieve user information. More...

Public Member Functions
bool	IsGuest ()
	Determines if the user is a guest on Kongregate. More...

string	GetUsername ()
	The Kongregate username for the current user. More...

string	GetGameAuthToken ()
	Retrieves the game authentication token for the Kongregate user. More...

long	GetUserId ()
	The Kongregate user ID of the current user. More...

bool	HasKongPlus ()
	Determines if the user has a Kong+ account. More...

int	GetNotificationCount ()

bool	HasUnreadGuildMessages ()

void	SetCharacterToken (string characterToken)
	Updates the character token used for guild chat authentication. More...

Detailed Description

This interface is used to retrieve user information.

Member Function Documentation

◆ GetGameAuthToken()

string Kongregate.IServices.GetGameAuthToken ( )

Retrieves the game authentication token for the Kongregate user.

Returns: The token

Note: This will be a stub value for guests

◆ GetNotificationCount()

int Kongregate.IServices.GetNotificationCount ( )

Returns: the number of notifications for current user

◆ GetUserId()

long Kongregate.IServices.GetUserId ( )

The Kongregate user ID of the current user.

Returns: The user id, or 0 if the user is a guest

◆ GetUsername()

string Kongregate.IServices.GetUsername ( )

The Kongregate username for the current user.

Returns: The username

◆ HasKongPlus()

bool Kongregate.IServices.HasKongPlus ( )

Determines if the user has a Kong+ account.

Returns: True if the user has a Kong+ account

◆ HasUnreadGuildMessages()

bool Kongregate.IServices.HasUnreadGuildMessages ( )

Returns: true if the user has unread guild chat messages

◆ IsGuest()

bool Kongregate.IServices.IsGuest ( )

Determines if the user is a guest on Kongregate.

Returns: True if the user is a guest

◆ SetCharacterToken()

void Kongregate.IServices.SetCharacterToken ( 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

The documentation for this interface was generated from the following file:

IServices.cs

Public Member Functions