Package com.mypurecloud.sdk.v2.model

Class AvailableTopic

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

  • Constructor Details

    • AvailableTopic

      public AvailableTopic()

    • AvailableTopic

      public AvailableTopic(Boolean initWithEmptyList)

  • Method Details

    • description

      public AvailableTopic description(String description)

    • getDescription

      public String getDescription()

    • setDescription

      public void setDescription(String description)

    • id

      public AvailableTopic id(String id)

    • getId

      public String getId()

    • setId

      public void setId(String id)

    • permissionDetails

      public AvailableTopic permissionDetails(List<PermissionDetails> permissionDetails)
      Full detailed permissions required to subscribe to the topic

    • getPermissionDetails

      public List<PermissionDetails> getPermissionDetails()

    • setPermissionDetails

      public void setPermissionDetails(List<PermissionDetails> permissionDetails)

    • requiresPermissions

      public AvailableTopic requiresPermissions(List<String> requiresPermissions)
      Permissions required to subscribe to the topic

    • getRequiresPermissions

      public List<String> getRequiresPermissions()

    • setRequiresPermissions

      public void setRequiresPermissions(List<String> requiresPermissions)

    • requiresDivisionPermissions

      public AvailableTopic requiresDivisionPermissions(Boolean requiresDivisionPermissions)
      True if the subscribing user must belong to the same division as the topic object ID

    • getRequiresDivisionPermissions

      public Boolean getRequiresDivisionPermissions()

    • setRequiresDivisionPermissions

      public void setRequiresDivisionPermissions(Boolean requiresDivisionPermissions)

    • requiresAnyValidator

      public AvailableTopic requiresAnyValidator(Boolean requiresAnyValidator)
      If multiple permissions are required for this topic, such as both requiresCurrentUser and requiresDivisionPermissions, then true here indicates that meeting any one condition will satisfy the requirements; false indicates all conditions must be met.

    • getRequiresAnyValidator

      public Boolean getRequiresAnyValidator()

    • setRequiresAnyValidator

      public void setRequiresAnyValidator(Boolean requiresAnyValidator)

    • enforced

      public AvailableTopic enforced(Boolean enforced)
      Whether or not the permissions on this topic are enforced

    • getEnforced

      public Boolean getEnforced()

    • setEnforced

      public void setEnforced(Boolean enforced)

    • visibility

      public AvailableTopic visibility(AvailableTopic.VisibilityEnum visibility)
      Visibility of this topic (Public or Preview)

    • getVisibility

      public AvailableTopic.VisibilityEnum getVisibility()

    • setVisibility

      public void setVisibility(AvailableTopic.VisibilityEnum visibility)

    • schema

      public AvailableTopic schema(Map<String,Object> schema)

    • getSchema

      public Map<String,Object> getSchema()

    • setSchema

      public void setSchema(Map<String,Object> schema)

    • requiresCurrentUser

      public AvailableTopic requiresCurrentUser(Boolean requiresCurrentUser)
      True if the topic user ID is required to match the subscribing user ID

    • getRequiresCurrentUser

      public Boolean getRequiresCurrentUser()

    • setRequiresCurrentUser

      public void setRequiresCurrentUser(Boolean requiresCurrentUser)

    • requiresCurrentUserOrPermission

      public AvailableTopic requiresCurrentUserOrPermission(Boolean requiresCurrentUserOrPermission)
      True if permissions are only required when the topic user ID does not match the subscribing user ID

    • getRequiresCurrentUserOrPermission

      public Boolean getRequiresCurrentUserOrPermission()

    • setRequiresCurrentUserOrPermission

      public void setRequiresCurrentUserOrPermission(Boolean requiresCurrentUserOrPermission)

    • transports

      public AvailableTopic transports(List<AvailableTopic.TransportsEnum> transports)
      Transports that support events for the topic

    • getTransports

      public List<AvailableTopic.TransportsEnum> getTransports()

    • setTransports

      public void setTransports(List<AvailableTopic.TransportsEnum> transports)

    • publicApiTemplateUriPaths

      public AvailableTopic publicApiTemplateUriPaths(List<String> publicApiTemplateUriPaths)

    • getPublicApiTemplateUriPaths

      public List<String> getPublicApiTemplateUriPaths()

    • setPublicApiTemplateUriPaths

      public void setPublicApiTemplateUriPaths(List<String> publicApiTemplateUriPaths)

    • topicParameters

      public AvailableTopic topicParameters(List<String> topicParameters)
      Parameters in the topic name that can be substituted, in the order they appear in the topic name

    • getTopicParameters

      public List<String> getTopicParameters()

    • setTopicParameters

      public void setTopicParameters(List<String> topicParameters)

    • 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