Enables scripted content fragments to send system notifications
Methods
Create
Create Overload 1
Creates a system notification
Velocity
#set($additionalInfoResponse = $core_v2_systemNotification.Create($subject, $body))
JavaScript
var additionalInfoResponse = core_v2_systemNotification.Create(subject, body);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
subject | String | Subject | Required | ||
body | String | Body | Required |
Create Overload 2
Creates a system notification
Velocity
#set($additionalInfoResponse = $core_v2_systemNotification.Create($subject, $body, "%{ EnableDistribution = $enableDistributionArg, GroupId = $groupIdArg, GroupingKey = $groupingKeyArg, IsResolvable = $isResolvableArg, UserIds = $userIdsArg }"))
JavaScript
var additionalInfoResponse = core_v2_systemNotification.Create(subject, body, { EnableDistribution: enableDistributionArg, GroupId: groupIdArg, GroupingKey: groupingKeyArg, IsResolvable: isResolvableArg, UserIds: userIdsArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
subject | String | Subject | Required | ||
body | String | Body | Required | ||
options | Options | Set of optional parameters including: | Required | ||
EnableDistribution | Boolean | Enables the system notification to be sent to recipients. If disabled, the notification will only show on the community site. | Optional | True | |
GroupId | Int32 | Identifier of the group to target for this notification | Optional | ||
GroupingKey | Int32 | Identifier of the notification for future grouping of duplicate occurrences | Optional | ||
IsResolvable | Boolean | Identifies whether this notification is user-resolvable. When true, it can only be resolved by the Service User. | Optional | True | |
UserIds | Array of Int32 | Comma-separated list of users to send thie notification to | Optional |
Returns
Get
Get Overload 1
Retrieves a system notification
Velocity
#set($systemNotificationResponse = $core_v2_systemNotification.Get($notificationId))
JavaScript
var systemNotificationResponse = core_v2_systemNotification.Get(notificationId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
notificationId | Int32 | Notification Id | Required |
Get Overload 2
Retrieves a system notification
Velocity
#set($systemNotificationResponse = $core_v2_systemNotification.Get($groupingKey))
JavaScript
var systemNotificationResponse = core_v2_systemNotification.Get(groupingKey);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupingKey | String | Notification Grouping Key | Required |
Returns
List
List Overload 1
Lists system notifications for the accessing user
Velocity
#set($pagedListResponse = $core_v2_systemNotification.List())
JavaScript
var pagedListResponse = core_v2_systemNotification.List();
List Overload 2
Lists system notifications for the accessing user
Velocity
#set($pagedListResponse = $core_v2_systemNotification.List("%{ IsResolved = $isResolvedArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg }"))
JavaScript
var pagedListResponse = core_v2_systemNotification.List({ IsResolved: isResolvedArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, SortBy: sortByArg, SortOrder: sortOrderArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | Options | Set of optional parameters including: | Required | ||
IsResolved | Boolean | Resolution state | Optional | ||
PageIndex | Int32 | Page number of paged results to return. Zero-based index. | Optional | 0 | |
PageSize | Int32 | Number of results to return per page. | Optional | 20 | |
SortBy | String | Sort mechanism | Optional | LastOccurredDate | Count, LastOccurredDate |
SortOrder | String | Sort order | Optional | Descending | Ascending, Descending |
Returns
Update
Update Overload 1
Updates a system notification
Velocity
#set($systemNotificationResponse = $core_v2_systemNotification.Update($notificationId))
JavaScript
var systemNotificationResponse = core_v2_systemNotification.Update(notificationId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
notificationId | Int32 | Notification Id | Required |
Update Overload 2
Updates a system notification
Velocity
#set($systemNotificationResponse = $core_v2_systemNotification.Update($notificationId, "%{ IsResolved = $isResolvedArg }"))
JavaScript
var systemNotificationResponse = core_v2_systemNotification.Update(notificationId, { IsResolved: isResolvedArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
notificationId | Int32 | Notification Id | Required | ||
options | Options | Set of optional parameters including: | Required | ||
IsResolved | Boolean | Status of this notification. If the notification is non-resolvable, it can only be resolved by the Service User. | Optional |
Update Overload 3
Updates a system notification
Velocity
#set($systemNotificationResponse = $core_v2_systemNotification.Update($groupingKey))
JavaScript
var systemNotificationResponse = core_v2_systemNotification.Update(groupingKey);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupingKey | String | Grouping Key | Required |
Update Overload 4
Updates a system notification
Velocity
#set($systemNotificationResponse = $core_v2_systemNotification.Update($groupingKey, "%{ IsResolved = $isResolvedArg }"))
JavaScript
var systemNotificationResponse = core_v2_systemNotification.Update(groupingKey, { IsResolved: isResolvedArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupingKey | String | Notification Grouping Key | Required | ||
options | Options | Set of optional parameters including: | Required | ||
IsResolved | Boolean | Status of this notification. If the notification is non-resolvable, it can only be resolved by the Service User. | Optional |