PushStatus

Since: BlackBerry 10.0.0

#include <bb/network/PushStatus>

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

Describes the status of a Push request.

The code attribute, when greater than 0, indicates the reason for the failure. The complete set of codes are defined in PushErrorCode.


Overview

Public Functions Index

PushStatus ()
PushStatus (int code)
PushStatus (const PushStatus &other)
~PushStatus ()
intcode () const
QStringerrorDescription () const
boolisError () const
PushStatus &operator= (const PushStatus &other)
voidsetCode (int code)
voidsetErrorDescription (const QString &errorDescription)

Public Functions

PushStatus ()

Constructs a PushStatus object.

Return:

The PushStatus object.

Since:

BlackBerry 10.0.0

PushStatus (
  • intcode)

Creates a new PushStatus object to store the response code from the PPG.

Parameters
code

The response code associated with the status.

Since:

BlackBerry 10.0.0

PushStatus (

Creates a copy of of an existing PushStatus object.

Parameters
other

The existing PushStatus object that will be copied.

Since:

BlackBerry 10.0.0

~PushStatus ()

Destructor.

Since:

BlackBerry 10.0.0

int code ()

Gets the response code associated with the PushStatus object.

Return:

code Returns the response code associated with the PushStatus. 0 indicates a success, while any other value indicates a failure. By calling errorDescription() on the PushStatus you can find out more information about the error.

Since:

BlackBerry 10.0.0

QString errorDescription ()

Gets the error description associated with the PushStatus object.

Return:

errorDescription Additional information about the error.

Since:

BlackBerry 10.0.0

bool isError ()

Specifies whether the PushStatus contains an error.

Return:

true if there is an error, false otherwise

Since:

BlackBerry 10.0.0

PushStatus & operator= (

Copies the data from an existing PushStatus object.

Parameters
other

The existing PushStatus object that will be copied.

Return:

A new PushStatus object containing the copied data.

Since:

BlackBerry 10.0.0

void setCode (
  • intcode)

Sets the response code.

Parameters
code

The response code associated with the status.

Since:

BlackBerry 10.0.0

void setErrorDescription (

Sets the error description.

Parameters
errorDescription

Error details associated with the status.

Since:

BlackBerry 10.0.0

Last modified: 2014-09-29



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

comments powered by Disqus