EOS API reference page for EOS_KWS_RequestPermissions


This function is part of the KWS Interface.


This interface is not available for general access at this time. Request new permissions 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

  • EOS_KWS_ParentEmailMissing if the account requesting permissions has no parent email associated with it

  • EOS_LimitExceeded if the number of permissions exceeds EOS_KWS_MAX_PERMISSIONS, or if any permission name exceeds EOS_KWS_MAX_PERMISSION_LENGTH



Parameter Type And NameUsage Information
const EOS_KWS_RequestPermissionsOptions* Optionsoptions required for updating permissions such as the new list of permissions
void* ClientDataArbitrary data that is passed back to you in the CompletionDelegate
const EOS_KWS_OnRequestPermissionsCallback CompletionDelegateA callback that is fired when the operation completes, either successfully or in error

Callback Function Information

Because this function is asynchronous, it employs a callback of type EOS_KWS_OnRequestPermissionsCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to EOS_KWS_RequestPermissions

Callback Parameters


Parameter Type And NameUsage Information
const EOS_KWS_RequestPermissionsCallbackInfo* DataA EOS_KWS_RequestPermissionsCallbackInfo containing the output information and result