- get(String) - Static method in enum com.avaya.ccs.api.enums.ContactType
-
- get(String) - Static method in enum com.avaya.ccs.api.enums.NotificationType
-
- getActivityCode() - Method in interface com.avaya.ccs.api.InteractionI
-
The activity code, if any, currently set on this interaction.
- getActivityCode() - Method in interface com.avaya.ccs.api.MonitoredInteractionI
-
The activity code that is currently set on the
InteractionI
that is represented by this
MonitoredInteractionI
.
- getActivityCodes() - Method in interface com.avaya.ccs.api.InteractionI
-
Requests retrieval of the administered activity codes in the Contact Center for this InteractionI
object.
- getAddress() - Method in interface com.avaya.ccs.api.InteractionI
-
The address URI associated with the
ResourceI
object that is handling this
InteractionI
object.
- getAddress() - Method in interface com.avaya.ccs.api.MonitoredInteractionI
-
The address URI of the
UserI
associated with the
InteractionI
object that is represented by this
MonitoredInteractionI
object.
- getAddress() - Method in interface com.avaya.ccs.api.RemoteParticipantI
-
- getAddress() - Method in interface com.avaya.ccs.api.ResourceI
-
The address associated with this resource.
- getAddressName() - Method in interface com.avaya.ccs.api.InteractionI
-
- getAddressName() - Method in interface com.avaya.ccs.api.MonitoredInteractionI
-
- getAddressName() - Method in interface com.avaya.ccs.api.ResourceI
-
This is the user name (or user information) portion of the resource's address URI (see
ResourceI.getAddress()
).
- getAfterCallWorkCodes() - Method in interface com.avaya.ccs.api.SessionI
-
- getAgentNotes() - Method in interface com.avaya.ccs.api.InteractionI
-
The agent notes stored on the InteractionI
object.
- getAgentScriptUrl() - Method in interface com.avaya.ccs.api.InteractionI
-
- getAreaCode() - Method in interface com.avaya.ccs.api.PhoneListEntryI
-
- getArrivalTime() - Method in interface com.avaya.ccs.api.CustomerHistoryItemI
-
The arrival time of the contact
- getArrivalTime() - Method in interface com.avaya.ccs.api.EmailMediaI
-
The time that the contact arrived at the CCS component
- getAttachments() - Method in interface com.avaya.ccs.api.SuggestedResponseI
-
Get any attachments for this Suggested Response
- getAutoPhrases() - Method in interface com.avaya.ccs.api.AutoPhrasesI
-
Get the list of Auto Phrases for an agent, as configured in CCMM Admin
- getAutoReconnect() - Method in interface com.avaya.ccs.api.ClientI
-
- getBcc() - Method in interface com.avaya.ccs.api.EmailMediaI
-
The Bcc party(s) of the email.
- getBinaryData() - Method in interface com.avaya.ccs.api.DataI
-
- getBody() - Method in interface com.avaya.ccs.api.CustomerInteractionMediaItemI
-
The 'Body' value of this media item.
- getBody() - Method in interface com.avaya.ccs.api.EmailMediaI
-
The email body
- getBody() - Method in interface com.avaya.ccs.api.SuggestedResponseI
-
The email body for this Suggested Response
- getCallbackDestinations(DestinationType) - Method in interface com.avaya.ccs.api.InteractionI
-
Requests the
DestinationI
objects of a specified
DestinationType
that are available for the user to setup
as the destination for a callback.
- getCallbackDestinationTypes() - Method in interface com.avaya.ccs.api.InteractionI
-
- getCalledAddress() - Method in interface com.avaya.ccs.api.InteractionI
-
The original destination address associated with this {code InteractionI}.
- getCalledAddress() - Method in interface com.avaya.ccs.api.MonitoredInteractionI
-
The original destination address of the {code InteractionI} that is represented by this MonitoredInteractionI
.
- getCalledAddressName() - Method in interface com.avaya.ccs.api.InteractionI
-
- getCalledAddressName() - Method in interface com.avaya.ccs.api.MonitoredInteractionI
-
- getCallingAddress() - Method in interface com.avaya.ccs.api.InteractionI
-
The address that was the original source of this InteractionI
.
- getCallingAddress() - Method in interface com.avaya.ccs.api.MonitoredInteractionI
-
The address that was the original source of the InteractionI
that is represented by this
MonitoredInteractionI
.
- getCallingAddressName() - Method in interface com.avaya.ccs.api.InteractionI
-
- getCallingAddressName() - Method in interface com.avaya.ccs.api.MonitoredInteractionI
-
- getCampaignName() - Method in interface com.avaya.ccs.api.InteractionI
-
The name of the POM campaign that caused this this InteractionI
object to be created.
- getCc() - Method in interface com.avaya.ccs.api.EmailMediaI
-
The Cc party(s) of the email.
- getClient() - Method in interface com.avaya.ccs.api.SessionI
-
Get the Client
object associated with this Session
.
- getClientId() - Method in interface com.avaya.ccs.api.ClientI
-
returns the Client ID.
- getClosedReasonCode() - Method in interface com.avaya.ccs.api.InteractionI
-
A ClosedReasonCode may optionally be set as a field on an Interaction.
- getCode() - Method in interface com.avaya.ccs.api.MonitoredUserI
-
This property provides the
ContactCenterCodeI
currently associated with the user that this
MonitoredUserI
represents.
- getCode() - Method in interface com.avaya.ccs.api.NotificationI
-
A
NotificationCode
that indicates the type of operation that generated the Notification.
- getCode() - Method in interface com.avaya.ccs.api.UserI
-
- getCodeNumber() - Method in interface com.avaya.ccs.api.ErrorI
-
- getCodes() - Method in interface com.avaya.ccs.api.CodeListI
-
- getCodeType() - Method in interface com.avaya.ccs.api.CodeListI
-
- getCommand() - Method in interface com.avaya.ccs.api.ErrorI
-
- getConnectedServer() - Method in interface com.avaya.ccs.api.ClientI
-
Identifies the fully qualified hostname of the Contact Center server that the client is currently connected and
authenticated with.
- getConsultDestinations(DestinationType) - Method in interface com.avaya.ccs.api.InteractionI
-
- getConsultDestinationTypes() - Method in interface com.avaya.ccs.api.InteractionI
-
- getContactId() - Method in interface com.avaya.ccs.api.CustomerHistoryI
-
Customer History is requested for a given Interaction
.
- getContactId() - Method in interface com.avaya.ccs.api.CustomerHistoryItemI
-
The contact ID for this contact
- getContactId() - Method in interface com.avaya.ccs.api.EmailMediaI
-
The Contact ID for this object.
- getContactId() - Method in interface com.avaya.ccs.api.InteractionI
-
The ID of the contact that this InteractionI
object represents.
- getContactId() - Method in interface com.avaya.ccs.api.MonitoredInteractionI
-
The ID of the contact associated with the InteractionI
that is represented by this MonitoredInteractionI
object.
- getContactNumbers() - Method in interface com.avaya.ccs.api.InteractionI
-
A list of
ContactNumberI
objects each representing an administered contact number for this customer.
- getContactType() - Method in interface com.avaya.ccs.api.CustomerHistoryItemI
-
The Contact type of this contact
- getContactType() - Method in interface com.avaya.ccs.api.InteractionI
-
- getContactType() - Method in interface com.avaya.ccs.api.MediaI
-
- getContactType() - Method in interface com.avaya.ccs.api.MonitoredInteractionI
-
- getContactTypes() - Method in interface com.avaya.ccs.api.MonitoredUserI
-
- getContactTypes() - Method in interface com.avaya.ccs.api.ResourceI
-
- getContactTypes() - Method in interface com.avaya.ccs.api.UserI
-
- getCountry() - Method in interface com.avaya.ccs.api.PostalAddressListEntryI
-
- getCountryCode() - Method in interface com.avaya.ccs.api.PhoneListEntryI
-
- getCreationTime() - Method in interface com.avaya.ccs.api.CustomerInteractionMediaItemI
-
Time this contact was created
- getCustomerDetails() - Method in interface com.avaya.ccs.api.InteractionI
-
- getCustomerInteractions() - Method in interface com.avaya.ccs.api.CustomerHistoryI
-
Get the list of Customer Interactions for a given customer
- getCustomerList() - Method in interface com.avaya.ccs.api.CustomerDataI
-
Deprecated.
- getCustomerList() - Method in interface com.avaya.ccs.api.CustomerListI
-
- getCustomFields() - Method in interface com.avaya.ccs.api.CustomFieldListI
-
A shallow copy of the list of
CustomFieldI
that this object stores
- getCustomFields() - Method in interface com.avaya.ccs.api.InteractionI
-
Requests retrieval of the custom fields for this InteractionI
object.
- getData() - Method in interface com.avaya.ccs.api.InteractionI
-
Retrieves the attached data that is associated with the contact.
- getData() - Method in interface com.avaya.ccs.api.MonitoredInteractionI
-
Retrieves the attached data that is associated with the contact of the
InteractionI
that is represented by this
MonitoredInteractionI
.
- getDefaultContactType() - Method in interface com.avaya.ccs.api.ResourceI
-
The default contact type for this ResourceI
.
- getDescription() - Method in interface com.avaya.ccs.api.PagePushUrlI
-
The description of this Page Push URL
- getDestinationCallType() - Method in interface com.avaya.ccs.api.DestinationI
-
- getDestinations() - Method in interface com.avaya.ccs.api.DestinationListI
-
- getDestinationType() - Method in interface com.avaya.ccs.api.DestinationI
-
- getDestinationType() - Method in interface com.avaya.ccs.api.DestinationListI
-
- getDoNotCall() - Method in interface com.avaya.ccs.api.PhoneListEntryI
-
Gets the 'Do Not Call' status of this number as configured in AACC
- getDoNotCall(boolean) - Method in interface com.avaya.ccs.api.PhoneListEntryI
-
- getEmailAddress() - Method in interface com.avaya.ccs.api.EmailListEntryI
-
- getEmailAttachmentUploadUri() - Method in interface com.avaya.ccs.api.EmailReplyResponseI
-
- getEmailList() - Method in interface com.avaya.ccs.api.CustomerDetailsI
-
A list of EmailListEntryI
s associated with this customer
- getEmailOutboundAttachments() - Method in interface com.avaya.ccs.api.EmailAttachmentsArgumentI
-
- getEncoding() - Method in interface com.avaya.ccs.api.EmailMediaI
-
The email character encoding.
- getError() - Method in interface com.avaya.ccs.api.NotificationEventI
-
- getErrorCode() - Method in interface com.avaya.ccs.api.ErrorI
-
- getFirstName() - Method in interface com.avaya.ccs.api.CustomerDetailsI
-
The customer's first name
- getFirstName() - Method in interface com.avaya.ccs.api.CustomerInteractionMediaItemI
-
The customer's first name
- getFirstName() - Method in interface com.avaya.ccs.api.MonitoredUserI
-
- getFirstName() - Method in interface com.avaya.ccs.api.UserI
-
- getFormat() - Method in interface com.avaya.ccs.api.DataI
-
- getFrom() - Method in interface com.avaya.ccs.api.CustomerInteractionMediaItemI
-
The 'From' value of this media item..
- getFrom() - Method in interface com.avaya.ccs.api.EmailMediaI
-
The From party of the email
- getFullName() - Method in interface com.avaya.ccs.api.MonitoredUserI
-
- getFullName() - Method in interface com.avaya.ccs.api.UserI
-
- getId() - Method in interface com.avaya.ccs.api.CustomerDetailsI
-
The ID for this CustomerDetails object
- getId() - Method in interface com.avaya.ccs.api.EmailListEntryI
-
- getId() - Method in interface com.avaya.ccs.api.InteractionI
-
A unique identifier for the InteractionI
object.
- getId() - Method in interface com.avaya.ccs.api.MediaI
-
The unique identifier of this Media object.
- getId() - Method in interface com.avaya.ccs.api.MonitoredInteractionI
-
A unique identifier for the MonitoredInteractionI
object.
- getId() - Method in interface com.avaya.ccs.api.MonitoredUserI
-
A unique identifier for the MonitoredUserI
object.
- getId() - Method in interface com.avaya.ccs.api.PhoneListEntryI
-
- getId() - Method in interface com.avaya.ccs.api.PostalAddressListEntryI
-
- getId() - Method in interface com.avaya.ccs.api.ResourceI
-
A unique identifier for the ResourceI
object.
- getId() - Method in interface com.avaya.ccs.api.SessionI
-
A unique identifier for the SessionI
instance.
- getId() - Method in interface com.avaya.ccs.api.SuggestedResponseI
-
A unique identifier to identify this Suggested Response
- getId() - Method in interface com.avaya.ccs.api.UserI
-
A unique identifier for the UserI
object.
- getInboundAttachments() - Method in interface com.avaya.ccs.api.EmailMediaI
-
The list of InboundAttachment
s attached to the email
- getInteractions() - Method in interface com.avaya.ccs.api.SessionI
-
- getIntrinsic(String) - Method in interface com.avaya.ccs.api.InteractionI
-
- getIntrinsic(String) - Method in interface com.avaya.ccs.api.MonitoredInteractionI
-
- getIntrinsics() - Method in interface com.avaya.ccs.api.InteractionI
-
A list of
IntrinsicI
objects that provide additional information about the contact that this
InteractionI
object is associated with.
- getIntrinsics() - Method in interface com.avaya.ccs.api.MonitoredInteractionI
-
A list of
IntrinsicI
objects that provide additional information about the contact associated with the
InteractionI
object that is represented by this
MonitoredInteractionI
.
- getInvalidObject() - Method in exception com.avaya.ccs.api.exceptions.ObjectInvalidException
-
Retrieve the disposed object that cause the Exception
- getKeyStore() - Method in interface com.avaya.ccs.api.SecurityContextI
-
- getKvpData() - Method in interface com.avaya.ccs.api.DataI
-
- getLanguage() - Method in interface com.avaya.ccs.api.UserI
-
The language of the UserI
client
- getLastLoginTime() - Method in interface com.avaya.ccs.api.SessionI
-
The server time of the last successful login for the currently connected user.
- getLastName() - Method in interface com.avaya.ccs.api.CustomerDetailsI
-
The customer's surname
- getLastName() - Method in interface com.avaya.ccs.api.CustomerInteractionMediaItemI
-
The customer's last name
- getLastName() - Method in interface com.avaya.ccs.api.MonitoredUserI
-
- getLastName() - Method in interface com.avaya.ccs.api.UserI
-
- getLaunchState() - Method in interface com.avaya.ccs.api.ScreenPopI
-
The launch state of the ScreenPop.
- getLine1() - Method in interface com.avaya.ccs.api.PostalAddressListEntryI
-
- getLine2() - Method in interface com.avaya.ccs.api.PostalAddressListEntryI
-
- getLine3() - Method in interface com.avaya.ccs.api.PostalAddressListEntryI
-
- getLine4() - Method in interface com.avaya.ccs.api.PostalAddressListEntryI
-
- getLine5() - Method in interface com.avaya.ccs.api.PostalAddressListEntryI
-
- getListType() - Method in interface com.avaya.ccs.api.DestinationListI
-
- getLocalServer() - Method in interface com.avaya.ccs.api.ServiceConfigI
-
- getLoginId() - Method in interface com.avaya.ccs.api.MonitoredUserI
-
- getLoginId() - Method in interface com.avaya.ccs.api.UserI
-
- getMailboxAddress() - Method in interface com.avaya.ccs.api.EmailMediaI
-
The AACC/ACCS mailbox address that handled this email
- getMainContactId() - Method in interface com.avaya.ccs.api.InteractionI
-
If the Contact that this InteractionI
is associated with was created as the result of a consult operation (transfer
or conference initiate), this method provides the ID of the main contact that is associated with this consult contact.
- getMainContactId() - Method in interface com.avaya.ccs.api.MonitoredInteractionI
-
If the contact associated with this
MonitoredInteractionI
object was created as the result of a consult operation
(transfer or conference initiate), this method provides the ID of the main contact that is associated with this consult
contact.
- getMedia() - Method in interface com.avaya.ccs.api.InteractionI
-
A getter for the MediaI member of this InteractionI object.
- getMessage() - Method in interface com.avaya.ccs.api.ErrorI
-
- getMode() - Method in interface com.avaya.ccs.api.OffsiteSettingsI
-
The current OffsiteMode
as administered in the Contact Center for the user.
- getMonitoredInteractions() - Method in interface com.avaya.ccs.api.MonitoredUserI
-
- getMonitoredUserId() - Method in interface com.avaya.ccs.api.MonitoredInteractionI
-
- getMonitoredUsers() - Method in interface com.avaya.ccs.api.UserI
-
A list of the users that the supervisor is monitoring.
- getName() - Method in interface com.avaya.ccs.api.AutoPhraseI
-
The name of this Auto Phrase
- getName() - Method in interface com.avaya.ccs.api.ContactCenterCodeI
-
The logical name for this ContactCenterCodeI
- getName() - Method in interface com.avaya.ccs.api.ContactNumberI
-
The logical name for this contact number.
- getName() - Method in interface com.avaya.ccs.api.CustomFieldI
-
The logical name for this CustomFieldI
- getName() - Method in interface com.avaya.ccs.api.DestinationI
-
- getName() - Method in interface com.avaya.ccs.api.IntrinsicI
-
- getName() - Method in interface com.avaya.ccs.api.RemoteParticipantI
-
- getName() - Method in interface com.avaya.ccs.api.ScreenPopI
-
The screenpop name
- getName() - Method in interface com.avaya.ccs.api.SuggestedResponseI
-
The name of this Suggested Response
- getNotification() - Method in interface com.avaya.ccs.api.UserI
-
- getNotificationObject() - Method in interface com.avaya.ccs.api.NotificationEventI
-
- getNotificationType() - Method in interface com.avaya.ccs.api.NotificationEventI
-
- getNotReadyReasonCodes() - Method in interface com.avaya.ccs.api.SessionI
-
- getNumber() - Method in interface com.avaya.ccs.api.ContactCenterCodeI
-
A number representing this
- getNumber() - Method in interface com.avaya.ccs.api.ContactNumberI
-
The phone number as a String
- getNumber() - Method in interface com.avaya.ccs.api.DestinationI
-
- getNumUsers() - Method in interface com.avaya.ccs.api.SessionI
-
- getOffsiteSettings() - Method in interface com.avaya.ccs.api.UserI
-
- getOffsiteStatus() - Method in interface com.avaya.ccs.api.UserI
-
Provides the offsite agent status of the Contact Center user.
- getOriginalDestination() - Method in interface com.avaya.ccs.api.InteractionI
-
The original destination address used by the caller to reach the system, sometimes referred to as the DNIS (Dialed Number
Identification Service).
- getOriginalDestination() - Method in interface com.avaya.ccs.api.MonitoredInteractionI
-
The original destination address used by the caller to reach the system, sometimes referred to as the DNIS (Dialed Number
Identification Service).
- getPagePushUrls() - Method in interface com.avaya.ccs.api.PagePushUrlListI
-
returns the list of Page Push URLs as configured in CCMM Admin
- getParticipationReason() - Method in interface com.avaya.ccs.api.InteractionI
-
Participation reason can be used to determine how a
UserI
is participating in a contact.
- getPath() - Method in interface com.avaya.ccs.api.ScreenPopI
-
The path or URL for the ScreenPop
- getPhone() - Method in interface com.avaya.ccs.api.OffsiteStatusI
-
- getPhoneList() - Method in interface com.avaya.ccs.api.CustomerDetailsI
-
A list of PhoneListEntryI
s associated with this customer
- getPhoneNumber() - Method in interface com.avaya.ccs.api.PhoneListEntryI
-
- getPhones() - Method in interface com.avaya.ccs.api.OffsiteSettingsI
-
A list containing the offsite phone numbers that are administered for the user in the Contact Center.
- getPhraseText() - Method in interface com.avaya.ccs.api.AutoPhraseI
-
The phrase text
- getPomZones() - Method in interface com.avaya.ccs.api.UserI
-
Provides an array of strings representing the POM zones administered on the experience portal server.
- getPostalAddressList() - Method in interface com.avaya.ccs.api.CustomerDetailsI
-
A list of postal addresses associated with this customer
- getPresence() - Method in interface com.avaya.ccs.api.DestinationI
-
- getPreviewTimer() - Method in interface com.avaya.ccs.api.InteractionI
-
Preview timer is the maximum time administered on the POM server that an interaction should remain in
InteractionState.Preview
before dialing.
- getReason() - Method in interface com.avaya.ccs.api.RemoteParticipantI
-
- getRemoteParticipants() - Method in interface com.avaya.ccs.api.InteractionI
-
- getRemoteServer() - Method in interface com.avaya.ccs.api.ServiceConfigI
-
- getResourceId() - Method in interface com.avaya.ccs.api.InteractionI
-
Identifies the
ResourceI
object that this
InteractionI
object is associated with by its identifier.
- getResources() - Method in interface com.avaya.ccs.api.SessionI
-
- getResponseData() - Method in interface com.avaya.ccs.api.NotificationEventI
-
- getRoles() - Method in interface com.avaya.ccs.api.UserI
-
- getScreenPops() - Method in interface com.avaya.ccs.api.InteractionI
-
Get the list of
ScreenPopI
s associated with this Interaction.
- getServer() - Method in interface com.avaya.ccs.api.ClientI
-
- getSession() - Method in interface com.avaya.ccs.api.ClientI
-
- getSession() - Method in interface com.avaya.ccs.api.InteractionI
-
- getSession() - Method in interface com.avaya.ccs.api.ResourceI
-
- getSession() - Method in interface com.avaya.ccs.api.UserI
-
- getSkillset() - Method in interface com.avaya.ccs.api.AutoPhraseI
-
The skillset associated with this Auto Phrase
- getSkillset() - Method in interface com.avaya.ccs.api.CustomerHistoryItemI
-
The Contact Center skillset which processed this Contact
- getSkillset() - Method in interface com.avaya.ccs.api.InteractionI
-
For an InteractionI
object representing a Contact Center contact this will return the latest skillset that the
contact has been routed to.
- getSkillset() - Method in interface com.avaya.ccs.api.MonitoredInteractionI
-
The skillset if present of the
InteractionI
that is represented by this
MonitoredInteractionI
.
- getSkillset() - Method in interface com.avaya.ccs.api.PagePushUrlI
-
The skillset associated with this Page Push URL
- getSkillsets() - Method in interface com.avaya.ccs.api.InteractionI
-
Request the list of available email skillsets configured in AACC/ACCS that can be used as an originating
address for an ad-hoc email.
- getSkillsetsForContactType(ContactType) - Method in interface com.avaya.ccs.api.UserI
-
Retrieve the list of skillsets that this
UserI
is enrolled in for a given
ContactType
- getSource() - Method in interface com.avaya.ccs.api.CustomerInteractionMediaItemI
-
A description of the origins of this contact.
- getState() - Method in interface com.avaya.ccs.api.ClientI
-
The current state of the ClientI
object can be retrieved by this method.
- getState() - Method in interface com.avaya.ccs.api.DestinationI
-
- getState() - Method in interface com.avaya.ccs.api.InteractionI
-
- getState() - Method in interface com.avaya.ccs.api.MonitoredInteractionI
-
- getState() - Method in interface com.avaya.ccs.api.MonitoredUserI
-
The current
UserState
of the
UserI
object that this
MonitoredUserI
object represents.
- getState() - Method in interface com.avaya.ccs.api.OffsiteStatusI
-
- getState() - Method in interface com.avaya.ccs.api.RemoteParticipantI
-
- getState() - Method in interface com.avaya.ccs.api.ResourceI
-
This property provides the current
ResourceState
of the
ResourceI
object.
- getState() - Method in interface com.avaya.ccs.api.UserI
-
This property provides the current
UserState
of the
UserI
object.
- getStateReason() - Method in interface com.avaya.ccs.api.InteractionI
-
The
StateReason
that represents the cause of the latest state transition.
- getStateReason() - Method in interface com.avaya.ccs.api.MonitoredInteractionI
-
The
StateReason
that represents the cause of the latest state transition that occurred on the
InteractionI
that is represented by this
MonitoredInteractionI
.
- getStateReason() - Method in interface com.avaya.ccs.api.ResourceI
-
- getStateReasonMessage() - Method in interface com.avaya.ccs.api.ResourceI
-
A text string containing a description of why this
ResourceI
is in the current
ResourceState
.
- getStatus() - Method in interface com.avaya.ccs.api.CustomerHistoryItemI
-
The current status of the Contact
- getStatus() - Method in interface com.avaya.ccs.api.EmailMediaI
-
The status of the Email media object.
- getStringData() - Method in interface com.avaya.ccs.api.DataI
-
- getSubject() - Method in interface com.avaya.ccs.api.CustomerHistoryItemI
-
The subject for this Contact, if applicable
- getSubject() - Method in interface com.avaya.ccs.api.CustomerInteractionMediaItemI
-
The 'Subject' value of this media item.
- getSubject() - Method in interface com.avaya.ccs.api.EmailMediaI
-
The email Subject
- getSubject() - Method in interface com.avaya.ccs.api.SuggestedResponseI
-
The email subject for this Suggested Response
- getSupervisorId() - Method in interface com.avaya.ccs.api.MonitoredInteractionI
-
- getSupervisorId() - Method in interface com.avaya.ccs.api.MonitoredUserI
-
- getSupervisorName() - Method in interface com.avaya.ccs.api.UserI
-
- getSupervisorUser() - Method in interface com.avaya.ccs.api.MonitoredUserI
-
- getText() - Method in interface com.avaya.ccs.api.NotificationI
-
- getTimezone() - Method in interface com.avaya.ccs.api.ContactNumberI
-
The time zone of this customer number
- getTimezone() - Method in interface com.avaya.ccs.api.DestinationI
-
A string representation of the timezone association with the destination if it is available.
- getTimezone() - Method in interface com.avaya.ccs.api.PhoneListEntryI
-
- getTitle() - Method in interface com.avaya.ccs.api.CustomerDetailsI
-
The title of the customer
- getTo() - Method in interface com.avaya.ccs.api.CustomerInteractionMediaItemI
-
The 'To' value of this media item.
- getTo() - Method in interface com.avaya.ccs.api.EmailMediaI
-
The To party(s) of the email.
- getTokens() - Method in interface com.avaya.ccs.api.NotificationI
-
A list of strings containing tokens to be inserted into a localized message.
- getType() - Method in interface com.avaya.ccs.api.ContactCenterCodeI
-
- getType() - Method in interface com.avaya.ccs.api.RemoteParticipantI
-
- getUploadAttachmentUrl() - Method in interface com.avaya.ccs.api.EmailMediaI
-
returns the upload attachment URL.
- getUrl() - Method in interface com.avaya.ccs.api.PagePushUrlI
-
The URL value
- getUserId() - Method in interface com.avaya.ccs.api.InteractionI
-
Identifies the
UserI
object that this
InteractionI
object is associated with by its identifier.
- getUserRole() - Method in interface com.avaya.ccs.api.CustomerInteractionMediaItemI
-
The customer's user role, e.g.
- getUsers() - Method in interface com.avaya.ccs.api.SessionI
-
- getUserSyncMessage() - Method in interface com.avaya.ccs.api.UserI
-
- getUserSyncStatus() - Method in interface com.avaya.ccs.api.UserI
-
Returns the current synchronised status of the
UserI
.
- getUUI() - Method in interface com.avaya.ccs.api.InteractionI
-
Retrieves the user-user info (UUI) stored on the contact associated with this InteractionI
.
- getUUI() - Method in interface com.avaya.ccs.api.MonitoredInteractionI
-
Retrieves the user-user info (UUI) stored on the contact associated with the InteractionI
that is represented by
this MonitoredInteractionI
.
- getValue() - Method in interface com.avaya.ccs.api.CustomFieldI
-
- getValue() - Method in interface com.avaya.ccs.api.IntrinsicI
-
- getVersion() - Method in interface com.avaya.ccs.api.ClientI
-
- getVersion() - Method in interface com.avaya.ccs.api.ServiceConfigI
-
- getVersion() - Method in interface com.avaya.ccs.api.SessionI
-
- getVoiceResource() - Method in interface com.avaya.ccs.api.UserI
-
- getWebChatAgentLabel() - Method in interface com.avaya.ccs.api.InteractionI
-
The Webchat label of the UserI
who received is processing this contact.
- getWebChatCustomerConnected() - Method in interface com.avaya.ccs.api.InteractionI
-
A customer in a web chat may temporarily lose their connection, for example if their internet connection drops
In this case, an Interaction Update will be sent to the client with WebChatCustomerConnected set to false
If this contact isn't a {WebChatMediaI} contact, then this will be null
- getWrapupTimer() - Method in interface com.avaya.ccs.api.InteractionI
-
Wrapup time is the maximum time administered on the POM server that an interaction should remain in
InteractionState.Wrapup
.
- getZipcode() - Method in interface com.avaya.ccs.api.PostalAddressListEntryI
-
- ScreenPopI - Interface in com.avaya.ccs.api
-
ScreenPops are links to applications or URLs which are sent by CCS as part of an
InteractionI
object; with the intention
that the associated application or URL can be 'popped' up automatically to the agent either on call alerting or call answer.
- SecurityContextI - Interface in com.avaya.ccs.api
-
The SecurityContextI
interface represents security context that the API will use to setup secure communications with
the server.
- SecurityException - Exception in com.avaya.ccs.api.exceptions
-
- SecurityException(String) - Constructor for exception com.avaya.ccs.api.exceptions.SecurityException
-
- SecurityException(String, Throwable) - Constructor for exception com.avaya.ccs.api.exceptions.SecurityException
-
- sendIsTypingRequest() - Method in interface com.avaya.ccs.api.WebChatMediaI
-
Sends an IsTyping request to the customer client
- sendMessage(String, boolean) - Method in interface com.avaya.ccs.api.WebChatMediaI
-
In a webchat session, agents send messages to customers and other agents using this method
- sendPagePushUrl(String) - Method in interface com.avaya.ccs.api.WebChatMediaI
-
In a webchat session, agents can sends a URL to customers and other agents using this method.
- ServiceConfigI - Interface in com.avaya.ccs.api
-
- SessionI - Interface in com.avaya.ccs.api
-
The SessionI
interface represents an active authenticated session with the server.
- SessionListenerI - Interface in com.avaya.ccs.api
-
An implementing instance of the
SessionListenerI
interface delivers
SessionI
level events to the application.
- setActivityCode(String) - Method in interface com.avaya.ccs.api.InteractionI
-
Requests that an activity code be set on the contact that this InteractionI
object represents.
- setAttachments(InboundAttachment[]) - Method in interface com.avaya.ccs.api.SuggestedResponseI
-
Set the attachments for this Suggested Response object
- setAutoPhrases(List<AutoPhrase>) - Method in interface com.avaya.ccs.api.AutoPhrasesI
-
- setAutoReconnect(boolean) - Method in interface com.avaya.ccs.api.ClientI
-
Sets whether the ClientI
object should automatically attempt to reconnect to the server on a web socket
close.
- setBody(String) - Method in interface com.avaya.ccs.api.SuggestedResponseI
-
Set the email body for this Suggested Response object
- setCallbackTypeSpecified(boolean) - Method in interface com.avaya.ccs.api.DestinationI
-
- setCallType(DestinationCallType) - Method in interface com.avaya.ccs.api.DestinationI
-
- setCountry(String) - Method in interface com.avaya.ccs.api.PostalAddressListEntryI
-
Allows the
UserI
processing an
InteractionI
to modify the country of the administered for the customer's
postal address entry
- setCountryCode(String) - Method in interface com.avaya.ccs.api.PhoneListEntryI
-
Allows the
UserI
processing an
InteractionI
to modify the country code administered for the customer's
phone entry
- setCustomerList(CustomerList) - Method in interface com.avaya.ccs.api.CustomerDataI
-
Deprecated.
- setData(DataI) - Method in interface com.avaya.ccs.api.InteractionI
-
Requests that attached data be set on the contact that associated with this InteractionI
object.
- setDefault(boolean) - Method in interface com.avaya.ccs.api.EmailListEntryI
-
Allows the
UserI
processing an
InteractionI
to set this as the default email address for the customer
- setDefault(boolean) - Method in interface com.avaya.ccs.api.PhoneListEntryI
-
Allows the
UserI
processing an
InteractionI
to specify this as the default phone number for the customer.
- setDefault(boolean) - Method in interface com.avaya.ccs.api.PostalAddressListEntryI
-
Allows the
UserI
processing an
InteractionI
to set this as the default address for the customoer
- setDescription(String) - Method in interface com.avaya.ccs.api.PagePushUrlI
-
- setEmailAddress(String) - Method in interface com.avaya.ccs.api.EmailListEntryI
-
Allows a
UserI
on an
InteractionI
with a customer to update the email record for the customer
server.
- setId(int) - Method in interface com.avaya.ccs.api.SuggestedResponseI
-
Set the ID for this object instance
- setIntrinsic(String, String) - Method in interface com.avaya.ccs.api.InteractionI
-
Requests that the value of an existing intrinsic be modified or a new intrinsic be added to a contact.
- setLanguage(String) - Method in interface com.avaya.ccs.api.UserI
-
Allows the application to change the language of the UserI
- setLine1(String) - Method in interface com.avaya.ccs.api.PostalAddressListEntryI
-
Allows the
UserI
processing an
InteractionI
to modify line 1 of the administered for the customer's postal
address entry
- setLine2(String) - Method in interface com.avaya.ccs.api.PostalAddressListEntryI
-
Allows the
UserI
processing an
InteractionI
to modify line 2 of the administered for the customer's postal
address entry
- setLine3(String) - Method in interface com.avaya.ccs.api.PostalAddressListEntryI
-
Allows the
UserI
processing an
InteractionI
to modify line 3 of the administered for the customer's postal
address entry
- setLine4(String) - Method in interface com.avaya.ccs.api.PostalAddressListEntryI
-
Allows the
UserI
processing an
InteractionI
to modify line 4 of the administered for the customer's postal
address entry
- setLine5(String) - Method in interface com.avaya.ccs.api.PostalAddressListEntryI
-
Allows the
UserI
processing an
InteractionI
to modify line 5 of the administered for the customer's postal
address entry
- setMedia(Media) - Method in interface com.avaya.ccs.api.InteractionI
-
A setter for the MediaI member of this InteractionI object.
- setName(String) - Method in interface com.avaya.ccs.api.DestinationI
-
- setName(String) - Method in interface com.avaya.ccs.api.SuggestedResponseI
-
Set the name for this object instance
- setNumber(String) - Method in interface com.avaya.ccs.api.DestinationI
-
- setPagePushUrls(List<PagePushUrl>) - Method in interface com.avaya.ccs.api.PagePushUrlListI
-
Set the list of Page Push URLs
- setPhoneNumber(String) - Method in interface com.avaya.ccs.api.PhoneListEntryI
-
Allows the
UserI
processing an
InteractionI
to modify the phone number administered for the customer's
phone entry
- setPomZone(String) - Method in interface com.avaya.ccs.api.DestinationI
-
- setPresence(Presence) - Method in interface com.avaya.ccs.api.DestinationI
-
- setReplyResponse(EmailReplyResponse) - Method in interface com.avaya.ccs.api.EmailMediaI
-
- setServer(String) - Method in interface com.avaya.ccs.api.ClientI
-
Allows the application to change the fully qualified hostname of the server that the client will connect at
signin time.
- setSkillset(String) - Method in interface com.avaya.ccs.api.PagePushUrlI
-
- setSubject(String) - Method in interface com.avaya.ccs.api.SuggestedResponseI
-
set the subject for this object instance
- setTimezone(String) - Method in interface com.avaya.ccs.api.DestinationI
-
- setTimezone(String) - Method in interface com.avaya.ccs.api.PhoneListEntryI
-
Allows the
UserI
processing an
InteractionI
to modify the timezone administered for the customer's phone
entry
- setType(DestinationType) - Method in interface com.avaya.ccs.api.DestinationI
-
- setUploadAttachmentUrl(String) - Method in interface com.avaya.ccs.api.EmailMediaI
-
When an email Reply (or Create) command is sent, CCS replies with a EmailReplyResponse
.
- setUrl(String) - Method in interface com.avaya.ccs.api.PagePushUrlI
-
- setUUI(String) - Method in interface com.avaya.ccs.api.InteractionI
-
Requests that new user-user-info (UUI) be set on the contact associated with this InteractionI
object.
- setZipcode(String) - Method in interface com.avaya.ccs.api.PostalAddressListEntryI
-
Allows the
UserI
processing an
InteractionI
to modify the country of the administered for the customer's
postal address entry
- signin(String, String, SessionListenerI, ClientListenerI) - Method in interface com.avaya.ccs.api.ClientI
-
Request that the ClientI
object connect and authenticate with the Contact Center server to use the
Contact Control Service.
- StateReason - Enum in com.avaya.ccs.api.enums
-
The
StateReason
enum defines the possible reasons for a state transition on an API object (for example
InteractionI
or
ResourceI
).
- SuggestedResponseI - Interface in com.avaya.ccs.api
-
A suggested response is a prepared email response which an agent can use to quickly respond to common customer requests.
- valueOf(String) - Static method in enum com.avaya.ccs.api.enums.ChatMessageType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.avaya.ccs.api.enums.ClientState
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.avaya.ccs.api.enums.CodeType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.avaya.ccs.api.enums.Command
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.avaya.ccs.api.enums.ContactType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.avaya.ccs.api.enums.DataFormat
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.avaya.ccs.api.enums.DestinationCallType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.avaya.ccs.api.enums.DestinationListType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.avaya.ccs.api.enums.DestinationType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.avaya.ccs.api.enums.ErrorCode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.avaya.ccs.api.enums.InteractionState
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.avaya.ccs.api.enums.InteractionType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.avaya.ccs.api.enums.NotificationCode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.avaya.ccs.api.enums.NotificationType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.avaya.ccs.api.enums.OffsiteMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.avaya.ccs.api.enums.OffsiteState
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.avaya.ccs.api.enums.Presence
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.avaya.ccs.api.enums.Profile
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.avaya.ccs.api.enums.RemoteParticipantState
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.avaya.ccs.api.enums.ResourceState
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.avaya.ccs.api.enums.Role
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.avaya.ccs.api.enums.StateReason
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.avaya.ccs.api.enums.UserState
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.avaya.ccs.api.enums.UserSyncStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.avaya.ccs.api.enums.WebChatMethod
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.avaya.ccs.api.enums.WebChatSenderType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.avaya.ccs.api.enums.ChatMessageType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.avaya.ccs.api.enums.ClientState
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.avaya.ccs.api.enums.CodeType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.avaya.ccs.api.enums.Command
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.avaya.ccs.api.enums.ContactType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.avaya.ccs.api.enums.DataFormat
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.avaya.ccs.api.enums.DestinationCallType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.avaya.ccs.api.enums.DestinationListType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.avaya.ccs.api.enums.DestinationType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.avaya.ccs.api.enums.ErrorCode
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.avaya.ccs.api.enums.InteractionState
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.avaya.ccs.api.enums.InteractionType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.avaya.ccs.api.enums.NotificationCode
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.avaya.ccs.api.enums.NotificationType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.avaya.ccs.api.enums.OffsiteMode
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.avaya.ccs.api.enums.OffsiteState
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.avaya.ccs.api.enums.Presence
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.avaya.ccs.api.enums.Profile
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.avaya.ccs.api.enums.RemoteParticipantState
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.avaya.ccs.api.enums.ResourceState
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.avaya.ccs.api.enums.Role
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.avaya.ccs.api.enums.StateReason
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.avaya.ccs.api.enums.UserState
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.avaya.ccs.api.enums.UserSyncStatus
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.avaya.ccs.api.enums.WebChatMethod
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.avaya.ccs.api.enums.WebChatSenderType
-
Returns an array containing the constants of this enum type, in
the order they are declared.