001package com.box.sdk;
002
003/**
004 * Box's ready-sign link feature enables you to create a link to a signature request that you've
005 * created from a template. Use this link when you want to post a signature request on a public form
006 * — such as an email, social media post, or web page — without knowing who the signers will be.
007 * Note: The ready-sign link feature is limited to Enterprise Plus customers and not available to
008 * Box Verified Enterprises.
009 */
010public class BoxSignTemplateReadySignLink {
011  private final String folderID;
012  private final String instructions;
013  private final boolean isActive;
014  private final boolean isNofiticationDisabled;
015  private final String name;
016  private final String url;
017
018  /**
019   * Constructs a BoxSignTemplateReadySignLink object with the provided information.
020   *
021   * @param folderID the folder ID.
022   * @param instructions the instructions.
023   * @param isActive whether the link is active or not.
024   * @param isNofiticationDisabled whether the notification is disabled or not.
025   * @param name the name.
026   * @param url the URL.
027   */
028  public BoxSignTemplateReadySignLink(
029      String folderID,
030      String instructions,
031      boolean isActive,
032      boolean isNofiticationDisabled,
033      String name,
034      String url) {
035    this.folderID = folderID;
036    this.instructions = instructions;
037    this.isActive = isActive;
038    this.isNofiticationDisabled = isNofiticationDisabled;
039    this.name = name;
040    this.url = url;
041  }
042
043  /**
044   * Gets the folder ID.
045   *
046   * @return the folder ID.
047   */
048  public String getFolderID() {
049    return this.folderID;
050  }
051
052  /**
053   * Gets the instructions.
054   *
055   * @return the instructions.
056   */
057  public String getInstructions() {
058    return this.instructions;
059  }
060
061  /**
062   * Gets whether the link is active or not.
063   *
064   * @return true if the link is active; otherwise false.
065   */
066  public boolean getIsActive() {
067    return this.isActive;
068  }
069
070  /**
071   * Gets whether the notification is disabled or not.
072   *
073   * @return true if the notification is disabled; otherwise false.
074   */
075  public boolean getIsNofiticationDisabled() {
076    return this.isNofiticationDisabled;
077  }
078
079  /**
080   * Gets the name of the ready-sign link.
081   *
082   * @return the name.
083   */
084  public String getName() {
085    return this.name;
086  }
087
088  /**
089   * Gets the URL of the ready-sign link.
090   *
091   * @return the URL.
092   */
093  public String getUrl() {
094    return this.url;
095  }
096}