com.intele.chimera.client.request

Class Sms.Builder

java.lang.Object

com.intele.chimera.client.request.Sms.Builder

Enclosing class:

Sms

public static class Sms.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder(String recipient, String content) Set the recipient and message content.

Method Summary

Modifier and Type	Method and Description
Sms	build()
Sms.Builder	withAge(int age) Sets the minimum age of the recipient.
Sms.Builder	withClientReference(String clientReference) Arbitrary client reference ID that will be returned in the message response.
Sms.Builder	withDifferentiator(String differentiator) Sets the name of the message group.
Sms.Builder	withGasSettings(GasSettings gasSettings) Specify GAS (Goods and Services) values.
Sms.Builder	withInvoiceNode(String invoiceNode) Sets a custom group name for the invoice.
Sms.Builder	withNewSession(boolean newSession) Start a new session.
Sms.Builder	withOriginatorSettings(com.intele.chimera.gw.xsd.smsgateway.request._2013._02.OriginatorTypeEnum originatorType, String originator) Sets the originator.
Sms.Builder	withParameters(List<com.intele.chimera.gw.xsd.smsgateway.request._2013._02.Parameter> parameters) Used add special parameters to the message.
Sms.Builder	withPrice(int price) Set the price of the message.
Sms.Builder	withPriority(int priority) Set the priority of the message.
Sms.Builder	withSafeRemoveNonGsmCharacters(boolean safeRemoveNonGsmCharacters) Decides if non-GSM characters should be removed from the content text.
Sms.Builder	withSendWindow(SendWindow sendWindow) Specify the send window for the message.
Sms.Builder	withSessionId(String sessionId) Use an existing session.
Sms.Builder	withValidity(int validity) Set a validity for the message.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(String recipient,
               String content)

Set the recipient and message content.

Parameters:

recipient - The MSISDN of the recipient. The format should follow the ITU-T E.164 standard with a + prefix, e.g. +4792000001.

content - The message payload to send, typically the message text. See chapter 3.4 in the ITC SMS Gateway API specification for more details

Method Detail

withPrice

public Sms.Builder withPrice(int price)

Set the price of the message.

Parameters:

price - The cost for the recipient to receive the message. In lowest monetary unit. See chapter 3.1 in the ITC SMS Gateway API specification for details. Example: 200 (2,- NOK)

Returns:

the updated builder

withClientReference

public Sms.Builder withClientReference(String clientReference)

Arbitrary client reference ID that will be returned in the message response.

Parameters:

clientReference - the client message ID

Returns:

the updated builder

withPriority

public Sms.Builder withPriority(int priority)

Set the priority of the message.

Parameters:

priority - Uses service value unless specified. Used to prioritize between messages sent from the same service. 1: low (slower) 2: medium 3: high (faster)

Returns:

the updated builder

withValidity

public Sms.Builder withValidity(int validity)

Set a validity for the message.

Parameters:

validity - Uses service value unless specified. Specifies the TTL (time to live) for the message, i.e. how long before the message times out in cases where it cannot be delivered to a handset. See chapter 3.3 in the ITC SMS Gateway API specification for valid values. Example: 173

Returns:

the updated builder

withDifferentiator

public Sms.Builder withDifferentiator(String differentiator)

Sets the name of the message group.

Parameters:

differentiator - Arbitrary string set by the client to enable grouping messages in certain statistic reports. Example: pincode_messages

Returns:

the updated builder

withAge

public Sms.Builder withAge(int age)

Sets the minimum age of the recipient.

Parameters:

age - Only relevant for CPA/GAS messages. Defines an age limit for message content. The mobile network operators enforces this. IMPORTANT: If the service is a subscription service all CPA/GAS messages must have age set to 18.

Returns:

the updated builder

withNewSession

public Sms.Builder withNewSession(boolean newSession)

Start a new session.

Parameters:

newSession - Used to start a new session. See chapter 3.5 in the ITC SMS Gateway API specification for details.

Returns:

the updated builder

withSessionId

public Sms.Builder withSessionId(String sessionId)

Use an existing session.

Parameters:

sessionId - Used to continue an existing session. See chapter 3.5 in the ITC SMS Gateway API for details.

Returns:

the updated builder

withInvoiceNode

public Sms.Builder withInvoiceNode(String invoiceNode)

Sets a custom group name for the invoice.

Parameters:

invoiceNode - Arbitrary string set by the client to enable grouping messages on the service invoice.

Returns:

the updated builder

withSafeRemoveNonGsmCharacters

public Sms.Builder withSafeRemoveNonGsmCharacters(boolean safeRemoveNonGsmCharacters)

Decides if non-GSM characters should be removed from the content text.

Parameters:

safeRemoveNonGsmCharacters - Default value is false. If set to true the SMSGW will remove or safely substitute invalid characters in the message content instead of rejecting the message. See chapter 3.4 in the ITC SMS Gateway API for details.

Returns:

the updated builder

withParameters

public Sms.Builder withParameters(List<com.intele.chimera.gw.xsd.smsgateway.request._2013._02.Parameter> parameters)

Used add special parameters to the message. See 3.7.3.4 in the ITC SMS Gateway API for valid keys and values.

Parameters:

key -

value -

Returns:

the updated builder

withOriginatorSettings

public Sms.Builder withOriginatorSettings(com.intele.chimera.gw.xsd.smsgateway.request._2013._02.OriginatorTypeEnum originatorType,
                                          String originator)

Sets the originator.

Parameters:

originatorType - Specifies the type of originator. See chapter 3.2 in the ITC SMS Gateway API for details.

originator - Depends on the originatorType. Examples: "+4799999999", "Intelecom", "1960"

Returns:

the updated builder

withGasSettings

public Sms.Builder withGasSettings(GasSettings gasSettings)

Specify GAS (Goods and Services) values. See chapter 3.1 in the ITC SMS Gateway API for details.

Parameters:

gasSettings -

Returns:

the updated builder

withSendWindow

public Sms.Builder withSendWindow(SendWindow sendWindow)

Specify the send window for the message. See chapter 3.6 in the ITC SMS Gateway API.

Used if the message should be queued and sent in the future instead of immediately.

Parameters:

sendWindow -

Returns:

the updated builder

build

public Sms build()

Returns:

the newly created Sms