API/Autodoc/Classes/URuStoreReviewManager.en.md

---

URuStoreReviewManager

Class for working with ratings and reviews. Provides an API for launching a UI form that allows the user to leave a rating and review about your application in “RuStore”.

#include <URuStoreReviewManager.h>

Inherits from UObject, RuStoreSDK::RuStoreListenerContainer

Public Functions

	Name
bool	GetIsInitialized() Checks whether the manager is initialized.
void	SetAllowNativeErrorHandling(bool value) Error handling in the native SDK.
bool	Init() Initializes the URuStoreReviewManager singleton.
void	Dispose() Deinitializes the singleton if no further work with the object is planned.
void	ConditionalBeginDestroy()
long	RequestReviewFlow(TFunction< void(long)> onSuccess, TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure) Prepares data for launching the rating and review form. The method must be called before each LaunchReviewFlow call. The prepared data remains valid for about five minutes.
long	LaunchReviewFlow(TFunction< void(long)> onSuccess, TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure) Launches the form to request a rating and review from the user. Each call to the method must be preceded by a call to RequestReviewFlow.
void	RequestReviewFlow(int64 & requestId)
void	LaunchReviewFlow(int64 & requestId)
URuStoreReviewManager *	Instance() Gets an instance of URuStoreReviewManager.

Public Attributes

	Name
const FString	PluginVersion — Plugin version.
FRequestReviewFlowErrorDelegate	OnRequestReviewFlowError
FRequestReviewFlowResponseDelegate	OnRequestReviewFlowResponse
FLaunchReviewFlowErrorDelegate	OnLaunchReviewFlowError
FLaunchReviewFlowResponseDelegate	OnLaunchReviewFlowResponse

Additional inherited members

Public Functions inherited from RuStoreSDK::RuStoreListenerContainer

	Name
TSharedPtr< RuStoreListener, ESPMode::ThreadSafe >	ListenerBind(RuStoreListener * item)
void	ListenerUnbind(long id)
void	ListenerUnbind(RuStoreListener * item)
void	ListenerUnbind(TSharedPtr< RuStoreListener, ESPMode::ThreadSafe > item)
void	ListenerRemoveAll()

function GetIsInitialized

bool GetIsInitialized()

Checks whether the manager is initialized.

Return: Returns true if the singleton is initialized, otherwise false.

function SetAllowNativeErrorHandling

void SetAllowNativeErrorHandling(
    bool value
)

Error handling in the native SDK.

Parameters:

• value true — enables error handling, false — disables it.

function Init

bool Init()

Initializes the URuStoreReviewManager singleton.

Return: Returns true if initialization was successful, otherwise false.

function Dispose

void Dispose()

Deinitializes the singleton if no further work with the object is planned.

function ConditionalBeginDestroy

void ConditionalBeginDestroy()

function RequestReviewFlow

long RequestReviewFlow(
    TFunction< void(long)> onSuccess,
    TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure
)

Prepares data for launching the rating and review form. The method must be called before each LaunchReviewFlow call. The prepared data remains valid for about five minutes.

Parameters:

• onSuccess The action performed when the operation succeeds. Returns a requestId of type long.
• onFailure The action performed in case of an error. Returns a requestId of type long and an object of type FURuStoreError with error information.

Return: Returns a requestId that is unique within a single application launch.

function LaunchReviewFlow

long LaunchReviewFlow(
    TFunction< void(long)> onSuccess,
    TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure
)

Launches the form to request a rating and review from the user. Each call to the method must be preceded by a call to RequestReviewFlow.

Parameters:

• onSuccess The action performed when the operation succeeds. Returns a requestId of type long.
• onFailure The action performed in case of an error. Returns a requestId of type long and an object of type FURuStoreError with error information.

Return: Returns a requestId that is unique within a single application launch.

function RequestReviewFlow

void RequestReviewFlow(
    int64 & requestId
)

function LaunchReviewFlow

void LaunchReviewFlow(
    int64 & requestId
)

function Instance

static URuStoreReviewManager * Instance()

Gets an instance of URuStoreReviewManager.

Return: Returns a pointer to the single instance of URuStoreReviewManager (Singleton pattern implementation). If the instance does not exist yet, it creates one.

variable PluginVersion

static const FString PluginVersion = "10.5.1";

Plugin version.

variable OnRequestReviewFlowError

FRequestReviewFlowErrorDelegate OnRequestReviewFlowError;

variable OnRequestReviewFlowResponse

FRequestReviewFlowResponseDelegate OnRequestReviewFlowResponse;

variable OnLaunchReviewFlowError

FLaunchReviewFlowErrorDelegate OnLaunchReviewFlowError;

variable OnLaunchReviewFlowResponse

FLaunchReviewFlowResponseDelegate OnLaunchReviewFlowResponse;

---