feat(HyperTrack): add plugin #1816
Conversation
| * @see {@link https://github.com/hypertrack/hypertrack-cordova/blob/master/www/HyperTrack.js#33|HyperTrack.js createAndAssignAction implementation} | ||
| * @see {@link https://docs.hypertrack.com/api/entities/action.html#the-action-object|HyperTrack API Documentation for Action} | ||
| * | ||
| * @usage |
There was a problem hiding this comment.
All usage examples should stay at the top, in the @Plugin() decorator's doc section.
There was a problem hiding this comment.
I see. I checked other plugins, (e.g. EstimoteBeacons) and followed that convention, but that's not a problem. Should be done in some minutes.
|
Let me know if anything else is needed before the PR is merged |
| /** | ||
| * Create a new user to identify the current device or get a user from a lookup id. | ||
| * | ||
| * @param {String} [name] User's name |
There was a problem hiding this comment.
The params are documented as optional, but the method signature defines them as mandatory. Please remove the brackets.
| plugin: 'cordova-plugin-hypertrack', | ||
| pluginRef: 'cordova.plugins.HyperTrack', | ||
| repo: 'https://github.com/hypertrack/hypertrack-cordova', | ||
| platforms: ['android'] |
There was a problem hiding this comment.
Capitalize the word android.
| * Returns given text. For testing purposes. | ||
| * | ||
| * @param {String} [text] Given text to print | ||
| * |
| * | ||
| * @description HyperTrack cordova plugin wrapper for Ionic Native. Location-based services provider. iOS is being implemented. | ||
| * | ||
| * @see {@link https://docs.hypertrack.com/sdks/cordova/reference.html#methods|Hypertrack Cordova Methods Reference} |
There was a problem hiding this comment.
Refrain from using @see and @link tags. They are not supported here. You can use Markdown to link to external resources if you need to.
There was a problem hiding this comment.
Should I stop using them throughout the whole file or only at the Plugin decorator?
| * @see {@link https://docs.hypertrack.com/sdks/android/setup.html#step-3-enable-location-permissions|HyperTrack Android SDK Setup} | ||
| */ | ||
| @Cordova({ | ||
| platforms: ['android'] |
There was a problem hiding this comment.
Since the plugin only supports Android platform, there is no need to define this here as well.
There was a problem hiding this comment.
I have been in touch with the maintainer of the HyperTrack cordova plugin, and iOS support is coming soon, however the methods that I specified that they only work on Android will most probably only be available for Android, even when iOS support comes. This is: checkLocationPermission, requestPermissions, checkLocationServices, and requestLocationServices will only work in Android even when iOS is supported.
This is the reason why I specified it, but I can erase it, and once iOS is supported it can be put back.
There was a problem hiding this comment.
The config passed to @Plugin() indicates that Android is the only supported platform.
|
@K1N5L4Y3R just submitted a new review. Once you fix those issues, I will review it once more to make sure that the signatures match the original plugin. |
|
Looks good now. |
|
Great, thanks! Just wondering, what does the beta tag do? and approx. when can I expect to see this plugin in a release? |
|
Should be released over the next few days (maybe today). The beta tags marks it as a beta plugin I'm the docs. This is because it's a new plugin and it's hasn't proven relibility yet. |
* feat(HyperTrack): add base implementation for HyperTrack * feat(HyperTrack): fix getOrCreateUser() * docs(HyperTrack): add note about publishable key * feat(HyperTrack): add requestPermissions * feat(HyperTrack): add startTracking * docs(HyperTrack): add usage for calls * feat(HyperTrack): add stopTracking * docs(HyperTrack): add stopTracking note * feat(HyperTrack): add setUserId * feat(HyperTrack): add getCurrentLocation * style(HyperTrack): reorder functions * feat(HyperTrack): add createAndAssignAction * feat(HyperTrack): add completeAction * feat(HyperTrack): add completeActionWithLookupId * feat(HyperTrack): add checkLocationPermission * docs(HyperTrack): add usage for requestPermissions * docs(HyperTrack): add android note * feat(HyperTrack): add checkLocationServices * feat(HyperTrack): add requestLocationServices * feat(HyperTrack): add base implementation for HyperTrack * feat(HyperTrack): fix getOrCreateUser() * docs(HyperTrack): add note about publishable key * feat(HyperTrack): add requestPermissions * feat(HyperTrack): add startTracking * docs(HyperTrack): add usage for calls * feat(HyperTrack): add stopTracking * docs(HyperTrack): add stopTracking note * feat(HyperTrack): add setUserId * feat(HyperTrack): add getCurrentLocation * style(HyperTrack): reorder functions * feat(HyperTrack): add createAndAssignAction * feat(HyperTrack): add completeAction * feat(HyperTrack): add completeActionWithLookupId * feat(HyperTrack): add checkLocationPermission * docs(HyperTrack): add usage for requestPermissions * docs(HyperTrack): add android note * feat(HyperTrack): add checkLocationServices * feat(HyperTrack): add requestLocationServices * docs(HyperTrack): Fix plugin usage * fix(HyperTrack): helloWorld param and docs * docs(HyperTrack): document all functions * docs(HyperTrack): move all usage documentation up * docs(HyperTrack): fix documentation * Add beta tag
Plugin that helps with location based services (i.e. track users, assign tasks, etc)