Struct fidl_fuchsia_identity_account::AccountProxy

pub struct AccountProxy { /* private fields */ }

Implementations

impl AccountProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for Account

pub fn take_event_stream(&self) -> AccountEventStream

Get a Stream of events from the remote end of the Account protocol

Panics

Panics if the event stream was already taken.

pub fn get_auth_state(&self) -> QueryResponseFut<AuthTargetGetAuthStateResult>

Returns the current AuthState of the target.

Returns: auth_state The target’s current authentication state.

pub fn register_auth_listener( &self, payload: AuthTargetRegisterAuthListenerRequest ) -> QueryResponseFut<AuthTargetRegisterAuthListenerResult>

Connects a channel that will receive changes in the authentication state of the target.

listener [required] The client end of an AuthListener channel initial_state If true, the listener will receive the initial auth state in addition to any changes. granularity An AuthChangeGranularity expressing the magnitude of change in authentication state that will lead to AuthStateChange events.

pub fn get_lifetime(&self) -> QueryResponseFut<Lifetime>

Returns the account’s lifetime.

pub fn get_persona_ids(&self) -> QueryResponseFut<Vec<u64>>

Returns a vector of all the personae defined for the account. NOTE: Currently all accounts have exactly one persona.

pub fn get_default_persona( &self, persona: ServerEnd<PersonaMarker> ) -> QueryResponseFut<AccountGetDefaultPersonaResult>

Connects a channel to read properties of and access tokens for the default persona for the account.

persona The server end of a Persona channel

Returns: id The identifier for the default persona

pub fn get_persona( &self, id: u64, persona: ServerEnd<PersonaMarker> ) -> QueryResponseFut<AccountGetPersonaResult>

Connects a channel to read properties of and access tokens for one of the personae for the account.

id The persona’s identifier as returned by GetPersonaIds() persona The server end of a Persona channel

pub fn get_auth_mechanism_enrollments( &self ) -> QueryResponseFut<AccountGetAuthMechanismEnrollmentsResult>

Returns all authentication mechanism enrollments.

pub fn create_auth_mechanism_enrollment( &self, interaction: ServerEnd<InteractionMarker> ) -> QueryResponseFut<AccountCreateAuthMechanismEnrollmentResult>

Create a new enrollment of the provided authentication mechanism, and add it to the account.

interaction An Interaction channel enabling the user to enroll a new authentication mechanism or complete authentication challenges using an existing mechanism if these are necessary.

Returns: The AuthMechanismEnrollmentId of the created enrollment.

pub fn remove_auth_mechanism_enrollment( &self, enrollment_id: u64 ) -> QueryResponseFut<AccountRemoveAuthMechanismEnrollmentResult>

Remove an authentication mechanism enrollment for the account.

enrollment_id The id of the enrollment to remove.

pub fn storage_lock(&self) -> QueryResponseFut<AccountStorageLockResult>

Locks all access to an account and its storage. After a successful call, all Account and Persona channels for this account will be terminated.

pub fn interaction_lock(&self) -> QueryResponseFut<AccountInteractionLockResult>

Locks interaction with an account. After a successful call, the account AuthStateSummary will be set to INTERACTION_LOCKED.

Fails with FailedPrecondition if authentication is not enabled for the account.

pub fn get_data_directory( &self, data_directory: ServerEnd<DirectoryMarker> ) -> QueryResponseFut<AccountGetDataDirectoryResult>

Connects a channel to access a data directory of the account. The directory is writable, and is initially empty for a newly created account. The directory is persisted according to the lifetime of the account and is never modified by the account system.

NOTE: This method should only be called by the root session component instance. Multiple component instance clients are not yet supported.

data_directory The server end of a fuchsia.io.Directory channel

Trait Implementations

impl AccountProxyInterface for AccountProxy

type GetAuthStateResponseFut = QueryResponseFut<Result<AuthState, Error>>

fn get_auth_state(&self) -> Self::GetAuthStateResponseFut

type RegisterAuthListenerResponseFut = QueryResponseFut<Result<(), Error>>

fn register_auth_listener( &self, payload: AuthTargetRegisterAuthListenerRequest ) -> Self::RegisterAuthListenerResponseFut

type GetLifetimeResponseFut = QueryResponseFut<Lifetime>

fn get_lifetime(&self) -> Self::GetLifetimeResponseFut

type GetPersonaIdsResponseFut = QueryResponseFut<Vec<u64, Global>>

fn get_persona_ids(&self) -> Self::GetPersonaIdsResponseFut

type GetDefaultPersonaResponseFut = QueryResponseFut<Result<u64, Error>>

fn get_default_persona( &self, persona: ServerEnd<PersonaMarker> ) -> Self::GetDefaultPersonaResponseFut

type GetPersonaResponseFut = QueryResponseFut<Result<(), Error>>

fn get_persona( &self, id: u64, persona: ServerEnd<PersonaMarker> ) -> Self::GetPersonaResponseFut

type GetAuthMechanismEnrollmentsResponseFut = QueryResponseFut<Result<Vec<AuthMechanismEnrollmentMetadata, Global>, Error>>

fn get_auth_mechanism_enrollments( &self ) -> Self::GetAuthMechanismEnrollmentsResponseFut

type CreateAuthMechanismEnrollmentResponseFut = QueryResponseFut<Result<u64, Error>>

fn create_auth_mechanism_enrollment( &self, interaction: ServerEnd<InteractionMarker> ) -> Self::CreateAuthMechanismEnrollmentResponseFut

type RemoveAuthMechanismEnrollmentResponseFut = QueryResponseFut<Result<(), Error>>

fn remove_auth_mechanism_enrollment( &self, enrollment_id: u64 ) -> Self::RemoveAuthMechanismEnrollmentResponseFut

type StorageLockResponseFut = QueryResponseFut<Result<(), Error>>

fn storage_lock(&self) -> Self::StorageLockResponseFut

type InteractionLockResponseFut = QueryResponseFut<Result<(), Error>>

fn interaction_lock(&self) -> Self::InteractionLockResponseFut

type GetDataDirectoryResponseFut = QueryResponseFut<Result<(), Error>>

fn get_data_directory( &self, data_directory: ServerEnd<DirectoryMarker> ) -> Self::GetDataDirectoryResponseFut

impl Clone for AccountProxy

fn clone(&self) -> AccountProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AccountProxy

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Proxy for AccountProxy

type Protocol = AccountMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed<'a>(&'a self) -> OnSignals<'a>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.