AccelByte::Api::Reporting Class Reference

Reporting API for Reporting content. More...

#include <AccelByteReportingApi.h>

Inheritance diagram for AccelByte::Api::Reporting:

Public Member Functions
	Reporting (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient=nullptr)
	Reporting (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
FAccelByteTaskWPtr	SubmitReport (FAccelByteModelsReportingSubmitData const &ReportData, THandler< FAccelByteModelsReportingSubmitResponse > const &OnSuccess, FErrorHandler const &OnError)
	Submit Report.
FAccelByteTaskWPtr	SubmitChatReport (FAccelByteModelsReportingSubmitDataChat const &ReportData, THandler< FAccelByteModelsReportingSubmitResponse > const &OnSuccess, FErrorHandler const &OnError)
	Submit a chat report.
FAccelByteTaskWPtr	GetReasons (FString const &ReasonGroup, int32 Offset, int32 Limit, THandler< FAccelByteModelsReasonsResponse > const &OnSuccess, FErrorHandler const &OnError, FString const &Title=TEXT(""))
	Get Reason under specified reason group.
FAccelByteTaskWPtr	GetReasonGroups (int32 Offset, int32 Limit, THandler< FAccelByteModelsReasonGroupsResponse > const &OnSuccess, FErrorHandler const &OnError)
	Get Reason Groups.
Public Member Functions inherited from AccelByte::FApiBase
	FApiBase (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient)
	FApiBase (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
void	SetApiClient (TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient)

Additional Inherited Members
Protected Member Functions inherited from AccelByte::FApiBase
template<typename T>
bool	ValidateAccelByteId (FString const &Id, EAccelByteIdHypensRule HypenRule, FString const &ErrorMessage, T const &OnError)
Protected Attributes inherited from AccelByte::FApiBase
TSharedRef< Credentials const, ESPMode::ThreadSafe >	CredentialsRef
Settings const &	SettingsRef
FHttpRetrySchedulerBase &	HttpRef
FHttpClient	HttpClient
FAccelBytePlatformPtr	AccelBytePlatformPtr

Detailed Description

Reporting API for Reporting content.

Member Function Documentation

GetReasonGroups()

FAccelByteTaskWPtr AccelByte::Api::Reporting::GetReasonGroups	(	int32	Offset,
		int32	Limit,
		THandler< FAccelByteModelsReasonGroupsResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get Reason Groups.

Parameters

Offset	Pagination offset.
Limit	Pagination limit.
OnSuccess	This will be called when the operation succeeded. The response is a FAccelByteModelsReasonGroupsResponse.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetReasons()

FAccelByteTaskWPtr AccelByte::Api::Reporting::GetReasons	(	FString const &	ReasonGroup,
		int32	Offset,
		int32	Limit,
		THandler< FAccelByteModelsReasonsResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		FString const &	Title = TEXT("") )

Get Reason under specified reason group.

Parameters

ReasonGroup	Specified reason group.
Offset	Pagination offset.
Limit	Pagination limit.
OnSuccess	This will be called when the operation succeeded. The response is a FAccelByteModelsReasonsResponse.
OnError	This will be called when the operation failed.
Title	Query reason(s) by title.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

SubmitChatReport()

FAccelByteTaskWPtr AccelByte::Api::Reporting::SubmitChatReport	(	FAccelByteModelsReportingSubmitDataChat const &	ReportData,
		THandler< FAccelByteModelsReportingSubmitResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Submit a chat report.

Parameters

ReportData	contain target report and evidence
OnSuccess	This will be called when the operation succeeded. The response is a FAccelByteModelsReportingSubmitResponse.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

SubmitReport()

FAccelByteTaskWPtr AccelByte::Api::Reporting::SubmitReport	(	FAccelByteModelsReportingSubmitData const &	ReportData,
		THandler< FAccelByteModelsReportingSubmitResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Submit Report.

Parameters

ReportData	contain target report and evidence
OnSuccess	This will be called when the operation succeeded. The response is a FAccelByteModelsReportingSubmitResponse.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.