Table of Contents

Class Notification

Namespace
Oqtane.Models
Assembly
Oqtane.Shared.dll

Notification for a User - usually meant to be sent as an E-Mail.

public class Notification : IDeletable
Inheritance
Notification
Implements

Constructors

Notification()

public Notification()

Notification(int, User, User, string, string)

public Notification(int siteId, User from, User to, string subject, string body)

Parameters

siteId int
from User
to User
subject string
body string

Notification(int, User, User, string, string, int?)

public Notification(int siteId, User from, User to, string subject, string body, int? parentId)

Parameters

siteId int
from User
to User
subject string
body string
parentId int?

Notification(int, User, string, string)

public Notification(int siteId, User to, string subject, string body)

Parameters

siteId int
to User
subject string
body string

Notification(int, User, string, string, DateTime)

public Notification(int siteId, User to, string subject, string body, DateTime sendOn)

Parameters

siteId int
to User
subject string
body string
sendOn DateTime

Notification(int, string, string, string, string)

public Notification(int siteId, string toDisplayName, string toEmail, string subject, string body)

Parameters

siteId int
toDisplayName string
toEmail string
subject string
body string

Notification(int, string, string, string, string, DateTime)

public Notification(int siteId, string toDisplayName, string toEmail, string subject, string body, DateTime sendOn)

Parameters

siteId int
toDisplayName string
toEmail string
subject string
body string
sendOn DateTime

Notification(int, string, string, string, string, string, string)

public Notification(int siteId, string fromDisplayName, string fromEmail, string toDisplayName, string toEmail, string subject, string body)

Parameters

siteId int
fromDisplayName string
fromEmail string
toDisplayName string
toEmail string
subject string
body string

Properties

Body

Body / Contents of this Notification

public string Body { get; set; }

Property Value

string

CreatedOn

When the notification was created.

public DateTime CreatedOn { get; set; }

Property Value

DateTime

DeletedBy

User who deleted this object.

public string DeletedBy { get; set; }

Property Value

string

DeletedOn

Timestamp when it was deleted.

public DateTime? DeletedOn { get; set; }

Property Value

DateTime?

DeliveredOn

When the Notification was sent/delivered.

public DateTime? DeliveredOn { get; set; }

Property Value

DateTime?

FromDisplayName

Nice Name of the Creator

public string FromDisplayName { get; set; }

Property Value

string

FromEmail

Creator E-Mail

public string FromEmail { get; set; }

Property Value

string

FromUserId

Creator User ID

public int? FromUserId { get; set; }

Property Value

int?

IsDeleted

If something is deleted, this will be true.

public bool IsDeleted { get; set; }

Property Value

bool

IsDelivered

If it has been delivered. See also DeliveredOn.

public bool IsDelivered { get; set; }

Property Value

bool

IsRead

If it has been read. See also IsDelivered

public bool IsRead { get; set; }

Property Value

bool

NotificationId

Internal ID

public int NotificationId { get; set; }

Property Value

int

ParentId

Reference to an optional Parent Notification - in case it's a kind of thread with reply-messages.

public int? ParentId { get; set; }

Property Value

int?

SendOn

When the Notification should be sent. See also DeliveredOn

public DateTime? SendOn { get; set; }

Property Value

DateTime?

SiteId

Reference to the Site on which the Notification was created.

public int SiteId { get; set; }

Property Value

int

Subject

Message Subject.

public string Subject { get; set; }

Property Value

string

ToDisplayName

Recipient Nice-Name.

public string ToDisplayName { get; set; }

Property Value

string

ToEmail

Recipient Mail

public string ToEmail { get; set; }

Property Value

string

ToUserId

Recipient User ID - nullable, as Recipient could be someone that's not a user.

public int? ToUserId { get; set; }

Property Value

int?