RegisterAccountParams

public struct RegisterAccountParams : Codable, Sendable

Undocumented

  • Undocumented

    Declaration

    Swift

    public init(
    username: String, email: String, password: String, agreement: Bool, locale: String,
    reason: String? = nil, token: String? = nil, fullname: String? = nil,
    captchaSolution: String? = nil, captchaToken: String? = nil, captchaAnswerData: String? = nil
)

  • The desired username for the account

    Declaration

    Swift

    public var username: String

  • The email address to be used for login.

    Declaration

    Swift

    public var email: String

  • The password to be used for login

    Declaration

    Swift

    public var password: String

  • Whether the user agrees to the local rules, terms, and policies. These should be presented to the user in order to allow them to consent before setting this parameter to true.

    Declaration

    Swift

    public var agreement: Bool

  • The language of the confirmation email that will be sent.

    Declaration

    Swift

    public var locale: String

  • If registrations require manual approval, this text will be reviewed by moderators.

    Declaration

    Swift

    public var reason: String?

  • Invite token required when the registrations aren’t public. Only supported by Pleroma and Akkoma

    Declaration

    Swift

    public var token: String?

  • Full name. Only supported by Pleroma and Akkoma

    Declaration

    Swift

    public var fullname: String?

  • Contains provider-specific captcha solution. Only supported by Pleroma and Akkoma

    Declaration

    Swift

    public var captchaSolution: String?

  • Contains provider-specific captcha token. Only supported by Pleroma and Akkoma

    Declaration

    Swift

    public var captchaToken: String?

  • Contains provider-specific captcha data. Only supported by Pleroma and Akkoma

    Declaration

    Swift

    public var captchaAnswerData: String?