github/awesome-cordova-plugins
3
0
Fork 1
mirror of https://github.com/danielsogl/awesome-cordova-plugins.git synced 2026-05-02 00:07:23 +08:00
Code Issues Projects Releases Wiki Activity

docs(all): standardizes and adds return types, also some param fixes

Browse Source
This commit is contained in:
Alex Muramoto
2016-11-29 16:40:50 -06:00
parent b7a562053a
commit 3da2831779
88 changed files with 635 additions and 347 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/plugins/socialsharing.ts
+13 -13
View File
@@ -38,7 +38,7 @@ export class SocialSharing {
* @param subject {string} The subject
* @param file {string|string[]} URL(s) to file(s) or image(s), local path(s) to file(s) or image(s), or base64 data of an image. Only the first file/image will be used on Windows Phone.
* @param url {string} A URL to share
* @returns {Promise}
* @returns {Promise<any>}
*/
@Cordova()
static share(message?: string, subject?: string, file?: string|string[], url?: string): Promise<any> { return; }
@@ -46,7 +46,7 @@ export class SocialSharing {
/**
* Shares using the share sheet with additional options and returns a result object or an error message (requires plugin version 5.1.0+)
* @param options {object} The options object with the message, subject, files, url and chooserTitle properties.
* @returns {Promise}
* @returns {Promise<any>}
*/
@Cordova({
platforms: ['iOS', 'Android']
@@ -60,7 +60,7 @@ export class SocialSharing {
* @param subject {string}
* @param image {string}
* @param url {string}
* @returns {Promise}
* @returns {Promise<any>}
*/
@Cordova({
successIndex: 5,
@@ -74,7 +74,7 @@ export class SocialSharing {
* @param message {string}
* @param image {string}
* @param url {string}
* @returns {Promise}
* @returns {Promise<any>}
*/
@Cordova({
successIndex: 3,
@@ -88,7 +88,7 @@ export class SocialSharing {
* @param message {string}
* @param image {string}
* @param url {string}
* @returns {Promise}
* @returns {Promise<any>}
*/
@Cordova({
successIndex: 3,
@@ -104,7 +104,7 @@ export class SocialSharing {
* @param image {string}
* @param url {string}
* @param pasteMessageHint {string}
* @returns {Promise}
* @returns {Promise<any>}
*/
@Cordova({
successIndex: 4,
@@ -117,7 +117,7 @@ export class SocialSharing {
* Shares directly to Instagram
* @param message {string}
* @param image {string}
* @returns {Promise}
* @returns {Promise<any>}
*/
@Cordova({
platforms: ['iOS', 'Android']
@@ -129,7 +129,7 @@ export class SocialSharing {
* @param message {string}
* @param image {string}
* @param url {string}
* @returns {Promise}
* @returns {Promise<any>}
*/
@Cordova({
successIndex: 3,
@@ -144,7 +144,7 @@ export class SocialSharing {
* @param message {string} Message to send
* @param image {string} Image to send (does not work on iOS
* @param url {string} Link to send
* @returns {Promise}
* @returns {Promise<any>}
*/
@Cordova({
successIndex: 4,
@@ -157,7 +157,7 @@ export class SocialSharing {
* Share via SMS
* @param messge {string} message to send
* @param phoneNumber {string} Number or multiple numbers seperated by commas
* @returns {Promise}
* @returns {Promise<any>}
*/
@Cordova({
platforms: ['iOS', 'Android']
@@ -166,7 +166,7 @@ export class SocialSharing {
/**
* Checks if you can share via email
* @returns {Promise}
* @returns {Promise<any>}
*/
@Cordova({
platforms: ['iOS', 'Android']
@@ -181,7 +181,7 @@ export class SocialSharing {
* @param cc {string[]} Optional
* @param bcc {string[]} Optional
* @param files {string|string[]} Optional URL or local path to file(s) to attach
* @returns {Promise}
* @returns {Promise<any>}
*/
@Cordova({
platforms: ['iOS', 'Android'],
@@ -197,7 +197,7 @@ export class SocialSharing {
* @param subject {string}
* @param image {string}
* @param url {string}
* @returns {Promise}
* @returns {Promise<any>}
*/
@Cordova({
successIndex: 5,