feat(launch-navigator): update plugin wrapper to support v4
closes #1738
This commit is contained in:
Ibby Hadeed
parent
76a45a3834
commit
953841681c
@ -1,10 +1,125 @@
|
||||
import { Injectable } from '@angular/core';
|
||||
import { Cordova, Plugin, IonicNativePlugin } from '@ionic-native/core';
|
||||
|
||||
export interface PromptsOptions {
|
||||
|
||||
/**
|
||||
* a function to pass the user's decision whether to remember their choice of app.
|
||||
* This will be passed a single boolean value indicating the user's decision.
|
||||
* @param rememberChoice
|
||||
*/
|
||||
callback?: (rememberChoice: boolean) => void;
|
||||
|
||||
/**
|
||||
* text to display in the native prompt header asking user whether to remember their choice.
|
||||
* Defaults to "Remember your choice?" if not specified.
|
||||
*/
|
||||
headerText?: string;
|
||||
|
||||
/**
|
||||
* text to display in the native prompt body asking user whether to remember their choice.
|
||||
* Defaults to "Use the same app for navigating next time?" if not specified.
|
||||
*/
|
||||
bodyText?: string;
|
||||
|
||||
|
||||
/**
|
||||
* text to display for the Yes button.
|
||||
* Defaults to "Yes" if not specified.
|
||||
*/
|
||||
yesButtonText?: string;
|
||||
|
||||
/**
|
||||
* text to display for the No button.
|
||||
* Defaults to "No" if not specified.
|
||||
*/
|
||||
noButtonText?: string;
|
||||
}
|
||||
|
||||
export interface RememberChoiceOptions {
|
||||
|
||||
/**
|
||||
* whether to remember user choice of app for next time, instead of asking again for user choice.
|
||||
* `"prompt"` - Prompt user to decide whether to remember choice.
|
||||
* - Default value if unspecified.
|
||||
* - If `promptFn` is defined, this will be used for user confirmation.
|
||||
* - Otherwise (by default), a native dialog will be displayed to ask user.
|
||||
* `false` - Do not remember user choice.
|
||||
* `true` - Remember user choice.
|
||||
*/
|
||||
enabled?: boolean | string;
|
||||
|
||||
|
||||
/**
|
||||
* a function which asks the user whether to remember their choice of app.
|
||||
* If this is defined, then the default dialog prompt will not be shown, allowing for a custom UI for asking the user.
|
||||
* This will be passed a callback function which should be invoked with a single boolean argument which indicates the user's decision to remember their choice.
|
||||
* @param callback
|
||||
*/
|
||||
promptFn?: (callback: (rememberChoice: boolean) => void) => void;
|
||||
|
||||
/**
|
||||
* options related to the default dialog prompt used to ask the user whether to remember their choice of app.
|
||||
*/
|
||||
prompt?: PromptsOptions;
|
||||
}
|
||||
|
||||
export interface AppSelectionOptions {
|
||||
/**
|
||||
* text to display in the native picker which enables user to select which navigation app to launch.
|
||||
* Defaults to "Select app for navigation" if not specified.
|
||||
*/
|
||||
dialogHeaderText?: string;
|
||||
|
||||
/**
|
||||
* text to display for the cancel button in the native picker which enables user to select which navigation app to launch.
|
||||
* Defaults to "Cancel" if not specified.
|
||||
*/
|
||||
cancelButtonText?: string;
|
||||
|
||||
/**
|
||||
* List of apps, defined as `launchnavigator.APP` constants, which should be displayed in the picker if the app is available.
|
||||
* This can be used to restrict which apps are displayed, even if they are installed.
|
||||
* By default, all available apps will be displayed.
|
||||
*/
|
||||
list?: string[];
|
||||
|
||||
/**
|
||||
* Callback to invoke when the user selects an app in the native picker.
|
||||
* A single string argument is passed which is the app what was selected defined as a `launchnavigator.APP` constant.
|
||||
*/
|
||||
callback?: (app: string) => void;
|
||||
|
||||
/**
|
||||
* (Android only) native picker theme. Specify using `actionsheet.ANDROID_THEMES` constants.
|
||||
* Default `actionsheet.ANDROID_THEMES.THEME_HOLO_LIGHT`
|
||||
*/
|
||||
androidTheme?: number;
|
||||
|
||||
/**
|
||||
* options related to whether to remember user choice of app for next time, instead of asking again for user choice.
|
||||
*/
|
||||
rememberChoice?: RememberChoiceOptions;
|
||||
}
|
||||
|
||||
export interface LaunchNavigatorOptions {
|
||||
|
||||
/**
|
||||
* name of the navigation app to use for directions. Specify using launchnavigator.APP constants. If not specified, defaults to User Selection.
|
||||
* A callback to invoke when the navigation app is successfully launched.
|
||||
*/
|
||||
successCallback?: Function;
|
||||
|
||||
/**
|
||||
* A callback to invoke if an error is encountered while launching the app.
|
||||
* A single string argument containing the error message will be passed in.
|
||||
*/
|
||||
errorCallback?: (error: string) => void;
|
||||
|
||||
/**
|
||||
* name of the navigation app to use for directions.
|
||||
* Specify using launchnavigator.APP constants.
|
||||
* e.g. `launchnavigator.APP.GOOGLE_MAPS`.
|
||||
* If not specified, defaults to User Selection.
|
||||
*/
|
||||
app?: string;
|
||||
|
||||
@ -14,7 +129,12 @@ export interface LaunchNavigatorOptions {
|
||||
destinationName?: string;
|
||||
|
||||
/**
|
||||
* Start point of the navigation
|
||||
* Start point of the navigation.
|
||||
* If not specified, the current device location will be used.
|
||||
* Either:
|
||||
* - a {string} containing the address. e.g. "Buckingham Palace, London"
|
||||
* - a {string} containing a latitude/longitude coordinate. e.g. "50.1. -4.0"
|
||||
* - an {array}, where the first element is the latitude and the second element is a longitude, as decimal numbers. e.g. [50.1, -4.0]
|
||||
*/
|
||||
start?: string | number[];
|
||||
|
||||
@ -39,23 +159,82 @@ export interface LaunchNavigatorOptions {
|
||||
extras?: any;
|
||||
|
||||
/**
|
||||
* (Android only) mode in which to open Google Maps app: "maps" or "turn-by-turn". Defaults to "maps" if not specified. Specify using launchnavigator.LAUNCH_MODE constants.
|
||||
* (Android only) mode in which to open Google Maps app.
|
||||
* `launchnavigator.LAUNCH_MODE.MAPS` or `launchnavigator.LAUNCH_MODE.TURN_BY_TURN`
|
||||
* Defaults to `launchnavigator.LAUNCH_MODE.MAPS` if not specified.
|
||||
*/
|
||||
launchMode?: string;
|
||||
launchModeGoogleMaps?: string;
|
||||
|
||||
/**
|
||||
* text to display in the native picker which enables user to select which navigation app to launch. Defaults to "Select app for navigation" if not specified.
|
||||
* (iOS only) method to use to open Apple Maps app.
|
||||
* `launchnavigator.LAUNCH_MODE.URI_SCHEME` or `launchnavigator.LAUNCH_MODE.MAPKIT`
|
||||
* Defaults to `launchnavigator.LAUNCH_MODE.URI_SCHEME` if not specified.
|
||||
*/
|
||||
appSelectionDialogHeader?: string;
|
||||
launchModeAppleMaps?: string;
|
||||
|
||||
|
||||
/**
|
||||
* text to display for the cancel button in the native picker which enables user to select which navigation app to launch. Defaults to "Cancel" if not specified.
|
||||
* If true, and input location type(s) doesn't match those required by the app, use geocoding to obtain the address/coords as required. Defaults to true.
|
||||
*/
|
||||
appSelectionCancelButton?: string;
|
||||
enableGeolocation?: boolean;
|
||||
|
||||
successCallback?: Function;
|
||||
/**
|
||||
* options related to the default native actionsheet picker which enables user to select which navigation app to launch if `app` is not specified.
|
||||
*/
|
||||
appSelection?: AppSelectionOptions;
|
||||
}
|
||||
|
||||
errorCallback?: Function;
|
||||
export interface UserChoice {
|
||||
|
||||
/**
|
||||
* Indicates whether a user choice exists for a preferred navigator app.
|
||||
* @param callback - function to pass result to: will receive a boolean argument.
|
||||
*/
|
||||
exists: (callback: (exists: boolean) => void) => void;
|
||||
|
||||
/**
|
||||
* Returns current user choice of preferred navigator app.
|
||||
* @param callback - function to pass result to: will receive a string argument indicating the app, which is a constant in `launchnavigator.APP`.
|
||||
*/
|
||||
get: (callback: (app: string) => void) => void;
|
||||
|
||||
/**
|
||||
* Sets the current user choice of preferred navigator app.
|
||||
* @param app - app to set as preferred choice as a constant in `launchnavigator.APP`.
|
||||
* @param callback - function to call once operation is complete.
|
||||
*/
|
||||
set: (app: string, callback: () => void) => void;
|
||||
|
||||
/**
|
||||
* Clears the current user choice of preferred navigator app.
|
||||
* @param callback - function to call once operation is complete.
|
||||
*/
|
||||
clear: (callback: () => void) => void;
|
||||
}
|
||||
|
||||
export interface UserPrompted {
|
||||
/**
|
||||
* Indicates whether user has already been prompted whether to remember their choice a preferred navigator app.
|
||||
* @param callback - function to pass result to: will receive a boolean argument.
|
||||
*/
|
||||
get: (callback: (exists: boolean) => void) => void;
|
||||
|
||||
/**
|
||||
* Sets flag indicating user has already been prompted whether to remember their choice a preferred navigator app.
|
||||
* @param callback - function to call once operation is complete.
|
||||
*/
|
||||
set: ( callback: () => void) => void;
|
||||
|
||||
/**
|
||||
* Clears flag which indicates if user has already been prompted whether to remember their choice a preferred navigator app.
|
||||
* @param callback - function to call once operation is complete.
|
||||
*/
|
||||
clear: ( callback: () => void) => void;
|
||||
}
|
||||
|
||||
export interface AppSelection {
|
||||
userChoice: UserChoice;
|
||||
userPrompted: UserPrompted;
|
||||
}
|
||||
|
||||
/**
|
||||
@ -86,6 +265,12 @@ export interface LaunchNavigatorOptions {
|
||||
* ```
|
||||
* @interfaces
|
||||
* LaunchNavigatorOptions
|
||||
* PromptsOptions
|
||||
* RememberChoiceOptions
|
||||
* AppSelectionOptions
|
||||
* UserChoice
|
||||
* UserPrompted
|
||||
* AppSelection
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'LaunchNavigator',
|
||||
@ -131,10 +316,7 @@ export class LaunchNavigator extends IonicNativePlugin {
|
||||
successIndex: 1,
|
||||
errorIndex: 2
|
||||
})
|
||||
navigate(
|
||||
destination: string | number[],
|
||||
options?: LaunchNavigatorOptions
|
||||
): Promise<any> { return; }
|
||||
navigate(destination: string | number[], options?: LaunchNavigatorOptions): Promise<any> { return; }
|
||||
|
||||
/**
|
||||
* Determines if the given app is installed and available on the current device.
|
||||
@ -186,14 +368,12 @@ export class LaunchNavigator extends IonicNativePlugin {
|
||||
getTransportModes(app: string, platform: string): string[] { return; }
|
||||
|
||||
/**
|
||||
* Indicates if an app on a given platform supports specification of launch mode.
|
||||
* Note that currently only Google Maps on Android does.
|
||||
* @param app {string}
|
||||
* @param platform {string}
|
||||
* @returns {boolean}
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
supportsLaunchMode(app: string, platform: string): boolean { return; }
|
||||
supportsDestName(app: string, platform: string): boolean { return; }
|
||||
|
||||
/**
|
||||
* Indicates if an app on a given platform supports specification of start location.
|
||||
@ -213,18 +393,21 @@ export class LaunchNavigator extends IonicNativePlugin {
|
||||
supportsStartName(app: string, platform: string): boolean { return; }
|
||||
|
||||
/**
|
||||
* Indicates if an app on a given platform supports specification of launch mode.
|
||||
* Note that currently only Google Maps on Android does.
|
||||
* @param app {string}
|
||||
* @param platform {string}
|
||||
* @returns {boolean}
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
supportsDestName(app: string, platform: string): boolean { return; }
|
||||
supportsLaunchMode(app: string, platform: string): boolean { return; }
|
||||
|
||||
/**
|
||||
* @param destination {string | number[]}
|
||||
* @param options {LaunchNavigatorOptions}
|
||||
*/
|
||||
@Cordova({ sync: true })
|
||||
userSelect(destination: string | number[], options: LaunchNavigatorOptions): void { }
|
||||
userSelect(destination: string | number[], options: LaunchNavigatorOptions): void {}
|
||||
|
||||
appSelection: AppSelection;
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user