NotificationManagerSend Method (ConnectionId, SessionId, NotificationType, Int32, DateTime, NotificationPriority, String, String, String, String, Int32, 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,
	DateTime dueDate,
	NotificationPriority priority,
	string title,
	string details,
	string senderEmail,
	string senderAlias,
	int attachedDocumentId,
	string applicationId
)

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.
dueDate
Type: SystemDateTime
A date indicating when a task should be completed. Set this parameter to DateTime.MinValue if no due date is applicable. This parameter is used for tasks only.
priority
Type: ContentStudio.NotificationsNotificationPriority
The priority of the message. Can be one of the members of the NotificationPriority enumeration.
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.
senderEmail
Type: SystemString
The email address of the sender. Normally you set this parameter to null or empty since the email address of the sender will be retrieved from Content Studio.
senderAlias
Type: SystemString
An alias name of the sender. Normally set this parameter to null or empty since the name of the sender will be retrieved from Content Studio. If alias is specified this name will show up in the list as sender.
attachedDocumentId
Type: SystemInt32
The ID of a local Content Studio document that can be sent to the receiver as an attachment. Set to zero if no attachment exists.
applicationId
Type: SystemString
A string that can be converted to a GUID (global unique identifier) or null.

Return Value

Type: Int32
The id of the notification sent.
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
CSInvalidParameterExceptionA parameter has an invalid value
SqlExceptionAn error occurred when executing the command against the Content Studio database
FormatExceptionThe format of the passed in AppID is invalid
OverflowExceptionThe format of the passed in AppID is invalid
Content Studio permissions

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

Reference