summaryrefslogtreecommitdiff
path: root/include/tgbot/types/SharedUser.h
blob: 680b38bab518ddae532ac7f2aad6ba4292958bd1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
#ifndef TGBOT_SHAREDUSER_H
#define TGBOT_SHAREDUSER_H

#include "tgbot/types/PhotoSize.h"

#include <cstdint>
#include <memory>
#include <string>
#include <vector>

namespace TgBot {

/**
 * @brief This object contains information about a user that was shared with the bot using a KeyboardButtonRequestUser button.
 *
 * @ingroup types
 */
class SharedUser {

public:
    typedef std::shared_ptr<SharedUser> Ptr;

    /**
     * @brief Identifier of the shared user.
     *
     * This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it.
     * But it has at most 52 significant bits, so 64-bit integers or double-precision float types are safe for storing these identifiers.
     * The bot may not have access to the user and could be unable to use this identifier, unless the user is already known to the bot by some other means.
     */
    std::int64_t userId;

    /**
     * @brief Optional. First name of the user, if the name was requested by the bot
     */
    std::string firstName;

    /**
     * @brief Optional. Last name of the user, if the name was requested by the bot
     */
    std::string lastName;

    /**
     * @brief Optional. Username of the user, if the username was requested by the bot
     */
    std::string username;

    /**
     * @brief Optional. Available sizes of the chat photo, if the photo was requested by the bot
     */
    std::vector<PhotoSize::Ptr> photo;
};
}

#endif //TGBOT_SHAREDUSER_H