Class: TTelephoneRingNotification

Declaration: TelephoneNotification.h

Taxonomy Categories:

Member Functions:

TTelephoneRingNotification
~TTelephoneRingNotification
operator=
GetIncomingNumber
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 the remote directory number (calling party ID) associated with an incoming call.

Instantiation:

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

Deriving Classes:

Do not derive classes from TTelephoneRingNotification.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TTelephoneRingNotification::TTelephoneRingNotification

TTelephoneRingNotification (const TTelephoneRingNotification &)
TTelephoneRingNotification ()

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

virtual ~ TTelephoneRingNotification ()

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

TTelephoneRingNotification & operator =(const TTelephoneRingNotification &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TTelephoneRingNotification & -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: TTelephoneRingNotification::GetIncomingNumber

void GetIncomingNumber (TText & phoneNumber) const

Interface Category:

API.

Purpose:

Provides the remote directory number (calling party ID) associated with an incoming call.

Calling Context:

Call directly to find out the directory number of the calling party.

Parameters:

TText & phoneNumber -Receives the remote directory number.

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: TTelephoneRingNotification::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: TTelephoneRingNotification::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: TTelephoneRingNotification::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.