.. currentmodule:: roblox

API Reference
=============

.. toctree::
    :maxdepth: 3
    :caption: Contents:

Client Session
--------------

.. autoclass:: RobloxSession
    :members:

Roblox Objects
--------------
**Don't create any instances of these directly. Instead, get them from the RobloxSession object.**

* :meth:`RobloxSession.get_user`
* :meth:`RobloxSession.get_asset`
* :meth:`RobloxSession.get_group`

User
^^^^

.. autoclass:: User
    :members:

Asset
^^^^^

.. autoclass:: Asset
    :members:

Group
^^^^^

.. autoclass:: Group
    :members:

Data Classes
------------
**Don't create any instances of these directly. Instead, get them from the RobloxSession or their respective objects**

.. autoclass:: SalesChart
    :members:

.. autoclass:: PrivateMessage
    :members:

.. autoclass:: UserPresence
    :members:

.. autoclass:: UserRelationship
    :members:

.. autoclass:: Friendship
    :members:

.. autoclass:: FriendRequest
    :members:

.. autoclass:: GroupRoleSet
    :members:

.. autoclass:: GroupShout
    :members:
    :inherited-members:

.. autoclass:: Comment
    :members:

Enums
^^^^^

.. autoclass:: BuildersClubStatus
    :members:

.. autoclass:: UserPresenceType
    :members:

.. autoclass:: MessageInbox
    :members:

.. autoclass:: AssetType
    :members:

.. autoclass:: Gender
    :members:

.. autoclass:: ConversationType
    :members:

Site Chat
---------

roblox.py supports in depth interaction with the Roblox site chat.

.. currentmodule:: roblox.chat

.. autoclass:: RobloxChatManager
    :members:

.. autoclass:: Conversation
    :members:

.. autoclass:: MultiUserConversation
    :members:

.. autoclass:: Message
    :members:

Utils
-----

.. currentmodule:: roblox.utils

.. autofunction:: get

.. autofunction:: robux_parse