qnx.invoke.InvokeRequest

InvokeRequest

Properties


Packageqnx.invoke
Classpublic final class InvokeRequest
InheritanceInvokeRequest Inheritance Object

The InvokeRequest class is used to invoke applications with the InvocationManager.invoke() method. If your application is invoked by another service or application, the InvocationManager.startupRequest property will contain the InvokeRequest that was used to invoke the application.

Class information:
BlackBerry 10 Version:   10.0.0

See also

InvokeManager.invoke()
InvokeManager.startupRequest



Public Properties

 PropertyDefined By
  action : String
The action to be performed by the target.
InvokeRequest
  data : ByteArray
Data to be acted upon encoded based on the specified type.
InvokeRequest
  fileTransferMode : String
Allows sender to specify if and how the file transfer mechanism will be applied.
InvokeRequest
  groupId : String
[read-only] Returns the primary group id of the process making the invocation request.
InvokeRequest
  installId : String
[read-only] Returns the id assigned to the process making the request.
InvokeRequest
  metadata : String
An optional JSON encoded string describing the type of data being passed.
InvokeRequest
  mimeType : String
The MIME type of data to be acted on.
InvokeRequest
  perimeter : String
The perimeter in which to invoke the target in.
InvokeRequest
  target : String
The identifier of the target to be invoked.
InvokeRequest
  targetOptions : uint
Optional mask which specifies which target types should be included in the invoke request.
InvokeRequest
  uri : String
The uri pointing to invocation data.
InvokeRequest

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.

See also

FileTransferMode

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.

targetOptions


public var targetOptions:uint

Optional mask which specifies which target types should be included in the invoke request. This property can be set to any combination of values in the InvokeTargetOptions class;

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.





comments powered by Disqus