Creates a new Memo that is associated with an AlertSet.

Namespace: ININ.IceLib.Statistics.Alerts
Assembly: ININ.IceLib.Statistics (in ININ.IceLib.Statistics.dll) Version: 0.0.0.0 (22.3.0.218)

Syntax

C#
public static Memo CreateAlertMemo(
	Session session,
	string messageText,
	string messageName,
	string url,
	bool popupType,
	Icon icon,
	string soundFile,
	string alertSetId
)
Visual Basic
Public Shared Function CreateAlertMemo ( _
	session As Session, _
	messageText As String, _
	messageName As String, _
	url As String, _
	popupType As Boolean, _
	icon As Icon, _
	soundFile As String, _
	alertSetId As String _
) As Memo

Parameters

session
Type: ININ.IceLib.Connection..::..Session
Session object used to aid construction.
messageText
Type: System..::..String
Text of the Memo.
messageName
Type: System..::..String
The name of the Memo.
url
Type: System..::..String
The URL to navigate to, may be nullNothingnullptra null reference (Nothing in Visual Basic).
popupType
Type: System..::..Boolean
Determines if the Memo should popup.
icon
Type: System.Drawing..::..Icon
Icon to display.
soundFile
Type: System..::..String
Sound to play, may be nullNothingnullptra null reference (Nothing in Visual Basic).
alertSetId
Type: System..::..String
The ID of the AlertSet that this Memo is associated with.

Return Value

Newly created Memo.

Remarks

An alert Memo is a Memo that is sent for an alert. The only situation that one should be created manually is when creating a template for an AlertSet.
Note
An alert Memo cannot expire and as such does not use the Expiration nor the CanExpire fields.

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptionA parameter is nullNothingnullptra null reference (Nothing in Visual Basic).
System..::..ArgumentExceptionThe alertSetId length is zero.

Version Information

Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 SU 4 and beyond.

See Also