Nakama .NET Client 3.17.0
The official Nakama and Satori .NET client.
Loading...
Searching...
No Matches
Satori Namespace Reference

Namespaces

namespace  TinyJson

Classes

class  ApiAuthenticateLogoutRequest
class  ApiAuthenticateRefreshRequest
class  ApiAuthenticateRequest
class  ApiClient
 The low level client for the Satori API.
class  ApiEvent
class  ApiEventRequest
class  ApiExperiment
class  ApiExperimentList
class  ApiFlag
class  ApiFlagList
class  ApiFlagOverride
class  ApiFlagOverrideList
class  ApiFlagOverrideValue
class  ApiGetMessageListResponse
class  ApiIdentifyRequest
class  ApiLiveEvent
class  ApiLiveEventList
class  ApiMessage
class  ApiProperties
class  ApiResponseException
 An exception generated for HttpResponse objects don't return a success status. More...
class  ApiSession
class  ApiUpdateMessageRequest
class  ApiUpdatePropertiesRequest
class  Client
class  Event
 An event to be published to the server. More...
class  FlagValueChangeReason
class  GZipContent
class  GZipHttpClientHandler
class  HttpAdapterUtil
 Utility methods for the interface. NOTE: DO NOT USE EXTENSION METHODS as Unity cannot cross-compile them properly to WebGL.
class  HttpRequestAdapter
 HTTP Request adapter which uses the .NET HttpClient to send requests. More...
interface  IApiAuthenticateLogoutRequest
 Log out a session, invalidate a refresh token, or log out all sessions/refresh tokens for a user. More...
interface  IApiAuthenticateRefreshRequest
 Authenticate against the server with a refresh token. More...
interface  IApiAuthenticateRequest
 Authentication request. More...
interface  IApiEvent
 A single event. Usually, but not necessarily, part of a batch. More...
interface  IApiEventRequest
 Publish an event to the server. More...
interface  IApiExperiment
 An experiment that this user is partaking. More...
interface  IApiExperimentList
 All experiments that this identity is involved with. More...
interface  IApiFlag
 Feature flag available to the identity. More...
interface  IApiFlagList
 All flags available to the identity. More...
interface  IApiFlagOverride
 Feature flag available to the identity. More...
interface  IApiFlagOverrideList
 All flags available to the identity and their value overrides. More...
interface  IApiFlagOverrideValue
 The details of a flag value override. More...
interface  IApiGetMessageListResponse
 A response containing all the messages for an identity. More...
interface  IApiIdentifyRequest
 Enrich/replace the current session with a new ID. More...
interface  IApiLiveEvent
 A single live event. More...
interface  IApiLiveEventList
 List of Live events. More...
interface  IApiMessage
 A scheduled message. More...
interface  IApiProperties
 Properties associated with an identity. More...
interface  IApiSession
 A session. More...
interface  IApiUpdateMessageRequest
 The request to update the status of a message. More...
interface  IApiUpdatePropertiesRequest
 Update Properties associated with this identity. More...
interface  IClient
 A client for the API in Satori server. More...
interface  IFlagValueChangeReason
interface  IHttpAdapter
 An adapter which implements the HTTP protocol. More...
interface  ILogger
 A simple logger to write log messages to an output sink. More...
interface  IProtobufAny
interface  IRpcStatus
interface  ISession
 A session authenticated for a user with Satori server. More...
class  PreserveAttribute
 A custom attribute recognized by Unity3D. When added to a class member, it prevents the Unity linker from stripping the code it is associated with. This is used in addition to the link.xml file because the Unity Package Manager does not recognize link.xml files inside Unity packages. https://docs.unity3d.com/2018.3/Documentation/Manual/ManagedCodeStripping.html.
class  ProtobufAny
class  Retry
 Represents a single retry attempt. More...
class  RetryConfiguration
 A configuration for controlling retriable requests. More...
class  RetryHistory
class  RetryInvoker
 Invokes requests with retry and exponential backoff.
class  RetryJitter
 A collection of Jitter algorithms.
class  RpcStatus
class  Session

Enumerations

enum  FlagValueChangeReasonType { UNKNOWN = 0 , FLAG_VARIANT = 1 , LIVE_EVENT = 2 , EXPERIMENT = 3 }
enum  ApiFlagOverrideType {
  FLAG = 0 , FLAG_VARIANT = 1 , LIVE_EVENT_FLAG = 2 , LIVE_EVENT_FLAG_VARIANT = 3 ,
  EXPERIMENT_PHASE_VARIANT_FLAG = 4
}

Functions

delegate int Jitter (IList< Retry > retryHistory, int retryDelay, Random random)
 The Jitter algorithm is responsible for introducing randomness to a delay before a retry.
delegate void RetryListener (int numRetry, Retry retry)
 Listens to retry events for a particular request.
delegate bool TransientExceptionDelegate (Exception e)
 A delegate used to determine whether or not a network exception is due to a temporary bad state on the server. For example, timeouts can be transient in cases where the server is experiencing temporarily high load.

Enumeration Type Documentation

◆ ApiFlagOverrideType

Enumerator
FLAG 
FLAG_VARIANT 
LIVE_EVENT_FLAG 
LIVE_EVENT_FLAG_VARIANT 
EXPERIMENT_PHASE_VARIANT_FLAG 

◆ FlagValueChangeReasonType

Enumerator
UNKNOWN 
FLAG_VARIANT 
LIVE_EVENT 
EXPERIMENT 

Function Documentation

◆ Jitter()

delegate int Satori.Jitter ( IList< Retry > retryHistory,
int retryDelay,
Random random )

The Jitter algorithm is responsible for introducing randomness to a delay before a retry.

Parameters
retryHistoryInformation about previous retry attempts.
retryDelayA delay (milliseconds) between the last failed attempt in the retry history and the next upcoming attempt.
randomA Random object that has been seeded by IClient.RetryJitterSeed.
Returns
A new delay (milliseconds) between the last failed attempt in the retry history and the next upcoming attempt.

◆ RetryListener()

delegate void Satori.RetryListener ( int numRetry,
Retry retry )

Listens to retry events for a particular request.

Parameters
numRetryThe number of retries made so far, including this retry.
retryAn holding inromation about the retry attempt.

◆ TransientExceptionDelegate()

delegate bool Satori.TransientExceptionDelegate ( Exception e)

A delegate used to determine whether or not a network exception is due to a temporary bad state on the server. For example, timeouts can be transient in cases where the server is experiencing temporarily high load.