Platform SDK Java 9.0 API Reference

Package com.genesyslab.platform.outbound.protocol.outbounddesktop

This package contains classes that your application can use to work with the Outbound Desktop protocol.

The Outbound Desktop protocol for Outbound Contact Server (OCS) enables OCS to communicate through T-Server with agent desktops. Refer to your OCS documentation for more information.

Outbound Desktop protocol is based on EventUserEvent which transports protocol messages in a key-value pair list format. The OutboundDesktopBinding class or the OutboundDesktopFactory class can marshal an OCS desktop message into a key-value pair list, and unmarshal a key-value pair list retrieved from an event's user data back to standard message format.

Code snippets:

Marshal an OCS desktop message to a key-value pair list:

        ...
                
        CampaignLoaded msg = new CampaignLoaded();

        // marshaling a message using old kvbinding 
        OutboundDesktopFactory factory = new OutboundDesktopFactory();
        KeyValueCollection kv = factory.marshal(msg);
        
        // marshaling a message using new kvbinding 
        KeyValueCollection kv2 = OutboundDesktopBinding.marshal(msg);
        
        ...
   
Unmarshal an OCS desktop message from EventUserEvent:

        ...
        
        EventUserEvent evt = (EventUserEvent) message;
        KeyValueCollection kv = evt.getUserData());

        // unmarshaling a kvlist using old kvbinding 
        Object obj = factory.unmarshal(kv);
        if (obj instanceof CampaignLoaded){
          ...
        }
        
        // unmarshaling a kvlist using new kvbinding 
        Object obj2 = OutboundDesktopBinding.unmarshal(kv);
        if (obj2 instanceof CampaignLoaded){
          ...
        }
   
Skip navigation links
Platform SDK Java 9.0 API Reference

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