Uses of Class
com.mypurecloud.sdk.v2.model.Recording

Packages that use Recording

Package	Description
com.mypurecloud.sdk.v2.api
com.mypurecloud.sdk.v2.api.request
com.mypurecloud.sdk.v2.model

Uses of Recording in com.mypurecloud.sdk.v2.api

Methods in com.mypurecloud.sdk.v2.api that return Recording

Modifier and Type	Method	Description
Recording	RecordingApi.getConversationRecording(GetConversationRecordingRequest request)	Gets a specific recording.
Recording	RecordingApi.getConversationRecording(String conversationId, String recordingId, String formatId, String emailFormatId, String chatFormatId, String messageFormatId, Boolean download, String fileName, String locale, List<String> mediaFormats)	Gets a specific recording.
Recording	RecordingApi.getOrphanrecordingMedia(GetOrphanrecordingMediaRequest request)	Gets the media of a single orphan recording A 202 response means the orphaned media is currently transcoding and will be available shortly.A 200 response denotes the transcoded orphan media is available now and is contained in the response body.
Recording	RecordingApi.getOrphanrecordingMedia(String orphanId, String formatId, String emailFormatId, String chatFormatId, String messageFormatId, Boolean download, String fileName, String locale, List<String> mediaFormats)	Gets the media of a single orphan recording A 202 response means the orphaned media is currently transcoding and will be available shortly.A 200 response denotes the transcoded orphan media is available now and is contained in the response body.
Recording	RecordingApi.putConversationRecording(PutConversationRecordingRequest request)	Updates the retention records on a recording.
Recording	RecordingApi.putConversationRecording(String conversationId, String recordingId, Recording body, Boolean clearExport)	Updates the retention records on a recording.
Recording	RecordingApi.putOrphanrecording(PutOrphanrecordingRequest request)	Updates an orphan recording to a regular recording with retention values If this operation is successful the orphan will no longer exist.
Recording	RecordingApi.putOrphanrecording(String orphanId, OrphanUpdateRequest body)	Updates an orphan recording to a regular recording with retention values If this operation is successful the orphan will no longer exist.

Methods in com.mypurecloud.sdk.v2.api that return types with arguments of type Recording

Modifier and Type	Method	Description
ApiResponse<Recording>	RecordingApi.getConversationRecording(ApiRequest<Void> request)	Gets a specific recording.
Future<Recording>	RecordingApiAsync.getConversationRecordingAsync(GetConversationRecordingRequest request, AsyncApiCallback<Recording> callback)	Gets a specific recording.
Future<ApiResponse<Recording>>	RecordingApiAsync.getConversationRecordingAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Recording>> callback)	Gets a specific recording.
List<Recording>	RecordingApi.getConversationRecordings(GetConversationRecordingsRequest request)	Get all of a Conversation's Recordings.
ApiResponse<List<Recording>>	RecordingApi.getConversationRecordings(ApiRequest<Void> request)	Get all of a Conversation's Recordings.
List<Recording>	RecordingApi.getConversationRecordings(String conversationId, Integer maxWaitMs, String formatId, List<String> mediaFormats, String locale, Boolean includePauseAnnotationsForScreenRecordings)	Get all of a Conversation's Recordings.
Future<List<Recording>>	RecordingApiAsync.getConversationRecordingsAsync(GetConversationRecordingsRequest request, AsyncApiCallback<List<Recording>> callback)	Get all of a Conversation's Recordings.
Future<ApiResponse<List<Recording>>>	RecordingApiAsync.getConversationRecordingsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<List<Recording>>> callback)	Get all of a Conversation's Recordings.
ApiResponse<List<Recording>>	RecordingApi.getConversationRecordingsWithHttpInfo(String conversationId, Integer maxWaitMs, String formatId, List<String> mediaFormats, String locale, Boolean includePauseAnnotationsForScreenRecordings)	Get all of a Conversation's Recordings.
ApiResponse<Recording>	RecordingApi.getConversationRecordingWithHttpInfo(String conversationId, String recordingId, String formatId, String emailFormatId, String chatFormatId, String messageFormatId, Boolean download, String fileName, String locale, List<String> mediaFormats)	Gets a specific recording.
ApiResponse<Recording>	RecordingApi.getOrphanrecordingMedia(ApiRequest<Void> request)	Gets the media of a single orphan recording A 202 response means the orphaned media is currently transcoding and will be available shortly.A 200 response denotes the transcoded orphan media is available now and is contained in the response body.
Future<Recording>	RecordingApiAsync.getOrphanrecordingMediaAsync(GetOrphanrecordingMediaRequest request, AsyncApiCallback<Recording> callback)	Gets the media of a single orphan recording A 202 response means the orphaned media is currently transcoding and will be available shortly.A 200 response denotes the transcoded orphan media is available now and is contained in the response body.
Future<ApiResponse<Recording>>	RecordingApiAsync.getOrphanrecordingMediaAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Recording>> callback)	Gets the media of a single orphan recording A 202 response means the orphaned media is currently transcoding and will be available shortly.A 200 response denotes the transcoded orphan media is available now and is contained in the response body.
ApiResponse<Recording>	RecordingApi.getOrphanrecordingMediaWithHttpInfo(String orphanId, String formatId, String emailFormatId, String chatFormatId, String messageFormatId, Boolean download, String fileName, String locale, List<String> mediaFormats)	Gets the media of a single orphan recording A 202 response means the orphaned media is currently transcoding and will be available shortly.A 200 response denotes the transcoded orphan media is available now and is contained in the response body.
ApiResponse<Recording>	RecordingApi.putConversationRecording(ApiRequest<Recording> request)	Updates the retention records on a recording.
Future<Recording>	RecordingApiAsync.putConversationRecordingAsync(PutConversationRecordingRequest request, AsyncApiCallback<Recording> callback)	Updates the retention records on a recording.
Future<ApiResponse<Recording>>	RecordingApiAsync.putConversationRecordingAsync(ApiRequest<Recording> request, AsyncApiCallback<ApiResponse<Recording>> callback)	Updates the retention records on a recording.
ApiResponse<Recording>	RecordingApi.putConversationRecordingWithHttpInfo(String conversationId, String recordingId, Recording body, Boolean clearExport)	Updates the retention records on a recording.
ApiResponse<Recording>	RecordingApi.putOrphanrecording(ApiRequest<OrphanUpdateRequest> request)	Updates an orphan recording to a regular recording with retention values If this operation is successful the orphan will no longer exist.
Future<Recording>	RecordingApiAsync.putOrphanrecordingAsync(PutOrphanrecordingRequest request, AsyncApiCallback<Recording> callback)	Updates an orphan recording to a regular recording with retention values If this operation is successful the orphan will no longer exist.
Future<ApiResponse<Recording>>	RecordingApiAsync.putOrphanrecordingAsync(ApiRequest<OrphanUpdateRequest> request, AsyncApiCallback<ApiResponse<Recording>> callback)	Updates an orphan recording to a regular recording with retention values If this operation is successful the orphan will no longer exist.
ApiResponse<Recording>	RecordingApi.putOrphanrecordingWithHttpInfo(String orphanId, OrphanUpdateRequest body)	Updates an orphan recording to a regular recording with retention values If this operation is successful the orphan will no longer exist.

Methods in com.mypurecloud.sdk.v2.api with parameters of type Recording

Modifier and Type	Method	Description
Recording	RecordingApi.putConversationRecording(String conversationId, String recordingId, Recording body, Boolean clearExport)	Updates the retention records on a recording.
ApiResponse<Recording>	RecordingApi.putConversationRecordingWithHttpInfo(String conversationId, String recordingId, Recording body, Boolean clearExport)	Updates the retention records on a recording.

Method parameters in com.mypurecloud.sdk.v2.api with type arguments of type Recording

Modifier and Type	Method	Description
Future<Recording>	RecordingApiAsync.getConversationRecordingAsync(GetConversationRecordingRequest request, AsyncApiCallback<Recording> callback)	Gets a specific recording.
Future<ApiResponse<Recording>>	RecordingApiAsync.getConversationRecordingAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Recording>> callback)	Gets a specific recording.
Future<List<Recording>>	RecordingApiAsync.getConversationRecordingsAsync(GetConversationRecordingsRequest request, AsyncApiCallback<List<Recording>> callback)	Get all of a Conversation's Recordings.
Future<ApiResponse<List<Recording>>>	RecordingApiAsync.getConversationRecordingsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<List<Recording>>> callback)	Get all of a Conversation's Recordings.
Future<Recording>	RecordingApiAsync.getOrphanrecordingMediaAsync(GetOrphanrecordingMediaRequest request, AsyncApiCallback<Recording> callback)	Gets the media of a single orphan recording A 202 response means the orphaned media is currently transcoding and will be available shortly.A 200 response denotes the transcoded orphan media is available now and is contained in the response body.
Future<ApiResponse<Recording>>	RecordingApiAsync.getOrphanrecordingMediaAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Recording>> callback)	Gets the media of a single orphan recording A 202 response means the orphaned media is currently transcoding and will be available shortly.A 200 response denotes the transcoded orphan media is available now and is contained in the response body.
ApiResponse<Recording>	RecordingApi.putConversationRecording(ApiRequest<Recording> request)	Updates the retention records on a recording.
Future<Recording>	RecordingApiAsync.putConversationRecordingAsync(PutConversationRecordingRequest request, AsyncApiCallback<Recording> callback)	Updates the retention records on a recording.
Future<ApiResponse<Recording>>	RecordingApiAsync.putConversationRecordingAsync(ApiRequest<Recording> request, AsyncApiCallback<ApiResponse<Recording>> callback)	Updates the retention records on a recording.
Future<ApiResponse<Recording>>	RecordingApiAsync.putConversationRecordingAsync(ApiRequest<Recording> request, AsyncApiCallback<ApiResponse<Recording>> callback)	Updates the retention records on a recording.
Future<Recording>	RecordingApiAsync.putOrphanrecordingAsync(PutOrphanrecordingRequest request, AsyncApiCallback<Recording> callback)	Updates an orphan recording to a regular recording with retention values If this operation is successful the orphan will no longer exist.
Future<ApiResponse<Recording>>	RecordingApiAsync.putOrphanrecordingAsync(ApiRequest<OrphanUpdateRequest> request, AsyncApiCallback<ApiResponse<Recording>> callback)	Updates an orphan recording to a regular recording with retention values If this operation is successful the orphan will no longer exist.

Uses of Recording in com.mypurecloud.sdk.v2.api.request

Methods in com.mypurecloud.sdk.v2.api.request that return Recording

Modifier and Type	Method	Description
Recording	PutConversationRecordingRequest.getBody()

Methods in com.mypurecloud.sdk.v2.api.request that return types with arguments of type Recording

Modifier and Type	Method	Description
ApiRequest<Recording>	PutConversationRecordingRequest.withHttpInfo()

Methods in com.mypurecloud.sdk.v2.api.request with parameters of type Recording

Modifier and Type	Method	Description
static PutConversationRecordingRequest.Builder	PutConversationRecordingRequest.builder(String conversationId, String recordingId, Recording body)
void	PutConversationRecordingRequest.setBody(Recording body)
PutConversationRecordingRequest.Builder	PutConversationRecordingRequest.Builder.withBody(Recording body)
PutConversationRecordingRequest	PutConversationRecordingRequest.withBody(Recording body)
PutConversationRecordingRequest.Builder	PutConversationRecordingRequest.Builder.withRequiredParams(String conversationId, String recordingId, Recording body)

Uses of Recording in com.mypurecloud.sdk.v2.model

Methods in com.mypurecloud.sdk.v2.model that return Recording

Modifier and Type	Method	Description
Recording	Recording.actualTranscodeTimeMs(Long actualTranscodeTimeMs)
Recording	Recording.annotations(List<Annotation> annotations)	Annotations that belong to the recording.
Recording	Recording.archiveDate(Date archiveDate)	The date the recording will be archived.
Recording	Recording.archiveMedium(Recording.ArchiveMediumEnum archiveMedium)	The type of archive medium used.
Recording	Recording.associatedConversationIds(List<String> associatedConversationIds)	List of associated conversation IDs
Recording	Recording.conversationId(String conversationId)
Recording	Recording.creationTime(Date creationTime)	The creation time of the recording.
Recording	Recording.deleteDate(Date deleteDate)	The date the recording will be deleted.
Recording	Recording.emailTranscript(List<RecordingEmailMessage> emailTranscript)	Represents an email transcript
Recording	Recording.endTime(String endTime)	The end time of the recording.
Recording	Recording.estimatedTranscodeTimeMs(Long estimatedTranscodeTimeMs)
Recording	Recording.exportDate(Date exportDate)	The date the recording will be exported.
Recording	Recording.exportedDate(Date exportedDate)	The date the recording was exported.
Recording	Recording.fileState(Recording.FileStateEnum fileState)	Represents the current file state for a recording.
Recording	OrphanRecording.getRecording()
Recording	Recording.maxAllowedRestorationsForOrg(Integer maxAllowedRestorationsForOrg)	How many archive restorations the organization is allowed to have.
Recording	Recording.media(String media)	The media type of the recording.
Recording	Recording.mediaSubject(String mediaSubject)	The media subject of the recording.
Recording	Recording.mediaSubtype(Recording.MediaSubtypeEnum mediaSubtype)	The media subtype of the recording.
Recording	Recording.mediaUris(Map<String,MediaResult> mediaUris)	The different mediaUris for the recording.
Recording	Recording.messagingTranscript(List<RecordingMessagingMessage> messagingTranscript)	Represents a messaging transcript
Recording	Recording.name(String name)
Recording	Recording.originalRecordingStartTime(Date originalRecordingStartTime)	The start time of the full recording, before any segment access restrictions are applied.
Recording	Recording.outputDurationMs(Integer outputDurationMs)	Duration of transcoded media in milliseconds
Recording	Recording.outputSizeInBytes(Integer outputSizeInBytes)	Size of transcoded media in bytes. 0 if there is no transcoded media.
Recording	Recording.path(String path)
Recording	Recording.recordingErrorStatus(Recording.RecordingErrorStatusEnum recordingErrorStatus)	Status of a recording that cannot be returned because of an error
Recording	Recording.recordingFileRole(Recording.RecordingFileRoleEnum recordingFileRole)	Role of the file recording.
Recording	Recording.remainingRestorationsAllowedForOrg(Integer remainingRestorationsAllowedForOrg)	The remaining archive restorations the organization has.
Recording	Recording.restoreExpirationTime(Date restoreExpirationTime)	The amount of time a restored recording will remain restored before being archived again.
Recording	Recording.sessionId(String sessionId)	The session id represents an external resource id, such as email, call, chat, etc
Recording	Recording.startTime(String startTime)	The start time of the recording.
Recording	Recording.transcript(List<ChatMessage> transcript)	Represents a chat transcript
Recording	Recording.users(List<User> users)	The users participating in the conversation

Methods in com.mypurecloud.sdk.v2.model with parameters of type Recording

Modifier and Type	Method	Description
OrphanRecording	OrphanRecording.recording(Recording recording)
void	OrphanRecording.setRecording(Recording recording)