qnx.invoke.InvokeViewerRequest

InvokeViewerRequest

Properties


Packageqnx.invoke
Classpublic final class InvokeViewerRequest
InheritanceInvokeViewerRequest Inheritance Object

The InvokeViewerRequest class is used to invoke viewers with the InvocationManager.invokeViewer() method. If your viewer is invoked by another service or application, the InvocationManager.startupViewerRequest property will contain the InvokeViewerRequest that was used to invoke the viewer.

Class information:
BlackBerry 10 Version:   10.0.0

See also

InvokeManager.invokeViewer()
InvokeManager.startupViewerRequest



Public Properties

 PropertyDefined By
  action : String
The action to be performed by the target.
InvokeViewerRequest
  data : ByteArray
Data to be acted upon encoded based on the specified type.
InvokeViewerRequest
  fileTransferMode : String
Allows sender to specify if and how the file transfer mechanism will be applied.
InvokeViewerRequest
  groupId : String
[read-only] Returns the primary group id of the process making the invocation request.
InvokeViewerRequest
  installId : String
[read-only] Returns the id assigned to the process making the request.
InvokeViewerRequest
  metadata : String
An optional JSON encoded string describing the type of data being passed.
InvokeViewerRequest
  mimeType : String
The MIME type of data to be acted on.
InvokeViewerRequest
  perimeter : String
The perimeter in which to invoke the target in.
InvokeViewerRequest
  target : String
The identifier of the target to be invoked.
InvokeViewerRequest
  uri : String
The uri pointing to invocation data.
InvokeViewerRequest
  windowHeight : int
The height of the viewer when intialized.
InvokeViewerRequest
  windowId : String
The window id of the viewer that holds the viewer.
InvokeViewerRequest
  windowWidth : int
The width of the viewer when intialized.
InvokeViewerRequest

Property Detail

action


public var action:String

The action to be performed by the target. If the action is omitted, the target should infer the action. Valid values for this property can be found as constants in the InvokeAction class.

data


public var data:ByteArray

Data to be acted upon encoded based on the specified type. Omitting the data implies that the action property is sufficient to carry out the invocation.

fileTransferMode


public var fileTransferMode:String

Allows sender to specify if and how the file transfer mechanism will be applied.

Options are:

  • FileTransferMode.PRESERVE: The file URI provided in the request should be preserved as-is. No box-2-box logic should be applied.
  • FileTransferMode.COPY_READ: The file identified by the request should be copied to the receivers inbox with permission o+r.
  • FileTransferMode.COPY_READ_WRITE: The file identified by the request should be copied to the receivers inbox with permissions o+rw.
  • FileTransferMode.LINK: The file identified by the request should be linked to the receivers inbox. Note the permissions on the original file must include o+r. If o+w is also set then the sender MUST be the owner of the file.

groupId


groupId:String  [read-only]

Returns the primary group id of the process making the invocation request.


Implementation

public function get groupId():String

installId


installId:String  [read-only]

Returns the id assigned to the process making the request.


Implementation

public function get installId():String

metadata


public var metadata:String

An optional JSON encoded string describing the type of data being passed.

The value of metadata must be purely informational/optional and must not strictly dictate the handling of the data. For example the metadata attribute is often used to pass thumbnails of media content.

mimeType


public var mimeType:String

The MIME type of data to be acted on. Note that this attribute is optional in the request. If the mime type is not specified the Invocation Framework will attempt to infer the mime type from the given uri. If the mime type can not be inferred or uri property is empty then invocation will be rejected.

perimeter


public var perimeter:String

The perimeter in which to invoke the target in.

target


public var target:String

The identifier of the target to be invoked. If the target is supplied when brokering is bypassed and an attempt is made to invoke the specified target.

uri


public var uri:String

The uri pointing to invocation data. If no uri is provided then the value of the data property is used.

windowHeight


public var windowHeight:int

The height of the viewer when intialized.

windowId


public var windowId:String

The window id of the viewer that holds the viewer.

windowWidth


public var windowWidth:int

The width of the viewer when intialized.





comments powered by Disqus