FOnlineAgreementAccelByte Class Reference

#include <OnlineAgreementInterfaceAccelByte.h>

Inheritance diagram for FOnlineAgreementAccelByte:

Public Member Functions
	DEFINE_ONLINE_PLAYER_DELEGATE (MAX_LOCAL_PLAYERS, OnUserNotComplied)
	DEFINE_ONLINE_PLAYER_DELEGATE_THREE_PARAM (MAX_LOCAL_PLAYERS, OnQueryEligibilitiesCompleted, bool, const TArray< FAccelByteModelsRetrieveUserEligibilitiesResponse > &, const FString &)
	DEFINE_ONLINE_PLAYER_DELEGATE_THREE_PARAM (MAX_LOCAL_PLAYERS, OnGetLocalizedPolicyContentCompleted, bool, const FString &, const FString &)
	DEFINE_ONLINE_PLAYER_DELEGATE_TWO_PARAM (MAX_LOCAL_PLAYERS, OnAcceptAgreementPoliciesCompleted, bool, const FString &)
	DEFINE_ONLINE_PLAYER_DELEGATE_THREE_PARAM (MAX_LOCAL_PLAYERS, AccelByteOnQueryEligibilitiesCompleted, bool, const TArray< FAccelByteModelsRetrieveUserEligibilitiesResponse > &, const FOnlineErrorAccelByte &)
	DEFINE_ONLINE_PLAYER_DELEGATE_THREE_PARAM (MAX_LOCAL_PLAYERS, AccelByteOnGetLocalizedPolicyContentCompleted, bool, const FString &, const FOnlineErrorAccelByte &)
	DEFINE_ONLINE_PLAYER_DELEGATE_TWO_PARAM (MAX_LOCAL_PLAYERS, AccelByteOnAcceptAgreementPoliciesCompleted, bool, const FOnlineErrorAccelByte &)
bool	QueryEligibleAgreements (int32 LocalUserNum, bool bNotAcceptedOnly=false, bool bAlwaysRequestToService=false)
	Query user's eligibilities.
bool	GetEligibleAgreements (int32 LocalUserNum, TArray< TSharedRef< FAccelByteModelsRetrieveUserEligibilitiesResponse > > &OutEligibilites)
bool	GetLocalizedPolicyContent (int32 LocalUserNum, const FString &BasePolicyId, const FString &LocaleCode, bool bAlwaysRequestToService=false)
	Get the localized policy content.
bool	GetLocalizedPolicyContentFromCache (const FString &BasePolicyId, const FString &LocaleCode, FString &OutLocalizedPolicyContent)
bool	AcceptAgreementPolicies (int32 LocalUserNum, const TArray< FABAcceptAgreementPoliciesRequest > &DocumentsToAccept)

Static Public Member Functions
static bool	GetFromSubsystem (const IOnlineSubsystem *Subsystem, TSharedPtr< FOnlineAgreementAccelByte, ESPMode::ThreadSafe > &OutInterfaceInstance)
static bool	GetFromWorld (const UWorld *World, TSharedPtr< FOnlineAgreementAccelByte, ESPMode::ThreadSafe > &OutInterfaceInstance)

Protected Member Functions
	FOnlineAgreementAccelByte ()

Protected Attributes
FOnlineSubsystemAccelByteWPtr	AccelByteSubsystem = nullptr

Detailed Description

Implementation of Agreement service from AccelByte services

Constructor & Destructor Documentation

FOnlineAgreementAccelByte()

FOnlineAgreementAccelByte::FOnlineAgreementAccelByte ( )

inlineprotected

Hidden default constructor, the constructor that takes in a subsystem instance should be used instead.

Member Function Documentation

GetFromSubsystem()

bool FOnlineAgreementAccelByte::GetFromSubsystem ( const IOnlineSubsystem * Subsystem, TSharedPtr< FOnlineAgreementAccelByte, ESPMode::ThreadSafe > & OutInterfaceInstance )

static

Convenience method to get an instance of this interface from the subsystem passed in.

Parameters

Subsystem	Subsystem instance that we wish to get this interface from
OutInterfaceInstance	Instance of the interface that we got from the subsystem, or nullptr if not found

Returns

boolean that is true if we could get an instance of the interface, false otherwise

GetFromWorld()

bool FOnlineAgreementAccelByte::GetFromWorld ( const UWorld * World, TSharedPtr< FOnlineAgreementAccelByte, ESPMode::ThreadSafe > & OutInterfaceInstance )

static

Convenience method to get an instance of this interface from the subsystem associated with the world passed in.

Parameters

World	World instance that we wish to get the interface from
OutInterfaceInstance	Instance of the interface that we got from the subsystem, or nullptr if not found

Returns

boolean that is true if we could get an instance of the interface, false otherwise

GetLocalizedPolicyContent()

bool FOnlineAgreementAccelByte::GetLocalizedPolicyContent	(	int32	LocalUserNum,
		const FString &	BasePolicyId,
		const FString &	LocaleCode,
		bool	bAlwaysRequestToService = false )

Get the localized policy content.

Parameters

bAlwaysRequestToService

true to force create request to query the content from agreement service.

QueryEligibleAgreements()

bool FOnlineAgreementAccelByte::QueryEligibleAgreements	(	int32	LocalUserNum,
		bool	bNotAcceptedOnly = false,
		bool	bAlwaysRequestToService = false )

Query user's eligibilities.

Parameters

bNotAcceptedOnly	true to only get the eligibilities that not complied yet.
bAlwaysRequestToService	true to force create request to query the eligibilities from agreement service.

Member Data Documentation

AccelByteSubsystem

FOnlineSubsystemAccelByteWPtr FOnlineAgreementAccelByte::AccelByteSubsystem = nullptr

protected

Instance of the subsystem that created this interface