pyrogram/docs/source/glossary.rst

80 lines
3.7 KiB
ReStructuredText
Raw Normal View History

2019-05-16 19:28:34 +00:00
Pyrogram Glossary
2019-05-18 01:21:02 +00:00
=================
2019-05-16 19:28:34 +00:00
This page contains a list of common words with brief explanations related to Pyrogram and, to some extent, Telegram in
2019-05-17 23:45:01 +00:00
general. Some words may as well link to dedicated articles in case the topic is covered in a more detailed fashion.
.. tip::
If you think something interesting could be added here, feel free to propose it by opening a `Feature Request`_.
2019-05-16 19:28:34 +00:00
2019-06-04 14:10:32 +00:00
Terms
-----
2019-05-16 19:28:34 +00:00
.. glossary::
2019-06-04 14:10:32 +00:00
:sorted:
2019-05-16 19:28:34 +00:00
API
Application Programming Interface: a set of methods, protocols and tools that make it easier to develop programs
by providing useful building blocks to the developer.
API key
A secret code used to authenticate and/or authorize a specific application to Telegram in order for it to
control how the API is being used, for example, to prevent abuses of the API.
2019-05-28 14:41:55 +00:00
:doc:`More on API keys <intro/setup>`.
2019-05-16 19:28:34 +00:00
2019-05-17 23:45:01 +00:00
DC
Also known as *data center*, is a place where lots of computer systems are housed and used together in order to
achieve high quality and availability for services.
RPC
Acronym for Remote Procedure call, that is, a function which gets executed at some remote place (i.e. Telegram
2019-05-23 16:59:29 +00:00
server) and not in your local machine.
2019-05-17 23:45:01 +00:00
RPCError
An error caused by an RPC which must be returned in place of the successful result in order to let the caller
2019-05-28 14:41:55 +00:00
know something went wrong. :doc:`More on RPCError <start/errors>`.
2019-05-17 23:45:01 +00:00
2019-05-16 19:28:34 +00:00
MTProto
2019-05-18 01:21:02 +00:00
The name of the custom-made, open and encrypted protocol by Telegram, implemented in Pyrogram.
2019-05-28 14:41:55 +00:00
:doc:`More on MTProto <topics/mtproto-vs-botapi>`.
2019-05-16 19:28:34 +00:00
MTProto API
The Telegram main API Pyrogram makes use of, which is able to connect both users and normal bots to Telegram
2019-05-18 01:21:02 +00:00
using MTProto as application layer protocol and execute any method Telegram provides from its public TL-schema.
2019-05-28 14:41:55 +00:00
:doc:`More on MTProto API <topics/mtproto-vs-botapi>`.
2019-05-16 19:28:34 +00:00
Bot API
2019-05-23 16:59:29 +00:00
The Telegram Bot API that is able to only connect normal bots only to Telegram using HTTP as application layer
protocol and allows to execute a sub-set of the main Telegram API.
2019-05-28 14:41:55 +00:00
:doc:`More on Bot API <topics/mtproto-vs-botapi>`.
2019-05-16 19:28:34 +00:00
Pyrogrammer
A developer that uses Pyrogram to build Telegram applications.
Userbot
Also known as *user bot* or *ubot* for short, is a user logged in by third-party Telegram libraries --- such as
Pyrogram --- to automate some behaviours, like sending messages or reacting to text commands or any other event.
Session
2019-06-19 14:11:53 +00:00
Also known as *login session*, is a strictly personal piece of data created and held by both parties
2019-05-16 19:28:34 +00:00
(client and server) which is used to grant permission into a single account without having to start a new
authorization process from scratch.
Callback
Also known as *callback function*, is a user-defined generic function that *can be* registered to and then
called-back by the framework when specific events occurs.
Handler
An object that wraps around a callback function that is *actually meant* to be registered into the framework,
which will then be able to handle a specific kind of events, such as a new incoming message, for example.
2019-05-28 14:41:55 +00:00
:doc:`More on Handlers <start/updates>`.
2019-05-16 19:28:34 +00:00
Decorator
Also known as *function decorator*, in Python, is a callable object that is used to modify another function.
2019-05-18 01:21:02 +00:00
Decorators in Pyrogram are used to automatically register callback functions for handling updates.
2019-05-28 14:41:55 +00:00
:doc:`More on Decorators <start/updates>`.
2019-05-17 23:45:01 +00:00
.. _Feature Request: https://github.com/pyrogram/pyrogram/issues/new?labels=enhancement&template=feature_request.md