Struct OAuthAuthCodeUrlBuilder

pub struct OAuthAuthCodeUrlBuilder { /* private fields */ }

Builder type used to configure optional settings for authorization with an OAuth 2.0 authorization server via the Authorization Code flow.

Created with OAuth::login(). Finalized with Self::build().

Implementations

impl OAuthAuthCodeUrlBuilder

pub fn prompt(self, prompt: Vec<Prompt>) -> Self

Set the Prompt of the authorization URL.

If this is not set, it is assumed that the user wants to log into an existing account.

Prompt::Create can be used to signify that the user wants to register a new account.

pub fn user_id_hint(self, user_id: &UserId) -> Self

Set the hint to the Authorization Server about the Matrix user ID the End-User might use to log in, as defined in MSC4198.

pub async fn build(self) -> Result<OAuthAuthorizationData, OAuthError>

Get the URL that should be presented to login via the Authorization Code flow.

This URL should be presented to the user and once they are redirected to the redirect_uri, the login can be completed by calling OAuth::finish_login().

Returns an error if the client registration was not restored, or if a request fails.