Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-16 11:33:30 +01:00
Code Issues Packages Projects Releases Wiki Activity

fix(docs): backport documentation for Presence#clientStatus (#3315)

Browse Source 
* backport documentation for Presence

* capitalize o

Co-Authored-By: SpaceEEC <spaceeec@yahoo.com>

* remove extra space

* backport ClientPresenceStatus

* Change to Client Presence Status
This commit is contained in:
Gryffon Bellish
2019-06-01 14:24:22 -04:00
committed by SpaceEEC
parent 5dd9181497
commit 0c6101901d
1 changed files with 12 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
src/structures/Presence.js
View File

@@ -2,7 +2,6 @@ const { ActivityFlags, Endpoints } = require('../util/Constants');
/** /**
* The status of this presence: * The status of this presence:
*
* * **`online`** - user is online * * **`online`** - user is online
* * **`idle`** - user is AFK * * **`idle`** - user is AFK
* * **`offline`** - user is offline or invisible * * **`offline`** - user is offline or invisible
@@ -10,6 +9,14 @@ const { ActivityFlags, Endpoints } = require('../util/Constants');
* @typedef {string} PresenceStatus * @typedef {string} PresenceStatus
*/ */
/**
* The status of this presence:
* * **`online`** - user is online
* * **`idle`** - user is AFK
* * **`dnd`** - user is in Do Not Disturb
* @typedef {string} ClientPresenceStatus
*/
/** /**
* Represents a user's presence. * Represents a user's presence.
*/ */
@@ -31,10 +38,10 @@ class Presence {
/** /**
* The devices this presence is on * The devices this presence is on
* @type {?object} * @type {?Object}
* @property {PresenceStatus} web * @property {?ClientPresenceStatus} web The current presence in the web application
* @property {PresenceStatus} mobile * @property {?ClientPresenceStatus} mobile The current presence in the mobile application
* @property {PresenceStatus} desktop * @property {?ClientPresenceStatus} desktop The current presence in the desktop application
*/ */
this.clientStatus = data.client_status || null; this.clientStatus = data.client_status || null;
} }