This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.INotifications>() and is defined in Telligent.Evolution.Platform.dll
Events
Events.AfterCreate
Handler
void NotificationAfterCreateEventHandler(NotificationAfterCreateEventArgs e);
Events.AfterDelete
Handler
void NotificationAfterDeleteEventHandler(NotificationAfterDeleteEventArgs e);
Events.AfterUpdate
Handler
void NotificationAfterUpdateEventHandler(NotificationAfterUpdateEventArgs e);
Events.BeforeCreate
Handler
void NotificationBeforeCreateEventHandler(NotificationBeforeCreateEventArgs e);
Events.BeforeDelete
Handler
void NotificationBeforeDeleteEventHandler(NotificationBeforeDeleteEventArgs e);
Events.BeforeUpdate
Handler
void NotificationBeforeUpdateEventHandler(NotificationBeforeUpdateEventArgs e);
Events.Render
Handler
void NotificationRenderEventHandler(NotificationRenderEventArgs e);
Properties
| Name | Type | Description | Default | Options |
|---|---|---|---|---|
| DataTypeId Obsolete | Guid | Migrate usage to scripted email or scripted plugins. |
Methods
AdditionalInfo Delete(Guid notificationId);
Deletes a notification
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| notificationId | Guid | Notification Id | Required |
Return Type
Notification Get(Guid notificationId);
Gets a single notification
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| notificationId | Guid | Notification Id | Required |
Return Type
NotificationTypeInfo GetNotificationType(Guid notificationTypeId);
Gets a notification type
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| notificationTypeId | Guid | Notification type Id | Required |
Return Type
PagedList<Notification> List(NotificationListOptions options = null);
Lists notifications. Filters can be passed as options in the format _Filters_NOTIFICATION_TYPE_ID = 'Include|Exclude'
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| options | NotificationListOptions | Options include: UserId, ContentId, ContentTypeId, ApplicationId, ContainerId, ContentUrl, IsRead, PageSize, PageIndex, Filters | Optional |
Return Type
ApiList<NotificationDistributionTypeInfo> ListDistributionTypes();
Lists notification distribution types
Return Type
ApiList<NotificationDistributionTypeInfo>
ApiList<NotificationTypeInfo> ListNotificationTypes();
Lists notification types
Return Type
NotificationUserPreferences ListPreferences();
Lists notification user preferences
Return Type
AdditionalInfo MarkAllAsRead(Guid? notificationCategoryId = null);
Mark notification as read
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| notificationCategoryId | Guid? | Notification Category Id | Optional |
Return Type
AdditionalInfo MarkAsRead(Guid notificationId);
Mark notification as read
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| notificationId | Guid | Notification Id | Required |
Return Type
AdditionalInfo UpdatePreference(Guid notificationTypeId, Guid? distributionTypeId, bool isEnabled);
Updates a notification user preference
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| notificationTypeId | Guid | Type of notification type to enable or disable | Required | ||
| distributionTypeId | Guid? | When specified, only enables or disables a specific distribution type for a specific notification type for a user. When not specified. When not specified, the entire notification is enabled or disabled for a user. | Required | ||
| isEnabled | bool | Whether to enable or disable | Required |