Platform SDK Java 8.5 API Reference

Uses of Interface
com.genesyslab.platform.contacts.protocol.contactserver.ContactServerMessage

Packages that use ContactServerMessage
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   
 

Uses of ContactServerMessage in com.genesyslab.platform.contacts.protocol.contactserver
 

Classes in com.genesyslab.platform.contacts.protocol.contactserver that implement ContactServerMessage
 class AbstractMessage
           
 

Uses of ContactServerMessage in com.genesyslab.platform.contacts.protocol.contactserver.events
 

Classes in com.genesyslab.platform.contacts.protocol.contactserver.events that implement ContactServerMessage
 class EventAddAgentStdRespFavorite
          Indicates that a Standard Response was added to the specified agent's favorites list.
 class EventAddCategory
          This event indicates that a category was successfully added.
 class EventAddCategoryAttribute
          This event indicates that a category attribute was successfully added.
 class EventAddCategoryRoot
          This event indicates that a category root was successfully added.
 class EventAddDocument
          This event indicates that a document was successfully added to an Interaction.
 class EventAddFieldCode
          This event indicates that a field code was successfully added.
 class EventAddFieldValue
          This event indicates that a field value was successfully added.
 class EventAddModel
           
 class EventAddScreeningRule
          This event indicates that a screening rule was successfully added.
 class EventAddStandardResponse
          Response on 'RequestAddStandardResponse' request.
 class EventAddStdRespUsage
          Response on 'RequestAddStdRespUsage' request.
 class EventAddTrainingDataObject
           
 class EventAssignInteractionToContact
          This event indicates that an Interaction was successfully assigned to a Contact.
 class EventBoostDocument
          Indicates whether RequestBoostDocument was successful or not.
 class EventCheckForUpdates
          This event indicates whether or not standard responses were updated since the requested time.
 class EventContactListGet
          This event indicates that the RequestContactListGet was successful, and contains a list of contacts matching the criteria specified in that request.
 class EventContactListGetNextPage
          This event returns the next page of contact objects, as specified by the earlier constraints.
 class EventContactListRelease
          This event indicates that the contact list was released successfully.
 class EventCountInteractions
          This event returns the number of Interactions that match the filter specified in the related RequestCountInteractions.
 class EventCreateStandardResponseRevision
          This event indicates that the RequestCreateStandardResponseRevision was successful, and contains a new version of a Standard Response in a Category (part of Standard Response history management).
 class EventDelete
          This event indicates that the contact with the specified ID was deleted.
 class EventDeleteAgentStdRespFavorite
          Indicates that a Standard Response was removed from the specified agent's favorites list.
 class EventDeleteCategory
          This event indicates that the specified category was deleted from UCS.
 class EventDeleteCategoryAttribute
          This event indicates that the specified category attribute was deleted from UCS.
 class EventDeleteCategoryRoot
          This event indicates that the specified category root was deleted from UCS.
 class EventDeleteFieldCode
          This event indicates that a field code was successfully deleted.
 class EventDeleteFieldValue
          This event indicates that a field value was successfully deleted.
 class EventDeleteInteraction
          This event indicates that the specified interactions were deleted from UCS.
 class EventDeleteModel
           
 class EventDeleteProperties
          Notifies about delete operation success.
 class EventDeleteScreeningRule
          This event indicates that a screening rule was successfully deleted.
 class EventDeleteStandardResponse
          Notifies about delete operation success.
 class EventDeleteTrainingDataObject
           
 class EventError
          Indicates that an error has occurred.
 class EventFindOrCreatePhoneCall
          This event returns a PhoneCall object.
 class EventGetAgentStdRespFavorites
          Returns a list of all Standard Response Favorites for the agent specified in RequestGetAgentStdRespFavorites.
 class EventGetAllCategories
          Deprecated. The message has been deprecated in UCS 8.5 and will not be implemented in UCS 9.0.
 class EventGetAttributes
          This event returns a complete list of contact attributes (as declared in the Contact Attribute enumerator in Configuration Server).
 class EventGetCategory
          This event contains information about the requested category.
 class EventGetCategoryAttribute
          This event delivers the content of the requested category attribute.
 class EventGetCategoryAttributes
          This event returns all (or some, depending on filtering) of the category attributes.
 class EventGetContacts
          This event delivers a specific range of contacts, based on your search and sort criteria.
 class EventGetDocument
          This event delivers the binary content of the requested document.
 class EventGetFieldCode
          This event delivers the content of the requested field code.
 class EventGetFieldCodes
          This event returns all of the field codes.
 class EventGetFieldValue
          This event delivers the content of the requested field value.
 class EventGetFieldValues
          This event returns all of the field values.
 class EventGetIndexProperties
          This event returns a list of configured indexes in UCS, showing you which fields are searchable.
 class EventGetInteractionContent
          This event delivers the binary content of the interaction.
 class EventGetInteractionsForContact
          This event returns all (or some, depending on filtering) of the interactions for a specified Contact.
 class EventGetInteractionsWithStatus
          This event delivers the set of interactions with requested status.
 class EventGetMergeDetail
          Response on 'RequestGetMergeDetail' request.
 class EventGetModel
           
 class EventGetModels
           
 class EventGetProperties
          Returns one, multiple or all key-value pairs for the specified person.
 class EventGetRootCategories
          This event contains a list of root categories from the specified tenant.
 class EventGetScreeningRule
          This event delivers the content of the requested screening rule.
 class EventGetScreeningRules
          This event returns all (or some, depending on filtering) of the screening rules.
 class EventGetServerTime
          Returns server time as a String in ISO8601 Date Format.
 class EventGetStandardResponse
          This event contains information about the requested standard response specified in RequestGetStandardResponse.
 class EventGetStandardResponses
          This event contains information about all the versions of a Standard Response content for a requested standard response ID.
 class EventGetSystemSettings
          The purpose is to provide available options.
 class EventGetTrainingDataObject
           
 class EventGetTrainingDataObjects
           
 class EventGetVersion
          This event contains the current version of the UCS database.
 class EventIdentifyContact
          This event returns a list of one or more Contact IDs based on user data values specified in the related RequestIdentifyContact request.
 class EventInsert
          This event is returned after a new contact is interested using RequestInsert.
 class EventInsertInteraction
          This event indicates that a new interaction was created in UCS.
 class EventInteractionListGet
          This event returns a list of Interactions matching the criteria specified by RequestInteractionListGet.
 class EventInteractionListGetNextPage
          This event returns the next interaction in the list that was returned by EventInteractionListGet.
 class EventInteractionListRelease
          This event indicates that list of interactions specified in RequestInteractionListRelease has been released.
 class EventMergeContacts
          Indicates that RequestMergeContacts was successful, and returns the ID of the merge request.
 class EventMergeListGet
          This event returns a UCS-wide list of merged agents.
 class EventMergeListGetNextPage
          This event delivers the next portion of the merge records from the previously built MergeList.
 class EventMergeListRelease
          This event returns all (or some, depending on filtering) of the interactions for a specified Contact.
 class EventMoveCategory
          This event indicates that a category was successfully moved.
 class EventRefresh
          Response of 'RequestRefresh' request.
 class EventRemoveAllAttributes
          Indicates that all attributes were successfully removed from a contact.
 class EventRemoveDocument
          This event indicates that a Document was successfully removed.
 class EventRenderFieldCodes
          This event returns the adjusted block of text, after a block of template text is rendered to replace field codes with actual values.
 class EventRestoreStandardResponseRevision
          This event indicates that the RequestRestoreStandardResponseRevision was successful.
 class EventSearch
          This event returns a list of UCS documents — standard responses, contacts, or interactions — that match the string-based queries submitted in RequestSearch.
 class EventSetInteractionStatus
          This event indicates that the interaction status has changed.
 class EventSetProperties
          Notifies about insert operation success.
 class EventStopInteraction
          Indicates that the interaction specified in the related RequestStopInteraction has stopped correctly.
 class EventUnMergeContacts
          This event indicates that the previously merged contacts were rolled back successfully.
 class EventUpdateAttributes
          Indicates that the related RequestUpdateAttributes was successful.
 class EventUpdateCategory
          This event indicates that a category was successfully updated.
 class EventUpdateCategoryAttribute
          This event indicates that a category attribute was successfully updated.
 class EventUpdateDocument
          This event indicates that the specified document was updated successfully.
 class EventUpdateFieldCode
          This event indicates that a field code was successfully updated.
 class EventUpdateFieldValue
          Deprecated. This message is deprecated in UCS 9.0
 class EventUpdateInteraction
          This event indicates that the interaction attributes and binary content were updated correctly.
 class EventUpdateModel
           
 class EventUpdateScreeningRule
          This event indicates that a screening rule was successfully updated.
 class EventUpdateStandardResponse
          Notifies about update operation success.
 class EventUpdateTrainingDataObject
           
 class EventValidateFieldCodes
          This event returns a list of any errors that were received after trying to validate the text specified in RequestValidateFieldCodes.
 

Uses of ContactServerMessage in com.genesyslab.platform.contacts.protocol.contactserver.requests
 

Classes in com.genesyslab.platform.contacts.protocol.contactserver.requests that implement ContactServerMessage
 class RequestAddAgentStdRespFavorite
          Deprecated. This message is deprecated in UCS 9.0
 class RequestAddCategory
          Deprecated. This message is deprecated in UCS 9.0
 class RequestAddCategoryAttribute
          Deprecated. This message is deprecated in UCS 9.0
 class RequestAddCategoryRoot
          Deprecated. This message is deprecated in UCS 9.0
 class RequestAddDocument
          This request is intended to add a document to an Interaction.
 class RequestAddFieldCode
          Deprecated. This message is deprecated in UCS 9.0
 class RequestAddFieldValue
          Deprecated. This message is deprecated in UCS 9.0
 class RequestAddModel
          Deprecated. This message is deprecated in UCS 9.0
 class RequestAddScreeningRule
          Deprecated. This message is deprecated in UCS 9.0
 class RequestAddStandardResponse
          Deprecated. This message is deprecated in UCS 9.0
 class RequestAddStdRespUsage
          Deprecated. This message is deprecated in UCS 9.0
 class RequestAddTrainingDataObject
          Deprecated. This message is deprecated in UCS 9.0
 class RequestAssignInteractionToContact
          This request is intended for downloading of the complete SRL content from server to client.
 class RequestBoostDocument
          This request increases document priority towards requests.
 class RequestCheckForUpdates
          This request is intended for checking whether standard responses were updated or not since the time, provided as a time-stamp.
 class RequestContactListGet
          This request is intended for building a ScrollableList object based on provided constraints.
 class RequestContactListGetNextPage
          This request is intended for delivering the next portion of the contact objects, previously found by some constraints.
 class RequestContactListRelease
          This request is intended for releasing of previously created ScrollableList.
 class RequestCountInteractions
          This request returns the number of Interactions that match the specified filter.
 class RequestCreateStandardResponseRevision
          Deprecated. This message is deprecated in UCS 9.0
 class RequestDelete
          This request is intended for deletion of the contact by its ID.
 class RequestDeleteAgentStdRespFavorite
          Deprecated. This message is deprecated in UCS 9.0
 class RequestDeleteCategory
          Deprecated. This message is deprecated in UCS 9.0
 class RequestDeleteCategoryAttribute
          Deprecated. This message is deprecated in UCS 9.0
 class RequestDeleteCategoryRoot
          Deprecated. This message is deprecated in UCS 9.0
 class RequestDeleteFieldCode
          Deprecated. This message is deprecated in UCS 9.0
 class RequestDeleteFieldValue
          This request is intended to delete a field value.
 class RequestDeleteInteraction
          This request is intended for deleting of interaction from UCS.
 class RequestDeleteModel
          Deprecated. This message is deprecated in UCS 9.0
 class RequestDeleteProperties
          Deletes one, multiple or all key-value pairs for the specified person.
 class RequestDeleteScreeningRule
          Deprecated. This message is deprecated in UCS 9.0
 class RequestDeleteStandardResponse
          Deprecated. This message is deprecated in UCS 9.0
 class RequestDeleteTrainingDataObject
          Deprecated. This message is deprecated in UCS 9.0
 class RequestFindOrCreatePhoneCall
          This request finds an existing PhoneCall object.
 class RequestGetAgentStdRespFavorites
          Request a list of all Standard Response Favorites for a particular agent.
 class RequestGetAllCategories
          Deprecated. The message has been deprecated in UCS 8.5 and will not be implemented in UCS 9.0.
 class RequestGetAttributes
          This request is intended for obtaining the complete list of all Contact Attribute objects associated with this Contact.
 class RequestGetCategory
          This request returns a specified category.
 class RequestGetCategoryAttribute
          This request is intended for delivering the content of a category attribute.
 class RequestGetCategoryAttributes
          The request is intended for delivering all or some of category attributes (depending on filtering).
 class RequestGetContacts
          This request is intended for delivering a specific range of contacts based on search and sort criteria.
 class RequestGetDocument
          This request is used to return the binary content of a document.
 class RequestGetFieldCode
          This request is intended for delivering the content of a field code.
 class RequestGetFieldCodes
          The request is intended for delivering all of field codes.
 class RequestGetFieldValue
          This request is intended for delivering the content of a field value.
 class RequestGetFieldValues
          The request is intended for delivering all of field values.
 class RequestGetIndexProperties
          This request returns a list of the configured indexes in UCS, showing you which fields are searchable.
 class RequestGetInteractionContent
          This request is intended for delivering the binary content of the interaction.
 class RequestGetInteractionsForContact
          This request is intended for delivering all or some of the interactions (depending on filtering) for the contact in question.
 class RequestGetInteractionsWithStatus
          This request is intended for delivering the set of interactions with requested status.
 class RequestGetMergeDetail
          Requests merge details.
 class RequestGetModel
           
 class RequestGetModels
           
 class RequestGetProperties
          Gets one, multiple or all key-value pairs for the specified person.
 class RequestGetRootCategories
          This request returns a list of root categories from a particular tenant.
 class RequestGetScreeningRule
          This request is intended for delivering the content of a screening rule.
 class RequestGetScreeningRules
          he request is intended for delivering all or some of screening rules.
 class RequestGetServerTime
          Used to retrieve current time on UCS' server in ISO8601 Date Format.
 class RequestGetStandardResponse
          This request returns information about a requested standard response.
 class RequestGetStandardResponses
          This method is intended for downloading of all the versions of a Standard Response content for a standard response ID from server to client.
 class RequestGetSystemSettings
          The purpose is to provide available options.
 class RequestGetTrainingDataObject
           
 class RequestGetTrainingDataObjects
           
 class RequestGetVersion
          This request returns the current version of the UCS database.
 class RequestIdentifyContact
          This request is intended for identifying a Contact based on user data values.
 class RequestInsert
          This request is intended for contact creation.
 class RequestInsertInteraction
          This request is intended for creation of new interaction in UCS.
 class RequestInteractionListGet
          This request provides a list of Interactions that you can scroll through.
 class RequestInteractionListGetNextPage
          This request scrolls to the next interaction in the list that was returned by EventInteractionListGet.
 class RequestInteractionListRelease
          This request will release previously created list of interactions returned by com.genesyslab.platform.Contacts.Protocols.ContactServer.events.EventInteractionListGet.
 class RequestMergeContacts
          Request to merge two existing Contacts.
 class RequestMergeListGet
          This request is intended for building of UCS-wide MergeList or specific list for particular agent.
 class RequestMergeListGetNextPage
          This request is intended for delivering the next portion of the merge records from the previously built MergeList.
 class RequestMergeListRelease
          This request is intended for releasing of previously created MergeList.
 class RequestMoveCategory
          Deprecated. This message is deprecated in UCS 9.0
 class RequestRefresh
          Refresh a list of document to make sure they are up to date or still exists.
 class RequestRemoveAllAttributes
          This request removes all attributes from a specified contact.
 class RequestRemoveDocument
          This request is intended to remove a document.
 class RequestRenderFieldCodes
          This request takes a block of template text, and replaces generic field codes with the actual values specified.
 class RequestRestoreStandardResponseRevision
          Deprecated. This message is deprecated in UCS 9.0
 class RequestSearch
          This request provides the ability to search for UCS entries - standard responses, contacts, or interactions - that match the string-based queries you create.
 class RequestSetInteractionStatus
          This request is intended for changing interaction status.
 class RequestSetProperties
          This method allows inserting custom data for a desktop.
 class RequestStopInteraction
          This request is intended for stopping an Interaction.
 class RequestUnMergeContacts
          This request is intended for rolling back of the previous contact merge.
 class RequestUpdateAttributes
          This request is intended for updating contact attributes.
 class RequestUpdateCategory
          Deprecated. This message is deprecated in UCS 9.0
 class RequestUpdateCategoryAttribute
          Deprecated. This message is deprecated in UCS 9.0
 class RequestUpdateDocument
          This request is intended to update a document.
 class RequestUpdateFieldCode
          Deprecated. This message is deprecated in UCS 9.0
 class RequestUpdateFieldValue
          Deprecated. This message is deprecated in UCS 9.0
 class RequestUpdateInteraction
          This request is intended for updating of interaction attributes and binary content.
 class RequestUpdateModel
          Deprecated. This message is deprecated in UCS 9.0
 class RequestUpdateScreeningRule
          Deprecated. This message is deprecated in UCS 9.0
 class RequestUpdateStandardResponse
          Deprecated. This message is deprecated in UCS 9.0
 class RequestUpdateTrainingDataObject
          Deprecated. This message is deprecated in UCS 9.0
 class RequestValidateFieldCodes
          Validates the specified template.
 


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.