Try our conversational search powered by Generative AI!

Class EventMessage

Holds information for an event message sent between sites.

Inheritance
System.Object
EventMessage
Inherited Members
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.Events
Assembly: EPiServer.Events.dll
Version: 11.20.7
Syntax
[EventsServiceKnownType]
public class EventMessage

Constructors

EventMessage()

Declaration
public EventMessage()

Properties

ApplicationName

Gets or sets the friendly name of the application (AppDomain) where the current message was sent from.

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

EventId

Gets or sets the unique id associated with this specific event.

Declaration
public Guid EventId { get; set; }
Property Value
Type Description
System.Guid

Parameter

Gets or sets a parameter object that should be passed with the event.

Declaration
public object Parameter { get; set; }
Property Value
Type Description
System.Object

RaiserId

Gets or sets the GUID that is unique per raising instance/site.

Declaration
public Guid RaiserId { get; set; }
Property Value
Type Description
System.Guid

Sent

Gets or sets the date and time when this message was sent from the remote server.

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

SequenceNumber

Gets or sets the sequence number of the current event message. This is used to track lost event messages.

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

ServerName

Gets or sets the name of the server where the current message was sent from.

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

SiteId

Gets or sets the id that sites share when they use the same database.

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

VerificationData

Signing of the event to make sure we can trust it

Declaration
public byte[] VerificationData { get; set; }
Property Value
Type Description
System.Byte[]

Methods

ToString()

Returns a System.String that represents this instance.

Declaration
public override string ToString()
Returns
Type Description
System.String

A System.String that represents this instance.

Overrides
System.Object.ToString()

ToString(String)

Returns a System.String that represents this instance.

Declaration
public virtual string ToString(string format)
Parameters
Type Name Description
System.String format

The format to use (use "V" to include the verification data).

Returns
Type Description
System.String

A System.String that represents this instance.

Extension Methods