Package com.mypurecloud.sdk.v2.model

Class Widget

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

  • Constructor Details

    • Widget

      public Widget()

    • Widget

      public Widget(Boolean initWithEmptyList)

  • Method Details

    • row

      public Widget row(Integer row)
      The row number for the specific dashboard widget configuration.

    • getRow

      public Integer getRow()

    • setRow

      public void setRow(Integer row)

    • column

      public Widget column(Integer column)
      The column number for the specific dashboard widget configuration.

    • getColumn

      public Integer getColumn()

    • setColumn

      public void setColumn(Integer column)

    • title

      public Widget title(String title)
      The title for the dashboard widget configuration.

    • getTitle

      public String getTitle()

    • setTitle

      public void setTitle(String title)

    • type

      public Widget type(Widget.TypeEnum type)
      The type of dashboard widget configuration.

    • getType

      public Widget.TypeEnum getType()

    • setType

      public void setType(Widget.TypeEnum type)

    • metrics

      public Widget metrics(List<Widget.MetricsEnum> metrics)
      The list of metrics for the dashboard widget configuration.

    • getMetrics

      public List<Widget.MetricsEnum> getMetrics()

    • setMetrics

      public void setMetrics(List<Widget.MetricsEnum> metrics)

    • displayText

      public Widget displayText(String displayText)
      The display text for the dashboard widget configuration.

    • getDisplayText

      public String getDisplayText()

    • setDisplayText

      public void setDisplayText(String displayText)

    • displayTextColor

      public Widget displayTextColor(String displayTextColor)
      The color of the display text for the dashboard widget configuration in RGB hexadecimal format (for example \"#FF0000\" represents red).

    • getDisplayTextColor

      public String getDisplayTextColor()

    • setDisplayTextColor

      public void setDisplayTextColor(String displayTextColor)

    • webContentUrl

      public Widget webContentUrl(String webContentUrl)
      The external web URL for the dashboard widget configuration.

    • getWebContentUrl

      public String getWebContentUrl()

    • setWebContentUrl

      public void setWebContentUrl(String webContentUrl)

    • splitFilters

      public Widget splitFilters(Boolean splitFilters)
      Indicates each filter to be displayed individually.

    • getSplitFilters

      public Boolean getSplitFilters()

    • setSplitFilters

      public void setSplitFilters(Boolean splitFilters)

    • splitByMediaType

      public Widget splitByMediaType(Boolean splitByMediaType)
      Indicates that data for each media type should be shown individually.

    • getSplitByMediaType

      public Boolean getSplitByMediaType()

    • setSplitByMediaType

      public void setSplitByMediaType(Boolean splitByMediaType)

    • showLongest

      public Widget showLongest(Boolean showLongest)
      Indicates the display be the longest time.

    • getShowLongest

      public Boolean getShowLongest()

    • setShowLongest

      public void setShowLongest(Boolean showLongest)

    • displayAsTable

      public Widget displayAsTable(Boolean displayAsTable)
      Indicates the widget to be displayed as table.

    • getDisplayAsTable

      public Boolean getDisplayAsTable()

    • setDisplayAsTable

      public void setDisplayAsTable(Boolean displayAsTable)

    • showDuration

      public Widget showDuration(Boolean showDuration)
      Indicates the display to include duration.

    • getShowDuration

      public Boolean getShowDuration()

    • setShowDuration

      public void setShowDuration(Boolean showDuration)

    • sortOrder

      public Widget sortOrder(Widget.SortOrderEnum sortOrder)
      The sort order of the table.

    • getSortOrder

      public Widget.SortOrderEnum getSortOrder()

    • setSortOrder

      public void setSortOrder(Widget.SortOrderEnum sortOrder)

    • sortKey

      public Widget sortKey(Widget.SortKeyEnum sortKey)
      The sort key of the table.

    • getSortKey

      public Widget.SortKeyEnum getSortKey()

    • setSortKey

      public void setSortKey(Widget.SortKeyEnum sortKey)

    • entityLimit

      public Widget entityLimit(Integer entityLimit)
      Indicates the limit of displayed entities.

    • getEntityLimit

      public Integer getEntityLimit()

    • setEntityLimit

      public void setEntityLimit(Integer entityLimit)

    • displayAggregates

      public Widget displayAggregates(Boolean displayAggregates)
      Indicates whether to display aggregate across all entity and media type combination.

    • getDisplayAggregates

      public Boolean getDisplayAggregates()

    • setDisplayAggregates

      public void setDisplayAggregates(Boolean displayAggregates)

    • isFullWidth

      public Widget isFullWidth(Boolean isFullWidth)
      Indicates whether a widget should take the full width of a dashboard or be shown only in a single slot.

    • getIsFullWidth

      public Boolean getIsFullWidth()

    • setIsFullWidth

      public void setIsFullWidth(Boolean isFullWidth)

    • showPercentageChange

      public Widget showPercentageChange(Boolean showPercentageChange)
      Indicates whether a widget should show the percentage diff between two values.

    • getShowPercentageChange

      public Boolean getShowPercentageChange()

    • setShowPercentageChange

      public void setShowPercentageChange(Boolean showPercentageChange)

    • showProfilePicture

      public Widget showProfilePicture(Boolean showProfilePicture)
      Indicates whether a widget should show the profile picture of an agent.

    • getShowProfilePicture

      public Boolean getShowProfilePicture()

    • setShowProfilePicture

      public void setShowProfilePicture(Boolean showProfilePicture)

    • filter

      public Widget filter(ViewFilter filter)
      The filters to be applied for dashboard widget configuration

    • getFilter

      public ViewFilter getFilter()

    • setFilter

      public void setFilter(ViewFilter filter)

    • periods

      public Widget periods(List<Widget.PeriodsEnum> periods)
      The list of periods for the dashboard widget configuration

    • getPeriods

      public List<Widget.PeriodsEnum> getPeriods()

    • setPeriods

      public void setPeriods(List<Widget.PeriodsEnum> periods)

    • mediaTypes

      public Widget mediaTypes(List<Widget.MediaTypesEnum> mediaTypes)
      The list of media types for the dashboard widget configuration

    • getMediaTypes

      public List<Widget.MediaTypesEnum> getMediaTypes()

    • setMediaTypes

      public void setMediaTypes(List<Widget.MediaTypesEnum> mediaTypes)

    • warnings

      public Widget warnings(List<Warning> warnings)
      List of warnings for dashboard widget configuration

    • getWarnings

      public List<Warning> getWarnings()

    • setWarnings

      public void setWarnings(List<Warning> warnings)

    • showTimeInStatus

      public Widget showTimeInStatus(Boolean showTimeInStatus)
      Indicates the show time in status of a widget configuration.

    • getShowTimeInStatus

      public Boolean getShowTimeInStatus()

    • setShowTimeInStatus

      public void setShowTimeInStatus(Boolean showTimeInStatus)

    • showOfflineAgents

      public Widget showOfflineAgents(Boolean showOfflineAgents)
      Indicates to show offline agent widget.

    • getShowOfflineAgents

      public Boolean getShowOfflineAgents()

    • setShowOfflineAgents

      public void setShowOfflineAgents(Boolean showOfflineAgents)

    • selectedStatuses

      public Widget selectedStatuses(List<Widget.SelectedStatusesEnum> selectedStatuses)
      Indicates the selected statuses used to filter the agent widget in the dashboard.

    • getSelectedStatuses

      public List<Widget.SelectedStatusesEnum> getSelectedStatuses()

    • setSelectedStatuses

      public void setSelectedStatuses(List<Widget.SelectedStatusesEnum> selectedStatuses)

    • selectedSegmentTypes

      public Widget selectedSegmentTypes(List<Widget.SelectedSegmentTypesEnum> selectedSegmentTypes)
      Indicates the selected segment types used to filter the agent activity in the dashboard.

    • getSelectedSegmentTypes

      public List<Widget.SelectedSegmentTypesEnum> getSelectedSegmentTypes()

    • setSelectedSegmentTypes

      public void setSelectedSegmentTypes(List<Widget.SelectedSegmentTypesEnum> selectedSegmentTypes)

    • agentInteractionSortOrder

      public Widget agentInteractionSortOrder(Widget.AgentInteractionSortOrderEnum agentInteractionSortOrder)
      The sort order of the interactions in the agent status widget.

    • getAgentInteractionSortOrder

      public Widget.AgentInteractionSortOrderEnum getAgentInteractionSortOrder()

    • setAgentInteractionSortOrder

      public void setAgentInteractionSortOrder(Widget.AgentInteractionSortOrderEnum agentInteractionSortOrder)

    • 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