• Home
• com.sinch.sdk
• sinch-sdk-java
• 1.3.1
• source code
• CalloutRequestParametersConference.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.sinch.sdk.domains.voice.models.requests.CalloutRequestParametersConference Maven / Gradle / Ivy

package com.sinch.sdk.domains.voice.models.requests;

import com.sinch.sdk.core.models.OptionalValue;
import com.sinch.sdk.domains.voice.models.ConferenceDtfmOptions;
import com.sinch.sdk.domains.voice.models.Destination;
import com.sinch.sdk.domains.voice.models.DomainType;
import com.sinch.sdk.domains.voice.models.MusicOnHoldType;
import com.sinch.sdk.models.DualToneMultiFrequency;
import com.sinch.sdk.models.E164PhoneNumber;

/**
 * The conference callout calls a phone number or a user. When the call is answered, it's connected
 * to a conference room
 */
public class CalloutRequestParametersConference extends CalloutRequestParameters {

  private final OptionalValue conferenceId;
  private final OptionalValue dtfmOptions;
  private final OptionalValue maxDuration;
  private final OptionalValue enableAce;
  private final OptionalValue enableDice;
  private final OptionalValue enablePie;
  private final OptionalValue locale;
  private final OptionalValue greeting;
  private final OptionalValue musicOnHold;
  private final OptionalValue domain;

  private CalloutRequestParametersConference(
      OptionalValue destination,
      OptionalValue cli,
      OptionalValue dtfm,
      OptionalValue custom,
      OptionalValue conferenceId,
      OptionalValue dtfmOptions,
      OptionalValue maxDuration,
      OptionalValue enableAce,
      OptionalValue enableDice,
      OptionalValue enablePie,
      OptionalValue locale,
      OptionalValue greeting,
      OptionalValue musicOnHold,
      OptionalValue domain) {
    super(destination, cli, dtfm, custom);

    this.conferenceId = conferenceId;
    this.dtfmOptions = dtfmOptions;
    this.maxDuration = maxDuration;
    this.enableAce = enableAce;
    this.enableDice = enableDice;
    this.enablePie = enablePie;
    this.locale = locale;
    this.greeting = greeting;
    this.musicOnHold = musicOnHold;
    this.domain = domain;
  }

  /**
   * @see Builder#setConferenceId(String)
   */
  public OptionalValue getConferenceId() {
    return conferenceId;
  }

  /**
   * @see Builder#setDtfm(DualToneMultiFrequency)
   */
  public OptionalValue getDtfmOptions() {
    return dtfmOptions;
  }

  /**
   * @see Builder#setMaxDuration(Integer)
   */
  public OptionalValue getMaxDuration() {
    return maxDuration;
  }

  /**
   * @see Builder#setEnableAce(Boolean)
   */
  public OptionalValue getEnableAce() {
    return enableAce;
  }

  /**
   * @see Builder#setEnableDice(Boolean)
   */
  public OptionalValue getEnableDice() {
    return enableDice;
  }

  /**
   * @see Builder#setEnablePie(Boolean)
   */
  public OptionalValue getEnablePie() {
    return enablePie;
  }

  /**
   * @see Builder#setLocale(String)
   */
  public OptionalValue getLocale() {
    return locale;
  }

  /**
   * @see Builder#setGreeting(String)
   */
  public OptionalValue getGreeting() {
    return greeting;
  }

  /**
   * @see Builder#setMusicOnHold(MusicOnHoldType) (MusicOnHoldType)
   */
  public OptionalValue getMusicOnHold() {
    return musicOnHold;
  }

  /**
   * @see Builder#setDomain(DomainType)
   */
  public OptionalValue getDomain() {
    return domain;
  }

  @Override
  public String toString() {
    return "CalloutRequestParametersConference{"
        + "conferenceId='"
        + conferenceId
        + '\''
        + ", dtfmOptions="
        + dtfmOptions
        + ", maxDuration="
        + maxDuration
        + ", enableAce="
        + enableAce
        + ", enableDice="
        + enableDice
        + ", enablePie="
        + enablePie
        + ", locale='"
        + locale
        + '\''
        + ", greeting='"
        + greeting
        + '\''
        + ", musicOnHold="
        + musicOnHold
        + ", domain="
        + domain
        + "} "
        + super.toString();
  }

  public static Builder builder() {
    return new Builder();
  }

  public static class Builder extends CalloutRequestParameters.Builder {

    OptionalValue conferenceId = OptionalValue.empty();
    OptionalValue dtfmOptions = OptionalValue.empty();
    OptionalValue maxDuration = OptionalValue.empty();
    OptionalValue enableAce = OptionalValue.empty();
    OptionalValue enableDice = OptionalValue.empty();
    OptionalValue enablePie = OptionalValue.empty();
    OptionalValue locale = OptionalValue.empty();
    OptionalValue greeting = OptionalValue.empty();
    OptionalValue musicOnHold = OptionalValue.empty();
    OptionalValue domain = OptionalValue.empty();

    public Builder() {
      super();
    }

    /**
     * The conferenceId of the conference to which you want the callee to join. * If the *
     * conferenceId doesn't exist a conference room will be created.
     *
     * @param conferenceId The conference value
     * @return current builder
     */
    public Builder setConferenceId(String conferenceId) {
      this.conferenceId = OptionalValue.of(conferenceId);
      return self();
    }

    /**
     * Define Dual Tone Multi Frequency options to control how DTMF signals are used by the
     * participant in the conference
     *
     * @param dtfmOptions DTFM definition
     * @return current builder
     */
    public Builder setDtfmOptions(ConferenceDtfmOptions dtfmOptions) {
      this.dtfmOptions = OptionalValue.of(dtfmOptions);
      return self();
    }

    /**
     * The maximum amount of time in seconds that the call will last.
     *
     * @param maxDuration Max duration value
     * @return current builder
     */
    public Builder setMaxDuration(Integer maxDuration) {
      this.maxDuration = OptionalValue.of(maxDuration);
      return self();
    }

    /**
     * If enableAce is set to true and the application has a callback URL specified, you will
     * receive an ACE callback when the call is answered. When the callback is received, your
     * platform must respond with a svamlet containing the connectConf action in order to add the
     * call to a conference or create the conference if it's the first call. If it's set to false,
     * no ACE event will be sent to your backend. Note if the call is towards an InApp destination
     * type: username, then no ACE will be issued when the call is connected, even if enableAce is
     * present in the callout request.
     *
     * @param enableAce is enabled or not
     * @return current builder
     */
    public Builder setEnableAce(Boolean enableAce) {
      this.enableAce = OptionalValue.of(enableAce);
      return self();
    }

    /**
     * If enableDice is set to true and the application has a callback URL specified, you will
     * receive a DiCE callback when the call is disconnected. If it's set to false, no DiCE event
     * will be sent to your backend. Note if the call is towards an InApp destination type:
     * username, then no DICE will be issued at the end of the call, even if enableDice is present
     * in the callout request.
     *
     * @param enableDice is enabled or not
     * @return current builder
     */
    public Builder setEnableDice(Boolean enableDice) {
      this.enableDice = OptionalValue.of(enableDice);
      return self();
    }

    /**
     * If enablePie is set to true and the application has a callback URL specified, you will
     * receive a PIE callback after a runMenu action, with the information of the action that the
     * user took. If it's set to false, no PIE event will be sent to your backend.
     *
     * @param enablePie is enabled or not
     * @return current builder
     */
    public Builder setEnablePie(Boolean enablePie) {
      this.enablePie = OptionalValue.of(enablePie);
      return self();
    }

    /**
     * The voice and language you want to use for the prompts. This can either be defined by the ISO
     * 639 locale and language code or by specifying a particular voice.
     *
     * @see Supported
     *     languages and voices are detailed here
     * @param locale The locale to be used
     * @return current builder
     */
    public Builder setLocale(String locale) {
      this.locale = OptionalValue.of(locale);
      return self();
    }

    /**
     * Set the text that will be spoken as a greeting.
     *
     * @param greeting the text value
     * @return current builder
     */
    public Builder setGreeting(String greeting) {
      this.greeting = OptionalValue.of(greeting);
      return self();
    }

    /**
     * Means "music-on-hold." It's an optional parameter that specifies what the first participant
     * should listen to while they're alone in the conference, waiting for other participants to
     * join.
     *
     * @param musicOnHold The music-on-hold to be used
     * @return current builder
     */
    public Builder setMusicOnHold(MusicOnHoldType musicOnHold) {
      this.musicOnHold = OptionalValue.of(musicOnHold);
      return self();
    }

    /**
     * Domain related call
     *
     * @param domain Domain to be used
     * @return current builder
     */
    public Builder setDomain(DomainType domain) {
      this.domain = OptionalValue.of(domain);
      return self();
    }

    public CalloutRequestParametersConference build() {
      return new CalloutRequestParametersConference(
          destination,
          cli,
          dtfm,
          custom,
          conferenceId,
          dtfmOptions,
          maxDuration,
          enableAce,
          enableDice,
          enablePie,
          locale,
          greeting,
          musicOnHold,
          domain);
    }

    @Override
    protected Builder self() {
      return this;
    }
  }
}