VerificationMessageTemplateType (aws-android-sdk-cognitoidentityprovider 2.81.1 API)

java.lang.Object
- com.amazonaws.services.cognitoidentityprovider.model.VerificationMessageTemplateType

All Implemented Interfaces:

java.io.Serializable
```
public class VerificationMessageTemplateType
extends java.lang.Object
implements java.io.Serializable
```
The template for verification messages.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

VerificationMessageTemplateType()

Constructors
Constructor and Description
`VerificationMessageTemplateType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getDefaultEmailOption()` The default email option.
`java.lang.String`	`getEmailMessage()` The template for email messages that Amazon Cognito sends to your users.
`java.lang.String`	`getEmailMessageByLink()` The email message template for sending a confirmation link to the user.
`java.lang.String`	`getEmailSubject()` The subject line for the email message template.
`java.lang.String`	`getEmailSubjectByLink()` The subject line for the email message template for sending a confirmation link to the user.
`java.lang.String`	`getSmsMessage()` The template for SMS messages that Amazon Cognito sends to your users.
`int`	`hashCode()`
`void`	`setDefaultEmailOption(DefaultEmailOptionType defaultEmailOption)` The default email option.
`void`	`setDefaultEmailOption(java.lang.String defaultEmailOption)` The default email option.
`void`	`setEmailMessage(java.lang.String emailMessage)` The template for email messages that Amazon Cognito sends to your users.
`void`	`setEmailMessageByLink(java.lang.String emailMessageByLink)` The email message template for sending a confirmation link to the user.
`void`	`setEmailSubject(java.lang.String emailSubject)` The subject line for the email message template.
`void`	`setEmailSubjectByLink(java.lang.String emailSubjectByLink)` The subject line for the email message template for sending a confirmation link to the user.
`void`	`setSmsMessage(java.lang.String smsMessage)` The template for SMS messages that Amazon Cognito sends to your users.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`VerificationMessageTemplateType`	`withDefaultEmailOption(DefaultEmailOptionType defaultEmailOption)` The default email option.
`VerificationMessageTemplateType`	`withDefaultEmailOption(java.lang.String defaultEmailOption)` The default email option.
`VerificationMessageTemplateType`	`withEmailMessage(java.lang.String emailMessage)` The template for email messages that Amazon Cognito sends to your users.
`VerificationMessageTemplateType`	`withEmailMessageByLink(java.lang.String emailMessageByLink)` The email message template for sending a confirmation link to the user.
`VerificationMessageTemplateType`	`withEmailSubject(java.lang.String emailSubject)` The subject line for the email message template.
`VerificationMessageTemplateType`	`withEmailSubjectByLink(java.lang.String emailSubjectByLink)` The subject line for the email message template for sending a confirmation link to the user.
`VerificationMessageTemplateType`	`withSmsMessage(java.lang.String smsMessage)` The template for SMS messages that Amazon Cognito sends to your users.

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

- Constructor Detail
  - VerificationMessageTemplateType
```
public VerificationMessageTemplateType()
```
- Method Detail
  - getSmsMessage
```
public java.lang.String getSmsMessage()
```
    The template for SMS messages that Amazon Cognito sends to your users.
    
    Constraints:
    Length: 6 - 140
    Pattern: .*\{####\}.*
    
    Returns:
    
    The template for SMS messages that Amazon Cognito sends to your users.
  - setSmsMessage
```
public void setSmsMessage(java.lang.String smsMessage)
```
    The template for SMS messages that Amazon Cognito sends to your users.
    
    Constraints:
    Length: 6 - 140
    Pattern: .*\{####\}.*
    
    Parameters:
    
    smsMessage -
    The template for SMS messages that Amazon Cognito sends to your users.
  - withSmsMessage
```
public VerificationMessageTemplateType withSmsMessage(java.lang.String smsMessage)
```
    The template for SMS messages that Amazon Cognito sends to your users.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 6 - 140
    Pattern: .*\{####\}.*
    
    Parameters:
    
    smsMessage -
    The template for SMS messages that Amazon Cognito sends to your users.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEmailMessage
```
public java.lang.String getEmailMessage()
```
    The template for email messages that Amazon Cognito sends to your users. You can set an EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Constraints:
    Length: 6 - 20000
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{####\}[\p{L}\p{M}\p{S}\p{ N}\p{P}\s*]*
    
    Returns:
    
    The template for email messages that Amazon Cognito sends to your users. You can set an EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
  - setEmailMessage
```
public void setEmailMessage(java.lang.String emailMessage)
```
    The template for email messages that Amazon Cognito sends to your users. You can set an EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Constraints:
    Length: 6 - 20000
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{####\}[\p{L}\p{M}\p{S}\p{ N}\p{P}\s*]*
    
    Parameters:
    
    emailMessage -
    The template for email messages that Amazon Cognito sends to your users. You can set an EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
  - withEmailMessage
```
public VerificationMessageTemplateType withEmailMessage(java.lang.String emailMessage)
```
    The template for email messages that Amazon Cognito sends to your users. You can set an EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 6 - 20000
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{####\}[\p{L}\p{M}\p{S}\p{ N}\p{P}\s*]*
    
    Parameters:
    
    emailMessage -
    The template for email messages that Amazon Cognito sends to your users. You can set an EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEmailSubject
```
public java.lang.String getEmailSubject()
```
    The subject line for the email message template. You can set an EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Constraints:
    Length: 1 - 140
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s]+
    
    Returns:
    
    The subject line for the email message template. You can set an EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
  - setEmailSubject
```
public void setEmailSubject(java.lang.String emailSubject)
```
    The subject line for the email message template. You can set an EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Constraints:
    Length: 1 - 140
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s]+
    
    Parameters:
    
    emailSubject -
    The subject line for the email message template. You can set an EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
  - withEmailSubject
```
public VerificationMessageTemplateType withEmailSubject(java.lang.String emailSubject)
```
    The subject line for the email message template. You can set an EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 140
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s]+
    
    Parameters:
    
    emailSubject -
    The subject line for the email message template. You can set an EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEmailMessageByLink
```
public java.lang.String getEmailMessageByLink()
```
    The email message template for sending a confirmation link to the user. You can set an EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Constraints:
    Length: 6 - 20000
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{##[\p{L}\p{M}\p{S}\p{N}\p {P}\s*]*##\}[\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*
    
    Returns:
    
    The email message template for sending a confirmation link to the user. You can set an EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
  - setEmailMessageByLink
```
public void setEmailMessageByLink(java.lang.String emailMessageByLink)
```
    The email message template for sending a confirmation link to the user. You can set an EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Constraints:
    Length: 6 - 20000
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{##[\p{L}\p{M}\p{S}\p{N}\p {P}\s*]*##\}[\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*
    
    Parameters:
    
    emailMessageByLink -
    The email message template for sending a confirmation link to the user. You can set an EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
  - withEmailMessageByLink
```
public VerificationMessageTemplateType withEmailMessageByLink(java.lang.String emailMessageByLink)
```
    The email message template for sending a confirmation link to the user. You can set an EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 6 - 20000
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{##[\p{L}\p{M}\p{S}\p{N}\p {P}\s*]*##\}[\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*
    
    Parameters:
    
    emailMessageByLink -
    The email message template for sending a confirmation link to the user. You can set an EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEmailSubjectByLink
```
public java.lang.String getEmailSubjectByLink()
```
    The subject line for the email message template for sending a confirmation link to the user. You can set an EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Constraints:
    Length: 1 - 140
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s]+
    
    Returns:
    
    The subject line for the email message template for sending a confirmation link to the user. You can set an EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
  - setEmailSubjectByLink
```
public void setEmailSubjectByLink(java.lang.String emailSubjectByLink)
```
    The subject line for the email message template for sending a confirmation link to the user. You can set an EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Constraints:
    Length: 1 - 140
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s]+
    
    Parameters:
    
    emailSubjectByLink -
    The subject line for the email message template for sending a confirmation link to the user. You can set an EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
  - withEmailSubjectByLink
```
public VerificationMessageTemplateType withEmailSubjectByLink(java.lang.String emailSubjectByLink)
```
    The subject line for the email message template for sending a confirmation link to the user. You can set an EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 140
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s]+
    
    Parameters:
    
    emailSubjectByLink -
    The subject line for the email message template for sending a confirmation link to the user. You can set an EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDefaultEmailOption
```
public java.lang.String getDefaultEmailOption()
```
    The default email option.
    
    Constraints:
    Allowed Values: CONFIRM_WITH_LINK, CONFIRM_WITH_CODE
    
    Returns:
    
    The default email option.
    
    See Also:
    
    DefaultEmailOptionType
  - setDefaultEmailOption
```
public void setDefaultEmailOption(java.lang.String defaultEmailOption)
```
    The default email option.
    
    Constraints:
    Allowed Values: CONFIRM_WITH_LINK, CONFIRM_WITH_CODE
    
    Parameters:
    
    defaultEmailOption -
    The default email option.
    
    See Also:
    
    DefaultEmailOptionType
  - withDefaultEmailOption
```
public VerificationMessageTemplateType withDefaultEmailOption(java.lang.String defaultEmailOption)
```
    The default email option.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: CONFIRM_WITH_LINK, CONFIRM_WITH_CODE
    
    Parameters:
    
    defaultEmailOption -
    The default email option.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    DefaultEmailOptionType
  - setDefaultEmailOption
```
public void setDefaultEmailOption(DefaultEmailOptionType defaultEmailOption)
```
    The default email option.
    
    Constraints:
    Allowed Values: CONFIRM_WITH_LINK, CONFIRM_WITH_CODE
    
    Parameters:
    
    defaultEmailOption -
    The default email option.
    
    See Also:
    
    DefaultEmailOptionType
  - withDefaultEmailOption
```
public VerificationMessageTemplateType withDefaultEmailOption(DefaultEmailOptionType defaultEmailOption)
```
    The default email option.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: CONFIRM_WITH_LINK, CONFIRM_WITH_CODE
    
    Parameters:
    
    defaultEmailOption -
    The default email option.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    DefaultEmailOptionType
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class VerificationMessageTemplateType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VerificationMessageTemplateType

Method Detail

getSmsMessage

setSmsMessage

withSmsMessage

getEmailMessage

setEmailMessage

withEmailMessage

getEmailSubject

setEmailSubject

withEmailSubject

getEmailMessageByLink

setEmailMessageByLink

withEmailMessageByLink

getEmailSubjectByLink

setEmailSubjectByLink

withEmailSubjectByLink

getDefaultEmailOption

setDefaultEmailOption

withDefaultEmailOption

setDefaultEmailOption

withDefaultEmailOption

toString

hashCode

equals