関数

flamingoで利用できるAPI関数の一覧です。

関数	引数	返り値の型	説明
Flamingo.dataUrl()	なし	string	パブリックコンテンツへのパスを返します
Flamingo.getBuild()	なし	string	該当サイトのリリースバージョンを返します
Flamingo.getDocument()	なし	object	オリジナルサイトのDOM要素オブジェクト
Flamingo.getEncoding()	なし	string/null	該当サイトで使われている文字コードを返します（特定できなかった場合は、nullを返します）
Flamingo.switchType(viewType)	pc/mobile	なし	該当のページにおいてデスクトップとモバイル端末間で表示を切り替えるために使います
Flamingo.Device.isPhone()	なし	TREU/FALSE	クライアントユーザーのデバイスがスマートフォンの場合は、TRUEを返し、そうでない場合は FALSEを返します
Flamingo.Device.isTablet()	なし	TREU/FALSE	クライアントユーザーのデバイスがタブレットの場合は、TRUEを返し、そうでない場合は FALSEを返します
Flamingo.Device.isDesktop()	なし	TREU/FALSE	クライアントユーザーのデバイスがデスクトップの場合は、TRUEを返し、そうでない場合は FALSEを返します
Flamingo.Device.isType(deviceType)	phone/tablet	TREU/FALSE	クライアントユーザーのデバイスが引数で指定されたデバイスの場合、TRUEを返し、そうでない場合は FALSEを返します
Flamingo.Device.isPlatform(platformType)	android/ios	TREU/FALSE	クライアントユーザーのデバイスのOSが引数で指定されたOSの場合、TRUEを返し、そうでない場合は FALSEを返します
Flamingo.Device.getType()	なし	phone/tablet	クライアントユーザーのデバイスがスマートフォンの場合は phone という文字列を返し、タブレットの場合は tablet という文字列を返します
Flamingo.Device.getVersion()	なし	string	クライアントユーザーのデバイスのiOSまたはAndroidのOSバージョンを返します。
Flamingo.Device.getPlatform()	なし	android/ios	クライアントユーザーのデバイスのOSを返します
Flamingo.Utils.extend(target, options, deep)	object, object, TREU/FALSE	object	指定したJavaScriptオブジェクトに特定のプロパティセットを追加します。
Flamingo.Utils.encodeHTML(htmlString)	string	string	HTMLコードを文字実体参照に変換します
Flamingo.XPath.value(xPath, parent)	string/Node Object	string	XPathによって特定されるテキストノードの値を返します
Flamingo.XPath.test(xPath, parent)	string/Node Object	TREU/FALSE	XPathによって特定されるノードが存在する場合は TRUE を、存在しない場合は FALSE を返します
Flamingo.XPath.get(xPath, parent)	string/Node Object	Array	XPathによって特定されるノードを取得します
Flamingo.XPath.html(xPath, parent)	string/Node Object	string	XPathによって特定されるノードのHTMLコンテンツをプレーンテキストとして返します
Flamingo.XPath.innerHTML(xPath, parent)	string/Node Object	string	XPathによって特定されるノードのHTMLコンテンツの内容をプレーンテキストとして出力します

ちなみに、Flamingo.XPath のエイリアスとしてXを使用することができます。したがって、次の書き方はどちらも同じです。

Flamingo.XPath.value('//title')

X.value('//title')