Parent topic: See the SDK in action
The Samples Framework is a web application designed to house and display sample code snippets. The goal is that there should be samples for all services provided by the SDK. The samples are organised hierarchically based on the language they are written in, the endpoints they use (e.g. QSI, SmartCloud), the service they take advantage of and their name. The Samples framework can be found here
(if your Tomcat is running on localhost).
The UI display consists of four areas:
- The header.
- The snippet-selection tree.
- The snippet's code display area.
- The snippet preview area.
Environment and Library Drop-downs
The snippet-selection tree.
This is an expandable and collapsable tree for browsing through the samples. After you have located the sample you want, click on it to view it. To expand all nodes or collapse all nodes, click the relevant buttons.
Snippet Code Display
This shows the result of running the code from the display area. It is within an iframe, but the link to the content of this iframe is also supplied.
The link is a jsp page which will generate the page based on the url parameters, and takes the form: