Beamable SDK
Public Member Functions | Protected Member Functions | List of all members
Beamable.Api.Commerce.CommerceService Class Reference

This type defines the Client main entry point for the Commerce feature. More...

Inheritance diagram for Beamable.Api.Commerce.CommerceService:
Inheritance graph
[legend]
Collaboration diagram for Beamable.Api.Commerce.CommerceService:
Collaboration graph
[legend]

Public Member Functions

 CommerceService (IDependencyProvider provider, IBeamableRequester requester)
 
Promise< UnitOnPurchase (string storeSymbol, string listingSymbol)
 This method will be removed in a future version of Beamable. Please do not use. More...
 
Promise< EmptyResponsePurchase (string storeSymbol, string listingSymbol)
 Purchase a listing from a store. After the purchase completes, the player will be granted whatever the listing stated. More...
 
void ForceRefresh (string storeSymbol)
 This will be removed in a future version of Beamable. Please do not use. More...
 
- Public Member Functions inherited from Beamable.Api.PlatformSubscribable< GetOffersResponse, PlayerStoreView >
PlatformSubscription< Data > Subscribe (Action< Data > callback)
 Subscribe to the callback to receive fresh data when available. More...
 
virtual PlatformSubscription< Data > Subscribe (string scope, Action< Data > callback)
 Subscribe to the callback to receive fresh data when available. More...
 
Promise< UnitRefresh ()
 Manually refresh the available data. More...
 
Data GetLatest ()
 
Data GetLatest (string scope)
 
async Promise< ScopedRsp > Fetch (string scope="")
 Send a request and get the latest state of the subscription. This method will not trigger existing subscriptions More...
 
Promise< Data > GetCurrent (string scope="")
 Manually fetch the available data. If the server hasn't delivered a new update, this method will not return the absolute latest data unless you pass forceRefresh as true. More...
 
void Notify (Data data)
 Manually notify observing scopes regarding the available data. More...
 
void Notify (string scope, Data data)
 Manually notify observing scopes regarding the available data. More...
 

Protected Member Functions

override void OnRefresh (GetOffersResponse data)
 
- Protected Member Functions inherited from Beamable.Api.PlatformSubscribable< GetOffersResponse, PlayerStoreView >
 PlatformSubscribable (IDependencyProvider provider, string service, BeamableGetApiResource< ScopedRsp > getter=null)
 
virtual void Reset ()
 
Promise< UnitRefresh (string scope)
 Manually refresh the available data. More...
 
virtual Promise OnRefreshScope (string scope)
 
virtual Promise< ScopedRsp > ExecuteRequest (IBeamableRequester requester, string url)
 
virtual string CreateRefreshUrl (string scope)
 
virtual void OnRefresh (ScopedRsp data)
 
virtual Promise OnRefresh (ScopedRsp data, string[] scopes)
 
void ScheduleRefresh (long seconds, string scope)
 
void Unsubscribe (string scope, PlatformSubscription< Data > subscription)
 

Additional Inherited Members

- Protected Attributes inherited from Beamable.Api.PlatformSubscribable< GetOffersResponse, PlayerStoreView >
IBeamableRequester requester
 
IConnectivityService connectivityService
 
INotificationService notificationService
 
CoroutineService coroutineService
 
IUserContext userContext
 
BeamableGetApiResource< ScopedRsp > getter
 
readonly string service
 
- Properties inherited from Beamable.Api.PlatformSubscribable< GetOffersResponse, PlayerStoreView >
bool UsesHierarchyScopes [getprotected set]
 

Detailed Description

This type defines the Client main entry point for the Commerce feature.

Related Links

img beamable-logo

Member Function Documentation

◆ ForceRefresh()

void Beamable.Api.Commerce.CommerceService.ForceRefresh ( string  storeSymbol)
inline

This will be removed in a future version of Beamable. Please do not use.

Parameters
storeSymbol

◆ OnPurchase()

Promise< Unit > Beamable.Api.Commerce.CommerceService.OnPurchase ( string  storeSymbol,
string  listingSymbol 
)
inline

This method will be removed in a future version of Beamable. Please do not use.

Parameters
storeSymbol
listingSymbol
Returns

◆ Purchase()

Promise< EmptyResponse > Beamable.Api.Commerce.CommerceService.Purchase ( string  storeSymbol,
string  listingSymbol 
)
inline

Purchase a listing from a store. After the purchase completes, the player will be granted whatever the listing stated.

Parameters
storeSymbolThe content ID of the store the listing is present in.
listingSymbolThe content ID of the listing to buy
Returns
A Promise<T> representing the network call

The documentation for this class was generated from the following file: