com.codename1.push.PushBuilder Maven / Gradle / Ivy
/*
* Copyright (c) 2012, Codename One and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Codename One designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Codename One through http://www.codenameone.com/ if you
* need additional information or have any questions.
*/
package com.codename1.push;
import com.codename1.xml.Element;
/**
* A convenience class for building a push notification Payload.
* @author shannah
*/
public class PushBuilder {
private String title, body, metaData, imageUrl, category;
private int type, badge;
/**
* Sets the title of the push notification.
* @param title The title of the push notification.
* @return Self for chaining.
*/
public PushBuilder title(String title) {
this.title = title;
return this;
}
/**
* Sets the badge to set with the push notification.
* @param badge The badge to set.
* @return Self for chaining.
*/
public PushBuilder badge(int badge) {
this.badge = badge;
return this;
}
/**
* Sets the body of the push notification.
* @param body The body of the push notification.
* @return Self for chaining.
*/
public PushBuilder body(String body) {
this.body = body;
return this;
}
/**
* Sets the metadata (i.e. content the user shouldn't see) for the push notification.
* @param metaData The metadata.
* @return Self for chaining.
*/
public PushBuilder metaData(String metaData) {
this.metaData = metaData;
return this;
}
/**
* Sets the URL for an image to send in the push notification. Make sure you use https:// or the image won't be shown on iOS.
* @param imageUrl The image URL.
* @return Self for chaining.
*/
public PushBuilder imageUrl(String imageUrl) {
this.imageUrl = imageUrl;
return this;
}
/**
* Sets the category of the push notification.
* @param category The category.
* @return Self for chaining.
*/
public PushBuilder category(String category) {
this.category = category;
return this;
}
/**
* Sets the type of the push notification.
* Types
* Type Description 1 Sends only body as the notification message 2 Sends only metadata. Invisible to user but will be received in push callback 3 Sends both metadata and body. Body is visible to the user. Push callback will receive <metadata>;<body>. 4 Sends both title and body. Push callback will receive <title>;<body> 100 Sends only the badge 101 Sends the badge and body. Push callback will receive the body only. 102 Sends the badge, title, and body. Push callback will receive <title>;<body>
*
*
* Both {@link #imageUrl} and {@link #category} can be added to any notification type. If either of these values are non-null,
* then the push notification is considered to be a rich push notification, and {@link #getType() } will return {@literal 99},
* which signifies that it is a rich push notification.
* @param type The type of the push notification.
* @return Self for chaining.
*/
public PushBuilder type(int type) {
this.type = type;
return this;
}
/**
* A notification is considered to be a rich push notification if either {@link #imageUrl} or {@link #category} is set.
* @return True if the notification is a rich notification.
*/
public boolean isRichPush() {
return imageUrl != null || category != null;
}
/**
* Gets the type of the notification. This will return {@literal 99} if {@link #isRichPush() } is true. Otherwise
* it will return the underlying type as set with {@link #type(int) }.
* @return The type of the notification.
* @see #type(int)
* @see #isRichPush()
*/
public int getType() {
if (isRichPush()) {
return 99;
}
return type;
}
/**
* Builds the payload for this rich push notification.
* @return The payload that can be passed as the message body to {@link Push}
*/
public String build() {
StringBuilder sb = new StringBuilder();
switch (type) {
case 0:
case 1:
sb.append(body);
break;
case 2:
sb.append(metaData);
break;
case 3:
sb.append(metaData).append(";").append(body);
break;
case 4:
sb.append(title).append(";").append(body);
break;
case 5:
sb.append(body);
break;
case 6:
case 100:
sb.append(badge);
break;
case 101:
sb.append(badge).append(" ").append(body);
break;
case 102:
sb.append(badge).append(";").append(title).append(";").append(body);
break;
}
if (isRichPush()) {
String b = sb.toString();
sb.setLength(0);
Element el = new Element("push");
el.setAttribute("type", ""+type);
el.setAttribute("body", b);
if (category != null) {
el.setAttribute("category", category);
}
if (imageUrl != null) {
Element imgEl = new Element("img");
imgEl.setAttribute("src", imageUrl);
el.addChild(imgEl);
}
return el.toString();
}
return sb.toString();
}
}