TfaMessage (infobip-api-java-client 3.2.0 API)

java.lang.Object
- com.infobip.model.TfaMessage

```
public class TfaMessage
extends Object
```
TfaMessage

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_APPLICATION_ID`
`static String`	`SERIALIZED_NAME_LANGUAGE`
`static String`	`SERIALIZED_NAME_MESSAGE_ID`
`static String`	`SERIALIZED_NAME_MESSAGE_TEXT`
`static String`	`SERIALIZED_NAME_PIN_LENGTH`
`static String`	`SERIALIZED_NAME_PIN_PLACEHOLDER`
`static String`	`SERIALIZED_NAME_PIN_TYPE`
`static String`	`SERIALIZED_NAME_REGIONAL`
`static String`	`SERIALIZED_NAME_REPEAT_D_T_M_F`
`static String`	`SERIALIZED_NAME_SENDER_ID`
`static String`	`SERIALIZED_NAME_SPEECH_RATE`

Constructor Summary

Constructors
Constructor and Description

TfaMessage()

Constructors
Constructor and Description
`TfaMessage()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TfaMessage`	`applicationId(String applicationId)`
`boolean`	`equals(Object o)`
`String`	`getApplicationId()` The ID of the application that represents your service (e.g.
`TfaLanguage`	`getLanguage()` The language code which message is written in used when sending text-to-speech messages.
`String`	`getMessageId()` The ID of the message template (message body with the PIN placeholder) that is sent to the recipient.
`String`	`getMessageText()` Text of a message that will be sent.
`Integer`	`getPinLength()` PIN code length.
`String`	`getPinPlaceholder()` The PIN code placeholder that will be replaced with a generated PIN code.
`TfaPinType`	`getPinType()` The type of PIN code that will be generated and sent as part of 2FA message.
`TfaRegionalOptions`	`getRegional()` Region specific parameters, often specified by local laws.
`String`	`getRepeatDTMF()` In case PIN message is sent by Voice, DTMF code will enable replaying the message.
`String`	`getSenderId()` The name that will appear as the sender of the 2FA message (Example: CompanyName).
`Double`	`getSpeechRate()` In case PIN message is sent by Voice, the speed of speech can be set for the message.
`int`	`hashCode()`
`TfaMessage`	`language(TfaLanguage language)`
`TfaMessage`	`messageId(String messageId)`
`TfaMessage`	`messageText(String messageText)`
`TfaMessage`	`pinLength(Integer pinLength)`
`TfaMessage`	`pinPlaceholder(String pinPlaceholder)`
`TfaMessage`	`pinType(TfaPinType pinType)`
`TfaMessage`	`regional(TfaRegionalOptions regional)`
`TfaMessage`	`repeatDTMF(String repeatDTMF)`
`TfaMessage`	`senderId(String senderId)`
`void`	`setApplicationId(String applicationId)`
`void`	`setLanguage(TfaLanguage language)`
`void`	`setMessageId(String messageId)`
`void`	`setMessageText(String messageText)`
`void`	`setPinLength(Integer pinLength)`
`void`	`setPinPlaceholder(String pinPlaceholder)`
`void`	`setPinType(TfaPinType pinType)`
`void`	`setRegional(TfaRegionalOptions regional)`
`void`	`setRepeatDTMF(String repeatDTMF)`
`void`	`setSenderId(String senderId)`
`void`	`setSpeechRate(Double speechRate)`
`TfaMessage`	`speechRate(Double speechRate)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_APPLICATION_ID
```
public static final String SERIALIZED_NAME_APPLICATION_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LANGUAGE
```
public static final String SERIALIZED_NAME_LANGUAGE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MESSAGE_ID
```
public static final String SERIALIZED_NAME_MESSAGE_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MESSAGE_TEXT
```
public static final String SERIALIZED_NAME_MESSAGE_TEXT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PIN_LENGTH
```
public static final String SERIALIZED_NAME_PIN_LENGTH
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PIN_PLACEHOLDER
```
public static final String SERIALIZED_NAME_PIN_PLACEHOLDER
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PIN_TYPE
```
public static final String SERIALIZED_NAME_PIN_TYPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REGIONAL
```
public static final String SERIALIZED_NAME_REGIONAL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REPEAT_D_T_M_F
```
public static final String SERIALIZED_NAME_REPEAT_D_T_M_F
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SENDER_ID
```
public static final String SERIALIZED_NAME_SENDER_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SPEECH_RATE
```
public static final String SERIALIZED_NAME_SPEECH_RATE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TfaMessage
```
public TfaMessage()
```
- Method Detail
  - applicationId
```
public TfaMessage applicationId(String applicationId)
```
  - getApplicationId
```
public String getApplicationId()
```
    The ID of the application that represents your service (e.g. 2FA for login, 2FA for changing the password, etc.) for which the requested message has been created.
    
    Returns:
    
    applicationId
  - setApplicationId
```
public void setApplicationId(String applicationId)
```
  - language
```
public TfaMessage language(TfaLanguage language)
```
  - getLanguage
```
public TfaLanguage getLanguage()
```
    The language code which message is written in used when sending text-to-speech messages. If not defined, it will default to English (`en`).
    
    Returns:
    
    language
  - setLanguage
```
public void setLanguage(TfaLanguage language)
```
  - messageId
```
public TfaMessage messageId(String messageId)
```
  - getMessageId
```
public String getMessageId()
```
    The ID of the message template (message body with the PIN placeholder) that is sent to the recipient.
    
    Returns:
    
    messageId
  - setMessageId
```
public void setMessageId(String messageId)
```
  - messageText
```
public TfaMessage messageText(String messageText)
```
  - getMessageText
```
public String getMessageText()
```
    Text of a message that will be sent. Message text must contain `pinPlaceholder`.
    
    Returns:
    
    messageText
  - setMessageText
```
public void setMessageText(String messageText)
```
  - pinLength
```
public TfaMessage pinLength(Integer pinLength)
```
  - getPinLength
```
public Integer getPinLength()
```
    PIN code length.
    
    Returns:
    
    pinLength
  - setPinLength
```
public void setPinLength(Integer pinLength)
```
  - pinPlaceholder
```
public TfaMessage pinPlaceholder(String pinPlaceholder)
```
  - getPinPlaceholder
```
public String getPinPlaceholder()
```
    The PIN code placeholder that will be replaced with a generated PIN code.
    
    Returns:
    
    pinPlaceholder
  - setPinPlaceholder
```
public void setPinPlaceholder(String pinPlaceholder)
```
  - pinType
```
public TfaMessage pinType(TfaPinType pinType)
```
  - getPinType
```
public TfaPinType getPinType()
```
    The type of PIN code that will be generated and sent as part of 2FA message. You can set PIN type to numeric, alpha, alphanumeric or hex.
    
    Returns:
    
    pinType
  - setPinType
```
public void setPinType(TfaPinType pinType)
```
  - regional
```
public TfaMessage regional(TfaRegionalOptions regional)
```
  - getRegional
```
public TfaRegionalOptions getRegional()
```
    Region specific parameters, often specified by local laws. Use this if country or region that you are sending SMS to requires some extra parameters.
    
    Returns:
    
    regional
  - setRegional
```
public void setRegional(TfaRegionalOptions regional)
```
  - repeatDTMF
```
public TfaMessage repeatDTMF(String repeatDTMF)
```
  - getRepeatDTMF
```
public String getRepeatDTMF()
```
    In case PIN message is sent by Voice, DTMF code will enable replaying the message.
    
    Returns:
    
    repeatDTMF
  - setRepeatDTMF
```
public void setRepeatDTMF(String repeatDTMF)
```
  - senderId
```
public TfaMessage senderId(String senderId)
```
  - getSenderId
```
public String getSenderId()
```
    The name that will appear as the sender of the 2FA message (Example: CompanyName).
    
    Returns:
    
    senderId
  - setSenderId
```
public void setSenderId(String senderId)
```
  - speechRate
```
public TfaMessage speechRate(Double speechRate)
```
  - getSpeechRate
```
public Double getSpeechRate()
```
    In case PIN message is sent by Voice, the speed of speech can be set for the message. Supported range is from `0.5` to `2`.
    
    Returns:
    
    speechRate
  - setSpeechRate
```
public void setSpeechRate(Double speechRate)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class TfaMessage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_APPLICATION_ID

SERIALIZED_NAME_LANGUAGE

SERIALIZED_NAME_MESSAGE_ID

SERIALIZED_NAME_MESSAGE_TEXT

SERIALIZED_NAME_PIN_LENGTH

SERIALIZED_NAME_PIN_PLACEHOLDER

SERIALIZED_NAME_PIN_TYPE

SERIALIZED_NAME_REGIONAL

SERIALIZED_NAME_REPEAT_D_T_M_F

SERIALIZED_NAME_SENDER_ID

SERIALIZED_NAME_SPEECH_RATE

Constructor Detail

TfaMessage

Method Detail

applicationId

getApplicationId

setApplicationId

language

getLanguage

setLanguage

messageId

getMessageId

setMessageId

messageText

getMessageText

setMessageText

pinLength

getPinLength

setPinLength

pinPlaceholder

getPinPlaceholder

setPinPlaceholder

pinType

getPinType

setPinType

regional

getRegional

setRegional

repeatDTMF

getRepeatDTMF

setRepeatDTMF

senderId

getSenderId

setSenderId

speechRate

getSpeechRate

setSpeechRate

equals

hashCode

toString