com.heroiclabs.nakama.api

Class NakamaGrpc.NakamaBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<NakamaGrpc.NakamaBlockingStub>

com.heroiclabs.nakama.api.NakamaGrpc.NakamaBlockingStub

Enclosing class:

NakamaGrpc

public static final class NakamaGrpc.NakamaBlockingStub
extends io.grpc.stub.AbstractBlockingStub<NakamaGrpc.NakamaBlockingStub>

A stub to allow clients to do synchronous rpc calls to service Nakama.

 The Nakama RPC protocol service built with GRPC.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
com.google.protobuf.Empty	addFriends(AddFriendsRequest request) Add friends by ID or username to a user's account.
com.google.protobuf.Empty	addGroupUsers(AddGroupUsersRequest request) Add users to a group.
Session	authenticateApple(AuthenticateAppleRequest request) Authenticate a user with an Apple ID against the server.
Session	authenticateCustom(AuthenticateCustomRequest request) Authenticate a user with a custom id against the server.
Session	authenticateDevice(AuthenticateDeviceRequest request) Authenticate a user with a device id against the server.
Session	authenticateEmail(AuthenticateEmailRequest request) Authenticate a user with an email+password against the server.
Session	authenticateFacebook(AuthenticateFacebookRequest request) Authenticate a user with a Facebook OAuth token against the server.
Session	authenticateFacebookInstantGame(AuthenticateFacebookInstantGameRequest request) Authenticate a user with a Facebook Instant Game token against the server.
Session	authenticateGameCenter(AuthenticateGameCenterRequest request) Authenticate a user with Apple's GameCenter against the server.
Session	authenticateGoogle(AuthenticateGoogleRequest request) Authenticate a user with Google against the server.
Session	authenticateSteam(AuthenticateSteamRequest request) Authenticate a user with Steam against the server.
com.google.protobuf.Empty	banGroupUsers(BanGroupUsersRequest request) Ban a set of users from a group.
com.google.protobuf.Empty	blockFriends(BlockFriendsRequest request) Block one or more users by ID or username.
protected NakamaGrpc.NakamaBlockingStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
Group	createGroup(CreateGroupRequest request) Create a new group with the current user as the owner.
com.google.protobuf.Empty	deleteAccount(com.google.protobuf.Empty request) Delete the current user's account.
com.google.protobuf.Empty	deleteFriends(DeleteFriendsRequest request) Delete one or more users by ID or username.
com.google.protobuf.Empty	deleteGroup(DeleteGroupRequest request) Delete a group by ID.
com.google.protobuf.Empty	deleteLeaderboardRecord(DeleteLeaderboardRecordRequest request) Delete a leaderboard record.
com.google.protobuf.Empty	deleteNotifications(DeleteNotificationsRequest request) Delete one or more notifications for the current user.
com.google.protobuf.Empty	deleteStorageObjects(DeleteStorageObjectsRequest request) Delete one or more objects by ID or username.
com.google.protobuf.Empty	deleteTournamentRecord(DeleteTournamentRecordRequest request) Delete a tournament record.
com.google.protobuf.Empty	demoteGroupUsers(DemoteGroupUsersRequest request) Demote a set of users in a group to the next role down.
com.google.protobuf.Empty	event(Event request) Submit an event for processing in the server's registered runtime custom events handler.
Account	getAccount(com.google.protobuf.Empty request) Fetch the current user's account.
MatchmakerStats	getMatchmakerStats(com.google.protobuf.Empty request) Get matchmaker stats.
ValidatedSubscription	getSubscription(GetSubscriptionRequest request) Get subscription by product id.
Users	getUsers(GetUsersRequest request) Fetch zero or more users by ID and/or username.
com.google.protobuf.Empty	healthcheck(com.google.protobuf.Empty request) A healthcheck which load balancers can use to check the service.
com.google.protobuf.Empty	importFacebookFriends(ImportFacebookFriendsRequest request) Import Facebook friends and add them to a user's account.
com.google.protobuf.Empty	importSteamFriends(ImportSteamFriendsRequest request) Import Steam friends and add them to a user's account.
com.google.protobuf.Empty	joinGroup(JoinGroupRequest request) Immediately join an open group, or request to join a closed one.
com.google.protobuf.Empty	joinTournament(JoinTournamentRequest request) Attempt to join an open and running tournament.
com.google.protobuf.Empty	kickGroupUsers(KickGroupUsersRequest request) Kick a set of users from a group.
com.google.protobuf.Empty	leaveGroup(LeaveGroupRequest request) Leave a group the user is a member of.
com.google.protobuf.Empty	linkApple(AccountApple request) Add an Apple ID to the social profiles on the current user's account.
com.google.protobuf.Empty	linkCustom(AccountCustom request) Add a custom ID to the social profiles on the current user's account.
com.google.protobuf.Empty	linkDevice(AccountDevice request) Add a device ID to the social profiles on the current user's account.
com.google.protobuf.Empty	linkEmail(AccountEmail request) Add an email+password to the social profiles on the current user's account.
com.google.protobuf.Empty	linkFacebook(LinkFacebookRequest request) Add Facebook to the social profiles on the current user's account.
com.google.protobuf.Empty	linkFacebookInstantGame(AccountFacebookInstantGame request) Add Facebook Instant Game to the social profiles on the current user's account.
com.google.protobuf.Empty	linkGameCenter(AccountGameCenter request) Add Apple's GameCenter to the social profiles on the current user's account.
com.google.protobuf.Empty	linkGoogle(AccountGoogle request) Add Google to the social profiles on the current user's account.
com.google.protobuf.Empty	linkSteam(LinkSteamRequest request) Add Steam to the social profiles on the current user's account.
ChannelMessageList	listChannelMessages(ListChannelMessagesRequest request) List a channel's message history.
FriendList	listFriends(ListFriendsRequest request) List all friends for the current user.
FriendsOfFriendsList	listFriendsOfFriends(ListFriendsOfFriendsRequest request) List friends of friends for the current user.
GroupList	listGroups(ListGroupsRequest request) List groups based on given filters.
GroupUserList	listGroupUsers(ListGroupUsersRequest request) List all users that are part of a group.
LeaderboardRecordList	listLeaderboardRecords(ListLeaderboardRecordsRequest request) List leaderboard records.
LeaderboardRecordList	listLeaderboardRecordsAroundOwner(ListLeaderboardRecordsAroundOwnerRequest request) List leaderboard records that belong to a user.
MatchList	listMatches(ListMatchesRequest request) Fetch list of running matches.
NotificationList	listNotifications(ListNotificationsRequest request) Fetch list of notifications.
StorageObjectList	listStorageObjects(ListStorageObjectsRequest request) List publicly readable storage objects in a given collection.
SubscriptionList	listSubscriptions(ListSubscriptionsRequest request) List user's subscriptions.
TournamentRecordList	listTournamentRecords(ListTournamentRecordsRequest request) List tournament records.
TournamentRecordList	listTournamentRecordsAroundOwner(ListTournamentRecordsAroundOwnerRequest request) List tournament records for a given owner.
TournamentList	listTournaments(ListTournamentsRequest request) List current or upcoming tournaments.
UserGroupList	listUserGroups(ListUserGroupsRequest request) List groups the current user belongs to.
com.google.protobuf.Empty	promoteGroupUsers(PromoteGroupUsersRequest request) Promote a set of users in a group to the next role up.
StorageObjects	readStorageObjects(ReadStorageObjectsRequest request) Get storage objects.
Rpc	rpcFunc(Rpc request) Execute a Lua function on the server.
com.google.protobuf.Empty	sessionLogout(SessionLogoutRequest request) Log out a session, invalidate a refresh token, or log out all sessions/refresh tokens for a user.
Session	sessionRefresh(SessionRefreshRequest request) Refresh a user's session using a refresh token retrieved from a previous authentication request.
com.google.protobuf.Empty	unlinkApple(AccountApple request) Remove the Apple ID from the social profiles on the current user's account.
com.google.protobuf.Empty	unlinkCustom(AccountCustom request) Remove the custom ID from the social profiles on the current user's account.
com.google.protobuf.Empty	unlinkDevice(AccountDevice request) Remove the device ID from the social profiles on the current user's account.
com.google.protobuf.Empty	unlinkEmail(AccountEmail request) Remove the email+password from the social profiles on the current user's account.
com.google.protobuf.Empty	unlinkFacebook(AccountFacebook request) Remove Facebook from the social profiles on the current user's account.
com.google.protobuf.Empty	unlinkFacebookInstantGame(AccountFacebookInstantGame request) Remove Facebook Instant Game profile from the social profiles on the current user's account.
com.google.protobuf.Empty	unlinkGameCenter(AccountGameCenter request) Remove Apple's GameCenter from the social profiles on the current user's account.
com.google.protobuf.Empty	unlinkGoogle(AccountGoogle request) Remove Google from the social profiles on the current user's account.
com.google.protobuf.Empty	unlinkSteam(AccountSteam request) Remove Steam from the social profiles on the current user's account.
com.google.protobuf.Empty	updateAccount(UpdateAccountRequest request) Update fields in the current user's account.
com.google.protobuf.Empty	updateGroup(UpdateGroupRequest request) Update fields in a given group.
ValidatePurchaseResponse	validatePurchaseApple(ValidatePurchaseAppleRequest request) Validate Apple IAP Receipt
ValidatePurchaseResponse	validatePurchaseFacebookInstant(ValidatePurchaseFacebookInstantRequest request) Validate FB Instant IAP Receipt
ValidatePurchaseResponse	validatePurchaseGoogle(ValidatePurchaseGoogleRequest request) Validate Google IAP Receipt
ValidatePurchaseResponse	validatePurchaseHuawei(ValidatePurchaseHuaweiRequest request) Validate Huawei IAP Receipt
ValidateSubscriptionResponse	validateSubscriptionApple(ValidateSubscriptionAppleRequest request) Validate Apple Subscription Receipt
ValidateSubscriptionResponse	validateSubscriptionGoogle(ValidateSubscriptionGoogleRequest request) Validate Google Subscription Receipt
LeaderboardRecord	writeLeaderboardRecord(WriteLeaderboardRecordRequest request) Write a record to a leaderboard.
StorageObjectAcks	writeStorageObjects(WriteStorageObjectsRequest request) Write objects into the storage engine.
LeaderboardRecord	writeTournamentRecord(WriteTournamentRecordRequest request) Write a record to a tournament.

Methods inherited from class io.grpc.stub.AbstractBlockingStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOnReadyThreshold, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected NakamaGrpc.NakamaBlockingStub build(io.grpc.Channel channel,
                                              io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<NakamaGrpc.NakamaBlockingStub>

addFriends

public com.google.protobuf.Empty addFriends(AddFriendsRequest request)

 Add friends by ID or username to a user's account.
 

addGroupUsers

public com.google.protobuf.Empty addGroupUsers(AddGroupUsersRequest request)

 Add users to a group.
 

sessionRefresh

public Session sessionRefresh(SessionRefreshRequest request)

 Refresh a user's session using a refresh token retrieved from a previous authentication request.
 

sessionLogout

public com.google.protobuf.Empty sessionLogout(SessionLogoutRequest request)

 Log out a session, invalidate a refresh token, or log out all sessions/refresh tokens for a user.
 

authenticateApple

public Session authenticateApple(AuthenticateAppleRequest request)

 Authenticate a user with an Apple ID against the server.
 

authenticateCustom

public Session authenticateCustom(AuthenticateCustomRequest request)

 Authenticate a user with a custom id against the server.
 

authenticateDevice

public Session authenticateDevice(AuthenticateDeviceRequest request)

 Authenticate a user with a device id against the server.
 

authenticateEmail

public Session authenticateEmail(AuthenticateEmailRequest request)

 Authenticate a user with an email+password against the server.
 

authenticateFacebook

public Session authenticateFacebook(AuthenticateFacebookRequest request)

 Authenticate a user with a Facebook OAuth token against the server.
 

authenticateFacebookInstantGame

public Session authenticateFacebookInstantGame(AuthenticateFacebookInstantGameRequest request)

 Authenticate a user with a Facebook Instant Game token against the server.
 

authenticateGameCenter

public Session authenticateGameCenter(AuthenticateGameCenterRequest request)

 Authenticate a user with Apple's GameCenter against the server.
 

authenticateGoogle

public Session authenticateGoogle(AuthenticateGoogleRequest request)

 Authenticate a user with Google against the server.
 

authenticateSteam

public Session authenticateSteam(AuthenticateSteamRequest request)

 Authenticate a user with Steam against the server.
 

banGroupUsers

public com.google.protobuf.Empty banGroupUsers(BanGroupUsersRequest request)

 Ban a set of users from a group.
 

blockFriends

public com.google.protobuf.Empty blockFriends(BlockFriendsRequest request)

 Block one or more users by ID or username.
 

createGroup

public Group createGroup(CreateGroupRequest request)

 Create a new group with the current user as the owner.
 

deleteAccount

public com.google.protobuf.Empty deleteAccount(com.google.protobuf.Empty request)

 Delete the current user's account.
 

deleteFriends

public com.google.protobuf.Empty deleteFriends(DeleteFriendsRequest request)

 Delete one or more users by ID or username.
 

deleteGroup

public com.google.protobuf.Empty deleteGroup(DeleteGroupRequest request)

 Delete a group by ID.
 

deleteLeaderboardRecord

public com.google.protobuf.Empty deleteLeaderboardRecord(DeleteLeaderboardRecordRequest request)

 Delete a leaderboard record.
 

deleteNotifications

public com.google.protobuf.Empty deleteNotifications(DeleteNotificationsRequest request)

 Delete one or more notifications for the current user.
 

deleteTournamentRecord

public com.google.protobuf.Empty deleteTournamentRecord(DeleteTournamentRecordRequest request)

 Delete a tournament record.
 

deleteStorageObjects

public com.google.protobuf.Empty deleteStorageObjects(DeleteStorageObjectsRequest request)

 Delete one or more objects by ID or username.
 

event

public com.google.protobuf.Empty event(Event request)

 Submit an event for processing in the server's registered runtime custom events handler.
 

getAccount

public Account getAccount(com.google.protobuf.Empty request)

 Fetch the current user's account.
 

getUsers

public Users getUsers(GetUsersRequest request)

 Fetch zero or more users by ID and/or username.
 

getSubscription

public ValidatedSubscription getSubscription(GetSubscriptionRequest request)

 Get subscription by product id.
 

getMatchmakerStats

public MatchmakerStats getMatchmakerStats(com.google.protobuf.Empty request)

 Get matchmaker stats.
 

healthcheck

public com.google.protobuf.Empty healthcheck(com.google.protobuf.Empty request)

 A healthcheck which load balancers can use to check the service.
 

importFacebookFriends

public com.google.protobuf.Empty importFacebookFriends(ImportFacebookFriendsRequest request)

 Import Facebook friends and add them to a user's account.
 

importSteamFriends

public com.google.protobuf.Empty importSteamFriends(ImportSteamFriendsRequest request)

 Import Steam friends and add them to a user's account.
 

joinGroup

public com.google.protobuf.Empty joinGroup(JoinGroupRequest request)

 Immediately join an open group, or request to join a closed one.
 

joinTournament

public com.google.protobuf.Empty joinTournament(JoinTournamentRequest request)

 Attempt to join an open and running tournament.
 

kickGroupUsers

public com.google.protobuf.Empty kickGroupUsers(KickGroupUsersRequest request)

 Kick a set of users from a group.
 

leaveGroup

public com.google.protobuf.Empty leaveGroup(LeaveGroupRequest request)

 Leave a group the user is a member of.
 

linkApple

public com.google.protobuf.Empty linkApple(AccountApple request)

 Add an Apple ID to the social profiles on the current user's account.
 

linkCustom

public com.google.protobuf.Empty linkCustom(AccountCustom request)

 Add a custom ID to the social profiles on the current user's account.
 

linkDevice

public com.google.protobuf.Empty linkDevice(AccountDevice request)

 Add a device ID to the social profiles on the current user's account.
 

linkEmail

public com.google.protobuf.Empty linkEmail(AccountEmail request)

 Add an email+password to the social profiles on the current user's account.
 

linkFacebook

public com.google.protobuf.Empty linkFacebook(LinkFacebookRequest request)

 Add Facebook to the social profiles on the current user's account.
 

linkFacebookInstantGame

public com.google.protobuf.Empty linkFacebookInstantGame(AccountFacebookInstantGame request)

 Add Facebook Instant Game to the social profiles on the current user's account.
 

linkGameCenter

public com.google.protobuf.Empty linkGameCenter(AccountGameCenter request)

 Add Apple's GameCenter to the social profiles on the current user's account.
 

linkGoogle

public com.google.protobuf.Empty linkGoogle(AccountGoogle request)

 Add Google to the social profiles on the current user's account.
 

linkSteam

public com.google.protobuf.Empty linkSteam(LinkSteamRequest request)

 Add Steam to the social profiles on the current user's account.
 

listChannelMessages

public ChannelMessageList listChannelMessages(ListChannelMessagesRequest request)

 List a channel's message history.
 

listFriends

public FriendList listFriends(ListFriendsRequest request)

 List all friends for the current user.
 

listFriendsOfFriends

public FriendsOfFriendsList listFriendsOfFriends(ListFriendsOfFriendsRequest request)

 List friends of friends for the current user.
 

listGroups

public GroupList listGroups(ListGroupsRequest request)

 List groups based on given filters.
 

listGroupUsers

public GroupUserList listGroupUsers(ListGroupUsersRequest request)

 List all users that are part of a group.
 

listLeaderboardRecords

public LeaderboardRecordList listLeaderboardRecords(ListLeaderboardRecordsRequest request)

 List leaderboard records.
 

listLeaderboardRecordsAroundOwner

public LeaderboardRecordList listLeaderboardRecordsAroundOwner(ListLeaderboardRecordsAroundOwnerRequest request)

 List leaderboard records that belong to a user.
 

listMatches

public MatchList listMatches(ListMatchesRequest request)

 Fetch list of running matches.
 

listNotifications

public NotificationList listNotifications(ListNotificationsRequest request)

 Fetch list of notifications.
 

listStorageObjects

public StorageObjectList listStorageObjects(ListStorageObjectsRequest request)

 List publicly readable storage objects in a given collection.
 

listSubscriptions

public SubscriptionList listSubscriptions(ListSubscriptionsRequest request)

 List user's subscriptions.
 

listTournaments

public TournamentList listTournaments(ListTournamentsRequest request)

 List current or upcoming tournaments.
 

listTournamentRecords

public TournamentRecordList listTournamentRecords(ListTournamentRecordsRequest request)

 List tournament records.
 

listTournamentRecordsAroundOwner

public TournamentRecordList listTournamentRecordsAroundOwner(ListTournamentRecordsAroundOwnerRequest request)

 List tournament records for a given owner.
 

listUserGroups

public UserGroupList listUserGroups(ListUserGroupsRequest request)

 List groups the current user belongs to.
 

promoteGroupUsers

public com.google.protobuf.Empty promoteGroupUsers(PromoteGroupUsersRequest request)

 Promote a set of users in a group to the next role up.
 

demoteGroupUsers

public com.google.protobuf.Empty demoteGroupUsers(DemoteGroupUsersRequest request)

 Demote a set of users in a group to the next role down.
 

readStorageObjects

public StorageObjects readStorageObjects(ReadStorageObjectsRequest request)

 Get storage objects.
 

rpcFunc

public Rpc rpcFunc(Rpc request)

 Execute a Lua function on the server.
 

unlinkApple

public com.google.protobuf.Empty unlinkApple(AccountApple request)

 Remove the Apple ID from the social profiles on the current user's account.
 

unlinkCustom

public com.google.protobuf.Empty unlinkCustom(AccountCustom request)

 Remove the custom ID from the social profiles on the current user's account.
 

unlinkDevice

public com.google.protobuf.Empty unlinkDevice(AccountDevice request)

 Remove the device ID from the social profiles on the current user's account.
 

unlinkEmail

public com.google.protobuf.Empty unlinkEmail(AccountEmail request)

 Remove the email+password from the social profiles on the current user's account.
 

unlinkFacebook

public com.google.protobuf.Empty unlinkFacebook(AccountFacebook request)

 Remove Facebook from the social profiles on the current user's account.
 

unlinkFacebookInstantGame

public com.google.protobuf.Empty unlinkFacebookInstantGame(AccountFacebookInstantGame request)

 Remove Facebook Instant Game profile from the social profiles on the current user's account.
 

unlinkGameCenter

public com.google.protobuf.Empty unlinkGameCenter(AccountGameCenter request)

 Remove Apple's GameCenter from the social profiles on the current user's account.
 

unlinkGoogle

public com.google.protobuf.Empty unlinkGoogle(AccountGoogle request)

 Remove Google from the social profiles on the current user's account.
 

unlinkSteam

public com.google.protobuf.Empty unlinkSteam(AccountSteam request)

 Remove Steam from the social profiles on the current user's account.
 

updateAccount

public com.google.protobuf.Empty updateAccount(UpdateAccountRequest request)

 Update fields in the current user's account.
 

updateGroup

public com.google.protobuf.Empty updateGroup(UpdateGroupRequest request)

 Update fields in a given group.
 

validatePurchaseApple

public ValidatePurchaseResponse validatePurchaseApple(ValidatePurchaseAppleRequest request)

 Validate Apple IAP Receipt
 

validateSubscriptionApple

public ValidateSubscriptionResponse validateSubscriptionApple(ValidateSubscriptionAppleRequest request)

 Validate Apple Subscription Receipt
 

validatePurchaseGoogle

public ValidatePurchaseResponse validatePurchaseGoogle(ValidatePurchaseGoogleRequest request)

 Validate Google IAP Receipt
 

validateSubscriptionGoogle

public ValidateSubscriptionResponse validateSubscriptionGoogle(ValidateSubscriptionGoogleRequest request)

 Validate Google Subscription Receipt
 

validatePurchaseHuawei

public ValidatePurchaseResponse validatePurchaseHuawei(ValidatePurchaseHuaweiRequest request)

 Validate Huawei IAP Receipt
 

validatePurchaseFacebookInstant

public ValidatePurchaseResponse validatePurchaseFacebookInstant(ValidatePurchaseFacebookInstantRequest request)

 Validate FB Instant IAP Receipt
 

writeLeaderboardRecord

public LeaderboardRecord writeLeaderboardRecord(WriteLeaderboardRecordRequest request)

 Write a record to a leaderboard.
 

writeStorageObjects

public StorageObjectAcks writeStorageObjects(WriteStorageObjectsRequest request)

 Write objects into the storage engine.
 

writeTournamentRecord

public LeaderboardRecord writeTournamentRecord(WriteTournamentRecordRequest request)

 Write a record to a tournament.