Documentation / zerotal / client / PresenceChannel

Class: PresenceChannel

Defined in: packages/client/src/Socket.ts:178

A presence channel — tracks who's currently subscribed.

Extends

Channel

Constructors

Constructor

new PresenceChannel(name, _socket): PresenceChannel

Defined in: packages/client/src/Socket.ts:112

Parameters

name

string

The wire channel name (already prefixed, e.g. private-orders.42).

_socket

Socket

Returns

PresenceChannel

Inherited from

Channel.constructor

Properties

name

readonly name: string

Defined in: packages/client/src/Socket.ts:114

The wire channel name (already prefixed, e.g. private-orders.42).

Inherited from

Channel.name

_socket

protected readonly _socket: Socket

Defined in: packages/client/src/Socket.ts:115

Inherited from

Channel._socket

Methods

listen()

listen(event, cb): this

Defined in: packages/client/src/Socket.ts:119

Bind a callback to a broadcast event on this channel. Chainable.

Parameters

event

string

cb

Listener

Returns

this

Inherited from

Channel.listen

stopListening()

stopListening(event, cb?): this

Defined in: packages/client/src/Socket.ts:127

Remove a specific listener, or all listeners for an event when cb is omitted. Chainable.

Parameters

event

string

cb?

Listener

Returns

this

Inherited from

Channel.stopListening

error()

error(cb): this

Defined in: packages/client/src/Socket.ts:134

Called when the server rejects the subscription (e.g. unauthorized). Chainable.

Parameters

cb

Listener

Returns

this

Inherited from

Channel.error

subscribed()

subscribed(cb): this

Defined in: packages/client/src/Socket.ts:140

Called once the subscription is confirmed. Chainable.

Parameters

cb

Listener

Returns

this

Inherited from

Channel.subscribed

unsubscribe()

unsubscribe(): void

Defined in: packages/client/src/Socket.ts:146

Leave (unsubscribe from) this channel.

Returns

void

Inherited from

Channel.unsubscribe

_emit()

protected _emit(cbs, payload): void

Defined in: packages/client/src/Socket.ts:166

Parameters

cbs

Set<Listener>

payload

unknown

Returns

void

Inherited from

Channel._emit

here()

here(cb): this

Defined in: packages/client/src/Socket.ts:184

Called once with the full member list when you join. Chainable.

Parameters

cb

(members) => void

Returns

this

joining()

joining(cb): this

Defined in: packages/client/src/Socket.ts:190

Called when another member joins. Chainable.

Parameters

cb

(member) => void

Returns

this

leaving()

leaving(cb): this

Defined in: packages/client/src/Socket.ts:196

Called when a member leaves. Chainable.

Parameters

cb

(member) => void

Returns

this