qnx.events.CardCloseEvent

CardCloseEvent

Properties | Methods | Constants


Packageqnx.events
Classpublic class CardCloseEvent
InheritanceCardCloseEvent Inheritance flash.events.Event

The CardCloseEvent is dispatched by the InvokeManager when an invoked card is closed for any reason.

The card can be closed if the user cancels the card or selects an item. The reason is specified by the reason property.



Class information:
BlackBerry 10 Version:   10.0.0
Found in:  QNXDevice.ane



Public Properties

 PropertyDefined By
  data : String
[read-only] The data that is returned from the card.
CardCloseEvent
  mimeType : String
[read-only] The mime type of the data that was returned.
CardCloseEvent
  reason : String
[read-only] The reason the card closed.
CardCloseEvent

Public Methods

 MethodDefined By
  
CardCloseEvent(type:String, reason:String, mimeType:String = null, data:String = null)
Creates a CardCloseEvent.
CardCloseEvent

Public Constants

 ConstantDefined By
  CARD_CLOSED : String = cardClosed
[static] Event type dispatched whent the card is closed.
CardCloseEvent

Property Detail

data


data:String  [read-only]

The data that is returned from the card.

Because the data that is returned can be encoded in number of different types, it is the responsibility of the application developer to decode the data.

For example, if the user was selecting an image or other binary object, the data will be encoded as Base64 and applications developers should use the qnx.crypto.Base64 class to decode it. It may also be a complex object, which is encoded as JSON. In this case application developers should use the top level JSON class to decode the data.


Implementation

public function get data():String

mimeType


mimeType:String  [read-only]

The mime type of the data that was returned.


Implementation

public function get mimeType():String

reason


reason:String  [read-only]

The reason the card closed.


Implementation

public function get reason():String

Constructor Detail

CardCloseEvent()


public function CardCloseEvent(type:String, reason:String, mimeType:String = null, data:String = null)

Creates a CardCloseEvent.

Parameters

type:String — The type of the event.
reason:String — The reason the card was closed.
mimeType:String (default = null) — The mime type of the data returned.
data:String (default = null) — The data that was returned by the card.

Constant Detail

CARD_CLOSED


public static const CARD_CLOSED:String = cardClosed

Event type dispatched whent the card is closed.

The CardCloseEvent.CARD_CLOSED constant defines the value of the type property of the event object for an cardClosed event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
dataThe data sent from the card when it was closed.
mimeTypeThe mime-type of the data returned with the event.
reasonThe reason the card was closed.
typeCardCloseEvent.CARD_CLOSED





comments powered by Disqus