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

Packages that use Annotation

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

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

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

Modifier and Type	Method	Description
Annotation	RecordingApi.getConversationRecordingAnnotation(GetConversationRecordingAnnotationRequest request)	Get annotation
Annotation	RecordingApi.getConversationRecordingAnnotation(String conversationId, String recordingId, String annotationId)	Get annotation
Annotation	RecordingApi.postConversationRecordingAnnotations(PostConversationRecordingAnnotationsRequest request)	Create annotation If the annotation does not exist on the recording, it is created.
Annotation	RecordingApi.postConversationRecordingAnnotations(String conversationId, String recordingId, Annotation body)	Create annotation If the annotation does not exist on the recording, it is created.
Annotation	RecordingApi.putConversationRecordingAnnotation(PutConversationRecordingAnnotationRequest request)	Update annotation If the annotation does not exist on the recording, it is created.
Annotation	RecordingApi.putConversationRecordingAnnotation(String conversationId, String recordingId, String annotationId, Annotation body)	Update annotation If the annotation does not exist on the recording, it is created.

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

Modifier and Type	Method	Description
ApiResponse<Annotation>	RecordingApi.getConversationRecordingAnnotation(ApiRequest<Void> request)	Get annotation
Future<Annotation>	RecordingApiAsync.getConversationRecordingAnnotationAsync(GetConversationRecordingAnnotationRequest request, AsyncApiCallback<Annotation> callback)	Get annotation
Future<ApiResponse<Annotation>>	RecordingApiAsync.getConversationRecordingAnnotationAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Annotation>> callback)	Get annotation
List<Annotation>	RecordingApi.getConversationRecordingAnnotations(GetConversationRecordingAnnotationsRequest request)	Get annotations for recording
ApiResponse<List<Annotation>>	RecordingApi.getConversationRecordingAnnotations(ApiRequest<Void> request)	Get annotations for recording
List<Annotation>	RecordingApi.getConversationRecordingAnnotations(String conversationId, String recordingId)	Get annotations for recording
Future<List<Annotation>>	RecordingApiAsync.getConversationRecordingAnnotationsAsync(GetConversationRecordingAnnotationsRequest request, AsyncApiCallback<List<Annotation>> callback)	Get annotations for recording
Future<ApiResponse<List<Annotation>>>	RecordingApiAsync.getConversationRecordingAnnotationsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<List<Annotation>>> callback)	Get annotations for recording
ApiResponse<List<Annotation>>	RecordingApi.getConversationRecordingAnnotationsWithHttpInfo(String conversationId, String recordingId)	Get annotations for recording
ApiResponse<Annotation>	RecordingApi.getConversationRecordingAnnotationWithHttpInfo(String conversationId, String recordingId, String annotationId)	Get annotation
ApiResponse<Annotation>	RecordingApi.postConversationRecordingAnnotations(ApiRequest<Annotation> request)	Create annotation If the annotation does not exist on the recording, it is created.
Future<Annotation>	RecordingApiAsync.postConversationRecordingAnnotationsAsync(PostConversationRecordingAnnotationsRequest request, AsyncApiCallback<Annotation> callback)	Create annotation If the annotation does not exist on the recording, it is created.
Future<ApiResponse<Annotation>>	RecordingApiAsync.postConversationRecordingAnnotationsAsync(ApiRequest<Annotation> request, AsyncApiCallback<ApiResponse<Annotation>> callback)	Create annotation If the annotation does not exist on the recording, it is created.
ApiResponse<Annotation>	RecordingApi.postConversationRecordingAnnotationsWithHttpInfo(String conversationId, String recordingId, Annotation body)	Create annotation If the annotation does not exist on the recording, it is created.
ApiResponse<Annotation>	RecordingApi.putConversationRecordingAnnotation(ApiRequest<Annotation> request)	Update annotation If the annotation does not exist on the recording, it is created.
Future<Annotation>	RecordingApiAsync.putConversationRecordingAnnotationAsync(PutConversationRecordingAnnotationRequest request, AsyncApiCallback<Annotation> callback)	Update annotation If the annotation does not exist on the recording, it is created.
Future<ApiResponse<Annotation>>	RecordingApiAsync.putConversationRecordingAnnotationAsync(ApiRequest<Annotation> request, AsyncApiCallback<ApiResponse<Annotation>> callback)	Update annotation If the annotation does not exist on the recording, it is created.
ApiResponse<Annotation>	RecordingApi.putConversationRecordingAnnotationWithHttpInfo(String conversationId, String recordingId, String annotationId, Annotation body)	Update annotation If the annotation does not exist on the recording, it is created.

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

Modifier and Type	Method	Description
Annotation	RecordingApi.postConversationRecordingAnnotations(String conversationId, String recordingId, Annotation body)	Create annotation If the annotation does not exist on the recording, it is created.
ApiResponse<Annotation>	RecordingApi.postConversationRecordingAnnotationsWithHttpInfo(String conversationId, String recordingId, Annotation body)	Create annotation If the annotation does not exist on the recording, it is created.
Annotation	RecordingApi.putConversationRecordingAnnotation(String conversationId, String recordingId, String annotationId, Annotation body)	Update annotation If the annotation does not exist on the recording, it is created.
ApiResponse<Annotation>	RecordingApi.putConversationRecordingAnnotationWithHttpInfo(String conversationId, String recordingId, String annotationId, Annotation body)	Update annotation If the annotation does not exist on the recording, it is created.

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

Modifier and Type	Method	Description
Future<Annotation>	RecordingApiAsync.getConversationRecordingAnnotationAsync(GetConversationRecordingAnnotationRequest request, AsyncApiCallback<Annotation> callback)	Get annotation
Future<ApiResponse<Annotation>>	RecordingApiAsync.getConversationRecordingAnnotationAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Annotation>> callback)	Get annotation
Future<List<Annotation>>	RecordingApiAsync.getConversationRecordingAnnotationsAsync(GetConversationRecordingAnnotationsRequest request, AsyncApiCallback<List<Annotation>> callback)	Get annotations for recording
Future<ApiResponse<List<Annotation>>>	RecordingApiAsync.getConversationRecordingAnnotationsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<List<Annotation>>> callback)	Get annotations for recording
ApiResponse<Annotation>	RecordingApi.postConversationRecordingAnnotations(ApiRequest<Annotation> request)	Create annotation If the annotation does not exist on the recording, it is created.
Future<Annotation>	RecordingApiAsync.postConversationRecordingAnnotationsAsync(PostConversationRecordingAnnotationsRequest request, AsyncApiCallback<Annotation> callback)	Create annotation If the annotation does not exist on the recording, it is created.
Future<ApiResponse<Annotation>>	RecordingApiAsync.postConversationRecordingAnnotationsAsync(ApiRequest<Annotation> request, AsyncApiCallback<ApiResponse<Annotation>> callback)	Create annotation If the annotation does not exist on the recording, it is created.
Future<ApiResponse<Annotation>>	RecordingApiAsync.postConversationRecordingAnnotationsAsync(ApiRequest<Annotation> request, AsyncApiCallback<ApiResponse<Annotation>> callback)	Create annotation If the annotation does not exist on the recording, it is created.
ApiResponse<Annotation>	RecordingApi.putConversationRecordingAnnotation(ApiRequest<Annotation> request)	Update annotation If the annotation does not exist on the recording, it is created.
Future<Annotation>	RecordingApiAsync.putConversationRecordingAnnotationAsync(PutConversationRecordingAnnotationRequest request, AsyncApiCallback<Annotation> callback)	Update annotation If the annotation does not exist on the recording, it is created.
Future<ApiResponse<Annotation>>	RecordingApiAsync.putConversationRecordingAnnotationAsync(ApiRequest<Annotation> request, AsyncApiCallback<ApiResponse<Annotation>> callback)	Update annotation If the annotation does not exist on the recording, it is created.
Future<ApiResponse<Annotation>>	RecordingApiAsync.putConversationRecordingAnnotationAsync(ApiRequest<Annotation> request, AsyncApiCallback<ApiResponse<Annotation>> callback)	Update annotation If the annotation does not exist on the recording, it is created.

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

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

Modifier and Type	Method	Description
Annotation	PostConversationRecordingAnnotationsRequest.getBody()
Annotation	PutConversationRecordingAnnotationRequest.getBody()

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

Modifier and Type	Method	Description
ApiRequest<Annotation>	PostConversationRecordingAnnotationsRequest.withHttpInfo()
ApiRequest<Annotation>	PutConversationRecordingAnnotationRequest.withHttpInfo()

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

Modifier and Type	Method	Description
static PostConversationRecordingAnnotationsRequest.Builder	PostConversationRecordingAnnotationsRequest.builder(String conversationId, String recordingId, Annotation body)
static PutConversationRecordingAnnotationRequest.Builder	PutConversationRecordingAnnotationRequest.builder(String conversationId, String recordingId, String annotationId, Annotation body)
void	PostConversationRecordingAnnotationsRequest.setBody(Annotation body)
void	PutConversationRecordingAnnotationRequest.setBody(Annotation body)
PostConversationRecordingAnnotationsRequest.Builder	PostConversationRecordingAnnotationsRequest.Builder.withBody(Annotation body)
PostConversationRecordingAnnotationsRequest	PostConversationRecordingAnnotationsRequest.withBody(Annotation body)
PutConversationRecordingAnnotationRequest.Builder	PutConversationRecordingAnnotationRequest.Builder.withBody(Annotation body)
PutConversationRecordingAnnotationRequest	PutConversationRecordingAnnotationRequest.withBody(Annotation body)
PostConversationRecordingAnnotationsRequest.Builder	PostConversationRecordingAnnotationsRequest.Builder.withRequiredParams(String conversationId, String recordingId, Annotation body)
PutConversationRecordingAnnotationRequest.Builder	PutConversationRecordingAnnotationRequest.Builder.withRequiredParams(String conversationId, String recordingId, String annotationId, Annotation body)

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

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

Modifier and Type	Method	Description
Annotation	Annotation.absoluteDurationMs(Long absoluteDurationMs)	Duration of annotation (milliseconds).
Annotation	Annotation.absoluteLocation(Long absoluteLocation)	Offset of annotation (milliseconds) from start of recording (after removing the cumulative duration of all pauses).
Annotation	Annotation.description(String description)	Text of annotation.
Annotation	Annotation.durationMs(Long durationMs)	Duration of annotation in milliseconds.
Annotation	Annotation.id(String id)	Annotation id.
Annotation	Annotation.location(Long location)	Offset of annotation in milliseconds.
Annotation	Annotation.name(String name)
Annotation	Annotation.recordingDurationMs(Long recordingDurationMs)	Duration of annotation (milliseconds), adjusted for any recording cuts.
Annotation	Annotation.recordingLocation(Long recordingLocation)	Offset of annotation (milliseconds) from start of recording, adjusted for any recording cuts
Annotation	Annotation.type(String type)
Annotation	Annotation.user(User user)	User that created this annotation (if any).

Methods in com.mypurecloud.sdk.v2.model that return types with arguments of type Annotation

Modifier and Type	Method	Description
List<Annotation>	Annotation.getAnnotations()
List<Annotation>	Recording.getAnnotations()
List<Annotation>	RecordingMetadata.getAnnotations()

Method parameters in com.mypurecloud.sdk.v2.model with type arguments of type Annotation

Modifier and Type	Method	Description
Recording	Recording.annotations(List<Annotation> annotations)	Annotations that belong to the recording.
RecordingMetadata	RecordingMetadata.annotations(List<Annotation> annotations)	Annotations that belong to the recording.
void	Recording.setAnnotations(List<Annotation> annotations)
void	RecordingMetadata.setAnnotations(List<Annotation> annotations)