cordova-plugin-apprate
Version:
This plugin provide the rate this app functionality into your Cordova/Phonegap application<br>
271 lines • 5.71 kB
HTML
<html>
<head>
<meta charset='UTF-8'>
<title>Documentation</title>
<script src='../javascript/application.js'></script>
<script src='../javascript/search.js'></script>
<link rel='stylesheet' href='../stylesheets/application.css' type='text/css'>
</head>
<body>
<div id='base' data-path='../'></div>
<div id='header'>
<div id='menu'>
<a href='../extra/README.md.html' title='../'>
../
</a>
»
<a href='../alphabetical_index.html' title='Index'>
Index
</a>
»
<span class='title'>Locales</span>
</div>
</div>
<div id='content'>
<h1>
Class:
Locales
</h1>
<table class='box'>
<tr>
<td>TypeScript defined in:</td>
<td>typescript/AppRate.d.ts</td>
</tr>
<tr>
<td>CoffeeScript defined in:</td>
<td>www_src/AppRate.coffee</td>
</tr>
</table>
<h2>Overview</h2>
<div class='docstring'>
<p>Collection of Locale objects</p>
</div>
<div class='tags'>
</div>
<h2>Class Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#addLocale-static'>
.
(Locale)
<b>addLocale</b><span>(localeObject)</span>
</a>
</span>
<span class='desc'>
Add locale to collection
</span>
</li>
<li>
<span class='signature'>
<a href='#getLocale-static'>
.
(Locale)
<b>getLocale</b><span>(language, applicationTitle = '')</span>
</a>
</span>
<span class='desc'>
Get locale from collection by language
</span>
</li>
<li>
<span class='signature'>
<a href='#getLocalesNames-static'>
.
(Array<String>)
<b>getLocalesNames</b><span>()</span>
</a>
</span>
<span class='desc'>
Get list of locales names
</span>
</li>
</ul>
<h2>Class Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='addLocale-static'>
.
(Locale)
<b>addLocale</b><span>(localeObject)</span>
<br>
</p>
<div class='docstring'>
<p>Add locale to collection</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>localeObject</span>
<span class='type'>
(
<tt><a href='../class/Locale.html'>Locale</a></tt>
)
</span>
</li>
</ul>
<h3>Returns:</h3>
<ul class='return'>
<li>
<span class='type'></span>
(
<tt><a href='../class/Locale.html'>Locale</a></tt>
)
—
<span class='desc'>Added locale object </span>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='getLocale-static'>
.
(Locale)
<b>getLocale</b><span>(language, applicationTitle = '')</span>
<br>
</p>
<div class='docstring'>
<p>Get locale from collection by language</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>language</span>
<span class='type'>
(
<tt>String</tt>
)
</span>
—
<span class='desc'>BCP 47 language tag </span>
</li>
<li>
<span class='name'>applicationTitle</span>
<span class='type'>
(
<tt>String</tt>
)
</span>
</li>
</ul>
<h3>Returns:</h3>
<ul class='return'>
<li>
<span class='type'></span>
(
<tt><a href='../class/Locale.html'>Locale</a></tt>
)
—
<span class='desc'>Locale object or null </span>
</li>
</ul>
<h3>See also:</h3>
<ul class='see'>
<li>
<a href='http://tools.ietf.org/html/bcp47'>http://tools.ietf.org/html/bcp47</a>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='getLocalesNames-static'>
.
(Array<String>)
<b>getLocalesNames</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>Get list of locales names</p>
</div>
<div class='tags'>
<h3>Returns:</h3>
<ul class='return'>
<li>
<span class='type'></span>
(
<tt>Array<String></tt>
)
—
<span class='desc'>List of locales names </span>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id='footer'>
February 07, 15 14:33:53 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>
2.0.9
✲
Press H to see the keyboard shortcuts
✲
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
✲
<a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a>
</div>
<iframe id='search_frame'></iframe>
<div id='fuzzySearch'>
<input type='text'>
<ol></ol>
</div>
<div id='help'>
<p>
Quickly fuzzy find classes, mixins, methods, file:
</p>
<ul>
<li>
<span>T</span>
Open fuzzy finder dialog
</li>
</ul>
<p>
Control the navigation frame:
</p>
<ul>
<li>
<span>L</span>
Toggle list view
</li>
<li>
<span>C</span>
Show class list
</li>
<li>
<span>I</span>
Show mixin list
</li>
<li>
<span>F</span>
Show file list
</li>
<li>
<span>M</span>
Show method list
</li>
<li>
<span>E</span>
Show extras list
</li>
</ul>
<p>
You can focus and blur the search input:
</p>
<ul>
<li>
<span>S</span>
Focus search input
</li>
<li>
<span>Esc</span>
Blur search input
</li>
</ul>
</div>
</body>
</html>