Class ConferenceRecordingAvailableCallback


  • @Generated("org.openapitools.codegen.languages.JavaClientCodegen")
    public class ConferenceRecordingAvailableCallback
    extends Object
    The Conference Recording Available event is sent after a conference recording has been processed. It indicates that the recording is available for download.
    • Constructor Detail

      • ConferenceRecordingAvailableCallback

        public ConferenceRecordingAvailableCallback()
    • Method Detail

      • 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)
      • 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)
      • getConferenceId

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

        public void setConferenceId​(String conferenceId)
      • getName

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

        public void setName​(String name)
      • getAccountId

        @Nullable
        public String getAccountId()
        The user account associated with the call.
        Returns:
        accountId
      • setAccountId

        public void setAccountId​(String accountId)
      • getRecordingId

        @Nullable
        public String getRecordingId()
        The unique ID of this recording
        Returns:
        recordingId
      • setRecordingId

        public void setRecordingId​(String recordingId)
      • getChannels

        @Nullable
        public Integer getChannels()
        Always `1` for conference recordings; multi-channel recordings are not supported on conferences.
        Returns:
        channels
      • setChannels

        public void setChannels​(Integer channels)
      • getStartTime

        @Nullable
        public OffsetDateTime getStartTime()
        Time the call was started, in ISO 8601 format.
        Returns:
        startTime
      • setStartTime

        public void setStartTime​(OffsetDateTime startTime)
      • getEndTime

        @Nullable
        public OffsetDateTime getEndTime()
        The time that the recording ended in ISO-8601 format
        Returns:
        endTime
      • getDuration

        @Nullable
        public String getDuration()
        The duration of the recording in ISO-8601 format
        Returns:
        duration
      • setDuration

        public void setDuration​(String duration)
      • getFileFormat

        @Nullable
        public FileFormatEnum getFileFormat()
        Get fileFormat
        Returns:
        fileFormat
      • setFileFormat

        public void setFileFormat​(FileFormatEnum fileFormat)
      • getMediaUrl

        @Nullable
        public URI getMediaUrl()
        The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded.
        Returns:
        mediaUrl
      • setMediaUrl

        public void setMediaUrl​(URI mediaUrl)
      • 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)
      • getStatus

        @Nullable
        public String getStatus()
        The current status of the process. For recording, current possible values are 'processing', 'partial', 'complete', 'deleted', and 'error'. For transcriptions, current possible values are 'none', 'processing', 'available', 'error', 'timeout', 'file-size-too-big', and 'file-size-too-small'. Additional states may be added in the future, so your application must be tolerant of unknown values.
        Returns:
        status
      • setStatus

        public void setStatus​(String status)
      • putAdditionalProperty

        public ConferenceRecordingAvailableCallback 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 ConferenceRecordingAvailableCallback 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
      • hashCode

        public int hashCode()
        Overrides:
        hashCode 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 ConferenceRecordingAvailableCallback
      • fromJson

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

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