Enum AccountEvent

Source
pub enum AccountEvent {
    CommandReceived {
        command: IncomingDeviceCommand,
    },
    ProfileUpdated,
    AccountAuthStateChanged,
    AccountDestroyed,
    DeviceConnected {
        device_name: String,
    },
    DeviceDisconnected {
        device_id: String,
        is_local_device: bool,
    },
    Unknown,
}
Expand description

An event that happened on the user’s account.

If the application has registered a DevicePushSubscription as part of its device record, then the Firefox Accounts server can send push notifications about important events that happen on the user’s account. This enum represents the different kinds of event that can occur.

Variants§

§

CommandReceived

Sent when another device has invoked a command for this device to execute.

When receiving this event, the application should inspect the contained command and react appropriately.

§

ProfileUpdated

Sent when the user has modified their account profile information.

When receiving this event, the application should request fresh profile information by calling get_profile with ignore_cache set to true, and update any profile information displayed in its UI.

§

AccountAuthStateChanged

Sent when when there has been a change in authorization status.

When receiving this event, the application should check whether it is still connected to the user’s account by calling check_authorization_status, and updating its UI as appropriate.

§

AccountDestroyed

Sent when the user deletes their Firefox Account.

When receiving this event, the application should act as though the user had signed out, discarding any persisted account state.

§

DeviceConnected

Sent when a new device connects to the user’s account.

When receiving this event, the application may use it to trigger an update of any UI that shows the list of connected devices. It may also show the user an informational notice about the new device, as a security measure.

Fields

§device_name: String
§

DeviceDisconnected

Sent when a device disconnects from the user’s account.

When receiving this event, the application may use it to trigger an update of any UI that shows the list of connected devices.

Fields

§device_id: String
§is_local_device: bool
§

Unknown

An unknown event, most likely an event the client doesn’t support yet.

When receiving this event, the application should gracefully ignore it.

Trait Implementations§

§

impl<UT> ConvertError<UT> for AccountEvent

§

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

Source§

impl Debug for AccountEvent

Source§

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

Formats the value using the given formatter. Read more
§

impl<UT> FfiConverter<UT> for AccountEvent

§

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a [MetadataBuffer].
§

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI. Read more
§

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType. Read more
§

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType. Read more
§

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form. Read more
§

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form. Read more
§

impl<UT> Lift<UT> for AccountEvent

§

type FfiType = <AccountEvent as FfiConverter<UT>>::FfiType

§

fn try_lift(v: Self::FfiType) -> Result<Self>

§

fn try_read(buf: &mut &[u8]) -> Result<Self>

§

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method
§

impl<UT> LiftRef<UT> for AccountEvent

§

impl<UT> LiftReturn<UT> for AccountEvent

§

type ReturnType = <AccountEvent as Lift<UT>>::FfiType

FFI return type for trait interfaces
§

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface
§

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface Read more
§

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result Read more
§

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error Read more
§

impl<UT> Lower<UT> for AccountEvent

§

type FfiType = <AccountEvent as FfiConverter<UT>>::FfiType

§

fn lower(obj: Self) -> Self::FfiType

§

fn write(obj: Self, buf: &mut Vec<u8>)

§

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method
§

impl<UT> LowerError<UT> for AccountEvent

§

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return Read more
§

impl<UT> LowerReturn<UT> for AccountEvent

§

type ReturnType = <AccountEvent as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type. Read more
§

fn lower_return(v: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call Read more
§

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts Read more
§

impl<UT> TypeId<UT> for AccountEvent

§

const TYPE_ID_META: MetadataBuffer

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

§

fn new_handle(value: Arc<T>) -> Handle

Create a new handle for an Arc value Read more
§

unsafe fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more
§

unsafe fn consume_handle(handle: Handle) -> Arc<T>

Consume a handle, getting back the initial Arc<> Read more
§

unsafe fn get_arc(handle: Handle) -> Arc<Self>

Get a clone of the Arc<> using a “borrowed” handle. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T