Skip to content
Adds support for Siri Shortcuts to Cordova, requires XCode 10 and iOS >= 12.0
Branch: master
Clone or download
Latest commit 0e8ef05 Sep 23, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src/ios
www [BC-break] Added clear option for getActivatedShortcut() Sep 23, 2018
.gitignore
README.md
package.json Create release Sep 23, 2018
plugin.xml Create release Sep 23, 2018

README.md

cordova-plugin-siri-shortcuts

Heads up!

The plugin only works in XCode 10, and on the iOS 12 platform.

Information

This plugin adds support for donating and removing Siri Shortcuts. The plugin adds the cordova.plugins.SiriShortcuts to the global space, but this is only available after the device has been initialised.

Installation

This requires Cordova 6.0+

cordova plugin add cordova-plugin-siri-shortcuts

Api reference

donate(options, success, error)

Donate shortcut to Siri

present(options, success, error)

Present shortcut to the user, will popup a view controller asking the user to add it to Siri

remove(persistentIdentifiers, success, error)

Remove shortcuts based on identifiers

removeAll(success, error)

Remove all shortcuts from the application

getActivatedShortcut(success, error)

Get the current clicked user activity, and return null if none

donate(options, success, error) ⇒

Donate shortcut to Siri

Kind: global function
Returns: void

Param Type Description
options object Options to specify for the donation
options.persistentIdentifier string Specify an identifier to uniquely identify the shortcut, in order to be able to remove it
options.title string Specify a title for the shortcut, which is visible to the user as the name of the shortcut
options.suggestedInvocationPhrase string Specify the phrase to give the user some inspiration on what the shortcut to call
options.userInfo object Provide a key-value object that contains information about the shortcut, this will be returned in the getActivatedShortcut method. It is not possible to use the persistentIdentifier key, it is used internally
options.isEligibleForSearch boolean This value defaults to true, set this value to make it searchable in Siri
options.isEligibleForPrediction boolean This value defaults to true, set this value to set whether the shortcut eligible for prediction
success function Function to call upon successful donation
error function Function to call upon unsuccessful donation, for example if the user has an iOS version < 12.0

present(options, success, error) ⇒

Present shortcut to the user, will popup a view controller asking the user to add it to Siri

Kind: global function
Returns: void

Param Type Description
options object Options to specify for the shortcut
options.persistentIdentifier string Specify an identifier to uniquely identify the shortcut, in order to be able to remove it
options.title string Specify a title for the shortcut, which is visible to the user as the name of the shortcut
options.suggestedInvocationPhrase string Specify the phrase to give the user some inspiration on what the shortcut to call
options.userInfo object Provide a key-value object that contains information about the shortcut, this will be returned in the getActivatedShortcut method. It is not possible to use the persistentIdentifier key, it is used internally
success function Function to call upon successful donation
error function Function to call upon unsuccessful donation, for example if the user has an iOS version < 12.0

remove(persistentIdentifiers, success, error) ⇒

Remove shortcuts based on identifiers

Kind: global function
Returns: void

Param Type Description
persistentIdentifiers string | Array.<string> Specify which shortcut(s) to delete by their persistent identifiers
success function Function to call upon successful removal
error function Function to call upon unsuccessful removal

removeAll(success, error) ⇒

Remove all shortcuts from the application

Kind: global function
Returns: void

Param Type Description
success function Function to call upon successful removal
error function Function to call upon unsuccessful removal

getActivatedShortcut(options, success, error) ⇒

Get the current clicked user activity, and return null if none

Kind: global function
Returns: void

Param Type Description
options object Options to specify for getting the shortcut
options.clear boolean Clear the currently activated shortcut, defaults to true
success function Function to call upon succesful fetch. Data returns either null when there is no activated shortcut, or a key-value object containing: { persistentIdentifier: string; title: string; userInfo: object; }
error function Function to call upon unsuccessful removal
You can’t perform that action at this time.