Platform SDK Java 8.5 API Reference

com.genesyslab.platform.webmedia.protocol.basicchat
Class MessageText

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.runtime.CompoundValue
          extended by com.genesyslab.platform.webmedia.protocol.basicchat.MessageText
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class MessageText
extends com.genesyslab.platform.commons.protocol.runtime.CompoundValue


Constructor Summary
MessageText()
           
 
Method Summary
static MessageText create()
          Creates instance of MessageText with no parameters set.
static MessageText create(MsgCheck msgCheck, java.lang.String messageType, TreatAs treatAs, java.lang.String text)
          Creates instance of MessageText.
static MessageText create(java.lang.String text)
          Creates instance of MessageText.
static MessageText create(java.lang.String messageType, TreatAs treatAs, java.lang.String text)
          Creates instance of MessageText.
abstract  java.lang.String getMessageType()
          Defines the message type for each MessageText object.
abstract  MsgCheck getMsgCheck()
          Defines message checking information.
abstract  java.lang.String getText()
          Any arbitrary text.
abstract  TreatAs getTreatAs()
          Specifies how MeassageText should be treated: NORMAL or SYSTEM.
abstract  void setMessageType(java.lang.String messageType)
          Defines the message type for each MessageText object.
abstract  void setMsgCheck(MsgCheck msgCheck)
          Defines message checking information.
abstract  void setText(java.lang.String text)
          Any arbitrary text.
abstract  void setTreatAs(TreatAs treatAs)
          Specifies how MeassageText should be treated: NORMAL or SYSTEM.
 
Methods inherited from class com.genesyslab.platform.commons.protocol.runtime.CompoundValue
getProtocolDescription
 
Methods inherited from class com.genesyslab.platform.commons.protocol.DataObject
equals, hashCode, toString, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MessageText

public MessageText()
Method Detail

create

public static MessageText create()
Creates instance of MessageText with no parameters set.

Returns:
instance of MessageText

create

public static MessageText create(java.lang.String text)
Creates instance of MessageText.

Parameters:
text - Text
Returns:
instance of MessageText

create

public static MessageText create(java.lang.String messageType,
                                 TreatAs treatAs,
                                 java.lang.String text)
Creates instance of MessageText.

Parameters:
messageType - MessageType
treatAs - TreatAs
text - Text
Returns:
instance of MessageText

create

public static MessageText create(MsgCheck msgCheck,
                                 java.lang.String messageType,
                                 TreatAs treatAs,
                                 java.lang.String text)
Creates instance of MessageText.

Parameters:
msgCheck - MsgCheck
messageType - MessageType
treatAs - TreatAs
text - Text
Returns:
instance of MessageText

getMsgCheck

public abstract MsgCheck getMsgCheck()
Defines message checking information.


setMsgCheck

public abstract void setMsgCheck(MsgCheck msgCheck)
Defines message checking information.


getMessageType

public abstract java.lang.String getMessageType()
Defines the message type for each MessageText object.


setMessageType

public abstract void setMessageType(java.lang.String messageType)
Defines the message type for each MessageText object.


getTreatAs

public abstract TreatAs getTreatAs()
Specifies how MeassageText should be treated: NORMAL or SYSTEM.


setTreatAs

public abstract void setTreatAs(TreatAs treatAs)
Specifies how MeassageText should be treated: NORMAL or SYSTEM.


getText

public abstract java.lang.String getText()
Any arbitrary text. For example, when used with the NoticeText class this could contain a URL if the NoticeType is set to PushURL or be empty for TypingStarted notifications.


setText

public abstract void setText(java.lang.String text)
Any arbitrary text. For example, when used with the NoticeText class this could contain a URL if the NoticeType is set to PushURL or be empty for TypingStarted notifications.


Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.