MyChannels.Nirvana.PurgeEventArgs Class Reference

An event that is raised when a message (event) has been purged. More...

Inheritance diagram for MyChannels.Nirvana.PurgeEventArgs:
MyChannels.Nirvana.MessageEventArgs

Public Member Functions

 PurgeEventArgs (long startId, long endId, string filter)
 Instantiate a new PurgeEventArgs object More...
 

Properties

long EndId [get]
 The ending range of the purge event More...
 
string Filter [get]
 A filter (if supplied) More...
 
override IMessage Message [get]
 Not supported More...
 
long StartId [get]
 The starting range of the purge event More...
 
override MessageEventArgsType Type [get]
 Will always return MessageEventArgsType.Purge for MessagePurgedEventArgs More...
 
- Properties inherited from MyChannels.Nirvana.MessageEventArgs
abstract IMessage Message [get]
 The message More...
 
abstract MessageEventArgsType Type [get]
 The type of event More...
 

Detailed Description

An event that is raised when a message (event) has been purged.

Constructor & Destructor Documentation

MyChannels.Nirvana.PurgeEventArgs.PurgeEventArgs ( long  startId,
long  endId,
string  filter 
)

Instantiate a new PurgeEventArgs object

Parameters
startIda long specifying the start event id of the range of events purged from the channel.
endIda long specifying the end event id of the range of events purged from the channel.
filterA filter used to purge only the events which match this criteria.

Property Documentation

long MyChannels.Nirvana.PurgeEventArgs.EndId
get

The ending range of the purge event

string MyChannels.Nirvana.PurgeEventArgs.Filter
get

A filter (if supplied)

override IMessage MyChannels.Nirvana.PurgeEventArgs.Message
get

Not supported

long MyChannels.Nirvana.PurgeEventArgs.StartId
get

The starting range of the purge event

override MessageEventArgsType MyChannels.Nirvana.PurgeEventArgs.Type
get

Will always return MessageEventArgsType.Purge for MessagePurgedEventArgs