IconViewSocket

@codebolt/client-sdk

---

Class: IconViewSocket

Defined in: CodeBolt/packages/clientsdk/src/sockets/icon-view.socket.ts:9

Icon View WebSocket - Subscribe to icon view updates. Subscribe-based: subscribe/unsubscribe to specific views, get history/detail.

Extends

• TypedEventEmitter<IconViewSocketEvents>

Constructors

Constructor

new IconViewSocket(connManager: SocketConnectionManager, socketName: string): IconViewSocket;

Defined in: CodeBolt/packages/clientsdk/src/sockets/icon-view.socket.ts:14

Parameters

Parameter	Type	Default value
connManager	SocketConnectionManager	undefined
socketName	string	'iconView'

Returns

IconViewSocket

Overrides

TypedEventEmitter.constructor

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

emit()

emit<K>(event: K, ...args: Parameters<IconViewSocketEvents[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<IconViewSocketEvents[K]>

Returns

boolean

Inherited from

TypedEventEmitter.emit

---

getDetail()

getDetail(messageId: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/icon-view.socket.ts:91

Parameters

Parameter	Type
messageId	string

Returns

void

---

getHistory()

getHistory(viewId: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/icon-view.socket.ts:87

Parameters

Parameter	Type
viewId	string

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

---

off()

off<K>(event: K, listener: IconViewSocketEvents[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	IconViewSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.off

---

on()

on<K>(event: K, listener: IconViewSocketEvents[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	IconViewSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.on

---

once()

once<K>(event: K, listener: IconViewSocketEvents[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	IconViewSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.once

---

ping()

ping(): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/icon-view.socket.ts:95

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

---

subscribe()

subscribe(viewId: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/icon-view.socket.ts:79

Parameters

Parameter	Type
viewId	string

Returns

void

---

unsubscribe()

unsubscribe(viewId: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/icon-view.socket.ts:83

Parameters

Parameter	Type
viewId	string

Returns

void