Class WSManager

Websocket manager, used to receive ws events.

Hierarchy

WSManager

Index

Constructors

Constructors

constructor

new WSManager(params: WSManagerParams): WSManager
Parameters
- params: WSManagerParams
Returns WSManager
- Defined in lib/WSManager.ts:12

Properties

`Optional` alive

alive?: boolean = false

apiversion

apiversion: string | number = ...

client

client: Client = ...

currReconnectAttempt

currReconnectAttempt: number = 0

emitter

emitter: {
    _events: any;
    options: {
        ignoreWarns: boolean;
    };
    emit(name: string | number, ...args: any[]): void;
    manager(): {
        _events: any;
        options: {
            ignoreWarns: boolean;
        };
    };
    on(name: string | number, listener: any): void;
    once(name: string | number, listener: any): void;
    removeAllListeners(name: string | number): void;
    removeListener(name: string | number, listenerToRemove: any): void;
    removeONCElisteners(name: string | number): void;
    removeONlisteners(name: string | number): void;
    resetListeners(): boolean;
    resetONCElisteners(): boolean;
    resetONlisteners(): boolean;
} = ...

Type declaration

_events: any
options: {
ignoreWarns: boolean;
}
- ignoreWarns: boolean
emit:function
- emit(name: string | number, ...args: any[]): void
- Parameters
  - name: string | number
  - Rest ...args: any[]
  Returns void
  - Defined in node_modules/emitterbuilder/dist/main.d.ts:18
manager:function
- manager(): {
      _events: any;
      options: {
          ignoreWarns: boolean;
      };
  }
- Returns {
      _events: any;
      options: {
          ignoreWarns: boolean;
      };
  }
  - _events: any
  - options: {
    ignoreWarns: boolean;
    }
    - ignoreWarns: boolean
  - Defined in node_modules/emitterbuilder/dist/main.d.ts:19
on:function
- on(name: string | number, listener: any): void
- Parameters
  - name: string | number
  - listener: any
  Returns void
  - Defined in node_modules/emitterbuilder/dist/main.d.ts:9
once:function
- once(name: string | number, listener: any): void
- Parameters
  - name: string | number
  - listener: any
  Returns void
  - Defined in node_modules/emitterbuilder/dist/main.d.ts:10
removeAllListeners:function
- removeAllListeners(name: string | number): void
- Parameters
  - name: string | number
  Returns void
  - Defined in node_modules/emitterbuilder/dist/main.d.ts:12
removeListener:function
- removeListener(name: string | number, listenerToRemove: any): void
- Parameters
  - name: string | number
  - listenerToRemove: any
  Returns void
  - Defined in node_modules/emitterbuilder/dist/main.d.ts:11
removeONCElisteners:function
- removeONCElisteners(name: string | number): void
- Parameters
  - name: string | number
  Returns void
  - Defined in node_modules/emitterbuilder/dist/main.d.ts:14
removeONlisteners:function
- removeONlisteners(name: string | number): void
- Parameters
  - name: string | number
  Returns void
  - Defined in node_modules/emitterbuilder/dist/main.d.ts:13
resetListeners:function
- resetListeners(): boolean
- Returns boolean
  - Defined in node_modules/emitterbuilder/dist/main.d.ts:15
resetONCElisteners:function
- resetONCElisteners(): boolean
- Returns boolean
  - Defined in node_modules/emitterbuilder/dist/main.d.ts:17
resetONlisteners:function
- resetONlisteners(): boolean
- Returns boolean
  - Defined in node_modules/emitterbuilder/dist/main.d.ts:16

firstwsMessage

firstwsMessage: boolean = true

lastMessageID

lastMessageID: null | string = null

lastPingTime

lastPingTime: number = NaN

`Readonly` params

params: WSManagerParams

ping

ping: number = NaN

proxyURL

proxyURL: string = ...

`Optional` reconnect

reconnect?: boolean = ...

reconnectAttemptLimit

reconnectAttemptLimit: number = ...

`Optional` replayMissedEvents

replayMissedEvents?: boolean = ...

token

token: string = ...

ws

ws: WebSocket = ...

Accessors

identifiers

get identifiers(): {
    BotServerMembershipCreated: string;
    CalendarEventCreated: string;
    CalendarEventDeleted: string;
    CalendarEventRsvpDeleted: string;
    CalendarEventRsvpUpdated: string;
    CalendarEventUpdated: string;
    ChannelMessageReactionCreated: string;
    ChannelMessageReactionDeleted: string;
    ChatMessageCreated: string;
    ChatMessageDeleted: string;
    ChatMessageUpdated: string;
    DocCreated: string;
    DocDeleted: string;
    DocUpdated: string;
    ForumTopicCommentCreated: string;
    ForumTopicCommentDeleted: string;
    ForumTopicCommentUpdated: string;
    ForumTopicCreated: string;
    ForumTopicDeleted: string;
    ForumTopicLocked: string;
    ForumTopicPinned: string;
    ForumTopicReactionCreated: string;
    ForumTopicReactionDeleted: string;
    ForumTopicUnlocked: string;
    ForumTopicUnpinned: string;
    ForumTopicUpdated: string;
    ListItemCompleted: string;
    ListItemCreated: string;
    ListItemDeleted: string;
    ListItemUncompleted: string;
    ListItemUpdated: string;
    ServerChannelCreated: string;
    ServerChannelDeleted: string;
    ServerChannelUpdated: string;
    ServerMemberBanned: string;
    ServerMemberJoined: string;
    ServerMemberRemoved: string;
    ServerMemberUnbanned: string;
    ServerMemberUpdated: string;
    ServerRolesUpdated: string;
    ServerWebhookCreated: string;
    ServerWebhookUpdated: string;
}
Returns {
    BotServerMembershipCreated: string;
    CalendarEventCreated: string;
    CalendarEventDeleted: string;
    CalendarEventRsvpDeleted: string;
    CalendarEventRsvpUpdated: string;
    CalendarEventUpdated: string;
    ChannelMessageReactionCreated: string;
    ChannelMessageReactionDeleted: string;
    ChatMessageCreated: string;
    ChatMessageDeleted: string;
    ChatMessageUpdated: string;
    DocCreated: string;
    DocDeleted: string;
    DocUpdated: string;
    ForumTopicCommentCreated: string;
    ForumTopicCommentDeleted: string;
    ForumTopicCommentUpdated: string;
    ForumTopicCreated: string;
    ForumTopicDeleted: string;
    ForumTopicLocked: string;
    ForumTopicPinned: string;
    ForumTopicReactionCreated: string;
    ForumTopicReactionDeleted: string;
    ForumTopicUnlocked: string;
    ForumTopicUnpinned: string;
    ForumTopicUpdated: string;
    ListItemCompleted: string;
    ListItemCreated: string;
    ListItemDeleted: string;
    ListItemUncompleted: string;
    ListItemUpdated: string;
    ServerChannelCreated: string;
    ServerChannelDeleted: string;
    ServerChannelUpdated: string;
    ServerMemberBanned: string;
    ServerMemberJoined: string;
    ServerMemberRemoved: string;
    ServerMemberUnbanned: string;
    ServerMemberUpdated: string;
    ServerRolesUpdated: string;
    ServerWebhookCreated: string;
    ServerWebhookUpdated: string;
}
- BotServerMembershipCreated: string
- CalendarEventCreated: string
- CalendarEventDeleted: string
- CalendarEventRsvpDeleted: string
- CalendarEventRsvpUpdated: string
- CalendarEventUpdated: string
- ChannelMessageReactionCreated: string
- ChannelMessageReactionDeleted: string
- ChatMessageCreated: string
- ChatMessageDeleted: string
- ChatMessageUpdated: string
- DocCreated: string
- DocDeleted: string
- DocUpdated: string
- ForumTopicCommentCreated: string
- ForumTopicCommentDeleted: string
- ForumTopicCommentUpdated: string
- ForumTopicCreated: string
- ForumTopicDeleted: string
- ForumTopicLocked: string
- ForumTopicPinned: string
- ForumTopicReactionCreated: string
- ForumTopicReactionDeleted: string
- ForumTopicUnlocked: string
- ForumTopicUnpinned: string
- ForumTopicUpdated: string
- ListItemCompleted: string
- ListItemCreated: string
- ListItemDeleted: string
- ListItemUncompleted: string
- ListItemUpdated: string
- ServerChannelCreated: string
- ServerChannelDeleted: string
- ServerChannelUpdated: string
- ServerMemberBanned: string
- ServerMemberJoined: string
- ServerMemberRemoved: string
- ServerMemberUnbanned: string
- ServerMemberUpdated: string
- ServerRolesUpdated: string
- ServerWebhookCreated: string
- ServerWebhookUpdated: string
- Defined in lib/WSManager.ts:36

replayEventsCondition

get replayEventsCondition(): boolean
Returns boolean
- Defined in lib/WSManager.ts:92

vAPI

get vAPI(): number
Returns number
- Defined in lib/WSManager.ts:84

Methods

_debug

_debug(message: string): boolean
Parameters
- message: string
Returns boolean
- Defined in lib/WSManager.ts:88

closeAll

closeAll(): void
Returns void
- Defined in lib/WSManager.ts:138

connect

connect(): void
Returns void
- Defined in lib/WSManager.ts:96

Class WSManager

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

params: WSManagerParams

Returns WSManager

Properties

Optional alive

apiversion

client

currReconnectAttempt

emitter

Type declaration

_events: any

options: { ignoreWarns: boolean; }

ignoreWarns: boolean

emit:function

Parameters

name: string | number

Rest ...args: any[]

Returns void

manager:function

Returns { _events: any; options: { ignoreWarns: boolean; }; }

_events: any

options: { ignoreWarns: boolean; }

ignoreWarns: boolean

on:function

Parameters

name: string | number

listener: any

Returns void

once:function

Parameters

name: string | number

listener: any

Returns void

removeAllListeners:function

Parameters

name: string | number

Returns void

removeListener:function

Parameters

name: string | number

listenerToRemove: any

Returns void

removeONCElisteners:function

Parameters

name: string | number

Returns void

removeONlisteners:function

Parameters

name: string | number

Returns void

resetListeners:function

Returns boolean

resetONCElisteners:function

Returns boolean

resetONlisteners:function

Returns boolean

firstwsMessage

lastMessageID

lastPingTime

Readonly params

ping

proxyURL

Optional reconnect

reconnectAttemptLimit

Optional replayMissedEvents

token

ws

Accessors

identifiers

BotServerMembershipCreated: string

CalendarEventCreated: string

`Optional` alive

options: {
ignoreWarns: boolean;
}

`Rest` ...args: any[]

Returns {
_events: any;
options: {
ignoreWarns: boolean;
};
}

options: {
ignoreWarns: boolean;
}

`Readonly` params

`Optional` reconnect

`Optional` replayMissedEvents