Struct ChatId

pub struct ChatId(u32);

Chat ID, including reserved IDs.

Some chat IDs are reserved to identify special chat types. This type can represent both the special as well as normal chats.

Tuple Fields

0: u32

Implementations

impl ChatId

pub const fn new(id: u32) -> ChatId

Create a new ChatId.

pub fn is_unset(self) -> bool

An unset ChatId

This is transitional and should not be used in new code.

pub fn is_special(self) -> bool

Whether the chat ID signifies a special chat.

This kind of chat ID can not be used for real chats.

pub fn is_trash(self) -> bool

Chat ID for messages which need to be deleted.

Messages which should be deleted get this chat ID and are deleted later. Deleted messages need to stay around as long as they are not deleted on the server so that their rfc724_mid remains known and downloading them again can be avoided.

pub fn is_archived_link(self) -> bool

Chat ID signifying there are any number of archived chats.

This chat ID can be returned in a Chatlist and signals to the UI to include a link to the archived chats.

pub fn is_alldone_hint(self) -> bool

Virtual chat ID signalling there are only archived chats.

This can be included in the chatlist if the DC_GCL_ADD_ALLDONE_HINT flag is used to build the Chatlist.

pub(crate) fn lookup_by_message(msg: &Message) -> Option<Self>

Returns ChatId of a chat that msg belongs to.

pub async fn lookup_by_contact( context: &Context, contact_id: ContactId, ) -> Result<Option<Self>>

Returns the ChatId for the 1:1 chat with contact_id if it exists and is not blocked.

If the chat does not exist or is blocked, None is returned.

pub(crate) async fn get_for_contact( context: &Context, contact_id: ContactId, ) -> Result<Self>

Returns the ChatId for the 1:1 chat with contact_id.

If the chat does not yet exist an unblocked chat (Blocked::Not) is created.

This is an internal API, if a user action needs to get a chat ChatId::create_for_contact should be used as this also scales up the Contact’s origin.

pub async fn create_for_contact( context: &Context, contact_id: ContactId, ) -> Result<Self>

Returns the unblocked 1:1 chat with contact_id.

This should be used when a user action creates a chat 1:1, it ensures the chat exists, is unblocked and scales the Contact’s origin.

pub(crate) async fn create_for_contact_with_blocked( context: &Context, contact_id: ContactId, create_blocked: Blocked, ) -> Result<Self>

Same as create_for_contact() with an additional create_blocked parameter that is used in case the chat does not exist or to unblock existing chats. create_blocked won’t block already unblocked chats again.

pub(crate) async fn create_multiuser_record( context: &Context, chattype: Chattype, grpid: &str, grpname: &str, create_blocked: Blocked, create_protected: ProtectionStatus, param: Option<String>, timestamp: i64, ) -> Result<Self>

Create a group or mailinglist raw database record with the given parameters. The function does not add SELF nor checks if the record already exists.

async fn set_selfavatar_timestamp( self, context: &Context, timestamp: i64, ) -> Result<()>

pub(crate) async fn set_blocked( self, context: &Context, new_blocked: Blocked, ) -> Result<bool>

Updates chat blocked status.

Returns true if the value was modified.

pub async fn block(self, context: &Context) -> Result<()>

Blocks the chat as a result of explicit user action.

pub(crate) async fn block_ex(self, context: &Context, sync: Sync) -> Result<()>

pub async fn unblock(self, context: &Context) -> Result<()>

Unblocks the chat.

pub(crate) async fn unblock_ex( self, context: &Context, sync: Sync, ) -> Result<()>

pub async fn accept(self, context: &Context) -> Result<()>

Accept the contact request.

Unblocks the chat and scales up origin of contacts.

pub(crate) async fn accept_ex(self, context: &Context, sync: Sync) -> Result<()>

pub(crate) async fn inner_set_protection( self, context: &Context, protect: ProtectionStatus, ) -> Result<bool>

Sets protection without sending a message.

Returns whether the protection status was actually modified.

pub(crate) async fn add_protection_msg( self, context: &Context, protect: ProtectionStatus, contact_id: Option<ContactId>, timestamp_sort: i64, ) -> Result<()>

Adds an info message to the chat, telling the user that the protection status changed.

Params:

• contact_id: In a 1:1 chat, pass the chat partner’s contact id.
• timestamp_sort is used as the timestamp of the added message and should be the timestamp of the change happening.

async fn set_protection_for_timestamp_sort( self, context: &Context, protect: ProtectionStatus, timestamp_sort: i64, contact_id: Option<ContactId>, ) -> Result<()>

Sets protection and adds a message.

timestamp_sort is used as the timestamp of the added message and should be the timestamp of the change happening.

pub(crate) async fn set_protection( self, context: &Context, protect: ProtectionStatus, timestamp_sent: i64, contact_id: Option<ContactId>, ) -> Result<()>

Sets protection and sends or adds a message.

timestamp_sent is the “sent” timestamp of a message caused the protection state change.

pub(crate) async fn set_protection_for_contact( context: &Context, contact_id: ContactId, timestamp: i64, ) -> Result<()>

Sets the 1:1 chat with the given address to ProtectionStatus::Protected, and posts a SystemMessage::ChatProtectionEnabled into it.

If necessary, creates a hidden chat for this.

pub async fn set_visibility( self, context: &Context, visibility: ChatVisibility, ) -> Result<()>

Archives or unarchives a chat.

pub(crate) async fn set_visibility_ex( self, context: &Context, sync: Sync, visibility: ChatVisibility, ) -> Result<()>

pub async fn unarchive_if_not_muted( self, context: &Context, msg_state: MessageState, ) -> Result<()>

Unarchives a chat that is archived and not muted. Needed after a message is added to a chat so that the chat gets a normal visibility again. msg_state is the state of the message. Matters only for incoming messages currently. For multiple outgoing messages the function may be called once with MessageState::Undefined. Sending an appropriate event is up to the caller. Also emits DC_EVENT_MSGS_CHANGED for DC_CHAT_ID_ARCHIVED_LINK when the number of archived chats with unread messages increases (which is possible if the chat is muted).

pub(crate) fn emit_msg_event( self, context: &Context, msg_id: MsgId, important: bool, )

Emits an appropriate event for a message. important is whether a notification should be shown.

pub async fn delete(self, context: &Context) -> Result<()>

Deletes a chat.

pub async fn set_draft( self, context: &Context, msg: Option<&mut Message>, ) -> Result<()>

Sets draft message.

Passing None as message just deletes the draft

async fn get_draft_msg_id(self, context: &Context) -> Result<Option<MsgId>>

Returns ID of the draft message, if there is one.

pub async fn get_draft(self, context: &Context) -> Result<Option<Message>>

Returns draft message, if there is one.

async fn maybe_delete_draft(self, context: &Context) -> Result<bool>

Deletes draft message, if there is one.

Returns true, if message was deleted, false otherwise.

async fn do_set_draft( self, context: &Context, msg: &mut Message, ) -> Result<bool>

Set provided message as draft message for specified chat. Returns true if the draft was added or updated in place.

pub async fn get_msg_cnt(self, context: &Context) -> Result<usize>

Returns number of messages in a chat.

pub async fn get_fresh_msg_cnt(self, context: &Context) -> Result<usize>

Returns the number of fresh messages in the chat.

pub(crate) async fn get_timestamp( self, context: &Context, ) -> Result<Option<i64>>

Returns timestamp of the latest message in the chat.

pub async fn get_similar_chat_ids( self, context: &Context, ) -> Result<Vec<(ChatId, f64)>>

Returns a list of active similar chat IDs sorted by similarity metric.

Jaccard similarity coefficient is used to estimate similarity of chat member sets.

Chat is considered active if something was posted there within the last 42 days.

pub async fn get_similar_chatlist(self, context: &Context) -> Result<Chatlist>

Returns similar chats as a Chatlist.

pub(crate) async fn get_param(self, context: &Context) -> Result<Params>

pub(crate) async fn is_unpromoted(self, context: &Context) -> Result<bool>

Returns true if the chat is not promoted.

pub(crate) async fn is_promoted(self, context: &Context) -> Result<bool>

Returns true if the chat is promoted.

pub async fn is_self_talk(self, context: &Context) -> Result<bool>

Returns true if chat is a saved messages chat.

pub async fn is_device_talk(self, context: &Context) -> Result<bool>

Returns true if chat is a device chat.

pub(crate) async fn get_member_list_timestamp( self, context: &Context, ) -> Result<i64>

Returns chat member list timestamp.

async fn parent_query<T, F>( self, context: &Context, fields: &str, state_out_min: MessageState, f: F, ) -> Result<Option<T>>

where F: Send + FnOnce(&Row<'_>) -> Result<T>, T: Send + 'static,

async fn get_parent_mime_headers( self, context: &Context, state_out_min: MessageState, ) -> Result<Option<(String, String, String)>>

pub async fn get_encryption_info(self, context: &Context) -> Result<String>

Returns multi-line text summary of encryption preferences of all chat contacts.

This can be used to find out if encryption is not available because keys for some users are missing or simply because the majority of the users in a group prefer plaintext emails.

To get more verbose summary for a contact, including its key fingerprint, use Contact::get_encrinfo.

pub fn to_u32(self) -> u32

Bad evil escape hatch.

Avoid using this, eventually types should be cleaned up enough that it is no longer necessary.

pub(crate) async fn reset_gossiped_timestamp( self, context: &Context, ) -> Result<()>

pub async fn get_gossiped_timestamp(self, context: &Context) -> Result<i64>

Get timestamp of the last gossip sent in the chat. Zero return value means that gossip was never sent.

pub(crate) async fn set_gossiped_timestamp( self, context: &Context, timestamp: i64, ) -> Result<()>

pub async fn is_protected(self, context: &Context) -> Result<ProtectionStatus>

Returns true if the chat is protected.

pub(crate) async fn calc_sort_timestamp( self, context: &Context, message_timestamp: i64, always_sort_to_bottom: bool, received: bool, incoming: bool, ) -> Result<i64>

Returns the sort timestamp for a new message in the chat.

message_timestamp should be either the message “sent” timestamp or a timestamp of the corresponding event in case of a system message (usually the current system time). always_sort_to_bottom makes this adjust the returned timestamp up so that the message goes to the chat bottom. received – whether the message is received. Otherwise being sent. incoming – whether the message is incoming.

pub(crate) fn spawn_securejoin_wait(self, context: &Context, timeout: u64)

Spawns a task checking after a timeout whether the SecureJoin has finished for the 1:1 chat and otherwise notifying the user accordingly.

impl ChatId

pub async fn get_ephemeral_timer(self, context: &Context) -> Result<Timer>

Get ephemeral message timer value in seconds.

pub(crate) async fn inner_set_ephemeral_timer( self, context: &Context, timer: Timer, ) -> Result<()>

Set ephemeral timer value without sending a message.

Used when a message arrives indicating that someone else has changed the timer value for a chat.

pub async fn set_ephemeral_timer( self, context: &Context, timer: Timer, ) -> Result<()>

Set ephemeral message timer value in seconds.

If timer value is 0, disable ephemeral message timer.

impl ChatId

pub(crate) async fn update_timestamp( &self, context: &Context, scope: Param, new_timestamp: i64, ) -> Result<bool>

Updates a chat id’s timestamp on disk, if reasonable. Returns true if the caller shall update the settings belonging to the scope.

Trait Implementations

impl Clone for ChatId

fn clone(&self) -> ChatId

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ChatId

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ChatId

fn default() -> ChatId

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ChatId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ChatId

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromSql for ChatId

Allow converting an SQLite integer directly into ChatId.

fn column_result(value: ValueRef<'_>) -> FromSqlResult<Self>

Converts SQLite value into Rust value.

impl Hash for ChatId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ChatId

fn cmp(&self, other: &ChatId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ChatId

fn eq(&self, other: &ChatId) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ChatId

fn partial_cmp(&self, other: &ChatId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ChatId

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSql for ChatId

Allow converting ChatId to an SQLite type.

This allows you to directly store ChatId into the database as well as query for a ChatId.

fn to_sql(&self) -> Result<ToSqlOutput<'_>>

Converts Rust value to SQLite value

impl Copy for ChatId

impl Eq for ChatId

impl StructuralPartialEq for ChatId