CallHistoryService

Since: BlackBerry 10.3.0

#include <bb/pim/phone/CallHistoryService>

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

CallHistoryService provides a way to inspect into the history of recently made calls.

CallHistoryService provides a way to fetch CallEntry objects. These objects represent a history of calls that have been made. These objects are also known as call logs.


Overview

Public Functions Index

CallHistoryService ()
~CallHistoryService ()
QList< CallEntryResult >callHistory (bb::pim::account::AccountKey accountId, const CallHistoryFilter &filter, const CallHistoryParam &extra=CallHistoryParam(), CallHistoryError::Type *presult=NULL) const
CallEntryResultcallHistory (bb::pim::account::AccountKey accountId, CallEntryId id, const CallHistoryParam &extra=CallHistoryParam(), CallHistoryError::Type *presult=NULL) const

Static Public Functions Index

Signals Index

voidcallHistoryAdded (bb::pim::account::AccountKey accountId, bb::pim::phone::CallEntryIdList idList)
voidcallHistoryDeleted (bb::pim::account::AccountKey accountId, bb::pim::phone::CallEntryIdList idList)

Public Functions

CallHistoryService ()

Construct a new CallHistoryService.

Since:

BlackBerry 10.3.0

~CallHistoryService ()

Destructor.

Since:

BlackBerry 10.3.0

QList< CallEntryResult > callHistory (

Fetch a list of made calls.

Retrieve a list of calls based on the criteria set out by filter.

Parameters
accountId

The ID of the account that is responsible for logging this call.

filter

A CallHistoryFilter that represents the criteria of calls to be fetched If you want all of the calls, pass in a default constructed CallHistoryFilter.

extra

A CallHistoryParam that represents extra parameters that do not pertain to filtering.

presult
An optional parameter to store the result of the operation. The values for the result are defined in CallHistoryError. Supply NULL if you don't care about the error value. Possible values:
Return:

A list of CallEntryResult under the provided filter

Since:

BlackBerry 10.3.0

CallEntryResult callHistory (

Fetch a particular CallEntry by ID.

This version is equivalent to calling CallHistoryService::callHistory that accepts a CallHistoryFilter, where the CallHistoryFilter contains a ID filter of the targeted ID.

Parameters
accountId

The ID of the account that is responsible for logging this call.

extra

A CallHistoryParam that represents extra parameters that do not pertain to filtering.

presult
An optional parameter to store the result of the operation. The values for the result are defined in CallHistoryError. Supply NULL if you don't care about the error value. Possible values:
Return:

A CallEntryResult with CallEntryId id. If the ID is invalid, the returned CallEntryResult will contain an invalid CallEntry

Since:

BlackBerry 10.3.0

Static Public Functions

bb::pim::account::Account defaultAccount ()

Retrieves the default call log account.

Return:

An account object that represents the default Call History account

Since:

BlackBerry 10.3.0

Signals

void callHistoryAdded (

Emitted when new calls are logged.

Parameters
accountId

The ID of the account where the call is being logged.

idList

The list of IDs corresponding to the new calls.

Since:

BlackBerry 10.3.0

void callHistoryDeleted (

Emitted when call logs are deleted.

Parameters
accountId

The ID of the account where the call log is being deleted.

idList

The list of IDs corresponding to the deleted call logs.

Since:

BlackBerry 10.3.0

Last modified: 2014-09-30



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus