Aroma Java Client

The Official Java Client for Aroma


Project maintained by RedRoma Hosted on GitHub Pages — Theme by mattgraham

Aroma How-To Guide for Java

Connecting with Aroma

By following a few simple steps, you can connect your Java application with Aroma and start viewing messages on your iPhone.

Maven

Add the following dependency to your pom to start using Aroma.

<dependency>
    <groupId>tech.aroma</groupId>
    <artifactId>aroma-java-client</artifactId>
    <version>1.2</version>
</dependency>

Gradle

Add the following line to your build.gradle file to start using Aroma.

compile group: 'tech.aroma', name: 'aroma-java-client', version: '1.2'

Add Import Statement

import tech.aroma.client.Aroma;

Create the Client

Aroma aroma = Aroma.create(APP_TOKEN);

Send a Message

aroma.begin()
     .titled("New User")
     .text("Email: {}", user.email)
     .send();

That's really all there is to it.

Best Practices

Send Important Messages

Try to only Send messages that are actually interesting. You don't want to bombard Aroma with too many diagnostic messages that are better suited for Logging.

Set the Urgency

Set an Urgency to each message. Think of Urgency like you would a Log Severity Level. Using them allows you and your team to know just how important a message is.

Javadocs

Javadocs can be found here.

Project Source

Additional info on the Java Client can be found by visiting the GitHub project.