attach

Gluon Attach alpha version

GPL-3.0 License

Stars
5

Gluon Attach

Gluon Attach is the component that addresses the integration with low-level platform APIs in an end-to-end Java Mobile solution.

Using Attach, you write code that access device and hardware features using a uniform, platform-independent API. At runtime, the appropriate implementation (charm-down-desktop, charm-down-android, charm-down-ios) makes sure the platform specific code is used to deliver the functionality.

Attach is open source, and it is freely licensed under the GPL license. Gluon can provide custom consultancy and training, commercial licenses, and open source commercial support, including daily and monthly releases.

Getting started

The best way to get started with Gluon Attach is using the Gluon plugin for your IDE and creating a Gluon Mobile project.

The Gluon samples are a good way to find out how Attach is used.

See the documentation and the Javadoc.

The list of available services at Attach can be found here.

Issues and Contributions

Issues can be reported to the Issue tracker

Contributions can be submitted via Pull requests

Building Attach

Requisites

Gluon Attach is frequently released, and this is only required in case you want to fork and build your local version of Attach.

These are the requisites:

  • A recent version of JDK 11
  • Gradle 4.10 or superior.

To build the iOS Services:

  • A Mac with with MacOS X 10.11.5 or superior
  • XCode 9.x or superior

How to build and install Attach

To build the Attach services on the project's root, run:

./gradlew clean build

If you want to install them, run:

./gradlew clean install

To build/install for desktop, add the option -Pdesktop.

To build/install for iOS, add the option -Pios.

When the process finishes successfully, the different services can be added to a Gluon Mobile project by including mavenLocal() in the list of repositories.

For instance, the Lifecycle service for desktop can be added to the project like:

repositories {
    mavenLocal()
}

dependencies {
    compile 'com.gluonhq:attach-lifecycle:4.0.0-SNAPSHOT:desktop'
}