SharePoint - Update User Alert
Declaration
<AMSHAREPOINT ACTIVITY="update_useralert" SITEURL="text" USER="text" ID="text" TITLE="text" EVENT="text (options)" FREQUENCY="text (options)" />
Description: Updates the settings and content of an existing user alert.
This activity is only supported on SharePoint 2013 Server. Before users and administrators can create, edit, delete, and view data alerts, they must be granted SharePoint permissions.
Practical Usage
Alerts are notifications of changes to content on a site that you receive as email messages or text messages to your mobile phone. This activity allows you to update a user alert for yourself or for other people if you are a site administrator.
Connection Parameters
Property |
Type |
Required |
Default |
Markup |
Description |
---|---|---|---|---|---|
Site |
Text |
Yes |
(Empty) |
SITE="http:/yServer/h/mi" |
The SharePoint site from which to modify a user alert. A SharePoint site is a collection of pages, site templates, lists, and libraries configured for the purpose of achieving an express goal. |
User |
Text |
Yes |
(Empty) |
USER="theUser"" |
The user from which to modify a user alert. The user can be identified by his/her login name or email address. |
User alert ID |
Text |
Yes |
(Empty) |
ID="D1F15740-4A56-4681-8C12-1DFBF346323B" |
The unique identifier of the alert to modify. |
Title |
Text |
No |
(Empty) |
TITLE="theAlert" |
The name of the alert in which to modify. |
Type |
Text (options) |
No |
Doesn't matter |
|
The type of alert to send. The available options are:
|
Event |
Text (options) |
No |
Doesn't matter |
|
The type of event to which the alert applies. The available options are:
|
Frequency |
Text (options) |
No |
Doesn't matter |
|
T he frequency in which the alert should be sent. The available options are:
|
Example
The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.
Description: Update SharePoint user alert for "me@myDaomain.com. Alert ID is "D1F15740-4A56-4681-8C12-1DFBF346323B"".
<AMSHAREPOINT ACTIVITY="update_useralert" SITEURL="http://myServer/myFolder" USER="me@myDaomain.com" USERFILTER="email" ID="D1F15740-4A56-4681-8C12-1DFBF346323B"" TITLE="myAlert" TYPE="email" EVENT="delete" FREQUENCY="daily" />