Struct NoteBuilder 

pub struct NoteBuilder<C> { /* private fields */ }

Builder for the build_note method.

Implementations

impl<C> NoteBuilder<C>

pub fn new(client: C) -> Self

Creates a builder with the client.

pub fn as_request(&self) -> &Request

Gets the request object for reuse.

pub fn text(&mut self, text: impl Into<String>) -> &mut Self

Sets the text of the note.

pub fn poll( &mut self, choices: impl IntoIterator<Item = impl Into<String>>, ) -> &mut Self

Creates a poll and sets the choices.

pub fn poll_multiple(&mut self, multiple: bool) -> &mut Self

Sets whether to allow multiple votes.

pub fn poll_expires_at(&mut self, at: DateTime<Utc>) -> &mut Self

Sets when the vote will expire.

pub fn poll_expires_after(&mut self, after: Duration) -> &mut Self

Sets how long the vote will expire after.

pub fn attach_file(&mut self, file: impl EntityRef<DriveFile>) -> &mut Self

Attaches the specified file to the note.

pub fn attach_files( &mut self, files: impl IntoIterator<Item = impl EntityRef<DriveFile>>, ) -> &mut Self

Adds attachments to the note.

pub fn visibility(&mut self, visibility: Visibility) -> &mut Self

Sets the visibility of the note.

pub fn public(&mut self) -> &mut Self

Sets the note to be visible to everyone.

This is equivalent to .visibility(Visibility::Public).

pub fn home_only(&mut self) -> &mut Self

Sets the note to be visible only to the home timeline.

This is equivalent to .visibility(Visibility::Home).

pub fn followers_only(&mut self) -> &mut Self

Sets the note to be visible only to the followers.

This is equivalent to .visibility(Visibility::Followers).

pub fn direct( &mut self, recipients: impl IntoIterator<Item = impl EntityRef<User>>, ) -> &mut Self

Sets the note to be visible only to the specified users.

pub fn hide_content(&mut self, cw_text: impl Into<String>) -> &mut Self

Hides the contents of the note as a content warning with the specified text.

pub fn via_mobile(&mut self, via_mobile: bool) -> &mut Self

Sets whether to show the note as posted from a mobile device.

pub fn local_only(&mut self, local_only: bool) -> &mut Self

Sets the note to be visible only to users on the same instance.

pub fn extract_mentions(&mut self, extract_mentions: bool) -> &mut Self

Sets whether or not to extract mentions (i.e. @username) from the text of the note.

Mentions are extracted by default, and you would need this method if you want to disable this behavior.

pub fn extract_hashtags(&mut self, extract_hashtags: bool) -> &mut Self

Sets whether or not to extract hashtags (i.e. #tag) from the text of the note.

Hashtags are extracted by default, and you would need this method if you want to disable this behavior.

pub fn extract_emojis(&mut self, extract_emojis: bool) -> &mut Self

Sets whether or not to extract emojis (i.e. :emoji:) from the text of the note.

Emojis are extracted by default, and you would need this method if you want to disable this behavior.

pub fn reply(&mut self, note: impl EntityRef<Note>) -> &mut Self

Sets the note as a reply to the specified note.

pub fn renote(&mut self, note: impl EntityRef<Note>) -> &mut Self

Sets the note as a renote of the specified note.

pub fn channel(&mut self, channel: impl EntityRef<Channel>) -> &mut Self

Available on crate feature 12-47-0 only.

Sets the note to be posted to the specified channel.

impl<C: Client> NoteBuilder<C>

pub async fn create(&self) -> Result<Note, Error<C::Error>>

Creates the note.