Job which is used to log into the Astra service. Returns a string indicating the user handle if successful, and an AuthError if there was a failure. More...
Public Member Functions | |
| override Auth.AuthError | GetError () |
| When the job is complete this function can be called by the developer to access the error data set which can be of any type (defined as T2). This needs to be defined if your derived class as an override. More... | |
| override string | GetResult () |
| When the job is complete this function can be called by the developer to access the result data set which can be of any type (defined as T1). This needs to be defined if your derived class as an override. More... | |
 Public Member Functions inherited from Astra.ApiJobWithResult< string, Auth.AuthError > | |
| IEnumerator | AsCoroutine (Action< float > progress=null, Action< T1 > onComplete=null, Action< T2 > onFailed=null) |
| Wraps a job to be used within a coroutine More... | |
Detailed Description
Job which is used to log into the Astra service. Returns a string indicating the user handle if successful, and an AuthError if there was a failure.
Member Function Documentation
◆ GetError()
|
inlinevirtual |
When the job is complete this function can be called by the developer to access the error data set which can be of any type (defined as T2). This needs to be defined if your derived class as an override.
- Returns
- Yields the error result data
Implements Astra.ApiJobWithResult< string, Auth.AuthError >.
◆ GetResult()
|
inlinevirtual |
When the job is complete this function can be called by the developer to access the result data set which can be of any type (defined as T1). This needs to be defined if your derived class as an override.
- Returns
- Yields the success result data
Implements Astra.ApiJobWithResult< string, Auth.AuthError >.
The documentation for this class was generated from the following file:
- Assets/Astra/Networking/Customer/LoginJob.cs
