Package com.nefrock.edgeocr

Interface NefrockLicenseAPI

public interface NefrockLicenseAPI
NefrockLicenseAPIは、Nefrock OCR SDKのライセンス認証を行うためのAPIです。 Nefrock OCR SDKを使用する前に、ライセンス認証を行う必要があります。 ライセンス認証は、`activate`メソッドを使用して行います。 ライセンス認証が完了すると、`activate`メソッドのコールバックにライセンス情報が渡されます。 ライセンス認証が完了していない場合、`activate`メソッドは`null`を返します。

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    NefrockLicenseAPI.Builder
    ライセンス認証APIのBuilderです

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.common.util.concurrent.ListenableFuture<License>
    activate()
    ライセンス認証を行います。ライセンス認証には時間がかかるため、`activate`メソッドは 非同期で実行されます。
    com.google.common.util.concurrent.ListenableFuture<License>
    activate(ActivationCallback callback, ActivationErrorCallback errorCallback)
    Deprecated.
    このメソッドは非推奨です。この関数の返り値のListenableFutureをgetすると、 errorCallbackを指定しても例外が発生する可能性があります。getで結果を期待したい場合は、 activate()を使用し、必要に応じて例外をキャッチしてください。
    com.google.common.util.concurrent.ListenableFuture<Void>
    deactivate()
    ライセンス認証を解除します。 デバイスにライセンス情報が保存されている場合は削除されます。サーバー側の登録も解除されます。
    String
    getDeviceId()
    APIの認証で端末識別に用いているデバイスIDを返します。
    com.google.common.util.concurrent.ListenableFuture<License>
    isActivated()
    ライセンス認証が完了しているかどうかを返します。
    com.google.common.util.concurrent.ListenableFuture<License>
    isActivated(ActivationCallback callback, ActivationErrorCallback errorCallback)
    Deprecated.
    このメソッドは非推奨です。この関数の返り値のListenableFutureをgetすると、 errorCallbackを指定しても例外が発生する可能性があります。getで結果を期待したい場合は、 isActivated()を使用し、必要に応じて例外をキャッチしてください。
    static String
    queryDeviceId()
    ライセンスAPIを初期化せずに端末IDを取得します。 共有されているライセンスキー・認証方式・保存先を変更しません。 既存のインスタンスメソッド getDeviceId() を static に変更すると、 利用側のソース互換性・バイナリ互換性が失われるため、別名で追加しています。
    com.google.common.util.concurrent.ListenableFuture<Void>
    resetLicense()
    デバイス上のライセンス認証をリセットします。 デバイスに保存されているライセンス情報が削除されますが、サーバー側の登録は解除されません。

  • Method Details

    • queryDeviceId

      static String queryDeviceId() throws EdgeError
      ライセンスAPIを初期化せずに端末IDを取得します。 共有されているライセンスキー・認証方式・保存先を変更しません。 既存のインスタンスメソッド getDeviceId() を static に変更すると、 利用側のソース互換性・バイナリ互換性が失われるため、別名で追加しています。
      Returns:
      デバイスID
      Throws:
      EdgeError - 端末IDの取得に失敗した場合

    • activate

      @Deprecated com.google.common.util.concurrent.ListenableFuture<License> activate(@Nullable ActivationCallback callback, @Nullable ActivationErrorCallback errorCallback)
      Deprecated.
      このメソッドは非推奨です。この関数の返り値のListenableFutureをgetすると、 errorCallbackを指定しても例外が発生する可能性があります。getで結果を期待したい場合は、 activate()を使用し、必要に応じて例外をキャッチしてください。
      ライセンス認証を行います。ライセンス認証には時間がかかるため、`activate`メソッドは 非同期で実行されます。ライセンス認証が完了すると、`callback`が呼び出されます。 ライセンス認証中にエラーが発生した場合は、`errorCallback`が呼び出されます。
      Parameters:
      callback - ライセンス認証が完了したときに呼び出されるコールバック
      errorCallback - ライセンス認証中にエラーが発生したときに呼び出されるコールバック
      Returns:
      ライセンス情報のfuture

    • activate

      com.google.common.util.concurrent.ListenableFuture<License> activate()
      ライセンス認証を行います。ライセンス認証には時間がかかるため、`activate`メソッドは 非同期で実行されます。
      Returns:
      ライセンス情報のfuture

    • isActivated

      @Deprecated com.google.common.util.concurrent.ListenableFuture<License> isActivated(@Nullable ActivationCallback callback, @Nullable ActivationErrorCallback errorCallback)
      Deprecated.
      このメソッドは非推奨です。この関数の返り値のListenableFutureをgetすると、 errorCallbackを指定しても例外が発生する可能性があります。getで結果を期待したい場合は、 isActivated()を使用し、必要に応じて例外をキャッチしてください。
      ライセンス認証が完了しているかどうかを返します。
      Parameters:
      callback - ライセンス認証が完了している場合に呼び出されるコールバック
      errorCallback - ライセンス認証が完了していない場合に呼び出されるコールバック
      Returns:
      ライセンス情報のfuture

    • isActivated

      com.google.common.util.concurrent.ListenableFuture<License> isActivated()
      ライセンス認証が完了しているかどうかを返します。
      Returns:
      ライセンス情報のfuture

    • getDeviceId

      String getDeviceId() throws EdgeError
      APIの認証で端末識別に用いているデバイスIDを返します。
      Returns:
      デバイスID
      Throws:
      EdgeError - デバイスIDの取得に失敗した場合

    • resetLicense

      com.google.common.util.concurrent.ListenableFuture<Void> resetLicense()
      デバイス上のライセンス認証をリセットします。 デバイスに保存されているライセンス情報が削除されますが、サーバー側の登録は解除されません。
      Returns:
      ライセンス認証リセットの完了を示すfuture

    • deactivate

      com.google.common.util.concurrent.ListenableFuture<Void> deactivate()
      ライセンス認証を解除します。 デバイスにライセンス情報が保存されている場合は削除されます。サーバー側の登録も解除されます。
      Returns:
      ライセンス認証解除の完了を示すfuture