Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

[detail level 12345]

NNakama
NConsole
CApiResponseException	An exception generated for HttpResponse objects don't return a success status
CIApiAccountDevice	Send a device to the server. Used with authenticate/link/unlink and user
CIApiChannelMessage	A message sent on a channel
CIApiFriend	A friend of a user
CIApiFriendList	A collection of zero or more friends of the user
CIApiGroup	A group in the server
CIApiLeaderboardRecord	Represents a complete leaderboard record with all scores and associated metadata
CIApiNotification	A notification in the server
CIApiStorageObject	An object within the storage engine
CIApiStorageObjectAck	A storage acknowledgement
CIApiUser	A user in the server
CIApiUserGroupList	A list of groups belonging to a user, along with the user's role in each group
CIConfigWarning	A warning for a configuration field
CIConsoleAccountExport	An export of all information stored for a user account
CIConsoleAuthenticateRequest	Authenticate a console user with username and password
CIConsoleConfig	The current server configuration and any associated warnings
CIConsoleConsoleSession	A console user session
CIConsoleStatusList	List of nodes and their stats
CIConsoleStorageList	List of storage objects
CIConsoleUnlinkDeviceRequest	Unlink a particular device ID from a user's account
CIConsoleUserList	A list of users
CIConsoleWalletLedger	An individual update to a user's wallet
CIConsoleWalletLedgerList	List of wallet ledger items for a particular user
CIConsoleWriteStorageObjectRequest	Write a new storage object or update an existing one
CINakamaapiAccount	A user with additional account details. Always the current user
CINakamaconsoleAccount	Account information
CINakamaconsoleUpdateAccountRequest	Update user account information
CIProtobufAny	Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... } Example 2: Pack and unpack a message in Java. Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... Example 4: Pack and unpack a message in Go foo := &pb.Foo{...} any, err := ptypes.MarshalAny(foo) ... foo := &pb.Foo{} if err := ptypes.UnmarshalAny(any, foo); err != nil { ... } The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z". JSON ==== The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example: package google.profile; message Person { string first_name = 1; string last_name = 2; } { "@type": "type.googleapis.com/google.profile.Person", "firstName": <string>, "lastName": <string> } If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]): { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }
CIRuntimeError
CIStatusListStatus	The status of a Nakama node
CIUserGroupListUserGroup	A single group-role pair
NNinja
NWebSockets
NExceptions
CEntityTooLargeException
CInvalidHttpResponseCodeException
CSecWebSocketKeyMissingException
CServerListenerSocketException
CWebSocketBufferOverflowException
CWebSocketHandshakeFailedException
CWebSocketVersionNotSupportedException
CBufferPool	This buffer pool is instance thread safe Use GetBuffer to get a MemoryStream (with a publically accessible buffer) Calling Close on this MemoryStream will clear its internal buffer and return the buffer to the pool for reuse MemoryStreams can grow larger than the DEFAULT_BUFFER_SIZE (or whatever you passed in) and the underlying buffers will be returned to the pool at their larger sizes
CPublicBufferMemoryStream	This memory stream is not instance thread safe (not to be confused with the BufferPool which is instance thread safe)
CHttpHelper
CIBufferPool
CIPingPongManager	Ping Pong Manager used to facilitate ping pong WebSocket messages
CIWebSocketClientFactory	Web socket client factory used to open web socket client connections
CIWebSocketServerFactory	Web socket server factory used to open web socket server connections
CPingPongManager	Ping Pong Manager used to facilitate ping pong WebSocket messages
CPongEventArgs	Pong EventArgs
CWebSocketClientFactory	Web socket client factory used to open web socket client connections
CWebSocketClientOptions	Client WebSocket init options
CWebSocketHttpContext	The WebSocket HTTP Context used to initiate a WebSocket handshake
CWebSocketServerFactory	Web socket server factory used to open web socket server connections
CWebSocketServerOptions	Server WebSocket init options
CApiResponseException	An exception generated for HttpResponse objects don't return a success status
CClient
CHttpRequestAdapter	HTTP Request adapter which uses the .NET HttpClient to send requests
CIApiAccount	A user with additional account details. Always the current user
CIApiAccountApple	Send a Apple Sign In token to the server. Used with authenticate/link/unlink
CIApiAccountCustom	Send a custom ID to the server. Used with authenticate/link/unlink
CIApiAccountDevice	Send a device to the server. Used with authenticate/link/unlink and user
CIApiAccountEmail	Send an email with password to the server. Used with authenticate/link/unlink
CIApiAccountFacebook	Send a Facebook token to the server. Used with authenticate/link/unlink
CIApiAccountFacebookInstantGame	Send a Facebook Instant Game token to the server. Used with authenticate/link/unlink
CIApiAccountGameCenter	Send Apple's Game Center account credentials to the server. Used with authenticate/link/unlink. https://developer.apple.com/documentation/gamekit/gklocalplayer/1515407-generateidentityverificationsign
CIApiAccountGoogle	Send a Google token to the server. Used with authenticate/link/unlink
CIApiAccountSteam	Send a Steam token to the server. Used with authenticate/link/unlink
CIApiChannelMessage	A message sent on a channel
CIApiChannelMessageList	A list of channel messages, usually a result of a list operation
CIApiCreateGroupRequest	Create a group with the current user as owner
CIApiDeleteStorageObjectId	Storage objects to delete
CIApiDeleteStorageObjectsRequest	Batch delete storage objects
CIApiEvent	Represents an event to be passed through the server to registered event handlers
CIApiFriend	A friend of a user
CIApiFriendList	A collection of zero or more friends of the user
CIApiFriendsOfFriendsList	A List of friends of friends
CIApiGroup	A group in the server
CIApiGroupList	One or more groups returned from a listing operation
CIApiGroupUserList	A list of users belonging to a group, along with their role
CIApiLeaderboardRecord	Represents a complete leaderboard record with all scores and associated metadata
CIApiLeaderboardRecordList	A set of leaderboard records, may be part of a leaderboard records page or a batch of individual records
CIApiLinkSteamRequest	Link Steam to the current user's account
CIApiListSubscriptionsRequest	List user subscriptions
CIApiMatch	Represents a realtime match
CIApiMatchList	A list of realtime matches
CIApiMatchmakerCompletionStats	Matchmaker ticket completion stats
CIApiMatchmakerStats	Matchmaker stats
CIApiNotification	A notification in the server
CIApiNotificationList	A collection of zero or more notifications
CIApiParty	Incoming information about a party
CIApiPartyList	A list of realtime matches
CIApiReadStorageObjectId	Storage objects to get
CIApiReadStorageObjectsRequest	Batch get storage objects
CIApiRpc	Execute an Lua function on the server
CIApiSession	A user's session used to authenticate messages
CIApiSessionLogoutRequest	Log out a session, invalidate a refresh token, or log out all sessions/refresh tokens for a user
CIApiSessionRefreshRequest	Authenticate against the server with a refresh token
CIApiStorageObject	An object within the storage engine
CIApiStorageObjectAck	A storage acknowledgement
CIApiStorageObjectAcks	Batch of acknowledgements for the storage object write
CIApiStorageObjectList	List of storage objects
CIApiStorageObjects	Batch of storage objects
CIApiSubscriptionList	A list of validated subscriptions stored by Nakama
CIApiTournament	A tournament on the server
CIApiTournamentList	A list of tournaments
CIApiTournamentRecordList	A set of tournament records which may be part of a tournament records page or a batch of individual records
CIApiUpdateAccountRequest	Update a user's account details
CIApiUpdateGroupRequest	Update fields in a given group
CIApiUser	A user in the server
CIApiUserGroupList	A list of groups belonging to a user, along with the user's role in each group
CIApiUsers	A collection of zero or more users
CIApiValidatedPurchase	Validated Purchase stored by Nakama
CIApiValidatedSubscription
CIApiValidatePurchaseAppleRequest	Apple IAP Purchases validation request
CIApiValidatePurchaseFacebookInstantRequest	Facebook Instant IAP Purchase validation request
CIApiValidatePurchaseGoogleRequest	Google IAP Purchase validation request
CIApiValidatePurchaseHuaweiRequest	Huawei IAP Purchase validation request
CIApiValidatePurchaseResponse	Validate IAP response
CIApiValidateSubscriptionAppleRequest	Apple Subscription validation request
CIApiValidateSubscriptionGoogleRequest	Google Subscription validation request
CIApiValidateSubscriptionResponse	Validate Subscription response
CIApiWriteStorageObject	The object to store
CIApiWriteStorageObjectsRequest	Write objects to the storage engine
CIChannel	A chat channel on the server
CIChannelMessageAck	An acknowledgement from the server when a chat message is delivered to a channel
CIChannelPresenceEvent	A batch of join and leave presences on a chat channel
CIClient	A client for the API in Nakama server
CIFriendsOfFriendsListFriendOfFriend	A friend of a friend
CIGroupUserListGroupUser	A single user-role pair
CIHttpAdapter	An adapter which implements the HTTP protocol
CILogger	A simple logger to write log messages to an output sink
CIMatch	A multiplayer match
CIMatchmakerMatched	The result of a successful matchmaker operation sent to the server
CIMatchmakerTicket	The matchmaker ticket received from the server
CIMatchmakerUser	The user with the parameters they sent to the server when asking for opponents
CIMatchPresenceEvent	A batch of join and leave presences for a match
CIMatchState	Some game state update in a match
CIParty	Incoming information about a party
CIPartyClose	End a party, kicking all party members and closing it
CIPartyData	Incoming party data delivered from the server
CIPartyJoinRequest	Incoming notification for one or more new presences attempting to join the party
CIPartyLeader	Announcement of a new party leader
CIPartyMatchmakerTicket	A response from starting a new party matchmaking process
CIPartyPresenceEvent	Presence update for a particular party
CIPartyUpdate	Incoming information about a party
CIProtobufAny
CIRpcStatus
CISession	A session authenticated for a user with Nakama server
CISocket	A socket to interact with Nakama server
CISocketAdapter	An adapter which implements a socket with a protocol supported by Nakama
CIStatus	Receive status updates for users
CIStatusPresenceEvent	A status update event about other users who've come online or gone offline
CIStream	A realtime socket stream on the server
CIStreamPresenceEvent	A batch of joins and leaves on the low level stream
CIStreamState	A state change received from a stream
CIUserGroupListUserGroup	A single group-role pair
CIUserPresence	An object which represents a connected user in the server
CIWriteLeaderboardRecordRequestLeaderboardRecordWrite	Record values to write
CIWriteTournamentRecordRequestTournamentRecordWrite	Record values to write
CRetry	Represents a single retry attempt
CRetryConfiguration	A configuration for controlling retriable requests
CSession
CSocket	A socket which implements the Nakama realtime API
CStorageObjectId	An identifier for a storage object
CWebSocketAdapter	An adapter which uses the WebSocket protocol with Nakama server
CWebSocketStdlibAdapter	An adapter which uses the WebSocket protocol with Nakama server
CWriteStorageObject
NSatori
CApiResponseException	An exception generated for HttpResponse objects don't return a success status
CClient
CEvent	An event to be published to the server
CHttpRequestAdapter	HTTP Request adapter which uses the .NET HttpClient to send requests
CIApiAuthenticateLogoutRequest	Log out a session, invalidate a refresh token, or log out all sessions/refresh tokens for a user
CIApiAuthenticateRefreshRequest	Authenticate against the server with a refresh token
CIApiAuthenticateRequest	Authentication request
CIApiEvent	A single event. Usually, but not necessarily, part of a batch
CIApiEventRequest	Publish an event to the server
CIApiExperiment	An experiment that this user is partaking
CIApiExperimentList	All experiments that this identity is involved with
CIApiFlag	Feature flag available to the identity
CIApiFlagList	All flags available to the identity
CIApiFlagOverride	Feature flag available to the identity
CIApiFlagOverrideList	All flags available to the identity and their value overrides
CIApiFlagOverrideValue	The details of a flag value override
CIApiGetMessageListResponse	A response containing all the messages for an identity
CIApiIdentifyRequest	Enrich/replace the current session with a new ID
CIApiLiveEvent	A single live event
CIApiLiveEventList	List of Live events
CIApiMessage	A scheduled message
CIApiProperties	Properties associated with an identity
CIApiSession	A session
CIApiUpdateMessageRequest	The request to update the status of a message
CIApiUpdatePropertiesRequest	Update Properties associated with this identity
CIClient	A client for the API in Satori server
CIFlagValueChangeReason
CIHttpAdapter	An adapter which implements the HTTP protocol
CILogger	A simple logger to write log messages to an output sink
CIProtobufAny
CIRpcStatus
CISession	A session authenticated for a user with Satori server
CRetry	Represents a single retry attempt
CRetryConfiguration	A configuration for controlling retriable requests
CSession