MimiUser

public struct MimiUser : Codable
extension MimiUser: Equatable

An individual user that has a Mimi account.

Types
  • Sex

    Sex of a user.

    • male: Male
    • female: Female
    • intersex: Intersex
    Declaration

    Swift

    public enum Sex : String, CaseIterable, Codable
  • PropertyUpdate

    Model for updating a user property.

    • sex: Sex update.
    • yearOfBirth: Year of Birth update.
    • country: Country update.
    Declaration

    Swift

    public enum PropertyUpdate

Properties
  • id

    Unique identifier of the user.

    Note

    This identifier consists of 32 hex digits to represent 16 bytes or 128 bits of data.
    Declaration

    Swift

    public private(set) var id: String? { get }
  • anonymousId

    Unique anonymous identifier.

    Note

    The length of the identifier is 36 characters (32 hex digits + 4 dashes)
    Declaration

    Swift

    public private(set) var anonymousId: String? { get }
  • isAnonymous

    Whether the user is anonymous or not.

    Declaration

    Swift

    public private(set) var isAnonymous: Bool { get }
  • email

    Email address.

    Declaration

    Swift

    public private(set) var email: String? { get }
  • yearOfBirth

    Year of Birth

    Declaration

    Swift

    public private(set) var yearOfBirth: YearOfBirth? { get }
  • sex

    Sex

    Declaration

    Swift

    public private(set) var sex: Sex? { get }
  • nickname

    Nickname

    Declaration

    Swift

    public private(set) var nickname: String? { get }
  • country

    Country

    Declaration

    Swift

    public private(set) var country: String? { get }
  • age

    Age

    Declaration

    Swift

    public var age: Age? { get }
  • isVerified

    Whether the user has verified their email address or not.

    Anonymous users will observe this field as nil.

    Declaration

    Swift

    public private(set) var isVerified: Bool? { get }

Coding
  • init(from:)
    Declaration

    Swift

    public init(from decoder: Decoder) throws

Relations
  • isRelated(to:)

    Whether the user is related to another user.

    Declaration

    Swift

    public func isRelated(to other: MimiUser?) -> Bool
    Parameters
    other

    Other user to check for relations.
    Return Value

    Whether the users are related.