aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRapptz <[email protected]>2016-07-13 20:11:18 -0400
committerRapptz <[email protected]>2016-07-13 20:11:18 -0400
commita128249b6324dd045561cb0be85cdabf8acd7694 (patch)
treebcca950498a3aed2d8bd67fa31b115f8a70833ad /docs
parentHandle CHANNEL_UPDATE for group direct messages. (diff)
downloaddiscord.py-a128249b6324dd045561cb0be85cdabf8acd7694.tar.xz
discord.py-a128249b6324dd045561cb0be85cdabf8acd7694.zip
Add support for different message types and call message.
Diffstat (limited to 'docs')
-rw-r--r--docs/api.rst33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/api.rst b/docs/api.rst
index 32014d6b..fb7da5cd 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -398,6 +398,33 @@ All enumerations are subclasses of `enum`_.
A private group text channel.
+.. class:: MessageType
+
+ Specifies the type of :class:`Message`. This is used to denote if a message
+ is to be interpreted as a system message or a regular message.
+
+ .. attribute:: default
+
+ The default message type. This is the same as regular messages.
+ .. attribute:: recipient_add
+
+ The system message when a recipient is added to a group private
+ message, i.e. a private channel of type :attr:`ChannelType.group`.
+ .. attribute:: recipient_remove
+
+ The system message when a recipient is removed from a group private
+ message, i.e. a private channel of type :attr:`ChannelType.group`.
+ .. attribute:: call
+
+ The system message denoting call state, e.g. missed call, started call,
+ etc.
+ .. attribute:: channel_name_change
+
+ The system message denoting that a channel's name has been changed.
+ .. attribute:: channel_icon_change
+
+ The system message denoting that a channel's icon has been changed.
+
.. class:: ServerRegion
Specifies the region a :class:`Server`'s voice server belongs to.
@@ -488,6 +515,12 @@ Message
.. autoclass:: Message
:members:
+CallMessage
+~~~~~~~~~~~~
+
+.. autoclass:: CallMessage
+ :members:
+
Server
~~~~~~