com.clivern.fred.sender.template.RemindersAdd Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fred Show documentation
A Java Framework for Building Slack Bots.
There is a newer version: 1.0.2
/*
 * Copyright (C) 2017 A.F 
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
package com.clivern.fred.sender.template;

import com.clivern.fred.config.Basic;
import com.clivern.fred.contract.sender.template.BasicTemplate;

/**
 * Reminders Add Template Class
 *
 * It Creates a reminder.
 *
 * Supported token types: user
 * Expected scopes: reminders:write, post
 *
 * For More Info
 *
 * @author A.F
 * @since 1.0.0
 */
public class RemindersAdd extends BasicTemplate {

    protected String token;
    protected String text;
    protected String time;
    protected String timestamp;
    protected String user;

    /**
     * Class Constructor
     */
    public RemindersAdd()
    {
        this.setURL(Basic.methodURL(Basic.remindersAddMethod));
    }

    /**
     * Set Token
     *
     * @param token
     */
    public void setToken(String token)
    {
        this.token = token;
    }

    /**
     * Set Text
     *
     * @param text
     */
    public void setText(String text)
    {
        this.text = text;
    }

    /**
     * Set Time
     *
     * @param time
     */
    public void setTime(String time)
    {
        this.time = time;
    }

    /**
     * Set Timestamp
     *
     * @param timestamp
     */
    public void setTimestamp(String timestamp)
    {
        this.timestamp = timestamp;
    }

    /**
     * Set User
     *
     * @param user
     */
    public void setUser(String user)
    {
        this.user = user;
    }

    /**
     * Get Token
     *
     * @return String
     */
    public String getToken()
    {
        return this.token;
    }

    /**
     * Get Text
     *
     * @return String
     */
    public String getText()
    {
        return this.text;
    }

    /**
     * Get Time
     *
     * @return String
     */
    public String getTime()
    {
        return this.time;
    }

    /**
     * Get Timestamp
     *
     * @return String
     */
    public String getTimestamp()
    {
        return this.timestamp;
    }

    /**
     * Get User
     *
     * @return String
     */
    public String getUser()
    {
        return this.user;
    }

    /**
     * Build Message Body
     */
    public String build()
    {
        if( !this.isDefined(this.token) || !this.isDefined(this.text) || (!this.isDefined(this.time) && !this.isDefined(this.timestamp)) ){
            return "";
        }

        if( this.isDefined(this.token) ){
            this.body += "token=" + this.token;
        }

        if( this.isDefined(this.text) ){
            this.body += "&text=" + this.text;
        }

        if( this.isDefined(this.time) ){
            this.body += "&time=" + this.time;
        }

        if( this.isDefined(this.timestamp) ){
            this.body += "&time=" + this.timestamp;
        }

        if( this.isDefined(this.user) ){
            this.body += "&user=" + this.user;
        }

        this.setBody(this.body);

        return this.body;
    }
}