EventAlertPoller Class [AX 2012]

The EventAlertPoller class polls for new alerts and notifies the user about them by displaying a pop-up window.

class EventAlertPoller

Run On

Called

  MethodDescription
Gg758308.pubmethod(en-us,AX.60).gif cancelTimeOut Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
Gg758308.protmethod(en-us,AX.60).gif detectAttentionGrabberClosure Detects the closure of the attention grabber displayed on the screen.
Gg758308.protmethod(en-us,AX.60).gif detectAttentionGrabberClosureTimeOut Initiates a new polling cycle, such as when the user is pausing over the grabber with the mouser pointer too long. When an attention grabber is displayed on the screen, a timeout to this method is initiated.
Gg758308.protmethod(en-us,AX.60).gif detectClientFocus Detects whether the Microsoft Dynamics AX client window has the input focus when the attention grabber pops up.
Gg758308.pubmethod(en-us,AX.60).gif equal Determines whether the specified object is equal to the current one. (Inherited from Object.)
Gg758308.pubmethod(en-us,AX.60).gif exitProtocol Called to indicate that a polling cycle is finished.
Gg758308.pubmethod(en-us,AX.60).gif forcedPollEntryProtocol Called to indicate that a polling cycle that is forced by an object (EventAlertInbox form) is to be started. The method delays the polling from executing until a regular polling cycle, initiated by the scheduler, is running.
Gg758308.pubmethod(en-us,AX.60).gif getAttentionGrabberParms
Gg758308.pubmethod(en-us,AX.60).gif getTimeOutTimerHandle Returns the timer handle for the object. (Inherited from Object.)
Gg758308.pubmethod(en-us,AX.60).gif handle Retrieves the handle of the class of the object. (Inherited from Object.)
Gg758308.protmethod(en-us,AX.60).gif isOneMultiAlertAttentionGrabberInQueue
Gg758308.protmethod(en-us,AX.60).gif new Initializes a new instance of the EventAlertPoller class.
Gg758308.pubmethod(en-us,AX.60).gif notify Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
Gg758308.pubmethod(en-us,AX.60).gif notifyAll Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
Gg758308.pubmethod(en-us,AX.60).gif objectOnServer Determines whether the object is on a server. (Inherited from Object.)
Gg758308.pubmethod(en-us,AX.60).gif owner Returns the instance that owns the object. (Inherited from Object.)
Gg758308.pubmethod(en-us,AX.60).gif parmPollInterval Gets or sets the PollInterval parameter.
Gg758308.pubmethod(en-us,AX.60).gif parmPopUpLinkDestinationId Gets or sets the PopUpLinkDestinationId parameter.
Gg758308.pubmethod(en-us,AX.60).gif parmPopUpShowDefineMode Gets or sets the PopUpShowDefineMode parameter.
Gg758308.pubmethod(en-us,AX.60).gif parmShowWorkflowAlerts Gets or sets the ShowWorkflowAlerts parameter.
Gg758308.protmethod(en-us,AX.60).gif poll Executes a polling cycle. If the execution has been initiated by Infolog's time-out logic (the scheduler), the method also schedules the next polling cycle, by adding a further time-out on itself.
Gg758308.pubmethod(en-us,AX.60).gif scheduledPollEntryProtocol Called to indicate that a polling cycle that is initiated by the scheduler is to be started. The method delays the polling from executing until a forced polling cycle that is started by an object, such as the EventAlertInbox form, is running.
Gg758308.pubmethod(en-us,AX.60).gif schedulePoll Schedules a polling cycle using Infolog's time-out logic.
Gg758308.pubmethod(en-us,AX.60).gif setPollingInterval Sets the polling interval.
Gg758308.pubmethod(en-us,AX.60).gif setTimeOut Sets up the scheduled execution of a specified method. (Inherited from Object.)
Gg758308.protmethod(en-us,AX.60).gif showNextAttentionGrabber Pops up the next attention grabber from the queue.
Gg758308.protmethod(en-us,AX.60).gif showQueuedAttentionGrabbers Pops up attention grabbers from the queue.
Gg758308.pubmethod(en-us,AX.60).gif toString Returns a string that represents the current object. (Inherited from Object.)
Gg758308.pubmethod(en-us,AX.60).gif usageCount Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
Gg758308.pubmethod(en-us,AX.60).gif wait Pauses a process. (Inherited from Object.)
Gg758308.pubmethod(en-us,AX.60).gif xml Returns an XML string that represents the current object. (Inherited from Object.)
Gg758308.pubmethod(en-us,AX.60).gif Gg758308.static(en-us,AX.60).gif ::construct Initializes a new instance of the EventAlertPoller class.
Gg758308.pubmethod(en-us,AX.60).gif Gg758308.static(en-us,AX.60).gif ::getCompanyName
Gg758308.pubmethod(en-us,AX.60).gif Gg758308.static(en-us,AX.60).gif ::isSingleCompany
Gg758308.pubmethod(en-us,AX.60).gif Gg758308.static(en-us,AX.60).gif ::newAlertPoller Creates a new alert poller.
Top

Upon startup of the Microsoft Dynamics AX client, an instance of the class is created and then put in the global cache of the client. By using the time-out mechanism of the Infolog, the instance makes sure that the EventAlertInbox table is polled regularly for new alerts.

static void example() 
{ 
    EventAlertPoller poller = EventAlertPoller::newAlertPoller(false); 
    infolog.globalCache().set(classstr(EventAlertPoller), 
        literalstr(ReferenceId), 
        poller); 
}

Object Class
  EventAlertPoller Class

Community Additions

ADD
Show: