# メソッド一覧

## getPlatformVersion

プラットフォームのバージョンを取得します。  

```dart
Future<String?> getPlatformVersion()
```
**サンプルコード**：（注：asreaderSlimはAsreaderSlimクラスのインスタンス）

```dart
Future<String?> platformVersion = asreaderSlim.getPlatformVersion();
platformVersion.then((futureResult) {
  //futureResult
});
```

**戻り値**

```{list-table}
:align: left
:class: list-table 

   * - 型
     - 説明
   * - Future<String?>
     - プラットフォームのバージョン
```   

<br>


## getSDKVersion
SDKのバージョンを取得します。

```dart
Future<String?> getSDKVersion()
```
**サンプルコード**：  
（注：asreaderSlimはAsreaderSlimクラスのインスタンス）

```dart
Future<String?> sdkString = asreaderSlim.getSDKVersion();
sdkString.then((futureResult) {
  //futureResult
});
```

**戻り値**

```{list-table}
:align: left
:class: list-table 

   * - 型
     - 説明
   * - Future<String?>
     - SDKのバージョン
```   

<br>

## getSerialNumber

AsReaderのシリアル番号を取得します。  

```dart
Future<String?> getSerialNumber()
```

**サンプルコード**：  
（注：asreaderSlimはAsreaderSlimクラスのインスタンス）

```dart
Future<String?> serialString = asreaderSlim.getSerialNumber();
serialString.then((futureResult) {
  //futureResult
});
```

**戻り値**

```{list-table}
:align: left
:class: list-table 

   * - 型
     - 説明
   * - Future<String?>
     - シリアル番号
```   

<br>


## getHardwareVersion

AsReaderのハードウェアバージョンを取得します。

```dart
Future<String?> getHardwareVersion()
```
**サンプルコード**：  
（注：asreaderSlimはAsreaderSlimクラスのインスタンス）

```dart
Future<String?> hardwareString = asreaderSlim.getHardwareVersion();
hardwareString.then((futureResult) {
  //futureResult
});
```

**戻り値**

```{list-table}
:align: left
:class: list-table 

   * - 型
     - 説明
   * - Future<String?>
     - ハードウェアバージョン
```   

<br>

## getFirmwareVersion

 AsReaderのファームウェアバージョンを取得します。

```dart
Future<String?> getFirmwareVersion()
```
**サンプルコード**：  
（注：asreaderSlimはAsreaderSlimクラスのインスタンス）

```dart
Future<String?> firmwareString = asreaderSlim.getFirmwareVersion();
firmwareString.then((futureResult) {
  //futureResult
});
```

**戻り値**

```{list-table}
:align: left
:class: list-table 

   * - 型
     - 説明
   * - Future<String?>
     - ファームウェアバージョン
```   

<br>

## startDecode

デコード処理を開始します。  
このメソッドを実行した後に、コールバックメソッド[DETECT_BARCODE_STRING](callback.md#detect-barcode-string)、[DETECT_BARCODE_DATA](callback.md#detect-barcode-data)でスキャン結果を受け取ります。  
また、コールバックメソッド[ACTION_STATE](callback.md#action-state)で現在の操作状態と結果を受け取ります。

```dart
Future<AsReaderSLIMResultCode?> startDecode()
```

**サンプルコード**：  
（注：asreaderSlimはAsreaderSlimクラスのインスタンス）

```dart
Future<AsReaderSLIMResultCode?> status = asreaderSlim.startDecode();
status.then((futureResult) {
  //futureResult メソッドの返した結果
});
```

**戻り値**

```{list-table}
:align: left
:class: list-table 

   * - 型
     - 説明
   * - Future<AsReaderSLIMResultCode?>
     - 列挙 [AsReaderSLIMResultCode](enums.md#asreaderslimresultcode)を参照
``` 

<br>


## stopDecode

デコードを停止します。  
このメソッドを実行した後に、コールバックメソッド[ACTION_STATE](callback.md#action-state)で現在の操作状態と結果を受け取ります。

```dart
Future<AsReaderSLIMResultCode?> stopDecode()
```

**サンプルコード**:  
（注：asreaderSlimはAsreaderSlimクラスのインスタンス）

```dart
Future<AsReaderSLIMResultCode?> status = asreaderSlim.stopDecode();
status.then((futureResult) {
  //futureResult メソッドの返した結果
});
```


**戻り値**

```{list-table}
:align: left
:class: list-table 

   * - 型
     - 説明
   * - Future<AsReaderSLIMResultCode?>
     - 列挙 [AsReaderSLIMResultCode](enums.md#asreaderslimresultcode)を参照
     
```   

<br>


## destroy

インスタンスを廃棄します。

```dart
Future<void> destroy()
```

**サンプルコード**：  
（注：asreaderSlimはAsreaderSlimクラスのインスタンス）

```dart
asreaderSlim.destroy();
```

## getResultCode

コマンドの実行結果を取得します。

```dart
Future<AsReaderSLIMResultCode?> getResultCode()
```

**サンプルコード**：  
（注：asreaderSlimはAsreaderSlimクラスのインスタンス）

```dart
Future<AsReaderSLIMResultCode?> status = asreaderSlim.getResultCode();
status.then((futureResult) {
  //futureResult メソッドの返した結果
});
```

**戻り値**
```{list-table}
:align: left
:class: list-table 

   * - 型
     - 説明
   * - Future<AsReaderSLIMResultCode?>
     - 列挙 [AsReaderSLIMResultCode](enums.md#asreaderslimresultcode)を参照
     
```   

<br>


## getState

AsReaderSLIMの現在の接続状態を取得します。

```dart
Future<AsReaderSLIMConnectionState?> getState()
```

**サンプルコード**：  
（注：asreaderSlimはAsreaderSlimクラスのインスタンス）

```dart
Future<AsReaderSLIMConnectionState?> status = asreaderSlim.getState();
status.then((futureResult) {
  //futureResult メソッドの返した結果
});
```

**戻り値**

```{list-table}
:align: left
:class: list-table 

   * - 型
     - 説明
   * - Future<AsReaderSLIMConnectionState?>
     - 列挙 [AsReaderSLIMConnectionState](enums.md#asreaderslimconnectionstate)を参照
```   

<br>


## getAction

AsReaderSLIMの現在の動作状態を取得します。

```dart
Future<AsReaderSLIMActionState?> getAction()
```
**サンプルコード**：  
（注：asreaderSlimはAsreaderSlimクラスのインスタンス）

```dart
Future<AsReaderSLIMActionState?> status = asreaderSlim.getAction();
status.then((futureResult) {
  //futureResult メソッドの返した結果
});
```

**戻り値**

```{list-table}
:align: left
:class: list-table 

   * - 型
     - 説明
   * - Future<AsReaderSLIMActionState?>
     - 列挙 [AsReaderSLIMActionState](enums.md#asreaderslimactionstate)を参照
```   

<br>


## disconnectDevice

AsReaderSLIMとの接続を切断します。  
このメソッドを実行した後に、コールバックメソッド[ON_CONNECT](callback.md#on-connect)でAsReaderの現在の接続状態を受け取ります。

```dart
Future<void> disconnectDevice()
```

**サンプルコード**：  
（注：asreaderSlimはAsreaderSlimクラスのインスタンス）

```dart
asreaderSlim.disconnectDevice();
```

## connectDevice

AsReaderSLIMに接続します。  
このメソッドを実行した後に、コールバックメソッド[ON_CONNECT](callback.md#on-connect)でAsReaderの現在の接続状態を受け取ります。

```dart
Future<void> connectDevice()
```

**サンプルコード**：  
（注：asreaderSlimはAsreaderSlimクラスのインスタンス）

```dart
asreaderSlim.connectDevice();
```

## defaultParameter

全てのパラメータ設定をデフォルト値に戻します。
デフォルト値は以下の通りです：  
・Buzzer: High  
・Sleep Buzzer: Off  
・Auto Off Time(s): 600  
・Barcode Timeout(s): 4    
このメソッドを実行した後に、コールバックメソッド[ACTION_STATE](callback.md#action-state)でAsReaderの現在の接続状態と結果を受け取ります。

```dart
Future<AsReaderSLIMResultCode?> defaultParameter()
```

**サンプルコード**：  
（注：asreaderSlimはAsreaderSlimクラスのインスタンス）

```dart
Future<AsReaderSLIMResultCode?> status = asreaderSlim.defaultParameter();
status.then((futureResult) {
  //futureResult メソッドの返した結果
});
```

**戻り値**

```{list-table}
:align: left
:class: list-table 

   * - 型
     - 説明
   * - Future<AsReaderSLIMResultCode?>
     - 列挙 [AsReaderSLIMResultCode](enums.md#asreaderslimresultcode)を参照
```   

<br>


## getBuzzer

ブザーの設定状態を取得します。

```dart
Future<AsReaderSLIMBuzzerState?> getBuzzer()
```
**サンプルコード**：  
（注：asreaderSlimはAsreaderSlimクラスのインスタンス）

```dart
Future<AsReaderSLIMBuzzerState?> status = asreaderSlim.getBuzzer();
status.then((futureResult) {
  //futureResult メソッドの返した結果
});
```

**戻り値**


```{list-table}
:align: left
:class: list-table 

   * - 型
     - 説明
   * - Future<AsReaderSLIMBuzzerState?>
     - 列挙 [AsReaderSLIMBuzzerState](enums.md#asreaderslimbuzzerstate)を参照
```   

<br>


## setBuzzer

ブザーの設定を変更します。

```dart
Future<void> setBuzzer(AsReaderSLIMBuzzerState state)
```

**サンプルコード**:  
（注：asreaderSlimはAsreaderSlimクラスのインスタンス）

```dart
asreaderSlim.setBuzzer(AsReaderSLIMBuzzerState.High);
```

**パラメータ**

```{list-table}
:align: left
:class: list-table 

   * - 型
     - 説明
   * - AsReaderSLIMBuzzerState
     - 列挙 [AsReaderSLIMBuzzerState](enums.md#asreaderslimbuzzerstate)を参照
```   

<br>


## getSleepBuzzer

スリープ時のブザー設定を取得します。

```dart
Future<AsReaderSLIMSleepBuzzerState?> getSleepBuzzer()
```

**サンプルコード**：  
（注：asreaderSlimはAsreaderSlimクラスのインスタンス）

```dart
Future<AsReaderSLIMSleepBuzzerState?> status = asreaderSlim.getSleepBuzzer();
status.then((futureResult) {
  //futureResult メソッドの返した結果
});
```

**戻り値**

```{list-table}
:align: left
:class: list-table 

   * - 型
     - 説明
   * - Future<AsReaderSLIMSleepBuzzerState?>
     - 列挙 [AsReaderSLIMSleepBuzzerState](enums.md#asreaderslimsleepbuzzerstate)を参照
```   

<br>

## setSleepBuzzer

スリープ時のブザー設定を変更します。

```dart
Future<void> setSleepBuzzer(AsReaderSLIMSleepBuzzerState state)
```

**サンプルコード**：  
（注：asreaderSlimはAsreaderSlimクラスのインスタンス）

```dart
asreaderSlim.setSleepBuzzer(AsReaderSLIMSleepBuzzerState.On);
```

**パラメータ**

```{list-table}
:align: left
:class: list-table 

   * - 型
     - 説明
   * - AsReaderSLIMSleepBuzzerState
     - 列挙 [AsReaderSLIMSleepBuzzerState](enums.md#asreaderslimsleepbuzzerstate)を参照
```   

<br>


## getAutoOffTime

電源が自動でオフになるまでの時間を取得します。

```dart
Future<int?> getAutoOffTime()
```

**サンプルコード**:  
（注：asreaderSlimはAsreaderSlimクラスのインスタンス）

```dart
Future<int?> status = asreaderSlim.getAutoOffTime();
status.then((futureResult) {
  //futureResult メソッドの返した結果
});
```

**戻り値**

```{list-table}
:align: left
:class: list-table 

   * - 型
     - 説明
   * - Future<int?>
     - オートオフ時間（秒）
```   

<br>


## setAutoOffTime

電源が自動でオフになるまでの時間を設定します。

```dart
Future<void> setAutoOffTime(int time)
```

**サンプルコード**:  
（注：asreaderSlimはAsreaderSlimクラスのインスタンス）

```dart
asreaderSlim.setAutoOffTime(600);
```

**パラメータ**

```{list-table}
:align: left
:class: list-table 

   * - 型
     - 説明
   * - int
     - オートオフ時間（秒、0~1800秒）
```   

<br>

## getBarcodeTimeOut

AsReaderのバーコードスキャンのタイムアウト時間を取得します。

```dart
Future<int?> getBarcodeTimeOut()
```

**サンプルコード**：  
（注：asreaderSlimはAsreaderSlimクラスのインスタンス）

```dart
Future<int?> status = asreaderSlim.getBarcodeTimeOut();
status.then((futureResult) {
  //futureResult メソッドの返した結果
});
```

**戻り値**

```{list-table}
:align: left
:class: list-table 

   * - 型
     - 説明
   * - Future<int?>
     - スキャンのタイムアウト時間（秒）
```   

<br>


## setBarcodeTimeOut

AsReaderのバーコードスキャンのタイムアウト時間を設定します。

```dart
Future<void> setBarcodeTimeOut(int time)
```

**サンプルコード**：  
（注：asreaderSlimはAsreaderSlimクラスのインスタンス）

```dart
asreaderSlim.setBarcodeTimeOut(4);
```

**パラメータ**

```{list-table}
:align: left
:class: list-table 

   * - 型
     - 説明
   * - int
     - スキャンのタイムアウト時間（秒、4~300秒）
```   

<br>


## setSenseMode

センサーモードを設定します。

```dart
Future<void> setSenseMode(bool mode)
```

**サンプルコード**：  
（注：asreaderSlimはAsreaderSlimクラスのインスタンス）

```dart
asreaderSlim.setSenseMode(true);
```

**パラメータ**

```{list-table}
:align: left
:class: list-table 

   * - 型
     - 説明
   * - bool
     - true:設定する
<br>false:設定しない
```   

<br>|