November Happy Hour will be moved to Thursday December 5th.

AI OnAI Off

Class UserNotificationMessage

NOTE: This is a pre-release API that is UNSTABLE and might not satisfy the compatibility requirements as denoted by its associated normal version. Represents a one-to-one message.

Inheritance
System.Object
UserNotificationMessage
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.Notification
Assembly: EPiServer.dll
Version: 9.12.2
Syntax
public class UserNotificationMessage

Constructors

UserNotificationMessage()

Declaration
public UserNotificationMessage()

Properties

Category

Declaration
public Uri Category { get; set; }
Property Value
Type Description
System.Uri

ChannelName

The name of the channel.

Declaration
public string ChannelName { get; set; }
Property Value
Type Description
System.String
Remarks

It is the ChannelName in combination with user settings that controls which INotificationFormatter and INotificationProvider that will be used to format and send the message.

Content

The content of the message

Declaration
public string Content { get; set; }
Property Value
Type Description
System.String

Id

The id of the message

Declaration
public int Id { get; set; }
Property Value
Type Description
System.Int32

Optional property that can be used for the FormatUserMessage-method in IUserNotificationFormatter to return custom information in the form of a uri.

Declaration
public Uri Link { get; set; }
Property Value
Type Description
System.Uri

If used, this property should be set in the IUserNotificationFormatter It is not saved with the message.

Posted

The time when the message was posted.

Declaration
public DateTime Posted { get; set; }
Property Value
Type Description
System.DateTime

Read

The time when the message was read or null if it hasn't been read yet.

Declaration
public DateTime? Read { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

Recipient

The receivers for the message

Declaration
public INotificationUser Recipient { get; set; }
Property Value
Type Description
INotificationUser

SendAt

The time after which the message will be sent or null for next scheduling.

Declaration
public DateTime? SendAt { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

Sender

The sender of the message

Declaration
public INotificationUser Sender { get; set; }
Property Value
Type Description
INotificationUser

Sent

The time when the message was sent or null if it hasn't been send yet.

Declaration
public DateTime? Sent { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

Subject

The message subject

Declaration
public string Subject { get; set; }
Property Value
Type Description
System.String

TypeName

The type of the message.

Declaration
public string TypeName { get; set; }
Property Value
Type Description
System.String

Extension Methods