mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-10 00:23:30 +01:00
Added invite docs
This commit is contained in:
@@ -10,6 +10,8 @@ The Channel class is the base class for all types of channel.
|
||||
Attributes
|
||||
----------
|
||||
|
||||
--------
|
||||
|
||||
id
|
||||
~~
|
||||
|
||||
|
||||
@@ -10,6 +10,8 @@ This page contains documentation on the `Discord.Client` class. This should be u
|
||||
Attributes
|
||||
----------
|
||||
|
||||
--------
|
||||
|
||||
users
|
||||
~~~~~
|
||||
|
||||
|
||||
66
docs/docs_invite.rst
Normal file
66
docs/docs_invite.rst
Normal file
@@ -0,0 +1,66 @@
|
||||
.. include:: ./vars.rst
|
||||
|
||||
Invite
|
||||
======
|
||||
|
||||
Used to represent data of an invite.
|
||||
|
||||
Attributes
|
||||
----------
|
||||
|
||||
--------
|
||||
|
||||
maxAge
|
||||
~~~~~~
|
||||
|
||||
`Number`, how long (in seconds) the invite has since creation before expiring.
|
||||
|
||||
code
|
||||
~~~~
|
||||
|
||||
`String`, the invite code.
|
||||
|
||||
server
|
||||
~~~~~~
|
||||
|
||||
The Server_ the invite is for.
|
||||
|
||||
channel
|
||||
~~~~~~~
|
||||
|
||||
The ServerChannel_ the invite is for.
|
||||
|
||||
revoked
|
||||
~~~~~~~
|
||||
|
||||
`Boolean`, whether the invite has been revoked or not.
|
||||
|
||||
createdAt
|
||||
~~~~~~~~~
|
||||
|
||||
`Number`, timestamp of when the invite was created.
|
||||
|
||||
temporary
|
||||
~~~~~~~~~
|
||||
|
||||
`Boolean`, whether the invite is temporary or not.
|
||||
|
||||
uses
|
||||
~~~~
|
||||
|
||||
`Number`, uses of the invite remaining.
|
||||
|
||||
maxUses
|
||||
~~~~~~~
|
||||
|
||||
`Number`, maximum uses of the invite.
|
||||
|
||||
inviter
|
||||
~~~~~~~
|
||||
|
||||
User_ who sent/created the invite.
|
||||
|
||||
xkcd
|
||||
~~~~
|
||||
|
||||
`Boolean`, whether the invite is intended to be easy to read and remember by a human.
|
||||
@@ -10,6 +10,8 @@ A Message object is used to represent the data of a message.
|
||||
Attributes
|
||||
----------
|
||||
|
||||
-------
|
||||
|
||||
channel
|
||||
~~~~~~~
|
||||
|
||||
|
||||
@@ -12,6 +12,8 @@ A PMChannel is a Private/Direct channel between the Client and another user.
|
||||
Attributes
|
||||
----------
|
||||
|
||||
--------
|
||||
|
||||
messages
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
@@ -10,6 +10,8 @@ Stores information about a Discord Server.
|
||||
Attributes
|
||||
----------
|
||||
|
||||
--------
|
||||
|
||||
client
|
||||
~~~~~~
|
||||
|
||||
|
||||
@@ -10,6 +10,8 @@ A ServerChannel is a Channel_ that belongs to a Server_.
|
||||
Attributes
|
||||
----------
|
||||
|
||||
--------
|
||||
|
||||
name
|
||||
~~~~
|
||||
|
||||
|
||||
@@ -12,6 +12,8 @@ A text channel of a server.
|
||||
Attributes
|
||||
----------
|
||||
|
||||
--------
|
||||
|
||||
topic
|
||||
~~~~~
|
||||
|
||||
|
||||
@@ -10,6 +10,8 @@ Stores information about users.
|
||||
Attributes
|
||||
----------
|
||||
|
||||
--------
|
||||
|
||||
client
|
||||
~~~~~~
|
||||
|
||||
|
||||
Reference in New Issue
Block a user