Interface PortalNotificationService

All Superinterfaces:
ContextSensitiveSingletonService, Service

@Deprecated public interface PortalNotificationService extends ContextSensitiveSingletonService
Deprecated.
The Notification functionality will be removed in a future release. Use the Tempo Interface for similar functionality.
Defines service methods used to access notifications received through the Portal. Portal registers itself with the Notification framework as one of the possible output media. Notifications sent to the Portal medium because of default settings or explicit rules can be retrieved through this service.

Methods of service classes can all throw the unchecked exception ServiceException if any system-level error (for example, server failure) occurs, and will in general throw a checked exception (InvalidXXXException) when an entity to be retrieved is inaccessible, instead of returning null. Exceptions to this paradigm (including the use of ResultList as described below) are noted. All checked exceptions extend AppianException.

It may be necessary to retrieve a subset of results as opposed to an entire collection, and also to sort the subset by some property of the returned object. "Paging" methods which return a ResultPage are provided in certain instances for this purpose. The ResultPage will contain the sorted subset of results (via Result.getResults()), and the total number of items in the available result set (via ResultPage.getAvailableItems()).

It may also be necessary to retrieve some results, even if all results cannot be retrieved (for instance, some of the entities corresponding to a list of entity IDs may no longer exist). Methods which return a ResultList are provided for this purpose. The Result.getResults() method in this case will return all results which can be retrieved. In addition, there will be a list of result codes (ResultList.getResultCodes()) that represent the successful retrieval of an entity, or, if the entity could not be retrieved, the reason for the failure. See the CODE_XXX constants in ResultList for details.

See Also:
  • Field Details

    • SORT_NOTIFICATION_ORDER_ASCENDING

      static final Integer SORT_NOTIFICATION_ORDER_ASCENDING
      Deprecated.
      A constant sort order for notification - sort in ascending order
    • SORT_NOTIFICATION_ORDER_DESCENDING

      static final Integer SORT_NOTIFICATION_ORDER_DESCENDING
      Deprecated.
      A constant sort order for notification - sort in descending order
    • PORTAL_NOTIFICATION_APPLICATION

      static final String PORTAL_NOTIFICATION_APPLICATION
      Deprecated.
      A constant for the Portal application This is used to send portal notifications
      See Also:
    • PERSONALIZATION_NOTIFICATION_APPLICATION

      static final String PERSONALIZATION_NOTIFICATION_APPLICATION
      Deprecated.
      A constant for the Personalization application This is used to send personalization notification
      See Also:
    • COLLABORATION_NOTIFICATION_APPLICATION

      static final String COLLABORATION_NOTIFICATION_APPLICATION
      Deprecated.
      A constant for the Collaboration application This is used to send notifications within collaboration
      See Also:
    • FORUM_NOTIFICATION_APPLICATION

      static final String FORUM_NOTIFICATION_APPLICATION
      Deprecated.
      A constant for the Forums application
      See Also:
    • PROCESS_NOTIFICATION_APPLICATION

      static final String PROCESS_NOTIFICATION_APPLICATION
      Deprecated.
      A constant for the Process application This is used to send process notification
      See Also:
    • TEMPO_NOTIFICATION_APPLICATION

      static final String TEMPO_NOTIFICATION_APPLICATION
      Deprecated.
      A constant for the Tempo application
      See Also:
    • TASKS_NOTIFICATION_APPLICATION

      static final String TASKS_NOTIFICATION_APPLICATION
      Deprecated.
      A constant for the Tasks application
      See Also:
    • FEED_NOTIFICATION_APPLICATION

      static final String FEED_NOTIFICATION_APPLICATION
      Deprecated.
      A constant for the Feeds application
      See Also:
    • FORUM_THREAD_SUBSCRIBE_NOTIFICATION_TYPE

      static final String FORUM_THREAD_SUBSCRIBE_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the forum and thread subscribe notification type This is used to send forum subscription notification
      See Also:
    • FORUM_THREAD_INVITE_NOTIFICATION_TYPE

      static final String FORUM_THREAD_INVITE_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the forum and thread invitation notification type This is used to send forum and thread inivitation notification
      See Also:
    • FORUM_THREAD_ACCEPT_INVITE_NOTIFICATION_TYPE

      static final String FORUM_THREAD_ACCEPT_INVITE_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the forum and thread invitation acceptance notification type This is used to send acceptances of forum and thread invitations
      See Also:
    • FORUM_THREAD_DECLINE_INVITE_NOTIFICATION_TYPE

      static final String FORUM_THREAD_DECLINE_INVITE_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the forum and thread invitation declination notification type This is used to send declinations of forum and thread invitation
      See Also:
    • GROUP_MEMBERSHIP_REQUESTED_NOTIFICATION_TYPE

      static final String GROUP_MEMBERSHIP_REQUESTED_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the group membership request notification type This is used to send a notification of a group membership request
      See Also:
    • GROUP_MEMBERSHIP_REMOVED_NOTIFICATION_TYPE

      static final String GROUP_MEMBERSHIP_REMOVED_NOTIFICATION_TYPE
      Deprecated.
      A constants corresponding to the group membership removal notification type This is used to send a group removal notification
      See Also:
    • GROUP_INVITATION_NOTIFICATION_TYPE

      static final String GROUP_INVITATION_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the group invitation notification type This is used to send a group invitation notification
      See Also:
    • GROUP_MEMBERSHIP_APPROVED_NOTIFICATION_TYPE

      static final String GROUP_MEMBERSHIP_APPROVED_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the group membership approved notification type This is used to send an invitation of an approved group membership
      See Also:
    • GROUP_MEMBERSHIP_DENIED_NOTIFICATION_TYPE

      static final String GROUP_MEMBERSHIP_DENIED_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the group membership denied notification type This is used to send a notification of a denial of group membership
      See Also:
    • GROUP_INVITATION_ACCEPTED_NOTIFICATION_TYPE

      static final String GROUP_INVITATION_ACCEPTED_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the group invitation acceptance notification type This is used to send a notification of acceptance to a group invitation
      See Also:
    • GROUP_INVITATION_DECLINED_NOTIFICATION_TYPE

      static final String GROUP_INVITATION_DECLINED_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the group invitation declination notification type This is used to send a notification of a declination to a group invitation
      See Also:
    • PORTAL_SEND_FEEDBACK_NOTIFICATION_TYPE

      static final String PORTAL_SEND_FEEDBACK_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the portal send feedback notification type This is used to send a feedback notification
      See Also:
    • PORTAL_SYSTEM_NOTIFICATION_TYPE

      static final String PORTAL_SYSTEM_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the portal system notification type This is used to send a portal system notification
      See Also:
    • PORTAL_PAGE_APPROVAL_NOTIFICATION_TYPE

      static final String PORTAL_PAGE_APPROVAL_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the portal page approval notification type This is used to send a notification for page approvals
      See Also:
    • PORTAL_PAGE_APPROVAL_REQUEST_NOTIFICATION_TYPE

      static final String PORTAL_PAGE_APPROVAL_REQUEST_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the portal page approval request notification type This is used to send a notification for page approval requests
      See Also:
    • PORTAL_PAGE_ACCESS_REMOVAL_NOTIFICATION_TYPE

      static final String PORTAL_PAGE_ACCESS_REMOVAL_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the portal page membership removal notification type This is used to send a notification for page membership removal
      See Also:
    • COLLABORATION_ACCESS_APPROVED_NOTIFICATION_TYPE

      static final String COLLABORATION_ACCESS_APPROVED_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the collaboration access approved notification type This is used to send a notification of access approved for a knowledge center in collaboration
      See Also:
    • COLLABORATION_ACCESS_DENIED_NOTIFICATION_TYPE

      static final String COLLABORATION_ACCESS_DENIED_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the collaboration access denied notification type This is used to send a notification of access denied to a a knowledge center in collaboration
      See Also:
    • COLLABORATION_ACCESS_REQUEST_NOTIFICATION_TYPE

      static final String COLLABORATION_ACCESS_REQUEST_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the collaboration access requested notification type This is used to send a notification of requested access to a knowledge center in collaboration
      See Also:
    • COLLABORATION_APPROVED_CHANGES_NOTIFICATION_TYPE

      static final String COLLABORATION_APPROVED_CHANGES_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the collaboration changes approved notification type This is used to send a notification of changes to a document approved in collaboration. When possible, use ContentService.notifyApproved(com.appiancorp.suiteapi.content.Approved...) instead.
      See Also:
    • COLLABORATION_DENIED_CHANGES_NOTIFICATION_TYPE

      static final String COLLABORATION_DENIED_CHANGES_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the collaboration changes denied notification type This is used to send a notification of denial of changes to a document in collaboration. When possible, use ContentService.notifyApproved(com.appiancorp.suiteapi.content.Approved...) instead.
      See Also:
    • COLLABORATION_REQUEST_CHANGES_NOTIFICATION_TYPE

      static final String COLLABORATION_REQUEST_CHANGES_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the collaboration request changes notification type This is used to send a notification to request approval of changes to a document in collaboration
      See Also:
    • COLLABORATION_EXPIRING_FILES_NOTIFICATION_TYPE

      static final String COLLABORATION_EXPIRING_FILES_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the collaboration file expiration notification type This is used to send a notification of expiring files in collaboration
      See Also:
    • COLLABORATION_INVITATION_NOTIFICATION_TYPE

      static final String COLLABORATION_INVITATION_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the collaboration invitation notification type This is used to send a notification of an invitation to a knowledge center in collaboration
      See Also:
    • COLLABORATION_INVITATION_ACCEPTED_NOTIFICATION_TYPE

      static final String COLLABORATION_INVITATION_ACCEPTED_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the collaboration invitation accepted notification type This is used to send a notification of acceptance of an invitation to a knowledge center in collaboration
      See Also:
    • COLLABORATION_INVITATION_DECLINED_NOTIFICATION_TYPE

      static final String COLLABORATION_INVITATION_DECLINED_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the collaboration invitation declined notification type This is used to send a notification of declination of an invitation to a knowledge center in collaboration
      See Also:
    • COLLABORATION_EXPORT_COMPLETED_NOTIFICATION_TYPE

      static final String COLLABORATION_EXPORT_COMPLETED_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the collaboration export completed notification type This is used to send a notification when an export operation has completed
      See Also:
    • COLLABORATION_IMPORT_COMPLETED_NOTIFICATION_TYPE

      static final String COLLABORATION_IMPORT_COMPLETED_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the collaboration import completed notification type This is used to send a notification when an import operation has completed
      See Also:
    • PROCESS_TASK_ESCALATED_NOTIFICATION_TYPE

      static final String PROCESS_TASK_ESCALATED_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the process task escalated notification type This is sent when to when a task has been escalated
      See Also:
    • PROCESS_PARENT_CAUSES_PUBLISH_NOTIFICATION_TYPE

      static final String PROCESS_PARENT_CAUSES_PUBLISH_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the "parent process causes sub process to be published" notification type This is used to send a notification when the publishing of a parent process model causes its sub- or linked process models to be published
      See Also:
    • PROCESS_NEW_TASK_ME_NOTIFICATION_TYPE

      static final String PROCESS_NEW_TASK_ME_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the "New Task Assigned to Me" notification type This is used to send a notification when a user has a new task assigned to them
      See Also:
    • PROCESS_NEW_TASK_OTHERS_NOTIFICATION_TYPE

      static final String PROCESS_NEW_TASK_OTHERS_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the "New Task Assigned to Others" notification type This is used to send a notification to a user when a task has been assigned to the user and to others
      See Also:
    • PROCESS_EXCEPTION_NOTIFICATION_TYPE

      static final String PROCESS_EXCEPTION_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the process exception notification type This is used to send a notification when an exception has occurred in a process
      See Also:
    • PROCESS_MODEL_EXCEPTION_NOTIFICATION_TYPE

      static final String PROCESS_MODEL_EXCEPTION_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the process model exception notification type This is used to send a notification when an exception has occurred in a process model
      See Also:
    • PROCESS_TASK_EXCEPTION_NOTIFICATION_TYPE

      static final String PROCESS_TASK_EXCEPTION_NOTIFICATION_TYPE
      Deprecated.
      A constant corresponding to the task exception notification type This is used to send a notification when an exception has occurred in a task
      See Also:
    • TEMPO_MESSAGE_POSTED

      static final String TEMPO_MESSAGE_POSTED
      Deprecated.
      A constant corresponding to the "New message sent to you" notification type. This is used to send a notification when someone posts a message targeted to a user explicitly (but not necessarily exclusively).
      See Also:
    • TEMPO_GROUP_MESSAGE_POSTED

      static final String TEMPO_GROUP_MESSAGE_POSTED
      Deprecated.
      A constant corresponding to the "New group message posted" notification type. This is used to send a notification when someone posts a message targeted to a group that the recipient is a member of.
      See Also:
    • TEMPO_COMMENT_ON_MESSAGE

      @Deprecated static final String TEMPO_COMMENT_ON_MESSAGE
      Deprecated.
      TEMPO_COMMENT_ON_MESSAGE_TO_GROUP is now used for messages to users, groups and everyone
      A constant corresponding to the "New comment on your message to everyone" notification type. This is used to send a notification when someone other than the recipient writes a comment on a message that the recipient posted.
      See Also:
    • TEMPO_COMMENT_ON_MESSAGE_TO_GROUP

      static final String TEMPO_COMMENT_ON_MESSAGE_TO_GROUP
      Deprecated.
      A constant corresponding to the "New comment on your message" notification type. This is used to send a notification when when someone other than the recipient writes a comment on a message that the recipient posted to a group.
      See Also:
    • TEMPO_COMMENT_ON_POST_TO_FOLLOWERS

      static final String TEMPO_COMMENT_ON_POST_TO_FOLLOWERS
      Deprecated.
      A constant corresponding to the "New comment on your post" notification type. This is used to send a notification when someone other than the recipient writes a comment on a post that the recipient made.
      See Also:
    • TEMPO_COMMENT_ON_MESSAGE_COMMENTED_ON

      static final String TEMPO_COMMENT_ON_MESSAGE_COMMENTED_ON
      Deprecated.
      A constant corresponding to the "New comment on a post or message that you have commented on" notification type. This is used to send a notification when someone other than the recipient writes a comment on a message that the recipient had previously also commented on or starred.
      See Also:
    • TEMPO_POST_ATTRIBUTED_TO_YOU

      static final String TEMPO_POST_ATTRIBUTED_TO_YOU
      Deprecated.
      A constant corresponding to the "New event attributed to you" notification type. This is used to send a notification when the recipient is listed as the actor for a Tempo event.
      See Also:
    • TEMPO_COMMENT_ON_POST

      static final String TEMPO_COMMENT_ON_POST
      Deprecated.
      A constant corresponding to the "New comment on an event attributed to you" notification type. This is used to send a notification when the recipient is listed as the actor for a Tempo event and another user posts a comment to the feed entry.
      See Also:
    • TEMPO_HAZARD_ON_POST

      static final String TEMPO_HAZARD_ON_POST
      Deprecated.
      A constant corresponding to the "New hazard on an event attributed to you" notification type. This is used to send a notification when the recipient is listed as the actor for a Tempo event and a hazard is posted to the feed entry.
      See Also:
    • TEMPO_COMMENT_ON_POST_COMMENTED_ON

      static final String TEMPO_COMMENT_ON_POST_COMMENTED_ON
      Deprecated.
      A constant corresponding to the "New comment on an event that you have commented on" notification type. This is used to send a notification when someone other than the recipient writes a comment on a feed entry that the recipient had previously also commented on or starred.
      See Also:
    • TEMPO_HAZARD_ON_POST_COMMENTED_ON

      static final String TEMPO_HAZARD_ON_POST_COMMENTED_ON
      Deprecated.
      A constant corresponding to the "New hazard on an event that you have commented on" notification type. This is used to send a notification when a hazard is posted to a feed entry that the recipient has commented on or starred.
      See Also:
    • TEMPO_COMMENT_ON_SYSTEM_POST_COMMENTED_ON

      static final String TEMPO_COMMENT_ON_SYSTEM_POST_COMMENTED_ON
      Deprecated.
      A constant corresponding to the "New comment on a system event that you have commented on" notification type. This is used to send a notification when someone other than the recipient writes a comment on a system event feed entry that the recipient had previously also commented on or starred.
      See Also:
    • TEMPO_HAZARD_ON_SYSTEM_POST_COMMENTED_ON

      static final String TEMPO_HAZARD_ON_SYSTEM_POST_COMMENTED_ON
      Deprecated.
      A constant corresponding to the "New hazard on a system event that you have commented on" notification type. This is used to send a notification when a hazard is posted to a system event feed entry that the recipient has commented on or starred.
      See Also:
    • TEMPO_RECEIVED_KUDOS

      static final String TEMPO_RECEIVED_KUDOS
      Deprecated.
      A constant corresponding to the "New kudos given to you" notification type. This is used to send a notification when the recipient gets a kudos
      See Also:
    • TEMPO_COMMENT_ON_GIVEN_KUDOS

      static final String TEMPO_COMMENT_ON_GIVEN_KUDOS
      Deprecated.
      A constant corresponding to the "New comment on a kudos that you gave" notification type. This is used to send a notification when someone other than the author writes a comment on a kudos.
      See Also:
    • TEMPO_COMMENT_ON_RECEIVED_KUDOS

      static final String TEMPO_COMMENT_ON_RECEIVED_KUDOS
      Deprecated.
      A constant corresponding to the "New comment on a kudos that you received" notification type. This is used to send a notification when someone other than the recipient writes a comment on a kudos.
      See Also:
    • TEMPO_COMMENT_ON_KUDOS_COMMENTED_ON

      static final String TEMPO_COMMENT_ON_KUDOS_COMMENTED_ON
      Deprecated.
      A constant corresponding to the "New comment on a kudos that you have commented on or starred" notification type. This is used to send a notification when someone other than the author or recipient writes a comment on a kudos that the recipient commented on or starred.
      See Also:
    • TEMPO_PARTICIPANT_ADDED

      static final String TEMPO_PARTICIPANT_ADDED
      Deprecated.
      You have been added as a participant
      See Also:
    • TEMPO_GROUP_PARTICIPANT_ADDED

      static final String TEMPO_GROUP_PARTICIPANT_ADDED
      Deprecated.
      Group has been added as a participant
      See Also:
    • TEMPO_PARTICIPANT_ADDED_TO_YOUR_ENTRY

      static final String TEMPO_PARTICIPANT_ADDED_TO_YOUR_ENTRY
      Deprecated.
      Participants added to your feed entry
      See Also:
    • TASKS_COMMENT_ON_SOCIAL_TASK_SENT_TO_YOU

      static final String TASKS_COMMENT_ON_SOCIAL_TASK_SENT_TO_YOU
      Deprecated.
      A constant corresponding to the "New comment on a social task that was sent to you" notification type. This is used to send a notification when there is a new comment on a social task.
      See Also:
    • TASKS_COMMENT_ON_SOCIAL_TASK_SENT_BY_YOU

      static final String TASKS_COMMENT_ON_SOCIAL_TASK_SENT_BY_YOU
      Deprecated.
      A constant corresponding to the "New comment on a social task that was sent by you" notification type. This is used to send a notification when there is a new comment on a social task.
      See Also:
    • TASKS_SOCIAL_TASK_SENT_TO_YOU_CLOSED

      static final String TASKS_SOCIAL_TASK_SENT_TO_YOU_CLOSED
      Deprecated.
      A constant corresponding to the "A social task that was sent to you was closed" notification type. This is used to send a notification when a social task is closed.
      See Also:
    • TASKS_SOCIAL_TASK_SENT_BY_YOU_CLOSED

      static final String TASKS_SOCIAL_TASK_SENT_BY_YOU_CLOSED
      Deprecated.
      A constant corresponding to the "A social task that was sent by you was closed" notification type. This is used to send a notification when a social task is closed.
      See Also:
    • getNotifications$UPDATES

      static final boolean getNotifications$UPDATES
      Deprecated.
      See Also:
    • getNotificationsByApplicationAndType$UPDATES

      static final boolean getNotificationsByApplicationAndType$UPDATES
      Deprecated.
      See Also:
    • getNotificationsByApplication$UPDATES

      static final boolean getNotificationsByApplication$UPDATES
      Deprecated.
      See Also:
    • deleteNotification$UPDATES

      static final boolean deleteNotification$UPDATES
      Deprecated.
      See Also:
    • deleteNotifications$UPDATES

      static final boolean deleteNotifications$UPDATES
      Deprecated.
      See Also:
    • deleteNotificationsBeforeTimestamp$UPDATES

      static final boolean deleteNotificationsBeforeTimestamp$UPDATES
      Deprecated.
      See Also:
    • getUnreadNotificationsCount$UPDATES

      static final boolean getUnreadNotificationsCount$UPDATES
      Deprecated.
      See Also:
    • getNotificationsSummary$UPDATES

      static final boolean getNotificationsSummary$UPDATES
      Deprecated.
      See Also:
    • deleteExpiredNotifications$UPDATES

      static final boolean deleteExpiredNotifications$UPDATES
      Deprecated.
      See Also:
    • markNotificationAsRead$UPDATES

      static final boolean markNotificationAsRead$UPDATES
      Deprecated.
      See Also:
    • markNotificationsAsRead$UPDATES

      static final boolean markNotificationsAsRead$UPDATES
      Deprecated.
      See Also:
    • notify$UPDATES

      static final boolean notify$UPDATES
      Deprecated.
      See Also:
    • notifyWithExcludedUsers$UPDATES

      static final boolean notifyWithExcludedUsers$UPDATES
      Deprecated.
      See Also:
    • getNotificationsPaging$UPDATES

      static final boolean getNotificationsPaging$UPDATES
      Deprecated.
      See Also:
    • getNotification$UPDATES

      static final boolean getNotification$UPDATES
      Deprecated.
      See Also:
    • updateUsernames$UPDATES

      static final boolean updateUsernames$UPDATES
      Deprecated.
      See Also:
    • commitUpdateUsernames$UPDATES

      static final boolean commitUpdateUsernames$UPDATES
      Deprecated.
      See Also:
    • rollbackUpdateUsernames$UPDATES

      static final boolean rollbackUpdateUsernames$UPDATES
      Deprecated.
      See Also:
    • reloadProperties$UPDATES

      static final boolean reloadProperties$UPDATES
      Deprecated.
      See Also:
    • validate$UPDATES

      static final boolean validate$UPDATES
      Deprecated.
      See Also:
    • validateDatabase$UPDATES

      static final boolean validateDatabase$UPDATES
      Deprecated.
      See Also:
  • Method Details