github/awesome-cordova-plugins
github/awesome-cordova-plugins
3
0
Fork 1
mirror of https://github.com/danielsogl/awesome-cordova-plugins.git synced 2025-04-28 22:10:20 +08:00
Code Issues Projects Releases Wiki Activity

refactor(media): rename main class to Media (#1769)

Browse Source 
BREAKING CHANGE: `MediaObject` class is now `Media`
This commit is contained in:
Ibby Hadeed 2017-07-07 19:13:25 -04:00 committed by GitHub
parent 3c54a1c7f5
commit 9f1a0f9585
1 changed files with 9 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/@ionic-native/plugins/media/index.ts
View File

@ -1,9 +1,6 @@
import { Injectable } from '@angular/core'; import { Injectable } from '@angular/core';
import { CordovaInstance, Plugin, checkAvailability, IonicNativePlugin } from '@ionic-native/core'; import { CordovaInstance, Plugin, checkAvailability, IonicNativePlugin } from '@ionic-native/core';
declare const Media: any;
// TODO for ionic native 4.x ... rename plugin class to Media and use Media.getPlugin() to retrieve the original media object
/** /**
* @hidden * @hidden
*/ */
@ -129,12 +126,12 @@ export type MediaErrorCallback = (error: MediaError) => void;
* 2.) If that's not working, too, create the file before using. * 2.) If that's not working, too, create the file before using.
* Example: * Example:
* ```typescript * ```typescript
* import { MediaPlugin, MediaObject } from '@ionic-native/media'; * import { Media, MediaObject } from '@ionic-native/media';
* import { File } from '@ionic-native/file'; * import { File } from '@ionic-native/file';
* *
* ... * ...
* *
* constructor(private media: MediaPlugin, private file: File) { } * constructor(private media: Media, private file: File) { }
* *
* ... * ...
* *
@ -149,16 +146,16 @@ export type MediaErrorCallback = (error: MediaError) => void;
* *
* @usage * @usage
* ```typescript * ```typescript
* import { MediaPlugin, MediaObject } from '@ionic-native/media'; * import { Media, MediaObject } from '@ionic-native/media';
* *
* *
* constructor(private media: MediaPlugin) { } * constructor(private media: Media) { }
* *
* *
* ... * ...
* *
* *
* // Create a MediaPlugin instance. Expects path to file or url as argument * // Create a Media instance. Expects path to file or url as argument
* // We can optionally pass a second argument to track the status of the media * // We can optionally pass a second argument to track the status of the media
* *
* const onStatusUpdate = (status) => console.log(status); * const onStatusUpdate = (status) => console.log(status);
@ -211,14 +208,14 @@ export type MediaErrorCallback = (error: MediaError) => void;
* MediaError * MediaError
*/ */
@Plugin({ @Plugin({
pluginName: 'MediaPlugin', pluginName: 'Media',
repo: 'https://github.com/apache/cordova-plugin-media', repo: 'https://github.com/apache/cordova-plugin-media',
plugin: 'cordova-plugin-media', plugin: 'cordova-plugin-media',
pluginRef: 'Media', pluginRef: 'Media',
platforms: ['Android', 'BlackBerry 10', 'Browser', 'iOS', 'Tizen', 'Ubuntu', 'Windows', 'Windows Phone'] platforms: ['Android', 'BlackBerry 10', 'Browser', 'iOS', 'Tizen', 'Ubuntu', 'Windows', 'Windows Phone']
}) })
@Injectable() @Injectable()
export class MediaPlugin extends IonicNativePlugin { export class Media extends IonicNativePlugin {
// Constants // Constants
/** /**
@ -275,9 +272,9 @@ export class MediaPlugin extends IonicNativePlugin {
let instance: any; let instance: any;
if (checkAvailability(MediaPlugin.getPluginRef(), null, MediaPlugin.getPluginName()) === true) { if (checkAvailability(Media.getPluginRef(), null, Media.getPluginName()) === true) {
// Creates a new media object // Creates a new media object
instance = new Media(src, onSuccess, onError, onStatusUpdate); instance = new (Media.getPlugin())(src, onSuccess, onError, onStatusUpdate);
} }
return new MediaObject(instance); return new MediaObject(instance);