Notifications In-Process API Service

Ben Tiedt — Tue, 19 Nov 2019 20:03:42 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 20:03:42

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 In-Process API Event Argument|NotificationAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void NotificationAfterDeleteEventHandler([[NotificationAfterDeleteEventArgs In-Process API Event Argument|NotificationAfterDeleteEventArgs]] e);

Events.AfterUpdate

Handler

void NotificationAfterUpdateEventHandler([[NotificationAfterUpdateEventArgs In-Process API Event Argument|NotificationAfterUpdateEventArgs]] e);

Events.BeforeCreate

Handler

void NotificationBeforeCreateEventHandler([[NotificationBeforeCreateEventArgs In-Process API Event Argument|NotificationBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void NotificationBeforeDeleteEventHandler([[NotificationBeforeDeleteEventArgs In-Process API Event Argument|NotificationBeforeDeleteEventArgs]] e);

Events.BeforeUpdate

Handler

void NotificationBeforeUpdateEventHandler([[NotificationBeforeUpdateEventArgs In-Process API Event Argument|NotificationBeforeUpdateEventArgs]] e);

Events.Render

Handler

void NotificationRenderEventHandler([[NotificationRenderEventArgs In-Process API Event Argument|NotificationRenderEventArgs]] e);

Properties

Name	Type	Description	Default	Options
DataTypeId	`Guid`	Notifications data type identifier

Methods

AdditionalInfo Delete(Guid notificationId);

Deletes a notification

Parameters

Name	Type	Description	Required	Default	Options
notificationId	`Guid`	Notification Id	Required

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

Notification Get(Guid notificationId);

Gets a single notification

Parameters

Name	Type	Description	Required	Default	Options
notificationId	`Guid`	Notification Id	Required

Return Type

[[Notification In-Process API Supplementary Type|Notification]]

NotificationTypeInfo GetNotificationType(Guid notificationTypeId);

Gets a notification type

Parameters

Name	Type	Description	Required	Default	Options
notificationTypeId	`Guid`	Notification type Id	Required

Return Type

[[NotificationTypeInfo In-Process API Supplementary Type|NotificationTypeInfo]]

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 In-Process API Supplementary Type\|NotificationListOptions]]`	Options include: UserId, ContentId, ContentTypeId, ApplicationId, ContainerId, ContentUrl, IsRead, PageSize, PageIndex, Filters	Optional

Return Type

[[PagedList(T) In-Process API Supplementary Type|PagedList]]<[[Notification In-Process API Supplementary Type|Notification]]>

ApiList<NotificationDistributionTypeInfo> ListDistributionTypes();

Lists notification distribution types

Return Type

[[ApiList(T) In-Process API Supplementary Type|ApiList]]<[[NotificationDistributionTypeInfo In-Process API Supplementary Type|NotificationDistributionTypeInfo]]>

ApiList<NotificationTypeInfo> ListNotificationTypes();

Lists notification types

Return Type

[[ApiList(T) In-Process API Supplementary Type|ApiList]]<[[NotificationTypeInfo In-Process API Supplementary Type|NotificationTypeInfo]]>

NotificationUserPreferences ListPreferences();

Lists notification user preferences

Return Type

[[NotificationUserPreferences In-Process API Supplementary Type|NotificationUserPreferences]]

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 In-Process API Supplementary Type|AdditionalInfo]]

AdditionalInfo MarkAsRead(Guid notificationId);

Mark notification as read

Parameters

Name	Type	Description	Required	Default	Options
notificationId	`Guid`	Notification Id	Required

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

AdditionalInfo UpdatePreference(Guid notificationTypeId, Guid? distributionTypeId, bool isEnabled);

Updates a notification user preference

Parameters

Name	Type	Description	Required
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

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]