BBjAPI::getEventData

Description

In BBj 17.00 and higher, this method returns a BBjEventData object when used exclusively inside an administrative event handler program. The administration server (part of BBjServices) calls this special type of event handler program when the administrator configures an event handler using the Enterprise Manager or Admin API. Outside an event handler program, this method returns null.

Note:

The code in the event handler program runs on the server, in a background process and does not have access to any UI components or console.

See Event Handlers in the Enterprise Manager for more information about configuring event handlers.

Syntax

Return Value

Method

BBjEventData

getEventData()

Parameters

None.

Return Value

An instance of the BBjEventData object containing information regarding the event that triggered the calling of the handler program.

Remarks

None.

Example

REM Get the BBjEventData object
eventData! = BBjAPI().getEventData()
REM Get the information about the event that occurred
id$ = eventData!.getEventId()
type$ = eventData!.getEventType()
name$ = eventData!.getEventName()
detail$ = eventData!.getEventDetail()

See Also

BBjAPI

Event Handlers

BBjAdminEventHandler

See the BBj Object Diagram for an illustration of the relationship between BBj Objects.