Class RecipientPhoneAuthentication


  • public class RecipientPhoneAuthentication
    extends Object
    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..
    • Constructor Detail

      • RecipientPhoneAuthentication

        public RecipientPhoneAuthentication()
    • 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.
      • getRecordVoicePrint

        public String getRecordVoicePrint()
        Reserved..
        Returns:
        recordVoicePrint
      • setRecordVoicePrint

        public void setRecordVoicePrint​(String recordVoicePrint)
        setRecordVoicePrint.
      • getRecordVoicePrintMetadata

        public PropertyMetadata getRecordVoicePrintMetadata()
        Reserved for DocuSign..
        Returns:
        recordVoicePrintMetadata
      • setRecordVoicePrintMetadata

        public void setRecordVoicePrintMetadata​(PropertyMetadata recordVoicePrintMetadata)
        setRecordVoicePrintMetadata.
      • 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.
        Overrides:
        equals in class Object
        Returns:
        true or false depending on comparison result.
      • hashCode

        public int hashCode()
        Returns the HashCode.
        Overrides:
        hashCode in class Object
      • toString

        public String toString()
        Converts the given object to string.
        Overrides:
        toString in class Object