com.infobip.model

Class TfaUpdateMessageRequest

java.lang.Object

com.infobip.model.TfaUpdateMessageRequest

public class TfaUpdateMessageRequest
extends Object

TfaUpdateMessageRequest

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_LANGUAGE
static String	SERIALIZED_NAME_MESSAGE_TEXT
static String	SERIALIZED_NAME_PIN_LENGTH
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
TfaUpdateMessageRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
TfaLanguage	getLanguage() Language code which message is written in.
String	getMessageText() Content of the message being sent which contains at minimum one placeholder for a PIN code (`{{pin}}`).
Integer	getPinLength() PIN code length.
TfaPinType	getPinType() The type of PIN code that will be generated and sent as part of a 2FA message.
TfaRegionalOptions	getRegional() Region-specific parameters, often imposed by local laws.
String	getRepeatDTMF() If the PIN is sent as a voice message, the DTMF code allows the recipient to replay the message.
String	getSenderId() The name that will appear as the sender of the 2FA message (e.g.
Double	getSpeechRate() The speed of narration for messages sent as voice.
int	hashCode()
TfaUpdateMessageRequest	language(TfaLanguage language)
TfaUpdateMessageRequest	messageText(String messageText)
TfaUpdateMessageRequest	pinLength(Integer pinLength)
TfaUpdateMessageRequest	pinType(TfaPinType pinType)
TfaUpdateMessageRequest	regional(TfaRegionalOptions regional)
TfaUpdateMessageRequest	repeatDTMF(String repeatDTMF)
TfaUpdateMessageRequest	senderId(String senderId)
void	setLanguage(TfaLanguage language)
void	setMessageText(String messageText)
void	setPinLength(Integer pinLength)
void	setPinType(TfaPinType pinType)
void	setRegional(TfaRegionalOptions regional)
void	setRepeatDTMF(String repeatDTMF)
void	setSenderId(String senderId)
void	setSpeechRate(Double speechRate)
TfaUpdateMessageRequest	speechRate(Double speechRate)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_LANGUAGE

public static final String SERIALIZED_NAME_LANGUAGE

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_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

TfaUpdateMessageRequest

public TfaUpdateMessageRequest()

Method Detail

language

public TfaUpdateMessageRequest language(TfaLanguage language)

getLanguage

public TfaLanguage getLanguage()

Language code which message is written in. This is used when sending text-to-speech messages. If not defined, it will default to English (`en`).

Returns:

language

setLanguage

public void setLanguage(TfaLanguage language)

messageText

public TfaUpdateMessageRequest messageText(String messageText)

getMessageText

public String getMessageText()

Content of the message being sent which contains at minimum one placeholder for a PIN code (`{{pin}}`). Placeholder format is `{{placeholderName}}`.

Returns:

messageText

setMessageText

public void setMessageText(String messageText)

pinLength

public TfaUpdateMessageRequest pinLength(Integer pinLength)

getPinLength

public Integer getPinLength()

PIN code length.

Returns:

pinLength

setPinLength

public void setPinLength(Integer pinLength)

pinType

public TfaUpdateMessageRequest pinType(TfaPinType pinType)

getPinType

public TfaPinType getPinType()

The type of PIN code that will be generated and sent as part of a 2FA message.

Returns:

pinType

setPinType

public void setPinType(TfaPinType pinType)

regional

public TfaUpdateMessageRequest regional(TfaRegionalOptions regional)

getRegional

public TfaRegionalOptions getRegional()

Region-specific parameters, often imposed by local laws. Use this, if country or region that you are sending a message to requires additional information.

Returns:

regional

setRegional

public void setRegional(TfaRegionalOptions regional)

repeatDTMF

public TfaUpdateMessageRequest repeatDTMF(String repeatDTMF)

getRepeatDTMF

public String getRepeatDTMF()

If the PIN is sent as a voice message, the DTMF code allows the recipient to replay the message.

Returns:

repeatDTMF

setRepeatDTMF

public void setRepeatDTMF(String repeatDTMF)

senderId

public TfaUpdateMessageRequest senderId(String senderId)

getSenderId

public String getSenderId()

The name that will appear as the sender of the 2FA message (e.g. CompanyName).

Returns:

senderId

setSenderId

public void setSenderId(String senderId)

speechRate

public TfaUpdateMessageRequest speechRate(Double speechRate)

getSpeechRate

public Double getSpeechRate()

The speed of narration for messages sent as voice. 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