Installation

To install a messaging API, unzip the archive file for your supported platform.

Java RTO API

The extracted package contains the following subdirectories in the /solclientj directory

  • docs — Java RTO API developer reference documentation
  • lib — Java RTO API libraries
  • license — contains the Apache license version 2.0 agreement and JZlib license for use with Java RTO
  • samples — contains Java RTO sample applications that provide a basic introduction to how to use JCSMP for messaging applications; for detailed information, see the readme.txt file included in this directory

C API

The extracted package contains the following subdirectories in the solclient directory:

ex — C sample applications that provide a basic introduction to how to use the C API for messaging applications; for detailed information on how to run these sample applications, see the README.txt file included in this directory

include — C API header files

Intro — introductory C sample applications to clearly illustrate message concepts; these sample applications do not include error checking no handling

lib — C API runtime libraries

 

The C API developer online reference documentation for all platforms is found in a separate solclient-doc.tar.gz archive.

.NET API

The extracted manually downloaded package contains the following subdirectories in the /solclient-dotnet directory:

docs — .NET API developer online reference help file (.chm)

ex — .NET sample applications that provide a basic introduction to how to use the .NET API for messaging applications; for detailed information on how to run these sample applications, see the README.txt file included in this directory

intro — introductory .NET sample applications to clearly illustrate message concepts; these sample applications do not include error checking no handling.

lib — contains .NET API assemblies and C API runtime libraries

The NuGet package contains the following subdirectories:

JavaScript Messaging API

To install the web browser-based JavaScript Messaging API, unzip the solclientjs-<version>.zip file on any supported platform. The resulting solclientjs directory contains the following directories:

  • docs—Contains the JavaScript messaging API Reference.

    The API developer online reference is an online help application describing the classes, interfaces, constructors, methods, and fields.

  • lib—Contains the release and debug versions of the messaging API for the JavaScript library files.

Node.js API

The API is available as a Node.js module, solclientjs. To install the messaging API for Node.js from the npm registry, ensure that Node.js and the npm package manager for Node.js are properly installed, and then execute the following command from your project's root folder:

npm install solclientjs

The resulting node_modules/solclientjs directory contains the following directories:

  • docs—Contains the JavaScript messaging API reference.

  • lib—Contains the Node.js module files.