The Live Data Manager class is the central class for managing Live Update subscriptions. More...
#include <MPLiveDataManager.h>
Instance Methods | |
| (instancetype) | - NS_UNAVAILABLE |
| (void) | - subscribe: |
| (void) | - unsubscribe: |
| (void) | - unsubscribeAll |
| Unsubscribe all Live Updates. When the last Topic Criteria is successfully unsubscribed the Live Data Manager will disconnect from the Live Update remote services. | |
| (void) | - updateLiveDataInfo |
| Update Live Data information, including list of active Domain Types for the current dataset. | |
Class Methods | |
| (instancetype) | + NS_UNAVAILABLE |
| (MPLiveDataManager *) | + sharedInstance |
| Get (or create and get) the shared instance of the Live Data Manager. | |
Properties | |
| id< MPLiveDataManagerDelegate > | delegate |
| Set or get the Live Data Manager Delegate. The delegate recieves all Live Updates, state changes, errors and other calls from the Live Data Manager. | |
| MPLiveDataManagerState | state |
| Get the state of the Live Data Manager. | |
| NSArray< MPLiveTopicCriteria * > * | subscriptions |
| Get the currently active and successful subscriptions. | |
Detailed Description
The Live Data Manager class is the central class for managing Live Update subscriptions.
Method Documentation
◆ NS_UNAVAILABLE [1/2]
| + (instancetype) NS_UNAVAILABLE |
◆ NS_UNAVAILABLE [2/2]
| - (instancetype) NS_UNAVAILABLE |
◆ sharedInstance
| + (MPLiveDataManager *) sharedInstance |
Get (or create and get) the shared instance of the Live Data Manager.
◆ subscribe:
| - (void) subscribe: | (MPLiveTopicCriteria *) | topic |
Subscribe to Live Updates with a given Topic Criteria. If no previous subscriptions have been made, the Live Data Manager will first connect to the Live Update remote services.
- Parameters
-
topic The Topic Criteria.
◆ unsubscribe:
| - (void) unsubscribe: | (MPLiveTopicCriteria *) | topic |
Unsubscribe to Live Updates with a given Topic Criteria. When the last Topic Criteria is successfully unsubscribed the Live Data Manager will disconnect from the Live Update remote services.
- Parameters
-
topic The Topic Criteria.
◆ unsubscribeAll
| - (void) unsubscribeAll |
Unsubscribe all Live Updates. When the last Topic Criteria is successfully unsubscribed the Live Data Manager will disconnect from the Live Update remote services.
◆ updateLiveDataInfo
| - (void) updateLiveDataInfo |
Update Live Data information, including list of active Domain Types for the current dataset.
Property Documentation
◆ delegate
|
readwritenonatomicweak |
Set or get the Live Data Manager Delegate. The delegate recieves all Live Updates, state changes, errors and other calls from the Live Data Manager.
◆ state
|
readnonatomicassign |
Get the state of the Live Data Manager.
◆ subscriptions
|
readnonatomicstrong |
Get the currently active and successful subscriptions.
