mirror of
https://github.com/lampaa/com.lampa.startapp.git
synced 2026-05-20 00:01:31 +08:00
Updated README.md
This commit is contained in:
lampaa
@@ -1,184 +1,260 @@
|
||||
cordova plugin startapp
|
||||
===========================================================================
|
||||
# cordova plugin startapp
|
||||
|
||||
Phonegap plugin for check or launch other application in android device.
|
||||
Phonegap plugin for check or launch other application, get extras in phonegap app.
|
||||
|
||||
===========================================
|
||||
Install: ```cordova plugin add com.lampa.startapp```
|
||||
> Install: ```cordova plugin add com.lampa.startapp```
|
||||
>
|
||||
> Install: ```cordova plugin add https://github.com/lampaa/com.lampa.startapp.git```
|
||||
>
|
||||
> Delete: ```cordova plugin rm com.lampa.startapp```
|
||||
>
|
||||
> Delete previos version: ```cordova plugin rm org.apache.cordova.startapp```
|
||||
|
||||
Install: ```cordova plugin add https://github.com/lampaa/com.lampa.startapp.git```
|
||||
[Manually installation for Android.](/lampaa/com.lampa.startapp/MANUALLY_INSTALL.md)
|
||||
|
||||
Delete: ```cordova plugin rm com.lampa.startapp```
|
||||
|
||||
Delete previos version: ```cordova plugin rm org.apache.cordova.startapp```
|
||||
**NEW!** [Script builder.](/lampaa/com.lampa.startapp/MANUALLY_INSTALL.md) Create script with ui builder.
|
||||
|
||||
===========================================
|
||||
|
||||
Manually installation for Android:
|
||||
# ANDROID
|
||||
|
||||
Add to ```/my-app/platforms/android/res/xml/config.xml```:
|
||||
```xml
|
||||
<feature name="startApp">
|
||||
<param name="android-package" value="com.lampa.startapp.startApp" />
|
||||
</feature>
|
||||
To run other application, you need to build data:
|
||||
```javascript
|
||||
var sApp = startApp.set({} params [, {} extras]);
|
||||
```
|
||||
Add to ```/my-app/platforms/android/assets/www/cordova_plugins.js```:
|
||||
| Param | Description | Default | Values |
|
||||
| --- | --- |
|
||||
| action | [Intent setAction](http://developer.android.com/reference/android/content/Intent.html#setAction(java.lang.String)) | null | String |
|
||||
| category | [Intent addCategory](http://developer.android.com/reference/android/content/Intent.html#addCategory(java.lang.String)) | null | String |
|
||||
| type | [Intent setType](http://developer.android.com/intl/ru/reference/android/content/Intent.html#setType(java.lang.String)) | null | String |
|
||||
| package | [Intent setPackage](http://developer.android.com/intl/ru/reference/android/content/Intent.html#setPackage(java.lang.String)) | null | String |
|
||||
| uri | [Intent Uri](http://developer.android.com/intl/ru/reference/android/content/Intent.html#Intent(java.lang.String, android.net.Uri)) | null | String |
|
||||
| flags | [Intent setFlags](http://developer.android.com/reference/android/content/Intent.html#setFlags(int)) | null | String |
|
||||
| component | [Intent setComponent](http://developer.android.com/reference/android/content/Intent.html#setComponent(android.content.ComponentName)) | null | String |
|
||||
| intentstart | set type of start intent | startActivity | startActivity, startActivityForResult, sendBroadcast |
|
||||
|
||||
Extras as a set of key-value:
|
||||
```javascript
|
||||
{
|
||||
"file": "plugins/com.lampa.startapp/www/startApp.js",
|
||||
"id": "com.lampa.startapp.startapp",
|
||||
"merges": [
|
||||
"navigator.startApp"
|
||||
]
|
||||
"key1":"value1",
|
||||
"key2":"value2"
|
||||
}
|
||||
```
|
||||
Add to ```/my-app/platforms/android/assets/www/plugins/com.lampa.startapp/www/``` file:
|
||||
https://github.com/lampaa/com.lampa.startapp/blob/master/www/startApp.js
|
||||
|
||||
Add to ```/my-app/platforms/android/src/com/lampa/startapp/``` file:
|
||||
https://github.com/lampaa/com.lampa.startapp/blob/master/src/android/startApp.java
|
||||
_Example_
|
||||
|
||||
|
||||
|
||||
use: **ANDROID**
|
||||
|
||||
_Check application for installed_
|
||||
|
||||
If success, returned application info: `versionName`, `packageName`, `versionCode` and `applicationInfo`.
|
||||
```javascript
|
||||
navigator.startApp.check("com.application.name", function(message) { /* success */
|
||||
console.log("app exists: ");
|
||||
console.log(message.versionName);
|
||||
console.log(message.packageName);
|
||||
console.log(message.versionCode);
|
||||
console.log(message.applicationInfo);
|
||||
},
|
||||
function(error) { /* error */
|
||||
console.log(error);
|
||||
var sApp = startApp.set({ /* params */
|
||||
"action":"ACTION_MAIN",
|
||||
"category":"CATEGORY_DEFAULT",
|
||||
"type":"text/css",
|
||||
"package":"com.lampa.startapp",
|
||||
"uri":"file://data/index.html",
|
||||
"flags":["FLAG_ACTIVITY_CLEAR_TOP","FLAG_ACTIVITY_CLEAR_TASK"],
|
||||
"component": ["com.app.name","com.app.name.Activity"],
|
||||
"intentstart":"startActivity",
|
||||
}, { /* extras */
|
||||
"EXTRA_STREAM":"extraValue1",
|
||||
"extraKey2":"extraValue2"
|
||||
});
|
||||
```
|
||||
|
||||
_Start application without parameters_
|
||||
```startApp.set()``` return object:
|
||||
```javascript
|
||||
sApp.start(function() { /* success */
|
||||
console.log("OK");
|
||||
}, function(error) { /* fail */
|
||||
alert(error);
|
||||
});
|
||||
```
|
||||
or
|
||||
```javascript
|
||||
sApp.check(function(values) { /* success */
|
||||
console.log(values);
|
||||
}, function(error) { /* fail */
|
||||
alert(error);
|
||||
});
|
||||
```
|
||||
If success, ```values``` contains data: `versionName`, `packageName`, `versionCode` and `applicationInfo`.
|
||||
|
||||
To get all extra fields use method ```extraFiels```:
|
||||
```javascript
|
||||
startApp.extraFields(function(fields) { /* success */
|
||||
console.log(fields);
|
||||
}, function() { /* fail */
|
||||
|
||||
});
|
||||
```
|
||||
Variable ```fields``` contains object array, example:
|
||||
```javascript
|
||||
{
|
||||
"key1":"value1",
|
||||
"key2":"value2"
|
||||
}
|
||||
```
|
||||
|
||||
To get one extra field use method ```getExtra```:
|
||||
```javascript
|
||||
startApp.getExtra(field, function(value) { /* success */
|
||||
console.log(fields);
|
||||
}, function() { /* fail */
|
||||
|
||||
});
|
||||
```
|
||||
Variable ```field``` is a String.
|
||||
Variable ```value``` contains String value.
|
||||
|
||||
To has one extra field use method ```extraField```:
|
||||
```javascript
|
||||
startApp.hasExtra(field, function() { /* success */
|
||||
console.log(fields);
|
||||
}, function() { /* fail */
|
||||
|
||||
});
|
||||
```
|
||||
Variable ```field``` is a String.
|
||||
|
||||
# Samples
|
||||
|
||||
_Set application as only package name_:
|
||||
```js
|
||||
navigator.startApp.start("com.application.name", function(message) { /* success */
|
||||
console.log(message); // => OK
|
||||
},
|
||||
function(error) { /* error */
|
||||
console.log(error);
|
||||
var sApp = startApp.set({
|
||||
"package":"com.application.name"
|
||||
});
|
||||
```
|
||||
|
||||
_Start application with params. First variant with package and activity:
|
||||
_Set application as package and activity_:
|
||||
```js
|
||||
navigator.startApp.start([["com.app.name", "com.app.name.Activity"]], function(message) { /* success */
|
||||
console.log(message); // => OK
|
||||
},
|
||||
function(error) { /* error */
|
||||
console.log(error);
|
||||
var sApp = startApp.set({
|
||||
"component": ["com.app.name","com.app.name.Activity"]
|
||||
});
|
||||
```
|
||||
_Start application with params. Second variant with action and action params:
|
||||
|
||||
_Set application as action, package, type and Uri_:
|
||||
```js
|
||||
navigator.startApp.start([["action", "ACTION_NAME", "PACKAGE", "TYPE", "URI"]], function(message) { /* success */
|
||||
console.log(message); // => OK
|
||||
},
|
||||
function(error) { /* error */
|
||||
console.log(error);
|
||||
var sApp = startApp.set({ /* params */
|
||||
"action":"ACTION_MAIN",
|
||||
"type":"text/css",
|
||||
"package":"com.lampa.startapp",
|
||||
"uri":"file://data/index.html"
|
||||
});
|
||||
```
|
||||
`ACTION_NAME` these is a Intent flag [Intent Flags](http://developer.android.com/reference/android/content/Intent.html) (MAIN, VIEW, CALL, etc..).
|
||||
|
||||
`PACKAGE` these is a Intent method [setPackage](http://developer.android.com/intl/ru/reference/android/content/Intent.html#setPackage(java.lang.String)) (optional or set null)
|
||||
|
||||
`TYPE` these is a Intent method [setType](http://developer.android.com/intl/ru/reference/android/content/Intent.html#setType(java.lang.String)) (optional or set null)
|
||||
|
||||
`URI` these is a Intent data Uri [Uri](http://developer.android.com/intl/ru/reference/android/content/Intent.html#Intent(java.lang.String, android.net.Uri)) (optional or set null)
|
||||
|
||||
|
||||
> **Important!** First value of first parameter of _start_ method can be either a string or an array. And the array must contain two parameters. Example:
|
||||
>
|
||||
> ["com.app.name", [....]] or [["com.app.name", "com.app.name.Activity"] [....]]
|
||||
|
||||
|
||||
_Start application with only values_
|
||||
_Start application with extra fields_
|
||||
|
||||
```js
|
||||
navigator.startApp.start([[...], ["set_param1", "set_param2",..., "set_paramN"]], function(message) { /* success */
|
||||
console.log(message); // => OK
|
||||
},
|
||||
function(error) { /* error */
|
||||
console.log(error);
|
||||
var sApp = startApp.set({ /* params */
|
||||
"component": ["com.app.name","com.app.name.Activity"]
|
||||
}, { /* extras */
|
||||
"extraKey1":"extraValue1",
|
||||
"extraKey2":"extraValue2"
|
||||
});
|
||||
```
|
||||
_ANDROID: Start application with key:value parameters_
|
||||
|
||||
```js
|
||||
navigator.startApp.start([[...], [{"key1":"value1"},{"key2":"value2"}, {...}, {"keyN":"valueN"}]], function(message) { /* success */
|
||||
console.log(message); // => OK
|
||||
},
|
||||
function(error) { /* error */
|
||||
console.log(error);
|
||||
});
|
||||
```
|
||||
Example, call application with activity and key:value param:
|
||||
|
||||
```js
|
||||
navigator.startApp.start([["app.com.name", "app.com.name.Activity"], [{"product_id":"100"}]], ...);
|
||||
```
|
||||
|
||||
|
||||
|
||||
Example, call skype:
|
||||
```js
|
||||
navigator.startApp.start([["action", "VIEW"], ["skype:+79109999999"]], ...);
|
||||
startApp.set({ /* params */
|
||||
"action": "ACTION_VIEW",
|
||||
"uri": "skype:+79109999999"
|
||||
}).start();
|
||||
```
|
||||
Example, call phone:
|
||||
```js
|
||||
navigator.startApp.start([["action", "CALL"], ["tel:+79109999999"]], ...);
|
||||
startApp.set({ /* params */
|
||||
"action": "ACTION_CALL",
|
||||
"uri": "tel:+79109999999"
|
||||
}).start();
|
||||
```
|
||||
Example, call browser:
|
||||
```js
|
||||
navigator.startApp.start([["action", "VIEW"], ["https://github.com/lampaa"]], ...);
|
||||
startApp.set({ /* params */
|
||||
"action": "ACTION_VIEW",
|
||||
"uri": "https://github.com/lampaa"
|
||||
}).start();
|
||||
```
|
||||
Example, call facebook:
|
||||
```js
|
||||
navigator.startApp.start([["action", "VIEW"], ["fb://facewebmodal/f?href=https://www.facebook.com/GitHub"]], ...);
|
||||
startApp.set({ /* params */
|
||||
"action": "ACTION_VIEW",
|
||||
"uri": "fb://facewebmodal/f?href=https://www.facebook.com/GitHub"
|
||||
}).start();
|
||||
```
|
||||
Example, call whatsapp:
|
||||
```js
|
||||
navigator.startApp.start([["action", "SEND", "com.whatsapp", "text/plain"], [{"android.intent.extra.TEXT":"Text..."}]], ...);
|
||||
startApp.set({ /* params */
|
||||
"action": "ACTION_SEND",
|
||||
"package": "com.whatsapp",
|
||||
"type": "text/plain"
|
||||
}, {
|
||||
"android.intent.extra.TEXT":"Text..."
|
||||
}).start();
|
||||
```
|
||||
Example, call whatsapp chat:
|
||||
```js
|
||||
navigator.startApp.start([["action", "SEND", "com.whatsapp", "text/plain", "+79123456789"], [{"android.intent.extra.TEXT":"Text..."}, {"chat": true}]], ...);
|
||||
startApp.set({ /* params */
|
||||
"action": "ACTION_SEND",
|
||||
"package": "com.whatsapp",
|
||||
"type": "text/plain",
|
||||
"uri": "+79123456789"
|
||||
}, {
|
||||
"android.intent.extra.TEXT":"Text...",
|
||||
"chat": true
|
||||
}).start();
|
||||
```
|
||||
Example, call sms:
|
||||
```js
|
||||
startApp.set({ /* params */
|
||||
"action": "ACTION_MAIN",
|
||||
"category": "CATEGORY_DEFAULT",
|
||||
"type": "vnd.android-dir/mms-sms"
|
||||
}).start();
|
||||
```
|
||||
Example, play mp4 video:
|
||||
```js
|
||||
startApp.set({ /* params */
|
||||
"action": "ACTION_VIEW",
|
||||
"uri": "http://domain.com/videofile.mp4",
|
||||
"type": "video/mp4"
|
||||
}).start();
|
||||
```
|
||||
Example, open contacts book:
|
||||
```js
|
||||
startApp.set({ /* params */
|
||||
"action": "ACTION_PICK",
|
||||
"uri": "ContactsContract.Contacts.CONTENT_URI",
|
||||
"type": "video/mp4",
|
||||
"intentstart":"startActivityForResult"
|
||||
}).start();
|
||||
```
|
||||
|
||||
|
||||
|
||||
Use **iOS**
|
||||
|
||||
_Check iOS application for installed_
|
||||
_Set iOS application_
|
||||
|
||||
```js
|
||||
navigator.startApp.check("twitter://", function(message) { /* success */
|
||||
console.log(message); // => OK
|
||||
},
|
||||
function(error) { /* error */
|
||||
console.log(error);
|
||||
var sApp = startApp.set("twitter://");
|
||||
```
|
||||
|
||||
return ```startApp``` object:
|
||||
```javascript
|
||||
sApp.start(function() { /* success */
|
||||
console.log("OK");
|
||||
}, function(error) { /* fail */
|
||||
alert(error);
|
||||
});
|
||||
```
|
||||
or
|
||||
```javascript
|
||||
sApp.check(function(values) { /* success */
|
||||
console.log(values);
|
||||
}, function(error) { /* fail */
|
||||
alert(error);
|
||||
});
|
||||
```
|
||||
|
||||
_Start iOS application_
|
||||
|
||||
```js
|
||||
navigator.startApp.start("twitter://", function(message) { /* success */
|
||||
console.log(message); // => OK
|
||||
},
|
||||
function(error) { /* error */
|
||||
console.log(error);
|
||||
});
|
||||
```
|
||||
===========================================
|
||||
Tags:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user