Call

Since: BlackBerry 10.0.0

#include <bb/system/phone/Call>

To link against this class, add the following line to your .pro file: LIBS += -lbbsystem

Provides a call's ID, state, and type information.

When an outgoing call is initiated through a Phone object, an instance of this class will be returned to represent the initiated call. If the isValid() function of the object returns true, the client of this object can start to access other properties of the object.

An instance of the Call class will also be provided through the Phone::callUpdated() signal to provide information about an incoming call or update the state of an existing call.

Permissions:

You must also specify the access_phone permission in your bar-descriptor.xml file.


Overview

Public Functions Index

Call ()
Call (const Call &other)
~Call ()
intcallId () const
CallState::TypecallState () const
CallType::TypecallType () const
boolisValid () const
Call &operator= (const Call &other)
booloperator== (const Call &other)

Public Functions

Call ()

Constructs an invalid Call object.

Since:

BlackBerry 10.0.0

Call (

Creates a copy of other.

Parameters
other

The source Call object.

Since:

BlackBerry 10.0.0

~Call ()

Destructor.

Since:

BlackBerry 10.0.0

int callId ()

Returns the unique ID of the call.

Return:

A non-negative ID of the call if the Call object is valid, or -1 if the object is invalid.

Since:

BlackBerry 10.0.0

CallState::Type callState ()

Returns the state of the call, as defined by CallState::Type.

Return:

The state of the call. If the Call object is invalid, the return value is undefined.

Since:

BlackBerry 10.0.0

CallType::Type callType ()

Returns the type of the call, as defined by CallType::Type.

Return:

The type of the call. If the Call object is invalid, the return value is undefined.

Since:

BlackBerry 10.0.0

bool isValid ()

Indicates whether this object is valid or not.

In general, the properties of this object should be accessed only when the object is valid.

Return:

true if this Call object contains valid information about a call, false otherwise.

Since:

BlackBerry 10.0.0

Call & operator= (

Copies another Call to this object.

Parameters
other

The source Call object.

Return:

The Call instance.

Since:

BlackBerry 10.0.0

bool operator== (

Compares another Call to this object.

Parameters
other

A Call object for comparison.

Return:

true if call id matches, false otherwise.

Since:

BlackBerry 10.0.0

Last modified: 2014-03-13

comments powered by Disqus