co.aurasphere.botmill.kik.factory.MessageFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kik-botmill Show documentation
Event-driven framework for Kik Messenger's bots
There is a newer version: 2.0.0-RC1
/**
 * 
 * MIT License
 *
 * Copyright (c) 2017 BotMill.io
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 * 
 */
package co.aurasphere.botmill.kik.factory;

import java.util.List;

import co.aurasphere.botmill.kik.model.Attribution;
import co.aurasphere.botmill.kik.model.Keyboard;
import co.aurasphere.botmill.kik.model.KeyboardType;
import co.aurasphere.botmill.kik.model.KikJsData;
import co.aurasphere.botmill.kik.model.Response;
import co.aurasphere.botmill.kik.model.ResponseType;

/**
 * A factory for creating Message objects.
 * 
 * @author Alvin P. Reyes
 */
public class MessageFactory {

	/**
	 * Creates a new Message object.
	 *
	 * @param name the name
	 * @param iconUrl the icon url
	 * @return the attribution
	 */
	public static Attribution createAttribution(String name,String iconUrl) {
		return new Attribution(name,iconUrl);
	}
	
	/**
	 * Creates a new Message object.
	 *
	 * @return the key value pair
	 */
	public static KikJsData createKikJsData() {
		return new KikJsData();
	}
	

	/**
	 * Creates a new Configuration object.
	 *
	 * @param body the body
	 * @param responseType the response type
	 * @return the response
	 */
	public static Response createResponse(String body, ResponseType responseType) {
		return new Response(body, responseType);
	}
	
	/**
	 * Creates a new Message object.
	 *
	 * @param body the body
	 * @param min the min
	 * @param max the max
	 * @param preselected the preselected
	 * @return the response
	 */
	public static Response createFriendPickerResponse(String body, int min, int max, List preselected){
		Response response = new Response(body, ResponseType.FRIEND_PICKER);
		response.setMin(min);
		response.setMax(max);
		response.setPreselected(preselected);
		return response;
	}
	
	/**
	 * Creates a new Configuration object.
	 *
	 * @param keyboardType the keyboard type
	 * @param response the response
	 * @return the keyboard
	 */
	public static Keyboard createStaticKeyboard(KeyboardType keyboardType, Response response) {
		return new Keyboard();
	}
}