Method SignInWithSteamAsync

SignInWithSteamAsync(string, string, SignInOptions)

Sign in using Steam's session ticket. If no options are used, this will create an account if none exist.

Declaration

Task SignInWithSteamAsync(string sessionTicket, string identity, SignInOptions options = null)

Parameters

Type	Name	Description
string	sessionTicket	Steam's session ticket
string	identity	The identity of the calling service
SignInOptions	options	Options for the operation

Returns

Type	Description
Task	Task for the operation

Exceptions

Type	Condition
AuthenticationException	The task fails with the exception when the task cannot complete successfully due to Authentication specific errors. Throws with ErrorCode InvalidParameters if parameter is empty or invalid. Throws with ErrorCode ClientInvalidUserState if the player has already signed in or a sign-in operation is in progress.
RequestFailedException	The task fails with the exception when the task cannot complete successfully. Throws with ErrorCode InvalidToken if the server side returned an invalid access token. Throws with ErrorCode TransportError if the API call failed due to network error. Check Unity logs for more debugging information. Throws with ErrorCode Unknown if the API call failed due to unexpected response from the server. Check Unity logs for more debugging information.

SignInWithSteamAsync(string, SignInOptions)

Sign in using Steam's session ticket. If no options are used, this will create an account if none exist. This method is deprecated and may be removed in future versions.

Declaration

[Obsolete("This method is deprecated as of version 2.7.1. Please use the SignInWithSteamAsync method with the 'identity' parameter for better security.")]
Task SignInWithSteamAsync(string sessionTicket, SignInOptions options = null)

Parameters

Type	Name	Description
string	sessionTicket	Steam's session ticket
SignInOptions	options	Options for the operation

Returns

Type	Description
Task	Task for the operation

SignInWithSteamAsync(string, string, string, SignInOptions)

Sign in using Steam's session ticket. If no options are used, this will create an account if none exist.

Declaration

Task SignInWithSteamAsync(string sessionTicket, string identity, string appId, SignInOptions options = null)

Parameters

Type	Name	Description
string	sessionTicket	Steam's session ticket
string	identity	The identity of the calling service
string	appId	App Id that was used to generate the ticket. Only required for additional app ids (e.g.: PlayTest, Demo, etc)
SignInOptions	options	Options for the operation

Returns

Type	Description
Task	Task for the operation

Exceptions

Type	Condition
AuthenticationException	The task fails with the exception when the task cannot complete successfully due to Authentication specific errors. Throws with ErrorCode InvalidParameters if parameter is empty or invalid. Throws with ErrorCode ClientInvalidUserState if the player has already signed in or a sign-in operation is in progress.
RequestFailedException	The task fails with the exception when the task cannot complete successfully. Throws with ErrorCode InvalidToken if the server side returned an invalid access token. Throws with ErrorCode TransportError if the API call failed due to network error. Check Unity logs for more debugging information. Throws with ErrorCode Unknown if the API call failed due to unexpected response from the server. Check Unity logs for more debugging information.