Interface PresenceManagerOptions

The presence manager's options.

Hierarchy

Properties

afk? customGetters? refreshInterval? status? templates? type?

Properties

Optional afk

afk?: boolean

Whether the presence should display the client is AFK.

Default Value

false

Optional customGetters

customGetters?: PresenceTemplaterGetters

An object to map a templater key to a custom getter. The getter function should return a Promise that resolves to the correct string that the templater should replace the key with.

Default Value

{}

Optional refreshInterval

refreshInterval?: null | number

The interval at which the client's presence should be updated.

Optional status

status?: PresenceStatusData

The presence status data to be used.

Default Value

online

Optional templates

templates?: string[]

The templates to be used by the presence manager refresh updated. For more information, check PresenceTemplater.

Default Value

['{num_guilds} servers!']

Optional type

type?: Playing | Streaming | Listening | Watching | Competing

The activity type to be used.

Default Value

ActivityType.Playing

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc