Struct matrix_sdk::matrix_auth::LoginBuilder

pub struct LoginBuilder { /* private fields */ }

Builder type used to configure optional settings for logging in with a username or token.

Created with MatrixAuth::login_username or MatrixAuth::login_token. Finalized with .send().

Implementations

impl LoginBuilder

pub fn device_id(self, value: &str) -> Self

Set the device ID.

The device ID is a unique ID that will be associated with this session. If not set, the homeserver will create one. Can be an existing device ID from a previous login call. Note that this should be done only if the client also holds the corresponding encryption keys.

pub fn initial_device_display_name(self, value: &str) -> Self

Set the initial device display name.

The device display name is the public name that will be associated with the device ID. Only necessary the first time you log in with this device ID. It can be changed later.

pub fn request_refresh_token(self) -> Self

Advertise support for refreshing access tokens.

By default, the Client won’t handle refreshing access tokens, so Client::refresh_access_token() or MatrixAuth::refresh_access_token() needs to be called manually.

This behavior can be changed by calling handle_refresh_tokens() when building the Client.

Note that refreshing access tokens might not be supported or might be enforced by the homeserver regardless of this setting.

pub async fn send(self) -> Result<Response>

Send the login request.

Instead of calling this function and .awaiting its return value, you can also .await the LoginBuilder directly.

Panics

Panics if a session was already restored or logged in.

Trait Implementations

impl IntoFuture for LoginBuilder

type Output = Result<Response, Error>

The output that the future will produce on completion.

type IntoFuture = Pin<Box<dyn Future<Output = <LoginBuilder as IntoFuture>::Output> + Send>>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.