Class ReceiverBuilder

sdk/java/src/main/java/com/chain/api/Account.java:329–396

Use this class to create a Receiver under an account.

   * Use this class to create a {@link Receiver} under an account.
   */
  public static class ReceiverBuilder {
    @SerializedName("account_alias")
    public String accountAlias;

    @SerializedName("account_id")
    public String accountId;

    @SerializedName("expires_at")
    public Date expiresAt;

    /**
     * Specifies the account under which the receiver is created. You must use
     * this method or @{link ReceiverBuilder#setAccountId}, but not both.
     *
     * @param alias the unique alias of the account
     * @return this ReceiverBuilder object
     */
    public ReceiverBuilder setAccountAlias(String alias) {
      this.accountAlias = alias;
      return this;
    }

    /**
     * Specifies the account under which the receiver is created. You must use
     * this method or @{link ReceiverBuilder#setAccountAlias}, but not both.
     *
     * @param id the unique ID of the account
     * @return this ReceiverBuilder object
     */
    public ReceiverBuilder setAccountId(String id) {
      this.accountId = id;
      return this;
    }

    /**
     * Specifies when the receiver will expire. This defaults to 30 days in the
     * future.
     *
     * Payments to expired receivers should not be considered valid, and may or
     * may not be indexed by your Chain Core instance. In general, as long as
     * the contents of receiver objects are not tampered with, the transaction
     * builder will ensure that transactions that pay to expired receivers will
     * be rejected by the blockchain.
     *
     * @param date the date when the receiver expires
     * @return this ReceiverBuilder object
     */
    public ReceiverBuilder setExpiresAt(Date date) {
      this.expiresAt = date;
      return this;
    }

    /**
     * Creates a single Receiver object under an account.
     *
     * @param client the client object providing access to an instance of Chain Core
     * @return a new Receiver object
     * @throws APIException This exception is raised if the api returns errors while creating the control programs.