com.infobip.model

Class TfaStartAuthenticationRequest

java.lang.Object

com.infobip.model.TfaStartAuthenticationRequest

public class TfaStartAuthenticationRequest
extends Object

TfaStartAuthenticationRequest

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_APPLICATION_ID
static String	SERIALIZED_NAME_FROM
static String	SERIALIZED_NAME_MESSAGE_ID
static String	SERIALIZED_NAME_PLACEHOLDERS
static String	SERIALIZED_NAME_TO

Constructor Summary

Constructors

Constructor and Description
TfaStartAuthenticationRequest()

Method Summary

Modifier and Type	Method and Description
TfaStartAuthenticationRequest	applicationId(String applicationId)
boolean	equals(Object o)
TfaStartAuthenticationRequest	from(String from)
String	getApplicationId() The ID of the application that represents your service, e.g.
String	getFrom() Use this parameter if you wish to override the sender ID from the [created](#channels/sms/create-2fa-message-template) message template parameter `senderId`.
String	getMessageId() The ID of the message template (message body with the PIN placeholder) that is sent to the recipient.
Map<String,String>	getPlaceholders() Key value pairs that will be replaced during message sending.
String	getTo() Phone number to which the 2FA message will be sent.
int	hashCode()
TfaStartAuthenticationRequest	messageId(String messageId)
TfaStartAuthenticationRequest	placeholders(Map<String,String> placeholders)
TfaStartAuthenticationRequest	putPlaceholdersItem(String key, String placeholdersItem)
void	setApplicationId(String applicationId)
void	setFrom(String from)
void	setMessageId(String messageId)
void	setPlaceholders(Map<String,String> placeholders)
void	setTo(String to)
TfaStartAuthenticationRequest	to(String to)
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_FROM

public static final String SERIALIZED_NAME_FROM

See Also:

Constant Field Values

SERIALIZED_NAME_MESSAGE_ID

public static final String SERIALIZED_NAME_MESSAGE_ID

See Also:

Constant Field Values

SERIALIZED_NAME_PLACEHOLDERS

public static final String SERIALIZED_NAME_PLACEHOLDERS

See Also:

Constant Field Values

SERIALIZED_NAME_TO

public static final String SERIALIZED_NAME_TO

See Also:

Constant Field Values

Constructor Detail

TfaStartAuthenticationRequest

public TfaStartAuthenticationRequest()

Method Detail

applicationId

public TfaStartAuthenticationRequest 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.

Returns:

applicationId

setApplicationId

public void setApplicationId(String applicationId)

from

public TfaStartAuthenticationRequest from(String from)

getFrom

public String getFrom()

Use this parameter if you wish to override the sender ID from the [created](#channels/sms/create-2fa-message-template) message template parameter `senderId`.

Returns:

from

setFrom

public void setFrom(String from)

messageId

public TfaStartAuthenticationRequest 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)

placeholders

public TfaStartAuthenticationRequest placeholders(Map<String,String> placeholders)

putPlaceholdersItem

public TfaStartAuthenticationRequest putPlaceholdersItem(String key,
                                                         String placeholdersItem)

getPlaceholders

public Map<String,String> getPlaceholders()

Key value pairs that will be replaced during message sending. Placeholder keys should NOT contain curly brackets and should NOT contain a `pin` placeholder. Valid example: `\"placeholders\":{\"firstName\":\"John\"}`

Returns:

placeholders

setPlaceholders

public void setPlaceholders(Map<String,String> placeholders)

to

public TfaStartAuthenticationRequest to(String to)

getTo

public String getTo()

Phone number to which the 2FA message will be sent. Example: 41793026727.

Returns:

to

setTo

public void setTo(String to)

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