mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-09 16:13:31 +01:00
Last of most of the documentation!
This commit is contained in:
64
docs/docs_invite.rst
Normal file
64
docs/docs_invite.rst
Normal file
@@ -0,0 +1,64 @@
|
||||
.. include:: ./vars.rst
|
||||
|
||||
Invite Documentation
|
||||
====================
|
||||
|
||||
The Invite Class is used to represent data about an Invite.
|
||||
|
||||
Attributes
|
||||
----------
|
||||
|
||||
max_age
|
||||
~~~~~~~
|
||||
|
||||
A `Number` in minutes for how long the Invite should be valid for. E.g. a value of ``3600`` is equal to 30 minutes.
|
||||
|
||||
code
|
||||
~~~~
|
||||
|
||||
`String` an alphanumeric code for the Invite.
|
||||
|
||||
revoked
|
||||
~~~~~~~
|
||||
|
||||
`Boolean` that dictates whether the Invite has been cancelled or not
|
||||
|
||||
created_at
|
||||
~~~~~~~~~~
|
||||
|
||||
A unix timestamp as a `Number` which is the time that the invite was created.
|
||||
|
||||
temporary
|
||||
~~~~~~~~~
|
||||
|
||||
`Boolean` that dictates whether the invite is temporary.
|
||||
|
||||
uses
|
||||
~~~~
|
||||
|
||||
`Number` the number of uses of the Invite, a value of ``0`` is none.
|
||||
|
||||
max_uses
|
||||
~~~~~~~~
|
||||
|
||||
`Number` that is the maximum amount of uses of the invite, ``0`` is unlimited.
|
||||
|
||||
inviter
|
||||
~~~~~~~
|
||||
|
||||
The User_ that created the invite.
|
||||
|
||||
xkcd
|
||||
~~~~
|
||||
|
||||
`Boolean` that is true if the invite should be human-readable.
|
||||
|
||||
channel
|
||||
~~~~~~~
|
||||
|
||||
The Channel_ that the invite is inviting to.
|
||||
|
||||
URL
|
||||
~~~
|
||||
|
||||
A `String` that generates a clickable link to the invite.
|
||||
@@ -36,6 +36,7 @@ Contents:
|
||||
docs_channel
|
||||
docs_pmchannel
|
||||
docs_message
|
||||
docs_invite
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
.. _Channel : ./docs_channel.html
|
||||
.. _Message : ./docs_message.html
|
||||
.. _PMChannel : ./docs_pmchannel.html
|
||||
.. _Invite : #invite
|
||||
.. _Invite : ./docs_invite.html
|
||||
.. _Channel Resolvable : ./docs_resolvable.html#channel-resolvable
|
||||
.. _Invite Resolvable : ./docs_resolvable.html#invite-resolvable
|
||||
.. _Promises : https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise
|
||||
Reference in New Issue
Block a user