Profile

public struct Profile
extension Profile: Equatable, Hashable

Information about the user that controls a Firefox Account.

This struct represents details about the user themselves, and would typically be used to customize account-related UI in the browser so that it is personalize for the current user.

  • uid

    The user’s account uid

    This is an opaque immutable unique identifier for their account.

    Declaration

    Swift

    public var uid: String

  • The user’s current primary email address.

    Note that unlike the uid field, the email address may change over time.

    Declaration

    Swift

    public var email: String

  • The user’s preferred textual display name.

    Declaration

    Swift

    public var displayName: String?

  • The URL of a profile picture representing the user.

    All accounts have a corresponding profile picture. If the user has not provided one then a default image is used.

    Declaration

    Swift

    public var avatar: String

  • Whether the avatar URL represents the default avatar image.

    Declaration

    Swift

    public var isDefaultAvatar: Bool

  • Declaration

    Swift

    public init(
    /**
     * The user's account uid
     *
     * This is an opaque immutable unique identifier for their account.
     */uid: String, 
    /**
     * The user's current primary email address.
     *
     * Note that unlike the `uid` field, the email address may change over time.
     */email: String, 
    /**
     * The user's preferred textual display name.
     */displayName: String?, 
    /**
     * The URL of a profile picture representing the user.
     *
     * All accounts have a corresponding profile picture. If the user has not
     * provided one then a default image is used.
     */avatar: String, 
    /**
     * Whether the `avatar` URL represents the default avatar image.
     */isDefaultAvatar: Bool)

  • Declaration

    Swift

    public static func == (lhs: Profile, rhs: Profile) -> Bool

  • Declaration

    Swift

    public func hash(into hasher: inout Hasher)