Enables scripted content fragments to use Notifications
Methods
Delete
Deletes a notification
Usage
#set($additionalInfoResponse = $core_v2_notification.Delete($notificationId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
notificationId | Guid | Notification Id | Required |
Return Type
Get
Gets a single notification
Usage
#set($notificationResponse = $core_v2_notification.Get($notificationId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
notificationId | Guid | Notification Id | Required |
Return Type
List
Lists notifications. Filters can be passed as options in the format _Filters_NOTIFICATION_TYPE_ID = 'Include|Exclude'
Usage
#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}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
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 | bool | Is Read | Optional | ||
NotificationCategoryId | Guid | Notification Category Id | Optional | ||
PageIndex | int | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
PageSize | int | Specify the number of results to return per page. | Optional | 20 | |
SortBy | string | Sort By | Optional | LastUpdatedDate | CreatedDate, LastUpdatedDate, NotificationCategory |
Return Type
Update
Updates a notification
Usage
#set($notificationResponse = $core_v2_notification.Update($notificationId, "%{MarkAsRead = $markAsReadArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
notificationId | Guid | Notification Id | Required | ||
MarkAsRead | bool | Mark As Read | Optional | False |