NotificationManager.Send Method (ConnectionId, SessionId, NotificationType, Int32, String, String)

NotificationManagerSend Method (ConnectionId, SessionId, NotificationType, Int32, String, String)

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Sends a user notification.

Namespace: ContentStudio.Notifications
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)

Syntax

public int Send(
	ConnectionId connectionId,
	SessionId sessionId,
	NotificationType notificationType,
	int receiverId,
	string title,
	string details
)

Public Function Send ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	notificationType As NotificationType,
	receiverId As Integer,
	title As String,
	details As String
) As Integer

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).
notificationType: Type: ContentStudio.NotificationsNotificationType
The type of notification to send
receiverId: Type: SystemInt32
The id of the Content Studio user that receives the notification.
title: Type: SystemString
The title (subject) of the notification to send. This value cannot exceed MAX_NOTIFICATION_TITLE characters.
details: Type: SystemString
The message body to send. This parameter can be null or empty.

Return Value

Type: Int32
The id of the notification send.

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	The session is invalid
CSInvalidParameterException	A parameter has an invalid value
SqlException	An error occurred when executing the command against the Content Studio database

Content Studio permissions

Create permission on the receiver mailbox is required. Normally this permission is granted to all authenticated users

Reference

NotificationManager Class

Send Overload

ContentStudio.Notifications Namespace