Interface INotificationsController

Namespace: DotNetNuke.Services.Social.Notifications
Assembly: DotNetNuke.dll
Syntax
public interface INotificationsController

Methods

CountNotifications(int, int)

Declaration
int CountNotifications(int userId, int portalId)
Parameters
Type Name Description
int userId
int portalId
Returns
Type Description
int

CreateNotificationType(NotificationType)

Declaration
void CreateNotificationType(NotificationType notificationType)
Parameters
Type Name Description
NotificationType notificationType

DeleteAllNotificationRecipients(int)

Declaration
void DeleteAllNotificationRecipients(int notificationId)
Parameters
Type Name Description
int notificationId

DeleteNotification(int)

Declaration
void DeleteNotification(int notificationId)
Parameters
Type Name Description
int notificationId

DeleteNotificationRecipient(int, int)

Declaration
void DeleteNotificationRecipient(int notificationId, int userId)
Parameters
Type Name Description
int notificationId
int userId

DeleteNotificationRecipient(int, string, int)

Declaration
void DeleteNotificationRecipient(int notificationTypeId, string context, int userId)
Parameters
Type Name Description
int notificationTypeId
string context
int userId

DeleteNotificationType(int)

Declaration
void DeleteNotificationType(int notificationTypeId)
Parameters
Type Name Description
int notificationTypeId

DeleteNotificationTypeAction(int)

Declaration
void DeleteNotificationTypeAction(int notificationTypeActionId)
Parameters
Type Name Description
int notificationTypeActionId

DeleteUserNotifications(UserInfo)

Declaration
int DeleteUserNotifications(UserInfo user)
Parameters
Type Name Description
UserInfo user
Returns
Type Description
int

GetNotification(int)

Declaration
Notification GetNotification(int notificationId)
Parameters
Type Name Description
int notificationId
Returns
Type Description
Notification

GetNotificationByContext(int, string)

Declaration
IList<Notification> GetNotificationByContext(int notificationTypeId, string context)
Parameters
Type Name Description
int notificationTypeId
string context
Returns
Type Description
IList<Notification>

GetNotificationType(int)

Declaration
NotificationType GetNotificationType(int notificationTypeId)
Parameters
Type Name Description
int notificationTypeId
Returns
Type Description
NotificationType

GetNotificationType(string)

Declaration
NotificationType GetNotificationType(string name)
Parameters
Type Name Description
string name
Returns
Type Description
NotificationType

GetNotificationTypeAction(int)

Declaration
NotificationTypeAction GetNotificationTypeAction(int notificationTypeActionId)
Parameters
Type Name Description
int notificationTypeActionId
Returns
Type Description
NotificationTypeAction

GetNotificationTypeAction(int, string)

Declaration
NotificationTypeAction GetNotificationTypeAction(int notificationTypeId, string name)
Parameters
Type Name Description
int notificationTypeId
string name
Returns
Type Description
NotificationTypeAction

GetNotificationTypeActions(int)

Declaration
IList<NotificationTypeAction> GetNotificationTypeActions(int notificationTypeId)
Parameters
Type Name Description
int notificationTypeId
Returns
Type Description
IList<NotificationTypeAction>

GetNotifications(int, int, int, int)

Declaration
IList<Notification> GetNotifications(int userId, int portalId, int afterNotificationId, int numberOfRecords)
Parameters
Type Name Description
int userId
int portalId
int afterNotificationId
int numberOfRecords
Returns
Type Description
IList<Notification>

GetToasts(UserInfo)

Declaration
IList<Notification> GetToasts(UserInfo userInfo)
Parameters
Type Name Description
UserInfo userInfo
Returns
Type Description
IList<Notification>

IsToastPending(int)

Declaration
bool IsToastPending(int notificationId)
Parameters
Type Name Description
int notificationId
Returns
Type Description
bool

MarkReadyForToast(Notification, UserInfo)

Declaration
void MarkReadyForToast(Notification notification, UserInfo userInfo)
Parameters
Type Name Description
Notification notification
UserInfo userInfo

MarkToastSent(int, int)

Declaration
void MarkToastSent(int notificationId, int userId)
Parameters
Type Name Description
int notificationId
int userId

SendNotification(Notification, int, IList<RoleInfo>, IList<UserInfo>)

Declaration
void SendNotification(Notification notification, int portalId, IList<RoleInfo> roles, IList<UserInfo> users)
Parameters
Type Name Description
Notification notification
int portalId
IList<RoleInfo> roles
IList<UserInfo> users

SetNotificationTypeActions(IList<NotificationTypeAction>, int)

Declaration
void SetNotificationTypeActions(IList<NotificationTypeAction> actions, int notificationTypeId)
Parameters
Type Name Description
IList<NotificationTypeAction> actions
int notificationTypeId

Extension Methods