Struct InviteLinkClient 

pub struct InviteLinkClient {
    pub(crate) key_store: KeyStore<KeySlotIds>,
    pub(crate) api_configurations: Arc<ApiConfigurations>,
}

Client for organization invite link cryptographic and network operations.

Fields

key_store: KeyStore<KeySlotIds>

api_configurations: Arc<ApiConfigurations>

Implementations

impl InviteLinkClient

pub async fn create_invite_link( &self, organization_id: OrganizationId, allowed_domains: Vec<String>, supports_confirmation: bool, ) -> Result<OrganizationInviteLink, InviteLinkError>

Creates a new organization invite and posts it to the server, returning the full [OrganizationInviteLink] persisted by the server.

Security

Only the sealed invite is posted to the server; the invite secret is never sent. Use InviteLinkClient::get_invite_secret to recover the secret needed to reconstruct the invite link.

pub async fn refresh_invite_link( &self, organization_id: OrganizationId, supports_confirmation: bool, ) -> Result<OrganizationInviteLink, InviteLinkError>

Refresh an existing invite link. This generates a new code and secret.

pub async fn set_invite_confirmation( &self, organization_id: OrganizationId, invite: Invite, supports_confirmation: bool, ) -> Result<OrganizationInviteLink, InviteLinkError>

Updates whether an existing invite link supports confirmation, re-sealing the given invite accordingly and persisting it to the server.

Enabling confirmation re-seals the organization key under the invite’s existing invite key; disabling it strips that envelope. Either way the invite key, code, and secret are left untouched, so links already handed out stay valid. Use InviteLinkClient::refresh_invite_link instead when the code and secret must be rotated.

Security

Only the re-sealed invite is posted to the server; the invite secret is never sent.

pub fn get_invite_secret( &self, organization_id: OrganizationId, invite: Invite, ) -> Result<InviteSecret, InviteLinkError>

Using the organization key, recovers the [InviteSecret] from the invite carried in the given [OrganizationInviteLink] so an admin can reconstruct the invite link.

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>

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

impl FromClient for InviteLinkClient

fn from_client(client: &Client) -> InviteLinkClient

Construct this type from a [Client] reference.

impl FromWasmAbi for InviteLinkClient

type Abi = u32

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> InviteLinkClient

Recover a Self from Self::Abi.

impl IntoWasmAbi for InviteLinkClient

type Abi = u32

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for InviteLinkClient

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<InviteLinkClient>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi( js: <InviteLinkClient as LongRefFromWasmAbi>::Abi, ) -> <InviteLinkClient as LongRefFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for InviteLinkClient

fn is_none(abi: &<InviteLinkClient as FromWasmAbi>::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for InviteLinkClient

fn none() -> <InviteLinkClient as IntoWasmAbi>::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for InviteLinkClient

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<InviteLinkClient>

The type that holds the reference to 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.

unsafe fn ref_from_abi( js: <InviteLinkClient as RefFromWasmAbi>::Abi, ) -> <InviteLinkClient as RefFromWasmAbi>::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for InviteLinkClient

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<InviteLinkClient>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi( js: <InviteLinkClient as RefMutFromWasmAbi>::Abi, ) -> <InviteLinkClient as RefMutFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for InviteLinkClient

fn try_from_js_value(value: JsValue) -> Result<InviteLinkClient, JsValue>

Performs the conversion.

fn try_from_js_value_ref(value: &JsValue) -> Option<InviteLinkClient>

Performs the conversion.

impl VectorFromWasmAbi for InviteLinkClient

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi( js: <InviteLinkClient as VectorFromWasmAbi>::Abi, ) -> Box<[InviteLinkClient]>

impl VectorIntoWasmAbi for InviteLinkClient

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi( vector: Box<[InviteLinkClient]>, ) -> <InviteLinkClient as VectorIntoWasmAbi>::Abi