Beamable SDK
Public Member Functions | Protected Member Functions | Protected Attributes | Properties | List of all members
Beamable.Api.PlatformSubscribable< ScopedRsp, Data > Class Template Referenceabstract

This type defines the subscribability of services. More...

Inheritance diagram for Beamable.Api.PlatformSubscribable< ScopedRsp, Data >:
Inheritance graph
[legend]
Collaboration diagram for Beamable.Api.PlatformSubscribable< ScopedRsp, Data >:
Collaboration graph
[legend]

Public Member Functions

PlatformSubscription< Data > Subscribe (Action< Data > callback)
 Subscribe to the callback to receive fresh data when available. More...
 
PlatformSubscription< Data > Subscribe (string scope, Action< Data > callback)
 Subscribe to the callback to receive fresh data when available. More...
 
Data GetLatest ()
 Manually fetch the available data. More...
 
Data GetLatest (string scope)
 Manually fetch the available data. More...
 
Promise< Data > GetCurrent (string scope="")
 Manually fetch the available data. 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...
 
- Public Member Functions inherited from Beamable.Common.Api.ISupportsGet< Data >
Promise< TData > GetCurrent (string scope="")
 
- Public Member Functions inherited from Beamable.Common.Api.ISupportGetLatest< Data >
TData GetLatest (string scope="")
 

Protected Member Functions

 PlatformSubscribable (IPlatformService platform, IBeamableRequester requester, string service, BeamableGetApiResource< ScopedRsp > getter=null)
 
virtual void Reset ()
 
Promise< UnitRefresh ()
 Manually refresh the available data. More...
 
Promise< UnitRefresh (string scope)
 Manually refresh the available data. More...
 
virtual Promise< ScopedRsp > ExecuteRequest (IBeamableRequester requester, string url)
 
virtual string CreateRefreshUrl (string scope)
 
abstract void OnRefresh (ScopedRsp data)
 
void ScheduleRefresh (long seconds, string scope)
 
void Unsubscribe (string scope, PlatformSubscription< Data > subscription)
 

Protected Attributes

IPlatformService platform
 
IBeamableRequester requester
 
BeamableGetApiResource< ScopedRsp > getter
 

Properties

bool UsesHierarchyScopes [get, protected set]
 

Detailed Description

This type defines the subscribability of services.

Related Links

img beamable-logo

Member Function Documentation

◆ GetCurrent()

Promise<Data> Beamable.Api.PlatformSubscribable< ScopedRsp, Data >.GetCurrent ( string  scope = "")
inline

Manually fetch the available data.

Parameters
scope
Returns

◆ GetLatest() [1/2]

Data Beamable.Api.PlatformSubscribable< ScopedRsp, Data >.GetLatest ( )
inline

Manually fetch the available data.

Returns

◆ GetLatest() [2/2]

Data Beamable.Api.PlatformSubscribable< ScopedRsp, Data >.GetLatest ( string  scope)
inline

Manually fetch the available data.

Parameters
scope
Returns

◆ Notify() [1/2]

void Beamable.Api.PlatformSubscribable< ScopedRsp, Data >.Notify ( Data  data)
inline

Manually notify observing scopes regarding the available data.

Parameters
data

◆ Notify() [2/2]

void Beamable.Api.PlatformSubscribable< ScopedRsp, Data >.Notify ( string  scope,
Data  data 
)
inline

Manually notify observing scopes regarding the available data.

Parameters
scope
data

◆ Refresh() [1/2]

Promise<Unit> Beamable.Api.PlatformSubscribable< ScopedRsp, Data >.Refresh ( )
inlineprotected

Manually refresh the available data.

Returns

◆ Refresh() [2/2]

Promise<Unit> Beamable.Api.PlatformSubscribable< ScopedRsp, Data >.Refresh ( string  scope)
inlineprotected

Manually refresh the available data.

Parameters
scope
Returns

◆ Subscribe() [1/2]

PlatformSubscription<Data> Beamable.Api.PlatformSubscribable< ScopedRsp, Data >.Subscribe ( Action< Data >  callback)
inline

Subscribe to the callback to receive fresh data when available.

Parameters
callback
Returns

◆ Subscribe() [2/2]

PlatformSubscription<Data> Beamable.Api.PlatformSubscribable< ScopedRsp, Data >.Subscribe ( string  scope,
Action< Data >  callback 
)
inline

Subscribe to the callback to receive fresh data when available.

Parameters
scope
callback
Returns

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