Package com.bandwidth.sdk.model

Class ConferenceMemberJoinCallback

java.lang.Object
com.bandwidth.sdk.model.ConferenceMemberJoinCallback
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.6.0") public class ConferenceMemberJoinCallback extends Object
The Conference Member Join event is fired whenever a caller joins a conference that specified a callbackUrl. The response may be either empty or a BXML document. Only the following verbs are valid for conferences: PlayAudio, SpeakSentence, StartRecording, StopRecording, PauseRecording, ResumeRecording. Audio verbs will be heard by all members of the conference. Recordings capture audio from all members who are not muted or on hold, as well as any audio verbs that are played into the conference.

  • Field Details

  • Constructor Details

    • ConferenceMemberJoinCallback

      public ConferenceMemberJoinCallback()

  • Method Details

    • eventType

      public ConferenceMemberJoinCallback eventType(String eventType)

    • getEventType

      @Nullable public String getEventType()
      The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect.
      Returns:
      eventType

    • setEventType

      public void setEventType(String eventType)

    • eventTime

      public ConferenceMemberJoinCallback eventTime(OffsetDateTime eventTime)

    • getEventTime

      @Nullable public OffsetDateTime getEventTime()
      The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution.
      Returns:
      eventTime

    • setEventTime

      public void setEventTime(OffsetDateTime eventTime)

    • conferenceId

      public ConferenceMemberJoinCallback conferenceId(String conferenceId)

    • getConferenceId

      @Nullable public String getConferenceId()
      The unique, Bandwidth-generated ID of the conference that was recorded
      Returns:
      conferenceId

    • setConferenceId

      public void setConferenceId(String conferenceId)

    • name

      public ConferenceMemberJoinCallback name(String name)

    • getName

      @Nullable public String getName()
      The user-specified name of the conference that was recorded
      Returns:
      name

    • setName

      public void setName(String name)

    • from

      public ConferenceMemberJoinCallback from(String from)

    • getFrom

      @Nullable public String getFrom()
      The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555).
      Returns:
      from

    • setFrom

      public void setFrom(String from)

    • to

      public ConferenceMemberJoinCallback to(String to)

    • getTo

      @Nullable public String getTo()
      The phone number that received the call, in E.164 format (e.g. +15555555555).
      Returns:
      to

    • setTo

      public void setTo(String to)

    • callId

      public ConferenceMemberJoinCallback callId(String callId)

    • getCallId

      @Nullable public String getCallId()
      The call id associated with the event.
      Returns:
      callId

    • setCallId

      public void setCallId(String callId)

    • tag

      public ConferenceMemberJoinCallback tag(String tag)

    • getTag

      @Nullable public String getTag()
      (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.
      Returns:
      tag

    • setTag

      public void setTag(String tag)

    • putAdditionalProperty

      public ConferenceMemberJoinCallback putAdditionalProperty(String key, Object value)
      Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.
      Parameters:
      key - name of the property
      value - value of the property
      Returns:
      the ConferenceMemberJoinCallback instance itself

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()
      Return the additional (undeclared) property.
      Returns:
      a map of objects

    • getAdditionalProperty

      public Object getAdditionalProperty(String key)
      Return the additional (undeclared) property with the specified name.
      Parameters:
      key - name of the property
      Returns:
      an object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • validateJsonElement

      public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOException
      Validates the JSON Element and throws an exception if issues found
      Parameters:
      jsonElement - JSON Element
      Throws:
      IOException - if the JSON Element is invalid with respect to ConferenceMemberJoinCallback

    • fromJson

      public static ConferenceMemberJoinCallback fromJson(String jsonString) throws IOException
      Create an instance of ConferenceMemberJoinCallback given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of ConferenceMemberJoinCallback
      Throws:
      IOException - if the JSON string is invalid with respect to ConferenceMemberJoinCallback

    • toJson

      public String toJson()
      Convert an instance of ConferenceMemberJoinCallback to an JSON string
      Returns:
      JSON string