Struct IdentityClient 

pub struct IdentityClient {
    pub metrics: Arc<Metrics>,
    pub brand: Option<String>,
    pub access_token: String,
    pub server_url: Url,
    pub matrix_client: Arc<MatrixClient>,
}

A way to access an Identity Server using the Identity Service API from a MatrixClient.

Fields

metrics: Arc<Metrics>

brand: Option<String>

access_token: String

server_url: Url

matrix_client: Arc<MatrixClient>

Implementations

impl IdentityClient

pub fn new( access_token: &str, server_url: Url, matrix_client: Arc<MatrixClient>, ) -> Self

pub async fn do_request( &self, method: Method, endpoint: &str, qs: Option<&[(&str, &str)]>, body: Option<Value>, ) -> Result<Response>

Performs a web request to the server, applying appropriate authorization headers for this client.

pub async fn get_account(&self) -> Result<Value>

Gets account information for the logged in user.

pub async fn get_terms_of_service(&self) -> Result<Value>

Gets the terms of service for which the identity server has.

pub async fn accept_terms(&self, terms_urls: Vec<String>) -> Result<()>

Accepts a given set of URLs from Policy objects returned by the server.

pub async fn accept_all_terms(&self) -> Result<()>

Accepts all terms of service offered by the identity server.

pub async fn lookup( &self, addresses: Vec<String>, algorithm: &str, pepper: &str, ) -> Result<Value>

Looks up a series of third party identifiers.

pub async fn lookup_threepids( &self, identifiers: &[Threepid], allow_plaintext: bool, ) -> Result<Vec<Option<String>>>

Looks up third-party identifiers and returns mxids in the same order as input.

Mirrors the TypeScript SDK behaviour: it negotiates hashing via /hash_details, prefers sha256, and can optionally fall back to plaintext (none).

pub async fn make_email_invite( &self, email_address: &str, room_id: &str, ) -> Result<Value>

Creates a third party email invite.

pub async fn acquire( oidc: &OpenIDConnect, server_url: Url, matrix_client: Arc<MatrixClient>, ) -> Result<Self>

Registers an OpenID Connect token against an identity server and acquires a client.

Trait Implementations

impl Clone for IdentityClient

fn clone(&self) -> IdentityClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.