com.clivern.wit.api

Class Message

java.lang.Object

com.clivern.wit.api.Message

All Implemented Interfaces:

Contract

public class Message
extends java.lang.Object
implements Contract

Message API

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	accessToken
java.lang.String	appId
java.lang.String	contentType
java.lang.String	context
java.util.Map<java.lang.String,java.lang.String>	data
java.lang.String	endpointName
java.lang.String	finalData
java.util.Map<java.lang.String,java.lang.String>	headers
java.lang.String	method
java.lang.String	msgId
java.lang.Integer	n
java.lang.String	q
java.lang.String	threadId
java.lang.String	url
java.lang.Boolean	verbose

Constructor Summary

Constructors

Constructor and Description
Message(java.lang.String endpointName) Class Constructor
Message(java.lang.String endpointName, java.lang.String contentType) Class Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	config() Configure The API Call Info
java.lang.String	debug() Debug The Request This Used for Development Purposes and Shouldn't used in Production
java.lang.String	getAccessToken() Get Access Token
java.lang.String	getAppId() Get The App ID
java.lang.String	getContext() Get context object (JSON)
java.lang.String	getData() Get The Data to Send
java.util.Map<java.lang.String,java.lang.String>	getHeaders() Get The Headers
java.lang.String	getMethod() Get The Method
java.lang.String	getMsgId() Get The Message ID
java.lang.Integer	getN() Get The number of n-best trait entities you want to get back.
java.lang.String	getQ() Get Q (User’s query).
java.lang.String	getThreadId() Get The Thread ID
java.lang.String	getUrl() Get The URL
java.lang.Boolean	getVerbose() Get Verbose Status.
void	setAccessToken(java.lang.String accessToken) Set Access Token
void	setAppId(java.lang.String appId) Set App ID
void	setContext(java.lang.String context) Set context object (JSON)
void	setMsgId(java.lang.String msgId) Set The Message ID
void	setN(java.lang.Integer n) Set The number of n-best trait entities you want to get back.
void	setQ(java.lang.String q) Set Q (User’s query).
void	setThreadId(java.lang.String threadId) Set The Thread ID
void	setVerbose(java.lang.Boolean verbose) Set Verbose Status.

Methods inherited from class java.lang.Object

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

Field Detail

appId

public java.lang.String appId

accessToken

public java.lang.String accessToken

endpointName

public java.lang.String endpointName

contentType

public java.lang.String contentType

url

public java.lang.String url

method

public java.lang.String method

data

public java.util.Map<java.lang.String,java.lang.String> data

finalData

public java.lang.String finalData

headers

public java.util.Map<java.lang.String,java.lang.String> headers

q

public java.lang.String q

context

public java.lang.String context

msgId

public java.lang.String msgId

threadId

public java.lang.String threadId

n

public java.lang.Integer n

verbose

public java.lang.Boolean verbose

Constructor Detail

Message

public Message(java.lang.String endpointName)

Class Constructor

Parameters:

endpointName - The Endpoint Name

Message

public Message(java.lang.String endpointName,
               java.lang.String contentType)

Class Constructor

Parameters:

endpointName - The Endpoint Name

contentType - The Content Type

Method Detail

config

public java.lang.Boolean config()
                         throws DataNotValid,
                                DataNotFound

Configure The API Call Info

Specified by:

config in interface Contract

Returns:

Boolean Whether Call Will be Valid or Not

Throws:

DataNotValid - Invalid Data Within The Request

DataNotFound - Some Data are Missing

getUrl

public java.lang.String getUrl()

Get The URL

Specified by:

getUrl in interface Contract

Returns:

String The URL

getMethod

public java.lang.String getMethod()

Get The Method

Specified by:

getMethod in interface Contract

Returns:

String The Method

getHeaders

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

Get The Headers

Specified by:

getHeaders in interface Contract

Returns:

Map The Headers

getQ

public java.lang.String getQ()

Get Q (User’s query). Length must be more than 0 and less than 256

Returns:

String The users query

getContext

public java.lang.String getContext()

Get context object (JSON)

Returns:

String The context object JSON

getMsgId

public java.lang.String getMsgId()

Get The Message ID

Returns:

String The Message ID

getThreadId

public java.lang.String getThreadId()

Get The Thread ID

Returns:

String The Thread ID

getN

public java.lang.Integer getN()

Get The number of n-best trait entities you want to get back. The Default is 1, and the maximum is 8

Returns:

Integer The number of n-best

getVerbose

public java.lang.Boolean getVerbose()

Get Verbose Status. A flag to get auxiliary information about entities, like the location within the sentence.

Returns:

Boolean The Verbose Value

getData

public java.lang.String getData()

Get The Data to Send

Specified by:

getData in interface Contract

Returns:

String The Data to Send

getAppId

public java.lang.String getAppId()

Get The App ID

Specified by:

getAppId in interface Contract

Returns:

String The App ID

getAccessToken

public java.lang.String getAccessToken()

Get Access Token

Specified by:

getAccessToken in interface Contract

Returns:

String The Access Token

setQ

public void setQ(java.lang.String q)

Set Q (User’s query). Length must be more than 0 and less than 256

Parameters:

q - The users query

setContext

public void setContext(java.lang.String context)

Set context object (JSON)

Parameters:

context - The context object JSON

setMsgId

public void setMsgId(java.lang.String msgId)

Set The Message ID

Parameters:

msgId - The Message ID

setThreadId

public void setThreadId(java.lang.String threadId)

Set The Thread ID

Parameters:

threadId - The Thread ID

setN

public void setN(java.lang.Integer n)

Set The number of n-best trait entities you want to get back. The Default is 1, and the maximum is 8

Parameters:

n - The number of n-best

setVerbose

public void setVerbose(java.lang.Boolean verbose)

Set Verbose Status. A flag to get auxiliary information about entities, like the location within the sentence.

Parameters:

verbose - The Verbose Value

setAppId

public void setAppId(java.lang.String appId)

Set App ID

Specified by:

setAppId in interface Contract

Parameters:

appId - Application ID

setAccessToken

public void setAccessToken(java.lang.String accessToken)

Set Access Token

Specified by:

setAccessToken in interface Contract

Parameters:

accessToken - Access Token

debug

public java.lang.String debug()

Debug The Request This Used for Development Purposes and Shouldn't used in Production

Specified by:

debug in interface Contract

Returns:

String The debug data