# [navigator]()
navigator用于管理瀏覽器運行環境信息
### 方法:
- [closeSplashscreen](http://www.dcloud.io/docs/api/zh_cn/navigator.shtml#plus.navigator.closeSplashscreen): 關閉程序啟動界面
- [isFullscreen](http://www.dcloud.io/docs/api/zh_cn/navigator.shtml#plus.navigator.isFullscreen): 判斷應用當前是否全屏模式顯示
- [setFullscreen](http://www.dcloud.io/docs/api/zh_cn/navigator.shtml#plus.navigator.setFullscreen): 設置應用是否全屏顯示
- [setStatusBarBackground](http://www.dcloud.io/docs/api/zh_cn/navigator.shtml#plus.navigator.setStatusBarBackground): 設置系統狀態欄背景顏色
- [getStatusBarBackground](http://www.dcloud.io/docs/api/zh_cn/navigator.shtml#plus.navigator.getStatusBarBackground): 獲取系統狀態欄背景顏色
- [setStatusBarStyle](http://www.dcloud.io/docs/api/zh_cn/navigator.shtml#plus.navigator.setStatusBarStyle): 設置系統狀態欄樣式
- [getStatusBarStyle](http://www.dcloud.io/docs/api/zh_cn/navigator.shtml#plus.navigator.getStatusBarStyle): 獲取系統狀態欄樣式
- [setUserAgent](http://www.dcloud.io/docs/api/zh_cn/navigator.shtml#plus.navigator.setUserAgent): 設置userAgent值
- [getUserAgent](http://www.dcloud.io/docs/api/zh_cn/navigator.shtml#plus.navigator.getUserAgent): 獲取userAgent值
- [setCookie](http://www.dcloud.io/docs/api/zh_cn/navigator.shtml#plus.navigator.setCookie): 設置Cookie值
- [getCookie](http://www.dcloud.io/docs/api/zh_cn/navigator.shtml#plus.navigator.getCookie): 獲取Cookie值
- [removeAllCookie](http://www.dcloud.io/docs/api/zh_cn/navigator.shtml#plus.navigator.removeAllCookie): 刪除應用所有Cookie值
- [removeCookie](http://www.dcloud.io/docs/api/zh_cn/navigator.shtml#plus.navigator.removeCookie): 刪除應用Cookie
- [removeSessionCookie](http://www.dcloud.io/docs/api/zh_cn/navigator.shtml#plus.navigator.removeSessionCookie): 刪除應用所有會話期Cookie值
# [closeSplashscreen]()
關閉程序啟動界面
~~~
void plus.navigator.closeSplashscreen();
~~~
### 說明:
很多情況下,程序啟動后需要一段時間加載數據,為了避免界面顯示空白內容,提高用戶體驗效果,這時可顯示啟動界面。 等數據加載完成后再關閉啟動界面進入應用,通常可在應用首界面加載數據完成并更新顯示內容后調用此方法。
### 參數:
無
### 返回值:
void : 無
### 示例:
~~~
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>navigator Example</title>
<script type="text/javascript">
// H5 plus事件處理
function plusReady(){
// 關閉程序啟動界面
plus.navigator.closeSplashscreen();
}
if(window.plus){
plusReady();
}else{
document.addEventListener("plusready",plusReady,false);
}
</script>
</head>
<body>
關閉程序啟動界面
</body>
</html>
~~~
# [isFullscreen]()
判斷應用當前是否全屏模式顯示
~~~
Boolean plus.navigator.isFullscreen();
~~~
### 參數:
無
### 返回值:
Boolean : 應用全屏模式顯示時返回true,否則返回false。
### 示例:
~~~
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>navigator Example</title>
<script type="text/javascript">
// H5 plus事件處理
function plusReady(){
// 是否全屏顯示
console.log( plus.navigator.isFullscreen()?"Fullscreen!":"Not fullscreen!" );
}
if(window.plus){
plusReady();
}else{
document.addEventListener("plusready",plusReady,false);
}
</script>
</head>
<body>
判斷應用當前是否全屏模式顯示
</body>
</html>
~~~
# [setFullscreen]()
設置應用是否全屏顯示
~~~
void plus.navigator.setFullscreen( fullscreen );
~~~
### 說明:
設置應用在全屏模式顯示時,將隱藏系統狀態欄,通常游戲類應用才會設置為全屏模式顯示。
### 參數:
- fullscreen: *( Boolean ) 必選 *是否全屏模式顯示
true表示全屏模式顯示,false表示非全屏模式顯示,默認為非全屏模式顯示。
### 返回值:
void : 無
### 示例:
~~~
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>navigator Example</title>
<script type="text/javascript">
// H5 plus事件處理
function plusReady(){
// 全屏顯示
plus.navigator.setFullscreen( true );
}
if(window.plus){
plusReady();
}else{
document.addEventListener("plusready",plusReady,false);
}
</script>
</head>
<body>
應用全屏模式顯示
</body>
</html>
~~~
# [setStatusBarBackground]()
設置系統狀態欄背景顏色
~~~
void plus.navigator.setStatusBarBackground( rgb );
~~~
### 說明:
設置應用在前臺運行時系統狀態欄的背景顏色,默認使用系統的白色背景。
### 參數:
- rgb: *( String ) 必選 *背景顏色字符串,格式為#RRGGBB
### 返回值:
void : 無
### 平臺支持:
- Android - 2.2+ (不支持): 不支持設置系統狀態欄背景顏色。
- iOS - 7.0+ (支持): 需iOS7.0及以上版本才支持設置系統狀態欄背景顏色。
### 示例:
~~~
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>navigator Example</title>
<script type="text/javascript">
// H5 plus事件處理
function plusReady(){
// 設置系統狀態欄背景為紅色
plus.navigator.setStatusBarBackground( "#FF0000" );
}
if(window.plus){
plusReady();
}else{
document.addEventListener("plusready",plusReady,false);
}
</script>
</head>
<body>
設置系統狀態欄背景為紅色
</body>
</html>
~~~
# [getStatusBarBackground]()
獲取系統狀態欄背景顏色
~~~
String plus.navigator.getStatusBarBackground();
~~~
### 說明:
獲取應用在前臺運行時系統狀態欄的背景顏色。
### 參數:
無
### 返回值:
String : 系統狀態欄的背景顏色,格式為#RRGGBB。
### 平臺支持:
- Android - 2.2+ (不支持): 不支持獲取系統狀態欄背景顏色。
- iOS - 7.0+ (支持): 需iOS7.0及以上版本才能獲取的正確的系統狀態欄背景顏色。
### 示例:
~~~
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>navigator Example</title>
<script type="text/javascript">
// H5 plus事件處理
function plusReady(){
// 設置系統狀態欄背景為紅色
var rgb = plus.navigator.getStatusBarBackground();
console.log( "StatusBarBackground: "+rgb );
}
if(window.plus){
plusReady();
}else{
document.addEventListener("plusready",plusReady,false);
}
</script>
</head>
<body>
設置系統狀態欄背景為紅色
</body>
</html>
~~~
# [setStatusBarStyle]()
設置系統狀態欄樣式
~~~
void plus.navigator.setStatusBarStyle( style );
~~~
### 說明:
設置應用在前臺運行時系統狀態欄的樣式,此操作是應用全局配置,Webview窗口關閉后仍然生效,默認值可在manifest.json中配置。
### 參數:
- style: *( String ) 必選 *背景顏色字符串,格式為#RRGGBB
可取值: "UIStatusBarStyleDefault":iOS6及以下系統狀態欄為黑底白字,iOS7及以上系統用于定義系統狀態欄上文字顏色為黑字(適用于淺色背景); "UIStatusBarStyleBlackOpaque":深色背景色樣式,iOS6及以下系統狀態欄為黑底白字,iOS7及以上系統用于定義系統狀態欄上文字顏色為白色(適用于深色背景); "UIStatusBarStyleBlackTranslucent":iOS6及以下系統在啟動界面為灰底白字,iOS7及以上系統與UIStatusBarStyleBlackOpaque效果一樣。
### 返回值:
void : 無
### 平臺支持:
- Android - 2.2+ (不支持): 不支持設置系統狀態欄樣式。
- iOS - 7.0+ (支持)
### 示例:
~~~
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>navigator Example</title>
<script type="text/javascript">
// H5 plus事件處理
function plusReady(){
// 設置系統狀態欄樣式為淺色文字
plus.navigator.setStatusBarStyle( "UIStatusBarStyleBlackOpaque" );
}
if(window.plus){
plusReady();
}else{
document.addEventListener("plusready",plusReady,false);
}
</script>
</head>
<body>
設置系統狀態欄樣式為淺色(白色)文字
</body>
</html>
~~~
# [getStatusBarStyle]()
獲取系統狀態欄樣式
~~~
String plus.navigator.getStatusBarStyle();
~~~
### 說明:
獲取應用在前臺運行時系統狀態欄的樣式。
### 參數:
無
### 返回值:
String : 系統狀態欄的背景樣式,可取值: "UIStatusBarStyleDefault":iOS6及以下系統狀態欄為黑底白字,iOS7及以上系統用于定義系統狀態欄上文字顏色為黑字(適用于淺色背景); "UIStatusBarStyleBlackOpaque":深色背景色樣式,iOS6及以下系統狀態欄為黑底白字,iOS7及以上系統用于定義系統狀態欄上文字顏色為白色(適用于深色背景); "UIStatusBarStyleBlackTranslucent":iOS6及以下系統在啟動界面為灰底白字,iOS7及以上系統不會返回此值。
### 平臺支持:
- Android - 2.2+ (不支持): 不支持獲取系統狀態欄樣式。
- iOS - 7.0+ (支持)
### 示例:
~~~
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>navigator Example</title>
<script type="text/javascript">
// H5 plus事件處理
function plusReady(){
// 設置系統狀態欄背景為紅色
var rgb = plus.navigator.getStatusBarBackground();
console.log( "StatusBarBackground: "+rgb );
}
if(window.plus){
plusReady();
}else{
document.addEventListener("plusready",plusReady,false);
}
</script>
</head>
<body>
設置系統狀態欄背景為紅色
</body>
</html>
~~~
# [setUserAgent]()
設置userAgent值
~~~
void plus.navigator.setUserAgent( useragent, checkplus );
~~~
### 說明:
設置應用通過navigator.userAgent獲取的值,及所有發起Http請求時提交的userAgent值。 如果要設置啟動頁面的userAgent值則需要在manifest.json中進行配置。
### 參數:
- useragent: *( String ) 必選 *要設置的新的userAgent值
- checkplus: *( Boolean ) 可選 *是否檢測userAgent中自動添加“Html5Plus”標識
布爾類型,true表示檢測并自動添加“Html5Plus”標識,false則不檢測,默認值為true。 Html5Plus標識格式為Html5Plus/%version%,%version%為版本號,目前為1.0,如" Html5Plus/1.0"。
### 返回值:
void : 無
### 平臺支持:
- Android - 2.2+ (支持): 調用此方法不能更新已經創建好的Webview窗口的userAgent,在此之后創建的Webview窗口將使用新設置的userAgent值。 同時調用此方法的Webview窗口也能及時更新userAgent值。
- iOS - 4.5+ (支持): 調用此方法不能更新已經創建好的Webview窗口的userAgent,在此之后創建的Webview窗口將使用新設置的userAgent值。 調用此方法的Webview窗口同樣不能更新userAgent值。
### 示例:
~~~
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>navigator Example</title>
<script type="text/javascript">
// H5 plus事件處理
function plusReady(){
// 設置userAgent
plus.navigator.setUserAgent( "Application/HelloWorld" );
}
if(window.plus){
plusReady();
}else{
document.addEventListener("plusready",plusReady,false);
}
</script>
</head>
<body>
設置userAgent為“Application/HelloWorld”
</body>
</html>
~~~
# [getUserAgent]()
獲取userAgent值
~~~
String plus.navigator.getUserAgent();
~~~
### 參數:
無
### 返回值:
string : 應用的userAgent值
### 示例:
~~~
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>navigator Example</title>
<script type="text/javascript">
// H5 plus事件處理
function plusReady(){
}
if(window.plus){
plusReady();
}else{
document.addEventListener("plusready",plusReady,false);
}
// 獲取應用的userAgent
function appUserAgent(){
alert( plus.navigator.getUserAgent() );
}
</script>
</head>
<body>
獲取userAgent值<br/>
<buttong onclick="appUserAgent()">Get userAgent</buttong>
</body>
</html>
~~~
# [setCookie]()
設置Cookie值
~~~
void plus.navigator.setCookie( url, value );
~~~
### 說明:
設置應用發起Http請求時提交的cookie值,調用此接口后所有的請求都生效。
### 參數:
- url: *( String ) 必選 *要設置的cookie所屬的網絡地址
- value: *( String ) 必選 *要設置的cookie值
cookie值的格式必需符合RFC2109中定義的SET-COOKIE響應數據格式,如“test=123; expires=Friday,24-Jan-2014 16:24:36 GMT; path=/”。
### 返回值:
void : 無
### 示例:
~~~
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>navigator Example</title>
<script type="text/javascript">
// H5 plus事件處理
function plusReady(){
// 設置cookie
plus.navigator.setCookie( "http://www.dcloud.io/", "test=123; expires=Friday,24-Jan-2015 16:24:36 GMT; path=/" );
}
if(window.plus){
plusReady();
}else{
document.addEventListener("plusready",plusReady,false);
}
</script>
</head>
<body>
設置cookie
</body>
</html>
~~~
# [getCookie]()
獲取Cookie值
~~~
String plus.navigator.getCookie( url );
~~~
### 參數:
- url: *( String ) 必選 *要獲取的cookie所屬的網絡地址
### 返回值:
string : Cookie值
### 示例:
~~~
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>navigator Example</title>
<script type="text/javascript">
// H5 plus事件處理
function plusReady(){
}
if(window.plus){
plusReady();
}else{
document.addEventListener("plusready",plusReady,false);
}
// 獲取Cookie
function getCookie(){
alert( plus.navigator.getCookie('http://www.dcloud.io/') );
}
</script>
</head>
<body>
獲取Cookie值<br/>
<buttong onclick="getCookie()">Get Cookie</buttong>
</body>
</html>
~~~
# [removeAllCookie]()
刪除應用所有Cookie值
~~~
void plus.navigator.removeAllCookie();
~~~
### 參數:
無
### 返回值:
void : 無
### 平臺支持:
- Android - 2.2+ (支持)
- iOS - 4.5+ (支持)
### 示例:
~~~
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>navigator Example</title>
<script type="text/javascript">
// H5 plus事件處理
function plusReady(){
}
if(window.plus){
plusReady();
}else{
document.addEventListener("plusready",plusReady,false);
}
// 清除應用的所有Cookie
function clearCookie(){
plus.navigator.removeAllCookie();
}
</script>
</head>
<body>
刪除應用所有Cookie值<br/>
<buttong onclick="clearCookie()">Clear Cookie</buttong>
</body>
</html>
~~~
# [removeCookie]()
刪除應用Cookie
~~~
void plus.navigator.removeCookie( url );
~~~
### 參數:
- url: *( String ) 必選 *要刪除cookie所屬的網絡地址
### 返回值:
void : 無
### 平臺支持:
- Android - 2.2+ (不支持): 不支持刪除指定網絡地址的cookie值。
- iOS - 4.5+ (支持)
### 示例:
~~~
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>navigator Example</title>
<script type="text/javascript">
// H5 plus事件處理
function plusReady(){
}
if(window.plus){
plusReady();
}else{
document.addEventListener("plusready",plusReady,false);
}
// 刪除應用的Cookie
function removeCookie(){
plus.navigator.removeCookie( "http://www.dcloud.io/" );
}
</script>
</head>
<body>
刪除應用Cookie<br/>
<buttong onclick="removeCookie()">Remove Cookie</buttong>
</body>
</html>
~~~
# [removeSessionCookie]()
刪除應用所有會話期Cookie值
~~~
void plus.navigator.removeSessionCookie();
~~~
### 參數:
無
### 返回值:
void : 無
### 平臺支持:
- Android - 2.2+ (支持)
- iOS - 4.5+ (支持)
### 示例:
~~~
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>navigator Example</title>
<script type="text/javascript">
// H5 plus事件處理
function plusReady(){
}
if(window.plus){
plusReady();
}else{
document.addEventListener("plusready",plusReady,false);
}
// 清除應用的所有會話期Cookie
function clearCookie(){
plus.navigator.removeSessionCookie();
}
</script>
</head>
<body>
刪除應用所有會話期Cookie值<br/>
<buttong onclick="clearCookie()">Clear Cookie</buttong>
</body>
</html>
~~~
- API參考
- Accelerometer
- Audio
- Camera
- Contacts
- Device
- Downloader
- Events
- Gallery
- Geolocation
- IO
- Key
- Messaging
- NativeUI
- Navigator
- Orientation
- Proximity
- SplashScreen
- Storage
- UI
- Uploader
- InterfaceOrientation
- Runtime
- WebView
- XMLHttpRequest
- Zip
- Plugins
- Barcode
- Maps
- Payment
- Push
- Share
- Speech
- Statistic
- Native.js
- Android
- iOS