From 1b9e0a43dd2b7073f589e9f4ae876f3e63970624 Mon Sep 17 00:00:00 2001 From: Strawmanbobi Date: Tue, 4 Jul 2017 21:15:25 +0800 Subject: [PATCH] Update README.md --- web/README.md | 129 ++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 119 insertions(+), 10 deletions(-) diff --git a/web/README.md b/web/README.md index 46afa33..6fa487c 100644 --- a/web/README.md +++ b/web/README.md @@ -14,6 +14,7 @@ Import classes: ```java import net.irext.webapi.model.*; import net.irext.webapi.WebAPIs; +import net.irext.webapi.WebAPICallbacks.*; ``` Get web API instance: ```java @@ -22,32 +23,140 @@ WebAPIs webApis = WebAPIs.getInstance(); Sign in for access id and token: ```java // App key and secret are fetched in step 1. -UserApp userApp = webApis.signIn(appKey, appSecret); -int id = userApp.getId(); -int token = userApp.getToken(); +SignInCallback signInCallback = new SignInCallback() { + @Override + public void onSignInSuccess(UserApp userApp) { + int id = userApp.getId(); + int token = userApp.getToken(); + } + + @Override + public void onSignInFailed() { + } + + @Override + public void onSignInError() { + } +}; +webApis.signIn(context, signInCallback); ``` Fetch household appliances categories: ```java -List categories = webApis.listCategories(); +ListCategoriesCallback listCategoriesCallback = new ListCategoriesCallback() { + @Override + public void onListCategoriesSuccess(List categories) { + } + + @Override + public void onListCategoriesFailed() { + } + + @Override + public void onListCategoriesError() { + } +}; +webApis.listCategories(listCategoriesCallback); ``` Fetch brands of a certain category other than STB: ```java -List brands = webApis.listBrands(category.getId()); +ListBrandsCallback listBrandsCallback = new ListBrandsCallback() { + @Override + public void onListBrandsSuccess(List brands) { + } + + @Override + public void onListBrandsFailed() { + } + + @Override + public void onListBrandsError() { + } +}; +webApis.listBrands(category.getId(), listBrandsCallback); ``` Fetch cities (in China) for STB: ```java -List provinces = webApis.listProvinces(); -List cities = webApis.listCities(provincePrefix); +ListProvincesCallback listProvincesCallback = new ListProvincesCallback() { + @Override + public void onListProvincesSuccess(List provinces) { + } + + @Override + public void onListProvincesFailed() { + } + + @Override + public void onListProvincesError() { + } +}; + +ListCitiesCallback listCitiesCallback = new ListCitiesCallback() { + @Override + public void onListCitiesSuccess(List cities) { + } + + @Override + public void onListCitiesFailed() { + } + + @Override + public void onListCitiesError() { + } +}; +webApis.listProvinces(listProvincesCallback); +webApis.listCities(provincePrefix, listCitiesCallback); ``` Fetch STB operators of a certain city: ```java -List; operators = webApis.listOperators(cityCode); +ListOperatersCallback listOperatorCallback = new ListOperatersCallback() { + + @Override + public void onListOperatorsSuccess(List operators) { + } + + @Override + public void onListOperatorsFailed() { + } + + @Override + public void onListOperatorsError() { + } +}; +webApis.listOperators(cityCode, listOperatorCallback); ``` Fetch remote indexes of a certain brand or STB operator: ```java -List remoteIndexes = webApis.listRemoteIndexes(category.getId(), brand.getId(), city.getCode(), operator.getOperator_id()); +ListIndexesCallback listIndexesCallback = new ListIndexesCallback() { + + @Override + public void onListIndexesSuccess(List indexes) { + } + + @Override + public void onListIndexesFailed() { + } + + @Override + public void onListIndexesError() { + } +}; +webApis.listRemoteIndexes(category.getId(), brand.getId(), city.getCode(), operator.getOperator_id(), listIndexesCallback); ``` Download IR binary for certain remote index: ```java -InputStream is = webApis.downloadBin(remoteIndex.getRemote_map(), remoteIndex.getId()); +DownloadBinCallback downloadBinCallback = new DownloadBinCallback() { + + @Override + public void onDownloadBinSuccess(InputStream inputStream) { + } + + @Override + public void onDownloadBinFailed() { + } + + @Override + public void onDownloadBinError() { + } +}; +webApis.downloadBin(remoteIndex.getRemote_map(), remoteIndex.getId(), downloadBinCallback); ```