AccelByte.Api.Agreement Class Reference

Inheritance diagram for AccelByte.Api.Agreement:

Public Member Functions
void	GetLegalPolicies (AgreementPolicyType agreementPolicyType, string[] tags, bool defaultOnEmpty, ResultCallback< PublicPolicy[]> callback)
	Retrieve all active latest policies based on a namespace. The country will be read from user token.
void	GetLegalPolicies (AgreementPolicyType agreementPolicyType, bool defaultOnEmpty, ResultCallback< PublicPolicy[]> callback)
	Retrieve all active latest policies based on a namespace. The country will be read from user token.
void	GetLegalPoliciesByCountry (string countryCode, AgreementPolicyType agreementPolicyType, bool defaultOnEmpty, ResultCallback< PublicPolicy[]> callback)
	Retrieve all active latest policies based on a namespace and country. The country will be read from user token.
void	GetLegalPoliciesByCountry (string countryCode, AgreementPolicyType agreementPolicyType, string[] tags, bool defaultOnEmpty, ResultCallback< PublicPolicy[]> callback)
	Retrieve all active latest policies based on a namespace and country. The country will be read from user token.
void	BulkAcceptPolicyVersions (AcceptAgreementRequest[] acceptAgreementRequests, ResultCallback< AcceptAgreementResponse > callback)
	Sign multiple user's legal eligibility documents.
void	AcceptPolicyVersion (string localizedPolicyVersionId, ResultCallback callback)
	Sign a user's legal eligibility document.
void	QueryLegalEligibilities (ResultCallback< RetrieveUserEligibilitiesResponse[]> callback)
	Query all player's legal eligibilities on a namespace, used to check is player already commited to legal or not.
void	GetLegalDocument (string url, ResultCallback< string > callback)
	Get the content of the legal document.
void	ChangePolicyPreferences (ChangeAgreementRequest[] requestBody, ResultCallback callback)
	Accept/Revoke Marketing Preference Consent.
void	GetLegalPoliciesByNamespaceAndCountry (string countryCode, ResultCallback< PublicPolicy[]> callback)
	Retrieve all active latest policies based on a namespace and country.
void	GetLegalPoliciesByNamespaceAndCountry (string countryCode, GetPoliciesByNamespaceAndCountryOptionalParameters optionalParameters, ResultCallback< PublicPolicy[]> callback)
	Retrieve all active latest policies based on a namespace and country.

Additional Inherited Members
Properties inherited from AccelByte.Core.WrapperBase
Utils.AccelByteIdValidator	IdValidator [get]

Member Function Documentation

AcceptPolicyVersion()

void AccelByte.Api.Agreement.AcceptPolicyVersion ( string localizedPolicyVersionId, ResultCallback callback )

inline

Sign a user's legal eligibility document.

Parameters

localizedPolicyVersionId	Localized Policy Version Id to accept
callback	Returns a Result via callback when completed

BulkAcceptPolicyVersions()

void AccelByte.Api.Agreement.BulkAcceptPolicyVersions ( AcceptAgreementRequest[] acceptAgreementRequests, ResultCallback< AcceptAgreementResponse > callback )

inline

Sign multiple user's legal eligibility documents.

Parameters

acceptAgreementRequests	Signed agreements
callback	Returns a Result that contains an AcceptAgreementResponse via callback when completed

ChangePolicyPreferences()

void AccelByte.Api.Agreement.ChangePolicyPreferences ( ChangeAgreementRequest[] requestBody, ResultCallback callback )

inline

Accept/Revoke Marketing Preference Consent.

Parameters

requestBody	Request body to be sent
callback	Returns a result via callback when completed

GetLegalDocument()

void AccelByte.Api.Agreement.GetLegalDocument ( string url, ResultCallback< string > callback )

inline

Get the content of the legal document.

Parameters

url	The url of the legal document, you can get it from GetLegalPolicies query
callback	Returns a Result that contains a string via callback when completed

GetLegalPolicies() [1/2]

void AccelByte.Api.Agreement.GetLegalPolicies ( AgreementPolicyType agreementPolicyType, bool defaultOnEmpty, ResultCallback< PublicPolicy[]> callback )

inline

Retrieve all active latest policies based on a namespace. The country will be read from user token.

Parameters

agreementPolicyType	Filter the responded policy by policy type. Choose the AgreementPolicyType.EMPTY if you want to be responded with all policy type.
defaultOnEmpty	Specify with true if you want to be responded with default country-specific policy if your requested country is not exist.
callback	Returns a Result that contains an array of public policy via callback when completed

GetLegalPolicies() [2/2]

void AccelByte.Api.Agreement.GetLegalPolicies ( AgreementPolicyType agreementPolicyType, string[] tags, bool defaultOnEmpty, ResultCallback< PublicPolicy[]> callback )

inline

Retrieve all active latest policies based on a namespace. The country will be read from user token.

• Main overload

Parameters

agreementPolicyType	Filter the responded policy by policy type. Choose the AgreementPolicyType.EMPTY if you want to be responded with all policy type.
tags
defaultOnEmpty	Specify with true if you want to be responded with default country-specific policy if your requested country is not exist.
callback	Returns a Result that contains an array of public policy via callback when completed

GetLegalPoliciesByCountry() [1/2]

void AccelByte.Api.Agreement.GetLegalPoliciesByCountry ( string countryCode, AgreementPolicyType agreementPolicyType, bool defaultOnEmpty, ResultCallback< PublicPolicy[]> callback )

inline

Retrieve all active latest policies based on a namespace and country. The country will be read from user token.

Parameters

defaultOnEmpty	Specify with true if you want to be responded with default country-specific policy if your requested country is not exist.
countryCode
agreementPolicyType	Filter the responded policy by policy type. Choose the AgreementPolicyType.EMPTY if you want to be responded with all policy type.
callback	Returns a Result that contains an array of public policy via callback when completed

GetLegalPoliciesByCountry() [2/2]

void AccelByte.Api.Agreement.GetLegalPoliciesByCountry ( string countryCode, AgreementPolicyType agreementPolicyType, string[] tags, bool defaultOnEmpty, ResultCallback< PublicPolicy[]> callback )

inline

Retrieve all active latest policies based on a namespace and country. The country will be read from user token.

Parameters

defaultOnEmpty	Specify with true if you want to be responded with default country-specific policy if your requested country is not exist.
countryCode
agreementPolicyType	Filter the responded policy by policy type. Choose the AgreementPolicyType.EMPTY if you want to be responded with all policy type.
tags	Filter the responded policy by tags.
callback	Returns a Result that contains an array of public policy via callback when completed

GetLegalPoliciesByNamespaceAndCountry() [1/2]

void AccelByte.Api.Agreement.GetLegalPoliciesByNamespaceAndCountry ( string countryCode, GetPoliciesByNamespaceAndCountryOptionalParameters optionalParameters, ResultCallback< PublicPolicy[]> callback )

inline

Retrieve all active latest policies based on a namespace and country.

• Main overload

Parameters

countryCode	Country code.
optionalParameters	Contains optional parameters.
callback	Returns a Result that contains an array of public policy via callback when completed

GetLegalPoliciesByNamespaceAndCountry() [2/2]

void AccelByte.Api.Agreement.GetLegalPoliciesByNamespaceAndCountry ( string countryCode, ResultCallback< PublicPolicy[]> callback )

inline

Retrieve all active latest policies based on a namespace and country.

• Main overload

Parameters

countryCode	Country code.
callback	Returns a Result that contains an array of public policy via callback when completed

QueryLegalEligibilities()

void AccelByte.Api.Agreement.QueryLegalEligibilities ( ResultCallback< RetrieveUserEligibilitiesResponse[]> callback )

inline

Query all player's legal eligibilities on a namespace, used to check is player already commited to legal or not.

Parameters

callback

Returns a Result that contains an array of RetrieveUserEligibilitiesResponse via callback when completed