File size: 5,401 Bytes
f0f4f2b | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 | #ifndef __DC_MSG_H__
#define __DC_MSG_H__
#ifdef __cplusplus
extern "C" {
#endif
#include "dc_param.h"
typedef enum {
DC_MOVE_STATE_UNDEFINED = 0
,DC_MOVE_STATE_PENDING = 1
,DC_MOVE_STATE_STAY = 2
,DC_MOVE_STATE_MOVING = 3
} dc_move_state_t;
/** the structure behind dc_msg_t */
struct _dc_msg
{
/** @privatesection */
uint32_t magic;
/**
* Message ID. Never 0.
*/
uint32_t id;
/**
* Contact ID of the sender. Never 0. See dc_contact_t::id for special IDs.
* Use dc_get_contact() to load details about this contact.
*/
uint32_t from_id;
/**
* Contact ID of the recipient. Never 0. See dc_contact_t::id for special IDs.
* Use dc_get_contact() to load details about this contact.
*/
uint32_t to_id;
/**
* Chat ID the message belongs to. Never 0. See dc_chat_t::id for special IDs.
* Use dc_get_chat() to load details about the chat.
*/
uint32_t chat_id;
dc_move_state_t move_state;
int type; /**< Message view type. */
int state; /**< Message state. It is recommended to use dc_msg_get_state() to access this field. */
int hidden; /**< Used eg. for handshaking messages. */
time_t timestamp_sort; /**< Unix time for sorting. 0 if unset. */
time_t timestamp_sent; /**< Unix time the message was sent. 0 if unset. */
time_t timestamp_rcvd; /**< Unix time the message was recveived. 0 if unset. */
char* text; /**< Message text. NULL if unset. It is recommended to use dc_msg_set_text() and dc_msg_get_text() to access this field. */
dc_context_t* context; /**< may be NULL, set on loading from database and on sending */
char* rfc724_mid; /**< The RFC-742 Message-ID */
char* in_reply_to;
char* server_folder; /**< Folder where the message was last seen on the server */
uint32_t server_uid; /**< UID last seen on the server for this message */
int is_dc_message; /**< Set to 1 if the message was sent by another messenger. 2=reply to messenger message. 0 otherwise. */
int starred; /**< Starred-state of the message. 0=no, 1=yes. */
int chat_blocked; /**< Internal */
uint32_t location_id;
dc_param_t* param; /**< Additional paramter for the message. Never a NULL-pointer. It is recommended to use setters and getters instead of accessing this field directly. */
};
dc_msg_t* dc_msg_new_untyped (dc_context_t*);
dc_msg_t* dc_msg_new_load (dc_context_t*, uint32_t id);
int dc_msg_load_from_db (dc_msg_t*, dc_context_t*, uint32_t id);
int dc_msg_is_increation (const dc_msg_t*);
char* dc_msg_get_summarytext_by_raw (int type, const char* text, dc_param_t*, int approx_bytes, dc_context_t*); /* the returned value must be free()'d */
void dc_msg_save_param_to_disk (dc_msg_t*);
void dc_msg_guess_msgtype_from_suffix (const char* pathNfilename, int* ret_msgtype, char** ret_mime);
void dc_delete_msg_from_db (dc_context_t*, uint32_t);
#define DC_MSG_NEEDS_ATTACHMENT(a) ((a)==DC_MSG_IMAGE || (a)==DC_MSG_GIF || (a)==DC_MSG_AUDIO || (a)==DC_MSG_VOICE || (a)==DC_MSG_VIDEO || (a)==DC_MSG_FILE)
/* as we do not cut inside words, this results in about 32-42 characters.
Do not use too long subjects - we add a tag after the subject which gets truncated by the clients otherwise.
It should also be very clear, the subject is _not_ the whole message.
The value is also used for CC:-summaries */
#define DC_APPROX_SUBJECT_CHARS 32
// Context functions to work with messages
int dc_msg_exists (dc_context_t*, uint32_t msg_id);
void dc_update_msg_chat_id (dc_context_t*, uint32_t msg_id, uint32_t chat_id);
void dc_update_msg_state (dc_context_t*, uint32_t msg_id, int state);
void dc_update_msg_move_state (dc_context_t*, const char* rfc724_mid, dc_move_state_t);
void dc_set_msg_failed (dc_context_t*, uint32_t msg_id, const char* error);
int dc_mdn_from_ext (dc_context_t*, uint32_t from_id, const char* rfc724_mid, time_t, uint32_t* ret_chat_id, uint32_t* ret_msg_id); /* returns 1 if an event should be send */
size_t dc_get_real_msg_cnt (dc_context_t*); /* the number of messages assigned to real chat (!=deaddrop, !=trash) */
size_t dc_get_deaddrop_msg_cnt (dc_context_t*);
int dc_rfc724_mid_cnt (dc_context_t*, const char* rfc724_mid);
uint32_t dc_rfc724_mid_exists (dc_context_t*, const char* rfc724_mid, char** ret_server_folder, uint32_t* ret_server_uid);
void dc_update_server_uid (dc_context_t*, const char* rfc724_mid, const char* server_folder, uint32_t server_uid);
#ifdef __cplusplus
} /* /extern "C" */
#endif
#endif /* __DC_MSG_H__ */
|