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 the backwards compatible implementation of this method.
This implementation does not throw any exceptions, instead callers must examine the outcome of the call in the Status and StatusText output parameters.
[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, string xmlParameterData, ref int pageNumber, int pageSize, out int pageCount, out int recordCount, out int status, out string statusText )
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). - xmlParameterData
- Type: SystemString
XML that contains the parameters that this call uses. This XML is according to the Content Studio parameters XML schema - 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 - status
- Type: SystemInt32
An integer indicating result of the call. Zero is success. - statusText
- Type: SystemString
The textual representation of the call result.
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
Remarks
See Also