Package com.bandwidth.twofactorauth.models

Class TwoFactorCodeRequestSchema

java.lang.Object
com.bandwidth.twofactorauth.models.TwoFactorCodeRequestSchema
public class TwoFactorCodeRequestSchema
extends java.lang.Object
This is a model class for TwoFactorCodeRequestSchema type.

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  TwoFactorCodeRequestSchema.Builder
    Class to build instances of TwoFactorCodeRequestSchema.

  • Constructor Summary

    Constructors 
    Constructor Description
    TwoFactorCodeRequestSchema()
    Default constructor.
    TwoFactorCodeRequestSchema​(java.lang.String to, java.lang.String from, java.lang.String applicationId, java.lang.String message, double digits, java.lang.String scope)
    Initialization constructor.

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getApplicationId()
    Getter for ApplicationId.
    double getDigits()
    Getter for Digits.
    java.lang.String getFrom()
    Getter for From.
    java.lang.String getMessage()
    Getter for Message.
    java.lang.String getScope()
    Getter for Scope.
    java.lang.String getTo()
    Getter for To.
    void setApplicationId​(java.lang.String applicationId)
    Setter for ApplicationId.
    void setDigits​(double digits)
    Setter for Digits.
    void setFrom​(java.lang.String from)
    Setter for From.
    void setMessage​(java.lang.String message)
    Setter for Message.
    void setScope​(java.lang.String scope)
    Setter for Scope.
    void setTo​(java.lang.String to)
    Setter for To.
    TwoFactorCodeRequestSchema.Builder toBuilder()
    Builds a new TwoFactorCodeRequestSchema.Builder object.
    java.lang.String toString()
    Converts this TwoFactorCodeRequestSchema into string format.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • TwoFactorCodeRequestSchema

      public TwoFactorCodeRequestSchema()
      Default constructor.

    • TwoFactorCodeRequestSchema

      public TwoFactorCodeRequestSchema​(java.lang.String to, java.lang.String from, java.lang.String applicationId, java.lang.String message, double digits, java.lang.String scope)
      Initialization constructor.
      Parameters:
      to - String value for to.
      from - String value for from.
      applicationId - String value for applicationId.
      message - String value for message.
      digits - double value for digits.
      scope - String value for scope.

  • Method Details

    • getTo

      public java.lang.String getTo()
      Getter for To. The phone number to send the 2fa code to.
      Returns:
      Returns the String

    • setTo

      public void setTo​(java.lang.String to)
      Setter for To. The phone number to send the 2fa code to.
      Parameters:
      to - Value for String

    • getFrom

      public java.lang.String getFrom()
      Getter for From. The application phone number, the sender of the 2fa code.
      Returns:
      Returns the String

    • setFrom

      public void setFrom​(java.lang.String from)
      Setter for From. The application phone number, the sender of the 2fa code.
      Parameters:
      from - Value for String

    • getApplicationId

      public java.lang.String getApplicationId()
      Getter for ApplicationId. The application unique ID, obtained from Bandwidth.
      Returns:
      Returns the String

    • setApplicationId

      public void setApplicationId​(java.lang.String applicationId)
      Setter for ApplicationId. The application unique ID, obtained from Bandwidth.
      Parameters:
      applicationId - Value for String

    • getScope

      public java.lang.String getScope()
      Getter for Scope. An optional field to denote what scope or action the 2fa code is addressing. If not supplied, defaults to "2FA".
      Returns:
      Returns the String

    • setScope

      public void setScope​(java.lang.String scope)
      Setter for Scope. An optional field to denote what scope or action the 2fa code is addressing. If not supplied, defaults to "2FA".
      Parameters:
      scope - Value for String

    • getMessage

      public java.lang.String getMessage()
      Getter for Message. The message format of the 2fa code. There are three values that the system will replace "{CODE}", "{NAME}", "{SCOPE}". The "{SCOPE}" and "{NAME} value template are optional, while "{CODE}" must be supplied. As the name would suggest, code will be replace with the actual 2fa code. Name is replaced with the application name, configured during provisioning of 2fa. The scope value is the same value sent during the call and partitioned by the server.
      Returns:
      Returns the String

    • setMessage

      public void setMessage​(java.lang.String message)
      Setter for Message. The message format of the 2fa code. There are three values that the system will replace "{CODE}", "{NAME}", "{SCOPE}". The "{SCOPE}" and "{NAME} value template are optional, while "{CODE}" must be supplied. As the name would suggest, code will be replace with the actual 2fa code. Name is replaced with the application name, configured during provisioning of 2fa. The scope value is the same value sent during the call and partitioned by the server.
      Parameters:
      message - Value for String

    • getDigits

      public double getDigits()
      Getter for Digits. The number of digits for your 2fa code. The valid number ranges from 2 to 8, inclusively.
      Returns:
      Returns the double

    • setDigits

      public void setDigits​(double digits)
      Setter for Digits. The number of digits for your 2fa code. The valid number ranges from 2 to 8, inclusively.
      Parameters:
      digits - Value for double

    • toString

      public java.lang.String toString()
      Converts this TwoFactorCodeRequestSchema into string format.
      Overrides:
      toString in class java.lang.Object
      Returns:
      String representation of this class

    • toBuilder

      public TwoFactorCodeRequestSchema.Builder toBuilder()
      Builds a new TwoFactorCodeRequestSchema.Builder object. Creates the instance with the state of the current model.
      Returns:
      a new TwoFactorCodeRequestSchema.Builder object