Struct Chat

pub struct Chat {
    pub id: ChatId,
    pub typ: Chattype,
    pub name: String,
    pub visibility: ChatVisibility,
    pub grpid: String,
    pub blocked: Blocked,
    pub param: Params,
    is_sending_locations: bool,
    pub mute_duration: MuteDuration,
}

An object representing a single chat in memory. Chat objects are created using eg. Chat::load_from_db and are not updated on database changes; if you want an update, you have to recreate the object.

Fields

id: ChatId

Database ID.

typ: Chattype

Chat type, e.g. 1:1 chat, group chat, mailing list.

name: String

Chat name.

visibility: ChatVisibility

Whether the chat is archived or pinned.

grpid: String

Group ID. For Chattype::Mailinglist – mailing list address. Empty for 1:1 chats and ad-hoc groups.

blocked: Blocked

Whether the chat is blocked, unblocked or a contact request.

param: Params

Additional chat parameters stored in the database.

is_sending_locations: bool

If location streaming is enabled in the chat.

mute_duration: MuteDuration

Duration of the chat being muted.

Implementations

impl Chat

pub async fn load_from_db(context: &Context, chat_id: ChatId) -> Result<Self>

Loads chat from the database by its ID.

pub fn is_self_talk(&self) -> bool

Returns whether this is the saved messages chat

pub fn is_device_talk(&self) -> bool

Returns true if chat is a device chat.

pub fn is_mailing_list(&self) -> bool

Returns true if chat is a mailing list.

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

Returns None if user can send messages to this chat.

Otherwise returns a reason useful for logging.

pub(crate) async fn why_cant_send_ex( &self, context: &Context, skip_fn: &(dyn Send + Sync + Fn(&CantSendReason) -> bool), ) -> Result<Option<CantSendReason>>

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

Returns true if can send to the chat.

This function can be used by the UI to decide whether to display the input box.

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

Checks if the user is part of a chat and has basically the permissions to edit the chat therefore. The function does not check if the chat type allows editing of concrete elements.

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

pub fn get_id(&self) -> ChatId

Returns chat ID.

pub fn get_type(&self) -> Chattype

Returns chat type.

pub fn get_name(&self) -> &str

Returns chat name.

pub fn get_mailinglist_addr(&self) -> Option<&str>

Returns mailing list address where messages are sent to.

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

Returns profile image path for the chat.

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

Returns chat avatar color.

For 1:1 chats, the color is calculated from the contact’s address for address-contacts and from the OpenPGP key fingerprint for key-contacts. For group chats the color is calculated from the grpid, if present, or the chat name.

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

Returns a struct describing the current state of the chat.

This is somewhat experimental, even more so than the rest of deltachat, and the data returned is still subject to change.

pub fn get_visibility(&self) -> ChatVisibility

Returns chat visibilitiy, e.g. whether it is archived or pinned.

pub fn is_contact_request(&self) -> bool

Returns true if chat is a contact request.

Messages cannot be sent to such chat and read receipts are not sent until the chat is manually unblocked.

pub fn is_unpromoted(&self) -> bool

Returns true if the chat is not promoted.

pub fn is_promoted(&self) -> bool

Returns true if the chat is promoted. This means a message has been sent to it and it not only exists on the users device.

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

Returns true if the chat is encrypted.

pub fn is_sending_locations(&self) -> bool

Returns true if location streaming is enabled in the chat.

pub fn is_muted(&self) -> bool

Returns true if the chat is currently muted.

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

Returns chat member list timestamp.

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

Returns true if member list is stale, i.e. has not been updated for 60 days.

This is used primarily to detect the case where the user just restored an old backup.

async fn prepare_msg_raw( &mut self, context: &Context, msg: &mut Message, update_msg_id: Option<MsgId>, ) -> Result<()>

Adds missing values to the msg object, writes the record to the database.

If update_msg_id is set, that record is reused; if update_msg_id is None, a new record is created.

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

Sends a SyncAction synchronising chat contacts to other devices.

async fn get_sync_id(&self, context: &Context) -> Result<Option<SyncId>>

Returns chat id for the purpose of synchronisation across devices.

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

Synchronises a chat action to other devices.

impl Chat

pub async fn get_last_reaction_if_newer_than( &self, context: &Context, timestamp: i64, ) -> Result<Option<(Message, ContactId, String)>>

Check if there is a reaction newer than the given timestamp.

If so, reaction details are returned and can be used to create a summary string.

Trait Implementations

impl Clone for Chat

fn clone(&self) -> Chat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Chat

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Chat

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Chat

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

where __S: Serializer,

Serialize this value into the given Serde serializer.