Package com.mypurecloud.sdk.v2.model

Class CommonAlert

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

  • Constructor Details

    • CommonAlert

      public CommonAlert()

    • CommonAlert

      public CommonAlert(Boolean initWithEmptyList)

  • Method Details

    • getId

      public String getId()

    • name

      public CommonAlert name(String name)

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • user

      public CommonAlert user(UserReference user)
      The user who created the rule that triggered the alert.

    • getUser

      public UserReference getUser()

    • setUser

      public void setUser(UserReference user)

    • rule

      public CommonAlert rule(AlertRuleProperties rule)
      The properties of the rule that triggered the alert.

    • getRule

      public AlertRuleProperties getRule()

    • setRule

      public void setRule(AlertRuleProperties rule)

    • notifications

      public CommonAlert notifications(List<AlertNotification> notifications)
      The collection of notification methods and the ids of users who were notified by those methods.

    • getNotifications

      public List<AlertNotification> getNotifications()

    • setNotifications

      public void setNotifications(List<AlertNotification> notifications)

    • dateStart

      public CommonAlert dateStart(Date dateStart)
      The timestamp of when the alert was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getDateStart

      public Date getDateStart()

    • setDateStart

      public void setDateStart(Date dateStart)

    • dateEnd

      public CommonAlert dateEnd(Date dateEnd)
      The timestamp of when the alert ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getDateEnd

      public Date getDateEnd()

    • setDateEnd

      public void setDateEnd(Date dateEnd)

    • active

      public CommonAlert active(Boolean active)
      Indicates if an alert is currently active.

    • getActive

      public Boolean getActive()

    • setActive

      public void setActive(Boolean active)

    • unread

      public CommonAlert unread(Boolean unread)
      Indicates if an alert has not been read.

    • getUnread

      public Boolean getUnread()

    • setUnread

      public void setUnread(Boolean unread)

    • waitBetweenNotificationMs

      public CommonAlert waitBetweenNotificationMs(Long waitBetweenNotificationMs)
      The amount of time to wait between notification. Time is in milliseconds.

    • getWaitBetweenNotificationMs

      public Long getWaitBetweenNotificationMs()

    • setWaitBetweenNotificationMs

      public void setWaitBetweenNotificationMs(Long waitBetweenNotificationMs)

    • muted

      public CommonAlert muted(Boolean muted)
      Flag indicating if the alert is in a muted state.

    • getMuted

      public Boolean getMuted()

    • setMuted

      public void setMuted(Boolean muted)

    • snoozed

      public CommonAlert snoozed(Boolean snoozed)
      Flag indicating if the alert is in a snoozed state.

    • getSnoozed

      public Boolean getSnoozed()

    • setSnoozed

      public void setSnoozed(Boolean snoozed)

    • dateMutedUntil

      public CommonAlert dateMutedUntil(Date dateMutedUntil)
      Timestamp of when the mute status of the alert should end. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getDateMutedUntil

      public Date getDateMutedUntil()

    • setDateMutedUntil

      public void setDateMutedUntil(Date dateMutedUntil)

    • dateSnoozedUntil

      public CommonAlert dateSnoozedUntil(Date dateSnoozedUntil)
      Timestamp of when the snooze status of the alert should end. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getDateSnoozedUntil

      public Date getDateSnoozedUntil()

    • setDateSnoozedUntil

      public void setDateSnoozedUntil(Date dateSnoozedUntil)

    • conditions

      public CommonAlert conditions(CommonRuleConditions conditions)
      The conditions that make up the rule.

    • getConditions

      public CommonRuleConditions getConditions()

    • setConditions

      public void setConditions(CommonRuleConditions conditions)

    • conversationId

      public CommonAlert conversationId(String conversationId)
      The id of the conversation instance that caused the alert to trigger.

    • getConversationId

      public String getConversationId()

    • setConversationId

      public void setConversationId(String conversationId)

    • alertSummary

      public CommonAlert alertSummary(AlertSummary alertSummary)
      Summary of the alert status of the entities defined in the conditions. Is set when rule has instance-based or team member based rule predicates

    • getAlertSummary

      public AlertSummary getAlertSummary()

    • setAlertSummary

      public void setAlertSummary(AlertSummary alertSummary)

    • ruleUri

      public CommonAlert ruleUri(String ruleUri)

    • getRuleUri

      public String getRuleUri()

    • setRuleUri

      public void setRuleUri(String ruleUri)

    • 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