Class PresenceManager

constructor

• new PresenceManager(client, options?): PresenceManager

• Parameters

  • client: ExtendedClient

    The client that this presence manager will be used by.

  • options: PresenceManagerOptions = {}

    The options for this presence manager.

  Returns PresenceManager

Readonly client

options

{
  templates: ['{num_guilds} servers!'],
  status: 'online',
  type: 'PLAYING',
  afk: false
}
Copy

Readonly templater

randomlyUpdate

• randomlyUpdate(): Promise<void>

• Update the client's presence with a presence randomly chosen from the templates specified.

  Returns Promise<void>

  Promise that resolves on presence update.

  Emits

  client#presenceUpdated

  Emits

  client#presenceUpdateError

setRefreshInterval

• setRefreshInterval(refreshInterval?): void

• Set the refresh interval at which the presences should update. The presences that are used are the ones specified in the templates option.

  Parameters

  • refreshInterval: null | number = null

    The interval at which the presences should update. Must be a positive integer.

  Returns void

  Throws

  Throws if the interval is not positive.

  Emits

  client#presenceRefreshInterval

update

• update(status, data?): Promise<void>

• Update the client's presence.

  Parameters

  • status: string

    The status message to set. It can be a templated message. See PresenceTemplater.

  • data: PresenceData = {}

    Additional data to pass to the presence updater.

  Returns Promise<void>

  A promise that resolves on presence update.

  Emits

  client#presenceUpdated

  Emits

  client#presenceUpdateError