CancelSubscriptionReply

Since: BlackBerry 10.0.0

#include <bb/platform/CancelSubscriptionReply>

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

Represents a response to PaymentManager::requestCancelSubscription().

An instance of this class is returned when a call to PaymentManager::requestCancelSubscription is made. Initially, the returned object will be unfinished and will not contain any valid information relating to the request (other than that it is unfinished). Once the request is finished, PaymentReply::isError() can be used to determine whether the request succeeded or failed. If the request was successful, then the isCanceled() method indicates whether the subscription was canceled. If the request failed, then the error code and error text are included; these can be accessed on the PaymentReply base class.

The finished() signal can be used to determine when the request finishes. The PaymentManager::cancelSubscriptionFinished signal can also be used to determine when a request finishes.

Note:

A successful response does not indicate that the subscription was canceled. The request is successful if the BlackBerry World server can be contacted and the purchase could be located. It is possible for a successful request to have not canceled the subscription. In this case, PaymentReply::isError() and isCanceled() will both return false.

,

Do not delete the object in a slot connected to the any of the finished signals. Use QObject::deleteLater() instead.


Overview

Inheritance

bb::platform::PaymentReply
bb::platform::CancelSubscriptionReply

Properties Index

boolcanceled [read-only]
QStringpurchaseId [read-only]
interrorCode [read-only]Inherited
QStringerrorInfo [read-only]Inherited
QStringerrorText [read-only]Inherited
boolfinished [read-only]Inherited

Public Functions Index

virtual ~CancelSubscriptionReply ()
boolisCanceled () const
QStringpurchaseId () const
interrorCode () const Inherited
QStringerrorInfo () const Inherited
QStringerrorText () const Inherited
boolisError () const Inherited
boolisFinished () const Inherited

Signals Index

Only has inherited signals

voidfinished ()Inherited

Properties

bool canceled[read-only]

Represents the result of a cancel subscription request.

Since:

BlackBerry 10.2.0

QString purchaseId[read-only]

Represents the purchase id .

The purchase id passed to PaymentManager::requestCancelSubscription().

Since:

BlackBerry 10.2.0

int errorCodeInherited[read-only]

Represents the error code.

Since:

BlackBerry 10.2.0

QString errorInfoInherited[read-only]

Get the extra error information.

In the event of a Failed errorCode, this represents extra information to further identify the error that occurred, for diagnostic purposes.

Since:

BlackBerry 10.2.0

QString errorTextInherited[read-only]

Represents the error text.

If the request is unfinished or finished successfully, then this method returns an empty string. If the request failed, then this method returns the a description of the error that occurred.

Since:

BlackBerry 10.2.0

bool finishedInherited[read-only]

Represents whether the request is finished.

Whether the request is finished.

Since:

BlackBerry 10.2.0

Public Functions

virtual~CancelSubscriptionReply ()

Destructor.

Since:

BlackBerry 10.0.0

bool isCanceled ()

Whether the subscription was successfully canceled.

If the request finished successfully, then this returns whether the subscription was successfully canceled. If the request failed or is unfinished, then false is returned.

Note:

A successful response does not indicate that the subscription was canceled. The request is successful if the BlackBerry World server can be contacted and the purchase could be located. It is possible for a successful request to have not canceled the subscription. In this case, PaymentReply::isError() and isCanceled() will both return false.

Return:

Whether the subscription was successfully canceled.

Since:

BlackBerry 10.0.0

QString purchaseId ()

Get the purchase id.

Return:

The purchase id passed to PaymentManager::requestCancelSubscription().

Since:

BlackBerry 10.0.0

int errorCode ()Inherited

Get the error code.

If the request is unfinished or finished successfully, then this method returns PaymentErrorCode::None. If the request failed, then this method returns the appropriate PaymentErrorCode.

Return:

The error code.

Since:

BlackBerry 10.0.0

QString errorInfo ()Inherited

Get the extra error information.

In the event of a Failed errorCode(), this method returns extra information to further identify the error that occurred, for diagnostic purposes.

Return:

The extra error information.

Since:

BlackBerry 10.2.0

QString errorText ()Inherited

Get the error text.

If the request is unfinished or finished successfully, then this method returns an empty string. If the request failed, then this method returns the a description of the error that occurred.

Return:

A description of the error that occurred.

Since:

BlackBerry 10.0.0

bool isError ()Inherited

Whether the request failed.

If the request is unfinished or finished successfully, then this method returns false. If the request failed, then this method returns true.

Return:

Whether the request failed.

Since:

BlackBerry 10.0.0

bool isFinished ()Inherited

Whether the request is finished.

Return:

true if a result has been received, false otherwise.

Since:

BlackBerry 10.0.0

Signals

(Only has inherited signals)

void finished ()Inherited

Emitted when a result is received.

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