Package com.bandwidth.sdk.model

Class ConferenceRecordingAvailableCallback

java.lang.Object

com.bandwidth.sdk.model.ConferenceRecordingAvailableCallback

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.10.0")
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 final String	SERIALIZED_NAME_ACCOUNT_ID
static final String	SERIALIZED_NAME_CHANNELS
static final String	SERIALIZED_NAME_CONFERENCE_ID
static final String	SERIALIZED_NAME_DURATION
static final String	SERIALIZED_NAME_END_TIME
static final String	SERIALIZED_NAME_EVENT_TIME
static final String	SERIALIZED_NAME_EVENT_TYPE
static final String	SERIALIZED_NAME_FILE_FORMAT
static final String	SERIALIZED_NAME_MEDIA_URL
static final String	SERIALIZED_NAME_NAME
static final String	SERIALIZED_NAME_RECORDING_ID
static final String	SERIALIZED_NAME_START_TIME
static final String	SERIALIZED_NAME_STATUS
static final String	SERIALIZED_NAME_TAG

Constructor Summary

Constructors

Constructor	Description
ConferenceRecordingAvailableCallback()

Method Summary

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 string
String	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 recorded
String	getDuration()	The duration of the recording in ISO-8601 format
OffsetDateTime	getEndTime()	The time that the recording ended in ISO-8601 format
OffsetDateTime	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 fileFormat
URI	getMediaUrl()	The URL that can be used to download the recording.
String	getName()	The user-specified name of the conference that was recorded
String	getRecordingId()	The unique ID of this recording
OffsetDateTime	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 string
String	toString()
static void	validateJsonElement(com.google.gson.JsonElement jsonElement)	Validates the JSON Element and throws an exception if issues found

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

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

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

ConferenceRecordingAvailableCallback

public ConferenceRecordingAvailableCallback()

Method Details

eventType

public ConferenceRecordingAvailableCallback eventType(@Nullable
 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(@Nullable
 String eventType)

eventTime

public ConferenceRecordingAvailableCallback eventTime(@Nullable
 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(@Nullable
 OffsetDateTime eventTime)

conferenceId

public ConferenceRecordingAvailableCallback conferenceId(@Nullable
 String conferenceId)

getConferenceId

@Nullable
public String getConferenceId()

The unique, Bandwidth-generated ID of the conference that was recorded

Returns:

conferenceId

setConferenceId

public void setConferenceId(@Nullable
 String conferenceId)

name

public ConferenceRecordingAvailableCallback name(@Nullable
 String name)

getName

@Nullable
public String getName()

The user-specified name of the conference that was recorded

Returns:

name

setName

public void setName(@Nullable
 String name)

accountId

public ConferenceRecordingAvailableCallback accountId(@Nullable
 String accountId)

getAccountId

@Nullable
public String getAccountId()

The user account associated with the call.

Returns:

accountId

setAccountId

public void setAccountId(@Nullable
 String accountId)

recordingId

public ConferenceRecordingAvailableCallback recordingId(@Nullable
 String recordingId)

getRecordingId

@Nullable
public String getRecordingId()

The unique ID of this recording

Returns:

recordingId

setRecordingId

public void setRecordingId(@Nullable
 String recordingId)

channels

public ConferenceRecordingAvailableCallback channels(@Nullable
 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(@Nullable
 Integer channels)

startTime

public ConferenceRecordingAvailableCallback startTime(@Nullable
 OffsetDateTime startTime)

getStartTime

@Nullable
public OffsetDateTime getStartTime()

Time the call was started, in ISO 8601 format.

Returns:

startTime

setStartTime

public void setStartTime(@Nullable
 OffsetDateTime startTime)

endTime

public ConferenceRecordingAvailableCallback endTime(@Nullable
 OffsetDateTime endTime)

getEndTime

@Nullable
public OffsetDateTime getEndTime()

The time that the recording ended in ISO-8601 format

Returns:

endTime

setEndTime

public void setEndTime(@Nullable
 OffsetDateTime endTime)

duration

public ConferenceRecordingAvailableCallback duration(@Nullable
 String duration)

getDuration

@Nullable
public String getDuration()

The duration of the recording in ISO-8601 format

Returns:

duration

setDuration

public void setDuration(@Nullable
 String duration)

fileFormat

public ConferenceRecordingAvailableCallback fileFormat(@Nullable
 FileFormatEnum fileFormat)

getFileFormat

@Nullable
public FileFormatEnum getFileFormat()

Get fileFormat

Returns:

fileFormat

setFileFormat

public void setFileFormat(@Nullable
 FileFormatEnum fileFormat)

mediaUrl

public ConferenceRecordingAvailableCallback mediaUrl(@Nullable
 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(@Nullable
 URI mediaUrl)

tag

public ConferenceRecordingAvailableCallback tag(@Nullable
 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(@Nullable
 String tag)

status

public ConferenceRecordingAvailableCallback status(@Nullable
 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(@Nullable
 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

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 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