Class CustomIDRequest
Request for signing up or signing in a player with Custom ID.
Inherited Members
Namespace: Unity.Services.Apis.PlayerAuthentication
Assembly: Unity.Services.Apis.dll
Syntax
[DataContract(Name = "CustomIDRequest")]
[Preserve]
public class CustomIDRequest
Constructors
CustomIDRequest(string, bool, string)
Initializes a new instance of the Custom
Declaration
[Preserve]
public CustomIDRequest(string externalId = null, bool signInOnly = false, string accessToken = null)
Parameters
Type | Name | Description |
---|---|---|
string | externalId | The external id used to identify the player. Length must be between 1-320. (required). |
bool | signInOnly | Whether the API should only attempt to sign-in and do not create a new player if the player does not exist.. |
string | accessToken | The access token for the account to be linked.. |
Properties
AccessToken
The access token for the account to be linked.
Declaration
[DataMember(Name = "accessToken", EmitDefaultValue = false)]
[Preserve]
public string AccessToken { get; set; }
Property Value
Type | Description |
---|---|
string | The access token for the account to be linked. |
ExternalId
The external id used to identify the player. Length must be between 1-320.
Declaration
[DataMember(Name = "externalId", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public string ExternalId { get; set; }
Property Value
Type | Description |
---|---|
string | The external id used to identify the player. Length must be between 1-320. |
SignInOnly
Whether the API should only attempt to sign-in and do not create a new player if the player does not exist.
Declaration
[DataMember(Name = "signInOnly", EmitDefaultValue = true)]
[Preserve]
public bool SignInOnly { get; set; }
Property Value
Type | Description |
---|---|
bool | Whether the API should only attempt to sign-in and do not create a new player if the player does not exist. |