com.askfast.model

Class DialogRequest

java.lang.Object

com.askfast.model.DialogRequest

public class DialogRequest
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
DialogRequest(java.util.Map<java.lang.String,java.lang.String> addressMap, java.util.Map<java.lang.String,java.lang.String> addressCcMap, java.util.Map<java.lang.String,java.lang.String> addressBccMap, AdapterType adapterType, java.lang.String adapterID, java.lang.String senderName, java.lang.String subject, java.lang.String url) A detailed consturctor which can be used to send a broadcast with a specific senderName
DialogRequest(java.lang.String address, AdapterType adapterType, java.lang.String adapterId, java.lang.String senderName, java.lang.String subject, java.lang.String url) A consturctor which can be used to trigger an outbound request

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAdapterID()
AdapterType	getAdapterType()
java.lang.String	getAddress()
java.util.Map<java.lang.String,java.lang.String>	getAddressBccMap()
java.util.Map<java.lang.String,java.lang.String>	getAddressCcMap()
java.util.Collection<java.lang.String>	getAddressList()
java.util.Map<java.lang.String,java.lang.String>	getAddressMap()
java.util.HashMap<java.lang.String,java.lang.String>	getAllAddresses() Collates all the addresses in the address, addressList, addressMaps
java.lang.String	getSenderName()
java.lang.String	getSubject()
java.lang.String	getUrl()
boolean	isValidRequest() Just validates the request payload
void	setAdapterID(java.lang.String adapterID)
void	setAdapterType(AdapterType adapterType)
void	setAddress(java.lang.String address)
void	setAddressBccMap(java.util.Map<java.lang.String,java.lang.String> addressBccMap)
void	setAddressCcMap(java.util.Map<java.lang.String,java.lang.String> addressCcMap)
void	setAddressList(java.util.Collection<java.lang.String> addressList)
void	setAddressMap(java.util.Map<java.lang.String,java.lang.String> addressMap)
void	setSenderName(java.lang.String senderName)
void	setSubject(java.lang.String subject)
void	setUrl(java.lang.String url)

Methods inherited from class java.lang.Object

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

Constructor Detail

DialogRequest

public DialogRequest(java.util.Map<java.lang.String,java.lang.String> addressMap,
                     java.util.Map<java.lang.String,java.lang.String> addressCcMap,
                     java.util.Map<java.lang.String,java.lang.String> addressBccMap,
                     AdapterType adapterType,
                     java.lang.String adapterID,
                     java.lang.String senderName,
                     java.lang.String subject,
                     java.lang.String url)

A detailed consturctor which can be used to send a broadcast with a specific senderName

Parameters:

addressMap - The key value pairs of {toAddress, recipientName}

addressCcMap - The key value pairs of {ccAddress, recipientName}. Used in case of an email adapter only

addressBccMap - The key value pairs of {bccAddress, recipientName}. Used in case of an email adapter only

adapterType - The type of communication opted for this outbound dialog. The first adapter of the given type is chosen if there are multiple ones exist. Usually either one of adapterType or adapterID is passed, although this constructor ignores the adapterType if the adapterID is present. An error is returned if its set outside of this constructor.

adapterID - The id identifying a particular mode of communication. These values can be retried from ASK-Fast Portal in the adapters section.

senderName - A senderName can be attached for medium types: SMS, EMAIL. For SMS, the length should not exceed 11 charecters.

subject - Only valid for an email adapter. The subject of the message to be sent

url - This can be one of:
1. http(s) endpoint fetching a Question json as response.
2. A standard text prefixed by keyword: text://your message. This will be transformed to a Question.QUESTION_TYPE_COMMENT
3. A unique dialogId as defined in the ASK-Fast Portal or by method AskFastRestClient.createDialog(Dialog) method

DialogRequest

public DialogRequest(java.lang.String address,
                     AdapterType adapterType,
                     java.lang.String adapterId,
                     java.lang.String senderName,
                     java.lang.String subject,
                     java.lang.String url)

A consturctor which can be used to trigger an outbound request

Parameters:

address - The address of the receipient. E.g. Phonenumber for Call, SMS and Email for Email adpater.

adapterType - The type of communication opted for this outbound dialog. The first adapter of the given type is chosen if there are multiple ones exist. Usually either one of adapterType or adapterID is passed, although this constructor ignores the adapterType if the adapterID is present. An error is returned if its set outside of this constructor.

adapterId - The id identifying a particular mode of communication. These values can be retried from ASK-Fast Portal in the adapters section.

senderName - A senderName can be attached for medium types: SMS, EMAIL. For SMS, the length should not exceed 11 charecters.

subject - Only valid for an email adapter. The subject of the message to be sent

url - This can be one of:
1. http(s) endpoint fetching a Question json as response.
2. A standard text prefixed by keyword: text://your message. This will be transformed to a Question.QUESTION_TYPE_COMMENT
3. A unique dialogId as defined in the ASK-Fast Portal or by method AskFastRestClient.createDialog(Dialog) method

Method Detail

getAddress

public java.lang.String getAddress()

setAddress

public void setAddress(java.lang.String address)

getAddressList

public java.util.Collection<java.lang.String> getAddressList()

setAddressList

public void setAddressList(java.util.Collection<java.lang.String> addressList)

getAddressMap

public java.util.Map<java.lang.String,java.lang.String> getAddressMap()

setAddressMap

public void setAddressMap(java.util.Map<java.lang.String,java.lang.String> addressMap)

getAddressCcMap

public java.util.Map<java.lang.String,java.lang.String> getAddressCcMap()

setAddressCcMap

public void setAddressCcMap(java.util.Map<java.lang.String,java.lang.String> addressCcMap)

getAddressBccMap

public java.util.Map<java.lang.String,java.lang.String> getAddressBccMap()

setAddressBccMap

public void setAddressBccMap(java.util.Map<java.lang.String,java.lang.String> addressBccMap)

getSenderName

public java.lang.String getSenderName()

setSenderName

public void setSenderName(java.lang.String senderName)

getSubject

public java.lang.String getSubject()

setSubject

public void setSubject(java.lang.String subject)

getUrl

public java.lang.String getUrl()

setUrl

public void setUrl(java.lang.String url)

getAdapterType

public AdapterType getAdapterType()

setAdapterType

public void setAdapterType(AdapterType adapterType)

getAdapterID

public java.lang.String getAdapterID()

setAdapterID

public void setAdapterID(java.lang.String adapterID)

getAllAddresses

public java.util.HashMap<java.lang.String,java.lang.String> getAllAddresses()

Collates all the addresses in the address, addressList, addressMaps

Returns:

All the addresses as a map

isValidRequest

public boolean isValidRequest()

Just validates the request payload

Returns:

If this dialogRequest if formatted properly