OutOfOfficeSettings

Since: BlackBerry 10.0.0

#include <bb/pim/message/OutOfOfficeSettings>

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

The OutOfOfficeSettings class includes information about out-of-office replies for messages.

You can use this class to set the Out of Office option, and you can specify the text to use as the out-of-office reply message.


Overview

Public Functions Index

OutOfOfficeSettings ()
OutOfOfficeSettings (int state, const QString &text)
OutOfOfficeSettings (OutOfOfficeSettingsPrivate *outOfOfficeSettingsPrivate)
OutOfOfficeSettings (const OutOfOfficeSettings &other)
~OutOfOfficeSettings ()
intisEnabled () const
boolisValid () const
OutOfOfficeSettings &operator= (const OutOfOfficeSettings &other)
voidsetState (int state)
voidsetText (const QString &text)
QStringText () const

Public Functions

OutOfOfficeSettings ()

Constructs a new OutOfOfficeSettings.

Since:

BlackBerry 10.0.0

OutOfOfficeSettings (

Constructs a new OutOfOfficeSettings with the provided state and text.

The state is an integer that should be either 0 (to disable the out-of-office option) or 1 (to enable the out-of-office option). The provided text is used as the out-of-office reply.

Parameters
state

The state of the out-of-office option (either 0 or 1).

text

The out-of-office reply text.

Since:

BlackBerry 10.0.0

OutOfOfficeSettings (
  • OutOfOfficeSettingsPrivate *outOfOfficeSettingsPrivate)

Constructs an OutOfOfficeSettings with the provided private out-of-office information.

This constructor creates an OutOfOfficeSettings by using a d_ptr to private out-of-office information.

Parameters
outOfOfficeSettingsPrivate

The private out-of-office information to use.

Since:

BlackBerry 10.0.0

OutOfOfficeSettings (

Copy constructor.

This function constructs an OutOfOfficeSettings containing exactly the same values as the provided OutOfOfficeSettings.

Parameters
other

The OutOfOfficeSettings to be copied.

Since:

BlackBerry 10.0.0

~OutOfOfficeSettings ()

Destructor.

Since:

BlackBerry 10.0.0

int isEnabled ()

Retrieves the state of this OutOfOfficeSettings.

The state is either 0 (if the out-of-office option is disabled) or 1 (if the out-of-office option is enabled).

Return:

The state of the out-of-office option (either 0 or 1).

Since:

BlackBerry 10.0.0

bool isValid ()

Indicates whether this OutOfOfficeSettings is valid.

Return:

true if this OutOfOfficeSettings is valid, false otherwise.

Since:

BlackBerry 10.0.0

OutOfOfficeSettings & operator= (

Assignment operator.

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

Parameters
other

The OutOfOfficeSettings from which to copy all values.

Return:

An OutOfOfficeSettings with all copied data.

Since:

BlackBerry 10.0.0

void setState (
  • intstate)

Sets the state of this OutOfOfficeSettings.

The provided state should be either 0 (to disable the out-of-office option) or 1 (to enable the out-of-office option).

Parameters
state

The new state of the out-of-office option (either 0 or 1).

Since:

BlackBerry 10.0.0

void setText (

Sets the out-of-office reply text of this OutOfOfficeSettings.

Parameters
text

The new out-of-office reply text.

Since:

BlackBerry 10.0.0

QString Text ()

Retrieves the out-of-office reply text of this OutOfOfficeSettings.

Since:

BlackBerry 10.0.0

Last modified: 2014-06-24



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

comments powered by Disqus