Documentation for the User object

Author: ALCC01

docs/index.rst

@@ -73,4 +73,6 @@ Nodeogram is released under the GNU General Public License 3.0.
     :caption: Objects
     :glob:
 
-    objects/Bot
+    objects/Bot
+    objects/Chat
+    objects/User

docs/objects/Chat.rst

@@ -5,7 +5,7 @@ This object represents a Telegram chat.
 
 .. note::
 
-    This object inherits some properties from the corresponding `Telegram object<https://core.telegram.org/bots/api#chat>`_
+    This object inherits some properties from the corresponding `Telegram object <https://core.telegram.org/bots/api#chat>`_
 
 =================
 Chat(object, bot)

docs/objects/User.rst

@@ -0,0 +1,106 @@
+User
+====
+
+This object represents a Telegram user.
+
+.. note::
+
+    This object inherits some properties from the corresponding `Telegram object <https://core.telegram.org/bots/api#user>`_
+
+=================
+User(object, bot)
+=================
+
+.. warning::
+
+    This constructor should be for internal use only.
+
+Creates a new User object.
+
+==========================
+sendMessage(text, options)
+==========================
+
+* ``text`` <String>
+* ``options`` <Object> *Optional*
+
+Sends a message to the user and returns a promise that resolves to a :doc:`Message` object representing what has been sent.
+
+==========================================
+sendLocation(longitude, latitude, options)
+==========================================
+
+* ``longitude`` <Number>
+* ``latitude`` <Number>
+* ``options`` <Object> *Optional*
+
+Sends a location object to the user and returns a promise that resolves to a :doc:`Message` object representing what has
+been sent.
+
+=======================================================
+sendVenue(longitude, latitude, title, address, options)
+=======================================================
+
+* ``longitude`` <Number>
+* ``latitude`` <Number>
+* ``title`` <String>
+* ``address`` <String>
+* ``options`` <Object> *Optional*
+
+Sends a venue object to the user and returns a promise that resolves to a :doc:`Message` object representing what has
+been sent.
+
+==============================================
+sendContact(phone_number, first_name, options)
+==============================================
+
+* ``phone_number`` <String>
+* ``first_name`` <String>
+* ``options`` <Object> *Optional*
+
+Sends a contact object to the user and returns a promise that resolves to a :doc:`Message` object representing what has
+been sent.
+
+=================================================
+forwardMessage(from_chat_id, message_id, options)
+=================================================
+
+* ``from_chat_id`` <String>
+* ``message_id`` <String>
+* ``options`` <Object> *Optional*
+
+Forwards a message to the user and returns a promise that resolves to a :doc:`Message` object representing what has
+been sent.
+
+=============================
+sendFile(type, path, options)
+=============================
+
+* ``type`` <String> Must be one of the following: ``photo``, ``audio``, ``sticker``, ``document``, ``video``, ``voice``
+* ``path`` <String> File's path for local files or file's id for uploaded files
+* ``options`` <Object> *Optional*
+
+Sends the specified file to the user and returns a promise that resolves to a :doc:`Message` object representing
+what has been sent.
+
+==================
+sendAction(action)
+==================
+
+* ``action`` <String> Must be one of the following: ``typing``, ``upload_photo``, ``record_video``, ``upload_video``, ``record_audio``, ``upload_audio``, ``upload_document``, ``find_location``
+
+Returns a promise that resolves to the response (true on success).
+
+=========================
+getProfilePhotos(options)
+=========================
+
+* ``options`` <Object> *Optional*
+
+Returns a promise that resolves to a :doc:`UserProfilePhotos` object.
+
+====
+name
+====
+
+<String> The full name of the user (first name + last name).