Struct matrix_sdk::oidc::OidcEndSessionUrlBuilder
source · pub struct OidcEndSessionUrlBuilder { /* private fields */ }
Available on crate feature
experimental-oidc
only.Expand description
Builder type used to configure optional settings for constructing an RP-Initiated Logout URL with an OpenID Connect provider.
Created with Oidc::logout()
. Finalized with Self::build()
.
Implementations§
source§impl OidcEndSessionUrlBuilder
impl OidcEndSessionUrlBuilder
sourcepub fn post_logout_redirect_uri(self, redirect_uri: Url) -> Self
pub fn post_logout_redirect_uri(self, redirect_uri: Url) -> Self
Set the URI where the user will be redirected after logging out.
Must be one of the post_logout_redirect_uris
registered in the client
metadata.
sourcepub fn ui_locales(self, ui_locales: Vec<LanguageTag>) -> Self
pub fn ui_locales(self, ui_locales: Vec<LanguageTag>) -> Self
Set the preferred locales of the user.
Must be ordered from the preferred locale to the least preferred locale.
sourcepub fn build(self) -> Result<OidcEndSessionData, OidcError>
pub fn build(self) -> Result<OidcEndSessionData, OidcError>
Get the URL that should be presented to log out from the OIDC provider’s interface.
If a post_logout_redirect_uri
was provided, the user will be
redirected to it after logging out with a state
query parameter that
is the same as the one in the OidcEndSessionData
.
Auto Trait Implementations§
impl !RefUnwindSafe for OidcEndSessionUrlBuilder
impl Send for OidcEndSessionUrlBuilder
impl Sync for OidcEndSessionUrlBuilder
impl Unpin for OidcEndSessionUrlBuilder
impl !UnwindSafe for OidcEndSessionUrlBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> CompatExt for T
impl<T> CompatExt for T
§impl<T> FutureExt for T
impl<T> FutureExt for T
§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
§impl<T, UT> HandleAlloc<UT> for T
impl<T, UT> HandleAlloc<UT> for T
§fn new_handle(value: Arc<T>) -> Handle
fn new_handle(value: Arc<T>) -> Handle
Create a new handle for an Arc value Read more
§fn clone_handle(handle: Handle) -> Handle
fn clone_handle(handle: Handle) -> Handle
Clone a handle Read more
§fn consume_handle(handle: Handle) -> Arc<T>
fn consume_handle(handle: Handle) -> Arc<T>
Consume a handle, getting back the initial
Arc<>