telebot-types.h

Go to the documentation of this file.

/*
 * telebot
 *
 * Copyright (c) 2015 Elmurod Talipov.
 *
 * Licensed under the Apache License, Version 2.0 (the License);
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef __TELEBOT_TYPES_H__
#define __TELEBOT_TYPES_H__

#include <stdbool.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef enum telebot_update_type {
    TELEBOT_UPDATE_TYPE_MESSAGE = 0,          
    TELEBOT_UPDATE_TYPE_EDITED_MESSAGE,       
    TELEBOT_UPDATE_TYPE_CHANNEL_POST,         
    TELEBOT_UPDATE_TYPE_EDITED_CHANNEL_POST,  
    TELEBOT_UPDATE_TYPE_INLINE_QUERY,         
    TELEBOT_UPDATE_TYPE_CHOSEN_INLINE_RESULT, 
    TELEBOT_UPDATE_TYPE_CALLBACK_QUERY,       
    TELEBOT_UPDATE_TYPE_SHIPPING_QUERY,       
    TELEBOT_UPDATE_TYPE_PRE_CHECKOUT_QUERY,   
    TELEBOT_UPDATE_TYPE_POLL,                 
    TELEBOT_UPDATE_TYPE_POLL_ANSWER,          
    TELEBOT_UPDATE_TYPE_MAX                   
} telebot_update_type_e;

typedef struct telebot_user {
    int id;

    bool is_bot;

    char *first_name;

    char *last_name;

    char *username;

    char *language_code;

    bool can_join_groups;

    bool can_read_all_group_messages;

    bool supports_inline_queries;

} telebot_user_t;

typedef struct telebot_chat {
    long long int id;

    char *type;

    char *title;

    char *username;

    char *first_name;

    char *last_name;

    struct telebot_chat_photo *photo;

    char *description;

    char *invite_link;

    struct telebot_message *pinned_message;

    struct telebot_chat_permissions *permissions;

    int slow_mode_delay;

    char *sticker_set_name;

    bool can_set_sticker_set;

} telebot_chat_t;


typedef struct telebot_message {
    int message_id;

    struct telebot_user *from;

    long date;

    struct telebot_chat *chat;

    struct telebot_user *forward_from;

    struct telebot_chat *forward_from_chat;

    int forward_from_message_id;

    char *forward_signature;

    char *forward_sender_name;

    long forward_date;

    struct telebot_message *reply_to_message;

    long edit_date;

    char *media_group_id;

    char *author_signature;

    char *text;

    struct telebot_message_entity *entities;
    int count_entities;

    struct telebot_message_entity *caption_entities;
    int count_caption_entities;

    struct telebot_audio *audio;

    struct telebot_document *document;

    struct telebot_animation *animation;

    struct telebot_game *game; //TODO:define type

    struct telebot_photo *photos;
    int count_photos;

    struct telebot_sticker *sticker;

    struct telebot_video *video;

    struct telebot_voice *voice;

    struct telebot_video_note *video_note;

    char *caption;

    struct telebot_contact *contact;

    struct telebot_location *location;

    struct telebot_venue *venue;

    struct telebot_poll *poll;

    struct telebot_dice *dice;

    struct telebot_user *new_chat_members;
    int count_new_chat_members;

    struct telebot_user *left_chat_members;
    int count_left_chat_members;

    char *new_chat_title;

    struct telebot_photo *new_chat_photos;
    int count_new_chat_photos;

    bool delete_chat_photo;

    bool group_chat_created;

    bool supergroup_chat_created;

    bool channel_chat_created;

    long long int migrate_to_chat_id;

    long long int migrate_from_chat_id;

    struct telebot_message *pinned_message;

    struct telebot_invoice *invoice; //TODO:define type

    struct telebot_successful_payment *successful_payment; //TODO:define type

    char *connected_website;

    struct telebot_passport_data *passport_data; //TODO:define type

    struct inline_keyboard_markup *reply_markup; //TODO:define type
} telebot_message_t;

typedef struct telebot_message_entity {
    char *type;

    int offset;

    int length;

    char *url;

    telebot_user_t *user;

    char *language;
} telebot_message_entity_t;


typedef struct telebot_photo {
    char *file_id;

    char *file_unique_id;

    int width;

    int height;

    int file_size;
} telebot_photo_t;


typedef struct telebot_audio {
    char *file_id;

    char *file_unique_id;

    int duration;

    char *performer;

    char *title;

    char *mime_type;

    int file_size;

    struct telebot_photo *thumb;
} telebot_audio_t;


typedef struct telebot_document {
    char *file_id;

    char *file_unique_id;

    struct telebot_photo *thumb;

    char *file_name;

    char *mime_type;

    int file_size;
} telebot_document_t;


typedef struct telebot_video {
    char *file_id;

    char *file_unique_id;

    int width;

    int height;

    int duration;

    struct telebot_photo *thumb;

    char *mime_type;

    int file_size;
} telebot_video_t;

typedef struct telebot_animation {
    char *file_id;

    char *file_unique_id;

    int width;

    int height;

    int duration;

    struct telebot_photo *thumb;

    char *file_name;

    char *mime_type;

    int file_size;
} telebot_animation_t;

typedef struct telebot_voice {
    char *file_id;

    char *file_unique_id;

    int duration;

    char *mime_type;

    int file_size;
} telebot_voice_t;


typedef struct telebot_video_note {
    char *file_id;

    char *file_unique_id;

    int length;

    int duration;

    struct telebot_photo *thumb;

    int file_size;
} telebot_video_note_t;


typedef struct telebot_contact {
    char *phone_number;

    char *first_name;

    char *last_name;

    int user_id;

    char *vcard;
} telebot_contact_t;


typedef struct telebot_location {
    float longitude;

    float latitude;
} telebot_location_t;


typedef struct telebot_venue {
    struct telebot_location *location;

    char *title;

    char *address;

    char *foursquare_id;

    char *foursquare_type;
} telebot_venue_t;

typedef struct telebot_poll_option {
    char *text;

    int voter_count;
} telebot_poll_option_t;

typedef struct telebot_poll_answer {
    char *poll_id;

    struct telebot_user *user;

    int *option_ids;

    /* Number of option ids */
    int count_option_ids;
} telebot_poll_answer_t;

typedef struct telebot_poll {
    char *id;

    char *question;

    telebot_poll_option_t *options;

    /* Number of options */
    int count_options;

    int total_voter_count;

    bool is_closed;

    bool is_anonymous;

    char *type;

    bool allows_multiple_answers;

    int correct_option_id;
} telebot_poll_t;

typedef struct telebot_dice {
    int value;
} telebot_dice_t;

typedef struct telebot_user_profile_photos {
    int total_count;

    int current_count;

    struct telebot_photo *photos[4];
} telebot_user_profile_photos_t;

typedef struct telebot_file {
    char *file_id;

    char *file_unique_id;

    int file_size;

    char *file_path;
} telebot_file_t;

typedef struct telebot_keyboard_button_poll_type {

    char *type;
} telebot_keyboard_button_poll_type_t;

typedef struct telebot_keyboard_button {
    char *text;

    bool request_contact;
    bool request_location;

    telebot_keyboard_button_poll_type_t *request_poll;
} telebot_keyboard_button_t;

typedef struct telebot_reply_keyboard_markup {
    telebot_keyboard_button_t *keyboard;

    /* Number of keyboard rows */
    int keyboard_rows;

    /* Number of keyboard columns */
    int keyboard_cols;

    bool resize_keyboard;

    bool one_time_keyboard;

    bool selective;
} telebot_reply_keyboard_markup_t;

typedef struct telebot_reply_keyboard_remove
{
    bool remove_keyboard;

    bool selective;
} telebot_reply_keyboard_remove_t;

typedef struct telebot_callback_query {
    char *id;

    struct telebot_user *from;

    struct telebot_message *message;

    char *inline_message_id;

    char *chat_instance;

    char *data;

    char *game_short_name;
} telebot_callback_query_t;

typedef struct telebot_force_reply
{
    bool force_reply;

    bool selective;
} telebot_force_reply_t;


typedef struct telebot_chat_photo {
    char *small_file_id;

    char *small_file_unique_id;

    char *big_file_id;

    char *big_file_unique_id;
} telebot_chat_photo_t;

typedef struct telebot_chat_member {
    struct telebot_user *user;

    char *status;

    char *custom_title;

    long until_date;

    bool can_be_edited;

    bool can_post_messages;

    bool can_edit_messages;

    bool can_delete_messages;

    bool can_restrict_members;

    bool can_promote_members;

    bool can_change_info;

    bool can_invite_users;

    bool can_pin_messages;

    bool is_member;

    bool can_send_messages;

    bool can_send_media_messages;

    bool can_send_polls;

    bool can_send_other_messages;

    bool can_add_web_page_previews;
} telebot_chat_member_t;

typedef struct telebot_chat_permissions {
    bool can_send_messages;

    bool can_send_media_messages;

    bool can_send_polls;

    bool can_send_other_messages;

    bool can_add_web_page_previews;

    bool can_change_info;

    bool can_invite_users;

    bool can_pin_messages;
} telebot_chat_permissions_t;

typedef struct telebot_bot_command {
    char *command;

    char *description;
} telebot_bot_command_t;

typedef struct telebot_response_paramters {
    int migrate_to_chat_id;

    int retry_after;
} telebot_response_paramters_t;

typedef struct telebot_update {
    int update_id;

    telebot_update_type_e update_type;

    union {
        telebot_message_t message;

        telebot_message_t edited_message;

        telebot_message_t channel_post;

        telebot_message_t edited_channel_post;

        //TODO: telebot_inline_query_t inline_query;

        //TODO: telebot_inline_query_result_t chosen_inline_result;

        telebot_callback_query_t callback_query;

        //TODO: telebot_shipping_query_t shipping_query;

        //TODO: telebot_pre_checkout_query_t pre_checkout_query;

        telebot_poll_t poll;

        telebot_poll_answer_t poll_anser;
    };
} telebot_update_t;

typedef struct telebot_webhook_info {
    char *url;

    bool has_custom_certificate;

    int pending_update_count;

    long last_error_date;

    char *last_error_message;

    int max_connections;

    telebot_update_type_e allowed_updates[TELEBOT_UPDATE_TYPE_MAX];

    int allowed_updates_count;

} telebot_webhook_info_t;

typedef struct telebot_handler_s *telebot_handler_t;

#ifdef __cplusplus
}
#endif

#endif /* __TELEBOT_TYPES_H__ */