Skip to content

README.md

Latest commit

 

History

History
86 lines (61 loc) · 2.09 KB

README.md

File metadata and controls

86 lines (61 loc) · 2.09 KB

Aroma Java Client

Build Status Maven Central Version

The Java Client to the Famed Aroma Service!

COMMAND your Software, with Aroma.

Download

To use, simply add the following maven dependency.

Release

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

Snapshot

First add the Snapshot Repository

<repository>
	<id>ossrh</id>
    <url>https://oss.sonatype.org/content/repositories/snapshots</url>
</repository>
<dependency>
	<groupId>tech.aroma</groupId>
	<artifactId>aroma-java-client</artifactId>
	<version>2.3-SNAPSHOT</version>
</dependency>

Connecting with Aroma

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

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();

Shorthand

You can also send messages using a one-shot shorthand way.

aroma.sendLowPriorityMessage("New User", "Email: {}", user.email);

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