Socket ScanAPI Reference Manual page 35

Socket ScanAPI Reference
ScanAPI is composed of two JAR files located under the lib directory of the SDK Java
portion.
Following are the steps required in order to include ScanAPI into your project and
workspace.
6.2.1 Setting up the Eclipse workspace
From Eclipse select the menu Window / Preferences.
For a BlackBerry target, select from the left tree control the path Java\Build
Path\User Libraries
Choose the "Import..." button and browse to where ScanAPI_SDK is installed to
select the ScanAPI_SDK.user libraries file. Check the ScanAPIBlackBerry option and
click OK.
For an Android target, select on the left tree control the path Java\Build
Path\Classpath Variables. Click on the "New..." button and type in the Name field:"
ScanAPI_Libs" and click the Folder... button to browse to where your ScanAPI_SDK
is installed to select the Lib folder underneath it. Click OK to validate your choice,
and Click OK again to add the New Variable Entry in your workspace.
6.2.2 Setting up the application project for using ScanAPI
For a BlackBerry target, go to your Java application project properties; select Java
Build Path in the tree on the left panel of your application properties dialog. On the
right panel, select the Libraries tab and click on the "Add Library..." button. In the
Add Library dialog window select "User Library" and click next. In the next screen
select the ScanAPI library corresponding to your targeted device platform and click
the Finish button.
For an Android target, go to your Java application project properties; select Java
Build Path in the tree on the left panel of your application properties dialog. Click on
the "Add Variable..." button, select the ScanAPI_Libs variables and click on Extend.
Select ScanAPIAndroid.jar and click OK. Repeat this operation but this time select
the ScanAPIFactoryAndroid.jar file. Both jar files are required in order to use
ScanAPI in your application.
At this point your Java application is ready to use ScanAPI.
6.2.3 Tools provided with ScanAPI SDK
There are 2 tools provides in the SDK and that are launched automatically during
the installation of ScanAPI SDK but they will not be launched if you have installed
ScanAPI SDK using the compressed SDK file.
© 2013 Socket Mobile, Inc. 35/152