Class PhoneRequestToken
- java.lang.Object
-
- io.github.ma1uta.matrix.identity.model.session.PhoneRequestToken
-
public class PhoneRequestToken extends Object
JSON body request of the creating an phone association.
-
-
Field Summary
Fields Modifier and Type Field Description private StringclientSecretRequired.private StringcountryRequired.private StringnextLinkOptional.private StringphoneNumberRequired.private LongsendAttemptRequired.
-
Constructor Summary
Constructors Constructor Description PhoneRequestToken()
-
Method Summary
Modifier and Type Method Description StringgetClientSecret()StringgetCountry()StringgetNextLink()StringgetPhoneNumber()LonggetSendAttempt()voidsetClientSecret(String clientSecret)voidsetCountry(String country)voidsetNextLink(String nextLink)voidsetPhoneNumber(String phoneNumber)voidsetSendAttempt(Long sendAttempt)
-
-
-
Field Detail
-
clientSecret
private String clientSecret
Required. A unique string generated by the client, and used to identify the validation attempt. It must be a string consisting of the characters [0-9a-zA-Z.=_-]. Its length must not exceed 255 characters and it must not be empty.
-
country
private String country
Required. The two-letter uppercase ISO country code that the number in phone_number should be parsed as if it were dialled from.
-
phoneNumber
private String phoneNumber
Required. The phone number to validate.
-
sendAttempt
private Long sendAttempt
Required. The server will only send a SMS if the send_attempt is a number greater than the most recent one which it has seen, scoped to that country + phone_number + client_secret triple. This is to avoid repeatedly sending the same SMS in the case of request retries between the POSTing user and the identity server. The client should increment this value if they desire a new SMS (e.g. a reminder) to be sent.
-
nextLink
private String nextLink
Optional. When the validation is completed, the identity server will redirect the user to this URL.
-
-
Method Detail
-
getClientSecret
public String getClientSecret()
-
setClientSecret
public void setClientSecret(String clientSecret)
-
getCountry
public String getCountry()
-
setCountry
public void setCountry(String country)
-
getPhoneNumber
public String getPhoneNumber()
-
setPhoneNumber
public void setPhoneNumber(String phoneNumber)
-
getSendAttempt
public Long getSendAttempt()
-
setSendAttempt
public void setSendAttempt(Long sendAttempt)
-
getNextLink
public String getNextLink()
-
setNextLink
public void setNextLink(String nextLink)
-
-