SystemAlertSocket
Class: SystemAlertSocket
Defined in: CodeBolt/packages/clientsdk/src/sockets/system-alert.socket.ts:10
System Alert WebSocket - Manage and receive system alert events. Mixed: send actions (get-all, create, update, remove, mark-read, clear-all) and receive broadcast events (created, updated, removed, cleared).
Extends
TypedEventEmitter<SystemAlertSocketEvents>
Constructors
Constructor
new SystemAlertSocket(connectionManager: SocketConnectionManager, socketName: string): SystemAlertSocket;
Defined in: CodeBolt/packages/clientsdk/src/sockets/system-alert.socket.ts:13
Parameters
| Parameter | Type | Default value |
|---|---|---|
connectionManager | SocketConnectionManager | undefined |
socketName | string | 'systemAlert' |
Returns
SystemAlertSocket
Overrides
Properties
| Property | Modifier | Type | Inherited from | Defined in |
|---|---|---|---|---|
listeners | protected | Map<string | symbol, Set<(...args: any[]) => void>> | TypedEventEmitter.listeners | CodeBolt/packages/clientsdk/src/core/event-emitter.ts:24 |
Methods
clearAll()
clearAll(): void;
Defined in: CodeBolt/packages/clientsdk/src/sockets/system-alert.socket.ts:104
Returns
void
create()
create(alert: unknown): void;
Defined in: CodeBolt/packages/clientsdk/src/sockets/system-alert.socket.ts:92
Parameters
| Parameter | Type |
|---|---|
alert | unknown |
Returns
void
emit()
emit<K>(event: K, ...args: Parameters<SystemAlertSocketEvents[K]>): boolean;
Defined in: CodeBolt/packages/clientsdk/src/core/event-emitter.ts:54
Type Parameters
| Type Parameter |
|---|
K extends string |
Parameters
| Parameter | Type |
|---|---|
event | K |
...args | Parameters<SystemAlertSocketEvents[K]> |
Returns
boolean
Inherited from
getAll()
getAll(): void;
Defined in: CodeBolt/packages/clientsdk/src/sockets/system-alert.socket.ts:89
Returns
void
listenerCount()
listenerCount(event: string): number;
Defined in: CodeBolt/packages/clientsdk/src/core/event-emitter.ts:75
Parameters
| Parameter | Type |
|---|---|
event | string |
Returns
number
Inherited from
TypedEventEmitter.listenerCount
markRead()
markRead(alertId: string): void;
Defined in: CodeBolt/packages/clientsdk/src/sockets/system-alert.socket.ts:101
Parameters
| Parameter | Type |
|---|---|
alertId | string |
Returns
void
off()
off<K>(event: K, listener: SystemAlertSocketEvents[K]): this;
Defined in: CodeBolt/packages/clientsdk/src/core/event-emitter.ts:35
Type Parameters
| Type Parameter |
|---|
K extends string |
Parameters
| Parameter | Type |
|---|---|
event | K |
listener | SystemAlertSocketEvents[K] |
Returns
this
Inherited from
on()
on<K>(event: K, listener: SystemAlertSocketEvents[K]): this;
Defined in: CodeBolt/packages/clientsdk/src/core/event-emitter.ts:27
Type Parameters
| Type Parameter |
|---|
K extends string |
Parameters
| Parameter | Type |
|---|---|
event | K |
listener | SystemAlertSocketEvents[K] |
Returns
this
Inherited from
once()
once<K>(event: K, listener: SystemAlertSocketEvents[K]): this;
Defined in: CodeBolt/packages/clientsdk/src/core/event-emitter.ts:46
Type Parameters
| Type Parameter |
|---|
K extends string |
Parameters
| Parameter | Type |
|---|---|
event | K |
listener | SystemAlertSocketEvents[K] |
Returns
this
Inherited from
ping()
ping(): void;
Defined in: CodeBolt/packages/clientsdk/src/sockets/system-alert.socket.ts:107
Returns
void
remove()
remove(alertId: string): void;
Defined in: CodeBolt/packages/clientsdk/src/sockets/system-alert.socket.ts:98
Parameters
| Parameter | Type |
|---|---|
alertId | string |
Returns
void
removeAllListeners()
removeAllListeners(event?: string): this;
Defined in: CodeBolt/packages/clientsdk/src/core/event-emitter.ts:66
Parameters
| Parameter | Type |
|---|---|
event? | string |
Returns
this
Inherited from
TypedEventEmitter.removeAllListeners
update()
update(alertId: string, data: unknown): void;
Defined in: CodeBolt/packages/clientsdk/src/sockets/system-alert.socket.ts:95
Parameters
| Parameter | Type |
|---|---|
alertId | string |
data | unknown |
Returns
void