dan/discord.js
1
0
Fork 0
mirror of https://github.com/danbulant/discord.js synced 2026-06-24 17:21:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Started server docs

Browse source
This commit is contained in:
hydrabolt 2015-11-20 17:15:08 +00:00
parent 257b63c07f
commit e1ce8d48e7
1 changed files with 59 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
docs/docs_server.rst Normal file
View file

@ -0,0 +1,59 @@
.. include:: ./vars.rst
Server
======
Stores information about a Discord Server.
Attributes
----------
client
~~~~~~
The Client_ that cached the Server.
region
~~~~~~
`String`, region of the server.
name
~~~~
`String`, name of the server.
id
~~
`String`, ID of the server - never changes.
members
~~~~~~~
Members of the server, a Cache_ of User_ objects.
channels
~~~~~~~~
Channels in the server, a Cache_ of ServerChannel_ objects.
roles
~~~~~
Roles of the server, a Cache_ of Role_ objects.
icon
~~~~
ID/Hash of server icon, use ``server.iconURL`` for an URL to the icon.
afkTimeout
~~~~~~~~~~
`Number`, the AFK timeout in seconds before a user is classed as AFK.
afkChannel
~~~~~~~~~~
The channel where AFK users are moved to, ServerChannel_ object.