Platform SDK Java 8.5 API Reference

Uses of Package
com.genesyslab.platform.contacts.protocol.contactserver.events

Packages that use com.genesyslab.platform.contacts.protocol.contactserver.events
com.genesyslab.platform.contacts.protocol.contactserver.events   
com.genesyslab.platform.contacts.protocol.contactserver.runtime This package is used internally by the protocol. 
 

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

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


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.