EOS_KWS_RequestPermissions

EOS API reference page for EOS_KWS_RequestPermissions

Choose your implementation method:

C

C#

This function is part of the KWS Interface.

Remarks

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

Parameters

EOS_KWS_RequestPermissions

Parameter Type And Name

Usage Information

EOS_HKWS Handle

const EOS_KWS_RequestPermissionsOptions* Options

options required for updating permissions such as the new list of permissions

void* ClientData

Arbitrary data that is passed back to you in the CompletionDelegate

const EOS_KWS_OnRequestPermissionsCallback 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.

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

EOS_KWS_OnRequestPermissionsCallback

Parameter Type And Name

Usage Information

const EOS_KWS_RequestPermissionsCallbackInfo* Data

A EOS_KWS_RequestPermissionsCallbackInfo containing the output information and result

Related API Members

This function is part of the KWS Interface.

Remarks

This interface is not available for general access at this time. Request new permissions for a given local Product User ID {Result.InvalidParameters} if any of the options are incorrect {Result.TooManyRequests} if the number of allowed requests is exceeded {Result.ParentEmailMissing} if the account requesting permissions has no parent email associated with it {Result.LimitExceeded} if the number of permissions exceeds {MaxPermissions}, or if any permission name exceeds {MaxPermissionLength}

Return Value

{Result.Success} if contact information update completes successfully

Parameters

KWS.KWSInterface.RequestPermissions

Parameter Type And Name

Usage Information

RequestPermissionsOptions options

options required for updating permissions such as the new list of permissions

object clientData

Arbitrary data that is passed back to you in the CompletionDelegate

OnRequestPermissionsCallback 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 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.

Callback Function Information

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

Callback Remarks

Function prototype definition for callbacks passed to {KWSInterface.RequestPermissions}

Callback Parameters

KWS.OnRequestPermissionsCallback

Parameter Type And Name

Usage Information

RequestPermissionsCallbackInfo data

A EOS_KWS_RequestPermissionsCallbackInfo containing the output information and result

Related API Members