public interface Client
Modifier and Type | Method and Description |
---|---|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
addFriends(@NonNull Session session,
java.lang.Iterable<java.lang.String> ids,
java.lang.String... usernames)
Add one or more friends by id or username.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
addFriends(@NonNull Session session,
java.lang.String... ids)
Add one or more friends by id.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
addGroupUsers(@NonNull Session session,
@NonNull java.lang.String groupId,
java.lang.String... ids)
Add one or more users to the group.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateApple(@NonNull java.lang.String token)
Authenticate a user with an Apple token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateApple(@NonNull java.lang.String token,
boolean create)
Authenticate a user with an Apple token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateApple(@NonNull java.lang.String token,
boolean create,
@NonNull java.lang.String username)
Authenticate a user with an Apple token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateApple(@NonNull java.lang.String token,
boolean create,
java.lang.String username,
@NonNull java.util.Map<java.lang.String,java.lang.String> vars)
Authenticate a user with an Apple token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateApple(@NonNull java.lang.String token,
@NonNull java.util.Map<java.lang.String,java.lang.String> vars)
Authenticate a user with an Apple token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateApple(@NonNull java.lang.String token,
@NonNull java.lang.String username)
Authenticate a user with an Apple token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateCustom(@NonNull java.lang.String id)
Authenticate a user with a custom id.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateCustom(@NonNull java.lang.String id,
boolean create)
Authenticate a user with a custom id.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateCustom(@NonNull java.lang.String id,
boolean create,
@NonNull java.lang.String username)
Authenticate a user with a custom id.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateCustom(@NonNull java.lang.String id,
boolean create,
java.lang.String username,
@NonNull java.util.Map<java.lang.String,java.lang.String> vars)
Authenticate a user with a custom id.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateCustom(@NonNull java.lang.String id,
@NonNull java.util.Map<java.lang.String,java.lang.String> vars)
Authenticate a user with a custom id.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateCustom(@NonNull java.lang.String id,
@NonNull java.lang.String username)
Authenticate a user with a custom id.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateDevice(@NonNull java.lang.String id)
Authenticate a user with a device id.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateDevice(@NonNull java.lang.String id,
boolean create)
Authenticate a user with a device id.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateDevice(@NonNull java.lang.String id,
boolean create,
@NonNull java.lang.String username)
Authenticate a user with a device id.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateDevice(@NonNull java.lang.String id,
boolean create,
java.lang.String username,
@NonNull java.util.Map<java.lang.String,java.lang.String> vars)
Authenticate a user with a device id.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateDevice(@NonNull java.lang.String id,
@NonNull java.util.Map<java.lang.String,java.lang.String> vars)
Authenticate a user with a device id.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateDevice(@NonNull java.lang.String id,
@NonNull java.lang.String username)
Authenticate a user with a device id.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateEmail(@NonNull java.lang.String email,
@NonNull java.lang.String password)
Authenticate a user with an email and password.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateEmail(@NonNull java.lang.String email,
@NonNull java.lang.String password,
boolean create)
Authenticate a user with an email and password.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateEmail(@NonNull java.lang.String email,
@NonNull java.lang.String password,
boolean create,
@NonNull java.lang.String username)
Authenticate a user with an email and password.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateEmail(@NonNull java.lang.String email,
@NonNull java.lang.String password,
boolean create,
java.lang.String username,
@NonNull java.util.Map<java.lang.String,java.lang.String> vars)
Authenticate a user with an email and password.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateEmail(@NonNull java.lang.String email,
@NonNull java.lang.String password,
@NonNull java.util.Map<java.lang.String,java.lang.String> vars)
Authenticate a user with an email and password.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateEmail(@NonNull java.lang.String email,
@NonNull java.lang.String password,
@NonNull java.lang.String username)
Authenticate a user with an email and password.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateFacebook(@NonNull java.lang.String accessToken)
Authenticate a user with a Facebook auth token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateFacebook(@NonNull java.lang.String accessToken,
boolean create)
Authenticate a user with a Facebook auth token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateFacebook(@NonNull java.lang.String accessToken,
boolean create,
@NonNull java.lang.String username)
Authenticate a user with a Facebook auth token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateFacebook(@NonNull java.lang.String accessToken,
boolean create,
@NonNull java.lang.String username,
boolean importFriends)
Authenticate a user with a Facebook auth token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateFacebook(@NonNull java.lang.String accessToken,
boolean create,
java.lang.String username,
boolean importFriends,
@NonNull java.util.Map<java.lang.String,java.lang.String> vars)
Authenticate a user with a Facebook auth token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateFacebook(@NonNull java.lang.String accessToken,
@NonNull java.util.Map<java.lang.String,java.lang.String> vars)
Authenticate a user with a Facebook auth token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateFacebook(@NonNull java.lang.String accessToken,
@NonNull java.lang.String username)
Authenticate a user with a Facebook auth token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateFacebookInstantGame(@NonNull java.lang.String accessToken)
Authenticate a user with a Facebook Instant auth token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateFacebookInstantGame(@NonNull java.lang.String accessToken,
boolean create)
Authenticate a user with a Facebook Instant auth token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateFacebookInstantGame(@NonNull java.lang.String accessToken,
boolean create,
@NonNull java.lang.String username)
Authenticate a user with a Facebook Instant auth token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateFacebookInstantGame(@NonNull java.lang.String accessToken,
boolean create,
java.lang.String username,
@NonNull java.util.Map<java.lang.String,java.lang.String> vars)
Authenticate a user with a Facebook Instant auth token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateFacebookInstantGame(@NonNull java.lang.String accessToken,
@NonNull java.util.Map<java.lang.String,java.lang.String> vars)
Authenticate a user with a Facebook Instant auth token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateFacebookInstantGame(@NonNull java.lang.String accessToken,
@NonNull java.lang.String username)
Authenticate a user with a Facebook Instant auth token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateGameCenter(@NonNull java.lang.String playerId,
@NonNull java.lang.String bundleId,
long timestampSeconds,
@NonNull java.lang.String salt,
@NonNull java.lang.String signature,
@NonNull java.lang.String publicKeyUrl)
Authenticate a user with Apple Game Center.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateGameCenter(@NonNull java.lang.String playerId,
@NonNull java.lang.String bundleId,
long timestampSeconds,
@NonNull java.lang.String salt,
@NonNull java.lang.String signature,
@NonNull java.lang.String publicKeyUrl,
boolean create)
Authenticate a user with Apple Game Center.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateGameCenter(@NonNull java.lang.String playerId,
@NonNull java.lang.String bundleId,
long timestampSeconds,
@NonNull java.lang.String salt,
@NonNull java.lang.String signature,
@NonNull java.lang.String publicKeyUrl,
boolean create,
@NonNull java.lang.String username)
Authenticate a user with Apple Game Center.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateGameCenter(@NonNull java.lang.String playerId,
@NonNull java.lang.String bundleId,
long timestampSeconds,
@NonNull java.lang.String salt,
@NonNull java.lang.String signature,
@NonNull java.lang.String publicKeyUrl,
boolean create,
java.lang.String username,
@NonNull java.util.Map<java.lang.String,java.lang.String> vars)
Authenticate a user with Apple Game Center.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateGameCenter(@NonNull java.lang.String playerId,
@NonNull java.lang.String bundleId,
long timestampSeconds,
@NonNull java.lang.String salt,
@NonNull java.lang.String signature,
@NonNull java.lang.String publicKeyUrl,
@NonNull java.util.Map<java.lang.String,java.lang.String> vars)
Authenticate a user with Apple Game Center.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateGameCenter(@NonNull java.lang.String playerId,
@NonNull java.lang.String bundleId,
long timestampSeconds,
@NonNull java.lang.String salt,
@NonNull java.lang.String signature,
@NonNull java.lang.String publicKeyUrl,
@NonNull java.lang.String username)
Authenticate a user with Apple Game Center.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateGoogle(@NonNull java.lang.String accessToken)
Authenticate a user with a Google auth token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateGoogle(@NonNull java.lang.String accessToken,
boolean create)
Authenticate a user with a Google auth token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateGoogle(@NonNull java.lang.String accessToken,
boolean create,
@NonNull java.lang.String username)
Authenticate a user with a Google auth token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateGoogle(@NonNull java.lang.String accessToken,
boolean create,
java.lang.String username,
@NonNull java.util.Map<java.lang.String,java.lang.String> vars)
Authenticate a user with a Google auth token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateGoogle(@NonNull java.lang.String accessToken,
@NonNull java.util.Map<java.lang.String,java.lang.String> vars)
Authenticate a user with a Google auth token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateGoogle(@NonNull java.lang.String accessToken,
@NonNull java.lang.String username)
Authenticate a user with a Google auth token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateSteam(@NonNull java.lang.String token)
Authenticate a user with a Steam auth token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateSteam(@NonNull java.lang.String token,
boolean create)
Authenticate a user with a Steam auth token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateSteam(@NonNull java.lang.String token,
boolean create,
@NonNull java.lang.String username)
Authenticate a user with a Steam auth token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateSteam(@NonNull java.lang.String token,
boolean create,
@NonNull java.lang.String username,
@NonNull java.util.Map<java.lang.String,java.lang.String> vars)
Authenticate a user with a Steam auth token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateSteam(@NonNull java.lang.String token,
@NonNull java.util.Map<java.lang.String,java.lang.String> vars)
Authenticate a user with a Steam auth token.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
authenticateSteam(@NonNull java.lang.String token,
@NonNull java.lang.String username)
Authenticate a user with a Steam auth token.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
banGroupUsers(@NonNull Session session,
@NonNull java.lang.String groupId,
java.lang.String... ids)
Bans a user from a group.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
blockFriends(@NonNull Session session,
java.lang.Iterable<java.lang.String> ids,
java.lang.String... usernames)
Block one or more friends by id or username.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
blockFriends(@NonNull Session session,
java.lang.String... ids)
Block one or more friends by id.
|
com.google.common.util.concurrent.ListenableFuture<Group> |
createGroup(@NonNull Session session,
@NonNull java.lang.String name)
Create a group.
|
com.google.common.util.concurrent.ListenableFuture<Group> |
createGroup(@NonNull Session session,
@NonNull java.lang.String name,
java.lang.String description)
Create a group.
|
com.google.common.util.concurrent.ListenableFuture<Group> |
createGroup(@NonNull Session session,
@NonNull java.lang.String name,
java.lang.String description,
java.lang.String avatarUrl)
Create a group.
|
com.google.common.util.concurrent.ListenableFuture<Group> |
createGroup(@NonNull Session session,
@NonNull java.lang.String name,
java.lang.String description,
java.lang.String avatarUrl,
java.lang.String langTag)
Create a group.
|
com.google.common.util.concurrent.ListenableFuture<Group> |
createGroup(@NonNull Session session,
@NonNull java.lang.String name,
java.lang.String description,
java.lang.String avatarUrl,
java.lang.String langTag,
boolean open)
Create a group.
|
com.google.common.util.concurrent.ListenableFuture<Group> |
createGroup(@NonNull Session session,
@NonNull java.lang.String name,
java.lang.String description,
java.lang.String avatarUrl,
java.lang.String langTag,
boolean open,
int maxCount)
Create a group.
|
SocketClient |
createSocket()
Create a new socket from the client with the default port set to 7350.
|
SocketClient |
createSocket(int port)
Create a new socket from the client.
|
SocketClient |
createSocket(int port,
int socketTimeoutMs)
Create a new socket from the client.
|
SocketClient |
createSocket(java.lang.String host,
int port)
Create a new socket from the client.
|
SocketClient |
createSocket(java.lang.String host,
int port,
boolean ssl)
Create a new socket from the client.
|
SocketClient |
createSocket(java.lang.String host,
int port,
boolean ssl,
int socketTimeoutMs)
Create a new socket from the client.
|
SocketClient |
createSocket(java.lang.String host,
int port,
boolean ssl,
int socketTimeoutMs,
int socketPingMs)
Create a new socket from the client.
|
SocketClient |
createSocket(java.lang.String host,
int port,
boolean ssl,
int socketTimeoutMs,
int socketPingMs,
java.util.concurrent.ExecutorService listenerThreadExec)
Create a new socket from the client.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
deleteAccount(@NonNull Session session)
Delete account.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
deleteFriends(@NonNull Session session,
java.lang.Iterable<java.lang.String> ids,
java.lang.String... usernames)
Delete one more or users by id or username from friends.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
deleteFriends(@NonNull Session session,
java.lang.String... ids)
Delete one more or users by id.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
deleteGroup(@NonNull Session session,
@NonNull java.lang.String groupId)
Delete a group by id.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
deleteLeaderboardRecord(@NonNull Session session,
@NonNull java.lang.String leaderboardId)
Delete a leaderboard record.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
deleteNotifications(@NonNull Session session,
java.lang.String... notificationIds)
Delete one or more notifications by id.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
deleteStorageObjects(@NonNull Session session,
StorageObjectId... objectIds)
Delete one or more storage objects.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
deleteTournamentRecord(@NonNull Session session,
@NonNull java.lang.String tournamentId)
Delete a tournament record.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
demoteGroupUsers(@NonNull Session session,
@NonNull java.lang.String groupId,
java.lang.String... userIds)
Demote a set of users in a group to the next role down.
|
void |
disconnect()
Disconnects the client.
|
void |
disconnect(long timeout,
@NonNull java.util.concurrent.TimeUnit unit)
Disconnects the client.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
emitEvent(@NonNull Session session,
@NonNull java.lang.String name,
@NonNull java.util.Map<java.lang.String,java.lang.String> properties)
Submit an event for processing in the server's registered runtime custom events handler.
|
com.google.common.util.concurrent.ListenableFuture<Account> |
getAccount(@NonNull Session session)
Fetch the user account owned by the session.
|
com.google.common.util.concurrent.ListenableFuture<MatchmakerStats> |
getMatchmakerStats(@NonNull Session session)
Get the Matchmaker stats.
|
com.google.common.util.concurrent.ListenableFuture<ValidatedSubscription> |
getSubscription(@NonNull Session session,
@NonNull java.lang.String productId)
Fetch a subscription by product id.
|
com.google.common.util.concurrent.ListenableFuture<Users> |
getUsers(@NonNull Session session,
java.lang.Iterable<java.lang.String> ids,
java.lang.Iterable<java.lang.String> usernames,
java.lang.String... facebookIds)
Fetch one or more users by id, usernames, and Facebook ids.
|
com.google.common.util.concurrent.ListenableFuture<Users> |
getUsers(@NonNull Session session,
java.lang.Iterable<java.lang.String> ids,
java.lang.String... usernames)
Fetch one or more users by id, usernames, and Facebook ids.
|
com.google.common.util.concurrent.ListenableFuture<Users> |
getUsers(@NonNull Session session,
java.lang.String... ids)
Fetch one or more users by id, usernames, and Facebook ids.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
importFacebookFriends(@NonNull Session session,
@NonNull java.lang.String token)
Import Facebook friends and add them to the user's account.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
importFacebookFriends(@NonNull Session session,
@NonNull java.lang.String token,
boolean reset)
Import Facebook friends and add them to the user's account.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
importSteamFriends(@NonNull Session session,
@NonNull java.lang.String token)
Import Steam friends and add them to the user's account.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
importSteamFriends(@NonNull Session session,
@NonNull java.lang.String token,
boolean reset)
Import Steam friends and add them to the user's account.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
joinGroup(@NonNull Session session,
@NonNull java.lang.String groupId)
Join a group if it has open membership or request to join it.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
joinTournament(@NonNull Session session,
@NonNull java.lang.String tournamentId)
Join a group if it has open membership or request to join it.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
kickGroupUsers(@NonNull Session session,
@NonNull java.lang.String groupId,
java.lang.String... ids)
Kick one or more users from the group.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
leaveGroup(@NonNull Session session,
@NonNull java.lang.String groupId)
Leave a group by id.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
linkApple(@NonNull Session session,
@NonNull java.lang.String token)
Add an Apple ID to the social profiles on the current user's account.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
linkCustom(@NonNull Session session,
@NonNull java.lang.String id)
Link a custom id to the user account owned by the session.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
linkDevice(@NonNull Session session,
@NonNull java.lang.String id)
Link a device id to the user account owned by the session.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
linkEmail(@NonNull Session session,
@NonNull java.lang.String email,
@NonNull java.lang.String password)
Link an email with password to the user account owned by the session.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
linkFacebook(@NonNull Session session,
@NonNull java.lang.String accessToken)
Link a Facebook profile to a user account.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
linkFacebook(@NonNull Session session,
@NonNull java.lang.String accessToken,
boolean importFriends)
Link a Facebook profile to a user account.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
linkFacebookInstantGame(@NonNull Session session,
@NonNull java.lang.String accessToken)
Link a Facebook Instant Games profile to a user account.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
linkGameCenter(@NonNull Session session,
@NonNull java.lang.String playerId,
@NonNull java.lang.String bundleId,
long timestampSeconds,
@NonNull java.lang.String salt,
@NonNull java.lang.String signature,
@NonNull java.lang.String publicKeyUrl)
Link a Game Center profile to a user account.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
linkGoogle(@NonNull Session session,
@NonNull java.lang.String accessToken)
Link a Google profile to a user account.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
linkSteam(@NonNull Session session,
@NonNull java.lang.String token,
boolean syncFriends)
Link a Steam profile to a user account.
|
com.google.common.util.concurrent.ListenableFuture<ChannelMessageList> |
listChannelMessages(@NonNull Session session,
@NonNull java.lang.String channelId)
List messages from a chat channel.
|
com.google.common.util.concurrent.ListenableFuture<ChannelMessageList> |
listChannelMessages(@NonNull Session session,
@NonNull java.lang.String channelId,
int limit)
List messages from a chat channel.
|
com.google.common.util.concurrent.ListenableFuture<ChannelMessageList> |
listChannelMessages(@NonNull Session session,
@NonNull java.lang.String channelId,
int limit,
java.lang.String cursor)
List messages from a chat channel.
|
com.google.common.util.concurrent.ListenableFuture<ChannelMessageList> |
listChannelMessages(@NonNull Session session,
@NonNull java.lang.String channelId,
int limit,
java.lang.String cursor,
boolean forward)
List messages from a chat channel.
|
com.google.common.util.concurrent.ListenableFuture<FriendList> |
listFriends(@NonNull Session session)
List of friends of the current user.
|
com.google.common.util.concurrent.ListenableFuture<FriendList> |
listFriends(@NonNull Session session,
int state,
int limit,
java.lang.String cursor)
List of friends of the current user.
|
com.google.common.util.concurrent.ListenableFuture<FriendsOfFriendsList> |
listFriendsOfFriends(@NonNull Session session,
int limit,
java.lang.String cursor)
List friends of my firends who are not my friends yet.
|
com.google.common.util.concurrent.ListenableFuture<GroupList> |
listGroups(@NonNull Session session,
@NonNull java.lang.String name)
List groups on the server.
|
com.google.common.util.concurrent.ListenableFuture<GroupList> |
listGroups(@NonNull Session session,
@NonNull java.lang.String name,
int limit)
List groups on the server.
|
com.google.common.util.concurrent.ListenableFuture<GroupList> |
listGroups(@NonNull Session session,
java.lang.String name,
int limit,
java.lang.String cursor)
List groups on the server.
|
com.google.common.util.concurrent.ListenableFuture<GroupList> |
listGroups(@NonNull Session session,
java.lang.String name,
java.lang.String langTag,
java.lang.Integer members,
java.lang.Boolean open,
int limit,
java.lang.String cursor)
List groups on the server.
|
com.google.common.util.concurrent.ListenableFuture<GroupUserList> |
listGroupUsers(@NonNull Session session,
@NonNull java.lang.String groupId)
List all users part of the group.
|
com.google.common.util.concurrent.ListenableFuture<GroupUserList> |
listGroupUsers(@NonNull Session session,
@NonNull java.lang.String groupId,
int state,
int limit,
java.lang.String cursor)
List all users part of the group.
|
com.google.common.util.concurrent.ListenableFuture<LeaderboardRecordList> |
listLeaderboardRecords(@NonNull Session session,
@NonNull java.lang.String leaderboardId)
List records from a leaderboard.
|
com.google.common.util.concurrent.ListenableFuture<LeaderboardRecordList> |
listLeaderboardRecords(@NonNull Session session,
@NonNull java.lang.String leaderboardId,
java.lang.Iterable<java.lang.String> ownerIds,
int expiry)
List records from a leaderboard.
|
com.google.common.util.concurrent.ListenableFuture<LeaderboardRecordList> |
listLeaderboardRecords(@NonNull Session session,
@NonNull java.lang.String leaderboardId,
java.lang.Iterable<java.lang.String> ownerIds,
int expiry,
int limit)
List records from a leaderboard.
|
com.google.common.util.concurrent.ListenableFuture<LeaderboardRecordList> |
listLeaderboardRecords(@NonNull Session session,
@NonNull java.lang.String leaderboardId,
java.lang.Iterable<java.lang.String> ownerIds,
int expiry,
int limit,
java.lang.String cursor)
List records from a leaderboard.
|
com.google.common.util.concurrent.ListenableFuture<LeaderboardRecordList> |
listLeaderboardRecords(@NonNull Session session,
@NonNull java.lang.String leaderboardId,
java.lang.String... ownerIds)
List records from a leaderboard.
|
com.google.common.util.concurrent.ListenableFuture<LeaderboardRecordList> |
listLeaderboardRecordsAroundOwner(@NonNull Session session,
@NonNull java.lang.String leaderboardId,
@NonNull java.lang.String ownerId)
List leaderboard records from a given leaderboard around the owner.
|
com.google.common.util.concurrent.ListenableFuture<LeaderboardRecordList> |
listLeaderboardRecordsAroundOwner(@NonNull Session session,
@NonNull java.lang.String leaderboardId,
@NonNull java.lang.String ownerId,
int expiry)
List leaderrboard records from a given leaderboard around the owner.
|
com.google.common.util.concurrent.ListenableFuture<LeaderboardRecordList> |
listLeaderboardRecordsAroundOwner(@NonNull Session session,
@NonNull java.lang.String leaderboardId,
@NonNull java.lang.String ownerId,
int expiry,
int limit)
List leaderrboard records from a given leaderboard around the owner.
|
com.google.common.util.concurrent.ListenableFuture<LeaderboardRecordList> |
listLeaderboardRecordsAroundOwner(@NonNull Session session,
@NonNull java.lang.String leaderboardId,
@NonNull java.lang.String ownerId,
int expiry,
int limit,
java.lang.String cursor)
List leaderrboard records from a given leaderboard around the owner.
|
com.google.common.util.concurrent.ListenableFuture<MatchList> |
listMatches(@NonNull Session session)
Fetch a list of matches active on the server.
|
com.google.common.util.concurrent.ListenableFuture<MatchList> |
listMatches(@NonNull Session session,
int min)
Fetch a list of matches active on the server.
|
com.google.common.util.concurrent.ListenableFuture<MatchList> |
listMatches(@NonNull Session session,
int min,
int max)
Fetch a list of matches active on the server.
|
com.google.common.util.concurrent.ListenableFuture<MatchList> |
listMatches(@NonNull Session session,
int min,
int max,
int limit)
Fetch a list of matches active on the server.
|
com.google.common.util.concurrent.ListenableFuture<MatchList> |
listMatches(@NonNull Session session,
int min,
int max,
int limit,
java.lang.String label)
Fetch a list of matches active on the server.
|
com.google.common.util.concurrent.ListenableFuture<MatchList> |
listMatches(@NonNull Session session,
int min,
int max,
int limit,
java.lang.String label,
boolean authoritative)
Fetch a list of matches active on the server.
|
com.google.common.util.concurrent.ListenableFuture<NotificationList> |
listNotifications(@NonNull Session session)
List notifications for the user with an optional cursor.
|
com.google.common.util.concurrent.ListenableFuture<NotificationList> |
listNotifications(@NonNull Session session,
int limit)
List notifications for the user with an optional cursor.
|
com.google.common.util.concurrent.ListenableFuture<NotificationList> |
listNotifications(@NonNull Session session,
int limit,
java.lang.String cacheableCursor)
List notifications for the user with an optional cursor.
|
com.google.common.util.concurrent.ListenableFuture<StorageObjectList> |
listStorageObjects(@NonNull Session session,
@NonNull java.lang.String collection)
List storage objects in a collection which have public read access.
|
com.google.common.util.concurrent.ListenableFuture<StorageObjectList> |
listStorageObjects(@NonNull Session session,
@NonNull java.lang.String collection,
int limit)
List storage objects in a collection which have public read access.
|
com.google.common.util.concurrent.ListenableFuture<StorageObjectList> |
listStorageObjects(@NonNull Session session,
@NonNull java.lang.String collection,
int limit,
java.lang.String cursor)
List storage objects in a collection which have public read access.
|
com.google.common.util.concurrent.ListenableFuture<SubscriptionList> |
listSubscriptions(@NonNull Session session)
List user subscriptions.
|
com.google.common.util.concurrent.ListenableFuture<SubscriptionList> |
listSubscriptions(@NonNull Session session,
@NonNull int limit)
List user subscriptions.
|
com.google.common.util.concurrent.ListenableFuture<SubscriptionList> |
listSubscriptions(@NonNull Session session,
@NonNull int limit,
@NonNull java.lang.String cursor)
List user subscriptions.
|
com.google.common.util.concurrent.ListenableFuture<TournamentRecordList> |
listTournamentRecords(@NonNull Session session,
@NonNull java.lang.String tournamentId)
List tournament records from a given tournament.
|
com.google.common.util.concurrent.ListenableFuture<TournamentRecordList> |
listTournamentRecords(@NonNull Session session,
@NonNull java.lang.String tournamentId,
int expiry)
List tournament records from a given tournament.
|
com.google.common.util.concurrent.ListenableFuture<TournamentRecordList> |
listTournamentRecords(@NonNull Session session,
@NonNull java.lang.String tournamentId,
int expiry,
int limit)
List tournament records from a given tournament.
|
com.google.common.util.concurrent.ListenableFuture<TournamentRecordList> |
listTournamentRecords(@NonNull Session session,
@NonNull java.lang.String tournamentId,
int expiry,
int limit,
java.lang.String cursor)
List tournament records from a given tournament.
|
com.google.common.util.concurrent.ListenableFuture<TournamentRecordList> |
listTournamentRecords(@NonNull Session session,
@NonNull java.lang.String tournamentId,
int expiry,
int limit,
java.lang.String cursor,
java.lang.String... ownerIds)
List tournament records from a given tournament.
|
com.google.common.util.concurrent.ListenableFuture<TournamentRecordList> |
listTournamentRecords(@NonNull Session session,
@NonNull java.lang.String tournamentId,
java.lang.String... ownerIds)
List tournament records from a given tournament.
|
com.google.common.util.concurrent.ListenableFuture<TournamentRecordList> |
listTournamentRecordsAroundOwner(@NonNull Session session,
@NonNull java.lang.String tournamentId,
@NonNull java.lang.String ownerId)
List tournament records from a given tournament around the owner.
|
com.google.common.util.concurrent.ListenableFuture<TournamentRecordList> |
listTournamentRecordsAroundOwner(@NonNull Session session,
@NonNull java.lang.String tournamentId,
@NonNull java.lang.String ownerId,
int expiry)
List tournament records from a given tournament around the owner.
|
com.google.common.util.concurrent.ListenableFuture<TournamentRecordList> |
listTournamentRecordsAroundOwner(@NonNull Session session,
@NonNull java.lang.String tournamentId,
@NonNull java.lang.String ownerId,
int expiry,
int limit)
List tournament records from a given tournament around the owner.
|
com.google.common.util.concurrent.ListenableFuture<TournamentRecordList> |
listTournamentRecordsAroundOwner(@NonNull Session session,
@NonNull java.lang.String tournamentId,
@NonNull java.lang.String ownerId,
int expiry,
int limit,
java.lang.String cursor)
List tournament records from a given tournament around the owner.
|
com.google.common.util.concurrent.ListenableFuture<TournamentList> |
listTournaments(@NonNull Session session)
List active/upcoming tournaments based on given filters.
|
com.google.common.util.concurrent.ListenableFuture<TournamentList> |
listTournaments(@NonNull Session session,
int categoryStart)
List active/upcoming tournaments based on given filters.
|
com.google.common.util.concurrent.ListenableFuture<TournamentList> |
listTournaments(@NonNull Session session,
int categoryStart,
int categoryEnd)
List active/upcoming tournaments based on given filters.
|
com.google.common.util.concurrent.ListenableFuture<TournamentList> |
listTournaments(@NonNull Session session,
int categoryStart,
int categoryEnd,
long startTime)
List active/upcoming tournaments based on given filters.
|
com.google.common.util.concurrent.ListenableFuture<TournamentList> |
listTournaments(@NonNull Session session,
int categoryStart,
int categoryEnd,
long startTime,
long endTime)
List active/upcoming tournaments based on given filters.
|
com.google.common.util.concurrent.ListenableFuture<TournamentList> |
listTournaments(@NonNull Session session,
int categoryStart,
int categoryEnd,
long startTime,
long endTime,
int limit,
java.lang.String cursor)
List active/upcoming tournaments based on given filters.
|
com.google.common.util.concurrent.ListenableFuture<TournamentList> |
listTournaments(@NonNull Session session,
int limit,
java.lang.String cursor)
List active/upcoming tournaments based on given filters.
|
com.google.common.util.concurrent.ListenableFuture<UserGroupList> |
listUserGroups(@NonNull Session session)
List of groups the current user is a member of.
|
com.google.common.util.concurrent.ListenableFuture<UserGroupList> |
listUserGroups(@NonNull Session session,
java.lang.String userId)
List groups a user is a member of.
|
com.google.common.util.concurrent.ListenableFuture<UserGroupList> |
listUserGroups(@NonNull Session session,
@NonNull java.lang.String userId,
int state,
int limit,
java.lang.String cursor)
List groups a user is a member of.
|
com.google.common.util.concurrent.ListenableFuture<StorageObjectList> |
listUsersStorageObjects(@NonNull Session session,
@NonNull java.lang.String collection,
java.lang.String userId)
List storage objects in a collection which belong to a specific user and have public read access.
|
com.google.common.util.concurrent.ListenableFuture<StorageObjectList> |
listUsersStorageObjects(@NonNull Session session,
@NonNull java.lang.String collection,
java.lang.String userId,
int limit)
List storage objects in a collection which belong to a specific user and have public read access.
|
com.google.common.util.concurrent.ListenableFuture<StorageObjectList> |
listUsersStorageObjects(@NonNull Session session,
@NonNull java.lang.String collection,
java.lang.String userId,
int limit,
java.lang.String cursor)
List storage objects in a collection which belong to a specific user and have public read access.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
logoutSession(@NonNull Session session)
Log out a session, invalidate a refresh token, or log out all sessions/refresh tokens for a user.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
promoteGroupUsers(@NonNull Session session,
@NonNull java.lang.String groupId,
java.lang.String... ids)
Promote one or more users in the group.
|
com.google.common.util.concurrent.ListenableFuture<StorageObjects> |
readStorageObjects(@NonNull Session session,
StorageObjectId... objectIds)
Read one or more objects from the storage engine.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
refreshSession(@NonNull Session session)
Refresh a user's session using a refresh token retrieved from a previous authentication request.
|
com.google.common.util.concurrent.ListenableFuture<Session> |
refreshSession(@NonNull Session session,
@NonNull java.util.Map<java.lang.String,java.lang.String> vars)
Refresh a user's session using a refresh token retrieved from a previous authentication request.
|
com.google.common.util.concurrent.ListenableFuture<Rpc> |
rpc(@NonNull Session session,
@NonNull java.lang.String id)
Execute a Lua function with an input payload on the server.
|
com.google.common.util.concurrent.ListenableFuture<Rpc> |
rpc(@NonNull Session session,
@NonNull java.lang.String id,
java.lang.String payload)
Execute a Lua function with an input payload on the server.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
unlinkApple(@NonNull Session session,
@NonNull java.lang.String id)
Remove the Apple ID from the social profiles on the current user's account.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
unlinkCustom(@NonNull Session session,
@NonNull java.lang.String id)
Unlink a custom id from the user account owned by the session.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
unlinkDevice(@NonNull Session session,
@NonNull java.lang.String id)
Unlink a device id from the user account owned by the session.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
unlinkEmail(@NonNull Session session,
@NonNull java.lang.String email,
@NonNull java.lang.String password)
Unlink an email with password from the user account owned by the session.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
unlinkFacebook(@NonNull Session session,
@NonNull java.lang.String accessToken)
Unlink a Facebook profile from the user account owned by the session.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
unlinkFacebookInstantGame(@NonNull Session session,
@NonNull java.lang.String accessToken)
Unlink a Facebook Instant Games profile from the user account owned by the session.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
unlinkGameCenter(@NonNull Session session,
@NonNull java.lang.String playerId,
@NonNull java.lang.String bundleId,
long timestampSeconds,
@NonNull java.lang.String salt,
@NonNull java.lang.String signature,
@NonNull java.lang.String publicKeyUrl)
Unlink a Game Center profile from the user account owned by the session.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
unlinkGoogle(@NonNull Session session,
@NonNull java.lang.String accessToken)
Unlink a Google profile from the user account owned by the session.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
unlinkSteam(@NonNull Session session,
@NonNull java.lang.String token)
Unlink a Steam profile from the user account owned by the session.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
updateAccount(@NonNull Session session,
java.lang.String username)
Update the current user's account on the server.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
updateAccount(@NonNull Session session,
java.lang.String username,
java.lang.String displayName)
Update the current user's account on the server.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
updateAccount(@NonNull Session session,
java.lang.String username,
java.lang.String displayName,
java.lang.String avatarUrl)
Update the current user's account on the server.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
updateAccount(@NonNull Session session,
java.lang.String username,
java.lang.String displayName,
java.lang.String avatarUrl,
java.lang.String langTag)
Update the current user's account on the server.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
updateAccount(@NonNull Session session,
java.lang.String username,
java.lang.String displayName,
java.lang.String avatarUrl,
java.lang.String langTag,
java.lang.String location)
Update the current user's account on the server.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
updateAccount(@NonNull Session session,
java.lang.String username,
java.lang.String displayName,
java.lang.String avatarUrl,
java.lang.String langTag,
java.lang.String location,
java.lang.String timezone)
Update the current user's account on the server.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
updateGroup(@NonNull Session session,
@NonNull java.lang.String groupId,
java.lang.String name)
Update a group.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
updateGroup(@NonNull Session session,
@NonNull java.lang.String groupId,
java.lang.String name,
java.lang.String description)
Update a group.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
updateGroup(@NonNull Session session,
@NonNull java.lang.String groupId,
java.lang.String name,
java.lang.String description,
java.lang.String avatarUrl)
Update a group.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
updateGroup(@NonNull Session session,
@NonNull java.lang.String groupId,
java.lang.String name,
java.lang.String description,
java.lang.String avatarUrl,
java.lang.String langTag)
Update a group.
|
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
updateGroup(@NonNull Session session,
@NonNull java.lang.String groupId,
java.lang.String name,
java.lang.String description,
java.lang.String avatarUrl,
java.lang.String langTag,
boolean open)
Update a group.
|
com.google.common.util.concurrent.ListenableFuture<ValidatePurchaseResponse> |
validatePurchaseApple(@NonNull Session session,
@NonNull java.lang.String receipt,
@NonNull boolean persist)
Validate Apple IAP Receipt.
|
com.google.common.util.concurrent.ListenableFuture<ValidatePurchaseResponse> |
validatePurchaseFacebookInstant(@NonNull Session session,
@NonNull java.lang.String signedRequest,
@NonNull boolean persist)
Validate FB Instant IAP Receipt.
|
com.google.common.util.concurrent.ListenableFuture<ValidatePurchaseResponse> |
validatePurchaseGoogle(@NonNull Session session,
@NonNull java.lang.String receipt,
@NonNull boolean persist)
Validate Google IAP Receipt.
|
com.google.common.util.concurrent.ListenableFuture<ValidatePurchaseResponse> |
validatePurchaseHuawei(@NonNull Session session,
@NonNull java.lang.String receipt,
@NonNull boolean persist)
Validate Huawei IAP Receipt.
|
com.google.common.util.concurrent.ListenableFuture<ValidateSubscriptionResponse> |
validateSubscriptionApple(@NonNull Session session,
@NonNull java.lang.String receipt,
@NonNull boolean persist)
Validate Apple Subscription Receipt
|
com.google.common.util.concurrent.ListenableFuture<ValidateSubscriptionResponse> |
validateSubscriptionGoogle(@NonNull Session session,
@NonNull java.lang.String receipt,
@NonNull boolean persist)
Validate Google Subscription Receipt
|
com.google.common.util.concurrent.ListenableFuture<LeaderboardRecord> |
writeLeaderboardRecord(@NonNull Session session,
@NonNull java.lang.String leaderboardId,
@NonNull long score)
Write a record to a leaderboard.
|
com.google.common.util.concurrent.ListenableFuture<LeaderboardRecord> |
writeLeaderboardRecord(@NonNull Session session,
@NonNull java.lang.String leaderboardId,
@NonNull long score,
@NonNull long subscore)
Write a record to a leaderboard.
|
com.google.common.util.concurrent.ListenableFuture<LeaderboardRecord> |
writeLeaderboardRecord(@NonNull Session session,
@NonNull java.lang.String leaderboardId,
@NonNull long score,
@NonNull long subscore,
@NonNull java.lang.String metadata)
Write a record to a leaderboard.
|
com.google.common.util.concurrent.ListenableFuture<LeaderboardRecord> |
writeLeaderboardRecord(@NonNull Session session,
@NonNull java.lang.String leaderboardId,
@NonNull long score,
@NonNull long subscore,
@NonNull java.lang.String metadata,
@NonNull Operator operator)
Write a record to a leaderboard.
|
com.google.common.util.concurrent.ListenableFuture<LeaderboardRecord> |
writeLeaderboardRecord(@NonNull Session session,
@NonNull java.lang.String leaderboardId,
@NonNull long score,
@NonNull java.lang.String metadata)
Write a record to a leaderboard.
|
com.google.common.util.concurrent.ListenableFuture<StorageObjectAcks> |
writeStorageObjects(@NonNull Session session,
StorageObjectWrite... objects)
Write objects to the storage engine.
|
com.google.common.util.concurrent.ListenableFuture<LeaderboardRecord> |
writeTournamentRecord(@NonNull Session session,
@NonNull java.lang.String tournamentId,
@NonNull long score)
A request to submit a score to a tournament.
|
com.google.common.util.concurrent.ListenableFuture<LeaderboardRecord> |
writeTournamentRecord(@NonNull Session session,
@NonNull java.lang.String tournamentId,
@NonNull long score,
@NonNull long subscore)
A request to submit a score to a tournament.
|
com.google.common.util.concurrent.ListenableFuture<LeaderboardRecord> |
writeTournamentRecord(@NonNull Session session,
@NonNull java.lang.String tournamentId,
@NonNull long score,
@NonNull long subscore,
@NonNull java.lang.String metadata)
A request to submit a score to a tournament.
|
com.google.common.util.concurrent.ListenableFuture<LeaderboardRecord> |
writeTournamentRecord(@NonNull Session session,
@NonNull java.lang.String tournamentId,
@NonNull long score,
@NonNull long subscore,
@NonNull java.lang.String metadata,
@NonNull Operator operator)
A request to submit a score to a tournament.
|
com.google.common.util.concurrent.ListenableFuture<LeaderboardRecord> |
writeTournamentRecord(@NonNull Session session,
@NonNull java.lang.String tournamentId,
@NonNull long score,
@NonNull java.lang.String metadata)
A request to submit a score to a tournament.
|
void disconnect(long timeout, @NonNull @NonNull java.util.concurrent.TimeUnit unit) throws java.lang.InterruptedException
java.lang.InterruptedException
void disconnect()
SocketClient createSocket()
SocketClient createSocket(int port)
port
- The port number of the server. Default should be 7350.SocketClient createSocket(int port, int socketTimeoutMs)
port
- The port number of the server. Default should be 7350.socketTimeoutMs
- Sets the connect, read and write timeout for new connections.SocketClient createSocket(java.lang.String host, int port)
host
- The host URL of the server.port
- The port number of the server. Default should be 7350.SocketClient createSocket(java.lang.String host, int port, boolean ssl)
host
- The host URL of the server.port
- The port number of the server. Default should be 7350.ssl
- Whether to use SSL to connect to the server.SocketClient createSocket(java.lang.String host, int port, boolean ssl, int socketTimeoutMs)
host
- The host URL of the server.port
- The port number of the server. Default should be 7350.ssl
- Whether to use SSL to connect to the server.socketTimeoutMs
- Sets the connect, read and write timeout for new connections.SocketClient createSocket(java.lang.String host, int port, boolean ssl, int socketTimeoutMs, int socketPingMs)
host
- The host URL of the server.port
- The port number of the server. Default should be 7350.ssl
- Whether to use SSL to connect to the server.socketTimeoutMs
- Sets the connect, read and write timeout for new connections.socketPingMs
- The interval at which to send Ping frames to the server.SocketClient createSocket(java.lang.String host, int port, boolean ssl, int socketTimeoutMs, int socketPingMs, java.util.concurrent.ExecutorService listenerThreadExec)
host
- The host URL of the server.port
- The port number of the server. Default should be 7350.ssl
- Whether to use SSL to connect to the server.socketTimeoutMs
- Sets the connect, read and write timeout for new connections.socketPingMs
- The interval at which to send Ping frames to the server.listenerThreadExec
- The threading model to use when processing socket messages from the server.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> addFriends(@NonNull @NonNull Session session, @NonNull java.lang.String... ids)
session
- The session of the user.ids
- The ids of the users to add or invite as friends.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> addFriends(@NonNull @NonNull Session session, java.lang.Iterable<java.lang.String> ids, java.lang.String... usernames)
session
- The session of the user.ids
- The ids of the users to add or invite as friends.usernames
- The usernames of the users to add as friends.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> addGroupUsers(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String groupId, @NonNull java.lang.String... ids)
session
- The session of the user.groupId
- The id of the group to add users into.ids
- The ids of the users to add or invite to the group.com.google.common.util.concurrent.ListenableFuture<Session> authenticateApple(@NonNull @NonNull java.lang.String token)
token
- The ID token received from Apple to validate.com.google.common.util.concurrent.ListenableFuture<Session> authenticateApple(@NonNull @NonNull java.lang.String token, @NonNull @NonNull java.util.Map<java.lang.String,java.lang.String> vars)
token
- The ID token received from Apple to validate.vars
- Extra information that will be bundled in the session token.com.google.common.util.concurrent.ListenableFuture<Session> authenticateApple(@NonNull @NonNull java.lang.String token, @NonNull @NonNull java.lang.String username)
token
- The ID token received from Apple to validate.username
- A username used to create the user.com.google.common.util.concurrent.ListenableFuture<Session> authenticateApple(@NonNull @NonNull java.lang.String token, boolean create)
token
- The ID token received from Apple to validate.create
- True if the user should be created when authenticated.com.google.common.util.concurrent.ListenableFuture<Session> authenticateApple(@NonNull @NonNull java.lang.String token, boolean create, @NonNull @NonNull java.lang.String username)
token
- The ID token received from Apple to validate.create
- True if the user should be created when authenticated.username
- A username used to create the user.com.google.common.util.concurrent.ListenableFuture<Session> authenticateApple(@NonNull @NonNull java.lang.String token, boolean create, java.lang.String username, @NonNull @NonNull java.util.Map<java.lang.String,java.lang.String> vars)
token
- The ID token received from Apple to validate.create
- True if the user should be created when authenticated.username
- A username used to create the user.vars
- Extra information that will be bundled in the session token.com.google.common.util.concurrent.ListenableFuture<Session> authenticateCustom(@NonNull @NonNull java.lang.String id)
id
- A custom identifier usually obtained from an external authentication service.com.google.common.util.concurrent.ListenableFuture<Session> authenticateCustom(@NonNull @NonNull java.lang.String id, @NonNull @NonNull java.util.Map<java.lang.String,java.lang.String> vars)
id
- A custom identifier usually obtained from an external authentication service.vars
- Extra information that will be bundled in the session token.com.google.common.util.concurrent.ListenableFuture<Session> authenticateCustom(@NonNull @NonNull java.lang.String id, @NonNull @NonNull java.lang.String username)
id
- A custom identifier usually obtained from an external authentication service.username
- A username used to create the user.com.google.common.util.concurrent.ListenableFuture<Session> authenticateCustom(@NonNull @NonNull java.lang.String id, boolean create)
id
- A custom identifier usually obtained from an external authentication service.create
- True if the user should be created when authenticated.com.google.common.util.concurrent.ListenableFuture<Session> authenticateCustom(@NonNull @NonNull java.lang.String id, boolean create, @NonNull @NonNull java.lang.String username)
id
- A custom identifier usually obtained from an external authentication service.create
- True if the user should be created when authenticated.username
- A username used to create the user.com.google.common.util.concurrent.ListenableFuture<Session> authenticateCustom(@NonNull @NonNull java.lang.String id, boolean create, java.lang.String username, @NonNull @NonNull java.util.Map<java.lang.String,java.lang.String> vars)
id
- A custom identifier usually obtained from an external authentication service.create
- True if the user should be created when authenticated.username
- A username used to create the user.vars
- Extra information that will be bundled in the session token.com.google.common.util.concurrent.ListenableFuture<Session> authenticateDevice(@NonNull @NonNull java.lang.String id)
id
- A device identifier usually obtained from a platform API.com.google.common.util.concurrent.ListenableFuture<Session> authenticateDevice(@NonNull @NonNull java.lang.String id, @NonNull @NonNull java.util.Map<java.lang.String,java.lang.String> vars)
id
- A device identifier usually obtained from a platform API.vars
- Extra information that will be bundled in the session token.com.google.common.util.concurrent.ListenableFuture<Session> authenticateDevice(@NonNull @NonNull java.lang.String id, @NonNull @NonNull java.lang.String username)
id
- A device identifier usually obtained from a platform API.username
- A username used to create the user.com.google.common.util.concurrent.ListenableFuture<Session> authenticateDevice(@NonNull @NonNull java.lang.String id, boolean create)
id
- A device identifier usually obtained from a platform API.create
- True if the user should be created when authenticated.com.google.common.util.concurrent.ListenableFuture<Session> authenticateDevice(@NonNull @NonNull java.lang.String id, boolean create, @NonNull @NonNull java.lang.String username)
id
- A device identifier usually obtained from a platform API.create
- True if the user should be created when authenticated.username
- A username used to create the user.com.google.common.util.concurrent.ListenableFuture<Session> authenticateDevice(@NonNull @NonNull java.lang.String id, boolean create, java.lang.String username, @NonNull @NonNull java.util.Map<java.lang.String,java.lang.String> vars)
id
- A device identifier usually obtained from a platform API.create
- True if the user should be created when authenticated.username
- A username used to create the user.vars
- Extra information that will be bundled in the session token.com.google.common.util.concurrent.ListenableFuture<Session> authenticateEmail(@NonNull @NonNull java.lang.String email, @NonNull @NonNull java.lang.String password)
email
- The email address of the user.password
- The password for the user.com.google.common.util.concurrent.ListenableFuture<Session> authenticateEmail(@NonNull @NonNull java.lang.String email, @NonNull @NonNull java.lang.String password, @NonNull @NonNull java.util.Map<java.lang.String,java.lang.String> vars)
email
- The email address of the user.password
- The password for the user.vars
- Extra information that will be bundled in the session token.com.google.common.util.concurrent.ListenableFuture<Session> authenticateEmail(@NonNull @NonNull java.lang.String email, @NonNull @NonNull java.lang.String password, @NonNull @NonNull java.lang.String username)
email
- The email address of the user.password
- The password for the user.username
- A username used to create the user.com.google.common.util.concurrent.ListenableFuture<Session> authenticateEmail(@NonNull @NonNull java.lang.String email, @NonNull @NonNull java.lang.String password, boolean create)
email
- The email address of the user.password
- The password for the user.create
- True if the user should be created when authenticated.com.google.common.util.concurrent.ListenableFuture<Session> authenticateEmail(@NonNull @NonNull java.lang.String email, @NonNull @NonNull java.lang.String password, boolean create, @NonNull @NonNull java.lang.String username)
email
- The email address of the user.password
- The password for the user.create
- True if the user should be created when authenticated.username
- A username used to create the user.com.google.common.util.concurrent.ListenableFuture<Session> authenticateEmail(@NonNull @NonNull java.lang.String email, @NonNull @NonNull java.lang.String password, boolean create, java.lang.String username, @NonNull @NonNull java.util.Map<java.lang.String,java.lang.String> vars)
email
- The email address of the user.password
- The password for the user.create
- True if the user should be created when authenticated.username
- A username used to create the user.vars
- Extra information that will be bundled in the session token.com.google.common.util.concurrent.ListenableFuture<Session> authenticateFacebook(@NonNull @NonNull java.lang.String accessToken)
accessToken
- An OAuth access token from the Facebook SDK.com.google.common.util.concurrent.ListenableFuture<Session> authenticateFacebook(@NonNull @NonNull java.lang.String accessToken, @NonNull @NonNull java.util.Map<java.lang.String,java.lang.String> vars)
accessToken
- An OAuth access token from the Facebook SDK.vars
- Extra information that will be bundled in the session token.com.google.common.util.concurrent.ListenableFuture<Session> authenticateFacebook(@NonNull @NonNull java.lang.String accessToken, @NonNull @NonNull java.lang.String username)
accessToken
- An OAuth access token from the Facebook SDK.username
- A username used to create the user.com.google.common.util.concurrent.ListenableFuture<Session> authenticateFacebook(@NonNull @NonNull java.lang.String accessToken, boolean create)
accessToken
- An OAuth access token from the Facebook SDK.create
- True if the user should be created when authenticated.com.google.common.util.concurrent.ListenableFuture<Session> authenticateFacebook(@NonNull @NonNull java.lang.String accessToken, boolean create, @NonNull @NonNull java.lang.String username)
accessToken
- An OAuth access token from the Facebook SDK.create
- True if the user should be created when authenticated.username
- A username used to create the user.com.google.common.util.concurrent.ListenableFuture<Session> authenticateFacebook(@NonNull @NonNull java.lang.String accessToken, boolean create, @NonNull @NonNull java.lang.String username, boolean importFriends)
accessToken
- An OAuth access token from the Facebook SDK.create
- True if the user should be created when authenticated.username
- A username used to create the user.importFriends
- True if the Facebook friends should be imported.com.google.common.util.concurrent.ListenableFuture<Session> authenticateFacebook(@NonNull @NonNull java.lang.String accessToken, boolean create, java.lang.String username, boolean importFriends, @NonNull @NonNull java.util.Map<java.lang.String,java.lang.String> vars)
accessToken
- An OAuth access token from the Facebook SDK.create
- True if the user should be created when authenticated.username
- A username used to create the user.importFriends
- True if the Facebook friends should be imported.vars
- Extra information that will be bundled in the session token.com.google.common.util.concurrent.ListenableFuture<Session> authenticateFacebookInstantGame(@NonNull @NonNull java.lang.String accessToken)
accessToken
- An access token from the Facebook SDK.com.google.common.util.concurrent.ListenableFuture<Session> authenticateFacebookInstantGame(@NonNull @NonNull java.lang.String accessToken, @NonNull @NonNull java.util.Map<java.lang.String,java.lang.String> vars)
accessToken
- An OAuth access token from the Facebook SDK.vars
- Extra information that will be bundled in the session token.com.google.common.util.concurrent.ListenableFuture<Session> authenticateFacebookInstantGame(@NonNull @NonNull java.lang.String accessToken, @NonNull @NonNull java.lang.String username)
accessToken
- An OAuth access token from the Facebook SDK.username
- A username used to create the user.com.google.common.util.concurrent.ListenableFuture<Session> authenticateFacebookInstantGame(@NonNull @NonNull java.lang.String accessToken, boolean create)
accessToken
- An OAuth access token from the Facebook SDK.create
- True if the user should be created when authenticated.com.google.common.util.concurrent.ListenableFuture<Session> authenticateFacebookInstantGame(@NonNull @NonNull java.lang.String accessToken, boolean create, @NonNull @NonNull java.lang.String username)
accessToken
- An OAuth access token from the Facebook SDK.create
- True if the user should be created when authenticated.username
- A username used to create the user.com.google.common.util.concurrent.ListenableFuture<Session> authenticateFacebookInstantGame(@NonNull @NonNull java.lang.String accessToken, boolean create, java.lang.String username, @NonNull @NonNull java.util.Map<java.lang.String,java.lang.String> vars)
accessToken
- An OAuth access token from the Facebook SDK.create
- True if the user should be created when authenticated.username
- A username used to create the user.vars
- Extra information that will be bundled in the session token.com.google.common.util.concurrent.ListenableFuture<Session> authenticateGoogle(@NonNull @NonNull java.lang.String accessToken)
accessToken
- An OAuth access token from the Google SDK.com.google.common.util.concurrent.ListenableFuture<Session> authenticateGoogle(@NonNull @NonNull java.lang.String accessToken, @NonNull @NonNull java.util.Map<java.lang.String,java.lang.String> vars)
accessToken
- An OAuth access token from the Google SDK.vars
- Extra information that will be bundled in the session token.com.google.common.util.concurrent.ListenableFuture<Session> authenticateGoogle(@NonNull @NonNull java.lang.String accessToken, @NonNull @NonNull java.lang.String username)
accessToken
- An OAuth access token from the Google SDK.username
- A username used to create the user.com.google.common.util.concurrent.ListenableFuture<Session> authenticateGoogle(@NonNull @NonNull java.lang.String accessToken, boolean create)
accessToken
- An OAuth access token from the Google SDK.create
- True if the user should be created when authenticated.com.google.common.util.concurrent.ListenableFuture<Session> authenticateGoogle(@NonNull @NonNull java.lang.String accessToken, boolean create, @NonNull @NonNull java.lang.String username)
accessToken
- An OAuth access token from the Google SDK.create
- True if the user should be created when authenticated.username
- A username used to create the user.com.google.common.util.concurrent.ListenableFuture<Session> authenticateGoogle(@NonNull @NonNull java.lang.String accessToken, boolean create, java.lang.String username, @NonNull @NonNull java.util.Map<java.lang.String,java.lang.String> vars)
accessToken
- An OAuth access token from the Google SDK.create
- True if the user should be created when authenticated.username
- A username used to create the user.vars
- Extra information that will be bundled in the session token.com.google.common.util.concurrent.ListenableFuture<Session> authenticateSteam(@NonNull @NonNull java.lang.String token)
token
- An authentication token from the Steam network.com.google.common.util.concurrent.ListenableFuture<Session> authenticateSteam(@NonNull @NonNull java.lang.String token, @NonNull @NonNull java.util.Map<java.lang.String,java.lang.String> vars)
token
- An authentication token from the Steam network.vars
- Extra information that will be bundled in the session token.com.google.common.util.concurrent.ListenableFuture<Session> authenticateSteam(@NonNull @NonNull java.lang.String token, @NonNull @NonNull java.lang.String username)
token
- An authentication token from the Steam network.username
- A username used to create the user.com.google.common.util.concurrent.ListenableFuture<Session> authenticateSteam(@NonNull @NonNull java.lang.String token, boolean create)
token
- An authentication token from the Steam network.create
- True if the user should be created when authenticated.com.google.common.util.concurrent.ListenableFuture<Session> authenticateSteam(@NonNull @NonNull java.lang.String token, boolean create, @NonNull @NonNull java.lang.String username)
token
- An authentication token from the Steam network.create
- True if the user should be created when authenticated.username
- A username used to create the user.com.google.common.util.concurrent.ListenableFuture<Session> authenticateSteam(@NonNull @NonNull java.lang.String token, boolean create, @NonNull @NonNull java.lang.String username, @NonNull @NonNull java.util.Map<java.lang.String,java.lang.String> vars)
token
- An authentication token from the Steam network.create
- True if the user should be created when authenticated.username
- A username used to create the user.vars
- Extra information that will be bundled in the session token.com.google.common.util.concurrent.ListenableFuture<Session> authenticateGameCenter(@NonNull @NonNull java.lang.String playerId, @NonNull @NonNull java.lang.String bundleId, long timestampSeconds, @NonNull @NonNull java.lang.String salt, @NonNull @NonNull java.lang.String signature, @NonNull @NonNull java.lang.String publicKeyUrl)
playerId
- The player id of the user in Game Center.bundleId
- The bundle id of the Game Center application.timestampSeconds
- The date and time that the signature was created.salt
- A random String used to compute the hash and keep it randomized.signature
- The verification signature data generated.publicKeyUrl
- The URL for the public encryption key.com.google.common.util.concurrent.ListenableFuture<Session> authenticateGameCenter(@NonNull @NonNull java.lang.String playerId, @NonNull @NonNull java.lang.String bundleId, long timestampSeconds, @NonNull @NonNull java.lang.String salt, @NonNull @NonNull java.lang.String signature, @NonNull @NonNull java.lang.String publicKeyUrl, @NonNull @NonNull java.util.Map<java.lang.String,java.lang.String> vars)
playerId
- The player id of the user in Game Center.bundleId
- The bundle id of the Game Center application.timestampSeconds
- The date and time that the signature was created.salt
- A random String used to compute the hash and keep it randomized.signature
- The verification signature data generated.publicKeyUrl
- The URL for the public encryption key.vars
- Extra information that will be bundled in the session token.com.google.common.util.concurrent.ListenableFuture<Session> authenticateGameCenter(@NonNull @NonNull java.lang.String playerId, @NonNull @NonNull java.lang.String bundleId, long timestampSeconds, @NonNull @NonNull java.lang.String salt, @NonNull @NonNull java.lang.String signature, @NonNull @NonNull java.lang.String publicKeyUrl, @NonNull @NonNull java.lang.String username)
playerId
- The player id of the user in Game Center.bundleId
- The bundle id of the Game Center application.timestampSeconds
- The date and time that the signature was created.salt
- A random String used to compute the hash and keep it randomized.signature
- The verification signature data generated.publicKeyUrl
- The URL for the public encryption key.username
- A username used to create the user.com.google.common.util.concurrent.ListenableFuture<Session> authenticateGameCenter(@NonNull @NonNull java.lang.String playerId, @NonNull @NonNull java.lang.String bundleId, long timestampSeconds, @NonNull @NonNull java.lang.String salt, @NonNull @NonNull java.lang.String signature, @NonNull @NonNull java.lang.String publicKeyUrl, boolean create)
playerId
- The player id of the user in Game Center.bundleId
- The bundle id of the Game Center application.timestampSeconds
- The date and time that the signature was created.salt
- A random String used to compute the hash and keep it randomized.signature
- The verification signature data generated.publicKeyUrl
- The URL for the public encryption key.create
- True if the user should be created when authenticated.com.google.common.util.concurrent.ListenableFuture<Session> authenticateGameCenter(@NonNull @NonNull java.lang.String playerId, @NonNull @NonNull java.lang.String bundleId, long timestampSeconds, @NonNull @NonNull java.lang.String salt, @NonNull @NonNull java.lang.String signature, @NonNull @NonNull java.lang.String publicKeyUrl, boolean create, @NonNull @NonNull java.lang.String username)
playerId
- The player id of the user in Game Center.bundleId
- The bundle id of the Game Center application.timestampSeconds
- The date and time that the signature was created.salt
- A random String used to compute the hash and keep it randomized.signature
- The verification signature data generated.publicKeyUrl
- The URL for the public encryption key.create
- True if the user should be created when authenticated.username
- A username used to create the user.com.google.common.util.concurrent.ListenableFuture<Session> authenticateGameCenter(@NonNull @NonNull java.lang.String playerId, @NonNull @NonNull java.lang.String bundleId, long timestampSeconds, @NonNull @NonNull java.lang.String salt, @NonNull @NonNull java.lang.String signature, @NonNull @NonNull java.lang.String publicKeyUrl, boolean create, java.lang.String username, @NonNull @NonNull java.util.Map<java.lang.String,java.lang.String> vars)
playerId
- The player id of the user in Game Center.bundleId
- The bundle id of the Game Center application.timestampSeconds
- The date and time that the signature was created.salt
- A random String used to compute the hash and keep it randomized.signature
- The verification signature data generated.publicKeyUrl
- The URL for the public encryption key.create
- True if the user should be created when authenticated.username
- A username used to create the user.vars
- Extra information that will be bundled in the session token.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> banGroupUsers(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String groupId, @NonNull java.lang.String... ids)
session
- The session of the user.groupId
- The group to ban the users from.ids
- The users to ban from the group..com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> blockFriends(@NonNull @NonNull Session session, @NonNull java.lang.String... ids)
session
- The session of the user.ids
- The ids of the users to block.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> blockFriends(@NonNull @NonNull Session session, java.lang.Iterable<java.lang.String> ids, java.lang.String... usernames)
session
- The session of the user.ids
- The ids of the users to block.usernames
- The usernames of the users to block.com.google.common.util.concurrent.ListenableFuture<Group> createGroup(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String name)
session
- The session of the user.name
- The name for the group.com.google.common.util.concurrent.ListenableFuture<Group> createGroup(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String name, java.lang.String description)
session
- The session of the user.name
- The name for the group.description
- A description for the group.com.google.common.util.concurrent.ListenableFuture<Group> createGroup(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String name, java.lang.String description, java.lang.String avatarUrl)
session
- The session of the user.name
- The name for the group.description
- A description for the group.avatarUrl
- An avatar url for the group.com.google.common.util.concurrent.ListenableFuture<Group> createGroup(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String name, java.lang.String description, java.lang.String avatarUrl, java.lang.String langTag)
session
- The session of the user.name
- The name for the group.description
- A description for the group.avatarUrl
- An avatar url for the group.langTag
- A language tag in BCP-47 format for the group.com.google.common.util.concurrent.ListenableFuture<Group> createGroup(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String name, java.lang.String description, java.lang.String avatarUrl, java.lang.String langTag, boolean open)
session
- The session of the user.name
- The name for the group.description
- A description for the group.avatarUrl
- An avatar url for the group.langTag
- A language tag in BCP-47 format for the group.open
- True if the group should have open membership.com.google.common.util.concurrent.ListenableFuture<Group> createGroup(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String name, java.lang.String description, java.lang.String avatarUrl, java.lang.String langTag, boolean open, int maxCount)
session
- The session of the user.name
- The name for the group.description
- A description for the group.avatarUrl
- An avatar url for the group.langTag
- A language tag in BCP-47 format for the group.open
- True if the group should have open membership.maxCount
- Maximum number of group members.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteAccount(@NonNull @NonNull Session session)
session
- The session of the user.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteFriends(@NonNull @NonNull Session session, @NonNull java.lang.String... ids)
session
- The session of the user.ids
- the user ids to remove as friends.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteFriends(@NonNull @NonNull Session session, java.lang.Iterable<java.lang.String> ids, java.lang.String... usernames)
session
- The session of the user.ids
- the user ids to remove as friends.usernames
- The usernames to remove as friends.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteGroup(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String groupId)
session
- The session of the user.groupId
- The group id to to remove.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteLeaderboardRecord(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String leaderboardId)
session
- The session of the user.leaderboardId
- The id of the leaderboard with the record to be deleted.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteNotifications(@NonNull @NonNull Session session, @NonNull java.lang.String... notificationIds)
session
- The session of the user.notificationIds
- The notification ids to remove.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteStorageObjects(@NonNull @NonNull Session session, @NonNull StorageObjectId... objectIds)
session
- The session of the user.objectIds
- The ids of the objects to delete.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteTournamentRecord(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String tournamentId)
session
- The session of the user.tournamentId
- The id of the tournament with the record to be deleted.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> demoteGroupUsers(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String groupId, java.lang.String... userIds)
session
- The session of the user.groupId
- The group ID to demote in.userIds
- The users to demote.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> emitEvent(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String name, @NonNull @NonNull java.util.Map<java.lang.String,java.lang.String> properties)
session
- The session of the user.name
- An event name, type, category, or identifier.properties
- Arbitrary event property values.com.google.common.util.concurrent.ListenableFuture<Account> getAccount(@NonNull @NonNull Session session)
session
- The session of the user.com.google.common.util.concurrent.ListenableFuture<MatchmakerStats> getMatchmakerStats(@NonNull @NonNull Session session)
session
- The session of the user.com.google.common.util.concurrent.ListenableFuture<ValidatedSubscription> getSubscription(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String productId)
session
- The session of the user.productId
- Product id of the subscription.com.google.common.util.concurrent.ListenableFuture<Users> getUsers(@NonNull @NonNull Session session, @NonNull java.lang.String... ids)
session
- The session of the user.ids
- List of user IDs.com.google.common.util.concurrent.ListenableFuture<Users> getUsers(@NonNull @NonNull Session session, java.lang.Iterable<java.lang.String> ids, java.lang.String... usernames)
session
- The session of the user.ids
- List of user IDs.usernames
- List of usernames.com.google.common.util.concurrent.ListenableFuture<Users> getUsers(@NonNull @NonNull Session session, java.lang.Iterable<java.lang.String> ids, java.lang.Iterable<java.lang.String> usernames, java.lang.String... facebookIds)
session
- The session of the user.ids
- List of user IDs.usernames
- List of usernames.facebookIds
- List of Facebook IDs.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> importFacebookFriends(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String token)
session
- The session of the user.token
- An OAuth access token from the Facebook SDK.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> importFacebookFriends(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String token, boolean reset)
session
- The session of the user.token
- An OAuth access token from the Facebook SDK.reset
- True if the Facebook friend import for the user should be reset.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> importSteamFriends(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String token)
session
- The session of the user.token
- An access token from the Steam.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> importSteamFriends(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String token, boolean reset)
session
- The session of the user.token
- An access token from the Steam.reset
- True if the Steam friend import for the user should be reset.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> joinGroup(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String groupId)
session
- The session of the user.groupId
- The id of the group to join.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> joinTournament(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String tournamentId)
session
- The session of the user.tournamentId
- The id of the tournament to join.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> kickGroupUsers(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String groupId, @NonNull java.lang.String... ids)
session
- The session of the user.groupId
- The id of the group.ids
- The ids of the users to kick.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> leaveGroup(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String groupId)
session
- The session of the user.groupId
- The id of the group to leave.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> linkApple(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String token)
session
- The session of the user.token
- The token received from Apple to validate.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> linkCustom(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String id)
session
- The session of the user.id
- A custom identifier usually obtained from an external authentication service.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> linkDevice(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String id)
session
- The session of the user.id
- A device identifier usually obtained from a platform API.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> linkEmail(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String email, @NonNull @NonNull java.lang.String password)
session
- The session of the user.email
- The email address of the user.password
- The password for the user.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> linkFacebook(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String accessToken)
session
- The session of the user.accessToken
- An OAuth access token from the Facebook SDK.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> linkFacebook(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String accessToken, boolean importFriends)
session
- The session of the user.accessToken
- An OAuth access token from the Facebook SDK.importFriends
- True if the Facebook friends should be imported.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> linkFacebookInstantGame(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String accessToken)
session
- The session of the user.accessToken
- An OAuth access token from the Facebook SDK.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> linkGoogle(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String accessToken)
session
- The session of the user.accessToken
- An OAuth access token from the Google SDK.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> linkSteam(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String token, boolean syncFriends)
session
- The session of the user.token
- An authentication token from the Steam network.syncFriends
- True if the Stream friends should be synced.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> linkGameCenter(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String playerId, @NonNull @NonNull java.lang.String bundleId, long timestampSeconds, @NonNull @NonNull java.lang.String salt, @NonNull @NonNull java.lang.String signature, @NonNull @NonNull java.lang.String publicKeyUrl)
session
- The session of the user.playerId
- The player id of the user in Game Center.bundleId
- The bundle id of the Game Center application.timestampSeconds
- The date and time that the signature was created.salt
- A random String used to compute the hash and keep it randomized.signature
- The verification signature data generated.publicKeyUrl
- The URL for the public encryption key.com.google.common.util.concurrent.ListenableFuture<ChannelMessageList> listChannelMessages(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String channelId)
session
- The session of the user.channelId
- A channel identifier.com.google.common.util.concurrent.ListenableFuture<ChannelMessageList> listChannelMessages(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String channelId, int limit)
session
- The session of the user.channelId
- A channel identifier.limit
- The number of chat messages to list.com.google.common.util.concurrent.ListenableFuture<ChannelMessageList> listChannelMessages(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String channelId, int limit, java.lang.String cursor)
session
- The session of the user.channelId
- A channel identifier.limit
- The number of chat messages to list.cursor
- A cursor for the current position in the messages history to list.com.google.common.util.concurrent.ListenableFuture<ChannelMessageList> listChannelMessages(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String channelId, int limit, java.lang.String cursor, boolean forward)
session
- The session of the user.channelId
- A channel identifier.limit
- The number of chat messages to list.forward
- Fetch messages forward from the current cursor (or the start).cursor
- A cursor for the current position in the messages history to list.com.google.common.util.concurrent.ListenableFuture<FriendList> listFriends(@NonNull @NonNull Session session)
session
- The session of the user.com.google.common.util.concurrent.ListenableFuture<FriendList> listFriends(@NonNull @NonNull Session session, int state, int limit, java.lang.String cursor)
session
- The session of the user.state
- The friend state to list.limit
- Max number of records to return. Between 1 and 100.cursor
- An optional next page cursor.com.google.common.util.concurrent.ListenableFuture<FriendsOfFriendsList> listFriendsOfFriends(@NonNull @NonNull Session session, int limit, java.lang.String cursor)
session
- The session of the user.limit
- Max number of records to return. Between 1 and 100.cursor
- An optional next page cursor.com.google.common.util.concurrent.ListenableFuture<GroupUserList> listGroupUsers(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String groupId)
session
- The session of the user.groupId
- The id of the group.com.google.common.util.concurrent.ListenableFuture<GroupUserList> listGroupUsers(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String groupId, int state, int limit, java.lang.String cursor)
session
- The session of the user.groupId
- The id of the group.state
- The group user state to list.limit
- Max number of records to return. Between 1 and 100.cursor
- An optional next page cursor.com.google.common.util.concurrent.ListenableFuture<GroupList> listGroups(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String name)
session
- The session of the user.name
- The name filter to apply to the group list.com.google.common.util.concurrent.ListenableFuture<GroupList> listGroups(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String name, int limit)
session
- The session of the user.name
- The name filter to apply to the group list.limit
- The number of groups to list.com.google.common.util.concurrent.ListenableFuture<GroupList> listGroups(@NonNull @NonNull Session session, java.lang.String name, int limit, java.lang.String cursor)
session
- The session of the user.name
- The name filter to apply to the group list.limit
- The number of groups to list.cursor
- A cursor for the current position in the groups to list.com.google.common.util.concurrent.ListenableFuture<GroupList> listGroups(@NonNull @NonNull Session session, java.lang.String name, java.lang.String langTag, java.lang.Integer members, java.lang.Boolean open, int limit, java.lang.String cursor)
session
- The session of the user.name
- The name filter to apply to the group list.langTag
- the language tag to filter on.members
- Number of group members.open
- Whether the group is open or closed.limit
- The number of groups to list.cursor
- A cursor for the current position in the groups to list.com.google.common.util.concurrent.ListenableFuture<LeaderboardRecordList> listLeaderboardRecords(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String leaderboardId)
session
- The session of the user.leaderboardId
- The id of the leaderboard to list.com.google.common.util.concurrent.ListenableFuture<LeaderboardRecordList> listLeaderboardRecords(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String leaderboardId, java.lang.String... ownerIds)
session
- The session of the user.leaderboardId
- The id of the leaderboard to list.ownerIds
- Record owners to fetch with the list of records.com.google.common.util.concurrent.ListenableFuture<LeaderboardRecordList> listLeaderboardRecords(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String leaderboardId, java.lang.Iterable<java.lang.String> ownerIds, int expiry)
session
- The session of the user.leaderboardId
- The id of the leaderboard to list.ownerIds
- Record owners to fetch with the list of records.expiry
- Expiry in seconds (since epoch) to begin fetching records from.com.google.common.util.concurrent.ListenableFuture<LeaderboardRecordList> listLeaderboardRecords(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String leaderboardId, java.lang.Iterable<java.lang.String> ownerIds, int expiry, int limit)
session
- The session of the user.leaderboardId
- The id of the leaderboard to list.ownerIds
- Record owners to fetch with the list of records.expiry
- Expiry in seconds (since epoch) to begin fetching records from.limit
- The number of records to list.com.google.common.util.concurrent.ListenableFuture<LeaderboardRecordList> listLeaderboardRecords(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String leaderboardId, java.lang.Iterable<java.lang.String> ownerIds, int expiry, int limit, java.lang.String cursor)
session
- The session of the user.leaderboardId
- The id of the leaderboard to list.ownerIds
- Record owners to fetch with the list of records.expiry
- Expiry in seconds (since epoch) to begin fetching records from.limit
- The number of records to list.cursor
- A cursor for the current position in the leaderboard records to list.com.google.common.util.concurrent.ListenableFuture<LeaderboardRecordList> listLeaderboardRecordsAroundOwner(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String leaderboardId, @NonNull @NonNull java.lang.String ownerId)
session
- The session of the user.leaderboardId
- The id of the leaderboard to list.ownerId
- The owner to retrieve records around.com.google.common.util.concurrent.ListenableFuture<LeaderboardRecordList> listLeaderboardRecordsAroundOwner(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String leaderboardId, @NonNull @NonNull java.lang.String ownerId, int expiry)
session
- The session of the user.leaderboardId
- The id of the leaderboard to list.ownerId
- The owner to retrieve records around.expiry
- Expiry in seconds (since epoch) to begin fetching records from.com.google.common.util.concurrent.ListenableFuture<LeaderboardRecordList> listLeaderboardRecordsAroundOwner(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String leaderboardId, @NonNull @NonNull java.lang.String ownerId, int expiry, int limit)
session
- The session of the user.leaderboardId
- The id of the leaderboard to list.ownerId
- The owner to retrieve records around.expiry
- Expiry in seconds (since epoch) to begin fetching records from.limit
- Max number of records to return. Between 1 and 100.com.google.common.util.concurrent.ListenableFuture<LeaderboardRecordList> listLeaderboardRecordsAroundOwner(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String leaderboardId, @NonNull @NonNull java.lang.String ownerId, int expiry, int limit, java.lang.String cursor)
session
- The session of the user.leaderboardId
- The id of the leaderboard to list.ownerId
- The owner to retrieve records around.expiry
- Expiry in seconds (since epoch) to begin fetching records from.limit
- Max number of records to return. Between 1 and 100.cursor
- A cursor for the current position in the leaderboard records to list.com.google.common.util.concurrent.ListenableFuture<MatchList> listMatches(@NonNull @NonNull Session session)
session
- The session of the user.com.google.common.util.concurrent.ListenableFuture<MatchList> listMatches(@NonNull @NonNull Session session, int min)
session
- The session of the user.min
- The minimum number of match participants.com.google.common.util.concurrent.ListenableFuture<MatchList> listMatches(@NonNull @NonNull Session session, int min, int max)
session
- The session of the user.min
- The minimum number of match participants.max
- The maximum number of match participants.com.google.common.util.concurrent.ListenableFuture<MatchList> listMatches(@NonNull @NonNull Session session, int min, int max, int limit)
session
- The session of the user.min
- The minimum number of match participants.max
- The maximum number of match participants.limit
- The number of matches to list.com.google.common.util.concurrent.ListenableFuture<MatchList> listMatches(@NonNull @NonNull Session session, int min, int max, int limit, java.lang.String label)
session
- The session of the user.min
- The minimum number of match participants.max
- The maximum number of match participants.limit
- The number of matches to list.label
- The label to filter the match list on.com.google.common.util.concurrent.ListenableFuture<MatchList> listMatches(@NonNull @NonNull Session session, int min, int max, int limit, java.lang.String label, boolean authoritative)
session
- The session of the user.min
- The minimum number of match participants.max
- The maximum number of match participants.limit
- The number of matches to list.authoritative
- True to include authoritative matches.label
- The label to filter the match list on.com.google.common.util.concurrent.ListenableFuture<NotificationList> listNotifications(@NonNull @NonNull Session session)
session
- The session of the user.com.google.common.util.concurrent.ListenableFuture<NotificationList> listNotifications(@NonNull @NonNull Session session, int limit)
session
- The session of the user.limit
- The number of notifications to list.com.google.common.util.concurrent.ListenableFuture<NotificationList> listNotifications(@NonNull @NonNull Session session, int limit, java.lang.String cacheableCursor)
session
- The session of the user.limit
- The number of notifications to list.cacheableCursor
- A cursor for the current position in notifications to list.com.google.common.util.concurrent.ListenableFuture<StorageObjectList> listStorageObjects(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String collection)
session
- The session of the user.collection
- The collection to list over.com.google.common.util.concurrent.ListenableFuture<StorageObjectList> listStorageObjects(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String collection, int limit)
session
- The session of the user.collection
- The collection to list over.limit
- The number of objects to list.com.google.common.util.concurrent.ListenableFuture<StorageObjectList> listStorageObjects(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String collection, int limit, java.lang.String cursor)
session
- The session of the user.collection
- The collection to list over.limit
- The number of objects to list.cursor
- A cursor to paginate over the collection.com.google.common.util.concurrent.ListenableFuture<SubscriptionList> listSubscriptions(@NonNull @NonNull Session session)
session
- The session of the user.com.google.common.util.concurrent.ListenableFuture<SubscriptionList> listSubscriptions(@NonNull @NonNull Session session, @NonNull @NonNull int limit)
session
- The session of the user.limit
- Max number of results per page.com.google.common.util.concurrent.ListenableFuture<SubscriptionList> listSubscriptions(@NonNull @NonNull Session session, @NonNull @NonNull int limit, @NonNull @NonNull java.lang.String cursor)
session
- The session of the user.limit
- Max number of results per page.cursor
- Cursor to retrieve a page of records from.com.google.common.util.concurrent.ListenableFuture<TournamentList> listTournaments(@NonNull @NonNull Session session)
session
- The session of the user.com.google.common.util.concurrent.ListenableFuture<TournamentList> listTournaments(@NonNull @NonNull Session session, int limit, java.lang.String cursor)
session
- The session of the user.limit
- Max number of records to return. Between 1 and 100.cursor
- A next page cursor for listings.com.google.common.util.concurrent.ListenableFuture<TournamentList> listTournaments(@NonNull @NonNull Session session, int categoryStart)
session
- The session of the user.categoryStart
- The start of the categories to include. Defaults to 0.com.google.common.util.concurrent.ListenableFuture<TournamentList> listTournaments(@NonNull @NonNull Session session, int categoryStart, int categoryEnd)
session
- The session of the user.categoryStart
- The start of the categories to include. Defaults to 0.categoryEnd
- The end of the categories to include. Defaults to 128.com.google.common.util.concurrent.ListenableFuture<TournamentList> listTournaments(@NonNull @NonNull Session session, int categoryStart, int categoryEnd, long startTime)
session
- The session of the user.categoryStart
- The start of the categories to include. Defaults to 0.categoryEnd
- The end of the categories to include. Defaults to 128.startTime
- The start time for tournaments. Defaults to current Unix time.com.google.common.util.concurrent.ListenableFuture<TournamentList> listTournaments(@NonNull @NonNull Session session, int categoryStart, int categoryEnd, long startTime, long endTime)
session
- The session of the user.categoryStart
- The start of the categories to include. Defaults to 0.categoryEnd
- The end of the categories to include. Defaults to 128.startTime
- The start time for tournaments. Defaults to current Unix time.endTime
- The end time for tournaments. Defaults to +1 year from current Unix time.com.google.common.util.concurrent.ListenableFuture<TournamentList> listTournaments(@NonNull @NonNull Session session, int categoryStart, int categoryEnd, long startTime, long endTime, int limit, java.lang.String cursor)
session
- The session of the user.categoryStart
- The start of the categories to include. Defaults to 0.categoryEnd
- The end of the categories to include. Defaults to 128.startTime
- The start time for tournaments. Defaults to current Unix time.endTime
- The end time for tournaments. Defaults to +1 year from current Unix time.limit
- Max number of records to return. Between 1 and 100.cursor
- A next page cursor for listings.com.google.common.util.concurrent.ListenableFuture<TournamentRecordList> listTournamentRecords(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String tournamentId)
session
- The session of the user.tournamentId
- The ID of the tournament to list for.com.google.common.util.concurrent.ListenableFuture<TournamentRecordList> listTournamentRecords(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String tournamentId, int expiry)
session
- The session of the user.tournamentId
- The ID of the tournament to list for.expiry
- Expiry in seconds (since epoch) to begin fetching records from.com.google.common.util.concurrent.ListenableFuture<TournamentRecordList> listTournamentRecords(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String tournamentId, int expiry, int limit)
session
- The session of the user.tournamentId
- The ID of the tournament to list for.expiry
- Expiry in seconds (since epoch) to begin fetching records from.limit
- Max number of records to return. Between 1 and 100.com.google.common.util.concurrent.ListenableFuture<TournamentRecordList> listTournamentRecords(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String tournamentId, int expiry, int limit, java.lang.String cursor)
session
- The session of the user.tournamentId
- The ID of the tournament to list for.expiry
- Expiry in seconds (since epoch) to begin fetching records from.limit
- Max number of records to return. Between 1 and 100.cursor
- A next or previous page cursor.com.google.common.util.concurrent.ListenableFuture<TournamentRecordList> listTournamentRecords(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String tournamentId, @NonNull java.lang.String... ownerIds)
session
- The session of the user.tournamentId
- The ID of the tournament to list for.ownerIds
- One or more owners to retrieve records for.com.google.common.util.concurrent.ListenableFuture<TournamentRecordList> listTournamentRecords(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String tournamentId, int expiry, int limit, java.lang.String cursor, @NonNull java.lang.String... ownerIds)
session
- The session of the user.tournamentId
- The ID of the tournament to list for.expiry
- Expiry in seconds (since epoch) to begin fetching records from.limit
- Max number of records to return. Between 1 and 100.cursor
- A next or previous page cursor.ownerIds
- One or more owners to retrieve records for.com.google.common.util.concurrent.ListenableFuture<TournamentRecordList> listTournamentRecordsAroundOwner(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String tournamentId, @NonNull @NonNull java.lang.String ownerId)
session
- The session of the user.tournamentId
- The ID of the tournament to list for.ownerId
- The owner to retrieve records around.com.google.common.util.concurrent.ListenableFuture<TournamentRecordList> listTournamentRecordsAroundOwner(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String tournamentId, @NonNull @NonNull java.lang.String ownerId, int expiry)
session
- The session of the user.tournamentId
- The ID of the tournament to list for.ownerId
- The owner to retrieve records around.expiry
- Expiry in seconds (since epoch) to begin fetching records from.com.google.common.util.concurrent.ListenableFuture<TournamentRecordList> listTournamentRecordsAroundOwner(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String tournamentId, @NonNull @NonNull java.lang.String ownerId, int expiry, int limit)
session
- The session of the user.tournamentId
- The ID of the tournament to list for.ownerId
- The owner to retrieve records around.expiry
- Expiry in seconds (since epoch) to begin fetching records from.limit
- Max number of records to return. Between 1 and 100.com.google.common.util.concurrent.ListenableFuture<TournamentRecordList> listTournamentRecordsAroundOwner(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String tournamentId, @NonNull @NonNull java.lang.String ownerId, int expiry, int limit, java.lang.String cursor)
session
- The session of the user.tournamentId
- The ID of the tournament to list for.ownerId
- The owner to retrieve records around.expiry
- Expiry in seconds (since epoch) to begin fetching records from.limit
- Max number of records to return. Between 1 and 100.cursor
- A next or previous page cursor.com.google.common.util.concurrent.ListenableFuture<UserGroupList> listUserGroups(@NonNull @NonNull Session session)
session
- The session of the user.com.google.common.util.concurrent.ListenableFuture<UserGroupList> listUserGroups(@NonNull @NonNull Session session, java.lang.String userId)
session
- The session of the user.userId
- The id of the user whose groups to list.com.google.common.util.concurrent.ListenableFuture<UserGroupList> listUserGroups(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String userId, int state, int limit, java.lang.String cursor)
session
- The session of the user.userId
- The id of the user whose groups to list.state
- The user group state to list.limit
- Max number of records to return. Between 1 and 100.cursor
- An optional next page cursor.com.google.common.util.concurrent.ListenableFuture<StorageObjectList> listUsersStorageObjects(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String collection, java.lang.String userId)
session
- The session of the user.collection
- The collection to list over.userId
- The user ID of the user to list objects for.com.google.common.util.concurrent.ListenableFuture<StorageObjectList> listUsersStorageObjects(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String collection, java.lang.String userId, int limit)
session
- The session of the user.collection
- The collection to list over.userId
- The user ID of the user to list objects for.limit
- The number of objects to list.com.google.common.util.concurrent.ListenableFuture<StorageObjectList> listUsersStorageObjects(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String collection, java.lang.String userId, int limit, java.lang.String cursor)
session
- The session of the user.collection
- The collection to list over.userId
- The user ID of the user to list objects for.limit
- The number of objects to list.cursor
- A cursor to paginate over the collection.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> logoutSession(@NonNull @NonNull Session session)
session
- The session to invalidate and log out.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> promoteGroupUsers(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String groupId, @NonNull java.lang.String... ids)
session
- The session of the user.groupId
- The id of the group to promote users into.ids
- The ids of the users to promote.com.google.common.util.concurrent.ListenableFuture<StorageObjects> readStorageObjects(@NonNull @NonNull Session session, @NonNull StorageObjectId... objectIds)
session
- The session of the user.objectIds
- The objects to read.com.google.common.util.concurrent.ListenableFuture<Rpc> rpc(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String id)
session
- The session of the user.id
- The id of the function to execute on the server.com.google.common.util.concurrent.ListenableFuture<Rpc> rpc(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String id, java.lang.String payload)
session
- The session of the user.id
- The id of the function to execute on the server.payload
- The payload to send with the function call.com.google.common.util.concurrent.ListenableFuture<Session> refreshSession(@NonNull @NonNull Session session)
session
- An existing session.com.google.common.util.concurrent.ListenableFuture<Session> refreshSession(@NonNull @NonNull Session session, @NonNull @NonNull java.util.Map<java.lang.String,java.lang.String> vars)
session
- An existing session.vars
- Extra information that will be bundled in the session token.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> unlinkApple(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String id)
session
- The session of the user.id
- The ID token received from Apple to validate.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> unlinkCustom(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String id)
session
- The session of the user.id
- A custom identifier usually obtained from an external authentication service.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> unlinkDevice(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String id)
session
- The session of the user.id
- A device identifier usually obtained from a platform API.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> unlinkEmail(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String email, @NonNull @NonNull java.lang.String password)
session
- The session of the user.email
- The email address of the user.password
- The password for the user.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> unlinkFacebook(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String accessToken)
session
- The session of the user.accessToken
- An OAuth access token from the Facebook SDK.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> unlinkFacebookInstantGame(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String accessToken)
session
- The session of the user.accessToken
- An OAuth access token from the Facebook SDK.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> unlinkGoogle(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String accessToken)
session
- The session of the user.accessToken
- An OAuth access token from the Google SDK.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> unlinkSteam(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String token)
session
- The session of the user.token
- An authentication token from the Steam network.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> unlinkGameCenter(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String playerId, @NonNull @NonNull java.lang.String bundleId, long timestampSeconds, @NonNull @NonNull java.lang.String salt, @NonNull @NonNull java.lang.String signature, @NonNull @NonNull java.lang.String publicKeyUrl)
session
- The session of the user.playerId
- The player id of the user in Game Center.bundleId
- The bundle id of the Game Center application.timestampSeconds
- The date and time that the signature was created.salt
- A random String used to compute the hash and keep it randomized.signature
- The verification signature data generated.publicKeyUrl
- The URL for the public encryption key.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> updateAccount(@NonNull @NonNull Session session, java.lang.String username)
session
- The session for the user.username
- The new username for the user.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> updateAccount(@NonNull @NonNull Session session, java.lang.String username, java.lang.String displayName)
session
- The session for the user.username
- The new username for the user.displayName
- A new display name for the user.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> updateAccount(@NonNull @NonNull Session session, java.lang.String username, java.lang.String displayName, java.lang.String avatarUrl)
session
- The session for the user.username
- The new username for the user.displayName
- A new display name for the user.avatarUrl
- A new avatar url for the user.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> updateAccount(@NonNull @NonNull Session session, java.lang.String username, java.lang.String displayName, java.lang.String avatarUrl, java.lang.String langTag)
session
- The session for the user.username
- The new username for the user.displayName
- A new display name for the user.avatarUrl
- A new avatar url for the user.langTag
- A new language tag in BCP-47 format for the user.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> updateAccount(@NonNull @NonNull Session session, java.lang.String username, java.lang.String displayName, java.lang.String avatarUrl, java.lang.String langTag, java.lang.String location)
session
- The session for the user.username
- The new username for the user.displayName
- A new display name for the user.avatarUrl
- A new avatar url for the user.langTag
- A new language tag in BCP-47 format for the user.location
- A new location for the user.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> updateAccount(@NonNull @NonNull Session session, java.lang.String username, java.lang.String displayName, java.lang.String avatarUrl, java.lang.String langTag, java.lang.String location, java.lang.String timezone)
session
- The session for the user.username
- The new username for the user.displayName
- A new display name for the user.avatarUrl
- A new avatar url for the user.langTag
- A new language tag in BCP-47 format for the user.location
- A new location for the user.timezone
- New timezone information for the user.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> updateGroup(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String groupId, java.lang.String name)
session
- The session of the user.groupId
- The id of the group to update.name
- A new name for the group.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> updateGroup(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String groupId, java.lang.String name, java.lang.String description)
session
- The session of the user.groupId
- The id of the group to update.name
- A new name for the group.description
- A new description for the group.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> updateGroup(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String groupId, java.lang.String name, java.lang.String description, java.lang.String avatarUrl)
session
- The session of the user.groupId
- The id of the group to update.name
- A new name for the group.description
- A new description for the group.avatarUrl
- A new avatar url for the group.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> updateGroup(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String groupId, java.lang.String name, java.lang.String description, java.lang.String avatarUrl, java.lang.String langTag)
session
- The session of the user.groupId
- The id of the group to update.name
- A new name for the group.description
- A new description for the group.avatarUrl
- A new avatar url for the group.langTag
- A new language tag in BCP-47 format for the group.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> updateGroup(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String groupId, java.lang.String name, java.lang.String description, java.lang.String avatarUrl, java.lang.String langTag, boolean open)
session
- The session of the user.groupId
- The id of the group to update.name
- A new name for the group.description
- A new description for the group.avatarUrl
- A new avatar url for the group.langTag
- A new language tag in BCP-47 format for the group.open
- True if the group should have open membership.com.google.common.util.concurrent.ListenableFuture<ValidatePurchaseResponse> validatePurchaseApple(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String receipt, @NonNull @NonNull boolean persist)
session
- The session of the user.receipt
- Base64 encoded Apple receipt data payload.persist
- Persist the purchase.com.google.common.util.concurrent.ListenableFuture<ValidatePurchaseResponse> validatePurchaseFacebookInstant(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String signedRequest, @NonNull @NonNull boolean persist)
session
- The session of the user.signedRequest
- Base64 encoded Facebook Instant signedRequest receipt data payload.persist
- Persist the purchase.com.google.common.util.concurrent.ListenableFuture<ValidatePurchaseResponse> validatePurchaseGoogle(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String receipt, @NonNull @NonNull boolean persist)
session
- The session of the user.receipt
- JSON encoded Google purchase payload.persist
- Persist the purchase.com.google.common.util.concurrent.ListenableFuture<ValidatePurchaseResponse> validatePurchaseHuawei(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String receipt, @NonNull @NonNull boolean persist)
session
- The session of the user.receipt
- JSON encoded Huawei InAppPurchaseData.persist
- Persist the purchase.com.google.common.util.concurrent.ListenableFuture<ValidateSubscriptionResponse> validateSubscriptionApple(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String receipt, @NonNull @NonNull boolean persist)
session
- The session of the user.receipt
- Base64 encoded Apple receipt data payload.persist
- Persist the purchase.com.google.common.util.concurrent.ListenableFuture<ValidateSubscriptionResponse> validateSubscriptionGoogle(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String receipt, @NonNull @NonNull boolean persist)
session
- The session of the user.receipt
- Base64 encoded Apple receipt data payload.persist
- Persist the purchase.com.google.common.util.concurrent.ListenableFuture<LeaderboardRecord> writeLeaderboardRecord(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String leaderboardId, @NonNull @NonNull long score)
session
- The session for the user.leaderboardId
- The id of the leaderboard to write.score
- The score for the leaderboard record.com.google.common.util.concurrent.ListenableFuture<LeaderboardRecord> writeLeaderboardRecord(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String leaderboardId, @NonNull @NonNull long score, @NonNull @NonNull long subscore)
session
- The session for the user.leaderboardId
- The id of the leaderboard to write.score
- The score for the leaderboard record.subscore
- The subscore for the leaderboard record.com.google.common.util.concurrent.ListenableFuture<LeaderboardRecord> writeLeaderboardRecord(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String leaderboardId, @NonNull @NonNull long score, @NonNull @NonNull java.lang.String metadata)
session
- The session for the user.leaderboardId
- The id of the leaderboard to write.score
- The score for the leaderboard record.metadata
- The metadata for the leaderboard record.com.google.common.util.concurrent.ListenableFuture<LeaderboardRecord> writeLeaderboardRecord(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String leaderboardId, @NonNull @NonNull long score, @NonNull @NonNull long subscore, @NonNull @NonNull java.lang.String metadata)
session
- The session for the user.leaderboardId
- The id of the leaderboard to write.score
- The score for the leaderboard record.subscore
- The subscore for the leaderboard record.metadata
- The metadata for the leaderboard record.com.google.common.util.concurrent.ListenableFuture<LeaderboardRecord> writeLeaderboardRecord(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String leaderboardId, @NonNull @NonNull long score, @NonNull @NonNull long subscore, @NonNull @NonNull java.lang.String metadata, @NonNull @NonNull Operator operator)
session
- The session for the user.leaderboardId
- The id of the leaderboard to write.score
- The score for the leaderboard record.subscore
- The subscore for the leaderboard record.metadata
- The metadata for the leaderboard record.operator
- Operator override.com.google.common.util.concurrent.ListenableFuture<StorageObjectAcks> writeStorageObjects(@NonNull @NonNull Session session, @NonNull StorageObjectWrite... objects)
session
- The session of the user.objects
- The objects to write.com.google.common.util.concurrent.ListenableFuture<LeaderboardRecord> writeTournamentRecord(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String tournamentId, @NonNull @NonNull long score)
session
- The session for the user.tournamentId
- The tournament ID to write the record for.score
- The score value to submit.com.google.common.util.concurrent.ListenableFuture<LeaderboardRecord> writeTournamentRecord(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String tournamentId, @NonNull @NonNull long score, @NonNull @NonNull long subscore)
session
- The session for the user.tournamentId
- The tournament ID to write the record for.score
- The score value to submit.subscore
- An optional secondary value.com.google.common.util.concurrent.ListenableFuture<LeaderboardRecord> writeTournamentRecord(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String tournamentId, @NonNull @NonNull long score, @NonNull @NonNull java.lang.String metadata)
session
- The session for the user.tournamentId
- The tournament ID to write the record for.score
- The score value to submit.metadata
- A JSON object of additional properties.com.google.common.util.concurrent.ListenableFuture<LeaderboardRecord> writeTournamentRecord(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String tournamentId, @NonNull @NonNull long score, @NonNull @NonNull long subscore, @NonNull @NonNull java.lang.String metadata)
session
- The session for the user.tournamentId
- The tournament ID to write the record for.score
- The score value to submit.subscore
- An optional secondary value.metadata
- A JSON object of additional properties.com.google.common.util.concurrent.ListenableFuture<LeaderboardRecord> writeTournamentRecord(@NonNull @NonNull Session session, @NonNull @NonNull java.lang.String tournamentId, @NonNull @NonNull long score, @NonNull @NonNull long subscore, @NonNull @NonNull java.lang.String metadata, @NonNull @NonNull Operator operator)
session
- The session for the user.tournamentId
- The tournament ID to write the record for.score
- The score value to submit.subscore
- An optional secondary value.metadata
- A JSON object of additional properties.operator
- Operator override.