mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-09 16:13:31 +01:00
ba51df918c
Added methods: pinMessage() unpinMessage() getPinnedMessages() Added params for getChannelLogs: around
101 lines
1.5 KiB
ReStructuredText
101 lines
1.5 KiB
ReStructuredText
.. include:: ./vars.rst
|
|
|
|
Message
|
|
=======
|
|
|
|
**extends** Equality_
|
|
|
|
A Message object is used to represent the data of a message.
|
|
|
|
--------
|
|
|
|
Attributes
|
|
----------
|
|
|
|
channel
|
|
~~~~~~~
|
|
|
|
The channel the message was sent in, either a TextChannel_ or PMChannel_.
|
|
|
|
server
|
|
~~~~~~~
|
|
|
|
The Server_ the message was sent in. Will be undefined if the message was sent in a PMChannel_.
|
|
|
|
client
|
|
~~~~~~
|
|
|
|
The Client_ that cached the message.
|
|
|
|
attachments
|
|
~~~~~~~~~~~
|
|
|
|
A raw array of attachment objects.
|
|
|
|
tts
|
|
~~~
|
|
|
|
`Boolean`, true if the message was text-to-speech.
|
|
|
|
embeds
|
|
~~~~~~
|
|
|
|
A raw array of embed objects.
|
|
|
|
timestamp
|
|
~~~~~~~~~
|
|
|
|
`Number`, timestamp of when the message was sent.
|
|
|
|
everyoneMentioned
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
`Boolean`, true if ``@everyone`` was mentioned.
|
|
|
|
id
|
|
~~
|
|
|
|
`String`, ID of the message.
|
|
|
|
editedTimestamp
|
|
~~~~~~~~~~~~~~~
|
|
|
|
Timestamp on when the message was last edited, `Number`. Potentially null.
|
|
|
|
author
|
|
~~~~~~
|
|
|
|
**Alias:** `sender`
|
|
|
|
The User_ that sent the message.
|
|
|
|
content
|
|
~~~~~~~
|
|
|
|
`String`, content of the message.
|
|
|
|
cleanContent
|
|
~~~~~~~
|
|
|
|
`String`, content of the message with valid user mentions (<@123>) replaced with "@username".
|
|
|
|
mentions
|
|
~~~~~~~~
|
|
|
|
A array of User_ objects that were mentioned in the message.
|
|
|
|
pinned
|
|
~~~~~~
|
|
|
|
`Boolean`, true if the message is pinned to its channel.
|
|
|
|
Functions
|
|
---------
|
|
|
|
isMentioned(user)
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
Returns true if the given user was mentioned in the message.
|
|
|
|
- **user** - A `User Resolvable`_
|