Skip to main content

ShardEvents

@discordeno/bot • Docs

Documentation / @discordeno/bot / ShardEvents

Interface: ShardEvents

Properties​

connected()?​

optional connected: (shard) => unknown

The shard is connected with Discord's gateway.

Parameters​

• shard: DiscordenoShard

Returns​

unknown

Defined in​

packages/gateway/dist/types/types.d.ts:137

connecting()?​

optional connecting: (shard) => unknown

The shard started to connect to Discord's gateway.

Parameters​

• shard: DiscordenoShard

Returns​

unknown

Defined in​

packages/gateway/dist/types/types.d.ts:135

disconnected()?​

optional disconnected: (shard) => unknown

The shard has been disconnected from Discord's gateway.

Parameters​

• shard: DiscordenoShard

Returns​

unknown

Defined in​

packages/gateway/dist/types/types.d.ts:139

heartbeat()?​

optional heartbeat: (shard) => unknown

A heartbeat has been send.

Parameters​

• shard: DiscordenoShard

Returns​

unknown

Defined in​

packages/gateway/dist/types/types.d.ts:121

heartbeatAck()?​

optional heartbeatAck: (shard) => unknown

A heartbeat ACK was received.

Parameters​

• shard: DiscordenoShard

Returns​

unknown

Defined in​

packages/gateway/dist/types/types.d.ts:123

hello()?​

optional hello: (shard) => unknown

Shard has received a Hello payload.

Parameters​

• shard: DiscordenoShard

Returns​

unknown

Defined in​

packages/gateway/dist/types/types.d.ts:125

identified()?​

optional identified: (shard) => unknown

The shard has successfully been identified itself with Discord.

Parameters​

• shard: DiscordenoShard

Returns​

unknown

Defined in​

packages/gateway/dist/types/types.d.ts:143

identifying()?​

optional identifying: (shard) => unknown

The shard has started to identify itself to Discord.

Parameters​

• shard: DiscordenoShard

Returns​

unknown

Defined in​

packages/gateway/dist/types/types.d.ts:141

invalidSession()?​

optional invalidSession: (shard, resumable) => unknown

The Shards session has been invalidated.

Parameters​

• shard: DiscordenoShard

• resumable: boolean

Returns​

unknown

Defined in​

packages/gateway/dist/types/types.d.ts:127

message()?​

optional message: (shard, payload) => unknown

The shard has received a message from Discord.

Parameters​

• shard: DiscordenoShard

• payload

• payload.d: unknown

• payload.op: number

• payload.s: null | number

• payload.t: null | GatewayEventNames

Returns​

unknown

Defined in​

packages/gateway/dist/types/types.d.ts:145

requestedReconnect()?​

optional requestedReconnect: (shard) => unknown

Discord has requested the Shard to reconnect.

Parameters​

• shard: DiscordenoShard

Returns​

unknown

Defined in​

packages/gateway/dist/types/types.d.ts:133

resumed()?​

optional resumed: (shard) => unknown

The shard has successfully resumed an old session.

Parameters​

• shard: DiscordenoShard

Returns​

unknown

Defined in​

packages/gateway/dist/types/types.d.ts:131

resuming()?​

optional resuming: (shard) => unknown

The shard has started a resume action.

Parameters​

• shard: DiscordenoShard

Returns​

unknown

Defined in​

packages/gateway/dist/types/types.d.ts:129