This function is part of the Connect Interface.
Login/Authenticate given a valid set of external auth credentials.
Parameters
EOS_Connect_Login
Parameter Type And Name
|
Usage Information
|
EOS_HConnect Handle
|
|
const EOS_Connect_LoginOptions* Options
|
structure containing the external account credentials and type to use during the login operation.
|
void* ClientData
|
arbitrary data that is passed back to you in the CompletionDelegate.
|
const EOS_Connect_OnLoginCallback CompletionDelegate
|
a callback that is fired when the login operation completes, either successfully or in error.
|
This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate
parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the void*
parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.
Because this function is asynchronous, it employs a callback of type EOS_Connect_OnLoginCallback to report the results of its operation.
Function prototype definition for callbacks passed to EOS_Connect_Login.
Callback Parameters
EOS_Connect_OnLoginCallback
Parameter Type And Name
|
Usage Information
|
const EOS_Connect_LoginCallbackInfo* Data
|
A EOS_Connect_LoginCallbackInfo containing the output information and result.
|
This function is part of the Connect Interface.
Login/Authenticate given a valid set of external auth credentials.
Parameters
Connect.ConnectInterface.Login
Parameter Type And Name
|
Usage Information
|
LoginOptions options
|
structure containing the external account credentials and type to use during the login operation.
|
object clientData
|
arbitrary data that is passed back to you in the CompletionDelegate.
|
OnLoginCallback completionDelegate
|
a callback that is fired when the login operation completes, either successfully or in error.
|
This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate
parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the object
parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.
Because this function is asynchronous, it employs a callback of type Connect.OnLoginCallback to report the results of its operation.
Function prototype definition for callbacks passed to {ConnectInterface.Login}.
Callback Parameters
Connect.OnLoginCallback
Parameter Type And Name
|
Usage Information
|
LoginCallbackInfo data
|
A EOS_Connect_LoginCallbackInfo containing the output information and result.
|
Was this document useful?
Thank you for the response!
You’ve marked this document as useful:
yes
You’ve marked this document as not useful:
no