mirror of
https://github.com/danielsogl/awesome-cordova-plugins.git
synced 2026-05-20 00:06:24 +08:00
docs(all): standardizes and adds return types, also some param fixes
This commit is contained in:
+12
-12
@@ -34,7 +34,7 @@ export class NFC {
|
||||
* Registers an event listener for any NDEF tag.
|
||||
* @param onSuccess
|
||||
* @param onFailure
|
||||
* @return {Promise<any>}
|
||||
* @returns {Observable<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
observable: true,
|
||||
@@ -50,7 +50,7 @@ export class NFC {
|
||||
* @param mimeType
|
||||
* @param onSuccess
|
||||
* @param onFailure
|
||||
* @return {Promise<any>}
|
||||
* @returns {Observable<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
observable: true,
|
||||
@@ -65,7 +65,7 @@ export class NFC {
|
||||
* Registers an event listener for NDEF tags matching a specified MIME type.
|
||||
* @param onSuccess
|
||||
* @param onFailure
|
||||
* @return {Promise<any>}
|
||||
* @returns {Observable<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
observable: true,
|
||||
@@ -80,7 +80,7 @@ export class NFC {
|
||||
* Registers an event listener for formatable NDEF tags.
|
||||
* @param onSuccess
|
||||
* @param onFailure
|
||||
* @return {Promise<any>}
|
||||
* @returns {Observable<any>}
|
||||
*/
|
||||
@Cordova({
|
||||
observable: true,
|
||||
@@ -92,13 +92,13 @@ export class NFC {
|
||||
/**
|
||||
* Qrites an NdefMessage to a NFC tag.
|
||||
* @param message {any[]}
|
||||
* @return {Promise<any>}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
static write(message: any[]): Promise<any> {return; }
|
||||
/**
|
||||
* Makes a NFC tag read only. **Warning** this is permanent.
|
||||
* @return {Promise<any>}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
static makeReadyOnly(): Promise<any> {return; }
|
||||
@@ -106,14 +106,14 @@ export class NFC {
|
||||
/**
|
||||
* Shares an NDEF Message via peer-to-peer.
|
||||
* @param message An array of NDEF Records.
|
||||
* @return {Promise<any>}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
static share(message: any[]): Promise<any> {return; }
|
||||
|
||||
/**
|
||||
* Stop sharing NDEF data via peer-to-peer.
|
||||
* @return {Promise<any>}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
static unshare(): Promise<any> {return; }
|
||||
@@ -127,28 +127,28 @@ export class NFC {
|
||||
/**
|
||||
* Send a file to another device via NFC handover.
|
||||
* @param uris A URI as a String, or an array of URIs.
|
||||
* @return {Promise<any>}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
static handover(uris: string[]): Promise<any> {return; }
|
||||
|
||||
/**
|
||||
* Stop sharing NDEF data via NFC handover.
|
||||
* @return {Promise<any>}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
static stopHandover(): Promise<any> {return; }
|
||||
|
||||
/**
|
||||
* Show the NFC settings on the device.
|
||||
* @return {Promise<any>}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
static showSettings(): Promise<any> {return; }
|
||||
|
||||
/**
|
||||
* Check if NFC is available and enabled on this device.
|
||||
* @return {Promise<any>}
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
@Cordova()
|
||||
static enabled(): Promise<any> {return; }
|
||||
|
||||
Reference in New Issue
Block a user