Struct Response 

pub struct Response { /* private fields */ }

Represents the response to a Send Message API request.

Implementations

impl Response

pub const fn id(&self) -> Option<u64>

Gets the Response id.

Unique ID assigned to the sent message.

pub fn set_id(&mut self, val: u64)

Sets the Response id.

Unique ID assigned to the sent message.

pub fn unset_id(&mut self) -> Option<u64>

Unsets the Response id.

Unique ID assigned to the sent message.

pub fn with_id(self, val: u64) -> Self

Builder function that sets the Response id.

Unique ID assigned to the sent message.

pub const fn automatic_new_visibility_policy(&self) -> Option<VisibilityPolicy>

Gets the Response automatic_new_visibility_policy.

If the message’s sender had configured their visibility policy settings

to potentially automatically follow or unmute topics when sending messages,

and one of these policies did in fact change the user’s visibility policy

for the topic where this message was sent, the new value for that user’s

visibility policy for the recipient topic.

Only present if the sender’s visibility was in fact changed.

The value can be either unmuted or followed.

Clients will also be notified about the change in policy via a

user_topic event as usual. This field is intended to be used by clients

to explicitly inform the user when a topic’s visibility policy was changed

automatically due to sending a message.

For example, the Zulip web application uses this field to decide whether

to display a warning or notice suggesting to unmute the topic after

sending a message to a muted channel. Such a notice would be confusing in

the event that the act of sending the message had already resulted in the

user automatically unmuting or following the topic in question.

Changes: New in Zulip 8.0 (feature level 218).

pub fn set_automatic_new_visibility_policy(&mut self, val: VisibilityPolicy)

Sets the Response automatic_new_visibility_policy.

If the message’s sender had configured their visibility policy settings

to potentially automatically follow or unmute topics when sending messages,

and one of these policies did in fact change the user’s visibility policy

for the topic where this message was sent, the new value for that user’s

visibility policy for the recipient topic.

Only present if the sender’s visibility was in fact changed.

The value can be either unmuted or followed.

Clients will also be notified about the change in policy via a

user_topic event as usual. This field is intended to be used by clients

to explicitly inform the user when a topic’s visibility policy was changed

automatically due to sending a message.

For example, the Zulip web application uses this field to decide whether

to display a warning or notice suggesting to unmute the topic after

sending a message to a muted channel. Such a notice would be confusing in

the event that the act of sending the message had already resulted in the

user automatically unmuting or following the topic in question.

Changes: New in Zulip 8.0 (feature level 218).

pub fn unset_automatic_new_visibility_policy( &mut self, ) -> Option<VisibilityPolicy>

Unsets the Response automatic_new_visibility_policy.

If the message’s sender had configured their visibility policy settings

to potentially automatically follow or unmute topics when sending messages,

and one of these policies did in fact change the user’s visibility policy

for the topic where this message was sent, the new value for that user’s

visibility policy for the recipient topic.

Only present if the sender’s visibility was in fact changed.

The value can be either unmuted or followed.

Clients will also be notified about the change in policy via a

user_topic event as usual. This field is intended to be used by clients

to explicitly inform the user when a topic’s visibility policy was changed

automatically due to sending a message.

For example, the Zulip web application uses this field to decide whether

to display a warning or notice suggesting to unmute the topic after

sending a message to a muted channel. Such a notice would be confusing in

the event that the act of sending the message had already resulted in the

user automatically unmuting or following the topic in question.

Changes: New in Zulip 8.0 (feature level 218).

pub fn with_automatic_new_visibility_policy(self, val: VisibilityPolicy) -> Self

Builder function that sets the Response automatic_new_visibility_policy.

If the message’s sender had configured their visibility policy settings

to potentially automatically follow or unmute topics when sending messages,

and one of these policies did in fact change the user’s visibility policy

for the topic where this message was sent, the new value for that user’s

visibility policy for the recipient topic.

Only present if the sender’s visibility was in fact changed.

The value can be either unmuted or followed.

Clients will also be notified about the change in policy via a

user_topic event as usual. This field is intended to be used by clients

to explicitly inform the user when a topic’s visibility policy was changed

automatically due to sending a message.

For example, the Zulip web application uses this field to decide whether

to display a warning or notice suggesting to unmute the topic after

sending a message to a muted channel. Such a notice would be confusing in

the event that the act of sending the message had already resulted in the

user automatically unmuting or following the topic in question.

Changes: New in Zulip 8.0 (feature level 218).

impl Response

pub const fn new() -> Self

Creates a new Response.

Trait Implementations

impl Clone for Response

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Response

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

Formats the value using the given formatter.

impl Default for Response

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Response

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Response

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

Formats the value using the given formatter.

impl Eq for Response

impl PartialEq for Response

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

Equality operator ==.

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

Inequality operator !=.

impl Response for Response

fn msg(&self) -> &str

Gets the Response msg field.

fn set_msg<'a, C: Into<Cow<'a, str>>>(&mut self, msg: C)

Sets the Response msg field.

fn with_msg<'a, C: Into<Cow<'a, str>>>(self, msg: C) -> Self

Builder function that sets the Response msg field.

fn result(&self) -> ApiResult

Gets the Response result field.

fn set_result(&mut self, result: ApiResult)

Sets the Response result field.

fn with_result(self, result: ApiResult) -> Self

Builder function that sets the Response result field.

fn code(&self) -> Option<ErrorCode>

Gets the Response code field.

fn set_code(&mut self, code: ErrorCode)

Sets the Response code field.

fn unset_code(&mut self) -> Option<ErrorCode>

Unsets the Response code field.

fn with_code(self, code: ErrorCode) -> Self

Builder function that sets the Response code field.

fn ignored_parameters_unsupported(&self) -> Option<&[String]>

Gets the Response ignored unsupported parameters list.

fn set_ignored_parameters_unsupported<'a, C: Into<Cow<'a, [String]>>>( &mut self, val: C, )

Sets the Response ignored unsupported parameters list.

fn unset_ignored_parameters_unsupported(&mut self) -> Option<Vec<String>>

Unsets the Response ignored unsupported parameters list.

fn with_ignored_parameters_unsupported<'a, C: Into<Cow<'a, [String]>>>( self, val: C, ) -> Self

Builder function that sets the Response ignored unsupported parameters list.

impl Serialize for Response

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Response