Platform SDK Java 8.5 API Reference

Welcome to the Platform SDK Java 8.5 API Reference

See:
          Description

Packages
com.genesyslab.platform.applicationblocks.com  
com.genesyslab.platform.applicationblocks.com.cache  
com.genesyslab.platform.applicationblocks.com.capacityrules  
com.genesyslab.platform.applicationblocks.com.objects  
com.genesyslab.platform.applicationblocks.com.queries  
com.genesyslab.platform.applicationblocks.commons  
com.genesyslab.platform.applicationblocks.commons.broker  
com.genesyslab.platform.applicationblocks.commons.protocols  
com.genesyslab.platform.applicationblocks.warmstandby  
com.genesyslab.platform.apptemplate.application This package provides helper components for connectivity with Genesys Configuration Framework.
com.genesyslab.platform.apptemplate.configuration Provides helper classes that read application options and other data from Configuration Server, converts it to corresponding Platform SDK objects and makes it easier to set up connections to backend servers and other applications.
com.genesyslab.platform.apptemplate.configuration.log Dedicated package for CME Application Logging Options configuration support.
com.genesyslab.platform.apptemplate.filtering  
com.genesyslab.platform.apptemplate.filtering.impl  
com.genesyslab.platform.apptemplate.filtering.impl.actions  
com.genesyslab.platform.apptemplate.filtering.impl.conditions  
com.genesyslab.platform.apptemplate.filtering.impl.configuration  
com.genesyslab.platform.apptemplate.filtering.impl.filters  
com.genesyslab.platform.apptemplate.filtering.impl.operands  
com.genesyslab.platform.apptemplate.lmslogger This package provides support of Genesys LMS files and LMS events logging.
com.genesyslab.platform.apptemplate.lmslogger.impl This package contains internal functionality of LMS Logging and Message Server delivery subsystems.
com.genesyslab.platform.apptemplate.lmslogger.jul This package contains java.util.logging based implementation of LmsEventLogger and correspondent LmsLoggerFactory.
com.genesyslab.platform.apptemplate.lmslogger.log4j This package contains Log4j v1.x implementation of LmsEventLogger and correspondent LmsLoggerFactory.
com.genesyslab.platform.apptemplate.lmslogger.log4j2 This package contains Log4j2 implementation of LmsEventLogger and correspondent LmsLoggerFactory.
com.genesyslab.platform.apptemplate.lmslogger.slf4j This package contains Slf4j implementation of LmsEventLogger and correspondent LmsLoggerFactory.
com.genesyslab.platform.apptemplate.log4j2 This package contains a set of AppTemplate classes related to Log4j v2 support.
com.genesyslab.platform.apptemplate.log4j2plugin This package contains Log4j2 extensions (plug-in's) and related classes.
com.genesyslab.platform.apptemplate.util Provides helper classes that make it easier to read and convert application options and other data from Configuration Server.
com.genesyslab.platform.clusterprotocol Cluster Protocol Application Block
com.genesyslab.platform.clusterprotocol.chat Cluster Protocol classes for Chat Server protocol.
com.genesyslab.platform.clusterprotocol.email Cluster Protocol classes for ESP Email Server.
com.genesyslab.platform.clusterprotocol.esp

External Service Cluster Protocol.

com.genesyslab.platform.clusterprotocol.lb Load Balancer for Cluster Protocol.
com.genesyslab.platform.clusterprotocol.ucs Cluster Protocol classes for Universal Contact Server.
com.genesyslab.platform.commons  
com.genesyslab.platform.commons.collections Contains classes that allow you to use Genesys Key-Value collections in your applications.
com.genesyslab.platform.commons.collections.processor  
com.genesyslab.platform.commons.connection Provides facilities for communicating with Genesys servers using the ConnectionManager factory class.
com.genesyslab.platform.commons.connection.configuration Provides configuration options for communicating with Genesys servers.
com.genesyslab.platform.commons.connection.resolver External Socket Address resolution support classes.
com.genesyslab.platform.commons.connection.tls Provides classes to support and configure TLS connections.
com.genesyslab.platform.commons.log This package provides logging support for your applications.
com.genesyslab.platform.commons.management  
com.genesyslab.platform.commons.protocol Contains classes that support the Protocol objects used by applications developed with the Platform SDKs.
com.genesyslab.platform.commons.protocol.auth Contains classes for user identification using Kerberos.
com.genesyslab.platform.commons.protocol.runtime  
com.genesyslab.platform.commons.threading  
com.genesyslab.platform.commons.util  
com.genesyslab.platform.commons.xmlfactory  
com.genesyslab.platform.configuration.protocol This package contains the Protocol classes that your applications can use to set up communication with Configuration Server.
com.genesyslab.platform.configuration.protocol.confserver  
com.genesyslab.platform.configuration.protocol.confserver.events This package includes the Event messages that contain information about the status of your requests.
com.genesyslab.platform.configuration.protocol.confserver.requests.connectivity  
com.genesyslab.platform.configuration.protocol.confserver.requests.locale  
com.genesyslab.platform.configuration.protocol.confserver.requests.objects This package contains the Request Object classes that your applications can use to work with objects in the Genesys Configuration Layer.

To use these classes, you will need to supply information about the objects you want to work with.
com.genesyslab.platform.configuration.protocol.confserver.requests.security The classes in this package allow you to authenticate a user, change his or her password, and work with his or her permissions.
com.genesyslab.platform.configuration.protocol.confserver.runtime This package is used internally by the protocol.
com.genesyslab.platform.configuration.protocol.confserver.runtime.channel This package is used internally by the protocol.
com.genesyslab.platform.configuration.protocol.exceptions  
com.genesyslab.platform.configuration.protocol.metadata  
com.genesyslab.platform.configuration.protocol.obj  
com.genesyslab.platform.configuration.protocol.runtime  
com.genesyslab.platform.configuration.protocol.runtime.binding This package is used internally by the protocol.
com.genesyslab.platform.configuration.protocol.runtime.channel This package is used internally by the protocol.
com.genesyslab.platform.configuration.protocol.runtime.codec This package is used internally by the protocol.
com.genesyslab.platform.configuration.protocol.runtime.metadata This package is used internally by the protocol.
com.genesyslab.platform.configuration.protocol.runtime.schemas This package is used internally by the protocol.
com.genesyslab.platform.configuration.protocol.server PSDK internal package for Configuration Server protocol clients handling functionality.
Note: This package is internal and is not supposed for explicit usage by applications.
com.genesyslab.platform.configuration.protocol.types This package contains classes based on the Genesys GEnum class.
com.genesyslab.platform.configuration.protocol.utilities  
com.genesyslab.platform.configuration.protocol.xml  
com.genesyslab.platform.contacts.protocol This package contains the Protocol classes that your applications can use to set up communication with Universal Contact Server, including UniversalContactServerProtocol.
com.genesyslab.platform.contacts.protocol.contactserver This package contains the Protocol classes that your applications can use to set up communication with Universal Contact Server.
com.genesyslab.platform.contacts.protocol.contactserver.events  
com.genesyslab.platform.contacts.protocol.contactserver.requests  
com.genesyslab.platform.contacts.protocol.contactserver.runtime This package is used internally by the protocol.
com.genesyslab.platform.contacts.protocol.runtime This package is used internally by the protocol.
com.genesyslab.platform.contacts.protocol.server PSDK internal package for Universal Contact Server protocol clients handling functionality.
Note: This package is internal and is not supposed for explicit usage by applications.
com.genesyslab.platform.json.jackson2 Platform SDK includes the following protocol-specific Jackson modules, that help to serialize protocol messages to or from JSON format:

Configuration protocol: ConfServerModule
Contacts protocol: ContactServerModule
OpenMedia protocols: ExternalServiceModule InteractionServerModule OpenMediaAttributesModule
Outbound protocols: OutboundDesktopModule OutboundServerModule
Management protocols: LocalControlAgentModule MessageServerModule SolutionControlServerModule
Reporting protocol: StatServerModule
Routing protocol: CustomServerModule RoutingServerModule
Voice protocols: TServerModule PreviewInteractionModule
WebMedia protocol: BasicChatModule CallbackModule EmailModule EspEmailModule FlexChatModule
com.genesyslab.platform.json.jackson2.basicchat  
com.genesyslab.platform.json.jackson2.callback  
com.genesyslab.platform.json.jackson2.confserver  
com.genesyslab.platform.json.jackson2.contactserver  
com.genesyslab.platform.json.jackson2.customserver  
com.genesyslab.platform.json.jackson2.email  
com.genesyslab.platform.json.jackson2.espemail  
com.genesyslab.platform.json.jackson2.externalservice  
com.genesyslab.platform.json.jackson2.flexchat  
com.genesyslab.platform.json.jackson2.interactionserver  
com.genesyslab.platform.json.jackson2.localcontrolagent  
com.genesyslab.platform.json.jackson2.messageserver  
com.genesyslab.platform.json.jackson2.openmediaattributes  
com.genesyslab.platform.json.jackson2.outbounddesktop  
com.genesyslab.platform.json.jackson2.outboundserver  
com.genesyslab.platform.json.jackson2.previewinteraction  
com.genesyslab.platform.json.jackson2.routingserver  
com.genesyslab.platform.json.jackson2.runtime  
com.genesyslab.platform.json.jackson2.solutioncontrolserver  
com.genesyslab.platform.json.jackson2.statserver  
com.genesyslab.platform.json.jackson2.tserver  
com.genesyslab.platform.json.serializer  
com.genesyslab.platform.logging  
com.genesyslab.platform.logging.configuration  
com.genesyslab.platform.logging.runtime  
com.genesyslab.platform.logging.runtime.configuration  
com.genesyslab.platform.logging.runtime.targets  
com.genesyslab.platform.logging.utilities  
com.genesyslab.platform.management.protocol This package contains the Protocol classes that your applications can use to set up communication with Genesys Solution Control Server, Message Server and Local Control Agents (LCAs).
com.genesyslab.platform.management.protocol.localcontrolagent  
com.genesyslab.platform.management.protocol.localcontrolagent.events  
com.genesyslab.platform.management.protocol.localcontrolagent.requests  
com.genesyslab.platform.management.protocol.localcontrolagent.responses  
com.genesyslab.platform.management.protocol.localcontrolagent.runtime This package is used internally by the protocol.
com.genesyslab.platform.management.protocol.localcontrolagent.runtime.channel This package is used internally by the protocol.
com.genesyslab.platform.management.protocol.localcontrolagentheartbeat  
com.genesyslab.platform.management.protocol.localcontrolagentheartbeat.runtime This package is used internally by the protocol.
com.genesyslab.platform.management.protocol.localcontrolagentheartbeat.runtime.channel This package is used internally by the protocol.
com.genesyslab.platform.management.protocol.localcontrolagentheartbeat.runtime.codec This package is used internally by the protocol.
com.genesyslab.platform.management.protocol.messageserver  
com.genesyslab.platform.management.protocol.messageserver.events  
com.genesyslab.platform.management.protocol.messageserver.requests  
com.genesyslab.platform.management.protocol.messageserver.requests.subscription  
com.genesyslab.platform.management.protocol.messageserver.runtime This package is used internally by the protocol.
com.genesyslab.platform.management.protocol.messageserver.runtime.channel This package is used internally by the protocol.
com.genesyslab.platform.management.protocol.messageserver.runtime.codec This package is used internally by the protocol.
com.genesyslab.platform.management.protocol.solutioncontrolserver  
com.genesyslab.platform.management.protocol.solutioncontrolserver.events  
com.genesyslab.platform.management.protocol.solutioncontrolserver.requests  
com.genesyslab.platform.management.protocol.solutioncontrolserver.requests.alarms  
com.genesyslab.platform.management.protocol.solutioncontrolserver.requests.applications  
com.genesyslab.platform.management.protocol.solutioncontrolserver.requests.hosts  
com.genesyslab.platform.management.protocol.solutioncontrolserver.requests.solutions  
com.genesyslab.platform.management.protocol.solutioncontrolserver.runtime This package is used internally by the protocol.
com.genesyslab.platform.management.protocol.solutioncontrolserver.runtime.channel This package is used internally by the protocol.
com.genesyslab.platform.openmedia.protocol This package contains the Protocol classes that your applications can use to set up communication with Interaction Server.
com.genesyslab.platform.openmedia.protocol.externalservice  
com.genesyslab.platform.openmedia.protocol.externalservice.event  
com.genesyslab.platform.openmedia.protocol.externalservice.request  
com.genesyslab.platform.openmedia.protocol.externalservice.runtime This package is used internally by the protocol.
com.genesyslab.platform.openmedia.protocol.interactionserver  
com.genesyslab.platform.openmedia.protocol.interactionserver.events  
com.genesyslab.platform.openmedia.protocol.interactionserver.events.interactionmanagement  
com.genesyslab.platform.openmedia.protocol.interactionserver.requests  
com.genesyslab.platform.openmedia.protocol.interactionserver.requests.agentmanagement  
com.genesyslab.platform.openmedia.protocol.interactionserver.requests.interactiondelivery  
com.genesyslab.platform.openmedia.protocol.interactionserver.requests.interactionmanagement  
com.genesyslab.platform.openmedia.protocol.interactionserver.runtime This package is used internally by the protocol.
com.genesyslab.platform.openmedia.protocol.openmediaattributes This package contains the openmediaattributes protocol classes that your applications can use to communicate with Interaction Server.
com.genesyslab.platform.openmedia.protocol.server PSDK internal package for ESP and Interaction Server protocols clients handling functionality.
Note: This package is internal and is not supposed for explicit usage by applications.
com.genesyslab.platform.outbound.protocol This package contains the Protocol classes that your applications can use to set up communication with Outbound Contact Server.
com.genesyslab.platform.outbound.protocol.outbounddesktop This package contains classes that your application can use to work with the Outbound Desktop protocol.
com.genesyslab.platform.outbound.protocol.outboundserver  
com.genesyslab.platform.outbound.protocol.outboundserver.events  
com.genesyslab.platform.outbound.protocol.outboundserver.requests  
com.genesyslab.platform.outbound.protocol.outboundserver.runtime This package is used internally by the protocol.
com.genesyslab.platform.outbound.protocol.outboundserver.runtime.channel This package is used internally by the protocol.
com.genesyslab.platform.reporting.protocol This package contains the StatServerProtocol class that you can use this class to set up communication with Stat Server.
com.genesyslab.platform.reporting.protocol.runtime This package is used internally by the protocol.
com.genesyslab.platform.reporting.protocol.statserver This package contains objects that correspond to objects in the Genesys Configuration Layer, such as AgentStatus and PlaceGroup.
com.genesyslab.platform.reporting.protocol.statserver.events This package contains many event messages, including EventInfo and EventCurrentTargetStateSnapshot, that give you statistical information.
com.genesyslab.platform.reporting.protocol.statserver.events.datastream The events in this package are for Genesys internal use only.

com.genesyslab.platform.reporting.protocol.statserver.requests This package contains the Request objects that your applications can use to open, look at, and close statistics.
com.genesyslab.platform.reporting.protocol.statserver.requests.datastream The requests in this package are for Genesys internal use only.

com.genesyslab.platform.reporting.protocol.statserver.runtime This package is used internally by the protocol.
com.genesyslab.platform.reporting.protocol.statserver.runtime.channel This package is used internally by the protocol.
com.genesyslab.platform.routing.protocol This package contains the UrsCustomProtocol, UrsCustomProtocolListener and RoutingServerProtocol classes.
com.genesyslab.platform.routing.protocol.customserver This package primarily contains enums that your applications can use when working with URS Custom Server.
com.genesyslab.platform.routing.protocol.customserver.events This package contains events that your applications may receive when working with URS Custom Server.
com.genesyslab.platform.routing.protocol.customserver.requests This package contains requests that your applications can send to URS Custom Server.
com.genesyslab.platform.routing.protocol.customserver.runtime This package is used internally by the protocol.
com.genesyslab.platform.routing.protocol.customserver.runtime.channel This package is used internally by the protocol.
com.genesyslab.platform.routing.protocol.routingserver This package primarily contains enums that your applications can use when working with Universal Routing Server (URS), such as CallType and RoutingPointStatus.
com.genesyslab.platform.routing.protocol.routingserver.events This package contains events that your applications may receive when working with Universal Routing Server (URS).
com.genesyslab.platform.routing.protocol.routingserver.requests This package contains requests that your applications can send to Universal Routing Server.
com.genesyslab.platform.routing.protocol.routingserver.runtime This package is used internally by the protocol.
com.genesyslab.platform.routing.protocol.routingserver.runtime.channel This package is used internally by the protocol.
com.genesyslab.platform.standby  
com.genesyslab.platform.standby.events  
com.genesyslab.platform.standby.exceptions  
com.genesyslab.platform.voice.protocol This package contains the Protocol classes that your applications can use to set up communication with T-Server, such as TServerProtocol.
com.genesyslab.platform.voice.protocol.previewinteraction This package contains the PreviewInteraction classes that your applications can use during communication with T-Server, such as PreviewInteractionAcknowledge.
com.genesyslab.platform.voice.protocol.runtime This package is used internally by the protocol.
com.genesyslab.platform.voice.protocol.runtime.codec This package is used internally by the protocol.
com.genesyslab.platform.voice.protocol.tserver  
com.genesyslab.platform.voice.protocol.tserver.events This package contains the Event messages that contain information about the status of your requests.

Note that you will normally want to set up a separate thread to wait for messages from T-Server.
com.genesyslab.platform.voice.protocol.tserver.events.callmonitoring  
com.genesyslab.platform.voice.protocol.tserver.requests.agent Request agent logins and logouts; set the agent's state to ready or not ready.
com.genesyslab.platform.voice.protocol.tserver.requests.callmonitoring  
com.genesyslab.platform.voice.protocol.tserver.requests.dn DN-related requests, such as forwarding calls; monitoring the next call; turning do not disturb, mute, or call waiting on and off.
com.genesyslab.platform.voice.protocol.tserver.requests.dtmf Send digits to an interactive voice response system (IVR).
com.genesyslab.platform.voice.protocol.tserver.requests.iscc Allows an application to get an access number to reach the destination switch, or to cancel a request for an access number.
com.genesyslab.platform.voice.protocol.tserver.requests.party Handle call activity, such as answering, making, and holding calls, initiating transfers and conference calls, or applying a treatment.
com.genesyslab.platform.voice.protocol.tserver.requests.queries Request information about calls, locations, servers, switches, or telephony objects.
com.genesyslab.platform.voice.protocol.tserver.requests.special  
com.genesyslab.platform.voice.protocol.tserver.requests.userdata Attach, update, and delete call-related user data.
com.genesyslab.platform.voice.protocol.tserver.requests.voicemail Collect digits from a caller; open and close a voicemail box; open, close, and play a voice file.
com.genesyslab.platform.voice.protocol.tserver.runtime This package is used internally by the protocol.
com.genesyslab.platform.voice.protocol.tserver.runtime.channel This package is used internally by the protocol.
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.
com.genesyslab.platform.webmedia.protocol.basicchat This package contains classes and enumerations that let you exchange information with Chat Server.
com.genesyslab.platform.webmedia.protocol.basicchat.events This package contains the BasicChat protocol Event messages that provide information about the status of your requests.
com.genesyslab.platform.webmedia.protocol.basicchat.requests This package contains the Request Object classes that your applications can use to work with chat interactions in Chat Server.
com.genesyslab.platform.webmedia.protocol.basicchat.runtime This package is used internally by the protocol.
com.genesyslab.platform.webmedia.protocol.basicchat.runtime.codec This package is used internally by the protocol.
com.genesyslab.platform.webmedia.protocol.callback This package contains classes and enumerations that let you exchange customer-generated information between web forms and your Genesys Callback Server.
com.genesyslab.platform.webmedia.protocol.callback.events This package contains the Callback protocol Event messages that provide information about the status of your requests.
com.genesyslab.platform.webmedia.protocol.callback.requests This package contains the Request Object classes that your applications can use to work with Callback interactions in Callback Server.
com.genesyslab.platform.webmedia.protocol.callback.runtime This package is used internally by the protocol.
com.genesyslab.platform.webmedia.protocol.callback.runtime.codec This package is used internally by the protocol.
com.genesyslab.platform.webmedia.protocol.email This package contains classes, enumerations, and interfaces that let you exchange customer-generated information from web forms with your Genesys E-Mail Server Java.
com.genesyslab.platform.webmedia.protocol.email.events This package contains the Email protocol Event messages that provide information about the status of your requests.
com.genesyslab.platform.webmedia.protocol.email.requests This package contains the Request Object classes that your applications can use to work with e-mail interactions in E-Mail Server Java.
com.genesyslab.platform.webmedia.protocol.email.runtime This package is used internally by the protocol.
com.genesyslab.platform.webmedia.protocol.email.runtime.codec This package is used internally by the protocol.
com.genesyslab.platform.webmedia.protocol.espemail  
com.genesyslab.platform.webmedia.protocol.espemail.events  
com.genesyslab.platform.webmedia.protocol.espemail.requests  
com.genesyslab.platform.webmedia.protocol.espemail.runtime This package is used internally by the protocol.
com.genesyslab.platform.webmedia.protocol.flexchat This package contains classes and enumerations that let you exchange information with Chat Server.
com.genesyslab.platform.webmedia.protocol.flexchat.events This package contains the FlexChat protocol Event messages that provide information about the status of your requests.
com.genesyslab.platform.webmedia.protocol.flexchat.requests This package contains the Request Object classes that your applications can use to work with FlexChat interactions in Chat Server.
com.genesyslab.platform.webmedia.protocol.flexchat.runtime This package is used internally by the protocol.
com.genesyslab.platform.webmedia.protocol.flexchat.runtime.codec This package is used internally by the protocol.
com.genesyslab.platform.webmedia.protocol.runtime This package is used internally by the protocol.
com.genesyslab.platform.webmedia.protocol.runtime.codec This package is used internally by the protocol.
com.genesyslab.platform.webmedia.protocol.server PSDK internal package for Web Media protocols clients handling functionality.
Note: This package is internal and is not supposed for explicit usage by applications.

 

Welcome to the Genesys Platform SDK for Java 8.5

New in This Release

A list of new features from each release of Platform SDK 8.5.x can be found by expanding the Platform SDK 8.5 Release Information section of the Platform SDK online documentation or by viewing the release note for this product.




Additional Information

Additional information on Genesys Telecommunications Laboratories, Inc. is available on our Customer Care website.

More information about the Genesys Platform SDKs, along with the latest versions of all other SDK documentation, can be found at the Genesys Documentation website. Please start by reading the Release Note for this product and then continue with related documentation. You can also use the Genesys forums to pose questions or as a source for important developer-related information.

Genesys Documentation website

Top of Page




Copyright Information

Any authorized distribution of any copy of this code (including any related documentation) must reproduce the following restrictions, disclaimer and copyright notice:

The Genesys name, trademarks and/or logo(s) of Genesys shall not be used to name (even as a part of another name), endorse and/or promote products derived from this code without prior written permission from Genesys Telecommunications Laboratories, Inc.

The use, copy, and/or distribution of this code is subject to the terms of the Genesys Developer License Agreement. This code shall not be used, copied, and/or distributed under any other license agreement.

THIS CODE IS PROVIDED BY GENESYS TELECOMMUNICATIONS LABORATORIES, INC. (“GENESYS”) “AS IS” WITHOUT ANY WARRANTY OF ANY KIND. GENESYS HEREBY DISCLAIMS ALL EXPRESS, IMPLIED, OR STATUTORY CONDITIONS, REPRESENTATIONS AND WARRANTIES WITH RESPECT TO THIS CODE (OR ANY PART THEREOF), INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. GENESYS AND ITS SUPPLIERS SHALL NOT BE LIABLE FOR ANY DAMAGE SUFFERED AS A RESULT OF USING THIS CODE. IN NO EVENT SHALL GENESYS AND ITS SUPPLIERS BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, ECONOMIC, INCIDENTAL, OR SPECIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, ANY LOST REVENUES OR PROFITS).

Copyright © 2006–2016 Genesys Telecommunications Laboratories, Inc. All rights reserved.

Top of Page


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.