mirror of
https://github.com/stoatchat/python-client-sdk.git
synced 2026-07-21 10:05:22 -04:00
rockboy987
217 lines
3.0 KiB
ReStructuredText
Executable File
217 lines
3.0 KiB
ReStructuredText
Executable File
.. currentmodule:: revolt
|
|
|
|
API Reference
|
|
===============
|
|
|
|
|
|
Client
|
|
~~~~~~~
|
|
|
|
.. autoclass:: Client
|
|
:members:
|
|
|
|
Asset
|
|
~~~~~~
|
|
|
|
.. autoclass:: Asset
|
|
:members:
|
|
|
|
Channel
|
|
~~~~~~~~
|
|
|
|
.. autoclass:: Channel
|
|
:members:
|
|
|
|
SavedMessageChannel
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: SavedMessageChannel
|
|
:members:
|
|
|
|
DMChannel
|
|
~~~~~~~~~~
|
|
|
|
.. autoclass:: DMChannel
|
|
:members:
|
|
|
|
GroupDMChannel
|
|
~~~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: GroupDMChannel
|
|
:members:
|
|
|
|
TextChannel
|
|
~~~~~~~~~~~~
|
|
|
|
.. autoclass:: TextChannel
|
|
:members:
|
|
|
|
VoiceChannel
|
|
~~~~~~~~~~~~
|
|
|
|
.. autoclass:: VoiceChannel
|
|
:members:
|
|
|
|
|
|
Embed
|
|
~~~~~~
|
|
|
|
.. autoclass:: Embed
|
|
:members:
|
|
|
|
|
|
File
|
|
~~~~~
|
|
|
|
.. autoclass:: File
|
|
:members:
|
|
|
|
Member
|
|
~~~~~~~
|
|
|
|
.. autoclass:: Member
|
|
:members:
|
|
|
|
Message
|
|
~~~~~~~
|
|
|
|
.. autoclass:: Message
|
|
:members:
|
|
|
|
.. autoclass:: MessageReply
|
|
:members:
|
|
|
|
Messageable
|
|
~~~~~~~~~~~~
|
|
|
|
.. autoclass:: Messageable
|
|
:members:
|
|
|
|
Permissions
|
|
~~~~~~~~~~~~
|
|
|
|
.. autoclass:: ChannelPermissions
|
|
:members:
|
|
|
|
.. autoclass:: ServerPermissions
|
|
:members:
|
|
|
|
Role
|
|
~~~~~
|
|
|
|
.. autoclass:: Role
|
|
:members:
|
|
|
|
Server
|
|
~~~~~~~
|
|
|
|
.. autoclass:: Server
|
|
:members:
|
|
|
|
Category
|
|
~~~~~~~~~
|
|
|
|
.. autoclass:: Category
|
|
:members:
|
|
|
|
|
|
SystemMessages
|
|
~~~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: SystemMessages
|
|
:members:
|
|
|
|
|
|
User
|
|
~~~~~
|
|
|
|
.. autoclass:: User
|
|
:members:
|
|
|
|
Relation
|
|
~~~~~~~~~
|
|
|
|
.. autonamedtuple:: Relation
|
|
|
|
|
|
Status
|
|
~~~~~~~
|
|
|
|
.. autonamedtuple:: Status
|
|
|
|
|
|
Enums
|
|
======
|
|
|
|
The api uses enums to say what variant of something is, these represent those enums
|
|
|
|
All enums subclass `aenum.Enum`.
|
|
|
|
.. class:: ChannelType
|
|
|
|
Specifies the type of channel.
|
|
|
|
.. attribute:: saved_message
|
|
|
|
A private channel only you can access.
|
|
.. attribute:: direct_message
|
|
|
|
A private direct message channel between you and another user
|
|
.. attribute:: group
|
|
|
|
A private group channel for messages between a group of users
|
|
.. attribute:: text_channel
|
|
|
|
A text channel in a server
|
|
.. attribute:: voice_channel
|
|
|
|
A voice only channel
|
|
|
|
.. class:: PresenceType
|
|
|
|
Specifies what a users presence is
|
|
|
|
.. attribute:: busy
|
|
|
|
The user is busy and wont receive notification
|
|
.. attribute:: idle
|
|
|
|
The user is idle
|
|
.. attribute:: invisible
|
|
|
|
The user is invisible, you will never receive this, instead they will appear offline
|
|
.. attribute:: online
|
|
|
|
The user is online
|
|
|
|
.. attribute:: offline
|
|
|
|
The user is offline or invisible
|
|
|
|
.. attribute:: RelationshipType
|
|
|
|
Specifies the relationship between two users
|
|
|
|
.. attribute:: blocked
|
|
|
|
You have blocked them
|
|
.. attribute:: blocked_other
|
|
|
|
They have blocked you
|
|
.. attribute:: friend
|
|
|
|
You are friends with them
|
|
.. attribute:: incoming_friend_request
|
|
|
|
They are sending you a friend request
|
|
.. attribute:: none
|
|
|
|
You have no relationship with them
|
|
.. attribute:: outgoing_friend_request
|
|
|
|
You are sending them a friend request
|
|
|
|
.. attribute:: user
|
|
|
|
That user is yourself
|