Package host.anzo.eossdk.eos.sdk
Class EOS_Sanctions_Interface
java.lang.Object
com.sun.jna.PointerType
host.anzo.eossdk.eos.sdk.EOS_Sanctions_Interface
- All Implemented Interfaces:
com.sun.jna.NativeMapped
public class EOS_Sanctions_Interface
extends com.sun.jna.PointerType
The following EOS_Sanctions_* functions allow you to query sanctions info for specified players
- Since:
- 8/19/2023
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionCopies an active player sanction.voidcreatePlayerSanctionAppeal(EOS_Sanctions_Interface handle, EOS_Sanctions_CreatePlayerSanctionAppealOptions options, com.sun.jna.Pointer clientData, EOS_Sanctions_CreatePlayerSanctionAppealCallback completionDelegate) Create a sanction appeal on behalf of a local user.intFetch the number of player sanctions that have been retrieved for a given player.voidqueryActivePlayerSanctions(EOS_Sanctions_QueryActivePlayerSanctionsOptions options, com.sun.jna.Pointer clientData, EOS_Sanctions_OnQueryActivePlayerSanctionsCallback completionDelegate) Start an asynchronous query to retrieve any active sanctions for a specified user.Methods inherited from class com.sun.jna.PointerType
equals, fromNative, getPointer, hashCode, nativeType, setPointer, toNative, toString
-
Constructor Details
-
EOS_Sanctions_Interface
public EOS_Sanctions_Interface(com.sun.jna.Pointer address) -
EOS_Sanctions_Interface
public EOS_Sanctions_Interface()
-
-
Method Details
-
queryActivePlayerSanctions
public void queryActivePlayerSanctions(EOS_Sanctions_QueryActivePlayerSanctionsOptions options, com.sun.jna.Pointer clientData, EOS_Sanctions_OnQueryActivePlayerSanctionsCallback completionDelegate) Start an asynchronous query to retrieve any active sanctions for a specified user. Call EOS_Sanctions_GetPlayerSanctionCount and EOS_Sanctions_CopyPlayerSanctionByIndex to retrieve the data.- Parameters:
options- Structure containing the input parametersclientData- Arbitrary data that is passed back to you in the CompletionDelegatecompletionDelegate- A callback that is fired when the async operation completes, either successfully or in error- See Also:
-
getPlayerSanctionCount
Fetch the number of player sanctions that have been retrieved for a given player. You must call QueryActivePlayerSanctions first to retrieve the data from the service backend.- Parameters:
options- Structure containing the input parameters- Returns:
- Number of available sanctions for this player.
- See Also:
-
copyPlayerSanctionByIndex
public EOS_Sanctions_PlayerSanction copyPlayerSanctionByIndex(EOS_Sanctions_CopyPlayerSanctionByIndexOptions options) throws EOSException Copies an active player sanction. You must call QueryActivePlayerSanctions first to retrieve the data from the service backend. On success,EOS_Sanctions_PlayerSanction.release()must be called on OutSanction to free memory.- Parameters:
options- Structure containing the input parameters- Returns:
- The player sanction data for the given index, if it exists and is valid
- Throws:
EOSInvalidParametersException- if you pass a null pointer for the out parameterEOSNotFoundException- if the player achievement is not foundEOSException- See Also:
-
createPlayerSanctionAppeal
public void createPlayerSanctionAppeal(EOS_Sanctions_Interface handle, EOS_Sanctions_CreatePlayerSanctionAppealOptions options, com.sun.jna.Pointer clientData, EOS_Sanctions_CreatePlayerSanctionAppealCallback completionDelegate) Create a sanction appeal on behalf of a local user. Note that for creating the sanction appeal you'll need the sanction reference id, which is available throughcopyPlayerSanctionByIndex(EOS_Sanctions_CopyPlayerSanctionByIndexOptions).- Parameters:
options- Structure containing the player sanction appeal information.clientData- Optional client data provided by the user of the SDK.completionDelegate- This function is called when the send operation completes.
-