Delta Chat Core C Interface
Loading...
Searching...
No Matches
deltachat.h
1#ifndef __DELTACHAT_H__
2#define __DELTACHAT_H__
3#ifdef __cplusplus
4extern "C" {
5#endif
6
7
8#ifndef PY_CFFI
9#include <stdint.h>
10#include <time.h>
11#endif
12
13
14typedef struct _dc_context dc_context_t;
15typedef struct _dc_accounts dc_accounts_t;
16typedef struct _dc_array dc_array_t;
17typedef struct _dc_chatlist dc_chatlist_t;
18typedef struct _dc_chat dc_chat_t;
19typedef struct _dc_msg dc_msg_t;
20typedef struct _dc_contact dc_contact_t;
21typedef struct _dc_lot dc_lot_t;
22typedef struct _dc_provider dc_provider_t;
23typedef struct _dc_event dc_event_t;
24typedef struct _dc_event_emitter dc_event_emitter_t;
25typedef struct _dc_event_channel dc_event_channel_t;
26typedef struct _dc_jsonrpc_instance dc_jsonrpc_instance_t;
27typedef struct _dc_backup_provider dc_backup_provider_t;
28
29// Alias for backwards compatibility, use dc_event_emitter_t instead.
30typedef struct _dc_event_emitter dc_accounts_event_emitter_t;
31
236
237
247
248// create/open/config/information
249
265dc_context_t* dc_context_new (const char* os_name, const char* dbfile, const char* blobdir);
266
267
284
285
305int dc_context_open (dc_context_t *context, const char* passphrase);
306
307
320int dc_context_change_passphrase (dc_context_t* context, const char* passphrase);
321
322
331
332
345
346
358uint32_t dc_get_id (dc_context_t* context);
359
360
377
378
387char* dc_get_blobdir (const dc_context_t* context);
388
389
516int dc_set_config (dc_context_t* context, const char* key, const char* value);
517
518
541char* dc_get_config (dc_context_t* context, const char* key);
542
543
555int dc_set_stock_translation(dc_context_t* context, uint32_t stock_id, const char* stock_msg);
556
557
570int dc_set_config_from_qr (dc_context_t* context, const char* qr);
571
572
587char* dc_get_info (const dc_context_t* context);
588
589
619char* dc_get_oauth2_url (dc_context_t* context, const char* addr, const char* redirect_uri);
620
621
622#define DC_CONNECTIVITY_NOT_CONNECTED 1000
623#define DC_CONNECTIVITY_CONNECTING 2000
624#define DC_CONNECTIVITY_WORKING 3000
625#define DC_CONNECTIVITY_CONNECTED 4000
626
627
649
650
667
668
669#define DC_PUSH_NOT_CONNECTED 0
670#define DC_PUSH_HEARTBEAT 1
671#define DC_PUSH_CONNECTED 2
672
685
686
687// connect
688
746
747
767int dc_is_configured (const dc_context_t* context);
768
769
780void dc_start_io (dc_context_t* context);
781
797
821
822
823
839int dc_preconfigure_keypair (dc_context_t* context, const char *secret_data);
840
841
842// handle chatlists
843
844#define DC_GCL_ARCHIVED_ONLY 0x01
845#define DC_GCL_NO_SPECIALS 0x02
846#define DC_GCL_ADD_ALLDONE_HINT 0x04
847#define DC_GCL_FOR_FORWARDING 0x08
848
849
899dc_chatlist_t* dc_get_chatlist (dc_context_t* context, int flags, const char* query_str, uint32_t query_id);
900
901
902// handle chats
903
917uint32_t dc_create_chat_by_contact_id (dc_context_t* context, uint32_t contact_id);
918
919
931uint32_t dc_get_chat_id_by_contact_id (dc_context_t* context, uint32_t contact_id);
932
933
969uint32_t dc_send_msg (dc_context_t* context, uint32_t chat_id, dc_msg_t* msg);
970
985uint32_t dc_send_msg_sync (dc_context_t* context, uint32_t chat_id, dc_msg_t* msg);
986
987
1007uint32_t dc_send_text_msg (dc_context_t* context, uint32_t chat_id, const char* text_to_send);
1008
1009
1024void dc_send_edit_request (dc_context_t* context, uint32_t msg_id, const char* new_text);
1025
1026
1039 void dc_send_delete_request (dc_context_t* context, const uint32_t* msg_ids, int msg_cnt);
1040
1041
1074int dc_send_webxdc_status_update (dc_context_t* context, uint32_t msg_id, const char* json, const char* descr);
1075
1076
1107char* dc_get_webxdc_status_updates (dc_context_t* context, uint32_t msg_id, uint32_t serial);
1108
1109
1120void dc_set_webxdc_integration (dc_context_t* context, const char* file);
1121
1122
1165uint32_t dc_init_webxdc_integration (dc_context_t* context, uint32_t chat_id);
1166
1167
1233uint32_t dc_place_outgoing_call (dc_context_t* context, uint32_t chat_id, const char* place_call_info, int has_video);
1234
1235
1255 int dc_accept_incoming_call (dc_context_t* context, uint32_t msg_id, const char* accept_call_info);
1256
1257
1279 int dc_end_call (dc_context_t* context, uint32_t msg_id);
1280
1281
1305void dc_set_draft (dc_context_t* context, uint32_t chat_id, dc_msg_t* msg);
1306
1307
1355uint32_t dc_add_device_msg (dc_context_t* context, const char* label, dc_msg_t* msg);
1356
1367int dc_was_device_msg_ever_added (dc_context_t* context, const char* label);
1368
1369
1382dc_msg_t* dc_get_draft (dc_context_t* context, uint32_t chat_id);
1383
1384
1385#define DC_GCM_ADDDAYMARKER 0x01
1386
1387
1409dc_array_t* dc_get_chat_msgs (dc_context_t* context, uint32_t chat_id, uint32_t flags, uint32_t marker1before);
1410
1411
1420int dc_get_msg_cnt (dc_context_t* context, uint32_t chat_id);
1421
1422
1440int dc_get_fresh_msg_cnt (dc_context_t* context, uint32_t chat_id);
1441
1442
1456
1457
1471int dc_estimate_deletion_cnt (dc_context_t* context, int from_server, int64_t seconds);
1472
1473
1493
1494
1518
1519
1543
1544
1558void dc_marknoticed_chat (dc_context_t* context, uint32_t chat_id);
1559
1560
1581void dc_markfresh_chat (dc_context_t* context, uint32_t chat_id);
1582
1583
1602dc_array_t* dc_get_chat_media (dc_context_t* context, uint32_t chat_id, int msg_type, int msg_type2, int msg_type3);
1603
1604
1616void dc_set_chat_visibility (dc_context_t* context, uint32_t chat_id, int visibility);
1617
1618
1644void dc_delete_chat (dc_context_t* context, uint32_t chat_id);
1645
1659void dc_block_chat (dc_context_t* context, uint32_t chat_id);
1660
1673void dc_accept_chat (dc_context_t* context, uint32_t chat_id);
1674
1697dc_array_t* dc_get_chat_contacts (dc_context_t* context, uint32_t chat_id);
1698
1709char* dc_get_chat_encrinfo (dc_context_t* context, uint32_t chat_id);
1710
1722uint32_t dc_get_chat_ephemeral_timer (dc_context_t* context, uint32_t chat_id);
1723
1746dc_array_t* dc_search_msgs (dc_context_t* context, uint32_t chat_id, const char* query);
1747
1748
1759dc_chat_t* dc_get_chat (dc_context_t* context, uint32_t chat_id);
1760
1761
1762// handle group chats
1763
1789uint32_t dc_create_group_chat (dc_context_t* context, int protect, const char* name);
1790
1791
1808
1809
1820int dc_is_contact_in_chat (dc_context_t* context, uint32_t chat_id, uint32_t contact_id);
1821
1822
1839int dc_add_contact_to_chat (dc_context_t* context, uint32_t chat_id, uint32_t contact_id);
1840
1841
1856int dc_remove_contact_from_chat (dc_context_t* context, uint32_t chat_id, uint32_t contact_id);
1857
1858
1874int dc_set_chat_name (dc_context_t* context, uint32_t chat_id, const char* name);
1875
1893int dc_set_chat_ephemeral_timer (dc_context_t* context, uint32_t chat_id, uint32_t timer);
1894
1915int dc_set_chat_profile_image (dc_context_t* context, uint32_t chat_id, const char* image);
1916
1917
1918
1940int dc_set_chat_mute_duration (dc_context_t* context, uint32_t chat_id, int64_t duration);
1941
1942// handle messages
1943
1956char* dc_get_msg_info (dc_context_t* context, uint32_t msg_id);
1957
1958
2006char* dc_get_msg_html (dc_context_t* context, uint32_t msg_id);
2007
2008
2028void dc_download_full_msg (dc_context_t* context, int msg_id);
2029
2030
2040void dc_delete_msgs (dc_context_t* context, const uint32_t* msg_ids, int msg_cnt);
2041
2042
2057void dc_forward_msgs (dc_context_t* context, const uint32_t* msg_ids, int msg_cnt, uint32_t chat_id);
2058
2059
2087void dc_save_msgs (dc_context_t* context, const uint32_t* msg_ids, int msg_cnt);
2088
2089
2106int dc_resend_msgs (dc_context_t* context, const uint32_t* msg_ids, int msg_cnt);
2107
2108
2139void dc_markseen_msgs (dc_context_t* context, const uint32_t* msg_ids, int msg_cnt);
2140
2141
2154dc_msg_t* dc_get_msg (dc_context_t* context, uint32_t msg_id);
2155
2156
2157// handle contacts
2158
2172int dc_may_be_valid_addr (const char* addr);
2173
2174
2198uint32_t dc_lookup_contact_id_by_addr (dc_context_t* context, const char* addr);
2199
2200
2228uint32_t dc_create_contact (dc_context_t* context, const char* name, const char* addr);
2229
2230
2231#define DC_GCL_ADD_SELF 0x02
2232#define DC_GCL_ADDRESS 0x04
2233
2234
2258int dc_add_address_book (dc_context_t* context, const char* addr_book);
2259
2260
2269char* dc_make_vcard (dc_context_t* context, uint32_t contact_id);
2270
2271
2281dc_array_t* dc_import_vcard (dc_context_t* context, const char* vcard);
2282
2283
2300dc_array_t* dc_get_contacts (dc_context_t* context, uint32_t flags, const char* query);
2301
2302
2312
2313
2323void dc_block_contact (dc_context_t* context, uint32_t contact_id, int block);
2324
2325
2336char* dc_get_contact_encrinfo (dc_context_t* context, uint32_t contact_id);
2337
2338
2351int dc_delete_contact (dc_context_t* context, uint32_t contact_id);
2352
2353
2367dc_contact_t* dc_get_contact (dc_context_t* context, uint32_t contact_id);
2368
2369
2370// import/export and tools
2371
2372#define DC_IMEX_EXPORT_SELF_KEYS 1 // param1 is a directory where the keys are written to
2373#define DC_IMEX_IMPORT_SELF_KEYS 2 // param1 is a directory where the keys are searched in and read from
2374#define DC_IMEX_EXPORT_BACKUP 11 // param1 is a directory where the backup is written to, param2 is a passphrase to encrypt the backup
2375#define DC_IMEX_IMPORT_BACKUP 12 // param1 is the file with the backup to import, param2 is the backup's passphrase
2376
2377
2422void dc_imex (dc_context_t* context, int what, const char* param1, const char* param2);
2423
2424
2474char* dc_imex_has_backup (dc_context_t* context, const char* dir);
2475
2476
2494
2495
2496// out-of-band verification
2497
2498#define DC_QR_ASK_VERIFYCONTACT 200 // id=contact
2499#define DC_QR_ASK_VERIFYGROUP 202 // text1=groupname
2500#define DC_QR_ASK_VERIFYBROADCAST 204 // text1=broadcast name
2501#define DC_QR_FPR_OK 210 // id=contact
2502#define DC_QR_FPR_MISMATCH 220 // id=contact
2503#define DC_QR_FPR_WITHOUT_ADDR 230 // test1=formatted fingerprint
2504#define DC_QR_ACCOUNT 250 // text1=domain
2505#define DC_QR_BACKUP2 252
2506#define DC_QR_BACKUP_TOO_NEW 255
2507#define DC_QR_PROXY 271 // text1=address (e.g. "127.0.0.1:9050")
2508#define DC_QR_ADDR 320 // id=contact
2509#define DC_QR_TEXT 330 // text1=text
2510#define DC_QR_URL 332 // text1=URL
2511#define DC_QR_ERROR 400 // text1=error string
2512#define DC_QR_WITHDRAW_VERIFYCONTACT 500
2513#define DC_QR_WITHDRAW_VERIFYGROUP 502 // text1=groupname
2514#define DC_QR_WITHDRAW_JOINBROADCAST 504 // text1=broadcast name
2515#define DC_QR_REVIVE_VERIFYCONTACT 510
2516#define DC_QR_REVIVE_VERIFYGROUP 512 // text1=groupname
2517#define DC_QR_REVIVE_JOINBROADCAST 514 // text1=broadcast name
2518#define DC_QR_LOGIN 520 // text1=email_address
2519
2612dc_lot_t* dc_check_qr (dc_context_t* context, const char* qr);
2613
2614
2639char* dc_get_securejoin_qr (dc_context_t* context, uint32_t chat_id);
2640
2641
2655char* dc_get_securejoin_qr_svg (dc_context_t* context, uint32_t chat_id);
2656
2680uint32_t dc_join_securejoin (dc_context_t* context, const char* qr);
2681
2682
2683// location streaming
2684
2685
2702void dc_send_locations_to_chat (dc_context_t* context, uint32_t chat_id, int seconds);
2703
2704
2718int dc_is_sending_locations_to_chat (dc_context_t* context, uint32_t chat_id);
2719
2720
2748int dc_set_location (dc_context_t* context, double latitude, double longitude, double accuracy);
2749
2750
2811dc_array_t* dc_get_locations (dc_context_t* context, uint32_t chat_id, uint32_t contact_id, int64_t timestamp_begin, int64_t timestamp_end);
2812
2813
2814// misc
2815
2827char* dc_create_qr_svg (const char* payload);
2828
2829
2844
2845
2858void dc_str_unref (char* str);
2859
2860
2866
2890
2891
2910
2911
2927
2938
2953
2977int dc_receive_backup (dc_context_t* context, const char* qr);
2978
3005
3028dc_accounts_t* dc_accounts_new (const char* dir, int writable);
3029
3058dc_accounts_t* dc_accounts_new_with_event_channel(const char* dir, int writable, dc_event_channel_t* events_channel);
3059
3067
3068
3085
3102
3117uint32_t dc_accounts_migrate_account (dc_accounts_t* accounts, const char* dbfile);
3118
3119
3131int dc_accounts_remove_account (dc_accounts_t* accounts, uint32_t account_id);
3132
3133
3143
3144
3156dc_context_t* dc_accounts_get_account (dc_accounts_t* accounts, uint32_t account_id);
3157
3158
3175
3176
3185int dc_accounts_select_account (dc_accounts_t* accounts, uint32_t account_id);
3186
3187
3198
3199
3209
3210
3221
3222
3236
3237
3254int dc_accounts_background_fetch (dc_accounts_t* accounts, uint64_t timeout);
3255
3256
3272
3273
3281void dc_accounts_set_push_device_token (dc_accounts_t* accounts, const char *token);
3282
3303
3304
3313
3314
3324
3325
3333size_t dc_array_get_cnt (const dc_array_t* array);
3334
3335
3344uint32_t dc_array_get_id (const dc_array_t* array, size_t index);
3345
3346
3356double dc_array_get_latitude (const dc_array_t* array, size_t index);
3357
3358
3368double dc_array_get_longitude (const dc_array_t* array, size_t index);
3369
3370
3381double dc_array_get_accuracy (const dc_array_t* array, size_t index);
3382
3383
3393int64_t dc_array_get_timestamp (const dc_array_t* array, size_t index);
3394
3395
3405uint32_t dc_array_get_chat_id (const dc_array_t* array, size_t index);
3406
3407
3417uint32_t dc_array_get_contact_id (const dc_array_t* array, size_t index);
3418
3419
3429uint32_t dc_array_get_msg_id (const dc_array_t* array, size_t index);
3430
3431
3446char* dc_array_get_marker (const dc_array_t* array, size_t index);
3447
3448
3459int dc_array_is_independent (const dc_array_t* array, size_t index);
3460
3461
3471int dc_array_search_id (const dc_array_t* array, uint32_t needle, size_t* ret_index);
3472
3473
3506
3507
3516
3517
3525size_t dc_chatlist_get_cnt (const dc_chatlist_t* chatlist);
3526
3527
3539uint32_t dc_chatlist_get_chat_id (const dc_chatlist_t* chatlist, size_t index);
3540
3541
3553uint32_t dc_chatlist_get_msg_id (const dc_chatlist_t* chatlist, size_t index);
3554
3555
3582dc_lot_t* dc_chatlist_get_summary (const dc_chatlist_t* chatlist, size_t index, dc_chat_t* chat);
3583
3584
3604dc_lot_t* dc_chatlist_get_summary2 (dc_context_t* context, uint32_t chat_id, uint32_t msg_id);
3605
3606
3615
3616
3633char* dc_chat_get_info_json (dc_context_t* context, size_t chat_id);
3634
3643
3644
3645#define DC_CHAT_ID_TRASH 3 // messages that should be deleted get this chat ID; the messages are deleted from the working thread later then. This is also needed as rfc724_mid should be preset as long as the message is not deleted on the server (otherwise it is downloaded again)
3646#define DC_CHAT_ID_ARCHIVED_LINK 6 // only an indicator in a chatlist
3647#define DC_CHAT_ID_ALLDONE_HINT 7 // only an indicator in a chatlist
3648#define DC_CHAT_ID_LAST_SPECIAL 9 // larger chat IDs are "real" chats, their messages are "real" messages
3649
3650
3659
3660
3673uint32_t dc_chat_get_id (const dc_chat_t* chat);
3674
3675
3683int dc_chat_get_type (const dc_chat_t* chat);
3684
3685
3697
3698
3710char* dc_chat_get_name (const dc_chat_t* chat);
3711
3712
3727
3728
3741uint32_t dc_chat_get_color (const dc_chat_t* chat);
3742
3743
3753
3754
3772
3773
3795
3796
3806
3807
3823
3824
3836int dc_chat_can_send (const dc_chat_t* chat);
3837
3838
3848
3849
3863
3864
3876
3877
3885int dc_chat_is_muted (const dc_chat_t* chat);
3886
3887
3896
3897
3905
3906
3907#define DC_MSG_ID_MARKER1 1 // this is used by iOS to mark things in the message list
3908#define DC_MSG_ID_DAYMARKER 9
3909#define DC_MSG_ID_LAST_SPECIAL 9
3910
3911
3924dc_msg_t* dc_msg_new (dc_context_t* context, int viewtype);
3925
3926
3935
3936
3945uint32_t dc_msg_get_id (const dc_msg_t* msg);
3946
3947
3962uint32_t dc_msg_get_from_id (const dc_msg_t* msg);
3963
3964
3973uint32_t dc_msg_get_chat_id (const dc_msg_t* msg);
3974
3975
3985
3986
4028
4029
4046int64_t dc_msg_get_timestamp (const dc_msg_t* msg);
4047
4048
4061
4062
4077
4078
4098char* dc_msg_get_text (const dc_msg_t* msg);
4099
4100
4118char* dc_msg_get_subject (const dc_msg_t* msg);
4119
4120
4134char* dc_msg_get_file (const dc_msg_t* msg);
4135
4136
4147int dc_msg_save_file (const dc_msg_t* msg, const char* path);
4148
4149
4160
4161
4173
4174
4187char* dc_msg_get_webxdc_blob (const dc_msg_t* msg, const char* filename, size_t* ret_bytes);
4188
4189
4228
4229
4241uint64_t dc_msg_get_filebytes (const dc_msg_t* msg);
4242
4243
4259
4260
4276
4277
4290
4291
4305
4315int dc_msg_is_bot (const dc_msg_t* msg);
4316
4329
4343
4344
4368
4369
4381char* dc_msg_get_summarytext (const dc_msg_t* msg, int approx_characters);
4382
4383
4413
4414
4415
4431
4432
4443
4444
4455int dc_msg_is_sent (const dc_msg_t* msg);
4456
4457
4475
4476
4488 int dc_msg_is_edited (const dc_msg_t* msg);
4489
4490
4511int dc_msg_is_info (const dc_msg_t* msg);
4512
4513
4547
4548
4570
4571
4572// DC_INFO* uses the same values as SystemMessage in rust-land
4573#define DC_INFO_UNKNOWN 0
4574#define DC_INFO_GROUP_NAME_CHANGED 2
4575#define DC_INFO_GROUP_IMAGE_CHANGED 3
4576#define DC_INFO_MEMBER_ADDED_TO_GROUP 4
4577#define DC_INFO_MEMBER_REMOVED_FROM_GROUP 5
4578
4579// Deprecated as of 2026-03-16, not used for new messages.
4580#define DC_INFO_AUTOCRYPT_SETUP_MESSAGE 6
4581
4582#define DC_INFO_SECURE_JOIN_MESSAGE 7
4583#define DC_INFO_LOCATIONSTREAMING_ENABLED 8
4584#define DC_INFO_LOCATION_ONLY 9
4585#define DC_INFO_EPHEMERAL_TIMER_CHANGED 10
4586#define DC_INFO_PROTECTION_ENABLED 11
4587#define DC_INFO_INVALID_UNENCRYPTED_MAIL 13
4588#define DC_INFO_WEBXDC_INFO_MESSAGE 32
4589#define DC_INFO_CHAT_E2EE 50
4590#define DC_INFO_GROUP_DESCRIPTION_CHANGED 70
4591
4592
4609
4610
4630char* dc_msg_get_error (const dc_msg_t* msg);
4631
4632
4657
4658
4685
4686
4695void dc_msg_set_text (dc_msg_t* msg, const char* text);
4696
4697
4722void dc_msg_set_html (dc_msg_t* msg, const char* html);
4723
4724
4734void dc_msg_set_subject (dc_msg_t* msg, const char* subject);
4735
4736
4749void dc_msg_set_override_sender_name(dc_msg_t* msg, const char* name);
4750
4751
4774void dc_msg_set_file_and_deduplicate(dc_msg_t* msg, const char* file, const char* name, const char* filemime);
4775
4776
4787void dc_msg_set_dimension (dc_msg_t* msg, int width, int height);
4788
4789
4799void dc_msg_set_duration (dc_msg_t* msg, int duration);
4800
4801
4818void dc_msg_set_location (dc_msg_t* msg, double latitude, double longitude);
4819
4820
4842void dc_msg_latefiling_mediasize (dc_msg_t* msg, int width, int height, int duration);
4843
4844
4859void dc_msg_set_quote (dc_msg_t* msg, const dc_msg_t* quote);
4860
4861
4877
4878
4901
4917
4918
4932
4933
4945uint32_t dc_msg_get_saved_msg_id (const dc_msg_t* msg);
4946
4966
4967
4968#define DC_CONTACT_ID_SELF 1
4969#define DC_CONTACT_ID_INFO 2 // centered messages as "member added", used in all chats
4970#define DC_CONTACT_ID_DEVICE 5 // messages "update info" in the device-chat
4971#define DC_CONTACT_ID_LAST_SPECIAL 9
4972
4973
4982
4983
4991uint32_t dc_contact_get_id (const dc_contact_t* contact);
4992
4993
5002char* dc_contact_get_addr (const dc_contact_t* contact);
5003
5004
5019char* dc_contact_get_name (const dc_contact_t* contact);
5020
5021
5042
5043
5060
5061
5062// dc_contact_get_first_name is removed,
5063// the following define is to make upgrading more smoothly.
5064#define dc_contact_get_first_name dc_contact_get_display_name
5065
5066
5082
5083
5096
5097
5109uint32_t dc_contact_get_color (const dc_contact_t* contact);
5110
5111
5124
5134
5135
5149
5150
5161
5162
5175
5184
5185
5198
5199
5228
5229
5235
5236
5250dc_provider_t* dc_provider_new_from_email (const dc_context_t* context, const char* email);
5251
5252
5267
5268
5281
5282
5298
5299
5311
5312
5320
5321
5332
5333
5334#define DC_TEXT1_DRAFT 1
5335#define DC_TEXT1_USERNAME 2
5336#define DC_TEXT1_SELF 3
5337
5338
5349
5350
5360char* dc_lot_get_text1 (const dc_lot_t* lot);
5361
5362
5372char* dc_lot_get_text2 (const dc_lot_t* lot);
5373
5374
5385
5386
5395
5396
5404uint32_t dc_lot_get_id (const dc_lot_t* lot);
5405
5406
5416int64_t dc_lot_get_timestamp (const dc_lot_t* lot);
5417
5418
5441
5442
5448#define DC_MSG_TEXT 10
5449
5450
5462#define DC_MSG_IMAGE 20
5463
5464
5470#define DC_MSG_GIF 21
5471
5472
5480#define DC_MSG_STICKER 23
5481
5482
5488#define DC_MSG_AUDIO 40
5489
5490
5497#define DC_MSG_VOICE 41
5498
5499
5508#define DC_MSG_VIDEO 50
5509
5510
5516#define DC_MSG_FILE 60
5517
5518
5534#define DC_MSG_CALL 71
5535
5536
5542#define DC_MSG_WEBXDC 80
5543
5548#define DC_MSG_VCARD 90
5549
5553
5554
5565
5569#define DC_STATE_UNDEFINED 0
5570
5574#define DC_STATE_IN_FRESH 10
5575
5579#define DC_STATE_IN_NOTICED 13
5580
5584#define DC_STATE_IN_SEEN 16
5585
5589#define DC_STATE_OUT_DRAFT 19
5590
5594#define DC_STATE_OUT_PENDING 20
5595
5599#define DC_STATE_OUT_FAILED 24
5600
5605#define DC_STATE_OUT_DELIVERED 26
5606
5610#define DC_STATE_OUT_MDN_RCVD 28
5611
5615
5616
5627
5632#define DC_CHAT_TYPE_UNDEFINED 0
5633
5641#define DC_CHAT_TYPE_SINGLE 100
5642
5650#define DC_CHAT_TYPE_GROUP 120
5651
5662#define DC_CHAT_TYPE_MAILINGLIST 140
5663
5675#define DC_CHAT_TYPE_OUT_BROADCAST 160
5676
5691#define DC_CHAT_TYPE_IN_BROADCAST 165
5692
5696
5697
5708
5712#define DC_SOCKET_AUTO 0
5713
5714
5718#define DC_SOCKET_SSL 1
5719
5720
5724#define DC_SOCKET_STARTTLS 2
5725
5726
5730#define DC_SOCKET_PLAIN 3
5731
5735
5736
5748
5749
5755#define DC_LP_AUTH_OAUTH2 0x2
5756
5757
5762#define DC_LP_AUTH_NORMAL 0x4
5763
5764
5768
5769#define DC_LP_AUTH_FLAGS (DC_LP_AUTH_OAUTH2|DC_LP_AUTH_NORMAL) // if none of these flags are set, the default is chosen
5770
5782
5786#define DC_CERTCK_AUTO 0
5787
5792#define DC_CERTCK_STRICT 1
5793
5798#define DC_CERTCK_ACCEPT_INVALID 2
5799
5804#define DC_CERTCK_ACCEPT_INVALID_CERTIFICATES 3
5805
5809
5810
5816
5827
5836
5863void dc_jsonrpc_request(dc_jsonrpc_instance_t* jsonrpc_instance, const char* request);
5864
5875
5887char* dc_jsonrpc_blocking_call(dc_jsonrpc_instance_t* jsonrpc_instance, const char *input);
5888
5900
5908
5919
5937
5945
5958
5959// Alias for backwards compatibility, use dc_get_next_event instead.
5960#define dc_accounts_get_next_event dc_get_next_event
5961
5970
5971// Alias for backwards compatibility, use dc_event_emtitter_unref instead.
5972#define dc_accounts_event_emitter_unref dc_event_emitter_unref
5973
5980
5993
5994
6007
6008
6021
6022
6034
6035
6047
6048
6059
6060
6069
6070
6084
6093#define DC_EVENT_INFO 100
6094
6095
6102#define DC_EVENT_SMTP_CONNECTED 101
6103
6104
6111#define DC_EVENT_IMAP_CONNECTED 102
6112
6119#define DC_EVENT_SMTP_MESSAGE_SENT 103
6120
6127#define DC_EVENT_IMAP_MESSAGE_DELETED 104
6128
6135#define DC_EVENT_IMAP_MESSAGE_MOVED 105
6136
6143#define DC_EVENT_IMAP_INBOX_IDLE 106
6144
6151#define DC_EVENT_NEW_BLOB_FILE 150
6152
6159#define DC_EVENT_DELETED_BLOB_FILE 151
6160
6169#define DC_EVENT_WARNING 300
6170
6171
6189#define DC_EVENT_ERROR 400
6190
6191
6202#define DC_EVENT_ERROR_SELF_NOT_IN_GROUP 410
6203
6204
6215#define DC_EVENT_MSGS_CHANGED 2000
6216
6217
6224#define DC_EVENT_REACTIONS_CHANGED 2001
6225
6226
6239#define DC_EVENT_INCOMING_REACTION 2002
6240
6241
6242
6259#define DC_EVENT_INCOMING_WEBXDC_NOTIFY 2003
6260
6261
6274#define DC_EVENT_INCOMING_MSG 2005
6275
6287#define DC_EVENT_INCOMING_MSG_BUNCH 2006
6288
6289
6302#define DC_EVENT_MSGS_NOTICED 2008
6303
6304
6312#define DC_EVENT_MSG_DELIVERED 2010
6313
6314
6323#define DC_EVENT_MSG_FAILED 2012
6324
6325
6333#define DC_EVENT_MSG_READ 2015
6334
6335
6342#define DC_EVENT_MSG_DELETED 2016
6343
6344
6353#define DC_EVENT_CHAT_MODIFIED 2020
6354
6361#define DC_EVENT_CHAT_EPHEMERAL_TIMER_MODIFIED 2021
6362
6363
6373#define DC_EVENT_CHAT_DELETED 2023
6374
6375
6382#define DC_EVENT_CONTACTS_CHANGED 2030
6383
6384
6385
6393#define DC_EVENT_LOCATION_CHANGED 2035
6394
6395
6402#define DC_EVENT_CONFIGURE_PROGRESS 2041
6403
6404
6411#define DC_EVENT_IMEX_PROGRESS 2051
6412
6413
6424#define DC_EVENT_IMEX_FILE_WRITTEN 2052
6425
6426
6437#define DC_EVENT_SECUREJOIN_INVITER_PROGRESS 2060
6438
6439
6453#define DC_EVENT_SECUREJOIN_JOINER_PROGRESS 2061
6454
6455
6465#define DC_EVENT_CONNECTIVITY_CHANGED 2100
6466
6467
6472#define DC_EVENT_SELFAVATAR_CHANGED 2110
6473
6474
6484#define DC_EVENT_CONFIG_SYNCED 2111
6485
6486
6501#define DC_EVENT_WEBXDC_STATUS_UPDATE 2120
6502
6508
6509#define DC_EVENT_WEBXDC_INSTANCE_DELETED 2121
6510
6520
6521#define DC_EVENT_WEBXDC_REALTIME_DATA 2150
6522
6529
6530#define DC_EVENT_WEBXDC_REALTIME_ADVERTISEMENT 2151
6531
6540
6541#define DC_EVENT_ACCOUNTS_BACKGROUND_FETCH_DONE 2200
6542
6548
6549#define DC_EVENT_CHATLIST_CHANGED 2300
6550
6557
6558#define DC_EVENT_CHATLIST_ITEM_CHANGED 2301
6559
6565
6566#define DC_EVENT_ACCOUNTS_CHANGED 2302
6567
6577
6578#define DC_EVENT_ACCOUNTS_ITEM_CHANGED 2303
6579
6585#define DC_EVENT_CHANNEL_OVERFLOW 2400
6586
6587
6588
6608#define DC_EVENT_INCOMING_CALL 2550
6609
6619 #define DC_EVENT_INCOMING_CALL_ACCEPTED 2560
6620
6629#define DC_EVENT_OUTGOING_CALL_ACCEPTED 2570
6630
6639#define DC_EVENT_CALL_ENDED 2580
6640
6649#define DC_EVENT_TRANSPORTS_MODIFIED 2600
6650
6651
6655
6656
6657#define DC_EVENT_DATA1_IS_STRING(e) 0 // not used anymore
6658#define DC_EVENT_DATA2_IS_STRING(e) ((e)==DC_EVENT_CONFIGURE_PROGRESS || (e)==DC_EVENT_IMEX_FILE_WRITTEN || ((e)>=100 && (e)<=499))
6659
6660
6661/*
6662 * Values for dc_get|set_config("media_quality")
6663 */
6664#define DC_MEDIA_QUALITY_BALANCED 0
6665#define DC_MEDIA_QUALITY_WORSE 1
6666
6667
6676
6689#define DC_PROVIDER_STATUS_OK 1
6690
6702#define DC_PROVIDER_STATUS_PREPARATION 2
6703
6716#define DC_PROVIDER_STATUS_BROKEN 3
6717
6721
6722
6733
6738#define DC_CHAT_VISIBILITY_NORMAL 0
6739
6752#define DC_CHAT_VISIBILITY_ARCHIVED 1
6753
6758#define DC_CHAT_VISIBILITY_PINNED 2
6759
6763
6764
6775
6779#define DC_DOWNLOAD_DONE 0
6780
6784#define DC_DOWNLOAD_AVAILABLE 10
6785
6789#define DC_DOWNLOAD_FAILURE 20
6790
6794#define DC_DOWNLOAD_UNDECIPHERABLE 30
6795
6799#define DC_DOWNLOAD_IN_PROGRESS 1000
6800
6801
6802
6806
6807
6826
6830#define DC_STR_NOMESSAGES 1
6831
6835#define DC_STR_SELF 2
6836
6840#define DC_STR_DRAFT 3
6841
6845#define DC_STR_VOICEMESSAGE 7
6846
6850#define DC_STR_IMAGE 9
6851
6855#define DC_STR_VIDEO 10
6856
6860#define DC_STR_AUDIO 11
6861
6865#define DC_STR_FILE 12
6866
6870#define DC_STR_GIF 23
6871
6875#define DC_STR_E2E_AVAILABLE 25
6876
6880#define DC_STR_ENCR_NONE 28
6881
6885#define DC_STR_FINGERPRINTS 30
6886
6891#define DC_STR_CONTACT_VERIFIED 35
6892
6896#define DC_STR_ARCHIVEDCHATS 40
6897
6902#define DC_STR_CANNOT_LOGIN 60
6903
6907#define DC_STR_MSGLOCATIONENABLED 64
6908
6912#define DC_STR_MSGLOCATIONDISABLED 65
6913
6917#define DC_STR_LOCATION 66
6918
6922#define DC_STR_STICKER 67
6923
6927#define DC_STR_DEVICE_MESSAGES 68
6928
6932#define DC_STR_SAVED_MESSAGES 69
6933
6937#define DC_STR_DEVICE_MESSAGES_HINT 70
6938
6942#define DC_STR_WELCOME_MESSAGE 71
6943
6949#define DC_STR_SUBJECT_FOR_NEW_CONTACT 73
6950
6955#define DC_STR_FAILED_SENDING_TO 74
6956
6961#define DC_STR_CONFIGURATION_FAILED 84
6962
6967#define DC_STR_BAD_TIME_MSG_BODY 85
6968
6972#define DC_STR_UPDATE_REMINDER_MSG_BODY 86
6973
6977#define DC_STR_ERROR_NO_NETWORK 87
6978
6983#define DC_STR_REPLY_NOUN 90
6984
6988#define DC_STR_SELF_DELETED_MSG_BODY 91
6989
6993#define DC_STR_FORWARDED 97
6994
6996#define DC_STR_QUOTA_EXCEEDING_MSG_BODY 98
6997
7001#define DC_STR_SYNC_MSG_SUBJECT 101
7002
7011#define DC_STR_SYNC_MSG_BODY 102
7012
7016#define DC_STR_INCOMING_MESSAGES 103
7017
7021#define DC_STR_OUTGOING_MESSAGES 104
7022
7026#define DC_STR_CONNECTED 107
7027
7031#define DC_STR_CONNTECTING 108
7032
7036#define DC_STR_UPDATING 109
7037
7041#define DC_STR_SENDING 110
7042
7046#define DC_STR_LAST_MSG_SENT_SUCCESSFULLY 111
7047
7053#define DC_STR_ERROR 112
7054
7058#define DC_STR_MESSAGES 114
7059
7063#define DC_STR_BROADCAST_LIST 115
7064
7068#define DC_STR_PART_OF_TOTAL_USED 116
7069
7077#define DC_STR_SECURE_JOIN_STARTED 117
7078
7087#define DC_STR_SECURE_JOIN_REPLIES 118
7088
7094#define DC_STR_SETUP_CONTACT_QR_DESC 119
7095
7101#define DC_STR_SECURE_JOIN_GROUP_QR_DESC 120
7102
7106#define DC_STR_NOT_CONNECTED 121
7107
7112#define DC_STR_GROUP_NAME_CHANGED_BY_YOU 124
7113
7119#define DC_STR_GROUP_NAME_CHANGED_BY_OTHER 125
7120
7122#define DC_STR_GROUP_IMAGE_CHANGED_BY_YOU 126
7123
7127#define DC_STR_GROUP_IMAGE_CHANGED_BY_OTHER 127
7128
7134#define DC_STR_ADD_MEMBER_BY_YOU 128
7135
7142#define DC_STR_ADD_MEMBER_BY_OTHER 129
7143
7149#define DC_STR_REMOVE_MEMBER_BY_YOU 130
7150
7157#define DC_STR_REMOVE_MEMBER_BY_OTHER 131
7158
7162#define DC_STR_GROUP_LEFT_BY_YOU 132
7163
7169#define DC_STR_GROUP_LEFT_BY_OTHER 133
7170
7174#define DC_STR_GROUP_IMAGE_DELETED_BY_YOU 134
7175
7181#define DC_STR_GROUP_IMAGE_DELETED_BY_OTHER 135
7182
7186#define DC_STR_LOCATION_ENABLED_BY_YOU 136
7187
7193#define DC_STR_LOCATION_ENABLED_BY_OTHER 137
7194
7198#define DC_STR_EPHEMERAL_TIMER_DISABLED_BY_YOU 138
7199
7205#define DC_STR_EPHEMERAL_TIMER_DISABLED_BY_OTHER 139
7206
7212#define DC_STR_EPHEMERAL_TIMER_SECONDS_BY_YOU 140
7213
7220#define DC_STR_EPHEMERAL_TIMER_SECONDS_BY_OTHER 141
7221
7225#define DC_STR_EPHEMERAL_TIMER_1_HOUR_BY_YOU 144
7226
7232#define DC_STR_EPHEMERAL_TIMER_1_HOUR_BY_OTHER 145
7233
7237#define DC_STR_EPHEMERAL_TIMER_1_DAY_BY_YOU 146
7238
7244#define DC_STR_EPHEMERAL_TIMER_1_DAY_BY_OTHER 147
7245
7249#define DC_STR_EPHEMERAL_TIMER_1_WEEK_BY_YOU 148
7250
7256#define DC_STR_EPHEMERAL_TIMER_1_WEEK_BY_OTHER 149
7257
7263#define DC_STR_EPHEMERAL_TIMER_MINUTES_BY_YOU 150
7264
7271#define DC_STR_EPHEMERAL_TIMER_MINUTES_BY_OTHER 151
7272
7278#define DC_STR_EPHEMERAL_TIMER_HOURS_BY_YOU 152
7279
7286#define DC_STR_EPHEMERAL_TIMER_HOURS_BY_OTHER 153
7287
7293#define DC_STR_EPHEMERAL_TIMER_DAYS_BY_YOU 154
7294
7301#define DC_STR_EPHEMERAL_TIMER_DAYS_BY_OTHER 155
7302
7308#define DC_STR_EPHEMERAL_TIMER_WEEKS_BY_YOU 156
7309
7316#define DC_STR_EPHEMERAL_TIMER_WEEKS_BY_OTHER 157
7317
7321#define DC_STR_EPHEMERAL_TIMER_1_YEAR_BY_YOU 158
7322
7328#define DC_STR_EPHEMERAL_TIMER_1_YEAR_BY_OTHER 159
7329
7333#define DC_STR_BACKUP_TRANSFER_QR 162
7334
7338#define DC_STR_BACKUP_TRANSFER_MSG_BODY 163
7339
7343#define DC_STR_CHAT_PROTECTION_ENABLED 170
7344
7348#define DC_STR_NEW_GROUP_SEND_FIRST_MESSAGE 172
7349
7355#define DC_STR_MESSAGE_ADD_MEMBER 173
7356
7362#define DC_STR_INVALID_UNENCRYPTED_MAIL 174
7363
7370#define DC_STR_YOU_REACTED 176
7371
7379#define DC_STR_REACTED_BY 177
7380
7384#define DC_STR_REMOVE_MEMBER 178
7385
7389#define DC_STR_SECUREJOIN_WAIT 190
7390
7392#define DC_STR_DONATION_REQUEST 193
7393
7395#define DC_STR_DECLINED_CALL 196
7396
7398#define DC_STR_CANCELED_CALL 197
7399
7401#define DC_STR_MISSED_CALL 198
7402
7406#define DC_STR_CHANNEL_LEFT_BY_YOU 200
7407
7413#define DC_STR_SECURE_JOIN_CHANNEL_QR_DESC 201
7414
7416#define DC_STR_MSG_YOU_JOINED_CHANNEL 202
7417
7423#define DC_STR_SECURE_JOIN_CHANNEL_STARTED 203
7424
7431#define DC_STR_CHANNEL_NAME_CHANGED 204
7432
7436#define DC_STR_CHANNEL_IMAGE_CHANGED 205
7437
7441#define DC_STR_STATS_MSG_BODY 210
7442
7446#define DC_STR_PROXY_ENABLED 220
7447
7451#define DC_STR_PROXY_ENABLED_DESCRIPTION 221
7452
7456#define DC_STR_CHAT_UNENCRYPTED_EXPLANATON 230
7457
7459#define DC_STR_OUTGOING_AUDIO_CALL 232
7460
7462#define DC_STR_OUTGOING_VIDEO_CALL 233
7463
7465#define DC_STR_INCOMING_AUDIO_CALL 234
7466
7468#define DC_STR_INCOMING_VIDEO_CALL 235
7469
7471#define DC_STR_GROUP_DESCRIPTION_CHANGED_BY_YOU 240
7472
7474#define DC_STR_GROUP_DESCRIPTION_CHANGED_BY_OTHER 241
7475
7479#define DC_STR_MESSAGES_ARE_E2EE 242
7480
7484
7485
7486#ifdef PY_CFFI_INC
7487/* Helper utility to locate the header file when building python bindings. */
7488char* _dc_header_file_location(void) {
7489 return __FILE__;
7490}
7491#endif
7492
7493
7494#ifdef __cplusplus
7495}
7496#endif
7497#endif // __DELTACHAT_H__
This class provides functionality that can be used to manage several dc_context_t objects running at ...
int dc_accounts_select_account(dc_accounts_t *accounts, uint32_t account_id)
Change the selected account.
void dc_accounts_unref(dc_accounts_t *accounts)
Free an account manager object.
dc_event_emitter_t * dc_accounts_get_event_emitter(dc_accounts_t *accounts)
Create the event emitter that is used to receive events.
dc_context_t * dc_accounts_get_selected_account(dc_accounts_t *accounts)
Get the currently selected account.
void dc_accounts_maybe_network(dc_accounts_t *accounts)
This function should be called when there is a hint that the network is available again.
uint32_t dc_accounts_migrate_account(dc_accounts_t *accounts, const char *dbfile)
Migrate independent accounts into accounts managed by the account manager.
int dc_accounts_background_fetch(dc_accounts_t *accounts, uint64_t timeout)
Perform a background fetch for all accounts in parallel with a timeout.
dc_accounts_t * dc_accounts_new_with_event_channel(const char *dir, int writable, dc_event_channel_t *events_channel)
Create a new account manager with an existing events channel, which allows you to see events emitted ...
dc_context_t * dc_accounts_get_account(dc_accounts_t *accounts, uint32_t account_id)
Get an account context from an account ID.
dc_array_t * dc_accounts_get_all(dc_accounts_t *accounts)
List all accounts.
dc_jsonrpc_instance_t * dc_jsonrpc_init(dc_accounts_t *account_manager)
Create the jsonrpc instance that is used to call the jsonrpc.
void dc_accounts_set_push_device_token(dc_accounts_t *accounts, const char *token)
Sets device token for Apple Push Notification service.
void dc_accounts_start_io(dc_accounts_t *accounts)
Start job and IMAP/SMTP tasks for all accounts managed by the account manager.
void dc_accounts_stop_io(dc_accounts_t *accounts)
Stop job and IMAP/SMTP tasks for all accounts and return when they are finished.
void dc_accounts_maybe_network_lost(dc_accounts_t *accounts)
This function can be called when there is a hint that the network is lost.
uint32_t dc_accounts_add_account(dc_accounts_t *accounts)
Add a new account to the account manager.
dc_accounts_t * dc_accounts_new(const char *dir, int writable)
Create a new account manager.
void dc_accounts_stop_background_fetch(dc_accounts_t *accounts)
Stop ongoing background fetch.
uint32_t dc_accounts_add_closed_account(dc_accounts_t *accounts)
Add a new closed account to the account manager.
int dc_accounts_remove_account(dc_accounts_t *accounts, uint32_t account_id)
Remove an account from the account manager.
An object containing a simple array.
void dc_array_unref(dc_array_t *array)
Free an array object.
double dc_array_get_accuracy(const dc_array_t *array, size_t index)
Return the accuracy of the item at the given index.
int64_t dc_array_get_timestamp(const dc_array_t *array, size_t index)
Return the timestamp of the item at the given index.
uint32_t dc_array_get_chat_id(const dc_array_t *array, size_t index)
Return the chat ID of the item at the given index.
int dc_array_is_independent(const dc_array_t *array, size_t index)
Return the independent-state of the location at the given index.
uint32_t dc_array_get_msg_id(const dc_array_t *array, size_t index)
Return the message ID of the item at the given index.
uint32_t dc_array_get_contact_id(const dc_array_t *array, size_t index)
Return the contact ID of the item at the given index.
double dc_array_get_longitude(const dc_array_t *array, size_t index)
Return the longitude of the item at the given index.
size_t dc_array_get_cnt(const dc_array_t *array)
Find out the number of items in an array.
uint32_t dc_array_get_id(const dc_array_t *array, size_t index)
Get the item at the given index as an ID.
char * dc_array_get_marker(const dc_array_t *array, size_t index)
Return the marker-character of the item at the given index.
double dc_array_get_latitude(const dc_array_t *array, size_t index)
Return the latitude of the item at the given index.
Set up another device.
char * dc_backup_provider_get_qr(const dc_backup_provider_t *backup_provider)
Returns the QR code text that will offer the backup to other devices.
void dc_backup_provider_unref(dc_backup_provider_t *backup_provider)
Frees a dc_backup_provider_t object.
void dc_backup_provider_wait(dc_backup_provider_t *backup_provider)
Waits for the sending to finish.
char * dc_backup_provider_get_qr_svg(const dc_backup_provider_t *backup_provider)
Returns the QR code SVG image that will offer the backup to other devices.
dc_backup_provider_t * dc_backup_provider_new(dc_context_t *context)
Creates an object for sending a backup to another device.
An object representing a single chat in memory.
char * dc_chat_get_name(const dc_chat_t *chat)
Get name of a chat.
int dc_chat_is_sending_locations(const dc_chat_t *chat)
Check if locations are sent to the chat at the time the object was created using dc_get_chat().
int dc_chat_get_type(const dc_chat_t *chat)
Get chat type as one of the DC_CHAT_TYPE constants.
char * dc_chat_get_mailinglist_addr(const dc_chat_t *chat)
Returns the address where messages are sent to if the chat is a mailing list.
uint32_t dc_chat_get_id(const dc_chat_t *chat)
Get the chat ID.
int dc_chat_is_device_talk(const dc_chat_t *chat)
Check if a chat is a device-talk.
int64_t dc_chat_get_remaining_mute_duration(const dc_chat_t *chat)
Get the exact state of the mute of a chat.
int dc_chat_is_contact_request(const dc_chat_t *chat)
Check if a chat is a contact request chat.
int dc_chat_get_visibility(const dc_chat_t *chat)
Get visibility of chat.
void dc_chat_unref(dc_chat_t *chat)
Free a chat object.
int dc_chat_is_unpromoted(const dc_chat_t *chat)
Check if a group chat is still unpromoted.
uint32_t dc_chat_get_color(const dc_chat_t *chat)
Get a color for the chat.
int dc_chat_can_send(const dc_chat_t *chat)
Check if messages can be sent to a given chat.
int dc_chat_is_self_talk(const dc_chat_t *chat)
Check if a chat is a self talk.
char * dc_chat_get_profile_image(const dc_chat_t *chat)
Get the chat's profile image.
int dc_chat_is_protected(const dc_chat_t *chat)
Deprecated, always returns 0.
int dc_chat_is_muted(const dc_chat_t *chat)
Check whether the chat is currently muted (can be changed by dc_set_chat_mute_duration()).
int dc_chat_is_encrypted(const dc_chat_t *chat)
Check if the chat is encrypted.
An object representing a single chatlist in memory.
uint32_t dc_chatlist_get_msg_id(const dc_chatlist_t *chatlist, size_t index)
Get a single message ID of a chatlist.
void dc_chatlist_unref(dc_chatlist_t *chatlist)
Free a chatlist object.
dc_lot_t * dc_chatlist_get_summary(const dc_chatlist_t *chatlist, size_t index, dc_chat_t *chat)
Get a summary for a chatlist index.
dc_context_t * dc_chatlist_get_context(dc_chatlist_t *chatlist)
Helper function to get the associated context object.
uint32_t dc_chatlist_get_chat_id(const dc_chatlist_t *chatlist, size_t index)
Get a single chat ID of a chatlist.
size_t dc_chatlist_get_cnt(const dc_chatlist_t *chatlist)
Find out the number of chats in a chatlist.
An object representing a single contact in memory.
char * dc_contact_get_addr(const dc_contact_t *contact)
Get the e-mail address of a contact.
char * dc_contact_get_name_n_addr(const dc_contact_t *contact)
Get a summary of name and address.
int dc_contact_is_verified(dc_contact_t *contact)
Check if the contact can be added to protected chats.
int dc_contact_is_key_contact(dc_contact_t *contact)
Returns whether contact is a key-contact, i.e.
char * dc_contact_get_profile_image(const dc_contact_t *contact)
Get the contact's profile image.
void dc_contact_unref(dc_contact_t *contact)
Free a contact object.
char * dc_contact_get_auth_name(const dc_contact_t *contact)
Get original contact name.
int64_t dc_contact_get_last_seen(const dc_contact_t *contact)
Get the contact's last seen timestamp.
uint32_t dc_contact_get_verifier_id(dc_contact_t *contact)
Return the contact ID that verified a contact.
char * dc_contact_get_status(const dc_contact_t *contact)
Get the contact's status.
int dc_contact_is_blocked(const dc_contact_t *contact)
Check if a contact is blocked.
char * dc_contact_get_name(const dc_contact_t *contact)
Get the edited contact name.
char * dc_contact_get_display_name(const dc_contact_t *contact)
Get display name.
uint32_t dc_contact_get_color(const dc_contact_t *contact)
Get a color for the contact.
uint32_t dc_contact_get_id(const dc_contact_t *contact)
Get the ID of a contact.
int dc_contact_is_bot(dc_contact_t *contact)
Returns whether contact is a bot.
int dc_contact_was_seen_recently(const dc_contact_t *contact)
Check if the contact was seen recently.
An object representing a single account.
char * dc_imex_has_backup(dc_context_t *context, const char *dir)
Check if there is a backup file.
int dc_add_address_book(dc_context_t *context, const char *addr_book)
Add a number of contacts.
int dc_get_msg_cnt(dc_context_t *context, uint32_t chat_id)
Get the total number of messages in a chat.
dc_context_t * dc_context_new_closed(const char *dbfile)
Create a new context object.
char * dc_make_vcard(dc_context_t *context, uint32_t contact_id)
Make a vCard.
dc_array_t * dc_get_contacts(dc_context_t *context, uint32_t flags, const char *query)
Returns known and unblocked contacts.
void dc_set_draft(dc_context_t *context, uint32_t chat_id, dc_msg_t *msg)
Save a draft for a chat in the database.
uint32_t dc_add_device_msg(dc_context_t *context, const char *label, dc_msg_t *msg)
Add a message to the device-chat.
void dc_send_delete_request(dc_context_t *context, const uint32_t *msg_ids, int msg_cnt)
Send chat members a request to delete the given messages.
dc_chatlist_t * dc_get_chatlist(dc_context_t *context, int flags, const char *query_str, uint32_t query_id)
Get a list of chats.
dc_array_t * dc_get_next_msgs(dc_context_t *context)
Returns the message IDs of all messages of any chat with a database ID higher than last_msg_id config...
uint32_t dc_init_webxdc_integration(dc_context_t *context, uint32_t chat_id)
Init a Webxdc integration.
char * dc_get_contact_encrinfo(dc_context_t *context, uint32_t contact_id)
Get encryption info for a contact.
uint32_t dc_lookup_contact_id_by_addr(dc_context_t *context, const char *addr)
Looks up a known and unblocked contact with a given e-mail address.
int dc_set_chat_profile_image(dc_context_t *context, uint32_t chat_id, const char *image)
Set group or broadcast channel profile image.
uint32_t dc_send_text_msg(dc_context_t *context, uint32_t chat_id, const char *text_to_send)
Send a simple text message a given chat.
void dc_maybe_network(dc_context_t *context)
This function should be called when there is a hint that the network is available again,...
int dc_was_device_msg_ever_added(dc_context_t *context, const char *label)
Check if a device-message with a given label was ever added.
uint32_t dc_get_chat_ephemeral_timer(dc_context_t *context, uint32_t chat_id)
Get the chat's ephemeral message timer.
dc_array_t * dc_get_chat_media(dc_context_t *context, uint32_t chat_id, int msg_type, int msg_type2, int msg_type3)
Returns all message IDs of the given types in a given chat or any chat.
dc_lot_t * dc_check_qr(dc_context_t *context, const char *qr)
Check a scanned QR code.
dc_array_t * dc_get_locations(dc_context_t *context, uint32_t chat_id, uint32_t contact_id, int64_t timestamp_begin, int64_t timestamp_end)
Get shared locations from the database.
void dc_send_locations_to_chat(dc_context_t *context, uint32_t chat_id, int seconds)
Enable or disable location streaming for a chat.
dc_contact_t * dc_get_contact(dc_context_t *context, uint32_t contact_id)
Get a single contact object.
void dc_stop_io(dc_context_t *context)
Stop job, IMAP, SMTP and other tasks and return when they are finished.
dc_msg_t * dc_get_draft(dc_context_t *context, uint32_t chat_id)
Get draft for a chat, if any.
int dc_preconfigure_keypair(dc_context_t *context, const char *secret_data)
Save a keypair as the default keys for the user.
char * dc_create_qr_svg(const char *payload)
Create a QR code from any input data.
char * dc_get_blobdir(const dc_context_t *context)
Get the blob directory.
dc_array_t * dc_get_blocked_contacts(dc_context_t *context)
Get blocked contacts.
void dc_context_unref(dc_context_t *context)
Free a context object.
void dc_stop_ongoing_process(dc_context_t *context)
Signal an ongoing process to stop.
dc_msg_t * dc_get_msg(dc_context_t *context, uint32_t msg_id)
Get a single message object of the type dc_msg_t.
void dc_markfresh_chat(dc_context_t *context, uint32_t chat_id)
Mark the last incoming message in chat as fresh.
dc_array_t * dc_get_chat_msgs(dc_context_t *context, uint32_t chat_id, uint32_t flags, uint32_t marker1before)
Get all message IDs belonging to a chat.
char * dc_get_info(const dc_context_t *context)
Get information about the context.
int dc_receive_backup(dc_context_t *context, const char *qr)
Gets a backup offered by a dc_backup_provider_t object on another device.
int dc_is_sending_locations_to_chat(dc_context_t *context, uint32_t chat_id)
Check if location streaming is enabled.
void dc_block_chat(dc_context_t *context, uint32_t chat_id)
Block a chat.
char * dc_get_securejoin_qr(dc_context_t *context, uint32_t chat_id)
Get QR code text that will offer an Setup-Contact or Verified-Group invitation.
int dc_end_call(dc_context_t *context, uint32_t msg_id)
End incoming or outgoing call.
dc_array_t * dc_get_fresh_msgs(dc_context_t *context)
Returns the message IDs of all fresh messages of any chat.
int dc_set_stock_translation(dc_context_t *context, uint32_t stock_id, const char *stock_msg)
Set stock string translation.
void dc_set_webxdc_integration(dc_context_t *context, const char *file)
Set Webxdc file as integration.
int dc_set_chat_mute_duration(dc_context_t *context, uint32_t chat_id, int64_t duration)
Set mute duration of a chat.
dc_array_t * dc_wait_next_msgs(dc_context_t *context)
Waits for notification of new messages and returns an array of new message IDs.
int dc_get_fresh_msg_cnt(dc_context_t *context, uint32_t chat_id)
Get the number of fresh messages in a chat.
int dc_set_chat_name(dc_context_t *context, uint32_t chat_id, const char *name)
Set the name of a group or broadcast channel.
uint32_t dc_create_broadcast_list(dc_context_t *context)
Create a new broadcast list.
void dc_marknoticed_chat(dc_context_t *context, uint32_t chat_id)
Mark all messages in a chat as noticed.
int dc_set_chat_ephemeral_timer(dc_context_t *context, uint32_t chat_id, uint32_t timer)
Set the chat's ephemeral message timer.
int dc_remove_contact_from_chat(dc_context_t *context, uint32_t chat_id, uint32_t contact_id)
Remove a member from a group.
dc_array_t * dc_search_msgs(dc_context_t *context, uint32_t chat_id, const char *query)
Search messages containing the given query string.
int dc_may_be_valid_addr(const char *addr)
Rough check if a string may be a valid e-mail address.
int dc_is_configured(const dc_context_t *context)
Check if the context is already configured.
int dc_estimate_deletion_cnt(dc_context_t *context, int from_server, int64_t seconds)
Estimate the number of messages that will be deleted by the dc_set_config()-option delete_device_afte...
int dc_get_connectivity(dc_context_t *context)
Get the current connectivity, i.e.
char * dc_get_last_error(dc_context_t *context)
Get last error string.
char * dc_get_oauth2_url(dc_context_t *context, const char *addr, const char *redirect_uri)
Get URL that can be used to initiate an OAuth2 authorization.
uint32_t dc_get_chat_id_by_contact_id(dc_context_t *context, uint32_t contact_id)
Check, if there is a normal chat with a given contact.
char * dc_get_config(dc_context_t *context, const char *key)
Get a configuration option.
int dc_set_location(dc_context_t *context, double latitude, double longitude, double accuracy)
Set current location.
void dc_set_chat_visibility(dc_context_t *context, uint32_t chat_id, int visibility)
Set chat visibility to pinned, archived or normal.
int dc_get_push_state(dc_context_t *context)
Get the current push notification state.
int dc_add_contact_to_chat(dc_context_t *context, uint32_t chat_id, uint32_t contact_id)
Add a member to a group.
char * dc_get_msg_info(dc_context_t *context, uint32_t msg_id)
Get an informational text for a single message.
char * dc_get_connectivity_html(dc_context_t *context)
Get an overview of the current connectivity, and possibly more statistics.
dc_array_t * dc_get_chat_contacts(dc_context_t *context, uint32_t chat_id)
Get the contact IDs belonging to a chat.
dc_chat_t * dc_get_chat(dc_context_t *context, uint32_t chat_id)
Get a chat object by a chat ID.
uint32_t dc_get_id(dc_context_t *context)
Get the ID of a context object.
dc_context_t * dc_context_new(const char *os_name, const char *dbfile, const char *blobdir)
Create a new context object and try to open it.
uint32_t dc_send_msg_sync(dc_context_t *context, uint32_t chat_id, dc_msg_t *msg)
Send a message defined by a dc_msg_t object to a chat, synchronously.
uint32_t dc_create_contact(dc_context_t *context, const char *name, const char *addr)
Add a single contact as a result of an explicit user action.
uint32_t dc_send_msg(dc_context_t *context, uint32_t chat_id, dc_msg_t *msg)
Send a message defined by a dc_msg_t object to a chat.
void dc_download_full_msg(dc_context_t *context, int msg_id)
Asks the core to start downloading a message fully.
char * dc_get_msg_html(dc_context_t *context, uint32_t msg_id)
Get uncut message, if available.
dc_event_emitter_t * dc_get_event_emitter(dc_context_t *context)
Create the event emitter that is used to receive events.
void dc_start_io(dc_context_t *context)
Start job and IMAP/SMTP tasks.
void dc_imex(dc_context_t *context, int what, const char *param1, const char *param2)
Import/export things.
char * dc_get_securejoin_qr_svg(dc_context_t *context, uint32_t chat_id)
Get QR code image from the QR code text generated by dc_get_securejoin_qr().
dc_array_t * dc_import_vcard(dc_context_t *context, const char *vcard)
Import a vCard.
char * dc_get_webxdc_status_updates(dc_context_t *context, uint32_t msg_id, uint32_t serial)
Get webxdc status updates.
dc_lot_t * dc_chatlist_get_summary2(dc_context_t *context, uint32_t chat_id, uint32_t msg_id)
Create a chatlist summary item when the chatlist object is already unref()'d.
uint32_t dc_create_chat_by_contact_id(dc_context_t *context, uint32_t contact_id)
Create a normal chat with a single user.
void dc_forward_msgs(dc_context_t *context, const uint32_t *msg_ids, int msg_cnt, uint32_t chat_id)
Forward messages to another chat.
int dc_send_webxdc_status_update(dc_context_t *context, uint32_t msg_id, const char *json, const char *descr)
A webxdc instance sends a status update to its other members.
dc_chatlist_t * dc_get_similar_chatlist(dc_context_t *context, uint32_t chat_id)
Returns a list of similar chats.
void dc_save_msgs(dc_context_t *context, const uint32_t *msg_ids, int msg_cnt)
Save a copy of messages in "Saved Messages".
int dc_set_config_from_qr(dc_context_t *context, const char *qr)
Set configuration values from a QR code.
void dc_str_unref(char *str)
Release a string returned by another deltachat-core function.
void dc_send_edit_request(dc_context_t *context, uint32_t msg_id, const char *new_text)
Send chat members a request to edit the given message's text.
int dc_delete_contact(dc_context_t *context, uint32_t contact_id)
Delete a contact so that it disappears from the corresponding lists.
void dc_delete_chat(dc_context_t *context, uint32_t chat_id)
Delete a chat.
void dc_block_contact(dc_context_t *context, uint32_t contact_id, int block)
Block or unblock a contact.
int dc_resend_msgs(dc_context_t *context, const uint32_t *msg_ids, int msg_cnt)
Resend messages and make information available for newly added chat members.
void dc_delete_msgs(dc_context_t *context, const uint32_t *msg_ids, int msg_cnt)
Delete messages.
void dc_configure(dc_context_t *context)
Configure a context.
uint32_t dc_join_securejoin(dc_context_t *context, const char *qr)
Continue a Setup-Contact or Verified-Group-Invite protocol started on another device with dc_get_secu...
void dc_markseen_msgs(dc_context_t *context, const uint32_t *msg_ids, int msg_cnt)
Mark messages as presented to the user.
uint32_t dc_create_group_chat(dc_context_t *context, int protect, const char *name)
Create a new group chat.
int dc_is_contact_in_chat(dc_context_t *context, uint32_t chat_id, uint32_t contact_id)
Check if a given contact ID is a member of a group chat.
int dc_context_is_open(dc_context_t *context)
Returns 1 if database is open.
int dc_accept_incoming_call(dc_context_t *context, uint32_t msg_id, const char *accept_call_info)
Accept incoming call.
void dc_accept_chat(dc_context_t *context, uint32_t chat_id)
Accept a contact request chat.
int dc_context_open(dc_context_t *context, const char *passphrase)
Opens the database with the given passphrase.
int dc_context_change_passphrase(dc_context_t *context, const char *passphrase)
Changes the passphrase on the open database.
char * dc_get_chat_encrinfo(dc_context_t *context, uint32_t chat_id)
Get encryption info for a chat.
uint32_t dc_place_outgoing_call(dc_context_t *context, uint32_t chat_id, const char *place_call_info, int has_video)
Start an outgoing call.
int dc_set_config(dc_context_t *context, const char *key, const char *value)
Configure the context.
Opaque object that is used to create an event emitter which can be used log events during startup of ...
dc_event_channel_t * dc_event_channel_new(void)
Create a new event channel.
dc_event_emitter_t * dc_event_channel_get_event_emitter(dc_event_channel_t *event_channel)
Create the event emitter that is used to receive events.
void dc_event_channel_unref(dc_event_channel_t *event_channel)
Release/free the events channel structure.
Opaque object that is used to get events from a single context.
void dc_event_emitter_unref(dc_event_emitter_t *emitter)
Free a context event emitter object.
dc_event_t * dc_get_next_event(dc_event_emitter_t *emitter)
Get the next event from a context event emitter object.
Opaque object describing a single event.
void dc_event_unref(dc_event_t *event)
Free memory used by an event object.
int dc_event_get_data2_int(dc_event_t *event)
Get data associated with an event object.
char * dc_event_get_data1_str(dc_event_t *event)
Get data associated with an event object.
char * dc_event_get_data2_str(dc_event_t *event)
Get data associated with an event object.
uint32_t dc_event_get_account_id(dc_event_t *event)
Get the account ID this event belongs to.
int dc_event_get_id(dc_event_t *event)
Get the event ID from an event object.
int dc_event_get_data1_int(dc_event_t *event)
Get data associated with an event object.
Opaque object for using the json rpc api from the cffi bindings.
char * dc_jsonrpc_next_response(dc_jsonrpc_instance_t *jsonrpc_instance)
Get the next json_rpc response, blocks until there is a new event, so call this in a loop from a thre...
void dc_jsonrpc_unref(dc_jsonrpc_instance_t *jsonrpc_instance)
Free a jsonrpc instance.
char * dc_jsonrpc_blocking_call(dc_jsonrpc_instance_t *jsonrpc_instance, const char *input)
Make a JSON-RPC call and return a response.
void dc_jsonrpc_request(dc_jsonrpc_instance_t *jsonrpc_instance, const char *request)
Makes an asynchronous jsonrpc request, returns immediately and once the result is ready it can be ret...
An object containing a set of values.
int64_t dc_lot_get_timestamp(const dc_lot_t *lot)
Get the associated timestamp.
int dc_lot_get_state(const dc_lot_t *lot)
Get the associated state.
uint32_t dc_lot_get_id(const dc_lot_t *lot)
Get the associated ID.
int dc_lot_get_text1_meaning(const dc_lot_t *lot)
Get the meaning of the first string.
void dc_lot_unref(dc_lot_t *lot)
Frees an object containing a set of parameters.
char * dc_lot_get_text1(const dc_lot_t *lot)
Get first string.
char * dc_lot_get_text2(const dc_lot_t *lot)
Get second string.
An object representing a single message in memory.
void dc_msg_set_html(dc_msg_t *msg, const char *html)
Set the HTML part of a message object.
char * dc_msg_get_webxdc_blob(const dc_msg_t *msg, const char *filename, size_t *ret_bytes)
Return a file from inside a webxdc message.
uint32_t dc_msg_get_ephemeral_timer(const dc_msg_t *msg)
Get the ephemeral timer duration for a message.
char * dc_msg_get_filename(const dc_msg_t *msg)
Get an original attachment filename, with extension but without the path.
void dc_msg_set_override_sender_name(dc_msg_t *msg, const char *name)
Set different sender name for a message.
char * dc_msg_get_summarytext(const dc_msg_t *msg, int approx_characters)
Get a message summary as a single line of text.
int dc_msg_get_showpadlock(const dc_msg_t *msg)
Check if message was correctly encrypted and signed.
dc_lot_t * dc_msg_get_summary(const dc_msg_t *msg, const dc_chat_t *chat)
Get a summary for a message.
uint32_t dc_msg_get_chat_id(const dc_msg_t *msg)
Get the ID of the chat the message belongs to.
void dc_msg_set_quote(dc_msg_t *msg, const dc_msg_t *quote)
Set the message replying to.
int dc_msg_has_location(const dc_msg_t *msg)
Check if a message has a POI location bound to it.
char * dc_msg_get_text(const dc_msg_t *msg)
Get the text of the message.
uint32_t dc_msg_get_from_id(const dc_msg_t *msg)
Get the ID of the contact who wrote the message.
int64_t dc_msg_get_ephemeral_timestamp(const dc_msg_t *msg)
Get the timestamp of the ephemeral message removal.
int dc_msg_get_download_state(const dc_msg_t *msg)
Check if the message is completely downloaded or if some further action is needed.
void dc_msg_set_duration(dc_msg_t *msg, int duration)
Set the duration associated with message object.
void dc_msg_set_file_and_deduplicate(dc_msg_t *msg, const char *file, const char *name, const char *filemime)
Sets the file associated with a message.
int dc_msg_save_file(const dc_msg_t *msg, const char *path)
Save file copy at the user-provided path.
void dc_msg_set_text(dc_msg_t *msg, const char *text)
Set the text of a message object.
int64_t dc_msg_get_timestamp(const dc_msg_t *msg)
Get the message sending time.
uint32_t dc_msg_get_original_msg_id(const dc_msg_t *msg)
Get original message ID for a saved message from the "Saved Messages" chat.
char * dc_msg_get_quoted_text(const dc_msg_t *msg)
Get quoted text, if any.
char * dc_msg_get_override_sender_name(const dc_msg_t *msg)
Get the name that should be shown over the message (in a group chat) instead of the contact display n...
void dc_msg_set_subject(dc_msg_t *msg, const char *subject)
Sets the email's subject.
int dc_msg_get_width(const dc_msg_t *msg)
Get the width of an image or a video.
char * dc_msg_get_filemime(const dc_msg_t *msg)
Get the MIME type of a file.
void dc_msg_unref(dc_msg_t *msg)
Free a message object.
char * dc_msg_get_webxdc_href(const dc_msg_t *msg)
Get link attached to an webxdc info message.
int dc_msg_is_bot(const dc_msg_t *msg)
Check if an incoming message is a bot message, i.e.
void dc_msg_set_dimension(dc_msg_t *msg, int width, int height)
Set the dimensions associated with message object.
int dc_msg_is_forwarded(const dc_msg_t *msg)
Check if the message is a forwarded message.
int dc_msg_has_deviating_timestamp(const dc_msg_t *msg)
Check if a message has a deviating timestamp.
int dc_msg_is_info(const dc_msg_t *msg)
Check if the message is an informational message, created by the device or by another users.
void dc_msg_latefiling_mediasize(dc_msg_t *msg, int width, int height, int duration)
Late filing information to a message.
int dc_msg_is_edited(const dc_msg_t *msg)
Check if the message was edited.
int dc_msg_get_state(const dc_msg_t *msg)
Get the state of a message.
void dc_msg_set_location(dc_msg_t *msg, double latitude, double longitude)
Set any location that should be bound to the message object.
uint64_t dc_msg_get_filebytes(const dc_msg_t *msg)
Get the size of the file.
char * dc_msg_get_subject(const dc_msg_t *msg)
Get the subject of the e-mail.
dc_msg_t * dc_msg_get_quoted_msg(const dc_msg_t *msg)
Get quoted message, if available.
uint32_t dc_msg_get_info_contact_id(const dc_msg_t *msg)
Return the contact ID of the profile to open when tapping the info message.
dc_msg_t * dc_msg_get_parent(const dc_msg_t *msg)
Get parent message, if available.
dc_msg_t * dc_msg_new(dc_context_t *context, int viewtype)
Create new message object.
int dc_msg_has_html(dc_msg_t *msg)
Checks if the message has a full HTML version.
int dc_msg_get_duration(const dc_msg_t *msg)
Get the duration of audio or video.
uint32_t dc_msg_get_id(const dc_msg_t *msg)
Get the ID of the message.
uint32_t dc_msg_get_saved_msg_id(const dc_msg_t *msg)
Check if a message was saved and return its ID inside "Saved Messages".
int dc_msg_get_info_type(const dc_msg_t *msg)
Get the type of an informational message.
int dc_msg_get_viewtype(const dc_msg_t *msg)
Get the type of the message.
int64_t dc_msg_get_sort_timestamp(const dc_msg_t *msg)
Get the message time used for sorting.
int dc_msg_get_height(const dc_msg_t *msg)
Get the height of an image or a video.
char * dc_msg_get_error(const dc_msg_t *msg)
Gets the error status of the message.
int dc_msg_is_sent(const dc_msg_t *msg)
Check if a message was sent successfully.
char * dc_msg_get_file(const dc_msg_t *msg)
Find out full path of the file associated with a message.
int64_t dc_msg_get_received_timestamp(const dc_msg_t *msg)
Get the message receive time.
char * dc_msg_get_webxdc_info(const dc_msg_t *msg)
Get info from a webxdc message, in JSON format.
Opaque object containing information about one single e-mail provider.
int dc_provider_get_status(const dc_provider_t *provider)
Whether DC works with this provider.
char * dc_provider_get_before_login_hint(const dc_provider_t *provider)
Get hints to be shown to the user on the login screen.
char * dc_provider_get_overview_page(const dc_provider_t *provider)
URL of the overview page.
dc_provider_t * dc_provider_new_from_email_with_dns(const dc_context_t *context, const char *email)
Create a provider struct for the given e-mail address by local lookup.
dc_provider_t * dc_provider_new_from_email(const dc_context_t *context, const char *email)
Create a provider struct for the given e-mail address by local lookup.
void dc_provider_unref(dc_provider_t *provider)
Free the provider info struct.