pub struct InviteLinkClient {
pub(crate) key_store: KeyStore<KeySlotIds>,
pub(crate) api_configurations: Arc<ApiConfigurations>,
}Expand description
Client for organization invite link operations.
This is a thin entry point that exposes two focused sub-clients: InviteLinkAdminClient (via
admin) for administrator CRUD operations, and InviteLinkUserClient (via
user) for invitee flows. The other methods on this type are deprecated redirects
kept for backwards compatibility.
Fields§
§key_store: KeyStore<KeySlotIds>§api_configurations: Arc<ApiConfigurations>Implementations§
Source§impl InviteLinkClient
impl InviteLinkClient
Sourcepub fn admin(&self) -> InviteLinkAdminClient
pub fn admin(&self) -> InviteLinkAdminClient
Administrative (organization-key) invite link operations.
Sourcepub fn user(&self) -> InviteLinkUserClient
pub fn user(&self) -> InviteLinkUserClient
Invitee (user) invite link operations.
Sourcepub async fn create_invite_link(
&self,
organization_id: OrganizationId,
allowed_domains: Vec<String>,
supports_confirmation: bool,
) -> Result<OrganizationInviteLink, InviteLinkError>
👎Deprecated: Use invite_link().admin().create(...) instead
pub async fn create_invite_link( &self, organization_id: OrganizationId, allowed_domains: Vec<String>, supports_confirmation: bool, ) -> Result<OrganizationInviteLink, InviteLinkError>
Use invite_link().admin().create(...) instead
Creates a new organization invite and posts it to the server.
Sourcepub async fn refresh_invite_link(
&self,
organization_id: OrganizationId,
supports_confirmation: bool,
) -> Result<OrganizationInviteLink, InviteLinkError>
👎Deprecated: Use invite_link().admin().refresh(...) instead
pub async fn refresh_invite_link( &self, organization_id: OrganizationId, supports_confirmation: bool, ) -> Result<OrganizationInviteLink, InviteLinkError>
Use invite_link().admin().refresh(...) instead
Refresh an existing invite link. This generates a new code and secret.
Sourcepub async fn set_invite_confirmation(
&self,
organization_id: OrganizationId,
invite: Invite,
supports_confirmation: bool,
) -> Result<OrganizationInviteLink, InviteLinkError>
👎Deprecated: Use invite_link().admin().update_confirmation(...) instead
pub async fn set_invite_confirmation( &self, organization_id: OrganizationId, invite: Invite, supports_confirmation: bool, ) -> Result<OrganizationInviteLink, InviteLinkError>
Use invite_link().admin().update_confirmation(...) instead
Updates whether an existing invite link supports confirmation, re-sealing the given invite accordingly and persisting it to the server.
Sourcepub fn get_invite_secret(
&self,
organization_id: OrganizationId,
invite: Invite,
) -> Result<InviteSecret, InviteLinkError>
👎Deprecated: Use invite_link().admin().create(...) or invite_link().admin().refresh(...), which return an OrganizationInviteLinkView, instead
pub fn get_invite_secret( &self, organization_id: OrganizationId, invite: Invite, ) -> Result<InviteSecret, InviteLinkError>
Use invite_link().admin().create(...) or invite_link().admin().refresh(...), which return an OrganizationInviteLinkView, instead
Using the organization key, recovers the [InviteSecret] from the invite carried in the
given OrganizationInviteLink so an admin can reconstruct the invite link.
Sourcepub async fn accept_and_optionally_confirm(
&self,
organization_id: OrganizationId,
code: String,
invite_secret: InviteSecret,
default_collection_name: String,
enroll_into_account_recovery: bool,
) -> Result<(), InviteLinkError>
👎Deprecated: Use invite_link().user().accept_and_optionally_confirm(...) instead
pub async fn accept_and_optionally_confirm( &self, organization_id: OrganizationId, code: String, invite_secret: InviteSecret, default_collection_name: String, enroll_into_account_recovery: bool, ) -> Result<(), InviteLinkError>
Use invite_link().user().accept_and_optionally_confirm(...) instead
Accepts an organization invite for the current user, optionally enrolling into account
recovery (when enroll_into_account_recovery is set) and — when the invite supports
confirmation — self-confirming.
Trait Implementations§
Source§impl From<InviteLinkClient> for JsValue
impl From<InviteLinkClient> for JsValue
Source§fn from(value: InviteLinkClient) -> Self
fn from(value: InviteLinkClient) -> Self
Source§impl FromClient for InviteLinkClient
impl FromClient for InviteLinkClient
Source§fn from_client(client: &Client) -> Self
fn from_client(client: &Client) -> Self
Client] reference.Source§impl FromWasmAbi for InviteLinkClient
impl FromWasmAbi for InviteLinkClient
Source§impl IntoWasmAbi for InviteLinkClient
impl IntoWasmAbi for InviteLinkClient
Source§impl OptionFromWasmAbi for InviteLinkClient
impl OptionFromWasmAbi for InviteLinkClient
Source§impl OptionIntoWasmAbi for InviteLinkClient
impl OptionIntoWasmAbi for InviteLinkClient
Source§impl RefFromWasmAbi for InviteLinkClient
impl RefFromWasmAbi for InviteLinkClient
Source§type Anchor = RcRef<InviteLinkClient>
type Anchor = RcRef<InviteLinkClient>
Self for the duration of the
invocation of the function that has an &Self parameter. This is
required to ensure that the lifetimes don’t persist beyond one function
call, and so that they remain anonymous.Source§impl RefMutFromWasmAbi for InviteLinkClient
impl RefMutFromWasmAbi for InviteLinkClient
impl SupportsConstructor for InviteLinkClient
impl SupportsInstanceProperty for InviteLinkClient
impl SupportsStaticProperty for InviteLinkClient
Source§impl TryFromJsValue for InviteLinkClient
impl TryFromJsValue for InviteLinkClient
Source§impl VectorFromWasmAbi for InviteLinkClient
impl VectorFromWasmAbi for InviteLinkClient
type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi
unsafe fn vector_from_abi(js: Self::Abi) -> Box<[InviteLinkClient]>
Source§impl VectorIntoWasmAbi for InviteLinkClient
impl VectorIntoWasmAbi for InviteLinkClient
type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi
fn vector_into_abi(vector: Box<[InviteLinkClient]>) -> Self::Abi
Source§impl WasmDescribe for InviteLinkClient
impl WasmDescribe for InviteLinkClient
Auto Trait Implementations§
impl !RefUnwindSafe for InviteLinkClient
impl !UnwindSafe for InviteLinkClient
impl Freeze for InviteLinkClient
impl Send for InviteLinkClient
impl Sync for InviteLinkClient
impl Unpin for InviteLinkClient
impl UnsafeUnpin for InviteLinkClient
Blanket Implementations§
§impl<T> AnySync for T
impl<T> AnySync for T
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
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
§impl<T> CompatExt for T
impl<T> CompatExt for T
§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
§unsafe fn clone_handle(handle: Handle) -> Handle
unsafe fn clone_handle(handle: Handle) -> Handle
§unsafe fn consume_handle(handle: Handle) -> Arc<T> ⓘ
unsafe fn consume_handle(handle: Handle) -> Arc<T> ⓘ
Arc<> Read more§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<T> ReturnWasmAbi for Twhere
T: IntoWasmAbi,
impl<T> ReturnWasmAbi for Twhere
T: IntoWasmAbi,
Source§type Abi = <T as IntoWasmAbi>::Abi
type Abi = <T as IntoWasmAbi>::Abi
IntoWasmAbi::AbiSource§fn return_abi(self) -> <T as ReturnWasmAbi>::Abi
fn return_abi(self) -> <T as ReturnWasmAbi>::Abi
IntoWasmAbi::into_abi, except that it may throw and never
return in the case of Err.