ODClientActivityManager class
We are still working the API Reference! This page might be incomplete or doesn't contain all details!
Overview
This is an Open Ticket client activity manager.
It's responsible for managing the client status. Here, you can set the activity & status of the bot.
It also has a built-in refresh function, so the status will refresh every 10 minutes to keep it visible.
Properties
initiated boolean ➜ boolean
Is the status already initiated?
optional interval type ➜ @types/node.Timeout
The timer responsible for refreshing the status. Stop it using clearInterval(interval)
manager class ➜ api.ODClientManager
Copy of discord.js client
refreshInterval number ➜ number
status refresh interval in seconds (5 minutes by default)
status type ➜ api.ODClientActivityStatus
The current status status
text string ➜ string
The current status text
type type ➜ api.ODClientActivityType
The current status type
Methods
constructor() function ➜ api.ODClientActivityManager
(no description)
View Parameters (2)
debug: class ➜api.ODDebugger- Parameter Description Lorem Ipsum.manager: class ➜api.ODClientManager- Parameter Description Lorem Ipsum.
getStatusType() function ➜ ""|"listening "|"playing "|"watching "
Get the status type (for displaying the status)
initStatus() function ➜ boolean
When initiating the status, the bot starts updating the status using discord.js. Returns true when successfull.
setStatus() function ➜ void
Update the status. When already initiated, it can take up to 10min to see the updated status in discord.
View Parameters (4)
type: type ➜api.ODClientActivityType- Parameter Description Lorem Ipsum.text: string ➜string- Parameter Description Lorem Ipsum.status: type ➜api.ODClientActivityStatus- Parameter Description Lorem Ipsum.forceUpdate: boolean ➜boolean- Parameter Description Lorem Ipsum.
Defaults
We're still working on this part of the documentation!
Examples
We're still working on this part of the documentation!