AccountEvent

public enum AccountEvent
extension AccountEvent: Equatable, Hashable

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.

  • 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.

    Declaration

    Swift

    case commandReceived(command: IncomingDeviceCommand
)

  • 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.

    Declaration

    Swift

    case profileUpdated

  • 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.

    Declaration

    Swift

    case accountAuthStateChanged

  • 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.

    Declaration

    Swift

    case accountDestroyed

  • 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.

    Declaration

    Swift

    case deviceConnected(deviceName: String
)

  • 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.

    Declaration

    Swift

    case deviceDisconnected(deviceId: String, isLocalDevice: Bool
)

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

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

    Declaration

    Swift

    case unknown