aboutsummaryrefslogtreecommitdiff
path: root/discord/message.py
diff options
context:
space:
mode:
authorTobotimus <[email protected]>2018-01-06 17:21:56 -0500
committerRapptz <[email protected]>2018-01-06 17:23:59 -0500
commit3112e1c17e7859adf6d13ed844f4c636b4bc30d8 (patch)
tree70d7aafca549a8c245ee4fdab774e1ab5302d531 /discord/message.py
parent[commands] Fix MissingRequiredArgument param handling (diff)
downloaddiscord.py-3112e1c17e7859adf6d13ed844f4c636b4bc30d8.tar.xz
discord.py-3112e1c17e7859adf6d13ed844f4c636b4bc30d8.zip
Add intersphinx
Diffstat (limited to 'discord/message.py')
-rw-r--r--discord/message.py32
1 files changed, 16 insertions, 16 deletions
diff --git a/discord/message.py b/discord/message.py
index 9b0b1c04..ea2d852b 100644
--- a/discord/message.py
+++ b/discord/message.py
@@ -40,20 +40,20 @@ class Attachment:
Attributes
------------
- id: int
+ id: :class:`int`
The attachment ID.
- size: int
+ size: :class:`int`
The attachment size in bytes.
- height: Optional[int]
+ height: Optional[:class:`int`]
The attachment's height, in pixels. Only applicable to images.
- width: Optional[int]
+ width: Optional[:class:`int`]
The attachment's width, in pixels. Only applicable to images.
- filename: str
+ filename: :class:`str`
The attachment's filename.
- url: str
+ url: :class:`str`
The attachment URL. If the message this attachment was attached
to is deleted, then this will 404.
- proxy_url: str
+ proxy_url: :class:`str`
The proxy URL. This is a cached version of the :attr:`~Attachment.url` in the
case of images. When the message is deleted, this URL might be valid for a few
minutes or not valid at all.
@@ -111,7 +111,7 @@ class Message:
Attributes
-----------
- tts: bool
+ tts: :class:`bool`
Specifies if the message was done with text-to-speech.
type: :class:`MessageType`
The type of message. In most cases this should not be checked, but it is helpful
@@ -119,7 +119,7 @@ class Message:
author
A :class:`Member` that sent the message. If :attr:`channel` is a
private channel, then it is a :class:`User` instead.
- content: str
+ content: :class:`str`
The actual contents of the message.
nonce
The value used by the discord guild and the client to verify that the message is successfully sent.
@@ -132,7 +132,7 @@ class Message:
call: Optional[:class:`CallMessage`]
The call that the message refers to. This is only applicable to messages of type
:attr:`MessageType.call`.
- mention_everyone: bool
+ mention_everyone: :class:`bool`
Specifies if the message mentions everyone.
.. note::
@@ -141,7 +141,7 @@ class Message:
Rather this boolean indicates if the ``@everyone`` text is in the message
**and** it did end up mentioning everyone.
- mentions: list
+ mentions: :class:`list`
A list of :class:`Member` that were mentioned. If the message is in a private message
then the list will be of :class:`User` instead. For messages that are not of type
:attr:`MessageType.default`\, this array can be used to aid in system messages.
@@ -152,20 +152,20 @@ class Message:
The order of the mentions list is not in any particular order so you should
not rely on it. This is a discord limitation, not one with the library.
- channel_mentions: list
+ channel_mentions: :class:`list`
A list of :class:`abc.GuildChannel` that were mentioned. If the message is in a private message
then the list is always empty.
- role_mentions: list
+ role_mentions: :class:`list`
A list of :class:`Role` that were mentioned. If the message is in a private message
then the list is always empty.
- id: int
+ id: :class:`int`
The message ID.
- webhook_id: Optional[int]
+ webhook_id: Optional[:class:`int`]
If this message was sent by a webhook, then this is the webhook ID's that sent this
message.
attachments: List[:class:`Attachment`]
A list of attachments given to a message.
- pinned: bool
+ pinned: :class:`bool`
Specifies if the message is currently pinned.
reactions : List[:class:`Reaction`]
Reactions to a message. Reactions can be either custom emoji or standard unicode emoji.