Interface SocketEventSubscriptionUpdate

interface SocketEventSubscriptionUpdate {
    enabled?: boolean;
    event?: SocketEventSubscriptionName;
    reset?: boolean;
    subscribe?: SocketEventSubscriptionName | SocketEventSubscriptionName[];
    subscriptions?: SocketEventSubscriptions;
    unsubscribe?: SocketEventSubscriptionName | SocketEventSubscriptionName[];
}

Index

Properties

enabled? event? reset? subscribe? subscriptions? unsubscribe?

Properties

`Optional`enabled

enabled?: boolean

Boolean value for the single-event update shorthand.

`Optional`event

event?: SocketEventSubscriptionName

Single-event update shorthand.

`Optional`reset

reset?: boolean

Clear existing server-side subscription overrides before applying this update.

`Optional`subscribe

subscribe?: SocketEventSubscriptionName | SocketEventSubscriptionName[]

Subscribe to one or more socket events or event groups.

`Optional`subscriptions

subscriptions?: SocketEventSubscriptions

Replace or merge explicit event subscription flags.

`Optional`unsubscribe

unsubscribe?: SocketEventSubscriptionName | SocketEventSubscriptionName[]

Unsubscribe from one or more socket events or event groups.