Method LinkWithSteamAsync

LinkWithSteamAsync(string, string, LinkOptions)

Link the current player with the Steam account using Steam's session ticket.

Declaration

Task LinkWithSteamAsync(string sessionTicket, string identity, LinkOptions options = null)

Parameters

Type	Name	Description
string	sessionTicket	Steam's session ticket
string	identity	The identity of the calling service
LinkOptions	options	Options for the link operations.

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 AccountAlreadyLinked if the player tries to link a social account while the social account is already linked with another player. Throws with ErrorCode InvalidParameters if parameter is empty or invalid. Throws with ErrorCode ClientInvalidUserState if the player is not authorized to perform this operation. Throws with ErrorCode AccountLinkLimitExceeded if the player has already reached the limit of links for this provider type.
RequestFailedException	The task fails with the exception when the task cannot complete successfully. Throws with ErrorCode InvalidToken if access token is invalid/expired. The access token is refreshed before it expires. This may happen if the refresh fails, or the app is unpaused with an expired access token while the refresh hasn't finished. 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.

LinkWithSteamAsync(string, LinkOptions)

Link the current player with the Steam account using Steam's session ticket. 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 LinkWithSteamAsync method with the 'identity' parameter for better security.")]
Task LinkWithSteamAsync(string sessionTicket, LinkOptions options = null)

Parameters

Type	Name	Description
string	sessionTicket	Steam's session ticket
LinkOptions	options	Options for the link operations.

Returns

Type	Description
Task	Task for the operation

LinkWithSteamAsync(string, string, string, LinkOptions)

Link the current player with the Steam account using Steam's session ticket.

Declaration

Task LinkWithSteamAsync(string sessionTicket, string identity, string appId, LinkOptions 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)
LinkOptions	options	Options for the link operations.

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 AccountAlreadyLinked if the player tries to link a social account while the social account is already linked with another player. Throws with ErrorCode InvalidParameters if parameter is empty or invalid. Throws with ErrorCode ClientInvalidUserState if the player is not authorized to perform this operation. Throws with ErrorCode AccountLinkLimitExceeded if the player has already reached the limit of links for this provider type.
RequestFailedException	The task fails with the exception when the task cannot complete successfully. Throws with ErrorCode InvalidToken if access token is invalid/expired. The access token is refreshed before it expires. This may happen if the refresh fails, or the app is unpaused with an expired access token while the refresh hasn't finished. 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.