Class: TTelephoneStatusNotification

Declaration: TelephoneNotification.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TNotification

Inherited By:

None.

Purpose:

TTelephoneStatusNotification is a derived class of TNotification that permits telephone line and handset derived classes to transport information associated with telephony events. This information is provided in the form of a TToken representing a change in hook status, call status, or feature status.

Instantiation:

Allocate on the heap or the stack. Allocated on the heap by telephony classes.

Deriving Classes:

Derive from TTelephoneStatusNotification only if you wish to send additional data along with the notification. To extend the existing set of line, call or feature states, developers may define their own additional TToken constants.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TTelephoneStatusNotification::TTelephoneStatusNotification

TTelephoneStatusNotification (const TTelephoneStatusNotification &)
TTelephoneStatusNotification ()

Interface Category:

API.

Purpose:

Copy constructor.
Default constructor.

Calling Context:

Called to copy an object. Called by The Notification Framework only. Not to be called by clients.
Called for streaming and assignment. Called by The Notification Framework only. Not to be called by clients.

Parameters:

const TTelephoneStatusNotification & -The TTelephoneStatusNotification to be copied.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Clients should create instances of this class by calling the Create Notification functions provided by TTelephoneLine and TTelephoneHandset.

Member Function: TTelephoneStatusNotification::~TTelephoneStatusNotification

virtual ~ TTelephoneStatusNotification ()

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:

Not multithread safe.

Other Considerations:

None.

Member Function: TTelephoneStatusNotification::operator=

TTelephoneStatusNotification & operator =(const TTelephoneStatusNotification &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call directly when an object is assigned to another compatible object.

Parameters:

const TTelephoneStatusNotification & -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:

Not multithread safe.

Other Considerations:

None.

Member Function: TTelephoneStatusNotification::GetStatus

TToken GetStatus () const

Interface Category:

API.

Purpose:

Returns the telephone status value.

Calling Context:

Call directly to check the hook status of a telephone line, a telephone handset, or to monitor the progress of a call or telephone feature.

Parameters:

Takes no parameters.

Return Value:

Returns a TToken containing the telephone status value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTelephoneStatusNotification::GetClassification

long GetClassification () const

Interface Category:

API.

Purpose:

Returns the notification classification.

Calling Context:

Call directly to find out the general classification of a notification without examining the specific status value.

Parameters:

Takes no parameters.

Return Value:

Returns one of the values of ETelephoneStatusClassification.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTelephoneStatusNotification::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:

Not multithread safe.

Other Considerations:

None.

Member Function: TTelephoneStatusNotification::operator<<=

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

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Call directly to stream in data.

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:

Not multithread safe.

Other Considerations:

None.

Member Function: TTelephoneStatusNotification::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Call directly to stream out data.

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:

Not multithread safe.

Other Considerations:

None.

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