NakamaBaseClient class abstract
This defines the interface to communicate with Nakama API. It is a little tricky to support web (via REST) and io (via gRPC) with just one codebase so please don't use this directly but get your fitting instance with getNakamaClient().
- Implementers
Constructors
- NakamaBaseClient()
- NakamaBaseClient.init({String? host, String? serverKey, String key = _kDefaultAppKey, int httpPort = 7350, int grpcPort = 7349, bool ssl = false})
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
authenticateCustom(
{required String id, bool create = true, String? username, Map< String, String> ? vars}) → Future<Session> -
authenticateDevice(
{required String deviceId, bool create = false, String? username, Map< String, String> ? vars}) → Future<Session> -
authenticateEmail(
{required String email, required String password, bool create = false, String? username, Map< String, String> ? vars}) → Future<Session> -
authenticateFacebook(
{required String token, bool create = true, String? username, Map< String, String> ? vars, bool import = false}) → Future<Session> -
authenticateGameCenter(
{required String playerId, required String bundleId, required int timestampSeconds, required String salt, required String signature, required String publicKeyUrl, bool create = true, String? username, Map< String, String> ? vars}) → Future<Session> -
authenticateGoogle(
{required String token, bool create = true, String? username, Map< String, String> ? vars}) → Future<Session> -
authenticateSteam(
{required String token, bool create = true, String? username, Map< String, String> ? vars}) → Future<Session> -
getAccount(
Session session) → Future< Account> -
getUsers(
{required Session session, List< String> ? facebookIds, List<String> ? ids, List<String> ? usernames}) → Future<Users> -
linkDevice(
{required Session session, String? id, Map< String, String> ? vars}) → Future<void> -
listChannelMessages(
{required Session session, required String channelId, int limit = 20, bool? forward, String? cursor}) → Future< ChannelMessageList?> -
listLeaderboardRecords(
{required Session session, required String leaderboardId, List< String> ? ownerIds, int limit = 20, String? cursor, String? expiry}) → Future<LeaderboardRecordList> -
listLeaderboardRecordsAroundOwner(
{required Session session, required String leaderboardId, String? ownerId, int limit = 20, String? expiry}) → Future< LeaderboardRecordList> -
listStorageObjects(
{required Session session, String? collection, String? cursor, String? userId, int? limit}) → Future< StorageObjectList> -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
readStorageObject(
{required Session session, String? collection, String? key, String? userId}) → Future< StorageObject> -
rpc(
{required Session session, required String id, String? payload}) → Future< Rpc> -
sessionRefresh(
{required Session session, Map< String, String> ? vars}) → Future<Session> -
toString(
) → String -
A string representation of this object.
inherited
-
unlinkDevice(
{required Session session, String? id, Map< String, String> ? vars}) → Future<void> -
updateAccount(
{required Session session, String? username, String? displayName, String? avatarUrl, String? langTag, String? location, String? timezone}) → Future< void> -
writeLeaderboardRecord(
{required Session session, required String leaderboardId, int? score, int? subscore, String? metadata}) → Future< LeaderboardRecord> -
writeStorageObject(
{required Session session, String? collection, String? key, String? value, String? version, StorageWritePermission? writePermission, StorageReadPermission? readPermission}) → Future< void>
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited