Package com.mypurecloud.sdk.v2.model

Class Annotation

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

  • Constructor Details

    • Annotation

      public Annotation()

    • Annotation

      public Annotation(Boolean initWithEmptyList)

  • Method Details

    • id

      public Annotation id(String id)
      Annotation id. All pause annotations on a recording will share an ID value, bookmark annotations will have unique IDs, and hold annotations will have randomly generated UUIDs (i.e. the ID will change at each request).

    • getId

      public String getId()

    • setId

      public void setId(String id)

    • name

      public Annotation name(String name)

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • type

      public Annotation type(String type)

    • getType

      public String getType()

    • setType

      public void setType(String type)

    • location

      public Annotation location(Long location)
      Offset of annotation in milliseconds.

    • getLocation

      public Long getLocation()

    • setLocation

      public void setLocation(Long location)

    • durationMs

      public Annotation durationMs(Long durationMs)
      Duration of annotation in milliseconds.

    • getDurationMs

      public Long getDurationMs()

    • setDurationMs

      public void setDurationMs(Long durationMs)

    • absoluteLocation

      public Annotation absoluteLocation(Long absoluteLocation)
      Offset of annotation (milliseconds) from start of recording (after removing the cumulative duration of all pauses).

    • getAbsoluteLocation

      public Long getAbsoluteLocation()

    • setAbsoluteLocation

      public void setAbsoluteLocation(Long absoluteLocation)

    • absoluteDurationMs

      public Annotation absoluteDurationMs(Long absoluteDurationMs)
      Duration of annotation (milliseconds).

    • getAbsoluteDurationMs

      public Long getAbsoluteDurationMs()

    • setAbsoluteDurationMs

      public void setAbsoluteDurationMs(Long absoluteDurationMs)

    • recordingLocation

      public Annotation recordingLocation(Long recordingLocation)
      Offset of annotation (milliseconds) from start of recording, adjusted for any recording cuts

    • getRecordingLocation

      public Long getRecordingLocation()

    • setRecordingLocation

      public void setRecordingLocation(Long recordingLocation)

    • recordingDurationMs

      public Annotation recordingDurationMs(Long recordingDurationMs)
      Duration of annotation (milliseconds), adjusted for any recording cuts.

    • getRecordingDurationMs

      public Long getRecordingDurationMs()

    • setRecordingDurationMs

      public void setRecordingDurationMs(Long recordingDurationMs)

    • user

      public Annotation user(User user)
      User that created this annotation (if any).

    • getUser

      public User getUser()

    • setUser

      public void setUser(User user)

    • description

      public Annotation description(String description)
      Text of annotation. Maximum character limit is 500.

    • getDescription

      public String getDescription()

    • setDescription

      public void setDescription(String description)

    • getReason

      public Annotation.ReasonEnum getReason()

    • getAnnotations

      public List<Annotation> getAnnotations()

    • getRealtimeLocation

      public Long getRealtimeLocation()

    • 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