com.twilio.rest.chat.v2.service.channel.MessageCreator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of twilio Show documentation
Twilio Java Helper Library
There is a newer version: 10.7.0
/**
 * This code was generated by
 * \ / _    _  _|   _  _
 *  | (_)\/(_)(_|\/| |(/_  v1.0.0
 *       /       /
 */

package com.twilio.rest.chat.v2.service.channel;

import com.twilio.base.Creator;
import com.twilio.converter.DateConverter;
import com.twilio.exception.ApiConnectionException;
import com.twilio.exception.ApiException;
import com.twilio.exception.RestException;
import com.twilio.http.HttpMethod;
import com.twilio.http.Request;
import com.twilio.http.Response;
import com.twilio.http.TwilioRestClient;
import com.twilio.rest.Domains;
import org.joda.time.DateTime;

public class MessageCreator extends Creator {
    private final String pathServiceSid;
    private final String pathChannelSid;
    private String from;
    private String attributes;
    private DateTime dateCreated;
    private DateTime dateUpdated;
    private String lastUpdatedBy;
    private String body;
    private String mediaSid;

    /**
     * Construct a new MessageCreator.
     * 
     * @param pathServiceSid Sid of the Service this message belongs to.
     * @param pathChannelSid Key that uniquely defines the channel this message
     *                       belongs to.
     */
    public MessageCreator(final String pathServiceSid, 
                          final String pathChannelSid) {
        this.pathServiceSid = pathServiceSid;
        this.pathChannelSid = pathChannelSid;
    }

    /**
     * The [identity](https://www.twilio.com/docs/api/chat/guides/identity) of the
     * message's author. Defaults to `system`..
     * 
     * @param from The identity of the message's author. Defaults to system if not
     *             specified.
     * @return this
     */
    public MessageCreator setFrom(final String from) {
        this.from = from;
        return this;
    }

    /**
     * An string metadata field you can use to store any data you wish. The string
     * value must contain structurally valid JSON if specified. **Note** that this
     * will always be null for resources returned via LIST GET operations, but will
     * be present for single GET operations..
     * 
     * @param attributes The attributes metadata field you can use to store any
     *                   data you wish.
     * @return this
     */
    public MessageCreator setAttributes(final String attributes) {
        this.attributes = attributes;
        return this;
    }

    /**
     * The ISO8601 time specifying the datetime the Message should be set as being
     * created. Will be set to the current time by the Chat service if not
     * specified.  Note that this should only be used in cases where a Chat's
     * history is being recreated from a backup/separate source..
     * 
     * @param dateCreated The ISO8601 time specifying the datetime the Message
     *                    should be set as being created.
     * @return this
     */
    public MessageCreator setDateCreated(final DateTime dateCreated) {
        this.dateCreated = dateCreated;
        return this;
    }

    /**
     * The ISO8601 time specifying the datetime the Message should be set as having
     * been last updated. Will be set to the `null` by the Chat service if not
     * specified.  Note that this should only be used in cases where a Chat's
     * history is being recreated from a backup/separate source  and where a Message
     * was previously updated..
     * 
     * @param dateUpdated The ISO8601 time specifying the datetime the Message
     *                    should be set as having been last updated.
     * @return this
     */
    public MessageCreator setDateUpdated(final DateTime dateUpdated) {
        this.dateUpdated = dateUpdated;
        return this;
    }

    /**
     * Specify the Identity of the User that last updated the Message (if relevant).
     * 
     * @param lastUpdatedBy Specify the Identity of the User that last updated the
     *                      Message
     * @return this
     */
    public MessageCreator setLastUpdatedBy(final String lastUpdatedBy) {
        this.lastUpdatedBy = lastUpdatedBy;
        return this;
    }

    /**
     * A string message to send to this channel. You can also send structured data
     * by serializing it into a string. May be empty string or `null`, will be set
     * as empty string as a result in this cases..
     * 
     * @param body The message body string.
     * @return this
     */
    public MessageCreator setBody(final String body) {
        this.body = body;
        return this;
    }

    /**
     * The [Media](https://www.twilio.com/docs/api/chat/rest/media) Sid to be
     * attached to this Message..
     * 
     * @param mediaSid  The Media Sid to be attached to this Message.
     * @return this
     */
    public MessageCreator setMediaSid(final String mediaSid) {
        this.mediaSid = mediaSid;
        return this;
    }

    /**
     * Make the request to the Twilio API to perform the create.
     * 
     * @param client TwilioRestClient with which to make the request
     * @return Created Message
     */
    @Override
    @SuppressWarnings("checkstyle:linelength")
    public Message create(final TwilioRestClient client) {
        Request request = new Request(
            HttpMethod.POST,
            Domains.CHAT.toString(),
            "/v2/Services/" + this.pathServiceSid + "/Channels/" + this.pathChannelSid + "/Messages",
            client.getRegion()
        );

        addPostParams(request);
        Response response = client.request(request);

        if (response == null) {
            throw new ApiConnectionException("Message creation failed: Unable to connect to server");
        } else if (!TwilioRestClient.SUCCESS.apply(response.getStatusCode())) {
            RestException restException = RestException.fromJson(response.getStream(), client.getObjectMapper());
            if (restException == null) {
                throw new ApiException("Server Error, no content");
            }

            throw new ApiException(
                restException.getMessage(),
                restException.getCode(),
                restException.getMoreInfo(),
                restException.getStatus(),
                null
            );
        }

        return Message.fromJson(response.getStream(), client.getObjectMapper());
    }

    /**
     * Add the requested post parameters to the Request.
     * 
     * @param request Request to add post params to
     */
    private void addPostParams(final Request request) {
        if (from != null) {
            request.addPostParam("From", from);
        }

        if (attributes != null) {
            request.addPostParam("Attributes", attributes);
        }

        if (dateCreated != null) {
            request.addPostParam("DateCreated", dateCreated.toString());
        }

        if (dateUpdated != null) {
            request.addPostParam("DateUpdated", dateUpdated.toString());
        }

        if (lastUpdatedBy != null) {
            request.addPostParam("LastUpdatedBy", lastUpdatedBy);
        }

        if (body != null) {
            request.addPostParam("Body", body);
        }

        if (mediaSid != null) {
            request.addPostParam("MediaSid", mediaSid);
        }
    }
}