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

Class LoginRequest

  • public class LoginRequest
extends Object
    Authenticates the user, and issues an access token they can use to authorize themself in subsequent requests.

    • Field Detail

      • type

        private String type
        Required. The login type being used. One of: ["m.login.password", "m.login.token"].

      • identifier

        private Identifier identifier
        Identification information for the user.

      • user

        @Deprecated
private String user
        Deprecated.
        in favour of identifier.
        The fully qualified user ID or just local part of the user ID, to log in.

      • medium

        @Deprecated
private String medium
        Deprecated.
        in favour of identifier.
        When logging in using a third party identifier, the medium of the identifier. Must be 'email'.

      • password

        private char[] password
        Required when type is m.login.password. The user's password.

      • token

        private String token
        Required when type is m.login.token. The login token.

      • 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.

    • Constructor Detail

      • LoginRequest

        public LoginRequest()

    • Method Detail

      • getType

        public String getType()

      • setType

        public void setType​(String type)

      • getIdentifier

        public Identifier getIdentifier()

      • setIdentifier

        public void setIdentifier​(Identifier identifier)

      • getUser

        public String getUser()

      • setUser

        public void setUser​(String user)

      • getMedium

        public String getMedium()

      • setMedium

        public void setMedium​(String medium)

      • getAddress

        public String getAddress()

      • setAddress

        public void setAddress​(String address)

      • getPassword

        public char[] getPassword()

      • setPassword

        public void setPassword​(char[] password)

      • getToken

        public String getToken()

      • setToken

        public void setToken​(String token)

      • getDeviceId

        public String getDeviceId()

      • setDeviceId

        public void setDeviceId​(String deviceId)

      • getInitialDeviceDisplayName

        public String getInitialDeviceDisplayName()

      • setInitialDeviceDisplayName

        public void setInitialDeviceDisplayName​(String initialDeviceDisplayName)