Package com.i2group.disco.alerts

Interface ISendTo

All Known Implementing Classes:
SendTo
public interface ISendTo
A set of criteria that determine the list of users to whom an alert is sent.

Users receive the alert if they match any of the criteria. For example, if getUserPrincipalNames() returns ["user1"] and getGroups() returns ["groupA","groupB"], then a user with the principal name user1 matches regardless of group membership, and a user who is a member of groupA matches regardless of membership of groupB (or any other group).

Note: A user must have logged into the system before an alert can be sent to them.

Since:
12.0

  • Method Details

    • getUsers

      @Deprecated Set<String> getUsers()
      Deprecated.
      Use getUserPrincipalNames() instead.
      Gets the principal names of specific users to receive the alert.
      Returns:
      See above, or null if this criterion is not used.

    • getUserPrincipalNames

      Set<String> getUserPrincipalNames()
      Gets the principal names of specific users to receive the alert.
      Returns:
      A set of user principal names, or null if this criterion is not used.
      Since:
      13.8

    • getUserIds

      Set<String> getUserIds()
      Gets the user identifiers of specific users to receive the alert.
      Returns:
      A set of user identifiers, or null if this criterion is not used.
      Since:
      13.8

    • getGroups

      Set<String> getGroups()
      Gets the names of specific system user groups to receive the alert.
      Returns:
      See above, or null if this criterion is not used.

    • getCommandPermissions

      Set<String> getCommandPermissions()
      Gets the names of command access control permissions whose owners are to receive the alert.
      Returns:
      See above, or null if this criterion is not used.

    • isSendToAll

      boolean isSendToAll()
      Indicates whether all users are to receive the alert.
      Returns:
      true if the alert is to go to all users, overriding any other criteria. false if the other criteria take precedence.