SystemNotifications In-Process API Service

This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.ISystemNotifications>() and is defined in Telligent.Evolution.Platform.dll

Methods

AdditionalInfo Create(string subject, string body, SystemNotificationCreateOptions options = null);

Creates a system notification

Parameters

Name	Type	Description	Required
subject	`string`	Subject	Required
body	`string`	Body	Required
options	`SystemNotificationCreateOptions`	Options	Optional

Return Type

AdditionalInfo

SystemNotification Get(int notificationId);

Gets a system notification

Parameters

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

Return Type

SystemNotification

SystemNotification Get(string groupingKey);

Gets a system notification

Parameters

Name	Type	Description	Required	Default	Options
groupingKey	`string`	Grouping Key	Required

Return Type

SystemNotification

PagedList<SystemNotification> List(SystemNotificationListOptions options = null);

Lists system notifications

Parameters

Name	Type	Description	Required	Default	Options
options	`SystemNotificationListOptions`	Options	Optional

Return Type

PagedList<SystemNotification>

SystemNotification Update(int notificationId, SystemNotificationUpdateOptions options = null);

Updates a system notification

Parameters

Name	Type	Description	Required	Default	Options
notificationId	`int`	Notification Id	Required
options	`SystemNotificationUpdateOptions`	Options	Optional

Return Type

SystemNotification

SystemNotification Update(string groupingKey, SystemNotificationUpdateOptions options = null);

Updates a system notification

Parameters

Name	Type	Description	Required	Default	Options
groupingKey	`string`	Grouping Key	Required
options	`SystemNotificationUpdateOptions`	Options	Optional

Return Type

SystemNotification

Recommended