NotificationReaderGetItem Method (ConnectionId, SessionId, Int32, Boolean) Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Reads a notification item and returns its details.

Namespace: ContentStudio.Notifications
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
Copy
public string GetItem(
	ConnectionId connectionId,
	SessionId sessionId,
	int notificationId,
	bool setReceived
)

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).
notificationId
Type: SystemInt32
The notification to read
setReceived
Type: SystemBoolean
A boolean value that indicates whether Content Studio should set the notification as being read or not. This parameter is ignored if the caller is anyone else than the receiver.

Return Value

Type: String
Xml
Copy
<root>
  <status>0</status> 
  <statustext>Success</statustext> 
<not>
  <id>238764</id> 
  <uid>C15A60A5-41AE-452F-B9D5-5E577171E2AD</uid> 
  <wfinstance>0</wfinstance> 
  <wfitemid>0</wfitemid > 
  <wfdefid>0</wfdefid> 
  <documentid>0</documentid> 
  <documentname></documentname> 
  <receivertype>0</receivertype> 
  <receiversid>S-1-5-21-2060480078-1251939488-620655208-1104</receiversid> 
  <receivername>User Useman</receivername> 
  <notiftype>0</notiftype> 
  <title>A message</title> 
  <details>Come at on once!</details> 
  <sendertype>0</sendertype> 
  <sendersid>S-1-27-1</sendersid> 
  <sendername>Content Studio runtime</sendername> 
  <senderemail /> 
  <posted>2003-08-05T09:48:31.370</posted> 
  <received>2003-08-05T10:48:32.000</received> 
  <priority>1</priority> 
  <duedate>2003-08-06T00:00:00.000</duedate> 
  <isdue>0</isdue > 
  <completed>2003-08-05T11:48:31.000</completed> 
  <deleted>2003-08-05T12:48:31.450</deleted> 
  <status>5</status> 
  <relatedurl /> 
  <relatedconid>0</relatedconid> 
  <relateddocid>0</relateddocid> 
  <tag /> 
  <receiverid>34</receiverid />
  <senderid>45</senderid />
  <hasappid>0</hasappid />
  </not>
</root>
Exceptions
ExceptionCondition
CSExceptionA business rule was violated in the underlying Content Studio database
CSPermissionDeniedExceptionThe caller has no permission to perform the requested action
CSInvalidSessionExceptionThe session is invalid
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions
READ permission on the notification is required. Normally only the receiver, sender and administrators has this permission.
See Also

Reference

NotificationReader Class
GetItem Overload
ContentStudio.Notifications Namespace