Android API Reference · Documentation

New API Methods

submitScore

Validate match id then reports a score to Skillz. Allows to keep control and return to Skillz later.

public static void submitScore(@NonNull final Activity activity, BigDecimal score, String matchId, SkillzScoreCallback callback)

Parameters

activity The activity to report the score from.

score The score to report.

matchId The id of the current match.

callback Callback that is called upon completion.

returnToSkillz

Returns to Skillz after score is submitted by using the method submitScore()

public static boolean returnToSkillz(@NonNull final Activity activity, String matchId)

Parameters

activity The activity on foreground

matchId The id of the match just being played - send null if not in a match

Returns

True if score has been submitted and user can return to Skillz, false if match is in progress or score has not been submitted.

displayTournamentResultsWithScore

Validate match id then reports a score to Skillz from a given activity. Moves control back to Skillz UI.

public static void displayTournamentResultsWithScore(@NonNull final Activity activity, BigDecimal score, String matchId)

Parameters

activity The activity to report the score from.

score The score to report.

matchId The id of the current match.

Progression Methods (SkillzProgression class)

Progression Namespace Constants

Calls to the progression methods must use one of the three namespace string values. Each namespace return a separate list of key-value pairs for for that namespace:

/* For player data and is game specific. */
"PlayerData"
"DefaultPlayerData"
/* In game items and is shared across all games in publisher's portfolio. */
"InGameItems"

getUserData

Get user progression data for a given namespace and set of keys. Results will be returned in a callback with either the data, or an exception object.

public static void getUserData(String namespace, List<String> keys, ProgressionCallback callback)

Parameters

namespace set to one of the valid strings listed below:
- "PlayerData"
- "DefaultPlayerData"
- "InGameItems"
keys a list of keys to get the values for
callback callback that will be called with either success or failure after API call is completed

updateUserData

Update user progression data for a given namespace and set of keys.

    public static void updateUserData(String namespace, Map<String, Object> values, ProgressionCallback callback)

Parameters

namespace set to one of the valid strings listed below:
- "PlayerData"
- "InGameItems"
values a map of keys to update with their respective values
callback callback that will be called with either success or failure after API call is completed

Skillz

Represents the main way to interact with Skillz.

abortMatch

Aborts the Skillz match in the activity.

static void abortMatch(Activity activity)

Parameters

activity Reference to the activity of your game's gameplay.

addMetadataForMatchInProgress

Updates the meta data for a Skillz match in progress.

static void addMetadataForMatchInProgress(java.util.Map<?,?> attributes, boolean isMatchInProgress)

Parameters

attributes A Map containing the metadata of the match in progress.

isMatchInProgress A boolean indicating if a match is in progress.

currentUserDisplayName

Returns the current Skillz user's display name.

static java.lang.String currentUserDisplayName(Activity activity)

Parameters

activity The instance of the Activity representing your game's gameplay.

Returns

A string representing the current user's display name.

endReplayRecording

End the current replay if one exists and returns the status of the score submission.

public static boolean endReplayRecording(String matchId)

Returns

True if end replay was successful and false if the user has not submitted a score for the match.

getMatchInfo

Use this method to fetch the match information of the current match.

static MatchInfo getMatchInfo(Activity activity)

Returns

A MatchInfo object.

getMatchRules

Returns a dictionary of gameplay parameters that you set in each match type in the Developer Console.

static java.util.Map<java.lang.String,java.lang.String> getMatchRules()

Returns

A Map containing the gameplay parameters for the match.

getPlayerDetails

Gets details of the currently logged in player.

static SkillzPlayer getPlayerDetails(Activity activity)

Returns

A SkillzPlayer object that contains info of the currently logged in player.

getRandom

Returns a random integer sequence supplied by the Skillz SDK to ensure fairness across competition games.

static SkillzRandom getRandom()

Returns

A SkillzRandom object that wraps the random integer.

isMatchInProgress

Returns whether or not there is currently a Skillz match in progress.

static boolean isMatchInProgress()

Returns

A boolean indicating if a match is in progress.

launch

Launches the Skillz UI.

static void launch(Activity activity)

player

Returns a more general Player object with more fields to describe a player.

static Player player(Activity activity)

Parameters

activity An instance of the activity representing your game's gameplay.

Returns

A Player object.

registerPushToken

Enables an app to receive push notifications.

static void registerPushToken(Context context, java.lang.String pushToken)

Parameters

context The current application's context to receive Skillz push notifications.

pushToken The device's Firebase push token.

reportScore (Deprecated)

Validate match id then reports a score to Skillz from a given activity.

static void reportScore(@NonNull final Activity activity, java.math.BigDecimal score, String matchId)

Parameters

activity The activity to report the score from.

score The score to report.

matchId The id of the current match.

SDKVersionShort

Returns the name of the Skillz SDK Version.

static java.lang.String SDKVersionShort()

Returns

The SDK Version as a string.

updatePlayersCurrentScore

This method must be called each time the current player's score changes during a Skillz match.

static void updatePlayersCurrentScore(Activity activity, BigDecimal score, String matchId)

Parameters

activity The activity which contains the score to update.

score The player's updated score.

matchId The id of the current match.

MatchInfo

Property	Data Type	Description
ConnectionInfo	SyncConnectionInfo	The connection info to a Skillz server that coordinates a real-time match.
ConnectToken	String
Name	String	Name of the match
EntryCash	float	If this tournament is being played for real cash, this is the amount of cash required to enter.
EntryPoints	int	If this tournament is being played for Z, this is the amount of Z required to enter.
ID	String	The unique ID for the match
IsCash	bool	Indicates the match is for real prizes or for Z
IsCustomServerSync	bool	Indicates if the match is a custom server sync match
IsSkillzServerSync	bool	Indicates if the match is a Skillz server sync match
IsSyncBotMatch	bool	Indicates if the match is a sync bot match
IsSynchronous	bool	Indicates if this is a sync match
MatchDescription	String	The description of this tournament type
Players	List<SkillzPlayer>	List of players in the match
SkillzDifficulty	String	The difficulty of the game (used with automatic difficulty). Note: only set in production.
TemplateID	String	The unique ID for the tournament template this match is based on

Player

Property	Data Type	Description
AvailableThumbnailURL	String	Returns ThumbnailURL or AvatarURL
AvatarURL	String	A link to the user's avatar image
BestScore	double	User's best score
CashPrize	double
EntryID	String
FlagURL	String	A link to the user's country's flag image
ID	String
isAborted	bool
isFinished	bool
isPending	bool
isStarted	bool
isTie	bool
isWinner	bool
MatchID	String	Match ID
Name	String	User Name
Outcome	String
Position	int
ReplayURL	String
Score	Double	User score
Shoutout	String
State	String
TicketzPrize	long
ThumbnailURL	String
UserID	String	The unique ID for this user
ZPrize	long

SkillzPlayer

Property	Data Type	Description
AvatarURL	String	A link to the user's avatar image
FlagURL	String	A link to the user's country's flag image
IsCurrentPlayer	bool	This Player object represents the current user if this is true
PlayerMatchID	String	ID of Player
UserName	String	User name
UserID	String	The unique ID for this user

SyncConnectionInfo

Property	Data Type	Description
isBotMatch	bool	Indicates if the match is a sync bot match
MatchId	String	The ID of the real-time match
MatchToken	String	An encrypted token to validate the session server-side
ServerIp	String	The hostname or IP for the match
ServerPort	String	The port for the game server