summaryrefslogtreecommitdiff
path: root/include/tgbot/types/InputSticker.h
blob: e636ba6ae9f837d962ea7b5d69c0bf9438f20241 (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
#ifndef TGBOT_INPUTSTICKER_H
#define TGBOT_INPUTSTICKER_H

#include "tgbot/types/MaskPosition.h"

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

namespace TgBot {

/**
 * @brief This object describes a sticker to be added to a sticker set.
 *
 * @ingroup types
 */
class InputSticker {

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

    /**
     * @brief The added sticker.
     *
     * Pass a fileId as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, upload a new one using multipart/form-data, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name.
     * Animated and video stickers can't be uploaded via HTTP URL.
     * [More information on Sending Files »](https://core.telegram.org/bots/api#sending-files)
     */
    std::string sticker;

    /**
     * @brief Format of the added sticker, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, “video” for a WEBM video
     */
    std::string format;

    /**
     * @brief List of 1-20 emoji associated with the sticker
     */
    std::vector<std::string> emojiList;

    /**
     * @brief Optional. Position where the mask should be placed on faces.
     *
     * For “mask” stickers only.
     */
    MaskPosition::Ptr maskPosition;

    /**
     * @brief Optional. List of 0-20 search keywords for the sticker with total length of up to 64 characters.
     *
     * For “regular” and “custom_emoji” stickers only.
     */
    std::vector<std::string> keywords;
};
}

#endif //TGBOT_INPUTSTICKER_H