Package com.bandwidth.sdk.model

Class MultiChannelMessageRequest

java.lang.Object

com.bandwidth.sdk.model.MultiChannelMessageRequest

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.10.0")
public class MultiChannelMessageRequest
extends Object

Multi-Channel Message Request

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MultiChannelMessageRequest.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_CHANNEL_LIST
static final String	SERIALIZED_NAME_EXPIRATION
static final String	SERIALIZED_NAME_PRIORITY
static final String	SERIALIZED_NAME_TAG
static final String	SERIALIZED_NAME_TO

Constructor Summary

Constructors

Constructor	Description
MultiChannelMessageRequest()

Method Summary

Modifier and Type	Method	Description
MultiChannelMessageRequest	addChannelListItem(MultiChannelChannelListObject channelListItem)
MultiChannelMessageRequest	channelList(List<MultiChannelChannelListObject> channelList)
boolean	equals(Object o)
MultiChannelMessageRequest	expiration(OffsetDateTime expiration)
static MultiChannelMessageRequest	fromJson(String jsonString)	Create an instance of MultiChannelMessageRequest given an JSON string
Map<String,Object>	getAdditionalProperties()	Return the additional (undeclared) property.
Object	getAdditionalProperty(String key)	Return the additional (undeclared) property with the specified name.
List<MultiChannelChannelListObject>	getChannelList()	A list of message bodies.
OffsetDateTime	getExpiration()	A string with the date/time value that the message will automatically expire by.
PriorityEnum	getPriority()	Get priority
String	getTag()	A custom string that will be included in callback events of the message.
String	getTo()	The phone number the message should be sent to in E164 format.
int	hashCode()
MultiChannelMessageRequest	priority(PriorityEnum priority)
MultiChannelMessageRequest	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
void	setChannelList(List<MultiChannelChannelListObject> channelList)
void	setExpiration(OffsetDateTime expiration)
void	setPriority(PriorityEnum priority)
void	setTag(String tag)
void	setTo(String to)
MultiChannelMessageRequest	tag(String tag)
MultiChannelMessageRequest	to(String to)
String	toJson()	Convert an instance of MultiChannelMessageRequest to an JSON string
String	toString()
static void	validateJsonElement(com.google.gson.JsonElement jsonElement)	Validates the JSON Element and throws an exception if issues found

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SERIALIZED_NAME_TO

public static final String SERIALIZED_NAME_TO

See Also:

• Constant Field Values

SERIALIZED_NAME_CHANNEL_LIST

public static final String SERIALIZED_NAME_CHANNEL_LIST

See Also:

• Constant Field Values

SERIALIZED_NAME_TAG

public static final String SERIALIZED_NAME_TAG

See Also:

• Constant Field Values

SERIALIZED_NAME_PRIORITY

public static final String SERIALIZED_NAME_PRIORITY

See Also:

• Constant Field Values

SERIALIZED_NAME_EXPIRATION

public static final String SERIALIZED_NAME_EXPIRATION

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

MultiChannelMessageRequest

public MultiChannelMessageRequest()

Method Details

to

public MultiChannelMessageRequest to(@Nonnull
 String to)

getTo

@Nonnull
public String getTo()

The phone number the message should be sent to in E164 format.

Returns:

to

setTo

public void setTo(@Nonnull
 String to)

channelList

public MultiChannelMessageRequest channelList(@Nonnull
 List<MultiChannelChannelListObject> channelList)

addChannelListItem

public MultiChannelMessageRequest addChannelListItem(MultiChannelChannelListObject channelListItem)

getChannelList

@Nonnull
public List<MultiChannelChannelListObject> getChannelList()

A list of message bodies. The messages will be attempted in the order they are listed. Once a message sends successfully, the others will be ignored.

Returns:

channelList

setChannelList

public void setChannelList(@Nonnull
 List<MultiChannelChannelListObject> channelList)

tag

public MultiChannelMessageRequest tag(@Nullable
 String tag)

getTag

@Nullable
public String getTag()

A custom string that will be included in callback events of the message. Max 1024 characters.

Returns:

tag

setTag

public void setTag(@Nullable
 String tag)

priority

public MultiChannelMessageRequest priority(@Nullable
 PriorityEnum priority)

getPriority

@Nullable
public PriorityEnum getPriority()

Get priority

Returns:

priority

setPriority

public void setPriority(@Nullable
 PriorityEnum priority)

expiration

public MultiChannelMessageRequest expiration(@Nullable
 OffsetDateTime expiration)

getExpiration

@Nullable
public OffsetDateTime getExpiration()

A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future.

Returns:

expiration

setExpiration

public void setExpiration(@Nullable
 OffsetDateTime expiration)

putAdditionalProperty

public MultiChannelMessageRequest putAdditionalProperty(String key,
 Object value)

Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

Parameters:

key - name of the property

value - value of the property

Returns:

the MultiChannelMessageRequest instance itself

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Return the additional (undeclared) property.

Returns:

a map of objects

getAdditionalProperty

public Object getAdditionalProperty(String key)

Return the additional (undeclared) property with the specified name.

Parameters:

key - name of the property

Returns:

an object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

validateJsonElement

public static void validateJsonElement(com.google.gson.JsonElement jsonElement)
                                throws IOException

Validates the JSON Element and throws an exception if issues found

Parameters:

jsonElement - JSON Element

Throws:

IOException - if the JSON Element is invalid with respect to MultiChannelMessageRequest

fromJson

public static MultiChannelMessageRequest fromJson(String jsonString)
                                           throws IOException

Create an instance of MultiChannelMessageRequest given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of MultiChannelMessageRequest

Throws:

IOException - if the JSON string is invalid with respect to MultiChannelMessageRequest

toJson

public String toJson()

Convert an instance of MultiChannelMessageRequest to an JSON string

Returns:

JSON string