Class: TTelephoneHoldFeatureControl

Declaration: TelephonyClasses.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TTelephoneLineFeatureControl

Inherited By:

None.

Purpose:

The standard feature control derived class for the hold feature.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Can be derived to modify behavior for a specific telephony environment. The interface protocol itself should not be modified.

Concurrency:

Multithread safe. Not intended to be shared across address spaces.

Resource Use:

This class depends on the existence of the telephone line handle that created it. Attempting to access one of these objects after the demise of its parent line handle might result in an exception being thrown.

Member Function: TTelephoneHoldFeatureControl::~TTelephoneHoldFeatureControl

virtual ~ TTelephoneHoldFeatureControl ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe. Not intended to be shared across address spaces.

Other Considerations:

Attempting to access one of these objects after the demise of its parent line handle might result in an exception being thrown.

Member Function: TTelephoneHoldFeatureControl::GetFeatureType

virtual void GetFeatureType (TTypeDescription &) const

Interface Category:

API.

Purpose:

Returns the standard hold feature type.

Calling Context:

Call directly to identify the type of feature for which this control is intended.

Parameters:

TTypeDescription & -Receives the type description for this feature control.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe. Not intended to be shared across address spaces.

Other Considerations:

Pure virtual member function.

Member Function: TTelephoneHoldFeatureControl::PutOnHold

virtual void PutOnHold ()

Interface Category:

API.

Purpose:

Puts the current active call on hold. The default implementation calls Activate.

Calling Context:

Call directly to access the hold feature.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe. Not intended to be shared across address spaces.

Other Considerations:

None.

Member Function: TTelephoneHoldFeatureControl::Reconnect

virtual void Reconnect (const TTelephoneCallHandle &)

Interface Category:

API.

Purpose:

Retrieves the specified held call. The default implementation calls Deactivate.

Calling Context:

Call directly to access the hold feature.

Parameters:

const TTelephoneCallHandle & -Specifies the call to retrieve.

Return Value:

None.

Exceptions:

Throws TTelephonyException if the specified call is not on hold.

Concurrency:

Multithread safe. Not intended to be shared across address spaces.

Other Considerations:

None.

Member Function: TTelephoneHoldFeatureControl::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Generates a hash value.

Calling Context:

Called by the Collection classes to generate a hash value.

Parameters:

Takes no parameters.

Return Value:

The numeric value of the hash.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe. Not intended to be shared across address spaces.

Other Considerations:

None.

Member Function: TTelephoneHoldFeatureControl::operator<<=

virtual TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called by a line handle to stream in feature controls from a line.

Parameters:

TStream & fromWhere -The stream the object streams itself in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws TInvalidVersionError if the versions don't match.

Concurrency:

Multithread safe. Not intended to be shared across address spaces.

Other Considerations:

None.

Member Function: TTelephoneHoldFeatureControl::operator>>=

virtual TStream & operator >>=(TStream & toWhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called by a line to stream out feature controls to a line handle.

Parameters:

TStream & toWhere -The stream the object streams itself out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe. Not intended to be shared across address spaces.

Other Considerations:

None.

Member Function: TTelephoneHoldFeatureControl::TTelephoneHoldFeatureControl

TTelephoneHoldFeatureControl (const TTelephoneHoldFeature &)
TTelephoneHoldFeatureControl (const TTelephoneHoldFeatureControl &)
TTelephoneHoldFeatureControl ()

Interface Category:

API.

Purpose:

Constructs a control for the specified feature instance. Its use is restricted to hold feature derived classes.
Copy constructor. Its use is restricted to friends and derived classes.
Default constructor. Its use is restricted to friends and derived classes.

Calling Context:

Called by hold feature derived classes to construct an object.
Only for internal use by Copy. Developers should treat as protected.
Only for internal use by Resurrect. Developers should treat as protected.

Parameters:

const TTelephoneHoldFeature & -The feature instance for which this class is a control.
const TTelephoneHoldFeatureControl & -The TTelephoneHoldFeatureControl to be copied.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe. Not intended to be shared across address spaces.

Other Considerations:

None.

Member Function: TTelephoneHoldFeatureControl::operator=

TTelephoneHoldFeatureControl & operator =(const TTelephoneHoldFeatureControl &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object. Its use is restricted to friends and derived classes.

Parameters:

const TTelephoneHoldFeatureControl & -The source object for the assignment.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe. Not intended to be shared across address spaces.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.