Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Xml
READ permission on the user's mailbox is required. This permission is normally limited to the user self and to administrators. Additionally the sender has permission to list her sent items.
[This is preliminary documentation and is subject to change.]
Returns a list of notifications for the calling user
Namespace: ContentStudio.Notifications
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
public string GetNotifications( ConnectionId connectionId, SessionId sessionId, int trusteeId, NotificationReaderSortOrder sortOrder, NotificationReaderListFilter filterCriteria, int currentId, ref int pageNumber, int pageSize, out int pageCount, out int recordCount )
Parameters
- connectionId
- Type: ContentStudioConnectionId
A value that identifies the web site - sessionId
- Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId). - trusteeId
- Type: SystemInt32
The user to list notifications for. Pass zero to list notifications for the caller. Reading notifications for other users is very limited due to strong security settings. - sortOrder
- Type: ContentStudio.NotificationsNotificationReaderSortOrder
Indicates how the list should be sorted - filterCriteria
- Type: ContentStudio.NotificationsNotificationReaderListFilter
Indicates what type of notifications to include in the list. - currentId
- Type: SystemInt32
This is the id of the current selected notification item or zero. If this item exists GetNotifications returns page where the item exists using the indicated sorting and filter. If not found the page indicated by the PageNumber parameter is returned instead. CurrentID can be used re-sort the list and still maintain the focus on the current selected item. Pass zero to ignore this functionality or when a selected item does not exist. - pageNumber
- Type: SystemInt32
The page number to read. If this value is less than 1 PageNumber will be 1. After the call this parameter will be updated with the actual page number. This value can be changed if the CurrentID parameter was defined. - pageSize
- Type: SystemInt32
The size of the pages to read. If this parameter is less than 1 pageSize will be 10. - pageCount
- Type: SystemInt32
The total pages of data found - recordCount
- Type: SystemInt32
The total entries found
Return Value
Type: StringXml
>root< >status<0status< >statustext<Success>/statustext< >pageno<1pageno< >pagesize<10>/pagesize< >pagecount<22pagecount< >recordcount<218>/recordcount< >filtercriteria<0filtercriteria< >notifications< >not< >id<10000>/id< >type<0type</< >posted<2006-10-01T09:48:31posted< >status<1>/status< >priority<1priority< >title<A messagetitle< >sender<Content Studioruntime>/sender< >receiver<UserUseman>/receiver< >duedate<2006-10-16T00:0000>/duedate< >isdue<0isdue< >/not< >!--More notelement canfollow--< >/notifications< >/root<
Exceptions
Exception | Condition |
---|---|
CSException | A business rule was violated in the underlying Content Studio database |
CSPermissionDeniedException | The caller has no permission to perform the requested action |
CSInvalidSessionException | A parameter has an invalid value |
CSInvalidParameterException | The session is invalid |
SqlException | An error occurred when executing the command against the Content Studio database |
Content Studio permissions
See Also