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

This function will be used to send any transactional alerts in OfficeClip. When an alert is sent, the alert gif in officeclip starts blinking. If the sent to the group, all the members of the group (whether registered or not) will get separate alerts.

Namespace:  OfficeClip.DBLayer.OfficePortal
Assembly:  OfficeClip.DBLayer (in OfficeClip.DBLayer)
Version: 8.1.1.0

Syntax

C#
public int SetAlert(
	int sendUserId,
	int isGroup,
	string message,
	string action,
	string alertType,
	string priority,
	int applicationId,
	int applicationSecondaryId,
	int id1,
	int id2,
	int isSecured,
	int userId,
	int sendGroupId
)
Visual Basic (Declaration)
Public Function SetAlert ( _
	sendUserId As Integer, _
	isGroup As Integer, _
	message As String, _
	action As String, _
	alertType As String, _
	priority As String, _
	applicationId As Integer, _
	applicationSecondaryId As Integer, _
	id1 As Integer, _
	id2 As Integer, _
	isSecured As Integer, _
	userId As Integer, _
	sendGroupId As Integer _
) As Integer
Visual C++
public:
int SetAlert(
	int sendUserId, 
	int isGroup, 
	String^ message, 
	String^ action, 
	String^ alertType, 
	String^ priority, 
	int applicationId, 
	int applicationSecondaryId, 
	int id1, 
	int id2, 
	int isSecured, 
	int userId, 
	int sendGroupId
)

Parameters

sendUserId
Type: System..::.Int32
The user id to whom the alert is sent. a -1 value indicates that the userId, is null
isGroup
Type: System..::.Int32
1 if it is group alert, 0 if user alert
message
Type: System..::.String
The alert message
action
Type: System..::.String
The javascript to which determines what happens when a user clicks on the action
alertType
Type: System..::.String
what kind of alert, e.g. Invitation
priority
Type: System..::.String
'L' = Low, 'M' = Middle and 'H' = High
applicationId
Type: System..::.Int32
The application which sent the alert
applicationSecondaryId
Type: System..::.Int32
application specific information
id1
Type: System..::.Int32
application specific information
id2
Type: System..::.Int32
application specific information
isSecured
Type: System..::.Int32
if 1, the system will check whether the user has access to send alert to another user or group. If 0, alert will be sent to anybody. Making it 0 can make the query run a little faster
userId
Type: System..::.Int32
Id of the the user from whom this alert is being sent.
sendGroupId
Type: System..::.Int32
Id of the group to which the message is being sent.

Return Value

Returns the alert_id if successful, returns a negative number if error

See Also