Skip to content

Vantiq/vantiq-sdk-ios

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

71 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

vantiq-sdk-ios

CI Status Version License Platform

Usage

To run the example project, clone the repo, and run pod install from the Example directory first.

Installation

vantiq-sdk-ios is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod "vantiq-sdk-ios"

Example App

There is an example iOS app that shows one or more uses of each API call. The app prompts for authentication to the development Vantiq server. In order to perform all API test cases, there must be a test type and a procedure defined in the namespace associated with the authenticated user.

The type must be named TestType and contain the following properties:

  • intValue: an Integer
  • stringValue: a String
  • uniqueString: a String

Also, uniqueString must be designated as a Natural Key.

The procedure is defined as follows:

PROCEDURE sumTwo(val1, val2)
	var result = val1 + val2
	return {result: result}

API Documentation

An Xcode Documentation Set (docset) is built by executing the builddoc.sh shell script, which is found in the Pod directory. This shell script builds both the docset and an HTML-formatted version of the API documentation, creating the output in the Pod/help directory.

API

HTML-format documentation for the SDK methods may be found in the Pod/help/html directory.

Author

Vantiq, Inc., [email protected]

License

vantiq-sdk-ios is available under the MIT license. See the LICENSE file for more info.