MimiSignUpData

public struct MimiSignUpData

Data object that can be used to sign up a user for a Mimi account.

  • Permission

    Permissions that are requested by Mimi.

    • privacyPolicy: Mimi’s Privacy Policy.
    • termsOfService: Mimi’s Terms of Service.
    • contact: Whether the user can be contacted by Mimi.
    Declaration

    Swift

    public enum Permission : String, CaseIterable
  • email

    Email to use for the user.

    Declaration

    Swift

    public let email: String
  • password

    Password to set for the user.

    Declaration

    Swift

    public let password: String
  • nickname

    Nickname for the user.

    Declaration

    Swift

    public let nickname: String?
  • sex

    Sex of the user.

    Declaration

    Swift

    public let sex: MimiUser.Sex?
  • yearOfBirth

    Year of birth of the user.

    Declaration

    Swift

    public let yearOfBirth: MimiUser.YearOfBirth?
  • country

    Country that the user lives in.

    Declaration

    Swift

    public let country: String?
  • acceptedPermissions

    Collection of permissions that the user has accepted.

    Declaration

    Swift

    public let acceptedPermissions: [Permission]
  • init(email:password:nickname:sex:yearOfBirth:country:acceptedPermissions:)

    Create new Sign Up data.

    Declaration

    Swift

    public init(email: String,
            password: String,
            nickname: String? = nil,
            sex: MimiUser.Sex? = nil,
            yearOfBirth: MimiUser.YearOfBirth? = nil,
            country: String? = nil,
            acceptedPermissions: [Permission]? = nil)
    Parameters
    email

    Email to use for the user (Required).
    password

    Password to set for the user (Required).
    nickname

    Nickname for the user.
    sex

    Sex of the user.
    yearOfBirth

    Year of birth of the user.
    country

    Country that the user lives in.
    acceptedPermissions

    Collection of permissions that the user has accepted.