com.plivo.api.models.message

Class MessageCreator

java.lang.Object

com.plivo.api.models.base.BaseRequest

com.plivo.api.models.base.Creator<MessageCreateResponse>

com.plivo.api.models.message.MessageCreator

public class MessageCreator
extends Creator<MessageCreateResponse>

Represents an instance of a message created on PlivoClient.

Field Summary

Fields inherited from class com.plivo.api.models.base.BaseRequest

plivoClient

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	destination()
java.lang.String	dlt_entity_id()
MessageCreator	dlt_entity_id(java.lang.String dlt_entity_id)
java.lang.String	dlt_template_category()
MessageCreator	dlt_template_category(java.lang.String dlt_template_category)
java.lang.String	dlt_template_id()
MessageCreator	dlt_template_id(java.lang.String dlt_template_id)
java.lang.Boolean	log()
MessageCreator	log(java.lang.Boolean log)
java.lang.String[]	media_ids()
MessageCreator	media_ids(java.lang.String[] media_ids) + * @param media_ids The media ids is used to send media for MMS.
java.lang.String[]	media_urls()
MessageCreator	media_urls(java.lang.String[] media_urls) + * @param media_url The media url is used to send media for MMS.
java.lang.Long	message_expiry()
MessageCreator	message_expiry(java.lang.Long message_expiry)
java.lang.String	method()
MessageCreator	method(java.lang.String method)
protected retrofit2.Call<MessageCreateResponse>	obtainCall()
java.lang.String	source()
MessageCreator	template_json_string(java.lang.String template_json_string)
MessageCreator	template(Template temp)
java.lang.String	text()
MessageCreator	trackable(java.lang.Boolean trackable)
MessageType	type()
MessageCreator	type(MessageType type)
java.net.URL	url()
MessageCreator	url(java.net.URL url)

Methods inherited from class com.plivo.api.models.base.Creator

client, create

Methods inherited from class com.plivo.api.models.base.BaseRequest

client, handleResponse, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

source

public java.lang.String source()

destination

public java.util.List<java.lang.String> destination()

text

public java.lang.String text()

type

public MessageType type()

url

public java.net.URL url()

method

public java.lang.String method()

log

public java.lang.Boolean log()

media_urls

public java.lang.String[] media_urls()

media_ids

public java.lang.String[] media_ids()

message_expiry

public java.lang.Long message_expiry()

dlt_entity_id

public java.lang.String dlt_entity_id()

dlt_template_id

public java.lang.String dlt_template_id()

dlt_template_category

public java.lang.String dlt_template_category()

type

public MessageCreator type(MessageType type)

Parameters:

type - Must be MessageType.SMS

url

public MessageCreator url(java.net.URL url)

Parameters:

url - The URL to which with the status of the message is sent.

method

public MessageCreator method(java.lang.String method)

Parameters:

method - The method used to call the url. Defaults to POST.

log

public MessageCreator log(java.lang.Boolean log)

Parameters:

log - If set to false, the content of this message will not be logged on the Plivo infrastructure and the dst value will be masked

trackable

public MessageCreator trackable(java.lang.Boolean trackable)

Parameters:

trackable -

media_urls

public MessageCreator media_urls(java.lang.String[] media_urls)

+ * @param media_url The media url is used to send media for MMS. +

media_ids

public MessageCreator media_ids(java.lang.String[] media_ids)

+ * @param media_ids The media ids is used to send media for MMS. +

message_expiry

public MessageCreator message_expiry(java.lang.Long message_expiry)

dlt_entity_id

public MessageCreator dlt_entity_id(java.lang.String dlt_entity_id)

Parameters:

dlt_entity_id - This is the DLT entity id passed in the message request.

dlt_template_id

public MessageCreator dlt_template_id(java.lang.String dlt_template_id)

Parameters:

dlt_template_id - This is the DLT template id passed in the message request.

dlt_template_category

public MessageCreator dlt_template_category(java.lang.String dlt_template_category)

Parameters:

dlt_template_category - This is the DLT template category passed in the message request.

template_json_string

public MessageCreator template_json_string(java.lang.String template_json_string)

Parameters:

template_json_string - This is the template passed as a json string in the whatsapp message request.

template

public MessageCreator template(Template temp)

Parameters:

temp - This is the template passed as a template object in the whatsapp message request.

obtainCall

protected retrofit2.Call<MessageCreateResponse> obtainCall()

Specified by:

obtainCall in class Creator<MessageCreateResponse>