Class: TTelephoneDigitsNotification

Declaration: TelephoneNotification.h

Taxonomy Categories:

Member Functions:

TTelephoneDigitsNotification
~TTelephoneDigitsNotification
operator=
GetDigits
Hash
operator<<=
operator>>=

Interface Category:

API.

Inherits From:

TNotification

Inherited By:

None.

Purpose:

A derived class of TNotification that permits telephone line and handset derived classes to transport digit strings generated by the remote connection (usually by means of DTMF key presses).

Instantiation:

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

Deriving Classes:

Do not derive classes from TTelephoneDigitsNotification.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TTelephoneDigitsNotification::TTelephoneDigitsNotification

TTelephoneDigitsNotification (const TTelephoneDigitsNotification &)
TTelephoneDigitsNotification ()

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 TTelephoneDigitsNotification & -The TTelephoneDigitsNotification 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: TTelephoneDigitsNotification::~TTelephoneDigitsNotification

virtual ~ TTelephoneDigitsNotification ()

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: TTelephoneDigitsNotification::operator=

TTelephoneDigitsNotification & operator =(const TTelephoneDigitsNotification &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TTelephoneDigitsNotification & -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: TTelephoneDigitsNotification::GetDigits

void GetDigits (TText & telephoneDigits) const

Interface Category:

API.

Purpose:

Provides the remotely generated digit string.

Calling Context:

Call directly by notification clients who want to examine the digits being generated by the remote connection. This class is intended for voice mail and interactive voice response applications that provide command and control by means of DTMF keys.

Parameters:

TText & telephoneDigits -Receives the digit string.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through. If the number is unknown, the TText parameter is left blank.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTelephoneDigitsNotification::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Generates a hash value.

Calling Context:

Call directly 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: TTelephoneDigitsNotification::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: TTelephoneDigitsNotification::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.