Enables scripted content fragments to use Notifications
Methods
Delete
Deletes a notification
Velocity
#set($additionalInfoResponse = $core_v2_notification.Delete($notificationId))
JavaScript
var additionalInfoResponse = core_v2_notification.Delete(notificationId);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| notificationId | Guid | Notification Id | Required |
Returns
Get
Gets a single notification
Velocity
#set($notificationResponse = $core_v2_notification.Get($notificationId))
JavaScript
var notificationResponse = core_v2_notification.Get(notificationId);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| notificationId | Guid | Notification Id | Required |
Returns
List
Lists notifications. Filters can be passed as options in the format _Filters_NOTIFICATION_TYPE_ID = 'Include|Exclude'
Velocity
#set($pagedListResponse = $core_v2_notification.List("%{ ApplicationId = $applicationIdArg, ContainerId = $containerIdArg, ContentId = $contentIdArg, ContentTypeId = $contentTypeIdArg, ContentUrl = $contentUrlArg, IsRead = $isReadArg, NotificationCategoryId = $notificationCategoryIdArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg }"))JavaScript
var pagedListResponse = core_v2_notification.List({ ApplicationId: applicationIdArg, ContainerId: containerIdArg, ContentId: contentIdArg, ContentTypeId: contentTypeIdArg, ContentUrl: contentUrlArg, IsRead: isReadArg, NotificationCategoryId: notificationCategoryIdArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, SortBy: sortByArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| options | Options | Set of optional parameters including: | Required | ||
| ApplicationId | Guid | Application Id | Optional | ||
| ContainerId | Guid | Container Id | Optional | ||
| ContentId | Guid | Content Id | Optional | ||
| ContentTypeId | Guid | Content Type Id | Optional | ||
| ContentUrl | String | Content Url | Optional | ||
| IsRead | Boolean | Is Read | Optional | ||
| NotificationCategoryId | Guid | Notification Category Id | Optional | ||
| PageIndex | Int32 | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
| PageSize | Int32 | Specify the number of results to return per page. | Optional | 20 | |
| SortBy | String | Sort By | Optional | LastUpdatedDate | CreatedDate, LastUpdatedDate, NotificationCategory |
Returns
MarkAllAsRead
MarkAllAsRead Overload 1
Mark all notifications as read
Velocity
#set($additionalInfoResponse = $core_v2_notification.MarkAllAsRead())
JavaScript
var additionalInfoResponse = core_v2_notification.MarkAllAsRead();
MarkAllAsRead Overload 2
Mark all notifications as read
Velocity
#set($additionalInfoResponse = $core_v2_notification.MarkAllAsRead("%{ NotificationCategoryId = $notificationCategoryIdArg }"))JavaScript
var additionalInfoResponse = core_v2_notification.MarkAllAsRead({ NotificationCategoryId: notificationCategoryIdArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| options | Options | Set of optional parameters including: | Required | ||
| NotificationCategoryId | Guid | Notification Category Id | Optional |
Returns
Update
Updates a notification
Velocity
#set($notificationResponse = $core_v2_notification.Update($notificationId, "%{ MarkAsRead = $markAsReadArg }"))JavaScript
var notificationResponse = core_v2_notification.Update(notificationId, { MarkAsRead: markAsReadArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| notificationId | Guid | Notification Id | Required | ||
| options | Options | Set of optional parameters including: | Required | ||
| MarkAsRead | Boolean | Mark As Read | Optional | False |