NotificationReader.GetNotifications Method (ConnectionId, SessionId, String, Int32, Int32, Int32, Int32, Int32, String)

NotificationReaderGetNotifications Method (ConnectionId, SessionId, String, Int32, Int32, Int32, Int32, Int32, String)

Content Studio 5.7 SDK

Content Studio Web Content Management System

[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
)

Public Function GetNotifications ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	xmlParameterData As String,
	ByRef pageNumber As Integer,
	pageSize As Integer,
	<OutAttribute> ByRef pageCount As Integer,
	<OutAttribute> ByRef recordCount As Integer,
	<OutAttribute> ByRef status As Integer,
	<OutAttribute> ByRef statusText As String
) As String

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: String
Xml

Copy

>root<
 &gt;status&lt;0status&lt;
 >statustext<Success>/statustext<
 &gt;pageno&lt;1pageno&lt;
 >pagesize<10>/pagesize<
 &gt;pagecount&lt;22pagecount&lt;
 >recordcount<218>/recordcount<
 &gt;filtercriteria&lt;0filtercriteria&lt;
 >notifications<
  &gt;not&lt;
   >id<10000>/id<
    &gt;type&lt;0type&lt;/&lt;
    >posted<2006-10-01T09:48:31posted&lt;
    >status<1>/status<
    &gt;priority&lt;1priority&lt;
    >title<A messagetitle&lt;
    >sender<Content Studioruntime>/sender<
    &gt;receiver&lt;UserUseman>/receiver<
    &gt;duedate&lt;2006-10-16T00:0000>/duedate<
    &gt;isdue&lt;0isdue&lt;
  >/not<
  &gt;!--More notelement canfollow--&lt;
 >/notifications<
&gt;/root&lt;

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

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.

Remarks

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.

Reference

NotificationReader Class

GetNotifications Overload

ContentStudio.Notifications Namespace