Package com.heroiclabs.nakama.api

Class NakamaGrpc.NakamaFutureStub

java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractFutureStub<NakamaGrpc.NakamaFutureStub>
com.heroiclabs.nakama.api.NakamaGrpc.NakamaFutureStub
Enclosing class:
NakamaGrpc
public static final class NakamaGrpc.NakamaFutureStub extends io.grpc.stub.AbstractFutureStub<NakamaGrpc.NakamaFutureStub>

 The Nakama RPC protocol service built with GRPC.

  • Method Details

    • build

      protected NakamaGrpc.NakamaFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
      Specified by:
      build in class io.grpc.stub.AbstractStub<NakamaGrpc.NakamaFutureStub>

    • addFriends

      public com.google.common.util.concurrent.ListenableFuture<Empty> addFriends(AddFriendsRequest request)
       Add friends by ID or username to a user's account.

    • addGroupUsers

      public com.google.common.util.concurrent.ListenableFuture<Empty> addGroupUsers(AddGroupUsersRequest request)
       Add users to a group.

    • authenticateApple

      public com.google.common.util.concurrent.ListenableFuture<Session> authenticateApple(AuthenticateAppleRequest request)
       Authenticate a user with an Apple ID against the server.

    • authenticateCustom

      public com.google.common.util.concurrent.ListenableFuture<Session> authenticateCustom(AuthenticateCustomRequest request)
       Authenticate a user with a custom id against the server.

    • authenticateDevice

      public com.google.common.util.concurrent.ListenableFuture<Session> authenticateDevice(AuthenticateDeviceRequest request)
       Authenticate a user with a device id against the server.

    • authenticateEmail

      public com.google.common.util.concurrent.ListenableFuture<Session> authenticateEmail(AuthenticateEmailRequest request)
       Authenticate a user with an email+password against the server.

    • authenticateFacebook

      public com.google.common.util.concurrent.ListenableFuture<Session> authenticateFacebook(AuthenticateFacebookRequest request)
       Authenticate a user with a Facebook OAuth token against the server.

    • authenticateFacebookInstantGame

      public com.google.common.util.concurrent.ListenableFuture<Session> authenticateFacebookInstantGame(AuthenticateFacebookInstantGameRequest request)
       Authenticate a user with a Facebook Instant Game token against the server.

    • authenticateGameCenter

      public com.google.common.util.concurrent.ListenableFuture<Session> authenticateGameCenter(AuthenticateGameCenterRequest request)
       Authenticate a user with Apple's GameCenter against the server.

    • authenticateGoogle

      public com.google.common.util.concurrent.ListenableFuture<Session> authenticateGoogle(AuthenticateGoogleRequest request)
       Authenticate a user with Google against the server.

    • authenticateSteam

      public com.google.common.util.concurrent.ListenableFuture<Session> authenticateSteam(AuthenticateSteamRequest request)
       Authenticate a user with Steam against the server.

    • banGroupUsers

      public com.google.common.util.concurrent.ListenableFuture<Empty> banGroupUsers(BanGroupUsersRequest request)
       Ban a set of users from a group.

    • blockFriends

      public com.google.common.util.concurrent.ListenableFuture<Empty> blockFriends(BlockFriendsRequest request)
       Block one or more users by ID or username.

    • createGroup

      public com.google.common.util.concurrent.ListenableFuture<Group> createGroup(CreateGroupRequest request)
       Create a new group with the current user as the owner.

    • deleteFriends

      public com.google.common.util.concurrent.ListenableFuture<Empty> deleteFriends(DeleteFriendsRequest request)
       Delete one or more users by ID or username.

    • deleteGroup

      public com.google.common.util.concurrent.ListenableFuture<Empty> deleteGroup(DeleteGroupRequest request)
       Delete a group by ID.

    • deleteLeaderboardRecord

      public com.google.common.util.concurrent.ListenableFuture<Empty> deleteLeaderboardRecord(DeleteLeaderboardRecordRequest request)
       Delete a leaderboard record.

    • deleteNotifications

      public com.google.common.util.concurrent.ListenableFuture<Empty> deleteNotifications(DeleteNotificationsRequest request)
       Delete one or more notifications for the current user.

    • deleteStorageObjects

      public com.google.common.util.concurrent.ListenableFuture<Empty> deleteStorageObjects(DeleteStorageObjectsRequest request)
       Delete one or more objects by ID or username.

    • event

      public com.google.common.util.concurrent.ListenableFuture<Empty> event(Event request)
       Submit an event for processing in the server's registered runtime custom events handler.

    • getAccount

      public com.google.common.util.concurrent.ListenableFuture<Account> getAccount(Empty request)
       Fetch the current user's account.

    • getUsers

      public com.google.common.util.concurrent.ListenableFuture<Users> getUsers(GetUsersRequest request)
       Fetch zero or more users by ID and/or username.

    • healthcheck

      public com.google.common.util.concurrent.ListenableFuture<Empty> healthcheck(Empty request)
       A healthcheck which load balancers can use to check the service.

    • importFacebookFriends

      public com.google.common.util.concurrent.ListenableFuture<Empty> importFacebookFriends(ImportFacebookFriendsRequest request)
       Import Facebook friends and add them to a user's account.

    • joinGroup

      public com.google.common.util.concurrent.ListenableFuture<Empty> joinGroup(JoinGroupRequest request)
       Immediately join an open group, or request to join a closed one.

    • joinTournament

      public com.google.common.util.concurrent.ListenableFuture<Empty> joinTournament(JoinTournamentRequest request)
       Attempt to join an open and running tournament.

    • kickGroupUsers

      public com.google.common.util.concurrent.ListenableFuture<Empty> kickGroupUsers(KickGroupUsersRequest request)
       Kick a set of users from a group.

    • leaveGroup

      public com.google.common.util.concurrent.ListenableFuture<Empty> leaveGroup(LeaveGroupRequest request)
       Leave a group the user is a member of.

    • linkApple

      public com.google.common.util.concurrent.ListenableFuture<Empty> linkApple(AccountApple request)
       Add an Apple ID to the social profiles on the current user's account.

    • linkCustom

      public com.google.common.util.concurrent.ListenableFuture<Empty> linkCustom(AccountCustom request)
       Add a custom ID to the social profiles on the current user's account.

    • linkDevice

      public com.google.common.util.concurrent.ListenableFuture<Empty> linkDevice(AccountDevice request)
       Add a device ID to the social profiles on the current user's account.

    • linkEmail

      public com.google.common.util.concurrent.ListenableFuture<Empty> linkEmail(AccountEmail request)
       Add an email+password to the social profiles on the current user's account.

    • linkFacebook

      public com.google.common.util.concurrent.ListenableFuture<Empty> linkFacebook(LinkFacebookRequest request)
       Add Facebook to the social profiles on the current user's account.

    • linkFacebookInstantGame

      public com.google.common.util.concurrent.ListenableFuture<Empty> linkFacebookInstantGame(AccountFacebookInstantGame request)
       Add Facebook Instant Game to the social profiles on the current user's account.

    • linkGameCenter

      public com.google.common.util.concurrent.ListenableFuture<Empty> linkGameCenter(AccountGameCenter request)
       Add Apple's GameCenter to the social profiles on the current user's account.

    • linkGoogle

      public com.google.common.util.concurrent.ListenableFuture<Empty> linkGoogle(AccountGoogle request)
       Add Google to the social profiles on the current user's account.

    • linkSteam

      public com.google.common.util.concurrent.ListenableFuture<Empty> linkSteam(AccountSteam request)
       Add Steam to the social profiles on the current user's account.

    • listChannelMessages

      public com.google.common.util.concurrent.ListenableFuture<ChannelMessageList> listChannelMessages(ListChannelMessagesRequest request)
       List a channel's message history.

    • listFriends

      public com.google.common.util.concurrent.ListenableFuture<FriendList> listFriends(ListFriendsRequest request)
       List all friends for the current user.

    • listGroups

      public com.google.common.util.concurrent.ListenableFuture<GroupList> listGroups(ListGroupsRequest request)
       List groups based on given filters.

    • listGroupUsers

      public com.google.common.util.concurrent.ListenableFuture<GroupUserList> listGroupUsers(ListGroupUsersRequest request)
       List all users that are part of a group.

    • listLeaderboardRecords

      public com.google.common.util.concurrent.ListenableFuture<LeaderboardRecordList> listLeaderboardRecords(ListLeaderboardRecordsRequest request)
       List leaderboard records.

    • listLeaderboardRecordsAroundOwner

      public com.google.common.util.concurrent.ListenableFuture<LeaderboardRecordList> listLeaderboardRecordsAroundOwner(ListLeaderboardRecordsAroundOwnerRequest request)
       List leaderboard records that belong to a user.

    • listMatches

      public com.google.common.util.concurrent.ListenableFuture<MatchList> listMatches(ListMatchesRequest request)
       Fetch list of running matches.

    • listNotifications

      public com.google.common.util.concurrent.ListenableFuture<NotificationList> listNotifications(ListNotificationsRequest request)
       Fetch list of notifications.

    • listStorageObjects

      public com.google.common.util.concurrent.ListenableFuture<StorageObjectList> listStorageObjects(ListStorageObjectsRequest request)
       List publicly readable storage objects in a given collection.

    • listTournaments

      public com.google.common.util.concurrent.ListenableFuture<TournamentList> listTournaments(ListTournamentsRequest request)
       List current or upcoming tournaments.

    • listTournamentRecords

      public com.google.common.util.concurrent.ListenableFuture<TournamentRecordList> listTournamentRecords(ListTournamentRecordsRequest request)
       List tournament records.

    • listTournamentRecordsAroundOwner

      public com.google.common.util.concurrent.ListenableFuture<TournamentRecordList> listTournamentRecordsAroundOwner(ListTournamentRecordsAroundOwnerRequest request)
       List tournament records for a given owner.

    • listUserGroups

      public com.google.common.util.concurrent.ListenableFuture<UserGroupList> listUserGroups(ListUserGroupsRequest request)
       List groups the current user belongs to.

    • promoteGroupUsers

      public com.google.common.util.concurrent.ListenableFuture<Empty> promoteGroupUsers(PromoteGroupUsersRequest request)
       Promote a set of users in a group to the next role up.

    • demoteGroupUsers

      public com.google.common.util.concurrent.ListenableFuture<Empty> demoteGroupUsers(DemoteGroupUsersRequest request)
       Demote a set of users in a group to the next role down.

    • readStorageObjects

      public com.google.common.util.concurrent.ListenableFuture<StorageObjects> readStorageObjects(ReadStorageObjectsRequest request)
       Get storage objects.

    • rpcFunc

      public com.google.common.util.concurrent.ListenableFuture<Rpc> rpcFunc(Rpc request)
       Execute a Lua function on the server.

    • unlinkApple

      public com.google.common.util.concurrent.ListenableFuture<Empty> unlinkApple(AccountApple request)
       Remove the Apple ID from the social profiles on the current user's account.

    • unlinkCustom

      public com.google.common.util.concurrent.ListenableFuture<Empty> unlinkCustom(AccountCustom request)
       Remove the custom ID from the social profiles on the current user's account.

    • unlinkDevice

      public com.google.common.util.concurrent.ListenableFuture<Empty> unlinkDevice(AccountDevice request)
       Remove the device ID from the social profiles on the current user's account.

    • unlinkEmail

      public com.google.common.util.concurrent.ListenableFuture<Empty> unlinkEmail(AccountEmail request)
       Remove the email+password from the social profiles on the current user's account.

    • unlinkFacebook

      public com.google.common.util.concurrent.ListenableFuture<Empty> unlinkFacebook(AccountFacebook request)
       Remove Facebook from the social profiles on the current user's account.

    • unlinkFacebookInstantGame

      public com.google.common.util.concurrent.ListenableFuture<Empty> unlinkFacebookInstantGame(AccountFacebookInstantGame request)
       Remove Facebook Instant Game profile from the social profiles on the current user's account.

    • unlinkGameCenter

      public com.google.common.util.concurrent.ListenableFuture<Empty> unlinkGameCenter(AccountGameCenter request)
       Remove Apple's GameCenter from the social profiles on the current user's account.

    • unlinkGoogle

      public com.google.common.util.concurrent.ListenableFuture<Empty> unlinkGoogle(AccountGoogle request)
       Remove Google from the social profiles on the current user's account.

    • unlinkSteam

      public com.google.common.util.concurrent.ListenableFuture<Empty> unlinkSteam(AccountSteam request)
       Remove Steam from the social profiles on the current user's account.

    • updateAccount

      public com.google.common.util.concurrent.ListenableFuture<Empty> updateAccount(UpdateAccountRequest request)
       Update fields in the current user's account.

    • updateGroup

      public com.google.common.util.concurrent.ListenableFuture<Empty> updateGroup(UpdateGroupRequest request)
       Update fields in a given group.

    • writeLeaderboardRecord

      public com.google.common.util.concurrent.ListenableFuture<LeaderboardRecord> writeLeaderboardRecord(WriteLeaderboardRecordRequest request)
       Write a record to a leaderboard.

    • writeStorageObjects

      public com.google.common.util.concurrent.ListenableFuture<StorageObjectAcks> writeStorageObjects(WriteStorageObjectsRequest request)
       Write objects into the storage engine.

    • writeTournamentRecord

      public com.google.common.util.concurrent.ListenableFuture<LeaderboardRecord> writeTournamentRecord(WriteTournamentRecordRequest request)
       Write a record to a tournament.