summaryrefslogtreecommitdiff
path: root/include/tgbot/types/WebhookInfo.h
blob: a375bc2eb96a87fc94ffa2a16537977bd0f7d52f (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
55
56
57
58
59
60
61
62
63
64
65
66
67
#ifndef TGBOT_WEBHOOKINFO_H
#define TGBOT_WEBHOOKINFO_H

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

namespace TgBot {

/**
 * @brief Contains information about the current status of a webhook.
 *
 * @ingroup types
 */
class WebhookInfo {
public:
    typedef std::shared_ptr<WebhookInfo> Ptr;

    /**
     * @brief Webhook URL, may be empty if webhook is not set up
     */
    std::string url;

    /**
     * @brief True, if a custom certificate was provided for webhook certificate checks
     */
    bool hasCustomCertificate;

    /**
     * @brief Number of updates awaiting delivery
     */
    std::int32_t pendingUpdateCount;

    /**
     * @brief Optional. Currently used webhook IP address
     */
    std::string ipAddress;

    /**
     * @brief Optional. Unix time for the most recent error that happened when trying to deliver an update via webhook
     */
    std::int32_t lastErrorDate;

    /**
     * @brief Optional. Error message in human-readable format for the most recent error that happened when trying to deliver an update via webhook
     */
    std::string lastErrorMessage;

    /**
     * @brief Optional. Unix time of the most recent error that happened when trying to synchronize available updates with Telegram datacenters
     */
    std::int32_t lastSynchronizationErrorDate;

    /**
     * @brief Optional. Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery
     */
    std::int32_t maxConnections;

    /**
     * @brief Optional. A list of update types the bot is subscribed to. Defaults to all update types except chatMember
     */
    std::vector<std::string> allowedUpdates;
};
}

#endif //TGBOT_WEBHOOKINFO_H