awesome-cordova-plugins/src/plugins/globalization.ts

122 lines
2.9 KiB
TypeScript
Raw Normal View History

2016-03-13 16:08:39 +08:00
import {Plugin, Cordova} from './plugin';
/**
* @name Globalization
* @description
* @usage
*/
@Plugin({
plugin: 'cordova-plugin-globalization',
pluginRef: 'navigator.globalization',
repo: 'https://github.com/apache/cordova-plugin-globalization'
})
export class Globalization {
/**
* 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.
* @return {Promise<{value:string}>}
*/
@Cordova()
static getPreferredLanguage() : Promise<{value:string}> {return}
/**
* Returns the BCP 47 compliant locale identifier string to the successCallback with a properties object as a parameter.
* @return {Promise<{value:string}>}
*/
@Cordova()
static getLocaleName() : Promise<{value:string}> {return}
/**
* Converts date to string
* @param date
* @param options
* @return {Promise<{value:string}>}
*/
@Cordova({
successIndex: 1,
errorIndex: 2
})
static dateToString(date : Date, options : {formatLength:string, selector:string}) : Promise<{value:string}> {return}
/**
*
* @param dateString
* @param options
*/
@Cordova({
successIndex: 1,
errorIndex: 2
})
static stringToDate(dateString:string, options:{formatLength:string, selector:string}) : Promise<{year : number, month : number, day:number, hour:number, minute:number, second:number, millisecond:number}> {return}
/**
*
* @param options
*/
@Cordova({
callbackOrder: 'reverse'
})
static getDatePattern(options:{formatLength:string, selector:string}) : Promise<{pattern:string}> {return}
/**
*
* @param options
*/
@Cordova({
callbackOrder: 'reverse'
})
static getDateNames(options:{type,item}) : Promise<{value:Array<string>}> {return}
/**
* Check if day light saving is active
* @param date
*/
@Cordova()
static isDayLightSavingsTime(date:Date) : Promise<{dst:string}> {return}
/**
* Get first day of week
*/
@Cordova()
static getFirstDayOfWeek() : Promise<{value:string}> {return}
/**
*
* @param options
*/
@Cordova({
successIndex: 1,
errorIndex: 2
})
static numberToString(options:{type:string}) : Promise<{value:string}> {return}
/**
*
* @param string
* @param options
*/
@Cordova({
successIndex: 1,
errorIndex: 2
})
static stringToNumber(string:string, options:{type:string}) :Promise<{value}> {return}
/**
*
* @param options
*/
@Cordova({
callbackOrder: 'reverse'
})
static getNumberPattern(options:{type:string}) : Promise<{pattern:string, symbol:string, fraction:number, rounding:number, positive:string, negative:string, decimal:string, grouping:string}> {return}
/**
*
* @param currencyCode
*/
@Cordova()
static getCurrencyPattern(currencyCode:string) : Promise<{pattern, code, fraction, rounding, decimal, grouping}> {return}
}