imbox.ApplicationOperationsオブジェクト
| コンポーネント情報 | |
|---|---|
| version | 8.0.3 |
| since | 8.0.0 |
アプリケーションに対する操作を行うクラスです。
メソッドの概要
| 返却値の型 | メソッド名 |
|---|---|
| ResultObject | getApplication (ApplicationKey applicationKey) アプリケーション情報の取得を行います。 |
| ResultObject | getApplications () アプリケーション情報一覧の取得を行います。 |
| ResultObject | getWatchApplications (String applicationCd, String start) ウォッチを行っているアプリケーションの一覧を取得します。 |
| ResultObject | removeWatch (String applicationCd, String targetId) アプリケーションのターゲットが削除された場合に、ウォッチを行っているユーザのウォッチを解除します。 |
| ResultObject | unwatch (String applicationCd, Entry4Targets entry4Targets) アプリケーションのウォッチを解除します。 |
| ResultObject | watch (String applicationCd, Entry4Targets entry4Targets) アプリケーションのウォッチを行います。 |
メソッドの詳細
ResultObject getApplication (ApplicationKey applicationKey)
アプリケーション情報の取得を行います。
パラメータ
返却値
|
|
ResultObject getApplications ()
アプリケーション情報一覧の取得を行います。
imbox-application-configに設定されたアプリケーション情報の取得が行われます。
返却値
|
ResultObject getWatchApplications (String applicationCd, String start)
ウォッチを行っているアプリケーションの一覧を取得します。
引数アプリケーションコード（applicationCd）にnullを指定した場合は、すべてのアプリケーションのウォッチ情報の取得を行います。 引数アプリケーションコード（applicationCd）を指定した場合は、指定したアプリケーションのウォッチ情報のみの取得を行います。 引数ターゲットID（start）を指定することにより、そのターゲットID以降のアプリケーション情報が返却されます。 引数ターゲットID（start）を指定した場合は必ず、アプリケーションコードを指定してください。 引数ターゲットID（start）にnullを指定した場合は、最新のアプリケーション情報から返却されます。 各アプリケーションのウォッチ情報取得件数は、imbox-config.xmlに設定された件数分取得が行われます。（デフォルトは20件）
パラメータ
返却値
|
ResultObject removeWatch (String applicationCd, String targetId)
アプリケーションのターゲットが削除された場合に、ウォッチを行っているユーザのウォッチを解除します。
パラメータ
返却値
|
ResultObject unwatch (String applicationCd, Entry4Targets entry4Targets)
アプリケーションのウォッチを解除します。
パラメータ
返却値
|
ResultObject watch (String applicationCd, Entry4Targets entry4Targets)
アプリケーションのウォッチを行います。
パラメータ
返却値
|