awesome-cordova-plugins/src/plugins/clipboard.ts

55 lines
1.4 KiB
TypeScript
Raw Normal View History

2016-07-08 06:46:46 +08:00
import { Cordova, Plugin } from './plugin';
2016-02-17 17:49:26 +08:00
/**
* @name Clipboard
* @description
2016-02-17 17:49:26 +08:00
* Clipboard management plugin for Cordova that supports iOS, Android, and Windows Phone 8.
*
* Requires Cordova plugin: https://github.com/VersoSolutions/CordovaClipboard
2016-03-05 05:42:21 +08:00
* For more info, please see the [Clipboard plugin docs](https://github.com/VersoSolutions/CordovaClipboard.git).
2016-02-17 17:49:26 +08:00
*
* @usage
* ```js
* import {Clipboard} from 'ionic-native';
*
*
*
2016-02-17 17:49:26 +08:00
* Clipboard.copy("Hello world");
*
* Clipboard.paste().then(
* (resolve : string) => {
2016-07-09 03:19:13 +08:00
* alert(resolve);
* },
2016-02-17 17:49:26 +08:00
* (reject : string) => {
* alert("Error: " + reject);
* }
2016-07-09 03:19:13 +08:00
* );
2016-02-17 17:49:26 +08:00
* );
* ```
*/
@Plugin({
2016-03-05 05:42:21 +08:00
plugin: 'https://github.com/VersoSolutions/CordovaClipboard.git',
2016-03-13 08:08:47 +08:00
pluginRef: 'cordova.plugins.clipboard',
2016-03-15 01:38:35 +08:00
repo: 'https://github.com/VersoSolutions/CordovaClipboard',
platforms: ['Amazon Fire OS', 'iOS', 'Android', 'BlackBerry 10', 'Windows Phone 7', 'Windows Phone 8', 'Windows', 'Firefox OS', 'Browser']
2016-02-17 17:49:26 +08:00
})
export class Clipboard {
/**
* Copies the given text
2016-07-09 03:19:13 +08:00
* @param {string} text Text that gets copied on the system clipboard
* @returns {Promise<T>} Returns a promise after the text has been copied
2016-02-17 17:49:26 +08:00
*/
2016-02-17 17:52:00 +08:00
@Cordova()
static copy(text: string): Promise<any> { return; }
2016-02-17 17:49:26 +08:00
/**
* Pastes the text stored in clipboard
2016-07-09 03:19:13 +08:00
* @returns {Promise<T>} Returns a promise after the text has been pasted
2016-02-17 17:49:26 +08:00
*/
2016-02-17 17:52:00 +08:00
@Cordova()
static paste(): Promise<any> { return; }
2016-02-17 17:49:26 +08:00
}