BbmConference

Since: BlackBerry 10.0.0

#include <bb/pim/calendar/BbmConference>

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

The BbmConference class provides data for BBM conference calls.

This class contains information for a BBM conference call that's associated with an event. This information includes phone labels (such as "US toll-free" and "Canada toll- free"), phone numbers, and participant data.


Overview

Public Functions Index

BbmConference ()
BbmConference (const BbmConference &other)
~BbmConference ()
voidaddPhoneLabel (const QString &phoneLabel)
voidaddPhoneNumber (const QString &phoneNumber)
BbmConferenceBridgeDatabridgeData () const
BbmConferenceEventDataeventData () const
boolisValid () const
BbmConference &operator= (const BbmConference &other)
QStringListphoneLabels () const
QStringListphoneNumbers () const
BbmConferencePreferredDatapreferredData () const
voidresetPhoneLabels ()
voidresetPhoneNumbers ()
voidsetBridgeData (const BbmConferenceBridgeData &bridgeData)
voidsetEventData (const BbmConferenceEventData &eventData)
voidsetPhoneLabels (const QStringList &phoneLabels)
voidsetPhoneNumbers (const QStringList &phoneNumbers)
voidsetPreferredData (const BbmConferencePreferredData &preferredData)
voidsetUserData (const BbmConferenceUserData &userData)
BbmConferenceUserDatauserData () const

Public Functions

BbmConference ()

Constructs a new BbmConference.

Since:

BlackBerry 10.0.0

BbmConference (

Copy constructor.

This function constructs a BbmConference containing exactly the same values as the provided BbmConference.

Parameters
other

The BbmConference to be copied.

Since:

BlackBerry 10.0.0

~BbmConference ()

Destructor.

Since:

BlackBerry 10.0.0

void addPhoneLabel (

Adds a new phone label to this BbmConference.

This function appends a phone label to the list of existing phone labels for this BbmConference.

Parameters
phoneLabel

The phone label to add.

Since:

BlackBerry 10.0.0

void addPhoneNumber (

Adds a phone number to this BbmConference.

This function appends a new phone number to the list of phone number for this BbmConference object.

Parameters
phoneNumber

The phone number to add.

Since:

BlackBerry 10.0.0

BbmConferenceBridgeData bridgeData ()

Retrieves the conference bridge for this BbmConference.

A conference bridge contains information about available phone numbers, mapped per country, moderator access code and participants access code.

The phone number and country mapping is achieved through QMap<QString, QVariant>

Return:

The conference bridge for this BbmConference.

Since:

BlackBerry 10.2.0

BbmConferenceEventData eventData ()

Retrieves the event conference data for this BbmConference.

This function returns the call parameters that were parsed from the details field in the event. These parameters include information such as moderator code and participant code.

Return:

The event conference data for this BbmConference.

Since:

BlackBerry 10.2.0

bool isValid ()

Indicates whether this BbmConference is valid.

This function determines whether the attributes of this BbmConference object have acceptable values.

Return:

true if this BbmConference is valid, false otherwise.

Since:

BlackBerry 10.0.0

BbmConference & operator= (

Assignment operator.

This operator copies all values from the provided BbmConference into this BbmConference.

Parameters
other

The BbmConference from which to copy all values.

Return:

A reference to this BbmConference.

Since:

BlackBerry 10.0.0

QStringList phoneLabels ()

Retrieves the list of phone labels for this BbmConference.

A phone label is used to indicate the type of a phone number. You can use the following phone labels:
  • 0: US toll-free

  • 1: Canada toll-free

  • 2: other toll-free

  • 3: internal number

  • 4: local number

  • 5: direct number

  • 6: other

  • 7: UK toll-free

The values for phone labels are aligned with the elements that are returned from the phoneNumbers() function. The first value from phoneLabels() is the type for the first phone number from phoneNumbers(), the second value is the second phone number's type, and so on.

Return:

The list of phone labels for this BbmConference.

Since:

BlackBerry 10.0.0

QStringList phoneNumbers ()

Retrieves the list of phone numbers for this BbmConference.

This function returns the list of available phone numbers for this BbmConference object.

Return:

The list of phone numbers for this BbmConference.

Since:

BlackBerry 10.0.0

BbmConferencePreferredData preferredData ()

Retrieves the preferred conference data for this BbmConference.

This function returns the call parameters that were parsed from the details field in the event. These parameters include information such as access code and participant code.

Return:

The preferred conference data for this BbmConference.

Since:

BlackBerry 10.0.0

void resetPhoneLabels ()

Clears the phone labels for this BbmConference.

This function removes all phone labels from this BbmConference object.

Since:

BlackBerry 10.0.0

void resetPhoneNumbers ()

Clears the phone numbers for this BbmConference.

This function removes all phone numbers from this BbmConference object.

Since:

BlackBerry 10.0.0

void setBridgeData (
  • const BbmConferenceBridgeData &bridgeData)

Sets the conference bridge for this BbmConference.

Parameters
bridge

The new user conference bridge.

Since:

BlackBerry 10.2.0

void setEventData (
  • const BbmConferenceEventData &eventData)

Sets the event conference data for this BbmConference.

Parameters
preferredData

The new event conference data.

Since:

BlackBerry 10.2.0

void setPhoneLabels (

Sets the list of phone labels for this BbmConference.

This function clears the list of phone labels for this BbmConference object and then populates it with phone labels from the provided list.

Parameters
phoneLabels

The new list of phone labels.

Since:

BlackBerry 10.0.0

void setPhoneNumbers (

Sets the list of phone numbers for this BbmConference.

This function clears the list of phone numbers for this BbmConference object and then populates it with phone numbers from the provided list.

Parameters
phoneNumbers

The new list of phone numbers.

Since:

BlackBerry 10.0.0

void setPreferredData (

Sets the preferred conference data for this BbmConference.

Parameters
preferredData

The new preferred conference data.

Since:

BlackBerry 10.0.0

void setUserData (

Sets the conference user data for this BbmConference.

Parameters
userData

The new user conference data.

Since:

BlackBerry 10.0.0

BbmConferenceUserData userData ()

Retrieves the conference user data for this BbmConference.

This function returns the call parameters that were selected by the user. These parameters include information such as access code and moderator flag.

Return:

The conference user data for this BbmConference.

Since:

BlackBerry 10.0.0

Last modified: 2014-03-13

comments powered by Disqus