Class Configuration

• Defined in File Configuration.cs

Nested Relationships

Nested Types

• Class Configuration::DefaultCreds

• Class Configuration::DemoCreds

Class Documentation

class xbe.sdk.Configuration

The Configuration class defines global configuration information used by the SDK to function. It also stores state information of the owning CoreSDK instance.

Public Functions

string GetBaseServicePath (Type type)

void SetBaseServicePath (Type type, string path)

string Base64HashFromString (string input)

string GuidFromBase64 (string input)

Configuration ()

Creates a new instance of Configuration.

AuthMethod GetAuthMethod (string name)

Returns the AuthMethod with the given name if available with the configured cluster. /summary>

param name:

The name of the auth method to retrieve.

Properties

bool AllowInsecure { get; set; }

Set to true to disable SSL certificate verification, otherwise set to false. Default is false.

string InstanceName { get; set; }

The instance name associated with this SDK/configuration.

string BaseUrl { get; set; }

The base URL to the services API.

string DeviceHash { get; set; }

The unique hash of this device.

string DeviceId { get; set; }

The unique identifier of this device.

string JWTAlgorithm { get; set; }

The algorithm to sign the JWT token with when local authentication is used.

string JWTAudience { get; set; }

The audience setting used to sign the JWT token when local authentication is used.

string JWTIssuer { get; set; }

The issuer setting used to sign the JWT token when local authentication is used.

string JWTPrivateKey { get; set; }

The private key used to sign the JWT token when local authentication is used.

string UserAgent { get; set; }

The user agent type used when making service API requests.

string > DefaultHeaders { get; set; }

The set of HTTP headers to include with all REST API requests.

CancellationToken CancelToken { get; set; }

The cancellation token used to stop any currently executing asynchronous tasks.

string > APIKeys { get; set; }

The map of API keys with the associated prefix.

string > BaseServicePaths { get; set; }

User LoggedInUser { get; set; }

The currently logged in user associated with this instance of the CoreSDK.

int MaxRetries { get; set; }

The maximum number of automatic retries performed before giving up on any given operation. Default is 5.

int PollingFrequency { get; set; }

The number of milliseconds to wait in between polling for updates to entity objects. Default is 5000.

string ProxyUrl { get; set; }

The URL to the HTTP proxy server that will relay requests from the SDK.

bool PushEnabled { get; set; }

Set to true to enable use of push notifications instead of polling, otherwise set to false. Default is true.

string SDKVersion { get; set; }

The version of current SDK.

string ExecutableVersion { get; set; }

The version of the Executable.

AuthMethod[] AuthMethods { get; set; }

class DefaultCreds

Change this for local testing.

Public Static Attributes

const string BaseUrl = "http://localhost:3000"

const string JWTAudience = "xbecloud.com"

const string JWTIssuer = "xbecloud.com"

const string JWTPrivateKey = "password"

class DemoCreds

Base configuration for XBE demo environment.

Public Static Attributes

const string BaseUrl = "https://api.demo.xbe.xsolla.cloud/v1"

const string JWTAudience = "demo.xbe.xsolla.cloud"

const string JWTIssuer = "api.demo.xbe.xsolla.cloud"

const string JWTPrivateKey = "password"