This function is part of the KWS Interface.
This interface is not available for general access at this time.
Update the parent contact information for a given local Product User ID
Return Value
EOS_Success if contact information update completes successfully
EOS_InvalidParameters if any of the options are incorrect
EOS_TooManyRequests if the number of allowed requests is exceeded
Parameters
EOS_KWS_UpdateParentEmail
Parameter Type And Name
|
Usage Information
|
EOS_HKWS Handle
|
|
const EOS_KWS_UpdateParentEmailOptions* Options
|
options required for updating the contact information such as the new email address
|
void* ClientData
|
Arbitrary data that is passed back to you in the CompletionDelegate
|
const EOS_KWS_OnUpdateParentEmailCallback CompletionDelegate
|
A callback that is fired when the 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_KWS_OnUpdateParentEmailCallback to report the results of its operation.
Function prototype definition for callbacks passed to EOS_KWS_UpdateParentEmail
Callback Parameters
EOS_KWS_OnUpdateParentEmailCallback
This function is part of the KWS Interface.
This interface is not available for general access at this time.
Update the parent contact information for a given local Product User ID
Return Value
EOS_Success if contact information update completes successfully
EOS_InvalidParameters if any of the options are incorrect
EOS_TooManyRequests if the number of allowed requests is exceeded
Parameters
KWS.KWSInterface.UpdateParentEmail
Parameter Type And Name
|
Usage Information
|
UpdateParentEmailOptions options
|
options required for updating the contact information such as the new email address
|
object clientData
|
Arbitrary data that is passed back to you in the CompletionDelegate
|
OnUpdateParentEmailCallback completionDelegate
|
A callback that is fired when the 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_KWS_OnUpdateParentEmailCallback to report the results of its operation.
Function prototype definition for callbacks passed to EOS_KWS_UpdateParentEmail
Callback Parameters
KWS.OnUpdateParentEmailCallback
Parameter Type And Name
|
Usage Information
|
UpdateParentEmailCallbackInfo data
|
A EOS_KWS_UpdateParentEmailCallbackInfo 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