Sites

Menu

AlphaLocatorFlow Class

Namespace: Improbable.Gdk.Core
GDK package: Core
Source

Represents the Alpha Locator connection flow.

Inheritance

Improbable.Gdk.Core.IConnectionFlow


Fields

LocatorHost Source
string LocatorHost

The IP address of the Locator to use when connecting.
AnonymousAuthPort Source
ushort AnonymousAuthPort

The port to use when connecting via development authentication.
DevAuthToken Source
string DevAuthToken

The development authentication token to use when connecting via with development authentication.
UseDevAuthFlow Source
bool UseDevAuthFlow

Denotes whether we should connect with development authentication.

Notes:
  • If this is false, it is assumed that the PlayerIdentityCredentials element in the LocatorParameters has been filled.
LocatorParameters Source
Improbable.Worker.CInterop.Alpha.LocatorParameters LocatorParameters

The parameters to use to connect to the Locator.


Constructors

AlphaLocatorFlow Source
AlphaLocatorFlow(IConnectionFlowInitializer<AlphaLocatorFlow> initializer = null)

Initializes a new instance of the AlphaLocatorFlow class.

Parameters


Methods

CreateAsync Source
async Task<Connection> CreateAsync(ConnectionParameters parameters, CancellationToken? token = null)

Creates a Connection asynchronously.

Returns:
A task that represents the asynchronous creation of the Connection object.

Parameters
  • ConnectionParameters parameters : The connection parameters to use for the connection.
  • CancellationToken? token : A cancellation token which should cancel the underlying connection attempt.
GetDevelopmentPlayerIdentityToken Source
string GetDevelopmentPlayerIdentityToken()

Retrieves a development player identity token using development authentication.

Returns:
The player identity token string.

Exceptions:
GetDevelopmentLoginTokens Source
List<LoginTokenDetails> GetDevelopmentLoginTokens(string workerType, string playerIdentityToken)

Retrieves the login tokens for all active deployments that the player can connect to via the development authentication flow.

Returns:
A list of all available login tokens and their deployments.

Parameters
  • string workerType : The type of the worker that wants to connect.
  • string playerIdentityToken : The player identity token of the player that wants to connect.
SelectLoginToken Source
string SelectLoginToken(List<LoginTokenDetails> loginTokens)

Selects which login token to use to connect via the development authentication flow.

Returns:
The selected login token.

Parameters
  • List<LoginTokenDetails> loginTokens : A list of available login tokens.
GetPlayerId Source
string GetPlayerId()

Gets the player ID for the player trying to connect via the development authentication flow.

Returns:
A string containing the player id.
GetDisplayName Source
string GetDisplayName()

Retrieves the display name for the player trying to connect via the development authentication flow.

Returns:
A string containing the display name.

Search results

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums