public class EOS_KWS_Interface
extends com.sun.jna.PointerType
The KWS Interface exists as an integration for age gating functionality provided by Kids Web Services from SuperAwesome, using the EOS Connect interface.
All KWS Interface calls take a handle of type EOS_HKWS as the first parameter. This handle can be retrieved from a EOS_HPlatform handle by using the EOS_Platform_GetKWSInterface function.
EOS_Platform_Interface.getKWSInterface()| Constructor and Description |
|---|
EOS_KWS_Interface() |
EOS_KWS_Interface(com.sun.jna.Pointer address) |
| Modifier and Type | Method and Description |
|---|---|
EOS_NotificationId |
addNotifyPermissionsUpdateReceived(EOS_KWS_AddNotifyPermissionsUpdateReceivedOptions options,
com.sun.jna.Pointer clientData,
EOS_KWS_OnPermissionsUpdateReceivedCallback notificationFn)
This interface is not available for general access at this time.
|
EOS_KWS_PermissionStatus |
copyPermissionByIndex(EOS_KWS_CopyPermissionByIndexOptions options)
This interface is not available for general access at this time.
|
void |
createUser(EOS_KWS_CreateUserOptions options,
com.sun.jna.Pointer clientData,
EOS_KWS_OnCreateUserCallback completionDelegate)
This interface is not available for general access at this time.
|
EOS_EResult |
getPermissionByKey(EOS_KWS_GetPermissionByKeyOptions options,
java.nio.IntBuffer outPermission)
This interface is not available for general access at this time.
|
int |
getPermissionsCount(EOS_KWS_GetPermissionsCountOptions options)
This interface is not available for general access at this time.
|
void |
queryAgeGate(EOS_KWS_QueryAgeGateOptions options,
com.sun.jna.Pointer clientData,
EOS_KWS_OnQueryAgeGateCallback completionDelegate)
This interface is not available for general access at this time.
|
void |
queryPermissions(EOS_KWS_QueryPermissionsOptions options,
com.sun.jna.Pointer clientData,
EOS_KWS_OnQueryPermissionsCallback completionDelegate)
This interface is not available for general access at this time.
|
void |
removeNotifyPermissionsUpdateReceived(EOS_NotificationId inId)
This interface is not available for general access at this time.
|
void |
requestPermissions(EOS_KWS_RequestPermissionsOptions options,
com.sun.jna.Pointer clientData,
EOS_KWS_OnRequestPermissionsCallback completionDelegate)
This interface is not available for general access at this time.
|
void |
updateParentEmail(EOS_KWS_UpdateParentEmailOptions options,
com.sun.jna.Pointer clientData,
EOS_KWS_OnUpdateParentEmailCallback completionDelegate)
This interface is not available for general access at this time.
|
public EOS_KWS_Interface(com.sun.jna.Pointer address)
public EOS_KWS_Interface()
public void queryAgeGate(EOS_KWS_QueryAgeGateOptions options, com.sun.jna.Pointer clientData, EOS_KWS_OnQueryAgeGateCallback completionDelegate)
Query the client's country and age permissions for client side reasoning about the possible need enforce age based restrictions
options - options required for interacting with the age gate systemclientData - Arbitrary data that is passed back to you in the completionDelegatecompletionDelegate - A callback that is fired when the operation completes, either successfully or in errorpublic void createUser(EOS_KWS_CreateUserOptions options, com.sun.jna.Pointer clientData, EOS_KWS_OnCreateUserCallback completionDelegate)
Create an account with Kids Web Services and associate it with the local Product User ID
options - options required for creating an account such as the local users Product User ID, their data of birth, and parental contact informationclientData - Arbitrary data that is passed back to you in the completionDelegatecompletionDelegate - A callback that is fired when the operation completes, either successfully or in errorpublic void queryPermissions(EOS_KWS_QueryPermissionsOptions options, com.sun.jna.Pointer clientData, EOS_KWS_OnQueryPermissionsCallback completionDelegate)
Query the current state of permissions for a given local Product User ID
options - options required for querying permissions such as the local users Product User IDclientData - Arbitrary data that is passed back to you in the completionDelegatecompletionDelegate - A callback that is fired when the operation completes, either successfully or in errorpublic void updateParentEmail(EOS_KWS_UpdateParentEmailOptions options, com.sun.jna.Pointer clientData, EOS_KWS_OnUpdateParentEmailCallback completionDelegate)
Update the parent contact information for a given local Product User ID
options - options required for updating the contact information such as the new email addressclientData - Arbitrary data that is passed back to you in the completionDelegatecompletionDelegate - A callback that is fired when the operation completes, either successfully or in errorpublic void requestPermissions(EOS_KWS_RequestPermissionsOptions options, com.sun.jna.Pointer clientData, EOS_KWS_OnRequestPermissionsCallback completionDelegate)
Request new permissions for a given local Product User ID
options - options required for updating permissions such as the new list of permissionsclientData - Arbitrary data that is passed back to you in the completionDelegatecompletionDelegate - A callback that is fired when the operation completes, either successfully or in errorpublic int getPermissionsCount(EOS_KWS_GetPermissionsCountOptions options)
Fetch the number of permissions found for a given local user
options - Structure containing the input parameterspublic EOS_KWS_PermissionStatus copyPermissionByIndex(EOS_KWS_CopyPermissionByIndexOptions options) throws EOSException
Fetch a permission for a given by index for a given local user
options - Structure containing the input parametersEOSNotFoundException - if the user is not found or the index is invalidEOSExceptioncreateUser(EOS_KWS_CreateUserOptions, Pointer, EOS_KWS_OnCreateUserCallback),
queryPermissions(EOS_KWS_QueryPermissionsOptions, Pointer, EOS_KWS_OnQueryPermissionsCallback),
requestPermissions(EOS_KWS_RequestPermissionsOptions, Pointer, EOS_KWS_OnRequestPermissionsCallback),
EOS_KWS_PermissionStatus.release()public EOS_EResult getPermissionByKey(EOS_KWS_GetPermissionByKeyOptions options, java.nio.IntBuffer outPermission)
Fetch the state of a given permission that are cached for a given local user.
options - Structure containing the input parametersoutPermission - the permission for the given key, if it exists and is validEOS_EResult.EOS_Success if the permission state is known for the given user and key
EOS_EResult.EOS_NotFound if the user or the permission is not foundcreateUser(EOS_KWS_CreateUserOptions, Pointer, EOS_KWS_OnCreateUserCallback),
queryPermissions(EOS_KWS_QueryPermissionsOptions, Pointer, EOS_KWS_OnQueryPermissionsCallback),
requestPermissions(EOS_KWS_RequestPermissionsOptions, Pointer, EOS_KWS_OnRequestPermissionsCallback)public EOS_NotificationId addNotifyPermissionsUpdateReceived(EOS_KWS_AddNotifyPermissionsUpdateReceivedOptions options, com.sun.jna.Pointer clientData, EOS_KWS_OnPermissionsUpdateReceivedCallback notificationFn)
Register to receive notifications about KWS permissions changes for any logged in local users
If the returned NotificationId is valid, you must call removeNotifyPermissionsUpdateReceived(EOS_NotificationId) when you no longer wish to have your NotificationHandler called.
options - Structure containing information about the request.clientData - Arbitrary data that is passed back to you in the completionDelegate.notificationFn - A callback that is fired when a notification is received.public void removeNotifyPermissionsUpdateReceived(EOS_NotificationId inId)
Unregister from receiving notifications about KWS permissions related to logged in users
inId - Handle representing the registered callback