API の実行方法

Thing-IF SDK for JavaScript は、Thing Interaction Framework の API を実行する方法として、ThingIFAPI と APIAuthor の 2 通りの方法をサポートしています。

通常のケースでは ThingIFAPI を使うことで目的の機能を実現できます。本ガイドでのサンプルコードも、ThingIFAPI を利用する方法で記述されています。アプリ管理者の権限で Thing-IF SDK の API を実行したい場合は APIAuthor を使う必要があります。

ThingIFAPI

ThingIFAPI は、Android や iOS と共通の方法で Thing Interaction Framework の機能を利用するクラスです。

ThingIFAPI のインスタンス内には、API を実行する際のターゲットとなる Thing が格納されています。モバイルアプリからこのインスタンスのメソッドを呼び出すことによって、ターゲットとして設定されている Thing を操作できます。

APIAuthor

Thing-IF SDK for JavaScript に特有のクラスです。サンプルコードは特に示していないため、使用する際は JSDoc をご覧ください。

APIAuthor は、API のターゲットとなる Thing を保持していないため、メソッドを実行するごとに、ターゲットとなる Thing を指定する必要があります。特に、管理者権限での実行時など、機能を実行する際の Thing のオーナーユーザーが、API を実行する権限を持ったユーザーと異なる場合には、APIAuthor を使用する必要があります。