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_jsonrpc_instance dc_jsonrpc_instance_t;
26typedef struct _dc_backup_provider dc_backup_provider_t;
27
28// Alias for backwards compatibility, use dc_event_emitter_t instead.
29typedef struct _dc_event_emitter dc_accounts_event_emitter_t;
30
247// create/open/config/information
248
264dc_context_t* dc_context_new (const char* os_name, const char* dbfile, const char* blobdir);
265
266
283
284
299int dc_context_open (dc_context_t *context, const char* passphrase);
300
301
312int dc_context_change_passphrase (dc_context_t* context, const char* passphrase);
313
314
323
324
337
338
350uint32_t dc_get_id (dc_context_t* context);
351
352
373
374
383char* dc_get_blobdir (const dc_context_t* context);
384
385
534int dc_set_config (dc_context_t* context, const char* key, const char* value);
535
536
562char* dc_get_config (dc_context_t* context, const char* key);
563
564
576int dc_set_stock_translation(dc_context_t* context, uint32_t stock_id, const char* stock_msg);
577
578
593int dc_set_config_from_qr (dc_context_t* context, const char* qr);
594
595
610char* dc_get_info (const dc_context_t* context);
611
612
642char* dc_get_oauth2_url (dc_context_t* context, const char* addr, const char* redirect_uri);
643
644
645#define DC_CONNECTIVITY_NOT_CONNECTED 1000
646#define DC_CONNECTIVITY_CONNECTING 2000
647#define DC_CONNECTIVITY_WORKING 3000
648#define DC_CONNECTIVITY_CONNECTED 4000
649
650
672
673
690
691
692#define DC_PUSH_NOT_CONNECTED 0
693#define DC_PUSH_HEARTBEAT 1
694#define DC_PUSH_CONNECTED 2
695
708
709
713int dc_all_work_done (dc_context_t* context);
714
715
716// connect
717
769
770
790int dc_is_configured (const dc_context_t* context);
791
792
803void dc_start_io (dc_context_t* context);
804
820
844
845
846
865int dc_preconfigure_keypair (dc_context_t* context, const char *addr, const char *public_data, const char *secret_data);
866
867
868// handle chatlists
869
870#define DC_GCL_ARCHIVED_ONLY 0x01
871#define DC_GCL_NO_SPECIALS 0x02
872#define DC_GCL_ADD_ALLDONE_HINT 0x04
873#define DC_GCL_FOR_FORWARDING 0x08
874
875
925dc_chatlist_t* dc_get_chatlist (dc_context_t* context, int flags, const char* query_str, uint32_t query_id);
926
927
928// handle chats
929
943uint32_t dc_create_chat_by_contact_id (dc_context_t* context, uint32_t contact_id);
944
945
957uint32_t dc_get_chat_id_by_contact_id (dc_context_t* context, uint32_t contact_id);
958
959
1005uint32_t dc_prepare_msg (dc_context_t* context, uint32_t chat_id, dc_msg_t* msg);
1006
1007
1045uint32_t dc_send_msg (dc_context_t* context, uint32_t chat_id, dc_msg_t* msg);
1046
1062uint32_t dc_send_msg_sync (dc_context_t* context, uint32_t chat_id, dc_msg_t* msg);
1063
1064
1084uint32_t dc_send_text_msg (dc_context_t* context, uint32_t chat_id, const char* text_to_send);
1085
1086
1120uint32_t dc_send_videochat_invitation (dc_context_t* context, uint32_t chat_id);
1121
1122
1150int dc_send_webxdc_status_update (dc_context_t* context, uint32_t msg_id, const char* json, const char* descr);
1151
1152
1183char* dc_get_webxdc_status_updates (dc_context_t* context, uint32_t msg_id, uint32_t serial);
1184
1185
1196void dc_set_webxdc_integration (dc_context_t* context, const char* file);
1197
1198
1241uint32_t dc_init_webxdc_integration (dc_context_t* context, uint32_t chat_id);
1242
1243
1267void dc_set_draft (dc_context_t* context, uint32_t chat_id, dc_msg_t* msg);
1268
1269
1317uint32_t dc_add_device_msg (dc_context_t* context, const char* label, dc_msg_t* msg);
1318
1329int dc_was_device_msg_ever_added (dc_context_t* context, const char* label);
1330
1331
1344dc_msg_t* dc_get_draft (dc_context_t* context, uint32_t chat_id);
1345
1346
1347#define DC_GCM_ADDDAYMARKER 0x01
1348#define DC_GCM_INFO_ONLY 0x02
1349
1350
1371dc_array_t* dc_get_chat_msgs (dc_context_t* context, uint32_t chat_id, uint32_t flags, uint32_t marker1before);
1372
1373
1382int dc_get_msg_cnt (dc_context_t* context, uint32_t chat_id);
1383
1384
1402int dc_get_fresh_msg_cnt (dc_context_t* context, uint32_t chat_id);
1403
1404
1418
1419
1434int dc_estimate_deletion_cnt (dc_context_t* context, int from_server, int64_t seconds);
1435
1436
1456
1457
1481
1482
1506
1507
1521void dc_marknoticed_chat (dc_context_t* context, uint32_t chat_id);
1522
1523
1542dc_array_t* dc_get_chat_media (dc_context_t* context, uint32_t chat_id, int msg_type, int msg_type2, int msg_type3);
1543
1544
1566uint32_t dc_get_next_media (dc_context_t* context, uint32_t msg_id, int dir, int msg_type, int msg_type2, int msg_type3);
1567
1568
1580void dc_set_chat_visibility (dc_context_t* context, uint32_t chat_id, int visibility);
1581
1582
1608void dc_delete_chat (dc_context_t* context, uint32_t chat_id);
1609
1623void dc_block_chat (dc_context_t* context, uint32_t chat_id);
1624
1637void dc_accept_chat (dc_context_t* context, uint32_t chat_id);
1638
1661dc_array_t* dc_get_chat_contacts (dc_context_t* context, uint32_t chat_id);
1662
1673char* dc_get_chat_encrinfo (dc_context_t* context, uint32_t chat_id);
1674
1686uint32_t dc_get_chat_ephemeral_timer (dc_context_t* context, uint32_t chat_id);
1687
1710dc_array_t* dc_search_msgs (dc_context_t* context, uint32_t chat_id, const char* query);
1711
1712
1723dc_chat_t* dc_get_chat (dc_context_t* context, uint32_t chat_id);
1724
1725
1726// handle group chats
1727
1755uint32_t dc_create_group_chat (dc_context_t* context, int protect, const char* name);
1756
1757
1774
1775
1786int dc_is_contact_in_chat (dc_context_t* context, uint32_t chat_id, uint32_t contact_id);
1787
1788
1805int dc_add_contact_to_chat (dc_context_t* context, uint32_t chat_id, uint32_t contact_id);
1806
1807
1822int dc_remove_contact_from_chat (dc_context_t* context, uint32_t chat_id, uint32_t contact_id);
1823
1824
1839int dc_set_chat_name (dc_context_t* context, uint32_t chat_id, const char* name);
1840
1858int dc_set_chat_ephemeral_timer (dc_context_t* context, uint32_t chat_id, uint32_t timer);
1859
1879int dc_set_chat_profile_image (dc_context_t* context, uint32_t chat_id, const char* image);
1880
1881
1882
1904int dc_set_chat_mute_duration (dc_context_t* context, uint32_t chat_id, int64_t duration);
1905
1906// handle messages
1907
1920char* dc_get_msg_info (dc_context_t* context, uint32_t msg_id);
1921
1922
1970char* dc_get_msg_html (dc_context_t* context, uint32_t msg_id);
1971
1972
1992void dc_download_full_msg (dc_context_t* context, int msg_id);
1993
1994
2009char* dc_get_mime_headers (dc_context_t* context, uint32_t msg_id);
2010
2011
2021void dc_delete_msgs (dc_context_t* context, const uint32_t* msg_ids, int msg_cnt);
2022
2023
2038void dc_forward_msgs (dc_context_t* context, const uint32_t* msg_ids, int msg_cnt, uint32_t chat_id);
2039
2040
2057int dc_resend_msgs (dc_context_t* context, const uint32_t* msg_ids, int msg_cnt);
2058
2059
2090void dc_markseen_msgs (dc_context_t* context, const uint32_t* msg_ids, int msg_cnt);
2091
2092
2105dc_msg_t* dc_get_msg (dc_context_t* context, uint32_t msg_id);
2106
2107
2108// handle contacts
2109
2123int dc_may_be_valid_addr (const char* addr);
2124
2125
2139uint32_t dc_lookup_contact_id_by_addr (dc_context_t* context, const char* addr);
2140
2141
2162uint32_t dc_create_contact (dc_context_t* context, const char* name, const char* addr);
2163
2164
2165#define DC_GCL_VERIFIED_ONLY 0x01
2166#define DC_GCL_ADD_SELF 0x02
2167
2168
2192int dc_add_address_book (dc_context_t* context, const char* addr_book);
2193
2194
2211dc_array_t* dc_get_contacts (dc_context_t* context, uint32_t flags, const char* query);
2212
2213
2223
2224
2234
2235
2245void dc_block_contact (dc_context_t* context, uint32_t contact_id, int block);
2246
2247
2258char* dc_get_contact_encrinfo (dc_context_t* context, uint32_t contact_id);
2259
2260
2273int dc_delete_contact (dc_context_t* context, uint32_t contact_id);
2274
2275
2289dc_contact_t* dc_get_contact (dc_context_t* context, uint32_t contact_id);
2290
2291
2292// import/export and tools
2293
2294#define DC_IMEX_EXPORT_SELF_KEYS 1 // param1 is a directory where the keys are written to
2295#define DC_IMEX_IMPORT_SELF_KEYS 2 // param1 is a directory where the keys are searched in and read from
2296#define DC_IMEX_EXPORT_BACKUP 11 // param1 is a directory where the backup is written to, param2 is a passphrase to encrypt the backup
2297#define DC_IMEX_IMPORT_BACKUP 12 // param1 is the file with the backup to import, param2 is the backup's passphrase
2298
2299
2344void dc_imex (dc_context_t* context, int what, const char* param1, const char* param2);
2345
2346
2396char* dc_imex_has_backup (dc_context_t* context, const char* dir);
2397
2398
2444
2445
2466int dc_continue_key_transfer (dc_context_t* context, uint32_t msg_id, const char* setup_code);
2467
2468
2486
2487
2488// out-of-band verification
2489
2490#define DC_QR_ASK_VERIFYCONTACT 200 // id=contact
2491#define DC_QR_ASK_VERIFYGROUP 202 // text1=groupname
2492#define DC_QR_FPR_OK 210 // id=contact
2493#define DC_QR_FPR_MISMATCH 220 // id=contact
2494#define DC_QR_FPR_WITHOUT_ADDR 230 // test1=formatted fingerprint
2495#define DC_QR_ACCOUNT 250 // text1=domain
2496#define DC_QR_BACKUP 251
2497#define DC_QR_WEBRTC_INSTANCE 260 // text1=domain, text2=instance pattern
2498#define DC_QR_ADDR 320 // id=contact
2499#define DC_QR_TEXT 330 // text1=text
2500#define DC_QR_URL 332 // text1=URL
2501#define DC_QR_ERROR 400 // text1=error string
2502#define DC_QR_WITHDRAW_VERIFYCONTACT 500
2503#define DC_QR_WITHDRAW_VERIFYGROUP 502 // text1=groupname
2504#define DC_QR_REVIVE_VERIFYCONTACT 510
2505#define DC_QR_REVIVE_VERIFYGROUP 512 // text1=groupname
2506#define DC_QR_LOGIN 520 // text1=email_address
2507
2593dc_lot_t* dc_check_qr (dc_context_t* context, const char* qr);
2594
2595
2617char* dc_get_securejoin_qr (dc_context_t* context, uint32_t chat_id);
2618
2619
2632char* dc_get_securejoin_qr_svg (dc_context_t* context, uint32_t chat_id);
2633
2657uint32_t dc_join_securejoin (dc_context_t* context, const char* qr);
2658
2659
2660// location streaming
2661
2662
2679void dc_send_locations_to_chat (dc_context_t* context, uint32_t chat_id, int seconds);
2680
2681
2695int dc_is_sending_locations_to_chat (dc_context_t* context, uint32_t chat_id);
2696
2697
2725int dc_set_location (dc_context_t* context, double latitude, double longitude, double accuracy);
2726
2727
2788dc_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);
2789
2790
2802
2803
2818
2819
2832void dc_str_unref (char* str);
2833
2834
2864
2865
2884
2885
2900
2911
2926
2950int dc_receive_backup (dc_context_t* context, const char* qr);
2951
3001dc_accounts_t* dc_accounts_new (const char* dir, int writable);
3002
3003
3011
3012
3029
3046
3061uint32_t dc_accounts_migrate_account (dc_accounts_t* accounts, const char* dbfile);
3062
3063
3075int dc_accounts_remove_account (dc_accounts_t* accounts, uint32_t account_id);
3076
3077
3087
3088
3100dc_context_t* dc_accounts_get_account (dc_accounts_t* accounts, uint32_t account_id);
3101
3102
3119
3120
3129int dc_accounts_select_account (dc_accounts_t* accounts, uint32_t account_id);
3130
3131
3142
3143
3153
3154
3165
3166
3180
3181
3197int dc_accounts_background_fetch (dc_accounts_t* accounts, uint64_t timeout);
3198
3199
3207void dc_accounts_set_push_device_token (dc_accounts_t* accounts, const char *token);
3208
3229
3230
3250
3251
3259size_t dc_array_get_cnt (const dc_array_t* array);
3260
3261
3270uint32_t dc_array_get_id (const dc_array_t* array, size_t index);
3271
3272
3282double dc_array_get_latitude (const dc_array_t* array, size_t index);
3283
3284
3294double dc_array_get_longitude (const dc_array_t* array, size_t index);
3295
3296
3307double dc_array_get_accuracy (const dc_array_t* array, size_t index);
3308
3309
3319int64_t dc_array_get_timestamp (const dc_array_t* array, size_t index);
3320
3321
3331uint32_t dc_array_get_chat_id (const dc_array_t* array, size_t index);
3332
3333
3343uint32_t dc_array_get_contact_id (const dc_array_t* array, size_t index);
3344
3345
3355uint32_t dc_array_get_msg_id (const dc_array_t* array, size_t index);
3356
3357
3372char* dc_array_get_marker (const dc_array_t* array, size_t index);
3373
3374
3385int dc_array_is_independent (const dc_array_t* array, size_t index);
3386
3387
3397int dc_array_search_id (const dc_array_t* array, uint32_t needle, size_t* ret_index);
3398
3399
3442
3443
3451size_t dc_chatlist_get_cnt (const dc_chatlist_t* chatlist);
3452
3453
3465uint32_t dc_chatlist_get_chat_id (const dc_chatlist_t* chatlist, size_t index);
3466
3467
3479uint32_t dc_chatlist_get_msg_id (const dc_chatlist_t* chatlist, size_t index);
3480
3481
3508dc_lot_t* dc_chatlist_get_summary (const dc_chatlist_t* chatlist, size_t index, dc_chat_t* chat);
3509
3510
3530dc_lot_t* dc_chatlist_get_summary2 (dc_context_t* context, uint32_t chat_id, uint32_t msg_id);
3531
3532
3541
3542
3559char* dc_chat_get_info_json (dc_context_t* context, size_t chat_id);
3560
3571#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)
3572#define DC_CHAT_ID_ARCHIVED_LINK 6 // only an indicator in a chatlist
3573#define DC_CHAT_ID_ALLDONE_HINT 7 // only an indicator in a chatlist
3574#define DC_CHAT_ID_LAST_SPECIAL 9 // larger chat IDs are "real" chats, their messages are "real" messages
3575
3576
3585
3586
3599uint32_t dc_chat_get_id (const dc_chat_t* chat);
3600
3601
3632int dc_chat_get_type (const dc_chat_t* chat);
3633
3634
3646
3647
3659char* dc_chat_get_name (const dc_chat_t* chat);
3660
3661
3676
3677
3690uint32_t dc_chat_get_color (const dc_chat_t* chat);
3691
3692
3702
3703
3721
3722
3744
3745
3755
3756
3772
3773
3785int dc_chat_can_send (const dc_chat_t* chat);
3786
3787
3812
3813
3832
3833
3845
3846
3854int dc_chat_is_muted (const dc_chat_t* chat);
3855
3856
3865
3866
3876#define DC_MSG_ID_MARKER1 1 // this is used by iOS to mark things in the message list
3877#define DC_MSG_ID_DAYMARKER 9
3878#define DC_MSG_ID_LAST_SPECIAL 9
3879
3880
3893dc_msg_t* dc_msg_new (dc_context_t* context, int viewtype);
3894
3895
3904
3905
3914uint32_t dc_msg_get_id (const dc_msg_t* msg);
3915
3916
3931uint32_t dc_msg_get_from_id (const dc_msg_t* msg);
3932
3933
3942uint32_t dc_msg_get_chat_id (const dc_msg_t* msg);
3943
3944
3954
3955
3999
4000
4017int64_t dc_msg_get_timestamp (const dc_msg_t* msg);
4018
4019
4032
4033
4048
4049
4069char* dc_msg_get_text (const dc_msg_t* msg);
4070
4071
4089char* dc_msg_get_subject (const dc_msg_t* msg);
4090
4091
4105char* dc_msg_get_file (const dc_msg_t* msg);
4106
4107
4118int dc_msg_save_file (const dc_msg_t* msg, const char* path);
4119
4120
4131
4132
4144
4145
4158char* dc_msg_get_webxdc_blob (const dc_msg_t* msg, const char* filename, size_t* ret_bytes);
4159
4160
4193
4194
4205uint64_t dc_msg_get_filebytes (const dc_msg_t* msg);
4206
4207
4223
4224
4240
4241
4254
4255
4264
4274int dc_msg_is_bot (const dc_msg_t* msg);
4275
4288
4302
4303
4327
4328
4340char* dc_msg_get_summarytext (const dc_msg_t* msg, int approx_characters);
4341
4342
4372
4373
4374
4390
4391
4402
4403
4414int dc_msg_is_sent (const dc_msg_t* msg);
4415
4416
4434
4435
4456int dc_msg_is_info (const dc_msg_t* msg);
4457
4458
4481
4482
4483// DC_INFO* uses the same values as SystemMessage in rust-land
4484#define DC_INFO_UNKNOWN 0
4485#define DC_INFO_GROUP_NAME_CHANGED 2
4486#define DC_INFO_GROUP_IMAGE_CHANGED 3
4487#define DC_INFO_MEMBER_ADDED_TO_GROUP 4
4488#define DC_INFO_MEMBER_REMOVED_FROM_GROUP 5
4489#define DC_INFO_AUTOCRYPT_SETUP_MESSAGE 6
4490#define DC_INFO_SECURE_JOIN_MESSAGE 7
4491#define DC_INFO_LOCATIONSTREAMING_ENABLED 8
4492#define DC_INFO_LOCATION_ONLY 9
4493#define DC_INFO_EPHEMERAL_TIMER_CHANGED 10
4494#define DC_INFO_PROTECTION_ENABLED 11
4495#define DC_INFO_PROTECTION_DISABLED 12
4496#define DC_INFO_INVALID_UNENCRYPTED_MAIL 13
4497#define DC_INFO_WEBXDC_INFO_MESSAGE 32
4498
4512
4513
4529
4530
4546
4547
4562
4563
4583char* dc_msg_get_error (const dc_msg_t* msg);
4584
4585
4615
4616#define DC_VIDEOCHATTYPE_UNKNOWN 0
4617#define DC_VIDEOCHATTYPE_BASICWEBRTC 1
4618#define DC_VIDEOCHATTYPE_JITSI 2
4619
4620
4645
4646
4673
4674
4683void dc_msg_set_text (dc_msg_t* msg, const char* text);
4684
4685
4710void dc_msg_set_html (dc_msg_t* msg, const char* html);
4711
4712
4722void dc_msg_set_subject (dc_msg_t* msg, const char* subject);
4723
4724
4737void dc_msg_set_override_sender_name(dc_msg_t* msg, const char* name);
4738
4739
4752void dc_msg_set_file (dc_msg_t* msg, const char* file, const char* filemime);
4753
4754
4765void dc_msg_set_dimension (dc_msg_t* msg, int width, int height);
4766
4767
4777void dc_msg_set_duration (dc_msg_t* msg, int duration);
4778
4779
4796void dc_msg_set_location (dc_msg_t* msg, double latitude, double longitude);
4797
4798
4820void dc_msg_latefiling_mediasize (dc_msg_t* msg, int width, int height, int duration);
4821
4822
4837void dc_msg_set_quote (dc_msg_t* msg, const dc_msg_t* quote);
4838
4839
4855
4856
4879
4895
4896
4906
4928#define DC_CONTACT_ID_SELF 1
4929#define DC_CONTACT_ID_INFO 2 // centered messages as "member added", used in all chats
4930#define DC_CONTACT_ID_DEVICE 5 // messages "update info" in the device-chat
4931#define DC_CONTACT_ID_LAST_SPECIAL 9
4932
4933
4942
4943
4951uint32_t dc_contact_get_id (const dc_contact_t* contact);
4952
4953
4962char* dc_contact_get_addr (const dc_contact_t* contact);
4963
4964
4979char* dc_contact_get_name (const dc_contact_t* contact);
4980
4981
5002
5003
5020
5021
5022// dc_contact_get_first_name is removed,
5023// the following define is to make upgrading more smoothly.
5024#define dc_contact_get_first_name dc_contact_get_display_name
5025
5026
5042
5043
5056
5057
5069uint32_t dc_contact_get_color (const dc_contact_t* contact);
5070
5071
5084
5094
5095
5109
5110
5121
5122
5141
5150
5151
5174
5175
5196dc_provider_t* dc_provider_new_from_email (const dc_context_t* context, const char* email);
5197
5198
5214
5215
5228
5229
5245
5246
5258
5259
5267
5268
5281#define DC_TEXT1_DRAFT 1
5282#define DC_TEXT1_USERNAME 2
5283#define DC_TEXT1_SELF 3
5284
5285
5296
5297
5307char* dc_lot_get_text1 (const dc_lot_t* lot);
5308
5309
5319char* dc_lot_get_text2 (const dc_lot_t* lot);
5320
5321
5332
5333
5342
5343
5351uint32_t dc_lot_get_id (const dc_lot_t* lot);
5352
5353
5363int64_t dc_lot_get_timestamp (const dc_lot_t* lot);
5364
5365
5395#define DC_MSG_TEXT 10
5396
5397
5409#define DC_MSG_IMAGE 20
5410
5411
5417#define DC_MSG_GIF 21
5418
5419
5425#define DC_MSG_STICKER 23
5426
5427
5433#define DC_MSG_AUDIO 40
5434
5435
5442#define DC_MSG_VOICE 41
5443
5444
5453#define DC_MSG_VIDEO 50
5454
5455
5461#define DC_MSG_FILE 60
5462
5463
5472#define DC_MSG_VIDEOCHAT_INVITATION 70
5473
5474
5480#define DC_MSG_WEBXDC 80
5481
5482
5502#define DC_STATE_UNDEFINED 0
5503
5507#define DC_STATE_IN_FRESH 10
5508
5512#define DC_STATE_IN_NOTICED 13
5513
5517#define DC_STATE_IN_SEEN 16
5518
5522#define DC_STATE_OUT_PREPARING 18
5523
5527#define DC_STATE_OUT_DRAFT 19
5528
5532#define DC_STATE_OUT_PENDING 20
5533
5537#define DC_STATE_OUT_FAILED 24
5538
5543#define DC_STATE_OUT_DELIVERED 26
5544
5548#define DC_STATE_OUT_MDN_RCVD 28
5549
5570#define DC_CHAT_TYPE_UNDEFINED 0
5571
5575#define DC_CHAT_TYPE_SINGLE 100
5576
5580#define DC_CHAT_TYPE_GROUP 120
5581
5585#define DC_CHAT_TYPE_MAILINGLIST 140
5586
5590#define DC_CHAT_TYPE_BROADCAST 160
5591
5611#define DC_SOCKET_AUTO 0
5612
5613
5617#define DC_SOCKET_SSL 1
5618
5619
5623#define DC_SOCKET_STARTTLS 2
5624
5625
5629#define DC_SOCKET_PLAIN 3
5630
5654#define DC_LP_AUTH_OAUTH2 0x2
5655
5656
5661#define DC_LP_AUTH_NORMAL 0x4
5662
5663
5668#define DC_LP_AUTH_FLAGS (DC_LP_AUTH_OAUTH2|DC_LP_AUTH_NORMAL) // if none of these flags are set, the default is chosen
5669
5685#define DC_CERTCK_AUTO 0
5686
5691#define DC_CERTCK_STRICT 1
5692
5697#define DC_CERTCK_ACCEPT_INVALID_CERTIFICATES 3
5698
5720
5729
5739void dc_jsonrpc_request(dc_jsonrpc_instance_t* jsonrpc_instance, const char* request);
5740
5751
5761char* dc_jsonrpc_blocking_call(dc_jsonrpc_instance_t* jsonrpc_instance, const char *input);
5762
5783
5784// Alias for backwards compatibility, use dc_get_next_event instead.
5785#define dc_accounts_get_next_event dc_get_next_event
5786
5795
5796// Alias for backwards compatibility, use dc_event_emtitter_unref instead.
5797#define dc_accounts_event_emitter_unref dc_event_emitter_unref
5798
5818
5819
5832
5833
5846
5847
5861
5862
5873
5874
5883
5884
5907#define DC_EVENT_INFO 100
5908
5909
5916#define DC_EVENT_SMTP_CONNECTED 101
5917
5918
5925#define DC_EVENT_IMAP_CONNECTED 102
5926
5933#define DC_EVENT_SMTP_MESSAGE_SENT 103
5934
5941#define DC_EVENT_IMAP_MESSAGE_DELETED 104
5942
5949#define DC_EVENT_IMAP_MESSAGE_MOVED 105
5950
5957#define DC_EVENT_IMAP_INBOX_IDLE 106
5958
5965#define DC_EVENT_NEW_BLOB_FILE 150
5966
5973#define DC_EVENT_DELETED_BLOB_FILE 151
5974
5983#define DC_EVENT_WARNING 300
5984
5985
6003#define DC_EVENT_ERROR 400
6004
6005
6016#define DC_EVENT_ERROR_SELF_NOT_IN_GROUP 410
6017
6018
6029#define DC_EVENT_MSGS_CHANGED 2000
6030
6031
6038#define DC_EVENT_REACTIONS_CHANGED 2001
6039
6040
6050#define DC_EVENT_INCOMING_MSG 2005
6051
6063#define DC_EVENT_INCOMING_MSG_BUNCH 2006
6064
6065
6078#define DC_EVENT_MSGS_NOTICED 2008
6079
6080
6088#define DC_EVENT_MSG_DELIVERED 2010
6089
6090
6099#define DC_EVENT_MSG_FAILED 2012
6100
6101
6109#define DC_EVENT_MSG_READ 2015
6110
6111
6118#define DC_EVENT_MSG_DELETED 2016
6119
6120
6130#define DC_EVENT_CHAT_MODIFIED 2020
6131
6138#define DC_EVENT_CHAT_EPHEMERAL_TIMER_MODIFIED 2021
6139
6140
6147#define DC_EVENT_CONTACTS_CHANGED 2030
6148
6149
6150
6159#define DC_EVENT_LOCATION_CHANGED 2035
6160
6161
6168#define DC_EVENT_CONFIGURE_PROGRESS 2041
6169
6170
6177#define DC_EVENT_IMEX_PROGRESS 2051
6178
6179
6190#define DC_EVENT_IMEX_FILE_WRITTEN 2052
6191
6192
6207#define DC_EVENT_SECUREJOIN_INVITER_PROGRESS 2060
6208
6209
6223#define DC_EVENT_SECUREJOIN_JOINER_PROGRESS 2061
6224
6225
6235#define DC_EVENT_CONNECTIVITY_CHANGED 2100
6236
6237
6242#define DC_EVENT_SELFAVATAR_CHANGED 2110
6243
6244
6254#define DC_EVENT_CONFIG_SYNCED 2111
6255
6256
6271#define DC_EVENT_WEBXDC_STATUS_UPDATE 2120
6272
6279#define DC_EVENT_WEBXDC_INSTANCE_DELETED 2121
6280
6290#define DC_EVENT_ACCOUNTS_BACKGROUND_FETCH_DONE 2200
6291
6298#define DC_EVENT_CHATLIST_CHANGED 2300
6299
6307#define DC_EVENT_CHATLIST_ITEM_CHANGED 2301
6308
6314#define DC_EVENT_DATA1_IS_STRING(e) 0 // not used anymore
6315#define DC_EVENT_DATA2_IS_STRING(e) ((e)==DC_EVENT_CONFIGURE_PROGRESS || (e)==DC_EVENT_IMEX_FILE_WRITTEN || ((e)>=100 && (e)<=499))
6316
6317
6318/*
6319 * Values for dc_get|set_config("show_emails")
6320 */
6321#define DC_SHOW_EMAILS_OFF 0
6322#define DC_SHOW_EMAILS_ACCEPTED_CONTACTS 1
6323#define DC_SHOW_EMAILS_ALL 2
6324
6325
6326/*
6327 * Values for dc_get|set_config("media_quality")
6328 */
6329#define DC_MEDIA_QUALITY_BALANCED 0
6330#define DC_MEDIA_QUALITY_WORSE 1
6331
6332
6333/*
6334 * Values for dc_get|set_config("key_gen_type")
6335 */
6336#define DC_KEY_GEN_DEFAULT 0
6337#define DC_KEY_GEN_RSA2048 1
6338#define DC_KEY_GEN_ED25519 2
6339#define DC_KEY_GEN_RSA4096 3
6340
6341
6363#define DC_PROVIDER_STATUS_OK 1
6364
6376#define DC_PROVIDER_STATUS_PREPARATION 2
6377
6390#define DC_PROVIDER_STATUS_BROKEN 3
6391
6412#define DC_CHAT_VISIBILITY_NORMAL 0
6413
6426#define DC_CHAT_VISIBILITY_ARCHIVED 1
6427
6432#define DC_CHAT_VISIBILITY_PINNED 2
6433
6453#define DC_DOWNLOAD_DONE 0
6454
6458#define DC_DOWNLOAD_AVAILABLE 10
6459
6463#define DC_DOWNLOAD_FAILURE 20
6464
6468#define DC_DOWNLOAD_UNDECIPHERABLE 30
6469
6473#define DC_DOWNLOAD_IN_PROGRESS 1000
6474
6475
6476
6504#define DC_STR_NOMESSAGES 1
6505
6509#define DC_STR_SELF 2
6510
6514#define DC_STR_DRAFT 3
6515
6519#define DC_STR_VOICEMESSAGE 7
6520
6524#define DC_STR_IMAGE 9
6525
6529#define DC_STR_VIDEO 10
6530
6534#define DC_STR_AUDIO 11
6535
6539#define DC_STR_FILE 12
6540
6548#define DC_STR_MSGGRPNAME 15
6549
6555#define DC_STR_MSGGRPIMGCHANGED 16
6556
6563#define DC_STR_MSGADDMEMBER 17
6564
6571#define DC_STR_MSGDELMEMBER 18
6572
6578#define DC_STR_MSGGROUPLEFT 19
6579
6583#define DC_STR_GIF 23
6584
6588#define DC_STR_ENCRYPTEDMSG 24
6589
6593#define DC_STR_E2E_AVAILABLE 25
6594
6596#define DC_STR_ENCR_TRANSP 27
6597
6601#define DC_STR_ENCR_NONE 28
6602
6606#define DC_STR_CANTDECRYPT_MSG_BODY 29
6607
6611#define DC_STR_FINGERPRINTS 30
6612
6616#define DC_STR_READRCPT 31
6617
6622#define DC_STR_READRCPT_MAILBODY 32
6623
6625#define DC_STR_MSGGRPIMGDELETED 33
6626
6630#define DC_STR_E2E_PREFERRED 34
6631
6636#define DC_STR_CONTACT_VERIFIED 35
6637
6642#define DC_STR_CONTACT_NOT_VERIFIED 36
6643
6648#define DC_STR_CONTACT_SETUP_CHANGED 37
6649
6653#define DC_STR_ARCHIVEDCHATS 40
6654
6658#define DC_STR_AC_SETUP_MSG_SUBJECT 42
6659
6663#define DC_STR_AC_SETUP_MSG_BODY 43
6664
6669#define DC_STR_CANNOT_LOGIN 60
6670
6679#define DC_STR_MSGACTIONBYUSER 62
6680
6688#define DC_STR_MSGACTIONBYME 63
6689
6693#define DC_STR_MSGLOCATIONENABLED 64
6694
6698#define DC_STR_MSGLOCATIONDISABLED 65
6699
6703#define DC_STR_LOCATION 66
6704
6708#define DC_STR_STICKER 67
6709
6713#define DC_STR_DEVICE_MESSAGES 68
6714
6718#define DC_STR_SAVED_MESSAGES 69
6719
6723#define DC_STR_DEVICE_MESSAGES_HINT 70
6724
6728#define DC_STR_WELCOME_MESSAGE 71
6729
6733#define DC_STR_UNKNOWN_SENDER_FOR_CHAT 72
6734
6740#define DC_STR_SUBJECT_FOR_NEW_CONTACT 73
6741
6746#define DC_STR_FAILED_SENDING_TO 74
6747
6753#define DC_STR_EPHEMERAL_DISABLED 75
6754
6762#define DC_STR_EPHEMERAL_SECONDS 76
6763
6769#define DC_STR_EPHEMERAL_MINUTE 77
6770
6776#define DC_STR_EPHEMERAL_HOUR 78
6777
6783#define DC_STR_EPHEMERAL_DAY 79
6784
6790#define DC_STR_EPHEMERAL_WEEK 80
6791
6793#define DC_STR_EPHEMERAL_FOUR_WEEKS 81
6794
6798#define DC_STR_VIDEOCHAT_INVITATION 82
6799
6804#define DC_STR_VIDEOCHAT_INVITE_MSG_BODY 83
6805
6810#define DC_STR_CONFIGURATION_FAILED 84
6811
6816#define DC_STR_BAD_TIME_MSG_BODY 85
6817
6821#define DC_STR_UPDATE_REMINDER_MSG_BODY 86
6822
6826#define DC_STR_ERROR_NO_NETWORK 87
6827
6832#define DC_STR_REPLY_NOUN 90
6833
6837#define DC_STR_SELF_DELETED_MSG_BODY 91
6838
6842#define DC_STR_SERVER_TURNED_OFF 92
6843
6851#define DC_STR_EPHEMERAL_MINUTES 93
6852
6860#define DC_STR_EPHEMERAL_HOURS 94
6861
6869#define DC_STR_EPHEMERAL_DAYS 95
6870
6878#define DC_STR_EPHEMERAL_WEEKS 96
6879
6883#define DC_STR_FORWARDED 97
6884
6890#define DC_STR_QUOTA_EXCEEDING_MSG_BODY 98
6891
6899#define DC_STR_PARTIAL_DOWNLOAD_MSG_BODY 99
6900
6906#define DC_STR_DOWNLOAD_AVAILABILITY 100
6907
6911#define DC_STR_SYNC_MSG_SUBJECT 101
6912
6921#define DC_STR_SYNC_MSG_BODY 102
6922
6926#define DC_STR_INCOMING_MESSAGES 103
6927
6931#define DC_STR_OUTGOING_MESSAGES 104
6932
6938#define DC_STR_STORAGE_ON_DOMAIN 105
6939
6941#define DC_STR_ONE_MOMENT 106
6942
6946#define DC_STR_CONNECTED 107
6947
6951#define DC_STR_CONNTECTING 108
6952
6956#define DC_STR_UPDATING 109
6957
6961#define DC_STR_SENDING 110
6962
6966#define DC_STR_LAST_MSG_SENT_SUCCESSFULLY 111
6967
6973#define DC_STR_ERROR 112
6974
6978#define DC_STR_NOT_SUPPORTED_BY_PROVIDER 113
6979
6983#define DC_STR_MESSAGES 114
6984
6988#define DC_STR_BROADCAST_LIST 115
6989
6993#define DC_STR_PART_OF_TOTAL_USED 116
6994
7003#define DC_STR_SECURE_JOIN_STARTED 117
7004
7013#define DC_STR_SECURE_JOIN_REPLIES 118
7014
7020#define DC_STR_SETUP_CONTACT_QR_DESC 119
7021
7027#define DC_STR_SECURE_JOIN_GROUP_QR_DESC 120
7028
7032#define DC_STR_NOT_CONNECTED 121
7033
7037#define DC_STR_AEAP_ADDR_CHANGED 122
7038
7050#define DC_STR_AEAP_EXPLANATION_AND_LINK 123
7051
7056#define DC_STR_GROUP_NAME_CHANGED_BY_YOU 124
7057
7063#define DC_STR_GROUP_NAME_CHANGED_BY_OTHER 125
7064
7066#define DC_STR_GROUP_IMAGE_CHANGED_BY_YOU 126
7067
7071#define DC_STR_GROUP_IMAGE_CHANGED_BY_OTHER 127
7072
7078#define DC_STR_ADD_MEMBER_BY_YOU 128
7079
7086#define DC_STR_ADD_MEMBER_BY_OTHER 129
7087
7093#define DC_STR_REMOVE_MEMBER_BY_YOU 130
7094
7101#define DC_STR_REMOVE_MEMBER_BY_OTHER 131
7102
7106#define DC_STR_GROUP_LEFT_BY_YOU 132
7107
7113#define DC_STR_GROUP_LEFT_BY_OTHER 133
7114
7118#define DC_STR_GROUP_IMAGE_DELETED_BY_YOU 134
7119
7125#define DC_STR_GROUP_IMAGE_DELETED_BY_OTHER 135
7126
7130#define DC_STR_LOCATION_ENABLED_BY_YOU 136
7131
7137#define DC_STR_LOCATION_ENABLED_BY_OTHER 137
7138
7142#define DC_STR_EPHEMERAL_TIMER_DISABLED_BY_YOU 138
7143
7149#define DC_STR_EPHEMERAL_TIMER_DISABLED_BY_OTHER 139
7150
7156#define DC_STR_EPHEMERAL_TIMER_SECONDS_BY_YOU 140
7157
7164#define DC_STR_EPHEMERAL_TIMER_SECONDS_BY_OTHER 141
7165
7169#define DC_STR_EPHEMERAL_TIMER_1_MINUTE_BY_YOU 142
7170
7176#define DC_STR_EPHEMERAL_TIMER_1_MINUTE_BY_OTHER 143
7177
7181#define DC_STR_EPHEMERAL_TIMER_1_HOUR_BY_YOU 144
7182
7188#define DC_STR_EPHEMERAL_TIMER_1_HOUR_BY_OTHER 145
7189
7193#define DC_STR_EPHEMERAL_TIMER_1_DAY_BY_YOU 146
7194
7200#define DC_STR_EPHEMERAL_TIMER_1_DAY_BY_OTHER 147
7201
7205#define DC_STR_EPHEMERAL_TIMER_1_WEEK_BY_YOU 148
7206
7212#define DC_STR_EPHEMERAL_TIMER_1_WEEK_BY_OTHER 149
7213
7219#define DC_STR_EPHEMERAL_TIMER_MINUTES_BY_YOU 150
7220
7227#define DC_STR_EPHEMERAL_TIMER_MINUTES_BY_OTHER 151
7228
7234#define DC_STR_EPHEMERAL_TIMER_HOURS_BY_YOU 152
7235
7242#define DC_STR_EPHEMERAL_TIMER_HOURS_BY_OTHER 153
7243
7249#define DC_STR_EPHEMERAL_TIMER_DAYS_BY_YOU 154
7250
7257#define DC_STR_EPHEMERAL_TIMER_DAYS_BY_OTHER 155
7258
7264#define DC_STR_EPHEMERAL_TIMER_WEEKS_BY_YOU 156
7265
7272#define DC_STR_EPHEMERAL_TIMER_WEEKS_BY_OTHER 157
7273
7277#define DC_STR_BACKUP_TRANSFER_QR 162
7278
7282#define DC_STR_BACKUP_TRANSFER_MSG_BODY 163
7283
7287#define DC_STR_CHAT_PROTECTION_ENABLED 170
7288
7292#define DC_STR_CHAT_PROTECTION_DISABLED 171
7293
7297#define DC_STR_NEW_GROUP_SEND_FIRST_MESSAGE 172
7298
7304#define DC_STR_MESSAGE_ADD_MEMBER 173
7305
7311#define DC_STR_INVALID_UNENCRYPTED_MAIL 174
7312
7319#define DC_STR_YOU_REACTED 176
7320
7328#define DC_STR_REACTED_BY 177
7329
7335#ifdef PY_CFFI_INC
7336/* Helper utility to locate the header file when building python bindings. */
7337char* _dc_header_file_location(void) {
7338 return __FILE__;
7339}
7340#endif
7341
7342
7343#ifdef __cplusplus
7344}
7345#endif
7346#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_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.
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:
int dc_chat_is_protection_broken(const dc_chat_t *chat)
Checks if the chat was protected, and then an incoming message broke this protection.
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)
Check if a chat is protected.
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()).
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 verified chats, 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.
int dc_preconfigure_keypair(dc_context_t *context, const char *addr, const char *public_data, const char *secret_data)
Save a keypair as the default keys for the user.
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.
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)
Check if an e-mail address belongs to a known and unblocked contact.
int dc_set_chat_profile_image(dc_context_t *context, uint32_t chat_id, const char *image)
Set group 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.
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.
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_continue_key_transfer(dc_context_t *context, uint32_t msg_id, const char *setup_code)
Continue the Autocrypt Key Transfer on another device.
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 group name.
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()-options delete_device_aft...
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.
uint32_t dc_prepare_msg(dc_context_t *context, uint32_t chat_id, dc_msg_t *msg)
Prepare a message for sending.
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.
uint32_t dc_get_next_media(dc_context_t *context, uint32_t msg_id, int dir, int msg_type, int msg_type2, int msg_type3)
Search next/previous message based on a given message and a list of types.
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 without passphrase.
uint32_t dc_send_videochat_invitation(dc_context_t *context, uint32_t chat_id)
Send invitation to a videochat.
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().
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.
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.
int dc_delete_contact(dc_context_t *context, uint32_t contact_id)
Delete a contact so that it disappears from the corresponding lists.
char * dc_get_mime_headers(dc_context_t *context, uint32_t msg_id)
Get the raw mime-headers of the given message.
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.
void dc_delete_all_locations(dc_context_t *context)
Delete all locations on the current device.
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.
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.
char * dc_initiate_key_transfer(dc_context_t *context)
Initiate Autocrypt Setup Transfer.
int dc_get_blocked_cnt(dc_context_t *context)
Get the number of blocked contacts.
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.
int dc_set_config(dc_context_t *context, const char *key, const char *value)
Configure the context.
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_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 a padlock should be shown beside the message.
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 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.
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.
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...
char * dc_msg_get_videochat_url(const dc_msg_t *msg)
Get URL of a videochat invitation.
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.
int dc_msg_is_bot(const dc_msg_t *msg)
Check if an incoming message is a bot message, i.e.
char * dc_msg_get_setupcodebegin(const dc_msg_t *msg)
Get the first characters of the setup code.
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_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.
int dc_msg_is_setupmessage(const dc_msg_t *msg)
Check if the message is an Autocrypt Setup Message.
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.
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.
void dc_msg_force_plaintext(dc_msg_t *msg)
Force the message to be sent in plain text.
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.
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.
int dc_msg_is_increation(const dc_msg_t *msg)
Check if a message is still in creation.
int64_t dc_msg_get_sort_timestamp(const dc_msg_t *msg)
Get the message time used for sorting.
int dc_msg_get_videochat_type(const dc_msg_t *msg)
Get type of videochat.
void dc_msg_set_file(dc_msg_t *msg, const char *file, const char *filemime)
Set the file associated with a message object.
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 and DNS 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.