Package com.mypurecloud.sdk.v2.model

Class Recording

java.lang.Object
com.mypurecloud.sdk.v2.model.Recording
All Implemented Interfaces:
Serializable
public class Recording extends Object implements Serializable
Recording
See Also:

  • Constructor Details

    • Recording

      public Recording()

    • Recording

      public Recording(Boolean initWithEmptyList)

  • Method Details

    • getId

      public String getId()

    • name

      public Recording name(String name)

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • conversationId

      public Recording conversationId(String conversationId)

    • getConversationId

      public String getConversationId()

    • setConversationId

      public void setConversationId(String conversationId)

    • path

      public Recording path(String path)

    • getPath

      public String getPath()

    • setPath

      public void setPath(String path)

    • startTime

      public Recording startTime(String startTime)
      The start time of the recording. Null when there is no playable media.

    • getStartTime

      public String getStartTime()

    • setStartTime

      public void setStartTime(String startTime)

    • endTime

      public Recording endTime(String endTime)
      The end time of the recording. Null when there is no playable media.

    • getEndTime

      public String getEndTime()

    • setEndTime

      public void setEndTime(String endTime)

    • media

      public Recording media(String media)
      The media type of the recording. This could be audio, chat, messaging, email, or screen.

    • getMedia

      public String getMedia()

    • setMedia

      public void setMedia(String media)

    • mediaSubtype

      public Recording mediaSubtype(Recording.MediaSubtypeEnum mediaSubtype)
      The media subtype of the recording.

    • getMediaSubtype

      public Recording.MediaSubtypeEnum getMediaSubtype()

    • setMediaSubtype

      public void setMediaSubtype(Recording.MediaSubtypeEnum mediaSubtype)

    • mediaSubject

      public Recording mediaSubject(String mediaSubject)
      The media subject of the recording.

    • getMediaSubject

      public String getMediaSubject()

    • setMediaSubject

      public void setMediaSubject(String mediaSubject)

    • annotations

      public Recording annotations(List<Annotation> annotations)
      Annotations that belong to the recording.

    • getAnnotations

      public List<Annotation> getAnnotations()

    • setAnnotations

      public void setAnnotations(List<Annotation> annotations)

    • transcript

      public Recording transcript(List<ChatMessage> transcript)
      Represents a chat transcript

    • getTranscript

      public List<ChatMessage> getTranscript()

    • setTranscript

      public void setTranscript(List<ChatMessage> transcript)

    • emailTranscript

      public Recording emailTranscript(List<RecordingEmailMessage> emailTranscript)
      Represents an email transcript

    • getEmailTranscript

      public List<RecordingEmailMessage> getEmailTranscript()

    • setEmailTranscript

      public void setEmailTranscript(List<RecordingEmailMessage> emailTranscript)

    • messagingTranscript

      public Recording messagingTranscript(List<RecordingMessagingMessage> messagingTranscript)
      Represents a messaging transcript

    • getMessagingTranscript

      public List<RecordingMessagingMessage> getMessagingTranscript()

    • setMessagingTranscript

      public void setMessagingTranscript(List<RecordingMessagingMessage> messagingTranscript)

    • fileState

      public Recording fileState(Recording.FileStateEnum fileState)
      Represents the current file state for a recording. Examples: Uploading, Archived, etc

    • getFileState

      public Recording.FileStateEnum getFileState()

    • setFileState

      public void setFileState(Recording.FileStateEnum fileState)

    • restoreExpirationTime

      public Recording restoreExpirationTime(Date restoreExpirationTime)
      The amount of time a restored recording will remain restored before being archived again. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getRestoreExpirationTime

      public Date getRestoreExpirationTime()

    • setRestoreExpirationTime

      public void setRestoreExpirationTime(Date restoreExpirationTime)

    • mediaUris

      public Recording mediaUris(Map<String,MediaResult> mediaUris)
      The different mediaUris for the recording. Null when there is no playable media.

    • getMediaUris

      public Map<String,MediaResult> getMediaUris()

    • setMediaUris

      public void setMediaUris(Map<String,MediaResult> mediaUris)

    • estimatedTranscodeTimeMs

      public Recording estimatedTranscodeTimeMs(Long estimatedTranscodeTimeMs)

    • getEstimatedTranscodeTimeMs

      public Long getEstimatedTranscodeTimeMs()

    • setEstimatedTranscodeTimeMs

      public void setEstimatedTranscodeTimeMs(Long estimatedTranscodeTimeMs)

    • actualTranscodeTimeMs

      public Recording actualTranscodeTimeMs(Long actualTranscodeTimeMs)

    • getActualTranscodeTimeMs

      public Long getActualTranscodeTimeMs()

    • setActualTranscodeTimeMs

      public void setActualTranscodeTimeMs(Long actualTranscodeTimeMs)

    • archiveDate

      public Recording archiveDate(Date archiveDate)
      The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getArchiveDate

      public Date getArchiveDate()

    • setArchiveDate

      public void setArchiveDate(Date archiveDate)

    • archiveMedium

      public Recording archiveMedium(Recording.ArchiveMediumEnum archiveMedium)
      The type of archive medium used. Example: CloudArchive

    • getArchiveMedium

      public Recording.ArchiveMediumEnum getArchiveMedium()

    • setArchiveMedium

      public void setArchiveMedium(Recording.ArchiveMediumEnum archiveMedium)

    • deleteDate

      public Recording deleteDate(Date deleteDate)
      The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getDeleteDate

      public Date getDeleteDate()

    • setDeleteDate

      public void setDeleteDate(Date deleteDate)

    • exportDate

      public Recording exportDate(Date exportDate)
      The date the recording will be exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getExportDate

      public Date getExportDate()

    • setExportDate

      public void setExportDate(Date exportDate)

    • exportedDate

      public Recording exportedDate(Date exportedDate)
      The date the recording was exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getExportedDate

      public Date getExportedDate()

    • setExportedDate

      public void setExportedDate(Date exportedDate)

    • outputDurationMs

      public Recording outputDurationMs(Integer outputDurationMs)
      Duration of transcoded media in milliseconds

    • getOutputDurationMs

      public Integer getOutputDurationMs()

    • setOutputDurationMs

      public void setOutputDurationMs(Integer outputDurationMs)

    • outputSizeInBytes

      public Recording outputSizeInBytes(Integer outputSizeInBytes)
      Size of transcoded media in bytes. 0 if there is no transcoded media.

    • getOutputSizeInBytes

      public Integer getOutputSizeInBytes()

    • setOutputSizeInBytes

      public void setOutputSizeInBytes(Integer outputSizeInBytes)

    • maxAllowedRestorationsForOrg

      public Recording maxAllowedRestorationsForOrg(Integer maxAllowedRestorationsForOrg)
      How many archive restorations the organization is allowed to have. Deprecated - Always returns 10000 since the restoration limit is no longer enforced.

    • getMaxAllowedRestorationsForOrg

      public Integer getMaxAllowedRestorationsForOrg()

    • setMaxAllowedRestorationsForOrg

      public void setMaxAllowedRestorationsForOrg(Integer maxAllowedRestorationsForOrg)

    • remainingRestorationsAllowedForOrg

      public Recording remainingRestorationsAllowedForOrg(Integer remainingRestorationsAllowedForOrg)
      The remaining archive restorations the organization has. Deprecated - Always returns 10000 since the restoration limit is no longer enforced.

    • getRemainingRestorationsAllowedForOrg

      public Integer getRemainingRestorationsAllowedForOrg()

    • setRemainingRestorationsAllowedForOrg

      public void setRemainingRestorationsAllowedForOrg(Integer remainingRestorationsAllowedForOrg)

    • sessionId

      public Recording sessionId(String sessionId)
      The session id represents an external resource id, such as email, call, chat, etc

    • getSessionId

      public String getSessionId()

    • setSessionId

      public void setSessionId(String sessionId)

    • users

      public Recording users(List<User> users)
      The users participating in the conversation

    • getUsers

      public List<User> getUsers()

    • setUsers

      public void setUsers(List<User> users)

    • recordingFileRole

      public Recording recordingFileRole(Recording.RecordingFileRoleEnum recordingFileRole)
      Role of the file recording. It can be either customer_experience or adhoc.

    • getRecordingFileRole

      public Recording.RecordingFileRoleEnum getRecordingFileRole()

    • setRecordingFileRole

      public void setRecordingFileRole(Recording.RecordingFileRoleEnum recordingFileRole)

    • recordingErrorStatus

      public Recording recordingErrorStatus(Recording.RecordingErrorStatusEnum recordingErrorStatus)
      Status of a recording that cannot be returned because of an error

    • getRecordingErrorStatus

      public Recording.RecordingErrorStatusEnum getRecordingErrorStatus()

    • setRecordingErrorStatus

      public void setRecordingErrorStatus(Recording.RecordingErrorStatusEnum recordingErrorStatus)

    • originalRecordingStartTime

      public Recording originalRecordingStartTime(Date originalRecordingStartTime)
      The start time of the full recording, before any segment access restrictions are applied. Null when there is no playable media. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getOriginalRecordingStartTime

      public Date getOriginalRecordingStartTime()

    • setOriginalRecordingStartTime

      public void setOriginalRecordingStartTime(Date originalRecordingStartTime)

    • creationTime

      public Recording creationTime(Date creationTime)
      The creation time of the recording. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getCreationTime

      public Date getCreationTime()

    • setCreationTime

      public void setCreationTime(Date creationTime)

    • associatedConversationIds

      public Recording associatedConversationIds(List<String> associatedConversationIds)
      List of associated conversation IDs

    • getAssociatedConversationIds

      public List<String> getAssociatedConversationIds()

    • setAssociatedConversationIds

      public void setAssociatedConversationIds(List<String> associatedConversationIds)

    • getSelfUri

      public String getSelfUri()

    • 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