Package io.github.ma1uta.matrix.client.model.account

Class RegisterRequest

  • public class RegisterRequest
extends Object
    Request for register for an account on this homeserver.

    • Field Detail

      • auth

        private AuthenticationData auth
        Additional authentication information for the user-interactive authentication API. Note that this information is not used to define how the registered user should be authenticated, but is instead used to authenticate the register call itself. It should be left empty, or omitted, unless an earlier call returned an response with status code 401.

      • bindEmail

        private Boolean bindEmail
        If true, the server binds the email used for authentication to the Matrix ID with the ID Server.

      • bindMsisdn

        private Boolean bindMsisdn
        If true, the server binds the phone number used for authentication to the Matrix ID with the identity server.

      • username

        private String username
        The basis for the localpart of the desired Matrix ID. If omitted, the homeserver MUST generate a Matrix ID local part.

      • password

        private char[] password
        The desired password for the account.

      • deviceId

        private String deviceId
        ID of the client device. If this does not correspond to a known client device, a new device will be created. The server will auto-generate a device_id if this is not specified.

      • initialDeviceDisplayName

        private String initialDeviceDisplayName
        A display name to assign to the newly-created device. Ignored if device_id corresponds to a known device.

      • inhibitLogin

        private Boolean inhibitLogin
        If true, an access_token and device_id should not be returned from this call, therefore preventing an automatic login. Defaults to false.

    • Constructor Detail

      • RegisterRequest

        public RegisterRequest()

    • Method Detail

      • getBindEmail

        public Boolean getBindEmail()

      • setBindEmail

        public void setBindEmail​(Boolean bindEmail)

      • getBindMsisdn

        public Boolean getBindMsisdn()

      • setBindMsisdn

        public void setBindMsisdn​(Boolean bindMsisdn)

      • getUsername

        public String getUsername()

      • setUsername

        public void setUsername​(String username)

      • getPassword

        public char[] getPassword()

      • setPassword

        public void setPassword​(char[] password)

      • getDeviceId

        public String getDeviceId()

      • setDeviceId

        public void setDeviceId​(String deviceId)

      • getInitialDeviceDisplayName

        public String getInitialDeviceDisplayName()

      • setInitialDeviceDisplayName

        public void setInitialDeviceDisplayName​(String initialDeviceDisplayName)

      • getInhibitLogin

        public Boolean getInhibitLogin()

      • setInhibitLogin

        public void setInhibitLogin​(Boolean inhibitLogin)