cisco.uc.cuae.legacy
Interface TimerFacilityServer

All Superinterfaces:

CuaeCommon, CuaeCommonServer, TimerFacility

All Known Implementing Classes:

BaseTimerFacilityServer, RemoteTimerFacilityServer

public interface TimerFacilityServer
extends TimerFacility, CuaeCommonServer

A suite of actions and events that provide timers. Generated from CUAE provider package Metreos.Providers.TimerFacility

Nested Class Summary

Nested classes/interfaces inherited from interface cisco.uc.cuae.legacy.TimerFacility

TimerFacility.AddNonTriggerTimerOptions, TimerFacility.AddNonTriggerTimerResult, TimerFacility.AddTriggerTimerOptions, TimerFacility.AddTriggerTimerResult, TimerFacility.RemoveTimerOptions, TimerFacility.RemoveTimerResult, TimerFacility.TimerFireOptions

Nested classes/interfaces inherited from interface cisco.uc.cuae.legacy.CuaeCommon

CuaeCommon.CuaeResult

Method Summary

TimerFacility.AddNonTriggerTimerResult	addNonTriggerTimer(java.lang.String sessionId, java.lang.String timerDateTime, java.lang.String timerRecurrenceInterval, TimerFacility.AddNonTriggerTimerOptions options) AddNonTriggerTimer will set a timer which will attempt to route to the same script which initated the timer.
TimerFacility.AddTriggerTimerResult	addTriggerTimer(java.lang.String sessionId, java.lang.String timerDateTime, java.lang.String timerRecurrenceInterval, java.lang.String timerUserData, TimerFacility.AddTriggerTimerOptions options) AddTriggerTimer will set a timer which will attempt to trigger a new script when fired.
TimerFacility.RemoveTimerResult	removeTimer(java.lang.String sessionId, java.lang.String timerId, TimerFacility.RemoveTimerOptions options) RemoveTimer will cancel the specified timer.

Method Detail

addTriggerTimer

TimerFacility.AddTriggerTimerResult addTriggerTimer(java.lang.String sessionId,
                                                    java.lang.String timerDateTime,
                                                    java.lang.String timerRecurrenceInterval,
                                                    java.lang.String timerUserData,
                                                    TimerFacility.AddTriggerTimerOptions options)

AddTriggerTimer will set a timer which will attempt to trigger a new script when fired. The Timer Provider stores timers only in memory. If the provider is disabled, or if the Cisco Unified Application Server service is restarted, all outstanding timers will be lost. If the timer results in a no handler, then the Timer Provider will remove the timer automatically. AddTriggerTimer is used to cause another script to initiate after a set amount of time. You can cancel an outstanding timer with the RemoveTimer action. AddTriggerTimer and AddNonTriggerTimer offer the same feature from the perspective that both provide a means to set a timer. The difference is that one action creates a triggering timer, and the other creates a non-triggering timer. Because script instances are a licensable resource and should be managed closely, it may make more sense to end the application that set the timer, and so a triggering timer is required. Ultimately it is up to the developer of the script to determine which is the best fit.

Parameters:

sessionId - The session Id for this method call

timerDateTime - The initial time to fire the TimerFire event. This value must be in a .NET Framework System.DateTime parseable string or a .NET System.DateTime object. As an example of specifying the DateTime object, one can set a timer that will fire 5 seconds from the moment the AddTriggerTimer action is used by using the following C# snippet: System.DateTime.Now.AddSeconds(5).

timerRecurrenceInterval - If specified, this timer will reoccur indefinitely until the timer is removed via RemoveTimer. This action parameter sets the value of the period of the timer that will be applied to this timer after the first occurrence of the timer occurs. This value must be in a .NET System.TimeSpan parseable string. As an example of specifying a TimeSpan of 5 minutes, the following C# snippet could be used: System.TimeSpan.FromMinutes(5). If this parameter is not specified, then the timer will only be fired once.

timerUserData - An opaque token used to allow distinguishable timer events to be raised. The value specified here will be sent back in the TimerFire event as an event parameter. For the triggering timer, a best practice is to specifiy a well-known value for this field so that the administrator of the Cisco Unified Application Server can set this value as a trigger parameter on the other TimerFire script associated with the application.

options - An object holding all the optional parameters

addNonTriggerTimer

TimerFacility.AddNonTriggerTimerResult addNonTriggerTimer(java.lang.String sessionId,
                                                          java.lang.String timerDateTime,
                                                          java.lang.String timerRecurrenceInterval,
                                                          TimerFacility.AddNonTriggerTimerOptions options)

AddNonTriggerTimer will set a timer which will attempt to route to the same script which initated the timer. The Timer Provider stores timers only in memory. If the provider is disabled, or if the Cisco Unified Application Server service is restarted, all outstanding timers will be lost. If the timer results in a no handler, then the Timer Provider will remove the timer automatically. AddNonTriggerTimer is used to cause an event to fire within the same script which initiated the AddNonTriggerTimer action. You can cancel an outstanding timer with the RemoveTimer action. Note that due to the queuing mechanism of the Application Runtime Environment, a timer set with the AddNonTriggerTimer could have already fired and the timer event is still queued for processing, even though you have used the RemoveTimer action. While this scenario is extremely unlikely, it is still possible and the logic of your application should account for it (for instance, you could set a boolean global variable indicating that the timer has been removed when you use the RemoveTimer event, and check the value of that boolean variable in the TimerFire event. AddTriggerTimer and AddNonTriggerTimer offer the same feature from the perspective that both provide a means to set a timer. The difference is that one action creates a triggering timer, and the other creates a non-triggering timer. Because script instances are a licensable resource and should be managed closely, it may make more sense to end the application that set the timer, and so a triggering timer is required. Ultimately it is up to the developer of the script to determine which is the best fit.

Parameters:

sessionId - The session Id for this method call

timerDateTime - The initial time to fire the TimerFire event. This value must be in a .NET Framework System.DateTime parseable string or a .NET System.DateTime object. As an example of specifying the DateTime object, one can set a timer that will fire 5 seconds from the moment the AddTriggerTimer action is used by using the following C# snippet: System.DateTime.Now.AddSeconds(5).

timerRecurrenceInterval - If specified, this timer will reoccur indefinitely until the timer is removed via RemoveTimer. This action parameter sets the value of the period of the timer that will be applied to this timer after the first occurrence of the timer occurs. This value must be in a .NET System.TimeSpan parseable string. As an example of specifying a TimeSpan of 5 minutes, the following C# snippet could be used: System.TimeSpan.FromMinutes(5). If this parameter is not specified, then the timer will only be fired once.

options - An object holding all the optional parameters

removeTimer

TimerFacility.RemoveTimerResult removeTimer(java.lang.String sessionId,
                                            java.lang.String timerId,
                                            TimerFacility.RemoveTimerOptions options)

RemoveTimer will cancel the specified timer. If the timer results in a no handler, then the Timer Provider will remove the timer automatically. AddTriggerTimer and AddNonTriggerTimer return a timer ID, which can be used as the TimerId action parameter of this action. Due to the queuing mechanism of the Application Runtime Environment, a timer set with the AddNonTriggerTimer could have already fired and the timer event is still queued for processing, even though you have used the RemoveTimer action. While this scenario is extremely unlikely, it is still possible and the logic of your application should account for it (for instance, you could set a boolean global variable indicating that the timer has been removed when you use the RemoveTimer event, and check the value of that boolean variable in the TimerFire event.

Parameters:

sessionId - The session Id for this method call

timerId - The identifier to the timer to remove. This value originates from either the AddTriggerTimer or AddNonTriggerTimer action.

options - An object holding all the optional parameters