ContactFavouriteActionBuilder

Since: BlackBerry 10.0.0

#include <bb/pim/contacts/ContactFavouriteActionBuilder>

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

The ContactFavouriteActionBuilder class lets you create, and specify properties for, a new ContactFavouriteAction or edit an existing ContactFavouriteAction.

You can use this class to set properties, such as action name and attribute association, for a ContactFavouriteAction. This class uses the builder pattern to create a ContactFavouriteAction and set its properties. Each of the set*() functions returns a self reference to the builder, allowing you to chain function calls together. For example, here's how to create a ContactFavouriteAction with a name and attribute association using the builder pattern:

 ContactFavouriteAction action = ContactFavouriteActionBuilder()
                                   .setActionName("email")
                                   .setAttributeAssociation(123456);


Overview

Public Functions Index

Public Functions

ContactFavouriteActionBuilder ()

Constructs a new ContactFavouriteActionBuilder.

Since:

BlackBerry 10.0.0

ContactFavouriteActionBuilder (

Copy constructor.

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

Parameters
copy

The ContactFavouriteAction to be copied.

Since:

BlackBerry 10.0.0

~ContactFavouriteActionBuilder ()

Destructor.

Since:

BlackBerry 10.0.0

operator ContactFavouriteAction ()

Cast operator.

This operator casts an object to the ContactFavouriteAction type.

Since:

BlackBerry 10.0.0

ContactFavouriteActionBuilder & operator= (

Assignment operator.

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

Parameters
operand

The ContactFavouriteActionBuilder from which to copy all values.

Return:

A ContactFavouriteActionBuilder with all copied data

Since:

BlackBerry 10.0.0

ContactFavouriteActionBuilder & setActionName (
  • QStringactionName)

Sets the name of the action.

This value is the name of the action that's associated with the attribute, and can be a QString such as "phone", "email", "text", and so on.

Parameters
actionName

The action name to set.

Return:

A ContactFavouriteActionBuilder with the provided action name.

Since:

BlackBerry 10.0.0

ContactFavouriteActionBuilder & setAttributeAssociation (
  • intattributeId)

Sets the attribute ID of the action.

The attribute ID specifies which attribute this action is associated with.

Parameters
attributeId

The attribute ID to set.

Return:

A ContactFavouriteActionBuilder with the provided attribute ID.

Since:

BlackBerry 10.0.0

Last modified: 2015-07-24



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

comments powered by Disqus