This is the official supported Java library for the Airship API. Please reach out to http://support.airship.com directly with any issues that need attention.
General documentation can be found here: http://docs.airship.com/ Java client library documentation can be found here: https://docs.airship.com/api/libraries/java/
Clone the repository, and use
mvn package
to build the jar. Add the jar, located at a path similar to:
target/java-client-<version>.jar
If you would like a copy of the javadocs, use
mvn javadoc:javadoc
Add the following to your pom.xml
<!-- Urban Airship Library Dependency-->
<dependency>
<groupId>com.urbanairship</groupId>
<artifactId>java-client</artifactId>
<version>VERSION</version>
<!-- Replace VERSION with the version you want to use -->
</dependency>Schedule requests now require a SchedulePayload object:
SchedulePayload schedulePayload = SchedulePayload.newBuilder()
.setName("optionalName")
.setSchedule(Schedule.newBuilder()
.setScheduledTimestamp(dateTime)
.build())
.setPushPayload(PushPayload.newBuilder()
.setDeviceTypes(DeviceTypeData.of(DeviceType.ANDROID))
.setNotification(Notifications.alert("Simple alert"))
.setAudience(Selectors.tag("tag"))
.build())
.build();
ScheduleRequest scheduleRequest = ScheduleRequest.newRequest(schedulePayload);
Schedule responses now contain an Immutable list of SchedulePayloadResponse objects instead of SchedulePayload objects inside the response body.
Response<ScheduleResponse> response = client.execute(scheduleRequest);
ImmutableList<SchedulePayloadResponse> schedulePayloadResponses = response.getBody().get().getSchedulePayloadResponses();
When creating a custom event request the CustomEventBody now requires CustomEventPropertyValue objects to support complex property objects.
CustomEventPropertyValue customEventProperty = CustomEventPropertyValue.of("victory");
List<CustomEventPropertyValue> items = new ArrayList<>();
items.add(CustomEventPropertyValue.of("la croix"));
items.add(CustomEventPropertyValue.of("more la croix"));
CustomEventBody customEventBody = CustomEventBody.newBuilder()
.setName("purchased")
.addPropertiesEntry("brand", customEventProperty)
.addPropertiesEntry("items", CustomEventPropertyValue.of(items))
.build();
CustomEventPayload customEventPayload = CustomEventPayload.newBuilder()
.setCustomEventBody(customEventBody)
.setCustomEventUser(customEventUser)
.setOccurred(occurred)
.build();
CustomEventBody.getSessionId() will now return an Optional String instead of a String.