text stringlengths 0 357 |
|---|
* Get message sending time. |
* The sending time is returned as a unix timestamp in seconds. |
* |
* Note that the message lists returned eg. by dc_get_chat_msgs() |
* are not sorted by the _sending_ time but by the _receiving_ time. |
* This ensures newly received messages always pop up at the end of the list, |
* however, for delayed messages, the correct sending time will be displayed. |
* |
* To display detailed information about the times to the user, |
* the UI can use dc_get_msg_info(). |
* |
* @memberof dc_msg_t |
* @param msg The message object. |
* @return The time of the message. |
*/ |
time_t dc_msg_get_timestamp(const dc_msg_t* msg) |
{ |
if (msg==NULL || msg->magic!=DC_MSG_MAGIC) { |
return 0; |
} |
return msg->timestamp_sent? msg->timestamp_sent : msg->timestamp_sort; |
} |
/** |
* Get message receive time. |
* The receive time is returned as a unix timestamp in seconds. |
* |
* To get the sending time, use dc_msg_get_timestamp(). |
* |
* @memberof dc_msg_t |
* @param msg The message object. |
* @return Receiving time of the message. |
* For outgoing messages, 0 is returned. |
*/ |
time_t dc_msg_get_received_timestamp(const dc_msg_t* msg) |
{ |
if (msg==NULL || msg->magic!=DC_MSG_MAGIC) { |
return 0; |
} |
return msg->timestamp_rcvd; |
} |
/** |
* Get message time used for sorting. |
* This function returns the timestamp that is used for sorting the message |
* into lists as returned eg. by dc_get_chat_msgs(). |
* This may be the reveived time, the sending time or another time. |
* |
* To get the receiving time, use dc_msg_get_received_timestamp(). |
* To get the sending time, use dc_msg_get_timestamp(). |
* |
* @memberof dc_msg_t |
* @param msg The message object. |
* @return Time used for ordering. |
*/ |
time_t dc_msg_get_sort_timestamp(const dc_msg_t* msg) |
{ |
if (msg==NULL || msg->magic!=DC_MSG_MAGIC) { |
return 0; |
} |
return msg->timestamp_sort; |
} |
/** |
* Check if a message has a deviating timestamp. |
* A message has a deviating timestamp |
* when it is sent on another day as received/sorted by. |
* |
* When the UI displays normally only the time beside the message and the full day as headlines, |
* the UI should display the full date directly beside the message if the timestamp is deviating. |
* |
* @memberof dc_msg_t |
* @param msg The message object. |
* @return 1=Timestamp is deviating, the UI should display the full date beside the message. |
* 0=Timestamp is not deviating and belongs to the same date as the date headers, |
* displaying the time only is sufficient in this case. |
*/ |
int dc_msg_has_deviating_timestamp(const dc_msg_t* msg) |
{ |
long cnv_to_local = dc_gm2local_offset(); |
time_t sort_timestamp = dc_msg_get_sort_timestamp(msg) + cnv_to_local; |
time_t send_timestamp = dc_msg_get_timestamp(msg) + cnv_to_local; |
return (sort_timestamp/DC_SECONDS_PER_DAY != send_timestamp/DC_SECONDS_PER_DAY); |
} |
/** |
* Check if a message has a location bound to it. |
* These messages are also returned by dc_get_locations() |
* and the UI may decide to display a special icon beside such messages, |
* |
* @memberof dc_msg_t |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.