[This is preliminary documentation and is subject to change.]
Declaration Syntax| C# | Visual Basic | Visual C++ |
public class Event
Public Class Event
public ref class Event
Members| All Members | Constructors | Properties | |||
| Icon | Member | Description |
|---|---|---|
 | EventEventNew(IDataObjectInputStream, EventAction, IElementDef) | |
| EventEventNew(IDataObjectInputStream, String, IElementDef) | Constructs an Event object to encapsulate
an inbound SIF Event. This form of the constructor is called internally by the
ADK when it receives a SIF Event message and is not intended to be used by ADK developers.
|
| EventEventNew(array<SifDataObject>[](), EventAction) | Constructs an Event object to encapsulate
an outbound SIF Event, which describes
one or more SifDataObjects that have been added, changed,
or deleted by the local application. This form of the constructor is called
by agents when reporting a SIF_Event message to a zone
|
| EventEventNew(array<SifDataObject>[](), String) | Constructs an Event object to encapsulate
an outbound SIF Event, which describes
one or more SifDataObjects that have been added, changed,
or deleted by the local application. This form of the constructor is called
by agents when reporting a SIF_Event message to a zone
|
 | Action | Gets the action code identifying how all of the data objects in the
Event payload have changed
|
| ActionString | Gets the action string that was received from the SIF Agent that
generated this event data.
|
| Data | Gets the SIF Data Objects in the Event payload
|
| ObjectType | Identifies the type of SIF Data Object contained in the Event payload |
| Zone | Used by the Adk to track the zone from which this event originated.
Calling this method for Events created by an agent has no effect.
|
RemarksAn Event is a notification to subscribing agents that a data object has been added, changed, or deleted in the reporting application's database. In the Schools Interoperability Framework, any agent may report SIF_Event messages for any object, even if that agent is not the authoritative publisher of the object.
Reporting SIF Events
To report a SIF_Event to a zone, construct an Event instance and call the ReportEvent(Event) method. Supply an array of SifDataObject instances and an action code to the Event constructor. You may also call alternative forms of the reportEvent method that accept SIFDataObjects and an action code as parameters. Note Events cannot be reported to a Topic because the ADK cannot determine which of its zones should receive the event. If you're using Topics, you must report events to the specific Zone or Zones to which the data applies.
Subscribing to SIF Events
To subscribe to SIF_Events for a specific object type, register an ISubscriber instance with IZone or ITopic instances. Call the setSubscriber method repeatedly for each object type you wish to subscribe to. When the ADK connects to a zone, it sends SIF_Subscribe messages for each object type. When a SIF_Event message is received by the ADK, it is dispatched to your OnEvent(Event, IZone, IMessageInfo) method for processing. Refer to that method for more information. Inheritance Hierarchy| Object | |
 | Event |