[This is preliminary documentation and is subject to change.]
Sets the alerts to the archived State. Alerts in the archived State
are viewed by the user when they click on the archived alerts link.
An exception is thrown if the data setting is not successful.
Namespace:
OfficeClip.DBLayer.OfficePortalAssembly: OfficeClip.DBLayer (in OfficeClip.DBLayer)
Version: 8.1.1.0
Syntax
C# |
---|
public void SetArchiveAlerts( string alertList, int userId, bool isArchive ) |
Visual Basic (Declaration) |
---|
Public Sub SetArchiveAlerts ( _ alertList As String, _ userId As Integer, _ isArchive As Boolean _ ) |
Visual C++ |
---|
public: void SetArchiveAlerts( String^ alertList, int userId, bool isArchive ) |
Parameters
- alertList
- Type: System..::.String
The comma separated list of the alert ids.
- userId
- Type: System..::.Int32
The unique identifier for the user.
- isArchive
- Type: System..::.Boolean
true if alert is to be archived, false if it is to be restored