README.md 10.2 KB
Newer Older
李晓兵's avatar
李晓兵 committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
<!--
# license: Licensed to the Apache Software Foundation (ASF) under one
#         or more contributor license agreements.  See the NOTICE file
#         distributed with this work for additional information
#         regarding copyright ownership.  The ASF licenses this file
#         to you under the Apache License, Version 2.0 (the
#         "License"); you may not use this file except in compliance
#         with the License.  You may obtain a copy of the License at
#
#           http://www.apache.org/licenses/LICENSE-2.0
#
#         Unless required by applicable law or agreed to in writing,
#         software distributed under the License is distributed on an
#         "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
#         KIND, either express or implied.  See the License for the
#         specific language governing permissions and limitations
#         under the License.
-->

# cordova-plugin-dialogs

[![Build Status](https://travis-ci.org/apache/cordova-plugin-dialogs.svg)](https://travis-ci.org/apache/cordova-plugin-dialogs)

このプラグインは、グローバル `navigator.notification` オブジェクトを介していくつかネイティブ ダイアログの UI 要素へのアクセスを提供します。

オブジェクトは、グローバル スコープの `ナビゲーター` に添付、それがないまで `deviceready` イベントの後。

    document.addEventListener("deviceready", onDeviceReady, false);
    function onDeviceReady() {
        console.log(navigator.notification);
    }
    

## インストール

    cordova plugin add cordova-plugin-dialogs
    

## メソッド

  * `navigator.notification.alert`
  * `navigator.notification.confirm`
  * `navigator.notification.prompt`
  * `navigator.notification.beep`

## navigator.notification.alert

カスタムの警告またはダイアログ ボックスが表示されます。 ほとんどコルドバ ネイティブ] ダイアログ ボックスの使用この機能がいくつかのプラットフォームは通常小さいカスタマイズ可能なブラウザーの `警告` 機能を使用します。

    navigator.notification.alert(message, alertCallback, [title], [buttonName])
    

  * **メッセージ**: ダイアログ メッセージ。*(文字列)*

  * **alertCallback**: 警告ダイアログが閉じられたときに呼び出すコールバック。*(機能)*

  * **タイトル**: ダイアログのタイトル。*(文字列)*(省略可能、既定値は`Alert`)

  * **buttonName**: ボタンの名前。*(文字列)*(省略可能、既定値は`OK`)

### 例

    function alertDismissed() {
        // do something
    }
    
    navigator.notification.alert(
        'You are the winner!',  // message
        alertDismissed,         // callback
        'Game Over',            // title
        'Done'                  // buttonName
    );
    

### サポートされているプラットフォーム

  * アマゾン火 OS
  * アンドロイド
  * ブラックベリー 10
  * Firefox の OS
  * iOS
  * Tizen
  * Windows Phone 7 と 8
  * Windows 8
  * Windows

### Windows Phone 7 と 8 癖

  * 組み込みのブラウザー警告がない呼び出しを次のように 1 つをバインドすることができます `alert()` 、グローバル スコープで。
    
        window.alert = navigator.notification.alert;
        

  * 両方の `alert``confirm` は非ブロッキング呼び出し、結果は非同期的にのみ利用できます。

### Firefox OS 互換:

ネイティブ ブロック `window.alert()` と非ブロッキング `navigator.notification.alert()` があります。

### ブラックベリー 10 癖

`navigator.notification.alert ('text' コールバック 'title'、'text')` コールバック パラメーターは数 1 に渡されます。

## navigator.notification.confirm

カスタマイズ可能な確認のダイアログ ボックスが表示されます。

    navigator.notification.confirm(message, confirmCallback, [title], [buttonLabels])
    

  * **メッセージ**: ダイアログ メッセージ。*(文字列)*

  * **confirmCallback**: インデックス (1、2、または 3) を押されたボタンまたはダイアログ ボックスは、ボタンを押す (0) なしに解雇されたときに呼び出すコールバック。*(機能)*

  * **タイトル**: ダイアログのタイトル。*(文字列)*(省略可能、既定値は`Confirm`)

  * **buttonLabels**: ボタンのラベルを指定する文字列の配列。*(配列)*(省略可能、既定値は [ `OK,Cancel` ])

### confirmCallback

`confirmCallback` は、いずれかの確認ダイアログ ボックスでボタンを押したときに実行します。

コールバックは、引数 `buttonIndex` *(番号)* は、押されたボタンのインデックス。 インデックスがインデックス 1 ベースので、値は `1``2``3` などに注意してください。

### 例

    function onConfirm(buttonIndex) {
        alert('You selected button ' + buttonIndex);
    }
    
    navigator.notification.confirm(
        'You are the winner!', // message
         onConfirm,            // callback to invoke with index of button pressed
        'Game Over',           // title
        ['Restart','Exit']     // buttonLabels
    );
    

### サポートされているプラットフォーム

  * アマゾン火 OS
  * アンドロイド
  * ブラックベリー 10
  * Firefox の OS
  * iOS
  * Tizen
  * Windows Phone 7 と 8
  * Windows 8
  * Windows

### Windows Phone 7 と 8 癖

  * 組み込みブラウザーの機能はありません `window.confirm` が割り当てることによってバインドすることができます。
    
        window.confirm = navigator.notification.confirm;
        

  * 呼び出しを `alert``confirm` では非ブロッキング、結果は非同期的にのみ使用できます。

### Windows の癖

  * Windows8/8.1 の MessageDialog インスタンスを 3 つ以上のボタンを追加することはできません。

  * Windows Phone 8.1 に 2 つ以上のボタンを持つダイアログを表示することはできません。

### Firefox OS 互換:

ネイティブ ブロック `window.confirm()` と非ブロッキング `navigator.notification.confirm()` があります。

## navigator.notification.prompt

ブラウザーの `プロンプト` 機能より詳細にカスタマイズはネイティブのダイアログ ボックスが表示されます。

    navigator.notification.prompt(message, promptCallback, [title], [buttonLabels], [defaultText])
    

  * **メッセージ**: ダイアログ メッセージ。*(文字列)*

  * **promptCallback**: インデックス (1、2、または 3) を押されたボタンまたはダイアログ ボックスは、ボタンを押す (0) なしに解雇されたときに呼び出すコールバック。*(機能)*

  * **title**: タイトル *(String)* (省略可能、既定 `プロンプト` ダイアログ)

  * **buttonLabels**: ボタンのラベル *(配列)* (省略可能、既定値 `["OK"、「キャンセル」]` を指定する文字列の配列)

  * **defaultText**: 既定テキスト ボックスの入力値 (`文字列`) (省略可能、既定: 空の文字列)

### promptCallback

`promptCallback` は、プロンプト ダイアログ ボックス内のボタンのいずれかを押したときに実行します。コールバックに渡される `results` オブジェクトには、次のプロパティが含まれています。

  * **buttonIndex**: 押されたボタンのインデックス。*(数)*インデックスがインデックス 1 ベースので、値は `1``2``3` などに注意してください。

  * **input1**: プロンプト ダイアログ ボックスに入力したテキスト。*(文字列)*

### 例

    function onPrompt(results) {
        alert("You selected button number " + results.buttonIndex + " and entered " + results.input1);
    }
    
    navigator.notification.prompt(
        'Please enter your name',  // message
        onPrompt,                  // callback to invoke
        'Registration',            // title
        ['Ok','Exit'],             // buttonLabels
        'Jane Doe'                 // defaultText
    );
    

### サポートされているプラットフォーム

  * アマゾン火 OS
  * アンドロイド
  * Firefox の OS
  * iOS
  * Windows Phone 7 と 8
  * Windows 8
  * Windows

### Android の癖

  * Android は最大 3 つのボタンをサポートしているし、それ以上無視します。

  * アンドロイド 3.0 と後、ホロのテーマを使用するデバイスを逆の順序でボタンが表示されます。

### Windows の癖

  * Windows プロンプト ダイアログは html ベースのようなネイティブ api の不足のためです。

### Firefox OS 互換:

ネイティブ ブロック `window.prompt()` と非ブロッキング `navigator.notification.prompt()` があります。

## navigator.notification.beep

デバイス サウンドをビープ音を再生します。

    navigator.notification.beep(times);
    

  * **times**: ビープ音を繰り返す回数。*(数)*

### 例

    // Beep twice!
    navigator.notification.beep(2);
    

### サポートされているプラットフォーム

  * アマゾン火 OS
  * アンドロイド
  * ブラックベリー 10
  * iOS
  * Tizen
  * Windows Phone 7 と 8
  * Windows 8

### アマゾン火 OS 癖

  * アマゾン火 OS デフォルト **設定/表示 & サウンド** パネルの下に指定した **通知音** を果たしています。

### Android の癖

  * アンドロイド デフォルト **通知着信音** **設定/サウンド & ディスプレイ** パネルの下に指定を果たしています。

### Windows Phone 7 と 8 癖

  * コルドバ分布からジェネリック ビープ音ファイルに依存します。

### Tizen の癖

  * Tizen は、メディア API 経由でオーディオ ファイルを再生してビープ音を実装します。

  * ビープ音ファイル短い、`sounds` アプリケーションのルート ディレクトリのサブディレクトリである必要があり。、`beep.wav` という名前である必要があります。.