Beamable SDK
Public Member Functions | Properties | List of all members
Beamable.Api.Notification.PubnubSubscriptionManager Class Reference
Inheritance diagram for Beamable.Api.Notification.PubnubSubscriptionManager:
Inheritance graph
[legend]
Collaboration diagram for Beamable.Api.Notification.PubnubSubscriptionManager:
Collaboration graph
[legend]

Public Member Functions

delegate void OnPubNubOperationDelegate ()
 
void Initialize (IPlatformService platform, IDependencyProvider provider)
 
void Reset ()
 
void Update ()
 
void OnDisable ()
 
async Promise SubscribeToProvider ()
 
void EnqueueOperation (PubNubOp operation, bool shouldRunNextOp=false)
 
void UnsubscribeAll ()
 
void LoadChannelHistory (string channel, int msgLimit, Action< List< object > > onHistory, Action< PubnubClientError > onHistoryError)
 
void OnMessageReceived (object result)
 
void OnSubscribeMessage (object result)
 
void OnUnsubscribeMessage (object result)
 
void OnSubscribeError (PubnubClientError pubnubError)
 
void OnUnsubscribeError (PubnubClientError pubnubError)
 
Promise OnDispose ()
 Used as a way to allow services attached to a IDependencyProvider to clean up their state when the IDependencyProviderScope.Dispose method is called More...
 

Properties

Subscription Subscription [get]
 
bool PubnubIsConnected [get]
 
long NumActiveChannels [get]
 
string FilterExpression [getset]
 

Detailed Description

Manage the connection and subscriptions to PubNub

Member Function Documentation

◆ EnqueueOperation()

void Beamable.Api.Notification.PubnubSubscriptionManager.EnqueueOperation ( PubNubOp  operation,
bool  shouldRunNextOp = false 
)
inline

◆ Initialize()

void Beamable.Api.Notification.PubnubSubscriptionManager.Initialize ( IPlatformService  platform,
IDependencyProvider  provider 
)
inline

◆ LoadChannelHistory()

void Beamable.Api.Notification.PubnubSubscriptionManager.LoadChannelHistory ( string  channel,
int  msgLimit,
Action< List< object > >  onHistory,
Action< PubnubClientError onHistoryError 
)
inline

History request for the channel. We pay by the message and history messages count towards that total. Be judicious on the amount of history retrieved

Implements Beamable.Api.Notification.IPubnubSubscriptionManager.

◆ OnDispose()

Promise Beamable.Api.Notification.PubnubSubscriptionManager.OnDispose ( )
inline

Used as a way to allow services attached to a IDependencyProvider to clean up their state when the IDependencyProviderScope.Dispose method is called

Returns
A promise that represents when the service's clean up is complete. This promise will hang the entire disposal process of the IDependencyProviderScope

Implements Beamable.Common.Dependencies.IBeamableDisposable.

◆ SubscribeToProvider()

async Promise Beamable.Api.Notification.PubnubSubscriptionManager.SubscribeToProvider ( )
inline

◆ UnsubscribeAll()

void Beamable.Api.Notification.PubnubSubscriptionManager.UnsubscribeAll ( )
inline

This method is used to unsubscribe from all channels used for notification and for chat. It is meant for use on exit

Implements Beamable.Api.Notification.IPubnubSubscriptionManager.


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