Package com.bandwidth.sdk.model
Class ConferenceRecordingAvailableCallback
- java.lang.Object
-
- com.bandwidth.sdk.model.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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ConferenceRecordingAvailableCallback.CustomTypeAdapterFactory
-
Field Summary
Fields Modifier and Type Field Description static HashSet<String>
openapiFields
static HashSet<String>
openapiRequiredFields
static String
SERIALIZED_NAME_ACCOUNT_ID
static String
SERIALIZED_NAME_CHANNELS
static String
SERIALIZED_NAME_CONFERENCE_ID
static String
SERIALIZED_NAME_DURATION
static String
SERIALIZED_NAME_END_TIME
static String
SERIALIZED_NAME_EVENT_TIME
static String
SERIALIZED_NAME_EVENT_TYPE
static String
SERIALIZED_NAME_FILE_FORMAT
static String
SERIALIZED_NAME_MEDIA_URL
static String
SERIALIZED_NAME_NAME
static String
SERIALIZED_NAME_RECORDING_ID
static String
SERIALIZED_NAME_START_TIME
static String
SERIALIZED_NAME_STATUS
static String
SERIALIZED_NAME_TAG
-
Constructor Summary
Constructors Constructor Description ConferenceRecordingAvailableCallback()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ConferenceRecordingAvailableCallback
accountId(String accountId)
ConferenceRecordingAvailableCallback
channels(Integer channels)
ConferenceRecordingAvailableCallback
conferenceId(String conferenceId)
ConferenceRecordingAvailableCallback
duration(String duration)
ConferenceRecordingAvailableCallback
endTime(OffsetDateTime endTime)
boolean
equals(Object o)
ConferenceRecordingAvailableCallback
eventTime(OffsetDateTime eventTime)
ConferenceRecordingAvailableCallback
eventType(String eventType)
ConferenceRecordingAvailableCallback
fileFormat(FileFormatEnum fileFormat)
static ConferenceRecordingAvailableCallback
fromJson(String jsonString)
Create an instance of ConferenceRecordingAvailableCallback given an JSON stringString
getAccountId()
The user account associated with the call.Map<String,Object>
getAdditionalProperties()
Return the additional (undeclared) property.Object
getAdditionalProperty(String key)
Return the additional (undeclared) property with the specified name.Integer
getChannels()
Always `1` for conference recordings; multi-channel recordings are not supported on conferences.String
getConferenceId()
The unique, Bandwidth-generated ID of the conference that was recordedString
getDuration()
The duration of the recording in ISO-8601 formatOffsetDateTime
getEndTime()
The time that the recording ended in ISO-8601 formatOffsetDateTime
getEventTime()
The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format.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.FileFormatEnum
getFileFormat()
Get fileFormatURI
getMediaUrl()
The URL that can be used to download the recording.String
getName()
The user-specified name of the conference that was recordedString
getRecordingId()
The unique ID of this recordingOffsetDateTime
getStartTime()
Time the call was started, in ISO 8601 format.String
getStatus()
The current status of the process.String
getTag()
(optional) The tag specified on call creation.int
hashCode()
ConferenceRecordingAvailableCallback
mediaUrl(URI mediaUrl)
ConferenceRecordingAvailableCallback
name(String name)
ConferenceRecordingAvailableCallback
putAdditionalProperty(String key, Object value)
Set the additional (undeclared) property with the specified name and value.ConferenceRecordingAvailableCallback
recordingId(String recordingId)
void
setAccountId(String accountId)
void
setChannels(Integer channels)
void
setConferenceId(String conferenceId)
void
setDuration(String duration)
void
setEndTime(OffsetDateTime endTime)
void
setEventTime(OffsetDateTime eventTime)
void
setEventType(String eventType)
void
setFileFormat(FileFormatEnum fileFormat)
void
setMediaUrl(URI mediaUrl)
void
setName(String name)
void
setRecordingId(String recordingId)
void
setStartTime(OffsetDateTime startTime)
void
setStatus(String status)
void
setTag(String tag)
ConferenceRecordingAvailableCallback
startTime(OffsetDateTime startTime)
ConferenceRecordingAvailableCallback
status(String status)
ConferenceRecordingAvailableCallback
tag(String tag)
String
toJson()
Convert an instance of ConferenceRecordingAvailableCallback to an JSON stringString
toString()
static void
validateJsonElement(com.google.gson.JsonElement jsonElement)
Validates the JSON Element and throws an exception if issues found
-
-
-
Field Detail
-
SERIALIZED_NAME_EVENT_TYPE
public static final String SERIALIZED_NAME_EVENT_TYPE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_EVENT_TIME
public static final String SERIALIZED_NAME_EVENT_TIME
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_CONFERENCE_ID
public static final String SERIALIZED_NAME_CONFERENCE_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_NAME
public static final String SERIALIZED_NAME_NAME
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ACCOUNT_ID
public static final String SERIALIZED_NAME_ACCOUNT_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_RECORDING_ID
public static final String SERIALIZED_NAME_RECORDING_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_CHANNELS
public static final String SERIALIZED_NAME_CHANNELS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_START_TIME
public static final String SERIALIZED_NAME_START_TIME
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_END_TIME
public static final String SERIALIZED_NAME_END_TIME
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_DURATION
public static final String SERIALIZED_NAME_DURATION
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_FILE_FORMAT
public static final String SERIALIZED_NAME_FILE_FORMAT
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_MEDIA_URL
public static final String SERIALIZED_NAME_MEDIA_URL
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_TAG
public static final String SERIALIZED_NAME_TAG
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_STATUS
public static final String SERIALIZED_NAME_STATUS
- See Also:
- Constant Field Values
-
-
Method Detail
-
eventType
public ConferenceRecordingAvailableCallback 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 ConferenceRecordingAvailableCallback 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 ConferenceRecordingAvailableCallback 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 ConferenceRecordingAvailableCallback 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)
-
accountId
public ConferenceRecordingAvailableCallback accountId(String accountId)
-
getAccountId
@Nullable public String getAccountId()
The user account associated with the call.- Returns:
- accountId
-
setAccountId
public void setAccountId(String accountId)
-
recordingId
public ConferenceRecordingAvailableCallback recordingId(String recordingId)
-
getRecordingId
@Nullable public String getRecordingId()
The unique ID of this recording- Returns:
- recordingId
-
setRecordingId
public void setRecordingId(String recordingId)
-
channels
public ConferenceRecordingAvailableCallback channels(Integer channels)
-
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)
-
startTime
public ConferenceRecordingAvailableCallback startTime(OffsetDateTime startTime)
-
getStartTime
@Nullable public OffsetDateTime getStartTime()
Time the call was started, in ISO 8601 format.- Returns:
- startTime
-
setStartTime
public void setStartTime(OffsetDateTime startTime)
-
endTime
public ConferenceRecordingAvailableCallback endTime(OffsetDateTime endTime)
-
getEndTime
@Nullable public OffsetDateTime getEndTime()
The time that the recording ended in ISO-8601 format- Returns:
- endTime
-
setEndTime
public void setEndTime(OffsetDateTime endTime)
-
duration
public ConferenceRecordingAvailableCallback duration(String duration)
-
getDuration
@Nullable public String getDuration()
The duration of the recording in ISO-8601 format- Returns:
- duration
-
setDuration
public void setDuration(String duration)
-
fileFormat
public ConferenceRecordingAvailableCallback fileFormat(FileFormatEnum fileFormat)
-
getFileFormat
@Nullable public FileFormatEnum getFileFormat()
Get fileFormat- Returns:
- fileFormat
-
setFileFormat
public void setFileFormat(FileFormatEnum fileFormat)
-
mediaUrl
public ConferenceRecordingAvailableCallback mediaUrl(URI mediaUrl)
-
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)
-
tag
public ConferenceRecordingAvailableCallback 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)
-
status
public ConferenceRecordingAvailableCallback status(String status)
-
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 propertyvalue
- 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
-
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
-
-