Packagecom.distriqt.extension.forcetouch.shortcut
Classpublic class ApplicationShortcut
InheritanceApplicationShortcut Inheritance Object

Represents a shortcut


Public Properties
 PropertyDefined By
  icon : int = -1
ApplicationShortcut
  iconBitmap : BitmapData
ApplicationShortcut
  identifier : String
ApplicationShortcut
  subtitle : String
ApplicationShortcut
  title : String
ApplicationShortcut
  type : String
ApplicationShortcut
  userInfo : Object
ApplicationShortcut
  userInfoJSON : String
[read-only] Returns JSON string representation of the userInfo
ApplicationShortcut
Public Methods
 MethodDefined By
  
ApplicationShortcut(identifier:String, title:String, subtitle:String, icon:int = -1, userInfo:Object = null)
Class constructor
ApplicationShortcut
  
setIcon(icon:int):ApplicationShortcut
The icon type (optional) Currently this extension only supports the built-in iOS system icons Supported iOS Only
ApplicationShortcut
  
setIconBitmap(bitmap:BitmapData):ApplicationShortcut
ApplicationShortcut
  
setIdentifier(identifier:String):ApplicationShortcut
Unique identifier for the type of shortcut (required) We recommend using com.domain.app.MyShortcut or similar.
ApplicationShortcut
  
setSubtitle(value:String):ApplicationShortcut
Subtitle text for the shortcut item (optional) This represents the subtitle field on iOS and the long label field on Android.
ApplicationShortcut
  
setTitle(value:String):ApplicationShortcut
Main title text for the shortcut item (required) This represents the title field on iOS and the short label on Android.
ApplicationShortcut
  
setUserInfo(data:Object):ApplicationShortcut
Custom data to be attached to the shortcut item (optional) This data will be returned when the shortcut is used along with the identifier.
ApplicationShortcut
  
validate():Boolean
ApplicationShortcut
Property Detail
iconproperty
public var icon:int = -1

See also

setIcon()
iconBitmapproperty 
public var iconBitmap:BitmapData

See also

setIconBitmap()
identifierproperty 
public var identifier:String

See also

setIdentifier()
subtitleproperty 
public var subtitle:String

See also

setSubtitle()
titleproperty 
public var title:String

See also

setTitle()
typeproperty 
type:String


Implementation
    public function get type():String
    public function set type(value:String):void
userInfoproperty 
public var userInfo:Object

See also

setUserInfo()
userInfoJSONproperty 
userInfoJSON:String  [read-only]

Returns JSON string representation of the userInfo


Implementation
    public function get userInfoJSON():String
Constructor Detail
ApplicationShortcut()Constructor
public function ApplicationShortcut(identifier:String, title:String, subtitle:String, icon:int = -1, userInfo:Object = null)

Class constructor

Parameters
identifier:String
 
title:String
 
subtitle:String
 
icon:int (default = -1)
 
userInfo:Object (default = null)
Method Detail
setIcon()method
public function setIcon(icon:int):ApplicationShortcut

The icon type (optional) Currently this extension only supports the built-in iOS system icons Supported iOS Only

Parameters

icon:int

Returns
ApplicationShortcut —

See also

com.distriqt.extension.forcetouch.shortcut.ShortcutIconType
setIconBitmap()method 
public function setIconBitmap(bitmap:BitmapData):ApplicationShortcut

Parameters

bitmap:BitmapData

Returns
ApplicationShortcut —
setIdentifier()method 
public function setIdentifier(identifier:String):ApplicationShortcut

Unique identifier for the type of shortcut (required) We recommend using com.domain.app.MyShortcut or similar.

Parameters

identifier:String — The unique identifier string for this shortcut

Returns
ApplicationShortcut — ApplicationShortcut instance for chaining calls
setSubtitle()method 
public function setSubtitle(value:String):ApplicationShortcut

Subtitle text for the shortcut item (optional) This represents the subtitle field on iOS and the long label field on Android. This can be longer than the title but we advise it should be kept to less than 25 characters.

Parameters

value:String — The subtitle / long label to be used for the shortcut

Returns
ApplicationShortcut — ApplicationShortcut instance for chaining calls
setTitle()method 
public function setTitle(value:String):ApplicationShortcut

Main title text for the shortcut item (required) This represents the title field on iOS and the short label on Android. This should be kept to a minimum number of characters and will be trimmed to 10 characters on Android.

Parameters

value:String — The title / short label to be used for the shortcut

Returns
ApplicationShortcut — ApplicationShortcut instance for chaining calls
setUserInfo()method 
public function setUserInfo(data:Object):ApplicationShortcut

Custom data to be attached to the shortcut item (optional) This data will be returned when the shortcut is used along with the identifier. Note: It should only consist of primitive data types

Parameters

data:Object — A data Object to attach to this shortcut

Returns
ApplicationShortcut — ApplicationShortcut instance for chaining calls
validate()method 
public function validate():Boolean

Returns
Boolean




Mon Dec 16 2024, 03:45 PM +10:00