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

Packages that use CommonAlert

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

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

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

Modifier and Type	Method	Description
CommonAlert	AlertingApi.getAlertingAlert(GetAlertingAlertRequest request)	Get an alert
CommonAlert	AlertingApi.getAlertingAlert(String alertId)	Get an alert
CommonAlert	AlertingApi.patchAlertingAlert(PatchAlertingAlertRequest request)	Allows an entity to mute/snooze an alert or update the unread status of the alert.
CommonAlert	AlertingApi.patchAlertingAlert(String alertId, AlertRequest body)	Allows an entity to mute/snooze an alert or update the unread status of the alert.

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

Modifier and Type	Method	Description
ApiResponse<CommonAlert>	AlertingApi.getAlertingAlert(ApiRequest<Void> request)	Get an alert
Future<CommonAlert>	AlertingApiAsync.getAlertingAlertAsync(GetAlertingAlertRequest request, AsyncApiCallback<CommonAlert> callback)	Get an alert
Future<ApiResponse<CommonAlert>>	AlertingApiAsync.getAlertingAlertAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<CommonAlert>> callback)	Get an alert
ApiResponse<CommonAlert>	AlertingApi.getAlertingAlertWithHttpInfo(String alertId)	Get an alert
ApiResponse<CommonAlert>	AlertingApi.patchAlertingAlert(ApiRequest<AlertRequest> request)	Allows an entity to mute/snooze an alert or update the unread status of the alert.
Future<CommonAlert>	AlertingApiAsync.patchAlertingAlertAsync(PatchAlertingAlertRequest request, AsyncApiCallback<CommonAlert> callback)	Allows an entity to mute/snooze an alert or update the unread status of the alert.
Future<ApiResponse<CommonAlert>>	AlertingApiAsync.patchAlertingAlertAsync(ApiRequest<AlertRequest> request, AsyncApiCallback<ApiResponse<CommonAlert>> callback)	Allows an entity to mute/snooze an alert or update the unread status of the alert.
ApiResponse<CommonAlert>	AlertingApi.patchAlertingAlertWithHttpInfo(String alertId, AlertRequest body)	Allows an entity to mute/snooze an alert or update the unread status of the alert.

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

Modifier and Type	Method	Description
Future<CommonAlert>	AlertingApiAsync.getAlertingAlertAsync(GetAlertingAlertRequest request, AsyncApiCallback<CommonAlert> callback)	Get an alert
Future<ApiResponse<CommonAlert>>	AlertingApiAsync.getAlertingAlertAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<CommonAlert>> callback)	Get an alert
Future<CommonAlert>	AlertingApiAsync.patchAlertingAlertAsync(PatchAlertingAlertRequest request, AsyncApiCallback<CommonAlert> callback)	Allows an entity to mute/snooze an alert or update the unread status of the alert.
Future<ApiResponse<CommonAlert>>	AlertingApiAsync.patchAlertingAlertAsync(ApiRequest<AlertRequest> request, AsyncApiCallback<ApiResponse<CommonAlert>> callback)	Allows an entity to mute/snooze an alert or update the unread status of the alert.

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

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

Modifier and Type	Method	Description
CommonAlert	CommonAlert.active(Boolean active)	Indicates if an alert is currently active.
CommonAlert	CommonAlert.alertSummary(AlertSummary alertSummary)	Summary of the alert status of the entities defined in the conditions.
CommonAlert	CommonAlert.conditions(CommonRuleConditions conditions)	The conditions that make up the rule.
CommonAlert	CommonAlert.conversationId(String conversationId)	The id of the conversation instance that caused the alert to trigger.
CommonAlert	CommonAlert.dateEnd(Date dateEnd)	The timestamp of when the alert ended.
CommonAlert	CommonAlert.dateMutedUntil(Date dateMutedUntil)	Timestamp of when the mute status of the alert should end.
CommonAlert	CommonAlert.dateSnoozedUntil(Date dateSnoozedUntil)	Timestamp of when the snooze status of the alert should end.
CommonAlert	CommonAlert.dateStart(Date dateStart)	The timestamp of when the alert was created.
CommonAlert	CommonAlert.muted(Boolean muted)	Flag indicating if the alert is in a muted state.
CommonAlert	CommonAlert.name(String name)
CommonAlert	CommonAlert.notifications(List<AlertNotification> notifications)	The collection of notification methods and the ids of users who were notified by those methods.
CommonAlert	CommonAlert.rule(AlertRuleProperties rule)	The properties of the rule that triggered the alert.
CommonAlert	CommonAlert.ruleUri(String ruleUri)
CommonAlert	CommonAlert.snoozed(Boolean snoozed)	Flag indicating if the alert is in a snoozed state.
CommonAlert	CommonAlert.unread(Boolean unread)	Indicates if an alert has not been read.
CommonAlert	CommonAlert.user(UserReference user)	The user who created the rule that triggered the alert.
CommonAlert	CommonAlert.waitBetweenNotificationMs(Long waitBetweenNotificationMs)	The amount of time to wait between notification.

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

Modifier and Type	Method	Description
List<CommonAlert>	AlertListing.getEntities()

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

Modifier and Type	Method	Description
AlertListing	AlertListing.entities(List<CommonAlert> entities)
void	AlertListing.setEntities(List<CommonAlert> entities)