Class CXoneLeaderElector

Handles leader election mechanism for browser

Hierarchy

CXoneLeaderElector

Index

Constructors

constructor

Properties

Accessors

Methods

start

Constructors

Private constructor

new CXoneLeaderElector(): CXoneLeaderElector

- Defined in common-sdk/src/lib/message-bus/cxone-leader-elector.ts:21
Constructor to create singleton instance of CXoneLeaderElector

Returns CXoneLeaderElector

Properties

Private elector

elector: LeaderElector

Private isActiveLeader

isActiveLeader: boolean

Private leaderChannel

leaderChannel: BroadcastChannel<any>

onLeaderChanged

onLeaderChanged: Subject<boolean>

Static Private singleton

singleton: CXoneLeaderElector

Accessors

isLeader

get isLeader(): boolean

- Defined in common-sdk/src/lib/message-bus/cxone-leader-elector.ts:70
Checks if instance is leader or not
example
```
const isLeader = this.isActiveLeader;
```
Returns boolean

Static instance

get instance(): CXoneLeaderElector

- Defined in common-sdk/src/lib/message-bus/cxone-leader-elector.ts:39
Static method to control the access of the singleton instance.
example
```
const leaderElection = CXoneLeaderElector.instance;
```
Returns CXoneLeaderElector

Methods

start

start(): void

- Defined in common-sdk/src/lib/message-bus/cxone-leader-elector.ts:53
Provides leader election mechanism for within multiple browser instances
example
```
CXoneLeaderElector.instance.start();
```
Returns void

Generated using TypeDoc