Struct OAuthCli

pub(crate) struct OAuthCli {
    pub(crate) client: Client,
    pub(crate) restored: bool,
    pub(crate) session_file: PathBuf,
}

An OAuth 2.0 CLI.

Fields

client: Client

The Matrix client.

restored: bool

Whether this is a restored client.

session_file: PathBuf

The path to the file storing the session.

Implementations

impl OAuthCli

pub(crate) async fn new(data_dir: &Path, session_file: PathBuf) -> Result<Self>

Create a new session by logging in.

pub(crate) async fn register_and_login(&self, data_dir: &Path) -> Result<()>

Register the client and log in the user via the OAuth 2.0 Authorization Code flow.

pub(crate) async fn from_stored_session(session_file: PathBuf) -> Result<Self>

Restore a previous session from a file.

pub(crate) async fn run(&self) -> Result<()>

Run the main program.

pub(crate) async fn recover(&self) -> Result<()>

pub(crate) async fn reset_cross_signing(&self) -> Result<()>

pub(crate) fn whoami(&self)

Get information about this session.

pub(crate) async fn account(&self, action: Option<AccountManagementActionFull>)

Get the account management URL.

pub(crate) async fn watch(&self) -> Result<()>

Watch incoming messages.

pub(crate) async fn watch_sliding_sync(&self) -> Result<()>

This watches for incoming responses using the high-level sliding sync helpers (SyncService).

pub(crate) fn setup_background_save(&self)

Sets up this client so that it automatically saves the session onto disk whenever there are new tokens that have been received.

This should always be set up whenever automatic refresh is happening.

pub(crate) async fn update_stored_session(&self) -> Result<()>

Update the session stored on the system.

This should be called everytime the access token (and possibly refresh token) has changed.

pub(crate) async fn refresh_token(&self) -> Result<()>

Refresh the access token.

pub(crate) async fn logout(&self) -> Result<()>

Log out from this session.

Trait Implementations

impl Clone for OAuthCli

fn clone(&self) -> OAuthCli

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OAuthCli

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

Formats the value using the given formatter.