host.anzo.eossdk.eos.sdk

Class EOS_KWS_Interface

java.lang.Object

com.sun.jna.PointerType

host.anzo.eossdk.eos.sdk.EOS_KWS_Interface

All Implemented Interfaces:

com.sun.jna.NativeMapped

public class EOS_KWS_Interface
extends com.sun.jna.PointerType

This interface is not available for general access at this time.

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.

Since:

8/20/2023

See Also:

EOS_Platform_Interface.getKWSInterface()

Constructor Summary

Constructors

Constructor and Description
EOS_KWS_Interface()
EOS_KWS_Interface(com.sun.jna.Pointer address)

Method Summary

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.

Methods inherited from class com.sun.jna.PointerType

equals, fromNative, getPointer, hashCode, nativeType, setPointer, toNative, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EOS_KWS_Interface

public EOS_KWS_Interface(com.sun.jna.Pointer address)

EOS_KWS_Interface

public EOS_KWS_Interface()

Method Detail

queryAgeGate

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

Query the client's country and age permissions for client side reasoning about the possible need enforce age based restrictions

Parameters:

options - options required for interacting with the age gate system

clientData - Arbitrary data that is passed back to you in the completionDelegate

completionDelegate - A callback that is fired when the operation completes, either successfully or in error

createUser

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

Create an account with Kids Web Services and associate it with the local Product User ID

Parameters:

options - options required for creating an account such as the local users Product User ID, their data of birth, and parental contact information

clientData - Arbitrary data that is passed back to you in the completionDelegate

completionDelegate - A callback that is fired when the operation completes, either successfully or in error

queryPermissions

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

Query the current state of permissions for a given local Product User ID

Parameters:

options - options required for querying permissions such as the local users Product User ID

clientData - Arbitrary data that is passed back to you in the completionDelegate

completionDelegate - A callback that is fired when the operation completes, either successfully or in error

updateParentEmail

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

Update the parent contact information for a given local Product User ID

Parameters:

options - options required for updating the contact information such as the new email address

clientData - Arbitrary data that is passed back to you in the completionDelegate

completionDelegate - A callback that is fired when the operation completes, either successfully or in error

requestPermissions

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

Request new permissions for a given local Product User ID

Parameters:

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

clientData - Arbitrary data that is passed back to you in the completionDelegate

completionDelegate - A callback that is fired when the operation completes, either successfully or in error

getPermissionsCount

public int getPermissionsCount(EOS_KWS_GetPermissionsCountOptions options)

This interface is not available for general access at this time.

Fetch the number of permissions found for a given local user

Parameters:

options - Structure containing the input parameters

Returns:

the number of permissions associated with the given user

copyPermissionByIndex

public EOS_KWS_PermissionStatus copyPermissionByIndex(EOS_KWS_CopyPermissionByIndexOptions options)
                                               throws EOSException

This interface is not available for general access at this time.

Fetch a permission for a given by index for a given local user

Parameters:

options - Structure containing the input parameters

Returns:

the permission for the given index, if it exists and is valid, use EOS_KWS_PermissionStatus_Release when finished

Throws:

EOSNotFoundException - if the user is not found or the index is invalid

EOSException

See Also:

createUser(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()

getPermissionByKey

public EOS_EResult getPermissionByKey(EOS_KWS_GetPermissionByKeyOptions options,
                                      java.nio.IntBuffer outPermission)

This interface is not available for general access at this time.

Fetch the state of a given permission that are cached for a given local user.

Parameters:

options - Structure containing the input parameters

outPermission - the permission for the given key, if it exists and is valid

Returns:

EOS_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 found

See Also:

createUser(EOS_KWS_CreateUserOptions, Pointer, EOS_KWS_OnCreateUserCallback), queryPermissions(EOS_KWS_QueryPermissionsOptions, Pointer, EOS_KWS_OnQueryPermissionsCallback), requestPermissions(EOS_KWS_RequestPermissionsOptions, Pointer, EOS_KWS_OnRequestPermissionsCallback)

addNotifyPermissionsUpdateReceived

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

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.

Parameters:

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.

Returns:

handle representing the registered callback

removeNotifyPermissionsUpdateReceived

public void removeNotifyPermissionsUpdateReceived(EOS_NotificationId inId)

This interface is not available for general access at this time.

Unregister from receiving notifications about KWS permissions related to logged in users

Parameters:

inId - Handle representing the registered callback