LINEOFFERINGMODE (Compact 2013)
3/26/2014
These bit-flag constants for TAPI describe different substates of an offering call. A mode is available as call status to the application after the call state transitions to offering, and within the LINE_CALLSTATE message indicating the call is in LINECALLSTATE_OFFERING. These values are used when the call is on an address that is shared (bridged) with other stations, primarily electronic key systems.
The following table shows the LINEOFFERINGMODE constants.
Value |
Description |
|---|---|
LINEOFFERINGMODE_ACTIVE = 0x00000001 |
Indicates that the call is alerting at the current station and if any application is set up to automatically answer, it can do so. If the call state mode is ZERO, the application should assume that the value is active. This would be the situation on a non-bridged address. |
LINEOFFERINGMODE_INACTIVE = 0x00000002 |
Indicates that the call is being offered at more than one station, but the current station is not alerting. For example, it may be an attendant station where the offering status is advisory, such as blinking a light. Software at the station set for automatic answering should preferably not answer the call, because this should be the prerogative at the primary (alerting) station, but lineAnswer may be used to connect the call. |
Remarks
These constants cannot be extended. All 32 bits are reserved.
For backward compatibility, it is the responsibility of the service provider to examine the negotiated API version on the line, and to not use these LINEOFFERINGMODE_ values if they are not supported on the negotiated version. Applications that are not cognizant of LINEOFFERINGMODE_ will most likely assume that a call that is in LINECALLSTATE_OFFERING is in LINEOFFERINGMODE_ACTIVE.
The LINEOFFERINGMODE_ACTIVE and LINEOFFERINGMODE_INACTIVE values are used when the call is on an address that is shared with other stations, primarily electronic key system. For more information about shared addresses, see LINEADDRESSSHARING If the offering call state mode is "active," it means that the call is alerting at the current station, and if any application is set up to automatically answer, it can do so. If the call state mode is "inactive," the call is being offered at more than one station, but the current station is not alerting. For example, it may be an attendant station where the offering status is advisory, such as blinking a light. Software at the station set for automatic answering should preferably not answer the call, because this should be the prerogative at the primary (alerting) station, but lineAnswer can be used to connect the call. If the call state mode is ZERO, the application should assume that the value is active. This would be the situation on a non-bridged address.
These constants are for applications that have negotiated TAPI 1.4 or later.
Requirements
Header |
tapi.h |