Package com.docusign.esign.model
Class RecipientPhoneAuthentication
- java.lang.Object
-
- com.docusign.esign.model.RecipientPhoneAuthentication
-
- All Implemented Interfaces:
Serializable
public class RecipientPhoneAuthentication extends Object implements Serializable
A complex type that Contains the elements: * recipMayProvideNumber - Boolean. When set to **true**, the recipient can use whatever phone number they choose. * senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use. * recordVoicePrint - Reserved. * validateRecipProvidedNumber - Reserved..- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description RecipientPhoneAuthentication()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RecipientPhoneAuthenticationaddSenderProvidedNumbersItem(String senderProvidedNumbersItem)addSenderProvidedNumbersItem.booleanequals(Object o)Compares objects.StringgetRecipMayProvideNumber()Boolean.PropertyMetadatagetRecipMayProvideNumberMetadata()Metadata that indicates whether the `recipMayProvideNumber` property can be edited..StringgetRecordVoicePrint()Reserved..PropertyMetadatagetRecordVoicePrintMetadata()Reserved for DocuSign..List<String>getSenderProvidedNumbers()An Array containing a list of phone numbers the recipient may use for SMS text authentication.PropertyMetadatagetSenderProvidedNumbersMetadata()Metadata that indicates whether the `senderProvidedNumbers` property can be edited..StringgetValidateRecipProvidedNumber()Reserved..PropertyMetadatagetValidateRecipProvidedNumberMetadata()Reserved for DocuSign..inthashCode()Returns the HashCode.RecipientPhoneAuthenticationrecipMayProvideNumber(String recipMayProvideNumber)recipMayProvideNumber.RecipientPhoneAuthenticationrecipMayProvideNumberMetadata(PropertyMetadata recipMayProvideNumberMetadata)recipMayProvideNumberMetadata.RecipientPhoneAuthenticationrecordVoicePrint(String recordVoicePrint)recordVoicePrint.RecipientPhoneAuthenticationrecordVoicePrintMetadata(PropertyMetadata recordVoicePrintMetadata)recordVoicePrintMetadata.RecipientPhoneAuthenticationsenderProvidedNumbers(List<String> senderProvidedNumbers)senderProvidedNumbers.RecipientPhoneAuthenticationsenderProvidedNumbersMetadata(PropertyMetadata senderProvidedNumbersMetadata)senderProvidedNumbersMetadata.voidsetRecipMayProvideNumber(String recipMayProvideNumber)setRecipMayProvideNumber.voidsetRecipMayProvideNumberMetadata(PropertyMetadata recipMayProvideNumberMetadata)setRecipMayProvideNumberMetadata.voidsetRecordVoicePrint(String recordVoicePrint)setRecordVoicePrint.voidsetRecordVoicePrintMetadata(PropertyMetadata recordVoicePrintMetadata)setRecordVoicePrintMetadata.voidsetSenderProvidedNumbers(List<String> senderProvidedNumbers)setSenderProvidedNumbers.voidsetSenderProvidedNumbersMetadata(PropertyMetadata senderProvidedNumbersMetadata)setSenderProvidedNumbersMetadata.voidsetValidateRecipProvidedNumber(String validateRecipProvidedNumber)setValidateRecipProvidedNumber.voidsetValidateRecipProvidedNumberMetadata(PropertyMetadata validateRecipProvidedNumberMetadata)setValidateRecipProvidedNumberMetadata.StringtoString()Converts the given object to string.RecipientPhoneAuthenticationvalidateRecipProvidedNumber(String validateRecipProvidedNumber)validateRecipProvidedNumber.RecipientPhoneAuthenticationvalidateRecipProvidedNumberMetadata(PropertyMetadata validateRecipProvidedNumberMetadata)validateRecipProvidedNumberMetadata.
-
-
-
Method Detail
-
recipMayProvideNumber
public RecipientPhoneAuthentication recipMayProvideNumber(String recipMayProvideNumber)
recipMayProvideNumber.- Returns:
- RecipientPhoneAuthentication
-
getRecipMayProvideNumber
public String getRecipMayProvideNumber()
Boolean. When set to **true**, the recipient can supply a phone number their choice..- Returns:
- recipMayProvideNumber
-
setRecipMayProvideNumber
public void setRecipMayProvideNumber(String recipMayProvideNumber)
setRecipMayProvideNumber.
-
recipMayProvideNumberMetadata
public RecipientPhoneAuthentication recipMayProvideNumberMetadata(PropertyMetadata recipMayProvideNumberMetadata)
recipMayProvideNumberMetadata.- Returns:
- RecipientPhoneAuthentication
-
getRecipMayProvideNumberMetadata
public PropertyMetadata getRecipMayProvideNumberMetadata()
Metadata that indicates whether the `recipMayProvideNumber` property can be edited..- Returns:
- recipMayProvideNumberMetadata
-
setRecipMayProvideNumberMetadata
public void setRecipMayProvideNumberMetadata(PropertyMetadata recipMayProvideNumberMetadata)
setRecipMayProvideNumberMetadata.
-
recordVoicePrint
public RecipientPhoneAuthentication recordVoicePrint(String recordVoicePrint)
recordVoicePrint.- Returns:
- RecipientPhoneAuthentication
-
getRecordVoicePrint
public String getRecordVoicePrint()
Reserved..- Returns:
- recordVoicePrint
-
setRecordVoicePrint
public void setRecordVoicePrint(String recordVoicePrint)
setRecordVoicePrint.
-
recordVoicePrintMetadata
public RecipientPhoneAuthentication recordVoicePrintMetadata(PropertyMetadata recordVoicePrintMetadata)
recordVoicePrintMetadata.- Returns:
- RecipientPhoneAuthentication
-
getRecordVoicePrintMetadata
public PropertyMetadata getRecordVoicePrintMetadata()
Reserved for DocuSign..- Returns:
- recordVoicePrintMetadata
-
setRecordVoicePrintMetadata
public void setRecordVoicePrintMetadata(PropertyMetadata recordVoicePrintMetadata)
setRecordVoicePrintMetadata.
-
senderProvidedNumbers
public RecipientPhoneAuthentication senderProvidedNumbers(List<String> senderProvidedNumbers)
senderProvidedNumbers.- Returns:
- RecipientPhoneAuthentication
-
addSenderProvidedNumbersItem
public RecipientPhoneAuthentication addSenderProvidedNumbersItem(String senderProvidedNumbersItem)
addSenderProvidedNumbersItem.- Returns:
- RecipientPhoneAuthentication
-
getSenderProvidedNumbers
public List<String> getSenderProvidedNumbers()
An Array containing a list of phone numbers the recipient may use for SMS text authentication. .- Returns:
- senderProvidedNumbers
-
setSenderProvidedNumbers
public void setSenderProvidedNumbers(List<String> senderProvidedNumbers)
setSenderProvidedNumbers.
-
senderProvidedNumbersMetadata
public RecipientPhoneAuthentication senderProvidedNumbersMetadata(PropertyMetadata senderProvidedNumbersMetadata)
senderProvidedNumbersMetadata.- Returns:
- RecipientPhoneAuthentication
-
getSenderProvidedNumbersMetadata
public PropertyMetadata getSenderProvidedNumbersMetadata()
Metadata that indicates whether the `senderProvidedNumbers` property can be edited..- Returns:
- senderProvidedNumbersMetadata
-
setSenderProvidedNumbersMetadata
public void setSenderProvidedNumbersMetadata(PropertyMetadata senderProvidedNumbersMetadata)
setSenderProvidedNumbersMetadata.
-
validateRecipProvidedNumber
public RecipientPhoneAuthentication validateRecipProvidedNumber(String validateRecipProvidedNumber)
validateRecipProvidedNumber.- Returns:
- RecipientPhoneAuthentication
-
getValidateRecipProvidedNumber
public String getValidateRecipProvidedNumber()
Reserved..- Returns:
- validateRecipProvidedNumber
-
setValidateRecipProvidedNumber
public void setValidateRecipProvidedNumber(String validateRecipProvidedNumber)
setValidateRecipProvidedNumber.
-
validateRecipProvidedNumberMetadata
public RecipientPhoneAuthentication validateRecipProvidedNumberMetadata(PropertyMetadata validateRecipProvidedNumberMetadata)
validateRecipProvidedNumberMetadata.- Returns:
- RecipientPhoneAuthentication
-
getValidateRecipProvidedNumberMetadata
public PropertyMetadata getValidateRecipProvidedNumberMetadata()
Reserved for DocuSign..- Returns:
- validateRecipProvidedNumberMetadata
-
setValidateRecipProvidedNumberMetadata
public void setValidateRecipProvidedNumberMetadata(PropertyMetadata validateRecipProvidedNumberMetadata)
setValidateRecipProvidedNumberMetadata.
-
equals
public boolean equals(Object o)
Compares objects.
-
-