Enum Param

#[repr(u8)]
pub enum Param {
    File = 102,
    Filename = 118,
    OverrideSenderDisplayname = 79,
    Width = 119,
    Height = 104,
    Duration = 100,
    MimeType = 109,
    SendHtml = 84,
    GuaranteeE2ee = 99,
    ProtectQuote = 48,
    ErroneousE2ee = 101,
    ForcePlaintext = 117,
    SkipAutocrypt = 111,
    WantsMdn = 114,
    Reaction = 120,
    LastReactionTimestamp = 121,
    LastReactionMsgId = 89,
    LastReactionContactId = 49,
    Bot = 98,
    Forwarded = 97,
    Quote = 113,
    Summary1 = 52,
    Cmd = 83,
    Arg = 69,
    Arg2 = 70,
    Arg3 = 71,
    Arg4 = 72,
    AttachGroupImage = 65,
    WebrtcRoom = 86,
    PrepForwards = 80,
    SetLatitude = 108,
    SetLongitude = 110,
    Unpromoted = 85,
    ProfileImage = 105,
    Selftalk = 75,
    LastSubject = 116,
    Devicetalk = 68,
    ListPost = 112,
    ListId = 115,
    StatusTimestamp = 106,
    AvatarTimestamp = 74,
    EphemeralSettingsTimestamp = 66,
    SubjectTimestamp = 67,
    GroupNameTimestamp = 103,
    MemberListTimestamp = 107,
    WebxdcDocument = 82,
    WebxdcDocumentTimestamp = 87,
    WebxdcSummary = 78,
    WebxdcSummaryTimestamp = 81,
    WebxdcIntegration = 51,
    WebxdcIntegrateFor = 50,
    ForceSticker = 88,
}

Available param keys.

Variants

File = 102

For messages

Filename = 118

For messages: original filename (as shown in chat)

OverrideSenderDisplayname = 79

For messages: This name should be shown instead of contact.get_display_name() (used if this is a mailinglist or explicitly set using set_override_sender_name(), eg. by bots)

Width = 119

For Messages

Height = 104

For Messages

Duration = 100

For Messages

MimeType = 109

For Messages

SendHtml = 84

For Messages: HTML to be written to the database and to be send. SendHtml param is not used for received messages. Use MsgId::get_html() to get HTML of received messages.

GuaranteeE2ee = 99

For Messages: message is encrypted, outgoing: guarantee E2EE or the message is not send

ProtectQuote = 48

For Messages: quoted message is encrypted.

If this message is sent unencrypted, quote text should be replaced.

ErroneousE2ee = 101

For Messages: decrypted with validation errors or without mutual set, if neither ‘c’ nor ‘e’ are preset, the messages is only transport encrypted.

ForcePlaintext = 117

For Messages: force unencrypted message, a value from ForcePlaintext enum.

SkipAutocrypt = 111

For Messages: do not include Autocrypt header.

WantsMdn = 114

For Messages

Reaction = 120

For Messages: the message is a reaction.

LastReactionTimestamp = 121

For Chats: the timestamp of the last reaction.

LastReactionMsgId = 89

For Chats: Message ID of the last reaction.

LastReactionContactId = 49

For Chats: Contact ID of the last reaction.

Bot = 98

For Messages: a message with “Auto-Submitted: auto-generated” header (“bot”).

Forwarded = 97

For Messages: unset or 0=not forwarded, 1=forwarded from unknown msg_id, >9 forwarded from msg_id

Quote = 113

For Messages: quoted text.

Summary1 = 52

For Messages: the 1st part of summary text (i.e. before the dash if any).

Cmd = 83

For Messages

Arg = 69

For Messages

Arg2 = 70

For Messages

Arg3 = 71

Secure-Join-Fingerprint header for {vc,vg}-request-with-auth messages.

Arg4 = 72

Deprecated Secure-Join-Group header for messages.

AttachGroupImage = 65

For Messages

WebrtcRoom = 86

For Messages

PrepForwards = 80

For Messages: space-separated list of messaged IDs of forwarded copies.

This is used when a crate::message::Message is in the crate::message::MessageState::OutPending state but is already forwarded. In this case the forwarded messages are written to the database and their message IDs are added to this parameter of the original message, which is also saved in the database. When the original message is then finally sent this parameter is used to also send all the forwarded messages.

SetLatitude = 108

For Messages

SetLongitude = 110

For Messages

Unpromoted = 85

For Groups

An unpromoted group has not had any messages sent to it and thus only exists on the creator’s device. Any changes made to an unpromoted group do not need to send system messages to the group members to update them of the changes. Once a message has been sent to a group it is promoted and group changes require sending system messages to all members.

ProfileImage = 105

For Groups and Contacts

Selftalk = 75

For Chats Signals whether the chat is the saved messages chat

LastSubject = 116

For Chats: On sending a new message we set the subject to Re: <last subject>. Usually we just use the subject of the parent message, but if the parent message is deleted, we use the LastSubject of the chat.

Devicetalk = 68

For Chats

ListPost = 112

For Chats: If this is a mailing list chat, contains the List-Post address. None if there simply is no List-Post header in the mailing list. Some(“”) if the mailing list is using multiple different List-Post headers.

The List-Post address is the email address where the user can write to in order to post something to the mailing list.

ListId = 115

For Contacts: If this is the List-Post address of a mailing list, contains the List-Id of the mailing list (which is also used as the group id of the chat).

StatusTimestamp = 106

For Contacts: timestamp of status (aka signature or footer) update.

AvatarTimestamp = 74

For Contacts and Chats: timestamp of avatar update.

EphemeralSettingsTimestamp = 66

For Chats: timestamp of status/signature/footer update.

SubjectTimestamp = 67

For Chats: timestamp of subject update.

GroupNameTimestamp = 103

For Chats: timestamp of group name update.

MemberListTimestamp = 107

For Chats: timestamp of member list update.

WebxdcDocument = 82

For Webxdc Message Instances: Current document name

WebxdcDocumentTimestamp = 87

For Webxdc Message Instances: timestamp of document name update.

WebxdcSummary = 78

For Webxdc Message Instances: Current summary

WebxdcSummaryTimestamp = 81

For Webxdc Message Instances: timestamp of summary update.

WebxdcIntegration = 51

For Webxdc Message Instances: Webxdc is an integration, see init_webxdc_integration()

WebxdcIntegrateFor = 50

For Webxdc Message Instances: Chat to integrate the Webxdc for.

ForceSticker = 88

For messages: Whether crate::message::Viewtype::Sticker should be forced.

Trait Implementations

impl Clone for Param

fn clone(&self) -> Param

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Param

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Param

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromPrimitive for Param

fn from_i64(n: i64) -> Option<Self>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(n: u64) -> Option<Self>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl Hash for Param

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 Param

fn cmp(&self, other: &Param) -> 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 Param

fn eq(&self, other: &Param) -> 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 Param

fn partial_cmp(&self, other: &Param) -> 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 Param

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Param

impl Eq for Param

impl StructuralPartialEq for Param