PhoneCall object

ApplicationName

String

Name of the application placing the call. The application name is stored in the call log and displayed by some platforms/applications in user dialog boxes.

CallComment

String

Comment that is stored in the call log and displayed by some platforms in user dialog boxes.

CalledParty

String

Name of the party associated with the PhoneNumber property for outgoing calls.

CallerID

String

Caller ID associated with the PhoneNumber for incoming calls.

CallerIDName

String

Name of the party associated with the PhoneNumber property for incoming calls.

CallStatus

Unsigned long

The status of the current call.

ClassDefinition

PowerObject

An object of type PowerObject containing information about the class definition of the object or control.

LineCallParamFlags

Unsigned long

A value that specifies a set of boolean parameters used to set options when making a phone call using the MakeCall function and for data transmission.

LineMediaMode

Unsigned long

A value that specifies the media type of a phone call.

LineStatus

Unsigned long

The status of the current line.

NoAnswerTimeout

Integer

Time in seconds to wait in the PROCEEDING or RINGBACK state after completion of dialing and before abandoning the call with a “no answer” and “disconnected” line call state.

PhoneNumber

String

Phone number of incoming or outgoing calls.

PromptUser

Boolean

Specifies whether to prompt user for confirmation before a call is placed. Values are:

• true Prompt user

• false Do not prompt user (default)

RingTone

String

Specifies the name and location of a sound file to be used as the ring tone for incoming calls.

TransmitCallerID

Integer

Specifies whether to block transmission of caller ID information:

• 0 Use the system default setting (default)

• 1 Block transmission of caller ID

• 2 Send caller ID

VoiceCall

Boolean

Specifies whether the phone call is a voice call or a data call. Values are:

• true Voice call (default)

• false Data call

CallConnected

When the call, either inbound or outbound, is connected

CallDisconnected

When the call, either inbound or outbound, is disconnected

CallerID

When a caller ID associated with an incoming call has been detected

Constructor

When the object is created

Destructor

When the object is destroyed

IncomingCall

When notification of an incoming call, such as the ringing of the phone, is received

LineReply

Not currently implemented—reserved for future use

AcceptCall

Integer

Accepts a new incoming call.

AllowReceivingCalls

Integer

Allows reception of incoming calls. Typically called immediately after PhoneCall object is constructed. Takes a boolean argument: true = object events will be fired, false = no object events will be fired.

DropCall

Integer

Disconnects the current call.

MakeCall

Integer

Places a call using the properties of the PhoneCall object.

SetHold

Integer

Allows the user to place the call on hold or retrieve a call placed on hold.

SetMute

Integer

Allows the user to mute or unmute the line. Takes a boolean argument: true = mute the line, false = unmute the line. The return value indicates the previous state: 1 = muted, 2 = not muted.

SetRingTone

Integer

Sets the ring tone for the PhoneCall object. If you specify an empty string for the function’s only argument, the default ring tone for the device is used.