Update README.md
This commit is contained in:
27
README.md
27
README.md
@@ -8,45 +8,44 @@ Indexing to the specified remote index and download its IR binary file
|
|||||||
|
|
||||||
Import classes:
|
Import classes:
|
||||||
|
|
||||||
import net.irext.webapi.model.*;
|
`import net.irext.webapi.model.*;`
|
||||||
|
|
||||||
import net.irext.webapi.WebAPIs;
|
`import net.irext.webapi.WebAPIs;`
|
||||||
|
|
||||||
Get web API instance:
|
Get web API instance:
|
||||||
|
|
||||||
WebAPIs webApis = WebAPIs.getInstance();
|
`WebAPIs webApis = WebAPIs.getInstance();`
|
||||||
|
|
||||||
Sign in for access id and token:
|
Sign in for access id and token:
|
||||||
|
|
||||||
Admin admin = webApis.signIn(userName, password);
|
`Admin admin = webApis.signIn(userName, password);`
|
||||||
|
|
||||||
int id = admin.getId();
|
`int id = admin.getId();`
|
||||||
|
|
||||||
int token = admin.getToken();
|
`int token = admin.getToken();`
|
||||||
|
|
||||||
Fetch categories of household appliances:
|
Fetch categories of household appliances:
|
||||||
|
|
||||||
List<Category> categories = webApis.listCategories();
|
`List<Category> categories = webApis.listCategories();`
|
||||||
|
|
||||||
Fetch brands for an certain category (other than STB):
|
Fetch brands for an certain category (other than STB):
|
||||||
|
|
||||||
List<Brand> brands = webApis.listBrands();
|
`List<Brand> brands = webApis.listBrands();`
|
||||||
|
|
||||||
Fetch cities (in China) for STB:
|
Fetch cities (in China) for STB:
|
||||||
|
|
||||||
List<City> provinces = webApis.listProvinces();
|
`List<City> provinces = webApis.listProvinces();`
|
||||||
|
|
||||||
List<City> cities = webApis.listCities(provincePrefix);
|
`List<City> cities = webApis.listCities(provincePrefix);`
|
||||||
|
|
||||||
Fetch STB operators of a certain city:
|
Fetch STB operators of a certain city:
|
||||||
|
|
||||||
List<StbOperator> operators = webApis.listOperators(cityCode);
|
`List<StbOperator> operators = webApis.listOperators(cityCode);`
|
||||||
|
|
||||||
Fetch remote indexes of certain brand or STB operator:
|
Fetch remote indexes of certain brand or STB operator:
|
||||||
|
|
||||||
List<RemoteIndex> remoteIndexes = webApis.listRemoteIndexes(categoryID, brandID, cityCode, operatorID);
|
`List<RemoteIndex> remoteIndexes = webApis.listRemoteIndexes(categoryID, brandID, cityCode, operatorID);`
|
||||||
// default value of each property is null
|
|
||||||
|
|
||||||
Download IR binary for certain remote index:
|
Download IR binary for certain remote index:
|
||||||
|
|
||||||
InputStream is = webApis.downloadBin(remoteIndex.getRemote_map(), remoteIndex.getId());
|
`InputStream is = webApis.downloadBin(remoteIndex.getRemote_map(), remoteIndex.getId());`
|
||||||
|
|||||||
Reference in New Issue
Block a user