applican/アプリカン

Tutorialチュートリアル

applican-config.xmlについて

アプリカンではwebディレクトリ内に、index.html、applican-{version}.js、applican-config.xmlの3つのファイルが必要になります。
ここではアプリケーションの設定情報を記述するapplican-config.xmlについて説明します。

applican-config.xmlはXML形式の設定ファイルです。以下は設定例です。

<applican-configuration>
	<property name="BEACON_CONFIG_FILENAME">http://yourdomain/yourbeacon-config.xml</property>

	<property name="GOOGLE_ANALYTICS_DISPATCH_PERIOD">30</property>
	<property name="GOOGLE_ANALYTICS_TRACKING">false</property>
	<property name="GOOGLE_ANALYTICS_TRACKING_ID">UA-xxxxxxx-x</property>
	
	<property name="KEEP_SCREEN_ON">false</property>
	<property name="MEDIA_PLAYBACK_REQUIRES_USER_ACTION">false</property>
	
	<property name="NATIVE_SLIDE_MENU">false</property>
	<property name="NATIVE_SLIDE_MENU_DEFAULT_COUNT">0</property>
	<property name="NATIVE_SLIDE_MENU_DEFAULT_IMAGES">
		menu1,menu2,menu3,menu4,menu5
	</property>
	<property name="NATIVE_SLIDE_MENU_DEFAULT_RESET">false</property>
	<property name="NATIVE_SLIDE_MENU_DEFAULT_URLS">
		index.html,http://www.google.co.jp/,tab3.html,tab4.html,test/tab5.html
	</property>
	<property name="NATIVE_SLIDE_MENU_HEIGHT">40</property>
	<property name="NATIVE_SLIDE_MENU_POSITION">left</property>
	<property name="NATIVE_SLIDE_MENU_WIDTH">80</property>

	<property name="NATIVE_TAB_AUTO_RELOAD">false</property>
	<property name="NATIVE_TAB_AUTO_RELOAD1">false</property>
	<property name="NATIVE_TAB_AUTO_RELOAD2">true</property>
	<property name="NATIVE_TAB_AUTO_RELOAD3">false</property>
	<property name="NATIVE_TAB_AUTO_RELOAD4">false</property>
	<property name="NATIVE_TAB_AUTO_RELOAD5">false</property>
	<property name="NATIVE_TAB_BAR">false</property>
	<property name="NATIVE_TAB_BADGE_TEXT_COLOR">#ffffff</property>
	<property name="NATIVE_TAB_COUNT">0</property>
	<property name="NATIVE_TAB_DEFAULT_URL"></property>
	<property name="NATIVE_TAB_HEIGHT">40</property>
	<property name="NATIVE_TAB_POSITION">bottom</property>
	<property name="NATIVE_TAB_TAP_RELOAD">false</property>
	<property name="NATIVE_TAB_URL1">index.html</property>
	<property name="NATIVE_TAB_URL2">http://www.google.co.jp/</property>
	<property name="NATIVE_TAB_URL3">tab3.html</property>
	<property name="NATIVE_TAB_URL4">tab4.html</property>
	<property name="NATIVE_TAB_URL5">test/tab5.html</property>
	
	<property name="NAVIGATION_BAR">true</property>
	
	<property name="PULL_TO_REFRESH">true</property>
	
	<property name="RESUME_RELOAD">false</property>
	
	<property name="SCREEN_ORIENTATION_LANDSCAPE">true</property>
	<property name="SCREEN_ORIENTATION_PORTRAIT">true</property>
	
	<property name="STATUS_BAR">true</property>
	<property name="STATUS_BAR_OVERLAY">false</property>
	<property name="STATUS_BAR_STYLE">light</property>
		
	<property name="SYSTEM_UI_KEEP_IMMERSIVE">false</property>
	<property name="SYSTEM_UI_NAVIGATION_BAR">true</property>
	
	<property name="WEBVIEW_BOUNCES">true</property>
	<property name="WEBVIEW_BACK">true</property>
	<property name="WEBVIEW_HARDWARE_BACK_BUTTON">true</property>
	<property name="WEBVIEW_USER_AGENT"></property>
</applican-configuration>

設定可能な項目と説明 _{※アルファベット順}

属性名・説明	設定値	デフォルト値	iOS	Android
BEACON_CONFIG_FILENAME beacon設定が記載されたXMLファイルのURLを指定します。省略した場合はbeacon-config.xmlが読み込まれます。ファイル名は自由に設定できます。	string	-	○	○
GOOGLE_ANALYTICS_DISPATCH_PERIOD アクセスログを送信する頻度を指定します。( 秒 )	Number	30	○	○
GOOGLE_ANALYTICS_TRACKING Google Analyticsを有効にします。	boolean	false	○	○
GOOGLE_ANALYTICS_TRACKING_ID Google社が発行するトラッキングIDを指定します。	string	-	○	○
KEEP_SCREEN_ON 画面が端末の設定によってOFFにならないように制御します。( 常時ONにします )	boolean	false	○	○
MEDIA_PLAYBACK_REQUIRES_USER_ACTION <audio>タグと<video>タグでのautoplay属性を制御します。falseの場合は自動で再生が始まります。	boolean	true	○	×
NATIVE_SLIDE_MENU スライドメニューを表示します。	boolean	false	○	○
NATIVE_SLIDE_MENU_DEFAULT_COUNT 初期表示するメニューの数を指定します。	number	0	○	○
NATIVE_SLIDE_MENU_DEFAULT_IMAGES slide_menuフォルダに配置した画像の、画像IDをカンマ区切りで指定します。	string	-	○	○
NATIVE_SLIDE_MENU_DEFAULT_RESET trueの場合、コンテンツの更新時にスライドメニューをapplican-config.xmlの設定値で初期化します。	boolean	false	○	○
NATIVE_SLIDE_MENU_DEFAULT_URLS メニューを選択した際に開くページのURLをカンマ区切りで指定します。	string	-	○	○
NATIVE_SLIDE_MENU_HEIGHT メニューの高さを指定します。	number	40	○	○
NATIVE_SLIDE_MENU_POSITION メニューの表示位置を指定します。	string	left	○	○
NATIVE_SLIDE_MENU_WIDTH メニューの幅を指定します。	number	80	○	○
NATIVE_TAB_AUTO_RELOAD(x) タブを開いた際にページを自動でリロードする。	boolean	false	○	○
NATIVE_TAB_BAR ネイティブタブを表示します。	boolean	false	○	○
NATIVE_TAB_BADGE_TEXT_COLOR タブ上にバッジを表示する際の文字色を指定します。	string	#ffffff	○	○
NATIVE_TAB_COUNT タブの数(2-5)を指定します。	number	0	○	○
NATIVE_TAB_DEFAULT_URL アプリ起動時のタブの初回表示ページを指定します。この属性を設定しないか、値を空にした場合は、初回表示ページの機能は使用しません。	string	-	○	○
NATIVE_TAB_HEIGHT タブの高さを指定します。	number	40	○	○
NATIVE_TAB_POSITION タブの表示位置を指定します。( top 又は buttomを設定できます。 )	string	bottom	○	○
NATIVE_TAB_TAP_RELOAD アクティブなタブをタップした場合にリロードします。	boolean	false	○	○
NATIVE_TAB_URL( X ) タブに割り当てるHTMLファイルを指定します。 ( Xはタブに応じて数値を指定します )	string	-	○	○
NAVIGATION_BAR 下部のナビゲーションを表示します。	boolean	true	○	○
PULL_TO_REFRESH 画面を引っぱり、画面をリフレッシュします。	boolean	true	○	○
RESUME_RELOAD アプリケーションを再開したときにリロードします。	boolean	false	○	○
SCREEN_ORIENTATION_LANDSCAPE 横向きの表示を許可します。	boolean	true	○	○
SCREEN_ORIENTATION_PORTRAIT 縦向きの表示を許可します。	boolean	true	○	○
STATUS_BAR 電波状況、電池残量、時刻等の端末自身のステータスバー表示します。	boolean	true	○	○
STATUS_BAR_OVERLAY ステータスバーを透過にします。	boolean	false	○	○
STATUS_BAR_STYLE 「light」または「dark」を設定できます。	string	light	○	×
SYSTEM_UI_KEEP_IMMERSIVE Androidのシステムナビゲーションバーを再表示させません。画面外からスワイプすることで再びシステムナビゲーションバーが再表示されます。この際、このプロパティーが true の場合はしばらくすると再びシステムナビゲーションバーが非表示になります。 false の場合は一度システムナビゲーションバーが表示されると表示されたままになります。	boolean	false	×	○
SYSTEM_UI_NAVIGATION_BAR Androidのシステムナビゲーションバーを表示します。このプロパティにSTATUS_BAR と SYSTEM_UI_KEEP_IMMERSIVE を組み合わせることによって完全なフルスクリーンにすることができます。	boolean	true	×	○
WEBVIEW_BOUNCES WebViewの跳ね返りを許可します。	boolean	true	○	×
WEBVIEW_BACK 戻るボタンを有効にします。	boolean	true	×	○
WEBVIEW_HARDWARE_BACK_BUTTON Android端末の戻るキーでブラウザバックさせるかどうかを制御します。 trueの場合は戻るボタンでブラウザバックします。 falseの場合は何もしません。デフォルトはtrueを使用します。	boolean	true	×	○
WEBVIEW_USER_AGENT WebViewのユーザエージェントを設定します。但し、設定したユーザエージェントの末尾に「APP_CLINET/WEBVIEW/APPLICAN」が自動的に付与されます。未設定の場合はWebViewの標準のユーザエージェントになります。	string	-	○	○

applican-config.xmlについて

設定可能な項目と説明 ※アルファベット順

設定可能な項目と説明 _{※アルファベット順}