Public Member Functions | |
| ServiceUserCredentials | new () |
| Create new instance of class ServiceUserCredentials. More... | |
Public Attributes | |
| ServiceUserAuthToken | authToken |
| User authentification token. More... | |
| String | exchangeCode |
| Exchange token. More... | |
| Dictionary | parameters |
| Additional parameters if required by the service. More... | |
| String | password |
| User password. More... | |
| String | username |
| User name. More... | |
Detailed Description
User credentials.
- Version
- 1.23
Credentials for logging in user. Required for situations where the user has to or wants to use manual logging in in contrary to automatic logging in. Depending on the capabilities of the service different manual login scenarios are possible.
- System login
This method requests the service to present the user with a service specific login UI. This UI is typically either layered directly above the game content or by using a separate system dialog window receiving user input.
To use this login method use an empty ServiceUserCredentials.
- Authentication provider login (SSO)
This method uses an authentification token received from another service. A typical example is receiving an authentification token from your logged in Steam account as login for the service in question. This login method is typically called single sign on (SSO). See ServiceUserFeatures.canAuthProviderLogin obtained from ServiceUser.getUserFeatures() to know which other services are supported for manual login using auth tokens.
To use this login method receive an authentification token from another service using ServiceUser.getAuthToken() and assign the received token to authToken.
- Authentification transfer
This method transfers the authentification from a launcher to the game. An example for this kind of login method is the EPIC Games Launcher. By means of command line an exchange token is provided to the application to re-login using the currently logged in user.
To use this login method obtain the exchange code from the authenticated process and assign it to exchangeCode.
- Username and password
This method uses the classic username and password login. Depending on the service the username can be a user name, identification number or email.
To use this method collect using game UI the username and password. Assign these values to username and password.
Member Function Documentation
◆ new()
| ServiceUserCredentials Dragengine.Services.User.ServiceUserCredentials.new | ( | ) |
Create new instance of class ServiceUserCredentials.
Member Data Documentation
◆ authToken
| ServiceUserAuthToken Dragengine.Services.User.ServiceUserCredentials.authToken |
User authentification token.
Used for cross-platform authentication. Often called linking accounts. Usually logging in using service native methods provides more functionality than linking to an account of another service.
◆ exchangeCode
| String Dragengine.Services.User.ServiceUserCredentials.exchangeCode |
Exchange token.
Used only if a login using an authentication transfer mechanism is used. An example for this is Epic Game Launcher logging in the user then passing an exchange token to the game to re-login.
◆ parameters
| Dictionary Dragengine.Services.User.ServiceUserCredentials.parameters |
Additional parameters if required by the service.
Dictionary mapping String key to String value. Keys and values are service defined.
◆ password
| String Dragengine.Services.User.ServiceUserCredentials.password |
User password.
Depending on the service this can be a password or pass phrase. Used only if login using a user/password system is used.
◆ username
| String Dragengine.Services.User.ServiceUserCredentials.username |
User name.
Depending on the service this can be a user name, identifier or an email address. Used only if login using a user/password system is used.
The documentation for this class was generated from the following file:
