flowground for Business Customers

Technical Specifications

startFlow

OnInit
./lib/triggers/startFlow.js
OnStartup
-
OnClose
-

Attributes

-

games_achievementDefinitions_list

Lists all the achievement definitions for your application.

OnInit
./lib/actions/games_achievementDefinitions_list.js
OnStartup
-
OnClose
-

Attributes

-

games_achievements_updateMultiple

Updates multiple achievements for the currently authenticated player.

OnInit
./lib/actions/games_achievements_updateMultiple.js
OnStartup
-
OnClose
-

Attributes

-

games_achievements_increment

Increments the steps of the achievement with the given ID for the currently authenticated player.

OnInit
./lib/actions/games_achievements_increment.js
OnStartup
-
OnClose
-

Attributes

-

games_achievements_reveal

Sets the state of the achievement with the given ID to REVEALED for the currently authenticated player.

OnInit
./lib/actions/games_achievements_reveal.js
OnStartup
-
OnClose
-

Attributes

-

games_achievements_setStepsAtLeast

Sets the steps for the currently authenticated player towards unlocking an achievement. If the steps parameter is less than the current number of steps that the player already gained for the achievement, the achievement is not modified.

OnInit
./lib/actions/games_achievements_setStepsAtLeast.js
OnStartup
-
OnClose
-

Attributes

-

games_achievements_unlock

Unlocks this achievement for the currently authenticated player.

OnInit
./lib/actions/games_achievements_unlock.js
OnStartup
-
OnClose
-

Attributes

-

games_applications_played

Indicate that the the currently authenticated user is playing your application.

OnInit
./lib/actions/games_applications_played.js
OnStartup
-
OnClose
-

Attributes

-

games_applications_get

Retrieves the metadata of the application with the given ID. If the requested application is not available for the specified platformType, the returned response will not include any instance data.

OnInit
./lib/actions/games_applications_get.js
OnStartup
-
OnClose
-

Attributes

-

games_applications_verify

Verifies the auth token provided with this request is for the application with the specified ID, and returns the ID of the player it was granted for.

OnInit
./lib/actions/games_applications_verify.js
OnStartup
-
OnClose
-

Attributes

-

games_events_listDefinitions

Returns a list of the event definitions in this application.

OnInit
./lib/actions/games_events_listDefinitions.js
OnStartup
-
OnClose
-

Attributes

-

games_events_listByPlayer

Returns a list showing the current progress on events in this application for the currently authenticated user.

OnInit
./lib/actions/games_events_listByPlayer.js
OnStartup
-
OnClose
-

Attributes

-

games_events_record

Records a batch of changes to the number of times events have occurred for the currently authenticated user of this application.

OnInit
./lib/actions/games_events_record.js
OnStartup
-
OnClose
-

Attributes

-

games_leaderboards_list

Lists all the leaderboard metadata for your application.

OnInit
./lib/actions/games_leaderboards_list.js
OnStartup
-
OnClose
-

Attributes

-

games_scores_submitMultiple

Submits multiple scores to leaderboards.

OnInit
./lib/actions/games_scores_submitMultiple.js
OnStartup
-
OnClose
-

Attributes

-

games_leaderboards_get

Retrieves the metadata of the leaderboard with the given ID.

OnInit
./lib/actions/games_leaderboards_get.js
OnStartup
-
OnClose
-

Attributes

-

games_scores_submit

Submits a score to the specified leaderboard.

OnInit
./lib/actions/games_scores_submit.js
OnStartup
-
OnClose
-

Attributes

-

games_scores_list

Lists the scores in a leaderboard, starting from the top.

OnInit
./lib/actions/games_scores_list.js
OnStartup
-
OnClose
-

Attributes

-

games_scores_listWindow

Lists the scores in a leaderboard around (and including) a player's score.

OnInit
./lib/actions/games_scores_listWindow.js
OnStartup
-
OnClose
-

Attributes

-

games_metagame_getMetagameConfig

Return the metagame configuration data for the calling application.

OnInit
./lib/actions/games_metagame_getMetagameConfig.js
OnStartup
-
OnClose
-

Attributes

-

games_players_list

Get the collection of players for the currently authenticated user.

OnInit
./lib/actions/games_players_list.js
OnStartup
-
OnClose
-

Attributes

-

games_players_get

Retrieves the Player resource with the given ID. To retrieve the player for the currently authenticated user, set playerId to me.

OnInit
./lib/actions/games_players_get.js
OnStartup
-
OnClose
-

Attributes

-

games_achievements_list

Lists the progress for all your application's achievements for the currently authenticated player.

OnInit
./lib/actions/games_achievements_list.js
OnStartup
-
OnClose
-

Attributes

-

games_metagame_listCategoriesByPlayer

List play data aggregated per category for the player corresponding to playerId.

OnInit
./lib/actions/games_metagame_listCategoriesByPlayer.js
OnStartup
-
OnClose
-

Attributes

-

games_scores_get

Get high scores, and optionally ranks, in leaderboards for the currently authenticated player. For a specific time span, leaderboardId can be set to ALL to retrieve data for all leaderboards in a given time span. NOTE: You cannot ask for 'ALL' leaderboards and 'ALL' timeSpans in the same request; only one parameter may be set to 'ALL'.

OnInit
./lib/actions/games_scores_get.js
OnStartup
-
OnClose
-

Attributes

-

games_quests_list

Get a list of quests for your application and the currently authenticated player.

OnInit
./lib/actions/games_quests_list.js
OnStartup
-
OnClose
-

Attributes

-

games_snapshots_list

Retrieves a list of snapshots created by your application for the player corresponding to the player ID.

OnInit
./lib/actions/games_snapshots_list.js
OnStartup
-
OnClose
-

Attributes

-

games_pushtokens_update

Registers a push token for the current user and application.

OnInit
./lib/actions/games_pushtokens_update.js
OnStartup
-
OnClose
-

Attributes

-

games_pushtokens_remove

Removes a push token for the current user and application. Removing a non-existent push token will report success.

OnInit
./lib/actions/games_pushtokens_remove.js
OnStartup
-
OnClose
-

Attributes

-

games_quests_accept

Indicates that the currently authorized user will participate in the quest.

OnInit
./lib/actions/games_quests_accept.js
OnStartup
-
OnClose
-

Attributes

-

games_questMilestones_claim

Report that a reward for the milestone corresponding to milestoneId for the quest corresponding to questId has been claimed by the currently authorized user.

OnInit
./lib/actions/games_questMilestones_claim.js
OnStartup
-
OnClose
-

Attributes

-

games_revisions_check

Checks whether the games client is out of date.

OnInit
./lib/actions/games_revisions_check.js
OnStartup
-
OnClose
-

Attributes

-

games_rooms_list

Returns invitations to join rooms.

OnInit
./lib/actions/games_rooms_list.js
OnStartup
-
OnClose
-

Attributes

-

games_rooms_create

Create a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

OnInit
./lib/actions/games_rooms_create.js
OnStartup
-
OnClose
-

Attributes

-

games_rooms_get

Get the data for a room.

OnInit
./lib/actions/games_rooms_get.js
OnStartup
-
OnClose
-

Attributes

-

games_rooms_decline

Decline an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

OnInit
./lib/actions/games_rooms_decline.js
OnStartup
-
OnClose
-

Attributes

-

games_rooms_dismiss

Dismiss an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

OnInit
./lib/actions/games_rooms_dismiss.js
OnStartup
-
OnClose
-

Attributes

-

games_rooms_join

Join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

OnInit
./lib/actions/games_rooms_join.js
OnStartup
-
OnClose
-

Attributes

-

games_rooms_leave

Leave a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

OnInit
./lib/actions/games_rooms_leave.js
OnStartup
-
OnClose
-

Attributes

-

games_rooms_reportStatus

Updates sent by a client reporting the status of peers in a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

OnInit
./lib/actions/games_rooms_reportStatus.js
OnStartup
-
OnClose
-

Attributes

-

games_snapshots_get

Retrieves the metadata for a given snapshot ID.

OnInit
./lib/actions/games_snapshots_get.js
OnStartup
-
OnClose
-

Attributes

-

games_turnBasedMatches_list

Returns turn-based matches the player is or was involved in.

OnInit
./lib/actions/games_turnBasedMatches_list.js
OnStartup
-
OnClose
-

Attributes

-

games_turnBasedMatches_create

Create a turn-based match.

OnInit
./lib/actions/games_turnBasedMatches_create.js
OnStartup
-
OnClose
-

Attributes

-

games_turnBasedMatches_sync

Returns turn-based matches the player is or was involved in that changed since the last sync call, with the least recent changes coming first. Matches that should be removed from the local cache will have a status of MATCH_DELETED.

OnInit
./lib/actions/games_turnBasedMatches_sync.js
OnStartup
-
OnClose
-

Attributes

-

games_turnBasedMatches_get

Get the data for a turn-based match.

OnInit
./lib/actions/games_turnBasedMatches_get.js
OnStartup
-
OnClose
-

Attributes

-

games_turnBasedMatches_cancel

Cancel a turn-based match.

OnInit
./lib/actions/games_turnBasedMatches_cancel.js
OnStartup
-
OnClose
-

Attributes

-

games_turnBasedMatches_decline

Decline an invitation to play a turn-based match.

OnInit
./lib/actions/games_turnBasedMatches_decline.js
OnStartup
-
OnClose
-

Attributes

-

games_turnBasedMatches_dismiss

Dismiss a turn-based match from the match list. The match will no longer show up in the list and will not generate notifications.

OnInit
./lib/actions/games_turnBasedMatches_dismiss.js
OnStartup
-
OnClose
-

Attributes

-

games_turnBasedMatches_finish

Finish a turn-based match. Each player should make this call once, after all results are in. Only the player whose turn it is may make the first call to Finish, and can pass in the final match state.

OnInit
./lib/actions/games_turnBasedMatches_finish.js
OnStartup
-
OnClose
-

Attributes

-

games_turnBasedMatches_join

Join a turn-based match.

OnInit
./lib/actions/games_turnBasedMatches_join.js
OnStartup
-
OnClose
-

Attributes

-

games_turnBasedMatches_leave

Leave a turn-based match when it is not the current player's turn, without canceling the match.

OnInit
./lib/actions/games_turnBasedMatches_leave.js
OnStartup
-
OnClose
-

Attributes

-

games_turnBasedMatches_leaveTurn

Leave a turn-based match during the current player's turn, without canceling the match.

OnInit
./lib/actions/games_turnBasedMatches_leaveTurn.js
OnStartup
-
OnClose
-

Attributes

-

games_turnBasedMatches_rematch

Create a rematch of a match that was previously completed, with the same participants. This can be called by only one player on a match still in their list; the player must have called Finish first. Returns the newly created match; it will be the caller's turn.

OnInit
./lib/actions/games_turnBasedMatches_rematch.js
OnStartup
-
OnClose
-

Attributes

-

games_turnBasedMatches_takeTurn

Commit the results of a player turn.

OnInit
./lib/actions/games_turnBasedMatches_takeTurn.js
OnStartup
-
OnClose
-

Attributes

-

No data available for terms

OAUTH_CLIENT_ID

OAuth Client ID

type
-
required
-
example
-

OAUTH_CLIENT_SECRET

OAuth Client Secret

type
-
required
-
example
-