Platform SDK Java 8.5 API Reference

Package com.genesyslab.platform.webmedia.protocol

This package contains the Protocol classes that allow you to create applications that integrate with Genesys non-voice media servers.

See:
          Description

Interface Summary
BasicChatProtocolHandshakeOptions Dedicated interface to represent Basic Chat Server protocol handshake parameters.
EspEmailProtocolHandshakeOptions Dedicated interface to represent ESP based Genesys Email Server protocol handshake parameters.
FlexChatProtocolHandshakeOptions Dedicated interface to represent Flex Chat Server protocol handshake parameters.
 

Class Summary
BasicChatProtocol By default, BasicChatProtocol has enabled AutoRegister mode.
BasicChatServerContext  
CallbackProtocol  
CallbackProtocolListener Callback ServerChannel component for handling of Genesys Callback Server protocol clients.
Here is a simple example of synchronous server side procedure:
ChatProtocolsListener Customized ServerChannel component for handling of Genesys Chat Server protocols - Flex Chat and Basic Chat.
It accepts connections of the both client types at a same time.
EmailProtocol Deprecated.  
EmailProtocolListener Deprecated.  
EspEmailProtocol Use an EspEmailProtocol object to establish communication between client application and ESP based Email Server.
EspEmailProtocolListener EspEmail ServerChannel component for handling of Genesys Callback Server protocol clients.
Here is a simple example of synchronous server side procedure:
FlexChatProtocol By default, channel has enabled AutoRegister mode.
FlexChatServerContext Context of Chat Servers Flex Protocol connection.
NoticeType  
OptionalRegistrationChannel  
WebmediaChannel It's an abstract base class for all WebMedia protocols including BasicChat, FlexChat, Callback and XML based Email protocols.
 

Package com.genesyslab.platform.webmedia.protocol Description

This package contains the Protocol classes that allow you to create applications that integrate with Genesys non-voice media servers. The WebmediaChannel class allows you to establish a communications channel for web media interactions, while the remaining classes provide access to the specific Genesys media servers you will be using (E-mail Server Java, Chat Server, and Callback Server).

When you write your applications, you will need to set up and open the appropriate Protocol object. For example, the following code might be used if you are working with the BasicChatProtocol package:

BasicChatProtocol chatServerProtocol =
  new BasicChatProtocol(
   new Endpoint(
    chatServerUri));
chatServerProtocol.open();

After opening the protocol object, you will be able to send messages to and receive from the Chat Server you have connected with. For more information on these messages, please refer to the documentation for the events and requests packages associated with this SDK, for example com.genesyslab.platform.webmedia.protocol.basicchat.events or com.genesyslab.platform.webmedia.protocol.basicchat.requests.

For general information on the structure and usage of the Platform SDKs, or an introduction to the use of the WebMedia Platform SDK,please refer to the introductory articles located in the Platform SDK Developer's Guide.


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.