Loading...
Searching...
No Matches
AccelByte::Api::StoreDisplay Class Reference

StoreDisplayAPI its to display Items in Item Shop/Store and to configure items on the View. More...

#include <AccelByteStoreDisplayApi.h>

Inheritance diagram for AccelByte::Api::StoreDisplay:

Public Member Functions

 StoreDisplay (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient=nullptr)
 StoreDisplay (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
FAccelByteTaskWPtr GetAllViews (FString const &StoreId, FString const &Language, THandler< TArray< FAccelByteModelsViewInfo > > const &OnSuccess, FErrorHandler const &OnError)
 Used to get all views.
FAccelByteTaskWPtr ListActiveSectionContents (FString const &StoreId, FString const &ViewId, FString const &Region, FString const &Language, THandler< TArray< FAccelByteModelsSectionInfo > > const &OnSuccess, FErrorHandler const &OnError, bool AutoCalcEstimatedPrice=false)
 Used to list active section contents.
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
FHttpRetrySchedulerBaseHttpRef
FHttpClient HttpClient
FAccelBytePlatformPtr AccelBytePlatformPtr

Detailed Description

StoreDisplayAPI its to display Items in Item Shop/Store and to configure items on the View.

Member Function Documentation

◆ GetAllViews()

FAccelByteTaskWPtr AccelByte::Api::StoreDisplay::GetAllViews ( FString const & StoreId,
FString const & Language,
THandler< TArray< FAccelByteModelsViewInfo > > const & OnSuccess,
FErrorHandler const & OnError )

Used to get all views.

Parameters
StoreIdIf it's leaved string empty, the value will be got from published store id on the namespace.
LanguageISO 639-1 language tag, e.g., "en, "zh".
OnSuccessThis will be called when the operation succeeded. The result is const FAccelByteModelsViewInfo.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.

◆ ListActiveSectionContents()

FAccelByteTaskWPtr AccelByte::Api::StoreDisplay::ListActiveSectionContents ( FString const & StoreId,
FString const & ViewId,
FString const & Region,
FString const & Language,
THandler< TArray< FAccelByteModelsSectionInfo > > const & OnSuccess,
FErrorHandler const & OnError,
bool AutoCalcEstimatedPrice = false )

Used to list active section contents.

Parameters
StoreIdIf it's leaved string empty, the value will be got from published store id on the namespace.
ViewIdThe ViewId.
RegionISO 3166-1 alpha-2 country tag, e.g., "US", "CN".
LanguageISO 639-1 language tag, e.g., "en, "zh".
OnSuccessThis will be called when the operation succeeded. The result is const FAccelByteModelsSectionInfo.
OnErrorThis will be called when the operation failed.
AutoCalcEstimatedPriceThis will Auto Calculate Estimated Price. Default is false, if autoCalcEstimatedPrice is true and item is flexible bundle, will auto calc price.
Returns
AccelByteTask object to track and cancel the ongoing API operation.