Public Member Functions | |
| async Promise | Refresh () |
| Forces a check of the data to make sure its up to date.If a refresh is already running, then this resulting Promise will represent the existing refresh call. This means you can't have multiple refreshes happening at once. More... | |
 Public Member Functions inherited from Beamable.Common.Player.DefaultObservable | |
| virtual int | GetBroadcastChecksum () |
| The broadcast checksum is a concept for change-detection. More... | |
Protected Member Functions | |
| abstract Promise | PerformRefresh () |
| Protected Member Functions inherited from Beamable.Common.Player.DefaultObservable | |
| void | TriggerUpdate () |
Properties | |
| bool | IsLoading [get] |
| Represents if the object is between OnLoadingStarted and OnLoadingFinished events. | |
Events | |
| Action | OnLoadingStarted |
| An event that happens when the Refresh method starts. This event will always be accompanied by a OnLoadingFinished event. More... | |
| Action | OnLoadingFinished |
| An event that happens after the Refresh method finishes. This event will always be after a OnLoadingStarted event. More... | |
| Events inherited from Beamable.Common.Player.DefaultObservable | |
| Action | OnUpdated |
| A "change" only happens when the value of the GetBroadcastChecksum changes. | |
| Events inherited from Beamable.Common.Player.IObservable | |
| Action | OnUpdated |
| An event that happens whenever the object has changed. | |
Member Function Documentation
◆ Refresh()
|
inline |
Forces a check of the data to make sure its up to date.If a refresh is already running, then this resulting Promise will represent the existing refresh call. This means you can't have multiple refreshes happening at once.
Implements Beamable.Common.Player.IRefreshable.
Event Documentation
◆ OnLoadingFinished
| Action Beamable.Common.Player.AbsRefreshableObservable.OnLoadingFinished |
An event that happens after the Refresh method finishes. This event will always be after a OnLoadingStarted event.
Between the two loading events, the DefaultObservable.OnUpdated might happen. However, if the refresh operation doesn't produce any meaningful changes as per the DefaultObservable.GetBroadcastChecksum Then the DefaultObservable.OnUpdated event won't happen.
◆ OnLoadingStarted
| Action Beamable.Common.Player.AbsRefreshableObservable.OnLoadingStarted |
An event that happens when the Refresh method starts. This event will always be accompanied by a OnLoadingFinished event.
Between the two loading events, the DefaultObservable.OnUpdated might happen. However, if the refresh operation doesn't produce any meaningful changes as per the DefaultObservable.GetBroadcastChecksum Then the DefaultObservable.OnUpdated event won't happen.
The documentation for this class was generated from the following file:
- com.beamable/Common/Runtime/Player/Observables.cs
