com.messagebird.objects

Class Message

java.lang.Object

com.messagebird.objects.Message

All Implemented Interfaces:

MessageBase, Serializable

public class Message
extends Object
implements MessageBase, Serializable

Class to hold's a Voice message that can be send

Created by rvt on 1/7/15.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Message(String originator, String body, List<BigInteger> recipients)
Message(String originator, String body, String recipients)

Method Summary

Modifier and Type	Method and Description
static Message	createBinarySMS(String originator, String header, String body, List<BigInteger> recipients) Factory to create Binary SMS message
static Message	createBinarySMS(String originator, String header, String body, String recipients) Factory to create Binary SMS message
String	getBody() The body of the SMS message.
DataCodingType	getDatacoding() The datacoding used, can be plain or unicode
Integer	getGateway() The configured SMS route that is used to send the message.
MClassType	getMclass() Indicated the message type.
String	getOriginator() The sender of the message.
String	getRecipients() The list of recipients msisdn's.
String	getReference()
URL	getReportUrl()
Date	getScheduledDatetime() The scheduled date and time of the message
MsgType	getType() The configured message type.
Map<String,Object>	getTypeDetails() An hash with extra information.
Integer	getValidity() The configured validity The amount of seconds that the message is valid.
protected static String	receipientsAsCommaSeperated(List<BigInteger> recipients) generates a string from List
void	setDatacoding(DataCodingType datacoding) The datacoding used, can be plain or unicode
void	setGateway(Integer gateway) The SMS route that is used to send the message.
void	setPremiumSMS(Object shortcode, Object keyword, Object tariff, Object mid) Setup premium SMS type
void	setReference(String reference)
void	setReportUrl(URL reportUrl)
void	setScheduledDatetime(Date scheduledDatetime) The scheduled date and time of the message.
void	setType(MsgType type) The type of message.
void	setTypeDetails(Map<String,Object> typeDetails) An hash with extra information.
void	setValidity(Integer validity) The amount of seconds that the message is valid.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Message

public Message(String originator,
               String body,
               String recipients)

Message

public Message(String originator,
               String body,
               List<BigInteger> recipients)

Method Detail

createBinarySMS

public static Message createBinarySMS(String originator,
                                      String header,
                                      String body,
                                      String recipients)

Factory to create Binary SMS message

Parameters:

originator -

header -

body -

recipients -

Returns:

createBinarySMS

public static Message createBinarySMS(String originator,
                                      String header,
                                      String body,
                                      List<BigInteger> recipients)

Factory to create Binary SMS message

Parameters:

originator -

header -

body -

recipients -

Returns:

receipientsAsCommaSeperated

protected static String receipientsAsCommaSeperated(List<BigInteger> recipients)

generates a string from List

Parameters:

recipients -

Returns:

toString

public String toString()

Overrides:

toString in class Object

getOriginator

public String getOriginator()

The sender of the message. This can be a telephone number (including country code) or an alphanumeric string. In case of an alphanumeric string, the maximum length is 11 characters.

Returns:

originator of the message

getBody

public String getBody()

Description copied from interface: MessageBase

The body of the SMS message.

Specified by:

getBody in interface MessageBase

Returns:

Message body

getRecipients

public String getRecipients()

Description copied from interface: MessageBase

The list of recipients msisdn's.

Specified by:

getRecipients in interface MessageBase

Returns:

String of comma separated recipients

getType

public MsgType getType()

The configured message type. Values can be: sms, binary, premium, or flash.

Returns:

MsgType that has been configured

setType

public void setType(MsgType type)

The type of message. Values can be: sms, binary, premium, or flash. Default: sms (set by MessageBird and will not be send)

Parameters:

type - Message Type

getReference

public String getReference()

Specified by:

getReference in interface MessageBase

Returns:

your own reference

setReference

public void setReference(String reference)

Parameters:

reference - The client reference

getValidity

public Integer getValidity()

The configured validity The amount of seconds that the message is valid. If a message is not delivered within this time, the message will be discarded.

Returns:

validity value

setValidity

public void setValidity(Integer validity)

The amount of seconds that the message is valid. If a message is not delivered within this time, the message will be discarded.

Parameters:

validity -

getGateway

public Integer getGateway()

The configured SMS route that is used to send the message.

Returns:

routing number

setGateway

public void setGateway(Integer gateway)

The SMS route that is used to send the message.

Parameters:

gateway -

getTypeDetails

public Map<String,Object> getTypeDetails()

An hash with extra information. Is only used when a binary or premium message is sent.

Note: Interface might change in feature

Returns:

Map with specific items for that request

setTypeDetails

public void setTypeDetails(Map<String,Object> typeDetails)

An hash with extra information. Is only used when a binary or premium message is sent.

Note: Interface might change in feature

getDatacoding

public DataCodingType getDatacoding()

The datacoding used, can be plain or unicode

Returns:

returns plain or unicode

setDatacoding

public void setDatacoding(DataCodingType datacoding)

The datacoding used, can be plain or unicode

Parameters:

datacoding -

getMclass

public MClassType getMclass()

Indicated the message type.

Returns:

getScheduledDatetime

public Date getScheduledDatetime()

Description copied from interface: MessageBase

The scheduled date and time of the message

Specified by:

getScheduledDatetime in interface MessageBase

Returns:

the configured date/time to send the mesage, this is handled on the message bird platform

setScheduledDatetime

public void setScheduledDatetime(Date scheduledDatetime)

The scheduled date and time of the message. Allows to specify when MessageBird server send's the mesage.

Parameters:

scheduledDatetime -

setPremiumSMS

public void setPremiumSMS(Object shortcode,
                          Object keyword,
                          Object tariff,
                          Object mid)

Setup premium SMS type

Parameters:

shortcode -

keyword -

tariff -

mid -

getReportUrl

public URL getReportUrl()

setReportUrl

public void setReportUrl(URL reportUrl)