149 lines
6.0 KiB
TypeScript
149 lines
6.0 KiB
TypeScript
import { Injectable } from '@angular/core';
|
|
import { Cordova, Plugin, IonicNativePlugin } from '@ionic-native/core';
|
|
|
|
/**
|
|
* @name Globalization
|
|
* @description
|
|
* @usage
|
|
* ```typescript
|
|
* import { Globalization } from '@ionic-native/globalization';
|
|
*
|
|
* constructor(private globalization: Globalization) { }
|
|
*
|
|
*
|
|
* ...
|
|
*
|
|
*
|
|
* this.globalization.getPreferredLanguage()
|
|
* .then(res => console.log(res))
|
|
* .catch(e => console.log(e));
|
|
*
|
|
*
|
|
* ```
|
|
*/
|
|
@Plugin({
|
|
pluginName: 'Globalization',
|
|
plugin: 'cordova-plugin-globalization',
|
|
pluginRef: 'navigator.globalization',
|
|
repo: 'https://github.com/apache/cordova-plugin-globalization',
|
|
platforms: ['Amazon Fire OS', 'Android', 'Browser', 'iOS', 'Windows']
|
|
})
|
|
@Injectable()
|
|
export class Globalization extends IonicNativePlugin {
|
|
|
|
/**
|
|
* Returns the BCP-47 compliant language identifier tag to the successCallback with a properties object as a parameter. That object should have a value property with a String value.
|
|
* @returns {Promise<{value: string}>}
|
|
*/
|
|
@Cordova()
|
|
getPreferredLanguage(): Promise<{ value: string }> { return; }
|
|
|
|
/**
|
|
* Returns the BCP 47 compliant locale identifier string to the successCallback with a properties object as a parameter.
|
|
* @returns {Promise<{value: string}>}
|
|
*/
|
|
@Cordova()
|
|
getLocaleName(): Promise<{ value: string }> { return; }
|
|
|
|
/**
|
|
* Converts date to string
|
|
* @param {Date} date Date you wish to convert
|
|
* @param options Options for the converted date. Length, selector.
|
|
* @returns {Promise<{value: string}>} Returns a promise when the date has been converted.
|
|
*/
|
|
@Cordova({
|
|
successIndex: 1,
|
|
errorIndex: 2
|
|
})
|
|
dateToString(date: Date, options: { formatLength: string, selector: string }): Promise<{ value: string }> { return; }
|
|
|
|
/**
|
|
* Parses a date formatted as a string, according to the client's user preferences and calendar using the time zone of the client, and returns the corresponding date object.
|
|
* @param {string} dateString Date as a string to be converted
|
|
* @param options Options for the converted date. Length, selector.
|
|
* @returns {Promise<{ year: number, month: number, day: number, hour: number, minute: number, second: number, millisecond: number }>} Returns a promise when the date has been converted.
|
|
*/
|
|
@Cordova({
|
|
successIndex: 1,
|
|
errorIndex: 2
|
|
})
|
|
stringToDate(dateString: string, options: { formatLength: string, selector: string }): Promise<{ year: number, month: number, day: number, hour: number, minute: number, second: number, millisecond: number }> { return; }
|
|
|
|
/**
|
|
* Returns a pattern string to format and parse dates according to the client's user preferences.
|
|
* @param options Object with the format length and selector
|
|
* @returns {Promise<{ pattern: string, timezone: string, utf_offset: number, dst_offset: number }>} Returns a promise.
|
|
*/
|
|
@Cordova({
|
|
callbackOrder: 'reverse'
|
|
})
|
|
getDatePattern(options: { formatLength: string, selector: string }): Promise<{ pattern: string, timezone: string, utf_offset: number, dst_offset: number }> { return; }
|
|
|
|
/**
|
|
* Returns an array of the names of the months or days of the week, depending on the client's user preferences and calendar.
|
|
* @param options Object with type (narrow or wide) and item (month or days).
|
|
* @returns {Promise<{value: Array<string>}>} Returns a promise.
|
|
*/
|
|
@Cordova({
|
|
callbackOrder: 'reverse'
|
|
})
|
|
getDateNames(options: { type: string, item: string }): Promise<{ value: Array<string> }> { return; }
|
|
|
|
/**
|
|
* Indicates whether daylight savings time is in effect for a given date using the client's time zone and calendar.
|
|
* @param {data} date Date to process
|
|
* @returns {Promise<{dst: string}>} reutrns a promise with the value
|
|
*/
|
|
@Cordova()
|
|
isDayLightSavingsTime(date: Date): Promise<{ dst: string }> { return; }
|
|
|
|
/**
|
|
* Returns the first day of the week according to the client's user preferences and calendar.
|
|
* @returns {Promise<{value: string}>} returns a promise with the value
|
|
*/
|
|
@Cordova()
|
|
getFirstDayOfWeek(): Promise<{ value: string }> { return; }
|
|
|
|
/**
|
|
* Returns a number formatted as a string according to the client's user preferences.
|
|
* @param numberToConvert {Number} The number to convert
|
|
* @param options {Object} Object with property `type` that can be set to: decimal, percent, or currency.
|
|
*/
|
|
@Cordova({
|
|
successIndex: 1,
|
|
errorIndex: 2
|
|
})
|
|
numberToString(numberToConvert: number, options: { type: string }): Promise<{ value: string }> { return; }
|
|
|
|
/**
|
|
*
|
|
* @param {string} stringToConvert String you want to conver to a number
|
|
* @param options The type of number you want to return. Can be decimal, percent, or currency.
|
|
* @returns {Promise<{ value: number | string }>} Returns a promise with the value.
|
|
*/
|
|
@Cordova({
|
|
successIndex: 1,
|
|
errorIndex: 2
|
|
})
|
|
stringToNumber(stringToConvert: string, options: { type: string }): Promise<{ value: number | string }> { return; }
|
|
|
|
/**
|
|
* Returns a pattern string to format and parse numbers according to the client's user preferences.
|
|
* @param options Can be decimal, percent, or currency.
|
|
* @returns {Promise<{ pattern: string, symbol: string, fraction: number, rounding: number, positive: string, negative: string, decimal: string, grouping: string }>}
|
|
*/
|
|
@Cordova({
|
|
callbackOrder: 'reverse'
|
|
})
|
|
getNumberPattern(options: { type: string }): Promise<{ pattern: string, symbol: string, fraction: number, rounding: number, positive: string, negative: string, decimal: string, grouping: string }> { return; }
|
|
|
|
/**
|
|
* Returns a pattern string to format and parse currency values according to the client's user preferences and ISO 4217 currency code.
|
|
* @param {string} currencyCode Currency Code.A
|
|
* @returns {Promise<{ pattern: string, code: string, fraction: number, rounding: number, decimal: number, grouping: string }>}
|
|
*/
|
|
@Cordova()
|
|
getCurrencyPattern(currencyCode: string): Promise<{ pattern: string, code: string, fraction: number, rounding: number, decimal: number, grouping: string }> { return; }
|
|
|
|
}
|