Platform SDK Java 8.5 API Reference

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

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.NoticeText
All Implemented Interfaces:
ProtocolDescriptionSupport

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


Constructor Summary
NoticeText()
           
 
Method Summary
static NoticeText create()
          Creates instance of NoticeText with no parameters set.
static NoticeText create(NoticeType noticeType, java.lang.String text)
          Creates instance of NoticeText with all parameters set.
static NoticeText create(java.lang.String text)
          Creates instance of NoticeText with required parameters set.
abstract  NoticeType getNoticeType()
          Type of notification (for example: typing, push URL, or custom notification).
abstract  java.lang.String getText()
          Any arbitrary text.
abstract  void setNoticeType(NoticeType noticeType)
          Type of notification (for example: typing, push URL, or custom notification).
abstract  void setText(java.lang.String text)
          Any arbitrary text.
 
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

NoticeText

public NoticeText()
Method Detail

create

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

Returns:
instance of NoticeText

create

public static NoticeText create(NoticeType noticeType,
                                java.lang.String text)
Creates instance of NoticeText with all parameters set.

Parameters:
noticeType - NoticeType
text - Text
Returns:
instance of NoticeText

create

public static NoticeText create(java.lang.String text)
Creates instance of NoticeText with required parameters set.

Parameters:
text - Text
Returns:
instance of NoticeText

getNoticeType

public abstract NoticeType getNoticeType()
Type of notification (for example: typing, push URL, or custom notification). Must be specified with a value other than None.


setNoticeType

public abstract void setNoticeType(NoticeType noticeType)
Type of notification (for example: typing, push URL, or custom notification). Must be specified with a value other than None.


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.