Avaya Aura®
Collaboration Environment
Version 3.0 API
A C D E F G H I L M N O P R S T U V W X 

A

ABANDONED - Static variable in class com.avaya.collaboration.call.CallTerminationCause
Call terminated by calling party before it was answered.
addBcc(String) - Method in interface com.avaya.collaboration.email.EmailRequest
Add one or many bcc recipients to the existing set of bcc recipients for this email.
addCc(String) - Method in interface com.avaya.collaboration.email.EmailRequest
Add one or many cc recipients to the existing set of cc recipients for this email.
addCriterion(String, String) - Method in interface com.avaya.collaboration.eventing.EventFilter
Add key/value pairs to filter against.
addCriterionIgnoreCase(String, String) - Method in interface com.avaya.collaboration.eventing.EventFilter
Add key/value pairs to filter against using a case-insensitive match on value.
addEventType(String) - Method in interface com.avaya.collaboration.eventing.EventSubscriptionAttributes
(Optional) - Add an event type to the subscription attributes.
addHeader(String, String) - Method in interface com.avaya.collaboration.call.sip.SipRequest
Adds a header with the given name and value.
addHeader(String, String) - Method in interface com.avaya.collaboration.call.sip.SipResponse
Adds a header with the given name and value.
addParticipant(Participant) - Method in interface com.avaya.collaboration.call.Call
Alert multiple destinations for the initial call.
addParticipantFailed(Call, Participant, CallTerminationCause) - Method in interface com.avaya.collaboration.call.CallListener
Indicates that the addParticipant call failed
addParticipantFailed(Call, Participant, CallTerminationCause) - Method in class com.avaya.collaboration.call.CallListenerAbstract
Indicates that the addParticipant call failed
addPhrase(String, float) - Method in interface com.avaya.collaboration.call.speech.search.query.Concept
Add a phrase and threshold to the concept
addPhrase(String, float) - Method in interface com.avaya.collaboration.call.speech.search.query.SearchQuery
Add a phrase and threshold to the search query
addRecipient(String) - Method in interface com.avaya.collaboration.sms.SmsRequest
Add another recipient to the existing set of recipients for this message.
AddressType - Class in com.avaya.collaboration.data.api
An enumeration of the supported communication address types configured in System Manager.
addTo(String) - Method in interface com.avaya.collaboration.email.EmailRequest
Add one or many to recipients to the existing set of to recipients for this email.
addValue(String, String) - Method in interface com.avaya.collaboration.eventing.EventMetaData
(Optional) - Add arbitrary key/value pairs as meta data.
AFTER_ANSWER - Static variable in class com.avaya.collaboration.call.CallTerminationCause
Call terminated after it was answered by called party.
ALL - Static variable in class com.avaya.collaboration.call.speech.search.match.MatchReportingStrategy
Provides matching results on all concepts and phrases in the entire search query.
ALL - Static variable in class com.avaya.collaboration.call.speech.search.query.OperatorType
The ALL operator generates a match whenever all of its constituent search terms are found to match within a specified time period.
AllOperator - Interface in com.avaya.collaboration.call.speech.search.query.operators
The ALL operator generates a match whenever all of its constituent search terms are found to match.
allow() - Method in interface com.avaya.collaboration.call.Call
Allow the call to proceed to the original target.
ALTERNATIVE_TARGET - Static variable in class com.avaya.collaboration.call.CallTerminationCause
Call terminated due to target suggested to try alternative target.
ANY - Static variable in class com.avaya.collaboration.call.speech.search.query.OperatorType
The ANY operator generates a match whenever any of its constituent search terms are found to match.
AnyOperator - Interface in com.avaya.collaboration.call.speech.search.query.operators
The ANY operator generates a match whenever any of its constituent search terms are found to match.
APPLICATION_DROPPED - Static variable in class com.avaya.collaboration.call.CallTerminationCause
Case where a service dropped the call
AT_LEAST - Static variable in class com.avaya.collaboration.call.speech.search.query.OperatorType
The AT_LEAST operator generates a match whenever at least m of its n constituent search terms are found to match within a specified time period.
AtLeastOperator - Interface in com.avaya.collaboration.call.speech.search.query.operators
The AT LEAST operator generates a match whenever at least m of its n constituent search terms are found to match.
AUDIO - Static variable in class com.avaya.collaboration.call.MediaType
 
AVAYA_E164 - Static variable in class com.avaya.collaboration.data.api.AddressType
Avaya E.164 number configured in System Manager
AVAYA_SIP - Static variable in class com.avaya.collaboration.data.api.AddressType
Avaya SIP number configured in System Manager
AVAYA_XMPP - Static variable in class com.avaya.collaboration.data.api.AddressType
Avaya XMPP address configured in System Manager

C

Call - Interface in com.avaya.collaboration.call
Represents a call, or session, for providing operations like allow, drop, or divertTo, and to change display names/addresses presented to the parties in a call.
callAlerting(Participant) - Method in interface com.avaya.collaboration.call.CallListener
Indicates that a party in Call has started alerting (i.e., the called party's device has notified its user of an incoming call).
callAlerting(Participant) - Method in class com.avaya.collaboration.call.CallListenerAbstract
Indicates that a party in Call has started alerting (i.e., the called party's device has notified its user of an incoming call).
callAnswered(Call) - Method in interface com.avaya.collaboration.call.CallListener
Indicates that a party in Call answered the call.
callAnswered(Call) - Method in class com.avaya.collaboration.call.CallListenerAbstract
Indicates that a party in Call answered the call.
callAnswered(Call) - Method in class com.avaya.collaboration.call.speech.search.sample.SampleUnifiedSpeechCall
When a call is answered, play a Text to Speech prompt to the calling party to inform them the call is being monitored for speech search.
CallFactory - Class in com.avaya.collaboration.call
Factory used to either create a call or get an existing call from its ID.
callIntercepted(Call) - Method in interface com.avaya.collaboration.call.CallListener
Notification of intercepted call.
callIntercepted(Call) - Method in class com.avaya.collaboration.call.speech.search.sample.SampleSpeechSearchCall
Intercept a call and start a speech search.
callIntercepted(Call) - Method in class com.avaya.collaboration.call.speech.search.sample.SampleUnifiedSpeechCall
Intercept a call and start a speech search.
callIntercepted(Call) - Method in class com.avaya.collaboration.call.speech.voicexml.sample.SampleVoiceXMLDialog
 
CallListener - Interface in com.avaya.collaboration.call
Listener interface through which the service is informed of Call events.
CallListenerAbstract - Class in com.avaya.collaboration.call
Abstract listener class through which the service is informed of Call events.
CallListenerAbstract() - Constructor for class com.avaya.collaboration.call.CallListenerAbstract
 
callOriginated(Call) - Method in interface com.avaya.collaboration.call.CallListener
Indicates that the calling party in a Call has originated a call.
callOriginated(Call) - Method in class com.avaya.collaboration.call.CallListenerAbstract
Indicates that the call has terminated.
CallProperties - Class in com.avaya.collaboration.call
This class provides access to various properties of the call.
CallProperties() - Constructor for class com.avaya.collaboration.call.CallProperties
 
callTerminated(Call, CallTerminationCause) - Method in interface com.avaya.collaboration.call.CallListener
Indicates that the call has terminated.
callTerminated(Call, CallTerminationCause) - Method in class com.avaya.collaboration.call.CallListenerAbstract
Indicates that the call has terminated.
CallTerminationCause - Class in com.avaya.collaboration.call
An enumeration of the Call Termination Cause which can be used to find reason of call termination.
cancelConf(int) - Static method in class com.avaya.collaboration.conference.scheduled.SchedConfOperations
Cancel the conference given by confId.
clearDeliverToPreferredVersion() - Method in interface com.avaya.collaboration.eventing.EventSubscriptionAttributes
(Optional) - Clear the "deliver to preferred version" option.
clearPopulateConsumerPreferredVersion() - Method in interface com.avaya.collaboration.eventing.EventSubscriptionAttributes
(Optional) - Clear the "populate preferred consumer version" option.
clone() - Method in exception com.avaya.collaboration.conference.scheduled.SchedConfException
Clone Not Supported
clone() - Method in class com.avaya.collaboration.conference.scheduled.SchedConfFactory
Clone Not Supported
clone() - Method in class com.avaya.collaboration.conference.scheduled.SchedConfOperations
Clone Not Supported
clone() - Method in exception com.avaya.collaboration.eventing.EventingException
Clone Not Supported
clone() - Method in class com.avaya.collaboration.eventing.EventingFactory
 
closeBus() - Static method in class com.avaya.collaboration.bus.factory.CollaborationBusFactory
 
ClusterData - Interface in com.avaya.collaboration.businessdata.api
This interface provides methods to retrieve various cluster-related data configured as cluster attributes
CollaborationBusException - Exception in com.avaya.collaboration.bus
Exception raised by the Collaboration Bus.
CollaborationBusException(String) - Constructor for exception com.avaya.collaboration.bus.CollaborationBusException
Constructs a CollaborationBusException with the specified error message
CollaborationBusFactory - Class in com.avaya.collaboration.bus.factory
Factory that returns the CollaborationBusMessageHandler instance
CollaborationBusMessage - Interface in com.avaya.collaboration.bus
A collaboration bus message.
CollaborationBusMessageHandler - Interface in com.avaya.collaboration.bus
This is the main interface for handling messaging on the Collaboration Bus.
CollaborationBusMessageHeader - Interface in com.avaya.collaboration.bus
The Collaboration Bus Message header.
CollaborationDataFactory - Class in com.avaya.collaboration.dal.factory
This factory class provides methods that return data access objects: ServiceData, etc.
collect(Participant, DigitOptions, MediaListener) - Method in interface com.avaya.collaboration.call.media.MediaService
Collects a pattern of digits from a participant on a call.
com.avaya.collaboration.bus - package com.avaya.collaboration.bus
The Collaboration Bus is used to send and receive messages between services.
com.avaya.collaboration.bus.factory - package com.avaya.collaboration.bus.factory
 
com.avaya.collaboration.bus.sample - package com.avaya.collaboration.bus.sample
Sample code snippet that illustrate the use of Collaboration Bus API and invoking outgoing http requests from system.
com.avaya.collaboration.businessdata.api - package com.avaya.collaboration.businessdata.api
 
com.avaya.collaboration.call - package com.avaya.collaboration.call
Provides classes and interfaces for dealing with call.
com.avaya.collaboration.call.media - package com.avaya.collaboration.call.media
Provides classes and interfaces for bringing media to call.
com.avaya.collaboration.call.media.sample - package com.avaya.collaboration.call.media.sample
 
com.avaya.collaboration.call.sip - package com.avaya.collaboration.call.sip
Provides classes and interfaces for doing SIP header manipulation.
com.avaya.collaboration.call.speech.search - package com.avaya.collaboration.call.speech.search
 
com.avaya.collaboration.call.speech.search.exception - package com.avaya.collaboration.call.speech.search.exception
 
com.avaya.collaboration.call.speech.search.match - package com.avaya.collaboration.call.speech.search.match
 
com.avaya.collaboration.call.speech.search.query - package com.avaya.collaboration.call.speech.search.query
 
com.avaya.collaboration.call.speech.search.query.operators - package com.avaya.collaboration.call.speech.search.query.operators
 
com.avaya.collaboration.call.speech.search.sample - package com.avaya.collaboration.call.speech.search.sample
 
com.avaya.collaboration.call.speech.voicexml - package com.avaya.collaboration.call.speech.voicexml
 
com.avaya.collaboration.call.speech.voicexml.sample - package com.avaya.collaboration.call.speech.voicexml.sample
 
com.avaya.collaboration.conference.scheduled - package com.avaya.collaboration.conference.scheduled
Provides classes and interfaces for scheduling conferences, including ones that can begin right away.
com.avaya.collaboration.conference.scheduled.sample - package com.avaya.collaboration.conference.scheduled.sample
Provides example code for use of the Scheduled Conference API.
com.avaya.collaboration.conference.scheduled.scopia - package com.avaya.collaboration.conference.scheduled.scopia
Provides a "raw" interface to the XML-based API for a Scopia system configured on Collaboration Environment.
com.avaya.collaboration.dal.factory - package com.avaya.collaboration.dal.factory
 
com.avaya.collaboration.data.api - package com.avaya.collaboration.data.api
Provides an API useful for retrieving certain items from a user’s data in Avaya Aura® Collaboration Environment.
com.avaya.collaboration.data.api.sample - package com.avaya.collaboration.data.api.sample
Provides examples for using the user data API.
com.avaya.collaboration.email - package com.avaya.collaboration.email
Provides an API useful for sending an email.
com.avaya.collaboration.email.sample - package com.avaya.collaboration.email.sample
Provides examples for using the Email API.
com.avaya.collaboration.eventing - package com.avaya.collaboration.eventing
The Eventing Framework provides the ability for a snap-in to generate notifications about "interesting events" that can then be received by other snap-ins with an interest in these events.
com.avaya.collaboration.eventing.families - package com.avaya.collaboration.eventing.families
Provides constants, grouped by event family, that are useful for handling events.
com.avaya.collaboration.eventing.sample - package com.avaya.collaboration.eventing.sample
Provides example code for use of the Eventing Framework API.
com.avaya.collaboration.service - package com.avaya.collaboration.service
Provides class and interface for injecting service life cycle (initialize/destroy of service) callbacks.
com.avaya.collaboration.service.activity - package com.avaya.collaboration.service.activity
Provides an API useful for recording service activity.
com.avaya.collaboration.service.activity.sample - package com.avaya.collaboration.service.activity.sample
Provides an example for using ServiceActivityData API
com.avaya.collaboration.sms - package com.avaya.collaboration.sms
Provides an API useful for sending SMS messages.
com.avaya.collaboration.sms.sample - package com.avaya.collaboration.sms.sample
Provides examples for using the SMS API.
com.avaya.collaboration.ssl.util - package com.avaya.collaboration.ssl.util
 
com.avaya.collaboration.ssl.util.sample - package com.avaya.collaboration.ssl.util.sample
 
com.avaya.collaboration.util - package com.avaya.collaboration.util
Contains general purpose utility classes and interfaces.
com.avaya.collaboration.util.logger - package com.avaya.collaboration.util.logger
Provides the Collaboration Logger class.
com.avaya.zephyr.platform.dal.api - package com.avaya.zephyr.platform.dal.api
 
COMMUNICATION_ERROR - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode
 
COMPLETE - Static variable in class com.avaya.collaboration.call.media.PlayOperationCause
Play completed because all media generation has completed.
Concept - Interface in com.avaya.collaboration.call.speech.search.query
A concept, in a speech search, is a categorization of a part of a conversation.
CONFERENCE_ALREADY_CANCELLED - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode
 
CONFERENCE_FINISHED - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode
 
CONFERENCE_NOT_FOUND - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode
 
CONFERENCE_STARTED - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode
 
CONNECTOR_NOT_FOUND - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode
 
CONSUMER_PRIVATE_DATA_TOO_LARGE - Static variable in class com.avaya.collaboration.eventing.EventingResultCode
 
create(Participant, String) - Static method in class com.avaya.collaboration.call.CallFactory
Creates new instance of Call with callingParty and target.
create(String, String, Identity) - Static method in class com.avaya.collaboration.call.CallFactory
Creates new instance of Call with from, to and onBehalfOf that is used to set up a 2-party call between the from and the to.
create(String) - Static method in class com.avaya.collaboration.call.IdentityFactory
Creates a new local Identity instance.
create(String, String) - Static method in class com.avaya.collaboration.call.IdentityFactory
Creates a new local Identity instance.
create(String) - Method in interface com.avaya.collaboration.call.IdentityFactoryInterface
 
create(String, String) - Method in interface com.avaya.collaboration.call.IdentityFactoryInterface
 
create(String) - Static method in class com.avaya.collaboration.call.ParticipantFactory
Creates a new local Participant instance.
create(String, String) - Static method in class com.avaya.collaboration.call.ParticipantFactory
Creates a new local Participant instance.
create(String, String, String) - Static method in class com.avaya.collaboration.call.ParticipantFactory
Creates a new local Participant instance.
createAllOperator() - Static method in class com.avaya.collaboration.call.speech.search.SpeechFactory
 
createAnyOperator() - Static method in class com.avaya.collaboration.call.speech.search.SpeechFactory
 
createAtLeastOperator() - Static method in class com.avaya.collaboration.call.speech.search.SpeechFactory
 
createConcept() - Static method in class com.avaya.collaboration.call.speech.search.SpeechFactory
Returns an instance of a Concept that is used to build a search query.
createConf() - Static method in class com.avaya.collaboration.conference.scheduled.SchedConfFactory
Creates a SchedConf instance with some its attributes initialized to default values.
createDigitOptions() - Static method in class com.avaya.collaboration.call.media.MediaFactory
Returns an instance of a DigitOptions that is used to make a request to a media server to collect digits from a participant on a call.
createEmailRequest() - Static method in class com.avaya.collaboration.email.EmailFactory
Creates an EmailRequest object with no parameters.
createEventFilter() - Static method in class com.avaya.collaboration.eventing.EventingFactory
Returns an EventFilter object used by a consumer to limit the events that will be delivered.
createEventingService() - Static method in class com.avaya.collaboration.eventing.EventingFactory
Returns an EventingService object, which provides various Eventing Framework operations such as subscribing for events.
createEventMetaData() - Static method in class com.avaya.collaboration.eventing.EventingFactory
Returns an EventMetaData object used by a producer to provide data with an event publication that is typically used to match against a subscription's EventFilter.
createEventProducer(String, String, EventMetaData, String, String) - Static method in class com.avaya.collaboration.eventing.EventingFactory
Returns an instance of an EventProducer, which is used to publish an event.
createEventSubscriptionAttributes(String) - Static method in class com.avaya.collaboration.eventing.EventingFactory
Returns an EventSubscriptionAttributes object that can be used to subscribe for an event.
createEventSubscriptionAttributes(String, String) - Static method in class com.avaya.collaboration.eventing.EventingFactory
Returns an EventSubscriptionAttributes object that can be used to subscribe for an event.
createEventSubscriptionAttributes(String, List) - Static method in class com.avaya.collaboration.eventing.EventingFactory
Returns an EventSubscriptionAttributes object that can be used to subscribe for an event.
createFirstOperator() - Static method in class com.avaya.collaboration.call.speech.search.SpeechFactory
 
createLastOperator() - Static method in class com.avaya.collaboration.call.speech.search.SpeechFactory
 
createMediaService() - Static method in class com.avaya.collaboration.call.media.MediaFactory
Returns an instance of a MediaService.
createPlayItem() - Static method in class com.avaya.collaboration.call.media.MediaFactory
Returns an instance of a PlayItem that is used to make a request to a media server to play a file to a participant on a call.
createScopiaRequest() - Static method in class com.avaya.collaboration.conference.scheduled.SchedConfFactory
Creates a ScopiaRequest instance which allows a service writer to submit raw requests to SCOPIA Management using the native (XML) interface.
createSearchOptions() - Static method in class com.avaya.collaboration.call.speech.search.SpeechFactory
Returns an instance of a SearchOptions that is used to make a request to a speech search service.
createSearchQuery() - Method in class com.avaya.collaboration.call.speech.search.sample.SampleUnifiedSpeechCall
Create a Search Query based on a insurance sales call.
createSearchQuery() - Static method in class com.avaya.collaboration.call.speech.search.SpeechFactory
Returns an instance of a SearchQuery that is used to build a search option.
createServicActivityData() - Static method in class com.avaya.collaboration.service.activity.ServiceActivityDataFactory
Returns a ServiceActivityData object that can be used to track and update service activity data.
createSmsRequest(String, String) - Static method in class com.avaya.collaboration.sms.SmsFactory
Creates an SmsRequest object, when the SMS will be sent to a single recipient.
createSmsRequest(List, String) - Static method in class com.avaya.collaboration.sms.SmsFactory
Creates an SmsRequest object, when the SMS will be sent to multiple recipients.
createSpeechService() - Static method in class com.avaya.collaboration.call.speech.search.SpeechFactory
Returns an instance of a SpeechService.
createSSLContext() - Static method in class com.avaya.collaboration.ssl.util.SSLUtilityFactory
Returns instance of SSLContext initialized with the platform's trust store and key store
createSSLContext(SSLProtocolType) - Static method in class com.avaya.collaboration.ssl.util.SSLUtilityFactory
Returns instance of SSLContext initialized with the platform's trust store and key store and with the specified SSL protocol
createVoiceXMLDialogItem() - Static method in class com.avaya.collaboration.call.speech.search.SpeechFactory
Returns an instance of a VoiceXMLDialogItem class that is used build a VoiceXMLDialog request to send to the Media Server.

D

DATA_GRID_CONNECTION_ERROR - Static variable in class com.avaya.collaboration.eventing.EventingResultCode
 
DATA_GRID_INITIALIZATION_ERROR - Static variable in class com.avaya.collaboration.eventing.EventingResultCode
 
decrement() - Method in interface com.avaya.collaboration.service.activity.ServiceActivityData
Decrements the existing activity count by one.
This method will not allow activity count to go below zero.
If decrement() is called when count is already 0, then it will not be decremented further and 0 will be returned.
DEFAULT_INTERRUPTIBLE - Static variable in interface com.avaya.collaboration.call.media.PlayItem
 
DEFAULT_IS_FLUSH_BUFFER - Static variable in interface com.avaya.collaboration.call.media.DigitOptions
 
DEFAULT_ITERATION_COUNT - Static variable in interface com.avaya.collaboration.call.media.PlayItem
 
DEFAULT_LANGUAGE - Static variable in interface com.avaya.collaboration.call.speech.search.query.SearchQuery
The default language.
DEFAULT_LANGUAGE - Static variable in interface com.avaya.collaboration.call.speech.search.SearchOptions
The default language.
DEFAULT_MAX_DURATION - Static variable in interface com.avaya.collaboration.call.media.PlayItem
 
DEFAULT_NUMBER_OF_DIGITS - Static variable in interface com.avaya.collaboration.call.media.DigitOptions
 
DEFAULT_TERMINATION_KEY - Static variable in interface com.avaya.collaboration.call.media.DigitOptions
 
DEFAULT_THRESHOLD - Static variable in interface com.avaya.collaboration.call.speech.search.query.Concept
The default threshold.
DEFAULT_THRESHOLD - Static variable in interface com.avaya.collaboration.call.speech.search.query.Phrase
The default threshold.
DEFAULT_TIMEOUT_MILLISECONDS - Static variable in interface com.avaya.collaboration.call.media.DigitOptions
 
DESERIALIZATION_FAILURE - Static variable in class com.avaya.collaboration.eventing.EventingResultCode
 
destroy() - Method in interface com.avaya.collaboration.service.ServiceLifeCycle
Invoked by the Avaya Aura® Collaboration Environment to indicate that the service is being taken out of service.
dialogEvent(UUID, Map, VoiceXMLDialogCause) - Method in class com.avaya.collaboration.call.speech.search.sample.SampleUnifiedSpeechCall.MyMediaListener
 
dialogEvent(UUID, Map, VoiceXMLDialogCause) - Method in class com.avaya.collaboration.call.speech.voicexml.sample.SampleVoiceXMLDialog.MyVoiceXMLDialogListener
 
dialogEvent(UUID, Map, VoiceXMLDialogCause) - Method in interface com.avaya.collaboration.call.speech.voicexml.VoiceXMLDialogListener
This is invoked when an event is generated by a VoiceXMLDialog request.
dialogEvent(UUID, Map, VoiceXMLDialogCause) - Method in class com.avaya.collaboration.call.speech.voicexml.VoiceXMLDialogListenerAbstract
 
DigitCollectorOperationCause - Class in com.avaya.collaboration.call.media
Enumeration of reasons with which collect operation can get completed.
DigitOptions - Interface in com.avaya.collaboration.call.media
 
digitsCollected(UUID, String, DigitCollectorOperationCause) - Method in interface com.avaya.collaboration.call.media.MediaListener
This is invoked when a pattern of digits has been collected.
digitsCollected(UUID, String, DigitCollectorOperationCause) - Method in class com.avaya.collaboration.call.media.MediaListenerAbstract
 
divertTo(String) - Method in interface com.avaya.collaboration.call.Call
Divert the call to a target.
drop() - Method in interface com.avaya.collaboration.call.Call
Drop the call.
DUPLICATE_CONFERENCE - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode
 

E

EC500 - Static variable in class com.avaya.collaboration.data.api.MobileType
EC500 is an option that allows a user to place a call between his mobile phone and his office phone.
EMAIL_BAD_REQUEST - Static variable in interface com.avaya.collaboration.email.EmailResponse
Status Code 400 - The EmailRequest was poorly formed
EMAIL_CONNECTOR_ERROR - Static variable in interface com.avaya.collaboration.email.EmailResponse
Status Code 500 - The email connector experienced an internal error
EMAIL_EXPIRED - Static variable in interface com.avaya.collaboration.email.EmailResponse
Status Code 408 - The EmailRequest expired
EMAIL_OK - Static variable in interface com.avaya.collaboration.email.EmailResponse
Status Code 200 - The EmailRequest was successfully delivered to the email server
EMAIL_PARTIAL_SUCCESS - Static variable in interface com.avaya.collaboration.email.EmailResponse
Status Code 206 - The EmailRequest was partially successfully delivered by the email server
EMAIL_QUEUED - Static variable in interface com.avaya.collaboration.email.EmailResponse
Status Code 202 - The EmailRequest was successfully queued to the email connector
EMAIL_TEST - Static variable in interface com.avaya.collaboration.email.EmailResponse
Status Code 201 - The email connector received the EmailRequest, but the connector is in test mode
EmailFactory - Class in com.avaya.collaboration.email
Factory used to create an EmailRequest, which would then be used to send an email to one or more recipients.
EmailFactory() - Constructor for class com.avaya.collaboration.email.EmailFactory
 
EmailListener - Interface in com.avaya.collaboration.email
A service writer who wishes to receive responses to an EmailRequest#send() operation will need to implement this interface.
EmailRequest - Interface in com.avaya.collaboration.email
Represents an EmailRequest object which can be used to send an email to one or more destinations.
EmailResponse - Interface in com.avaya.collaboration.email
Represents an EmailResponse object which can be used to get information about a response to an EmailRequest#send() operation.
EmailType - Class in com.avaya.collaboration.data.api
An enumeration of the supported email types configured in System Manager.
enableMediaBeforeAnswer() - Method in interface com.avaya.collaboration.call.Call
Instruct Collaboration Environment to set up resources to allow media operations before a call is answered.
equals(Object) - Method in interface com.avaya.collaboration.call.media.PlayItem
 
error(Object) - Method in class com.avaya.collaboration.util.logger.Logger
This method logs a message at the ERROR level.
error(Object, Throwable) - Method in class com.avaya.collaboration.util.logger.Logger
This method logs a message at the ERROR level and adds the stack trace for the Throwable.
ERROR_EVENT - Static variable in class com.avaya.collaboration.call.speech.voicexml.VoiceXMLDialogCause
This event is thrown when a dialog request cannot be completed (wrong internal state,...)
Event - Interface in com.avaya.collaboration.eventing
Represents an event that is published by a producer and received by a consumer.
EVENT_BODY_LENGTH_TOO_LARGE - Static variable in class com.avaya.collaboration.eventing.EventingResultCode
 
EVENT_CALL_ALERTING - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCall
 
EVENT_CALL_ALERTING_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCall
 
EVENT_CALL_ANSWERED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCall
 
EVENT_CALL_ANSWERED_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCall
 
EVENT_CALL_ENDED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCall
 
EVENT_CALL_ENDED_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCall
 
EVENT_CALL_OFFERED_FROM_CALLING_PARTY - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCall
 
EVENT_CALL_OFFERED_FROM_CALLING_PARTY_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCall
 
EVENT_OFFERING_CALL_TO_CALLED_PARTY - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCall
 
EVENT_OFFERING_CALL_TO_CALLED_PARTY_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCall
 
EVENT_SNAP_IN_INSTALLED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilySystem
 
EVENT_SNAP_IN_INSTALLED_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilySystem
 
EVENT_SNAP_IN_UNINSTALLED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilySystem
 
EVENT_SNAP_IN_UNINSTALLED_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilySystem
 
EVENT_SPEECH_SEARCH_ERROR - Static variable in class com.avaya.collaboration.eventing.families.EventFamilySpeechSearch
 
EVENT_SPEECH_SEARCH_ERROR_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilySpeechSearch
 
EVENT_SPEECH_SEARCH_MATCH - Static variable in class com.avaya.collaboration.eventing.families.EventFamilySpeechSearch
 
EVENT_SPEECH_SEARCH_MATCH_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilySpeechSearch
 
EVENT_SPEECH_SEARCH_STARTED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilySpeechSearch
 
EVENT_SPEECH_SEARCH_STARTED_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilySpeechSearch
 
EVENT_SPEECH_SEARCH_STOPPED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilySpeechSearch
 
EVENT_SPEECH_SEARCH_STOPPED_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilySpeechSearch
 
EVENT_SUBSCRIPTION_EXPIRING - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyEventing
 
EVENT_SUBSCRIPTION_EXPIRING_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyEventing
 
EVENT_WORK_ERROR - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyWorkAssignment
 
EVENT_WORK_ERROR_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyWorkAssignment
 
EVENT_WORK_OFFER - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyWorkAssignment
 
EVENT_WORK_OFFER_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyWorkAssignment
 
EVENT_WORK_QUEUED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyWorkAssignment
 
EVENT_WORK_QUEUED_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyWorkAssignment
 
EventFamilyCall - Class in com.avaya.collaboration.eventing.families
Various constants that define useful values related to the Call event family.
EventFamilyEventing - Class in com.avaya.collaboration.eventing.families
Various constants that define useful values related to the Eventing event family.
EventFamilySpeechSearch - Class in com.avaya.collaboration.eventing.families
Various constants that define useful values related to the SpeechSearch event family.
EventFamilySystem - Class in com.avaya.collaboration.eventing.families
Various constants that define useful values related to the System event family.
EventFamilyWorkAssignment - Class in com.avaya.collaboration.eventing.families
Various constants that define useful values related to the WorkAssignment event family.
EventFilter - Interface in com.avaya.collaboration.eventing
The event filter criteria is applied against EventMetaData to determine if a subscription matches a published event.
EVENTING_SYSTEM_NOT_READY - Static variable in class com.avaya.collaboration.eventing.EventingResultCode
 
EventingException - Exception in com.avaya.collaboration.eventing
A runtime exception used to indicate error conditions in the Avaya Aura® Collaboration Environment Eventing API.
EventingException(EventingResultCode, String) - Constructor for exception com.avaya.collaboration.eventing.EventingException
 
EventingException(EventingResultCode) - Constructor for exception com.avaya.collaboration.eventing.EventingException
 
EventingException(EventingResultCode, String, Throwable) - Constructor for exception com.avaya.collaboration.eventing.EventingException
 
EventingException(EventingResultCode, Throwable) - Constructor for exception com.avaya.collaboration.eventing.EventingException
 
EventingFactory - Class in com.avaya.collaboration.eventing
Factory used to create Eventing Framework objects like EventSubscriptionAttrs and EventProducer.
EventingResultCode - Class in com.avaya.collaboration.eventing
Values used to indicate the result of various operations available in the Avaya Aura® Collaboration Environment Eventing API.
EventingService - Interface in com.avaya.collaboration.eventing
Object used to perform various Eventing Framework operations, such as subscribing for events.
EventListener - Interface in com.avaya.collaboration.eventing
The EventListener allows a snap-in to be informed of events.
EventMetaData - Interface in com.avaya.collaboration.eventing
The data against which subscription filter criteria are applied.
EventProducer - Interface in com.avaya.collaboration.eventing
The object used by a producer to publish an event.
eventReceived(Event) - Method in interface com.avaya.collaboration.eventing.EventListener
The method that is invoked to receive event notifications.
EventSubscriptionAttributes - Interface in com.avaya.collaboration.eventing
Specifies the various attributes of a subscription.
EXITED - Static variable in class com.avaya.collaboration.call.speech.voicexml.VoiceXMLDialogCause
Event sent by the VoiceXML interpreter, as a result of executing the element

F

FAILED - Static variable in class com.avaya.collaboration.call.media.DigitCollectorOperationCause
If the digit collection failed before any completion criteria was met.
FAILED - Static variable in class com.avaya.collaboration.call.media.PlayOperationCause
Play operation failed before it could complete.
FAMILY_NAME - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCall
 
FAMILY_NAME - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyEventing
 
FAMILY_NAME - Static variable in class com.avaya.collaboration.eventing.families.EventFamilySpeechSearch
 
FAMILY_NAME - Static variable in class com.avaya.collaboration.eventing.families.EventFamilySystem
 
FAMILY_NAME - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyWorkAssignment
 
fatal(Object) - Method in class com.avaya.collaboration.util.logger.Logger
This method logs a message at the FATAL level.
fatal(Object, Throwable) - Method in class com.avaya.collaboration.util.logger.Logger
This method logs a message at the FATAL level and adds the stack trace for the Throwable.
FILTER_LOCAL_CID - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCall
Reserved for possible future use.
FILTER_SNAP_IN_TYPE - Static variable in class com.avaya.collaboration.eventing.families.EventFamilySystem
 
FILTER_UCID - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCall
 
fine(Object) - Method in class com.avaya.collaboration.util.logger.Logger
This method logs a message at the FINE level.
fine(Object, Throwable) - Method in class com.avaya.collaboration.util.logger.Logger
This method logs a message at the FINE level and adds the stack trace for the Throwable.
finer(Object) - Method in class com.avaya.collaboration.util.logger.Logger
This method logs a message at the FINER level.
finer(Object, Throwable) - Method in class com.avaya.collaboration.util.logger.Logger
This method logs a message at the FINER level and adds the stack trace for the Throwable.
finest(Object) - Method in class com.avaya.collaboration.util.logger.Logger
This method logs a message at the FINEST level.
finest(Object, Throwable) - Method in class com.avaya.collaboration.util.logger.Logger
This method logs a message at the FINEST level and adds the stack trace for the Throwable.
FIRST - Static variable in class com.avaya.collaboration.call.speech.search.query.OperatorType
The FIRST operator generates a match whenever any of its constituent search terms are found to match within a specified time period that begins at the start of the search.
FirstOperator - Interface in com.avaya.collaboration.call.speech.search.query.operators
The FIRST operator generates a match whenever any of its constituent search terms are found to match within a specified time period that begins at the start of the search.
FORWARDING_ERROR - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode
 

G

GENERIC_SERVER_ERROR - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode
 
get() - Method in interface com.avaya.collaboration.service.activity.ServiceActivityData
Returns the current activity count.
getAccountId() - Method in interface com.avaya.collaboration.sms.SmsRequest
Get the account ID.
getAddress() - Method in interface com.avaya.collaboration.call.Identity
Convenience method that returns an address string of the form handle@domain, where handle is the same as would be provided with getHandle, and domain is the same as would be provide with getDomain.
getAddress() - Method in interface com.avaya.collaboration.call.Participant
Convenience method that returns an address string of the form handle@domain, where handle is the same as would be provided with getHandle, and domain is the same as would be provide with getDomain.
getAddressHeader(String) - Method in interface com.avaya.collaboration.call.sip.SipRequest
Returns the value of the specified header as a Address object.
getAddressHeader(String) - Method in interface com.avaya.collaboration.call.sip.SipResponse
Returns the value of the specified header as a Address object.
getAddressHeaders(String) - Method in interface com.avaya.collaboration.call.sip.SipRequest
Returns a ListIterator over all Address header field values for the specified header.
getAddressHeaders(String) - Method in interface com.avaya.collaboration.call.sip.SipResponse
Returns a ListIterator over all Address header field values for the specified header.
getAddressNameByValue(int) - Static method in class com.avaya.collaboration.data.api.AddressType
 
getAlertingParties() - Method in interface com.avaya.collaboration.call.Call
Get a list of the parties that are alerting on this call.
getAllCommunicationAddresses(String) - Method in interface com.avaya.collaboration.data.api.UserData
Returns an immutable map with 'name of communication profile' as a key and a map of all types of communication addresses as value configured in SMGR for a given enterprise ID.
getAnsweringParty() - Method in interface com.avaya.collaboration.call.Call
Get details about the party that answered the call.
getAttribute(String) - Method in interface com.avaya.collaboration.call.Call
Retrieve an attribute that was previously stored with the setAttribute method.
getAttributeList() - Method in interface com.avaya.collaboration.businessdata.api.SystemGlobalData
Returns a list of available Global Attributes.
getAttributeValue(String) - Method in interface com.avaya.collaboration.businessdata.api.SystemGlobalData
Returns the value for a enterprise-wide configuration data.
getBcc() - Method in interface com.avaya.collaboration.email.EmailRequest
Get the list of bcc email address for this request
getBody() - Method in interface com.avaya.collaboration.bus.CollaborationBusMessage
Get the body of the message.
getCall(String) - Static method in class com.avaya.collaboration.call.CallFactory
Returns instance of Call associated with given ID string.
getCall() - Method in interface com.avaya.collaboration.call.Participant
Get the Call instance associated with the Participant, null if not associated.
getCalledParty() - Method in interface com.avaya.collaboration.call.Call
Get a reference to the called party.
getCallingParty() - Method in interface com.avaya.collaboration.call.Call
Get a reference to the calling party.
getCallListenerClass() - Method in class com.avaya.zephyr.platform.dal.api.ServiceDescriptor
 
getCc() - Method in interface com.avaya.collaboration.email.EmailRequest
Get the list of cc email address for this request
getCharsAllowedInDescription() - Static method in class com.avaya.collaboration.conference.scheduled.SchedConfOperations
Returns the list of characters allowed in a conference subject and description.
getClusterAttribute(String) - Method in interface com.avaya.collaboration.businessdata.api.ClusterData
Returns the value for a cluster attribute.
getClusterAttributeList() - Method in interface com.avaya.collaboration.businessdata.api.ClusterData
Returns the list of Cluster Attributes defined for the cluster.
getClusterData() - Static method in class com.avaya.collaboration.dal.factory.CollaborationDataFactory
Returns a ClusterData object that can be used to retrieve cluster related data.
getClusterDescription() - Method in interface com.avaya.collaboration.businessdata.api.ClusterData
Returns the description of the cluster that includes the Collaboration Environment instance on which the service is running.
getClusterDomainName() - Method in interface com.avaya.collaboration.businessdata.api.ClusterData
Returns the domain name of the cluster that includes the Collaboration Environment instance on which the service is running.
getClusterEncryptedAttribute(String) - Method in interface com.avaya.collaboration.businessdata.api.ClusterData
Returns the value for an encrypted cluster attribute.
getClusterHost() - Method in interface com.avaya.collaboration.businessdata.api.ClusterData
Returns the IP address of the cluster that includes the Collaboration Environment instance on which the service is running.
getClusterName() - Method in interface com.avaya.collaboration.businessdata.api.ClusterData
Returns the name of the cluster that includes the Collaboration Environment instance on which the service is running.
getClusterProfileID() - Method in interface com.avaya.collaboration.businessdata.api.ClusterData
Returns the profile ID of the cluster that includes the Collaboration Environment instance on which the service is running.
getClusterProfileName() - Method in interface com.avaya.collaboration.businessdata.api.ClusterData
Returns the cluster profile name of the cluster that includes the Collaboration Environment instance on which the service is running.
getCollaborationBusMessageHandlerInstance(String, String) - Static method in class com.avaya.collaboration.bus.factory.CollaborationBusFactory
Returns an instance of the CollaborationBusMessageHandler.
getCollectedDigits() - Method in interface com.avaya.collaboration.call.Call
Returns digits collected during the call setup
getConcepts() - Method in interface com.avaya.collaboration.call.speech.search.query.SearchQuery
The search concepts of the search query.
getConfId() - Method in interface com.avaya.collaboration.conference.scheduled.SchedConf
Returns the conference ID of the conference.
getConfidence() - Method in interface com.avaya.collaboration.call.speech.search.match.SpeechSearchMatch
The confidence of the concept matched.
getConsumerName() - Method in interface com.avaya.collaboration.eventing.Event
The service name of the consumer.
getConsumerName() - Method in interface com.avaya.collaboration.eventing.EventSubscriptionAttributes
Get the consumer name associated with the subscription.
getConsumerPrivateData() - Method in interface com.avaya.collaboration.eventing.Event
This is an arbitrary, opaque object that a consumer can include as part of its subscription.
getConsumerPrivateData() - Method in interface com.avaya.collaboration.eventing.EventSubscriptionAttributes
Get the consumer private data associated with the subscription.
getConsumerVersion() - Method in interface com.avaya.collaboration.eventing.Event
The version of the consumer.
getConsumerVersion() - Method in interface com.avaya.collaboration.eventing.EventSubscriptionAttributes
Get the consumer version associated with the subscription.
getContentType() - Method in interface com.avaya.collaboration.call.sip.SipRequest
Returns the value of the Content-Type header field.
getContentType() - Method in interface com.avaya.collaboration.call.sip.SipResponse
Returns the value of the Content-Type header field.
getContextId() - Method in interface com.avaya.collaboration.call.Call
Get the context ID associated with this call.
getCorrelationId() - Method in interface com.avaya.collaboration.eventing.EventFilter
Get the correlation ID.
getCorrelationId() - Method in interface com.avaya.collaboration.eventing.EventMetaData
Get the correlation ID associated with an event.
getCpuOccupancy() - Static method in class com.avaya.collaboration.util.SystemStatus
Get CPU occupancy.
getCriterionIgnoreCaseMap() - Method in interface com.avaya.collaboration.eventing.EventFilter
Get a reference to the internal map that holds the key/value pairs of the filter criterion.
getCriterionMap() - Method in interface com.avaya.collaboration.eventing.EventFilter
Get a reference to the internal map that holds the key/value pairs of the filter criterion.
getDEFAULTPLATFORMVERSION() - Static method in class com.avaya.collaboration.util.SystemStatus
 
getDEFAULTSDKAPIVERSION() - Static method in class com.avaya.collaboration.util.SystemStatus
 
getDeliveredRecipients() - Method in interface com.avaya.collaboration.sms.SmsResponse
Get the list of recipients for which this request was successfully delivered.
getDescription() - Method in interface com.avaya.collaboration.conference.scheduled.SchedConf
Returns the description of the conference.
getDescription() - Method in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode
 
getDescription() - Method in class com.avaya.collaboration.eventing.EventingResultCode
 
getDestinationChannel() - Method in interface com.avaya.collaboration.bus.CollaborationBusMessageHeader
Get the channel the message was sent to.
getDestinationServiceName() - Method in interface com.avaya.collaboration.bus.CollaborationBusMessageHeader
Get the name of the service the message was routed to.
getDestinationServiceVersion() - Method in interface com.avaya.collaboration.bus.CollaborationBusMessageHeader
Get the version of the service the message was routed to.
getDetail() - Method in interface com.avaya.collaboration.email.EmailResponse
Return the detailed information about the response.
getDetail() - Method in interface com.avaya.collaboration.sms.SmsResponse
Get detailed information about the response.
getDialIn() - Method in interface com.avaya.collaboration.conference.scheduled.SchedConf
Returns the dial-in number for the conference.
getDisplayName() - Method in interface com.avaya.collaboration.call.Identity
Get the display name of the Identify as provided by the network or endpoint.
getDisplayName() - Method in interface com.avaya.collaboration.call.Participant
Get the display name of the participant as provided by the network or endpoint.
getDisplayName() - Method in interface com.avaya.collaboration.call.sip.SipAddress
Returns the display name of this Address.
getDomain() - Method in interface com.avaya.collaboration.call.Participant
Get the domain part of the party's address as provided by the network or endpoint.
getDuration() - Method in interface com.avaya.collaboration.call.media.PlayItem
Returns the duration of a play request in milliseconds.
getDuration() - Method in interface com.avaya.collaboration.call.speech.search.query.operators.AllOperator
Get the duration time constraint.
getDuration() - Method in interface com.avaya.collaboration.call.speech.search.query.operators.AtLeastOperator
Get the duration time constraint.
getDuration() - Method in interface com.avaya.collaboration.call.speech.search.query.operators.FirstOperator
Get the duration time constraint.
getDuration() - Method in interface com.avaya.collaboration.call.speech.search.query.operators.LastOperator
Get the duration time constraint.
getDuration() - Method in interface com.avaya.collaboration.conference.scheduled.SchedConf
Returns the duration of the conference.
getEmails(String) - Method in interface com.avaya.collaboration.data.api.UserData
Returns an immutable map with 'name of communication profile' as a key and a map of email addresses as value for a given enterprise ID.
getEndTime() - Method in interface com.avaya.collaboration.call.speech.search.match.SpeechSearchMatch
End time in seconds from beginning of speech search of the match.
getEventId() - Method in interface com.avaya.collaboration.eventing.Event
Get the event ID of the event, which is an arbitrary, unique identifier of an event.
getEventListenerClass() - Method in class com.avaya.zephyr.platform.dal.api.ServiceDescriptor
Get the version of the service.
getEventMetaData() - Method in interface com.avaya.collaboration.eventing.Event
Get the event meta data provided by the event producer.
getEventTypeList() - Method in interface com.avaya.collaboration.eventing.EventSubscriptionAttributes
Get A reference to the internal list that holds events types.
getExpires() - Method in interface com.avaya.collaboration.call.sip.SipAddress
Returns the value of the "expires" parameter as delta-seconds.
getFailedRecipients() - Method in interface com.avaya.collaboration.sms.SmsResponse
Get the list of recipients for which this request failed.
getFamily() - Method in interface com.avaya.collaboration.eventing.Event
Get the family of the event.
getFamily() - Method in interface com.avaya.collaboration.eventing.EventSubscriptionAttributes
Get the event family associated with the subscription.
getFilter() - Method in interface com.avaya.collaboration.eventing.EventSubscriptionAttributes
Get the event filter associated with the subscription.
getFrom() - Method in interface com.avaya.collaboration.call.sip.SipRequest
Returns the value of the From header.
getFrom() - Method in interface com.avaya.collaboration.call.sip.SipResponse
Returns the value of the From header.
getFrom() - Method in interface com.avaya.collaboration.email.EmailRequest
Get the from email address(e.g., "fromMe@domain.com")
getGlobalServiceAttribute(String) - Method in interface com.avaya.collaboration.businessdata.api.ServiceData
Deprecated.
getGlobalServiceAttributeList() - Method in interface com.avaya.collaboration.businessdata.api.ServiceData
Deprecated.
getGlobalServiceEncryptedAttribute(String) - Method in interface com.avaya.collaboration.businessdata.api.ServiceData
Deprecated.
getHandle() - Method in interface com.avaya.collaboration.call.Participant
Get the handle part of the party's address as provided by the network or endpoint.
getHeader() - Method in interface com.avaya.collaboration.bus.CollaborationBusMessage
Get the header of a message.
getHeader(String) - Method in interface com.avaya.collaboration.call.sip.SipRequest
Returns the value of the specified header as a String.
getHeader(String) - Method in interface com.avaya.collaboration.call.sip.SipResponse
Returns the value of the specified header as a String.
getHeader(String) - Method in interface com.avaya.collaboration.call.sip.SipURI
Returns the value of the specified header.
getHeaderNames() - Method in interface com.avaya.collaboration.call.sip.SipRequest
Returns an Iterator over all the header names this message contains.
getHeaderNames() - Method in interface com.avaya.collaboration.call.sip.SipResponse
Returns an Iterator over all the header names this message contains.
getHeaderNames() - Method in interface com.avaya.collaboration.call.sip.SipURI
Returns an Iterator over the names of all headers present in this SipURI.
getHeaders(String) - Method in interface com.avaya.collaboration.call.sip.SipRequest
Returns all the values of the specified header as a ListIterator over a number of String objects.
getHeaders(String) - Method in interface com.avaya.collaboration.call.sip.SipResponse
Returns all the values of the specified header as a ListIterator over a number of String objects.
getHost() - Method in interface com.avaya.collaboration.call.sip.SipURI
Returns the host part of this SipURI.
getId() - Method in interface com.avaya.collaboration.call.Call
Every call, or session, has a unique identifier.
getId() - Method in interface com.avaya.collaboration.call.speech.search.query.SearchQuery
The identification of the search query.
getInResponseToChannel() - Method in interface com.avaya.collaboration.bus.CollaborationBusMessageHeader
Get the channel the message is in response to.
getInvalidAddresses() - Method in interface com.avaya.collaboration.email.EmailResponse
Return the addresses to which this message could not be sent.
getIterateCount() - Method in interface com.avaya.collaboration.call.media.PlayItem
The number of times to repeatedly play this item.
getLanguage() - Method in interface com.avaya.collaboration.call.speech.search.query.SearchQuery
The language of the search query.
getLanguage() - Method in interface com.avaya.collaboration.call.speech.search.SearchOptions
The language used in the speech search.
getListener() - Method in interface com.avaya.collaboration.email.EmailRequest
Get the listener that was previously assigned using EmailRequest.setListener(EmailListener).
getListener() - Method in interface com.avaya.collaboration.sms.SmsRequest
Get the listener that was previously assigned using SmsRequest.setListener(SmsListener).
getLogger(Class) - Static method in class com.avaya.collaboration.util.logger.Logger
This methods returns a service-specific Logger for the calling service.
getLogger(String) - Static method in class com.avaya.collaboration.util.logger.Logger
This methods returns a Logger for the requested service.
getLoginNameByParticipant(String, String) - Method in interface com.avaya.collaboration.data.api.UserData
Returns user's login name for a given participant.
getLoginNameByPhoneNumber(String) - Method in interface com.avaya.collaboration.data.api.UserData
Returns user's login name (enterprise ID) for a given phone number.
getLrParam() - Method in interface com.avaya.collaboration.call.sip.SipURI
Returns true if the "lr" flag parameter is set, and false otherwise.
getMAddrParam() - Method in interface com.avaya.collaboration.call.sip.SipURI
Returns the value of the "maddr" parameter, or null if this is not set.
getMatchReportingStrategy() - Method in interface com.avaya.collaboration.call.speech.search.SearchOptions
The match reporting strategy which can be either a summary or detailed.
getMaxDuration() - Static method in class com.avaya.collaboration.conference.scheduled.SchedConfOperations
Returns a Duration instance that is the maximum allowed duration of 30 days, 0 hours, 0 minutes.
getMaxParticipants() - Method in interface com.avaya.collaboration.conference.scheduled.SchedConf
Returns the number of reserved participant ports.
getMemoryUtilization() - Static method in class com.avaya.collaboration.util.SystemStatus
Get Memory Utilization.
getMessageSequenceId() - Method in interface com.avaya.collaboration.bus.CollaborationBusMessageHeader
Get the message sequence id.
getMessageType() - Method in interface com.avaya.collaboration.bus.CollaborationBusMessageHeader
Get the message type.
getMethod() - Method in interface com.avaya.collaboration.call.sip.SipRequest
Returns the SIP method of this message.
getMethod() - Method in interface com.avaya.collaboration.call.sip.SipResponse
Returns the SIP method of this message.
getMinDuration() - Static method in class com.avaya.collaboration.conference.scheduled.SchedConfOperations
Returns a Duration instance that is the minimum allowed duration of 1 minute.
getMobileNumbers(String) - Method in interface com.avaya.collaboration.data.api.UserData
Returns a map of mobile numbers for a given enterprise ID.
getModeratorPin() - Method in interface com.avaya.collaboration.conference.scheduled.SchedConf
Returns the moderator PIN for the conference.
getName() - Method in interface com.avaya.collaboration.call.speech.search.match.SpeechSearchMatch
The name of the concept.
getName() - Method in interface com.avaya.collaboration.call.speech.search.query.Concept
The name of the concept.
getName() - Method in interface com.avaya.collaboration.call.speech.search.query.SearchQuery
The name of the search query.
getName() - Method in class com.avaya.zephyr.platform.dal.api.ServiceDescriptor
Get the name of the service.
getNodeThatHostsCall(Call) - Static method in class com.avaya.collaboration.call.CallProperties
Get the address of the node where your service hosts the provided call
getNumber() - Method in interface com.avaya.collaboration.call.speech.search.query.operators.AtLeastOperator
Get the number of concepts required for a match.
getNumber() - Method in interface com.avaya.collaboration.conference.scheduled.SchedConf
Deprecated. 
getNumberAsString() - Method in interface com.avaya.collaboration.conference.scheduled.SchedConf
Returns the conference Number of the conference.
getNumberOfDigits() - Method in interface com.avaya.collaboration.call.media.DigitOptions
Returns the number of digits to be collected.
getOperator() - Method in interface com.avaya.collaboration.call.speech.search.match.SpeechSearchMatch
Get the operator for the concept.
getOperator() - Method in interface com.avaya.collaboration.call.speech.search.query.Concept
Get the operator for the concept.
getParameter(String) - Method in interface com.avaya.collaboration.call.sip.SipAddress
Returns the value of the named parameter, or null if it is not set.
getParameter(String) - Method in interface com.avaya.collaboration.call.sip.SipURI
Returns the value of the named parameter, or null if it is not set.
getParameterNames() - Method in interface com.avaya.collaboration.call.sip.SipAddress
Returns an Iterator of the names of all parameters contained in this object.
getParameterNames() - Method in interface com.avaya.collaboration.call.sip.SipURI
Returns an Iterator over the names of all parameters present in this SipURI.
getParameters() - Method in interface com.avaya.collaboration.call.sip.SipAddress
Returns a Collection view of the parameter name-value mappings contained in this Parameterable.
getParticipantPin() - Method in interface com.avaya.collaboration.conference.scheduled.SchedConf
Returns the participant PIN for the conference.
getPassword() - Method in interface com.avaya.collaboration.sms.SmsRequest
Get the password
getPayload() - Method in interface com.avaya.collaboration.eventing.Event
Get the event payload, which is an arbitrary set of data provided by a producer as part of an event publication.
getPendingRecipients() - Method in interface com.avaya.collaboration.sms.SmsResponse
Get the list of recipients for which this request was delivered to the SMS provider, but the provider has indicated that the request is queued for subsequent delivery.
getPhoneNumbers(String) - Method in interface com.avaya.collaboration.data.api.UserData
Returns an immutable map with 'name of communication profile' as a key and a list of associated phone numbers as value for a given enterprise ID.
getPhrase() - Method in interface com.avaya.collaboration.call.speech.search.query.Phrase
The phrase.
getPhrases() - Method in interface com.avaya.collaboration.call.speech.search.query.Concept
The collection of phrases belonging to the concept.
getPhrases() - Method in interface com.avaya.collaboration.call.speech.search.query.SearchQuery
The search phrases of the search query.
getPlatformVersion() - Static method in class com.avaya.collaboration.util.SystemStatus
Get Collaboration Environment platform version.
getPort() - Method in interface com.avaya.collaboration.call.sip.SipURI
Returns the port number of this SipURI, or -1 if this is not set.
getPresentedDisplayName() - Method in interface com.avaya.collaboration.call.Participant
Get the display name to be presented to other parties in the call, as previously set by the client service.
getPresentedDomain() - Method in interface com.avaya.collaboration.call.Participant
Get the domain part of this party's address to be presented to other parties in the call, as previously set by the client service.
getPresentedHandle() - Method in interface com.avaya.collaboration.call.Participant
Get the handle part of this party's address to be presented to other parties in the call, as previously set by the client service.
getProducerName() - Method in interface com.avaya.collaboration.eventing.Event
The name of the producer that published the event.
getProducerName() - Method in interface com.avaya.collaboration.eventing.EventMetaData
Get the producer name.
getProducerVersion() - Method in interface com.avaya.collaboration.eventing.Event
The version number of the producer that published the event.
getProducerVersion() - Method in interface com.avaya.collaboration.eventing.EventMetaData
Get the producer version.
getPropertiesXmlFileRead() - Static method in class com.avaya.zephyr.platform.dal.api.ServiceUtil
 
getProtocolString() - Method in class com.avaya.collaboration.ssl.util.SSLProtocolType
 
getRawContent() - Method in interface com.avaya.collaboration.call.sip.SipRequest
Returns message content as a byte array.
getRawContent() - Method in interface com.avaya.collaboration.call.sip.SipResponse
Returns message content as a byte array.
getReason() - Method in exception com.avaya.collaboration.conference.scheduled.SchedConfException
Returns a reason for the exception.
getReason() - Method in exception com.avaya.collaboration.eventing.EventingException
Returns a reason for the exception.
getReasonDescription() - Method in exception com.avaya.collaboration.conference.scheduled.SchedConfException
Returns a verbose reason for the exception.
getReasonDescription() - Method in exception com.avaya.collaboration.eventing.EventingException
Returns a verbose reason for the exception.
getReasonPhrase() - Method in interface com.avaya.collaboration.call.sip.SipResponse
Returns the reason phrase for this response object.
getRecipients() - Method in interface com.avaya.collaboration.sms.SmsRequest
Get the list of recipients for this request.
getReplyTo() - Method in interface com.avaya.collaboration.email.EmailRequest
Get the replyTo email address(e.g., "fromMe@domain.com")
getRequestURI() - Method in interface com.avaya.collaboration.call.sip.SipRequest
Returns the request URI of this request.
getRespondToChannel() - Method in interface com.avaya.collaboration.bus.CollaborationBusMessageHeader
Get the channel the sender specified to respond to.
getResponseToSequenceId() - Method in interface com.avaya.collaboration.bus.CollaborationBusMessageHeader
Get the sequence id of the message this was a response to.
getSdkVersionBuiltWith() - Method in class com.avaya.zephyr.platform.dal.api.ServiceDescriptor
Get the version of the SDK the service was built with.
getSdkVersionOnPlatform() - Static method in class com.avaya.collaboration.util.SystemStatus
Get system SDK API version deployed on platform.
getSearchQueries() - Method in interface com.avaya.collaboration.call.speech.search.SearchOptions
The collection of search queries used in the speech search.
getSender() - Method in interface com.avaya.collaboration.sms.SmsRequest
Get the sender (e.g., "13035551234")
getSenderService() - Method in interface com.avaya.collaboration.bus.CollaborationBusMessageHeader
Get the sender service.
getSenderServiceVersion() - Method in interface com.avaya.collaboration.bus.CollaborationBusMessageHeader
Get the version of the sender service.
getServicActivityData() - Method in interface com.avaya.collaboration.service.activity.ServiceActivityDataFactoryDelegate
 
getServiceAttribute(String, String) - Method in interface com.avaya.collaboration.businessdata.api.ServiceData
Returns the value for a service attribute, the serviceName is not required.
getServiceAttribute(String) - Method in interface com.avaya.collaboration.businessdata.api.ServiceData
Returns the value for a service attribute that's not uniquely administered for a particular user, but global to the service.
getServiceAttributeList() - Method in interface com.avaya.collaboration.businessdata.api.ServiceData
Returns a list of available Service Attributes for a given service.
getServiceData(String, String) - Static method in class com.avaya.collaboration.dal.factory.CollaborationDataFactory
Returns a ServiceData object that can be used to retrieve service related data.
getServiceDescriptor() - Static method in class com.avaya.zephyr.platform.dal.api.ServiceUtil
 
getServiceEncryptedAttribute(String) - Method in interface com.avaya.collaboration.businessdata.api.ServiceData
Returns the value for a service encrypted attribute that's not uniquely administered for a particular user, but global to the service.
getServiceLicenseData(String) - Static method in class com.avaya.collaboration.dal.factory.CollaborationDataFactory
Returns a ServiceLicenseData object that can be used to retrieve the token status for the service or the service license mode
getServiceLicenseData(String, String) - Static method in class com.avaya.collaboration.dal.factory.CollaborationDataFactory
Returns a ServiceLicenseData object that can be used to retrieve the token status for the service or the service license mode
getServiceProfile() - Method in interface com.avaya.collaboration.eventing.EventFilter
Get the service profile.
getSource() - Method in interface com.avaya.collaboration.call.media.PlayItem
Returns the list of the audio resources and TTS text strings to be played.
getStartTime() - Method in interface com.avaya.collaboration.call.speech.search.match.SpeechSearchMatch
Start time in seconds from beginning of speech search of the match.
getStartTime() - Method in interface com.avaya.collaboration.conference.scheduled.SchedConf
Returns the start time of the conference.
getStatus() - Method in interface com.avaya.collaboration.call.sip.SipResponse
Returns the status code of this response object.
getStatus() - Method in interface com.avaya.collaboration.conference.scheduled.SchedConf
Returns the status of the conference.
getStatus() - Method in interface com.avaya.collaboration.email.EmailResponse
Return the response's status code.
getStatus() - Method in interface com.avaya.collaboration.sms.SmsResponse
Get the response's status code.
getStatusMessage() - Static method in class com.avaya.collaboration.util.SystemStatus
Get StatusMessage.
getSubConcepts() - Method in interface com.avaya.collaboration.call.speech.search.query.Concept
The collection of sub concepts belonging to the concept.
getSubject() - Method in interface com.avaya.collaboration.conference.scheduled.SchedConf
Returns the subject of the conference.
getSubject() - Method in interface com.avaya.collaboration.email.EmailRequest
Get the subject (e.g., "This is the subject of the email")
getSubscriptionId() - Method in interface com.avaya.collaboration.eventing.Event
The subscription ID of the subscription that resulted in this event being delivered.
getTenantID(String) - Method in interface com.avaya.collaboration.data.api.UserData
Returns tenant ID for a given enterprise ID.
getTerminationKey() - Method in interface com.avaya.collaboration.call.media.DigitOptions
Returns the termination key that stops a digit collection operation.
getText() - Method in interface com.avaya.collaboration.sms.SmsRequest
Get the text body
getTextBody() - Method in interface com.avaya.collaboration.email.EmailRequest
Get the email message text body as a String.
getThreshold() - Method in interface com.avaya.collaboration.call.speech.search.query.Concept
Get the threshold for the concept.
getThreshold() - Method in interface com.avaya.collaboration.call.speech.search.query.Phrase
Get the threshold for the concept.
getTimeout() - Method in interface com.avaya.collaboration.call.media.DigitOptions
Returns the number of milliseconds to wait to receive the first digit.
getTo() - Method in interface com.avaya.collaboration.call.sip.SipRequest
Returns the value of the To header.
getTo() - Method in interface com.avaya.collaboration.call.sip.SipResponse
Returns the value of the To header.
getTo() - Method in interface com.avaya.collaboration.email.EmailRequest
Get the list of to email address for this request
getTransactionID() - Method in interface com.avaya.collaboration.bus.CollaborationBusMessageHeader
Get the transaction id.
getType() - Method in interface com.avaya.collaboration.call.Participant
Get the protocol type used by the participant.
getType() - Method in interface com.avaya.collaboration.call.speech.search.query.Operator
The type of the Operator.
getType() - Method in interface com.avaya.collaboration.eventing.Event
Get the event type of the event.
getTypeQualified() - Method in interface com.avaya.collaboration.eventing.Event
Get fully qualified type formatted as "family:type".
getUCID() - Method in interface com.avaya.collaboration.call.Call
Get the Universal Call ID associated with this call.
getURI() - Method in interface com.avaya.collaboration.call.sip.SipAddress
Returns the URI component of this Address.
getUrl() - Method in interface com.avaya.collaboration.conference.scheduled.SchedConf
Returns the URL for the conference.
getUser() - Method in interface com.avaya.collaboration.bus.CollaborationBusMessageHeader
Get the user that pertains to this message.
getUser() - Method in interface com.avaya.collaboration.call.sip.SipURI
Returns the user part of this SipURI.
getUser() - Method in interface com.avaya.collaboration.eventing.EventFilter
Get the user
getUser() - Method in interface com.avaya.collaboration.eventing.EventMetaData
Get the user associated with an event.
getUserName() - Method in interface com.avaya.collaboration.sms.SmsRequest
Get the user name.
getValidSentAddresses() - Method in interface com.avaya.collaboration.email.EmailResponse
Return the addresses to which this message was sent successfully.
getValidUnsentAddresses() - Method in interface com.avaya.collaboration.email.EmailResponse
Return the addresses that are valid but to which this message was not sent.
getValue() - Method in class com.avaya.collaboration.call.CallTerminationCause
 
getValue() - Method in class com.avaya.collaboration.call.ProtocolType
 
getValue() - Method in interface com.avaya.collaboration.call.sip.SipAddress
Returns the field value as a string.
getValue() - Method in class com.avaya.collaboration.data.api.AddressType
 
getValueMap() - Method in interface com.avaya.collaboration.eventing.EventMetaData
Returns a reference to the internal map holding meta data key, value pairs.
getVersion() - Method in interface com.avaya.collaboration.eventing.Event
Get the version of the event.
getVersion() - Method in class com.avaya.zephyr.platform.dal.api.ServiceDescriptor
Get the version of the service.
getVoiceXMLScript() - Method in interface com.avaya.collaboration.call.speech.voicexml.VoiceXMLDialogItem
Returns the URI of the source of the VoiceXML document.
GOOGLE_TALK - Static variable in class com.avaya.collaboration.data.api.AddressType
Google Talk ID configured in System Manager
GS_SUBSCRIPTION_HASH_ERROR - Static variable in class com.avaya.collaboration.eventing.EventingResultCode
 

H

handle(CollaborationBusMessageHeader) - Method in interface com.avaya.collaboration.bus.PreSendMessageHandler
 
hashCode() - Method in interface com.avaya.collaboration.call.media.PlayItem
 

I

IBM_SAMETIME - Static variable in class com.avaya.collaboration.data.api.AddressType
IBM Same time ID configured in System Manager
Identity - Interface in com.avaya.collaboration.call
 
IdentityFactory - Class in com.avaya.collaboration.call
Factory used to create an Identity which would then be used to create a call.
IdentityFactory() - Constructor for class com.avaya.collaboration.call.IdentityFactory
 
IdentityFactoryInterface - Interface in com.avaya.collaboration.call
 
increment() - Method in interface com.avaya.collaboration.service.activity.ServiceActivityData
Increments the existing activity count by one.
When snap-in is initialized, the activity count is zero (By calling increment() first time, the count would go to one).
info(Object) - Method in class com.avaya.collaboration.util.logger.Logger
This method logs a message at the INFO level.
info(Object, Throwable) - Method in class com.avaya.collaboration.util.logger.Logger
This method logs a message at the INFO level and adds the stack trace for the Throwable.
init() - Method in interface com.avaya.collaboration.service.ServiceLifeCycle
Invoked by the Avaya Aura® Collaboration Environment to indicate that the service is ready.
INITIALIZATION_ERROR - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode
 
INITIALIZATION_ERROR - Static variable in class com.avaya.collaboration.eventing.EventingResultCode
 
initiate() - Method in interface com.avaya.collaboration.call.Call
Initiates an outgoing call to the target defined while creating the call instance.
INTERRUPTED - Static variable in class com.avaya.collaboration.call.media.PlayOperationCause
Play completed because the media was interrupted by a digit press.
InvalidSearchQueryException - Exception in com.avaya.collaboration.call.speech.search.exception
Indicates that an invalid SearchQuery was encountered.
InvalidSearchQueryException(String, Throwable) - Constructor for exception com.avaya.collaboration.call.speech.search.exception.InvalidSearchQueryException
 
isCalledPhase() - Method in interface com.avaya.collaboration.call.Call
Returns true if server is invoked in imsterm phase, false otherwise.
isCallingPhase() - Method in interface com.avaya.collaboration.call.Call
Returns true if server is invoked in imsorig phase, false otherwise.
isDeliverToPreferredVersion() - Method in interface com.avaya.collaboration.eventing.EventSubscriptionAttributes
Returns true if the "deliver to preferred version" option has been selected.
isEventingReady() - Static method in class com.avaya.collaboration.eventing.EventingFactory
Returns true if the eventing framework is initialized and available for use; false, otherwise.
isFineEnabled() - Method in class com.avaya.collaboration.util.logger.Logger
This method returns whether the FINE level is enabled.
isFinerEnabled() - Method in class com.avaya.collaboration.util.logger.Logger
This method returns whether the FINER level is enabled.
isFinestEnabled() - Method in class com.avaya.collaboration.util.logger.Logger
This method returns whether the FINEST level is enabled.
isFlushBuffer() - Method in interface com.avaya.collaboration.call.media.DigitOptions
Returns true if the digit buffer will be flushed before digit collection.
isHostedOnLocalNode(Call) - Static method in class com.avaya.collaboration.call.CallProperties
Check if the provided call is hosted by your service on this node
isInDenyNewService() - Static method in class com.avaya.collaboration.util.SystemStatus
Check if system is in deny new service state.
isInfoEnabled() - Method in class com.avaya.collaboration.util.logger.Logger
This method returns whether the INFO level is enabled.
isInterruptible() - Method in interface com.avaya.collaboration.call.media.PlayItem
Returns true if the play operation can be interrupted when a digit is detected.
isOverloaded() - Static method in class com.avaya.collaboration.util.SystemStatus
Check if system is overloaded for CPU and Memory.
isPopulateConsumerPreferredVersion() - Method in interface com.avaya.collaboration.eventing.EventSubscriptionAttributes
Returns true if the "populate consumer preferred version" option has been selected.
isValidCharsInDescription(String) - Static method in class com.avaya.collaboration.conference.scheduled.SchedConfOperations
Validates that the value of description contains only allowed characters.
ITERATE_FOREVER - Static variable in interface com.avaya.collaboration.call.media.PlayItem
 

L

LAST - Static variable in class com.avaya.collaboration.call.speech.search.query.OperatorType
The LAST operator generates a match whenever any of its constituent search terms are found to match within a specified time period that finishes at the end of the file or stream.
LastOperator - Interface in com.avaya.collaboration.call.speech.search.query.operators
The LAST operator generates a match whenever any of its constituent search terms are found to match within a specified time period that finishes at the end of the search.
LISTENER_DEFINITION_ERROR - Static variable in class com.avaya.collaboration.eventing.EventingResultCode
 
LISTENER_NOT_FOUND - Static variable in class com.avaya.collaboration.eventing.EventingResultCode
 
logEvent(String, Object[]) - Method in class com.avaya.collaboration.util.logger.Logger
Logs an event, which will be converted into an alarm by CE.
Logger - Class in com.avaya.collaboration.util.logger
A service should use this class for debug logging.
Logger(String) - Constructor for class com.avaya.collaboration.util.logger.Logger
 
LOTUS_NOTES - Static variable in class com.avaya.collaboration.data.api.AddressType
IBM Lotus note ID configured in System Manager

M

matchFound(UUID, Call, List) - Method in interface com.avaya.collaboration.call.speech.search.SpeechSearchListener
Notification of a match from a speech search.
matchFound(UUID, Call, List) - Method in class com.avaya.collaboration.call.speech.search.SpeechSearchListenerAbstract
 
MatchReportingStrategy - Class in com.avaya.collaboration.call.speech.search.match
The matching strategy tunes the match results provided to the SpeechSearchListener.
mediaDetected(Participant, MediaType) - Method in interface com.avaya.collaboration.call.CallListener
Indicates that media has been detected from an alerting party or the answering party.
mediaDetected(Participant, MediaType) - Method in class com.avaya.collaboration.call.CallListenerAbstract
Indicates that media has been detected from an alerting party or the answering party.
MediaFactory - Class in com.avaya.collaboration.call.media
A factory to create media objects used in making media server requests.
MediaListener - Interface in com.avaya.collaboration.call.media
An instance of the MediaListener is passed into the MediaService media request methods, such as play, collect and dialog.
MediaListenerAbstract - Class in com.avaya.collaboration.call.media
An instance of the MediaListener is passed into methods that are invoked on the MediaService to report the result of the media operations.
MediaListenerAbstract() - Constructor for class com.avaya.collaboration.call.media.MediaListenerAbstract
 
MediaService - Interface in com.avaya.collaboration.call.media
This is the interface used to invoke media server operations including playing a file and collecting digits.
MediaType - Class in com.avaya.collaboration.call
 
messageReceived(CollaborationBusMessage) - Method in interface com.avaya.collaboration.bus.MessageReceiver
Receives the next message produced for this consumer.
MessageReceiver - Interface in com.avaya.collaboration.bus
A service implement this method to receive messages that have been delivered to a channel for which the service is a consumer.
MICROSOFT_EXCHANGE - Static variable in class com.avaya.collaboration.data.api.AddressType
Outlook Email address configured in System Manager
MICROSOFT_EXCHANGE - Static variable in class com.avaya.collaboration.data.api.EmailType
Outlook Email address linked to user.
MICROSOFT_OCS_SIP - Static variable in class com.avaya.collaboration.data.api.AddressType
Microsoft OCS SIP address configured in System Manager
MIDCALL_EVENT_RECEIVED - Static variable in class com.avaya.collaboration.call.speech.voicexml.VoiceXMLDialogCause
Event sent by the VoiceXML interpreter when a mid-call event arises
MOBILE - Static variable in class com.avaya.collaboration.data.api.MobileType
This is user's mobile number configured in SMGR User Management -> Identity tab ->Address -> Phone Details - Mobile Number
MobileType - Class in com.avaya.collaboration.data.api
An enumeration of the supported mobile types configured in System Manager.

N

NETWORK_FAILED - Static variable in class com.avaya.collaboration.call.CallTerminationCause
Call terminated because network failed.
NETWORK_SUGGESTED_RETRY - Static variable in class com.avaya.collaboration.call.CallTerminationCause
Call terminated because network failed but suggested to try again with negotiated parameters.
NoAttributeFoundException - Exception in com.avaya.collaboration.businessdata.api
The attribute can't be found.
NoAttributeFoundException(String) - Constructor for exception com.avaya.collaboration.businessdata.api.NoAttributeFoundException
 
NoServiceProfileFoundException - Exception in com.avaya.collaboration.businessdata.api
Service Profile not found.
NoServiceProfileFoundException(String) - Constructor for exception com.avaya.collaboration.businessdata.api.NoServiceProfileFoundException
 
NOT_DETERMINED - Static variable in class com.avaya.collaboration.call.CallTerminationCause
Error case where CMA code failed to provide a cause.
NoUserFoundException - Exception in com.avaya.collaboration.businessdata.api
User not found.
NoUserFoundException(String) - Constructor for exception com.avaya.collaboration.businessdata.api.NoUserFoundException
 
NUMBER_OF_DIGITS - Static variable in class com.avaya.collaboration.call.media.DigitCollectorOperationCause
If the collection ended and the number of digits is met.

O

OK - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode
 
OK - Static variable in class com.avaya.collaboration.eventing.EventingResultCode
 
Operator - Interface in com.avaya.collaboration.call.speech.search.query
An Operator specifies how matches for one or more search terms will be combined.
OperatorType - Class in com.avaya.collaboration.call.speech.search.query
The Operator Types supported by Speech Search.
ORGANIZATION_NOT_FOUND - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode
 
OTHER_EMAIL - Static variable in class com.avaya.collaboration.data.api.AddressType
Other email configured in System Manager
OTHER_EMAIL - Static variable in class com.avaya.collaboration.data.api.EmailType
Other email addresses linked to user.
OTHER_SIP - Static variable in class com.avaya.collaboration.data.api.AddressType
Other SIP number configured in System Manager
OTHER_XMPP - Static variable in class com.avaya.collaboration.data.api.AddressType
Other XMPP address configured in System Manager

P

Participant - Interface in com.avaya.collaboration.call
Each party in the call (e.g., calling party, called party) is represented by a Participant.
ParticipantFactory - Class in com.avaya.collaboration.call
Factory used to create a participant which would then be used to create a call.
PHRASE - Static variable in class com.avaya.collaboration.call.speech.search.query.OperatorType
The PHRASE operator identifies search terms.
Phrase - Interface in com.avaya.collaboration.call.speech.search.query
 
play(Participant, PlayItem, MediaListener) - Method in interface com.avaya.collaboration.call.media.MediaService
Plays a list of audio files to a participant on a call.
playCompleted(UUID, PlayOperationCause) - Method in interface com.avaya.collaboration.call.media.MediaListener
This is invoked when a play request has completed.
playCompleted(UUID, PlayOperationCause) - Method in class com.avaya.collaboration.call.media.MediaListenerAbstract
 
playCompleted(UUID, PlayOperationCause) - Method in class com.avaya.collaboration.call.speech.search.sample.SampleUnifiedSpeechCall.MyMediaListener
 
PlayItem - Interface in com.avaya.collaboration.call.media
 
PlayOperationCause - Class in com.avaya.collaboration.call.media
Enumeration of reasons with which play operation can get completed.
PreSendMessageHandler - Interface in com.avaya.collaboration.bus
A client uses this interface to be notified of a populated CollaborationBusMessageHeader, before the message is actually sent.
promptAndCollect(Participant, PlayItem, DigitOptions, MediaListener) - Method in interface com.avaya.collaboration.call.media.MediaService
Plays a list of prompt resources to a participant on a call and then collects digits from the same participant.
ProtocolType - Class in com.avaya.collaboration.call
An enumeration of the supported protocol types used for the underlying communications protocol.
publish() - Method in interface com.avaya.collaboration.eventing.EventProducer
Publish an event.

R

readConfig() - Static method in class com.avaya.zephyr.platform.dal.api.ServiceUtil
 
readProperties() - Static method in class com.avaya.zephyr.platform.dal.api.ServiceUtil
 
register(Object) - Static method in class com.avaya.collaboration.dal.factory.CollaborationDataFactory
Registers with the Avaya Aura® Collaboration Environment data service for data access.
registerResponseListener(String, MessageReceiver) - Method in interface com.avaya.collaboration.bus.CollaborationBusMessageHandler
Registers a callback listener for each channel that responses are to be received on.
removeHeader(String) - Method in interface com.avaya.collaboration.call.sip.SipRequest
Removes the specified header.
removeHeader(String) - Method in interface com.avaya.collaboration.call.sip.SipResponse
Removes the specified header.
removeHeader(String) - Method in interface com.avaya.collaboration.call.sip.SipURI
Removes the named header from this SipURI.
removeParameter(String) - Method in interface com.avaya.collaboration.call.sip.SipAddress
Removes the named parameter from this object.
removeParameter(String) - Method in interface com.avaya.collaboration.call.sip.SipURI
Removes the named parameter from this URL.
renewSubscription(String) - Method in interface com.avaya.collaboration.eventing.EventingService
Renew a subscription.
reReadInstallProperties() - Static method in class com.avaya.collaboration.util.SystemStatus
 
RESOURCE_ERROR - Static variable in class com.avaya.collaboration.eventing.EventingResultCode
 
responseReceived(EmailResponse) - Method in interface com.avaya.collaboration.email.EmailListener
Invoked upon receiving a response to a sent Email.
responseReceived(EmailResponse) - Method in class com.avaya.collaboration.email.sample.SampleEmailListener
 
responseReceived(SmsResponse) - Method in class com.avaya.collaboration.sms.sample.SampleSmsListener
 
responseReceived(SmsResponse) - Method in interface com.avaya.collaboration.sms.SmsListener
Invoked upon receiving a response to a sent SMS.
retrieveConf(int) - Static method in class com.avaya.collaboration.conference.scheduled.SchedConfFactory
Retrieve a conference from the conference service for a given conference ID.
retrieveListConf() - Static method in class com.avaya.collaboration.conference.scheduled.SchedConfFactory
Retrieve a list of conferences from the conference service that are in a "not started" state.

S

SampleCBClient - Class in com.avaya.collaboration.bus.sample
Sample Collaboration Bus Client
SampleCBClient() - Constructor for class com.avaya.collaboration.bus.sample.SampleCBClient
 
SampleCBConnector - Class in com.avaya.collaboration.bus.sample
Sample lottery result retriever
SampleCBConnector() - Constructor for class com.avaya.collaboration.bus.sample.SampleCBConnector
 
SampleEmail - Class in com.avaya.collaboration.email.sample
Sample code: Send an Email.
SampleEmail() - Constructor for class com.avaya.collaboration.email.sample.SampleEmail
 
SampleEmailListener - Class in com.avaya.collaboration.email.sample
Sample code: Email Listener
The code below is the listener that is set in the SampleEmail logic.
SampleEmailListener() - Constructor for class com.avaya.collaboration.email.sample.SampleEmailListener
 
SampleEventConsumer - Class in com.avaya.collaboration.eventing.sample
Sample code: Event Consumer

The code below illustrates how an event consumer subscribes to indicate interest in receiving events published by an event producer.

SampleEventListener - Class in com.avaya.collaboration.eventing.sample
Sample Code: Event Listener

The code below illustrates how an event consumer defines a listener class to receive events.

SampleEventProducer - Class in com.avaya.collaboration.eventing.sample
Sample Code: Event Producer

The code below illustrates how an event producer publishes an event.

SampleLotteryHttpClient - Class in com.avaya.collaboration.bus.sample
Sample client code to make outgoing http requests from system
SampleLotteryHttpClient() - Constructor for class com.avaya.collaboration.bus.sample.SampleLotteryHttpClient
 
SampleMediaCall - Class in com.avaya.collaboration.call.media.sample
Sample Code: Play an Announcement to a Caller.
SampleMediaCall() - Constructor for class com.avaya.collaboration.call.media.sample.SampleMediaCall
 
SamplePublishHTTP - Class in com.avaya.collaboration.eventing.sample
Sample Code: Publish through HTTP

The sample code below illustrates how to publish events through the HTTP interface of the EventingConnector snap-in.

SampleSchedConf - Class in com.avaya.collaboration.conference.scheduled.sample
Sample code: Schedule a Conference.
SampleServiceActivityDataUsage - Class in com.avaya.collaboration.service.activity.sample
Sample code: Get ServiceActivityData object and perform various operations using it.
SampleServiceActivityDataUsage() - Constructor for class com.avaya.collaboration.service.activity.sample.SampleServiceActivityDataUsage
 
SampleSms - Class in com.avaya.collaboration.sms.sample
Sample code: Send an SMS.
SampleSms() - Constructor for class com.avaya.collaboration.sms.sample.SampleSms
 
SampleSmsListener - Class in com.avaya.collaboration.sms.sample
Sample code: SMS Listener
This is the listener set in the SampleSms logic.
SampleSmsListener() - Constructor for class com.avaya.collaboration.sms.sample.SampleSmsListener
 
SampleSpeechSearchCall - Class in com.avaya.collaboration.call.speech.search.sample
Sample Code: Start a Speech Search on a call
SampleSpeechSearchCall() - Constructor for class com.avaya.collaboration.call.speech.search.sample.SampleSpeechSearchCall
 
SampleSSLUtil - Class in com.avaya.collaboration.ssl.util.sample
Sample code: How to use the SSL Util API to create and initialize a new SSL context with CE's key store and trust store
The code below illustrates how to use SSL Util API.
SampleSSLUtil() - Constructor for class com.avaya.collaboration.ssl.util.sample.SampleSSLUtil
 
SampleUnifiedSpeechCall - Class in com.avaya.collaboration.call.speech.search.sample
 
SampleUnifiedSpeechCall() - Constructor for class com.avaya.collaboration.call.speech.search.sample.SampleUnifiedSpeechCall
 
SampleUnifiedSpeechCall.MyMediaListener - Class in com.avaya.collaboration.call.speech.search.sample
 
SampleUnifiedSpeechCall.MyMediaListener(Participant) - Constructor for class com.avaya.collaboration.call.speech.search.sample.SampleUnifiedSpeechCall.MyMediaListener
 
SampleVoiceXMLDialog - Class in com.avaya.collaboration.call.speech.voicexml.sample
Sample Code: Start a VoiceXML Dialog on a call
SampleVoiceXMLDialog() - Constructor for class com.avaya.collaboration.call.speech.voicexml.sample.SampleVoiceXMLDialog
 
SampleVoiceXMLDialog.MyVoiceXMLDialogListener - Class in com.avaya.collaboration.call.speech.voicexml.sample
 
SampleVoiceXMLDialog.MyVoiceXMLDialogListener(Participant) - Constructor for class com.avaya.collaboration.call.speech.voicexml.sample.SampleVoiceXMLDialog.MyVoiceXMLDialogListener
 
SchedConf - Interface in com.avaya.collaboration.conference.scheduled
A class that represents a conference in a conference service.
SchedConfException - Exception in com.avaya.collaboration.conference.scheduled
A runtime exception used to indicate error conditions in the Avaya Aura® Collaboration Environment Scheduled Conference API.
SchedConfException(SchedConfResultCode, String) - Constructor for exception com.avaya.collaboration.conference.scheduled.SchedConfException
 
SchedConfException(SchedConfResultCode) - Constructor for exception com.avaya.collaboration.conference.scheduled.SchedConfException
 
SchedConfException(SchedConfResultCode, String, Throwable) - Constructor for exception com.avaya.collaboration.conference.scheduled.SchedConfException
 
SchedConfException(SchedConfResultCode, Throwable) - Constructor for exception com.avaya.collaboration.conference.scheduled.SchedConfException
 
SchedConfFactory - Class in com.avaya.collaboration.conference.scheduled
Factory used to instantiate various scheduled conference objects.
SchedConfOperations - Class in com.avaya.collaboration.conference.scheduled
Provides various operations related to scheduled conferences.
SchedConfResultCode - Class in com.avaya.collaboration.conference.scheduled
Values used to indicate the result of various operations available in the Avaya Aura® Collaboration Environment Scheduled Conference API.
schedule() - Method in interface com.avaya.collaboration.conference.scheduled.SchedConf
Schedules a conference with the attribute values that have been set on the instance of this class.
ScopiaRequest - Interface in com.avaya.collaboration.conference.scheduled.scopia
Provides "raw" access to the SCOPIA Management XML API so that a service writer can submit requests directly to SCOPIA Management using XML.
SearchOptions - Interface in com.avaya.collaboration.call.speech.search
Options for Speech Search including the search queries, and language details.
SearchQuery - Interface in com.avaya.collaboration.call.speech.search.query
A search query consists of the concepts and phrases used in a speech search.
send(String) - Method in interface com.avaya.collaboration.conference.scheduled.scopia.ScopiaRequest
Sends a request to the conference service.
send() - Method in interface com.avaya.collaboration.email.EmailRequest
Send the email.
send() - Method in interface com.avaya.collaboration.sms.SmsRequest
Send the message.
sendEventingMessage(String, String, String, byte[]) - Method in interface com.avaya.collaboration.bus.CollaborationBusMessageHandler
Sends an eventing message
sendingOut(SipRequest, Participant) - Method in interface com.avaya.collaboration.call.sip.SipMessageListener
Indicates that request is about to be sent to targetParticipant.
sendingOut(SipResponse, Participant) - Method in interface com.avaya.collaboration.call.sip.SipMessageListener
Indicates that response is about to be sent to targetParticipant.
sendingOut(SipResponse, Participant) - Method in class com.avaya.collaboration.call.sip.SipMessageListenerAbstract
Indicates that request is about to be sent to targetParticipant.
sendMessage(String, String, byte[], String) - Method in interface com.avaya.collaboration.bus.CollaborationBusMessageHandler
Sends a message to a channel.
sendMessage(String, String, byte[], String, PreSendMessageHandler) - Method in interface com.avaya.collaboration.bus.CollaborationBusMessageHandler
Sends a message on a channel.
sendResponse(String, CollaborationBusMessageHeader, byte[]) - Method in interface com.avaya.collaboration.bus.CollaborationBusMessageHandler
Sends a response message to a previously received message.
SERIALIZATION_FAILURE - Static variable in class com.avaya.collaboration.eventing.EventingResultCode
 
ServiceActivityData - Interface in com.avaya.collaboration.service.activity
This interface provides methods to deal with custom activity value for a snap-in.
A snap-in can record and manipulate its activity count based on its business logic.
ServiceActivityDataFactory - Class in com.avaya.collaboration.service.activity
Factory used to create a ServiceActivityData object
ServiceActivityDataFactoryDelegate - Interface in com.avaya.collaboration.service.activity
This is an internal interface used by the ServiceActivityFactory.
ServiceData - Interface in com.avaya.collaboration.businessdata.api
This interface provides methods to retrieve various service related data.
ServiceDescriptor - Class in com.avaya.zephyr.platform.dal.api
The service descriptor returns details of the service including the service name, service version and the SDK version the service was built with.
ServiceDescriptor(String, String) - Constructor for class com.avaya.zephyr.platform.dal.api.ServiceDescriptor
 
ServiceLifeCycle - Interface in com.avaya.collaboration.service
The Service life cycle interface defines service initialization and destroy callback methods for the purpose of startup and cleanup, respectively.
ServiceNotFoundException - Exception in com.avaya.collaboration.businessdata.api
Service not found.
ServiceNotFoundException(String) - Constructor for exception com.avaya.collaboration.businessdata.api.ServiceNotFoundException
 
ServiceUtil - Class in com.avaya.zephyr.platform.dal.api
This Utility factory class returns ServiceDescriptor object.
set(long) - Method in interface com.avaya.collaboration.service.activity.ServiceActivityData
Sets the activity count to newValue.
setAccountId(String) - Method in interface com.avaya.collaboration.sms.SmsRequest
Set the account ID.
setAttribute(String, Object) - Method in interface com.avaya.collaboration.call.Call
Store an attribute for later retrieval.
setCallListenerClass(String) - Method in class com.avaya.zephyr.platform.dal.api.ServiceDescriptor
 
setCollectedDigits(String) - Method in interface com.avaya.collaboration.call.Call
Sets the collected digits portion of the initial invitation message sent to the called party
setConcepts(Concept[]) - Method in interface com.avaya.collaboration.call.speech.search.query.SearchQuery
Set the concepts for the search query.
setConfigFile(String) - Static method in class com.avaya.zephyr.platform.dal.api.ServiceUtil
 
setConfigFileReadAttempted(boolean) - Static method in class com.avaya.zephyr.platform.dal.api.ServiceUtil
 
setConsumerName(String) - Method in interface com.avaya.collaboration.eventing.EventSubscriptionAttributes
(Optional) - Set the consumer name associated with this subscription.
setConsumerPrivateData(Serializable) - Method in interface com.avaya.collaboration.eventing.EventSubscriptionAttributes
(Optional) - Set an arbitrary object/set of data associated with this subscription.
setConsumerVersion(String) - Method in interface com.avaya.collaboration.eventing.EventSubscriptionAttributes
(Optional) - Set the consumer version associated with this subscription.
setContextId(String) - Method in interface com.avaya.collaboration.call.Call
Set the context ID associated with this call.
setCorrelationId(String) - Method in interface com.avaya.collaboration.eventing.EventFilter
Set the correlation Id to filter against.
setCorrelationId(String) - Method in interface com.avaya.collaboration.eventing.EventMetaData
(Optional) - Set a correlation ID associated with an event.
setDeliverToPreferredVersion() - Method in interface com.avaya.collaboration.eventing.EventSubscriptionAttributes
(Optional) - Set the "deliver to preferred version" option when subscribing.
setDescription(String) - Method in interface com.avaya.collaboration.conference.scheduled.SchedConf
(Optional) - Sets the conference description.
setDisplayName(String) - Method in interface com.avaya.collaboration.call.sip.SipAddress
Sets the display name of this Address.
setDuration(int) - Method in interface com.avaya.collaboration.call.media.PlayItem
(Optional) - sets the duration of a play request in milliseconds.
setDuration(double) - Method in interface com.avaya.collaboration.call.speech.search.query.operators.AllOperator
Set the duration time constraint.
setDuration(double) - Method in interface com.avaya.collaboration.call.speech.search.query.operators.AtLeastOperator
Set the duration time constraint.
setDuration(double) - Method in interface com.avaya.collaboration.call.speech.search.query.operators.FirstOperator
Set the duration time constraint.
setDuration(double) - Method in interface com.avaya.collaboration.call.speech.search.query.operators.LastOperator
Set the duration time constraint.
setDuration(int, int, int) - Method in interface com.avaya.collaboration.conference.scheduled.SchedConf
(Optional) - Sets the duration for the conference.
setDuration(Duration) - Method in interface com.avaya.collaboration.conference.scheduled.SchedConf
(Optional) - Sets the duration for the conference.
setEventListenerClass(String) - Method in class com.avaya.zephyr.platform.dal.api.ServiceDescriptor
 
setFilter(EventFilter) - Method in interface com.avaya.collaboration.eventing.EventSubscriptionAttributes
(Optional) - Set an EventFilter object for this subscription.
setFlushBuffer(boolean) - Method in interface com.avaya.collaboration.call.media.DigitOptions
Sets the parameter used to determine when the buffer should be flushed.
setFrom(String) - Method in interface com.avaya.collaboration.email.EmailRequest
Set the from.
setHeader(String, String) - Method in interface com.avaya.collaboration.call.sip.SipRequest
Sets a header with the given name and value.
setHeader(String, String) - Method in interface com.avaya.collaboration.call.sip.SipResponse
Sets a header with the given name and value.
setHeader(String, String) - Method in interface com.avaya.collaboration.call.sip.SipURI
Sets the value of the specified header in this SipURI.
setINSTALLPROPS(String) - Static method in class com.avaya.collaboration.util.SystemStatus
 
setInterruptible(boolean) - Method in interface com.avaya.collaboration.call.media.PlayItem
(Optional) - defines whether or not audio announcements may be interrupted when a digit is detected.
setIterateCount(int) - Method in interface com.avaya.collaboration.call.media.PlayItem
(Optional) - sets the number of times to play this item.
setLangauge(String) - Method in interface com.avaya.collaboration.call.speech.search.query.SearchQuery
Set the language of the search query.
setLanguage(String) - Method in interface com.avaya.collaboration.call.speech.search.SearchOptions
Set the language used for the speech search.
setListener(EmailListener) - Method in interface com.avaya.collaboration.email.EmailRequest
Responses to a EmailRequest.send() request arrive asynchronously.
setListener(SmsListener) - Method in interface com.avaya.collaboration.sms.SmsRequest
Responses to a SmsRequest.send() request arrive asynchronously.
setMatchReportingStrategy(MatchReportingStrategy) - Method in interface com.avaya.collaboration.call.speech.search.SearchOptions
Sets the match reporting strategy that tunes the reporting of the matches found during a speech search.
setMaxParticipants(int) - Method in interface com.avaya.collaboration.conference.scheduled.SchedConf
(Optional) - Sets the number of conference participants.
setModeratorPin(int) - Method in interface com.avaya.collaboration.conference.scheduled.SchedConf
(Optional) - Sets the moderator pin.
setName(String) - Method in interface com.avaya.collaboration.call.speech.search.query.Concept
Sets the concept name
setName(String) - Method in interface com.avaya.collaboration.call.speech.search.query.SearchQuery
Set the name of the search query.
setName(String) - Method in class com.avaya.zephyr.platform.dal.api.ServiceDescriptor
 
setNumber(int) - Method in interface com.avaya.collaboration.call.speech.search.query.operators.AtLeastOperator
Set the number of concepts required for a match.
setNumberOfDigits(int) - Method in interface com.avaya.collaboration.call.media.DigitOptions
Sets the number of digits that must be collected before an event is generated.
setOperator(Operator) - Method in interface com.avaya.collaboration.call.speech.search.query.Concept
Sets the concept operator type
setParameter(String, String) - Method in interface com.avaya.collaboration.call.sip.SipAddress
Sets the value of the named parameter.
setParameter(String, String) - Method in interface com.avaya.collaboration.call.sip.SipURI
Sets the value of the named parameter.
setParticipantPin(int) - Method in interface com.avaya.collaboration.conference.scheduled.SchedConf
(Optional) - Sets the participant pin.
setPassword(String) - Method in interface com.avaya.collaboration.sms.SmsRequest
Set the password.
setPopulateConsumerPreferredVersion() - Method in interface com.avaya.collaboration.eventing.EventSubscriptionAttributes
(Optional) - Set the "populate preferred consumer version" option when subscribing.
setPrefix(String) - Method in class com.avaya.collaboration.util.logger.Logger
 
setPresentedDisplayName(String) - Method in interface com.avaya.collaboration.call.Participant
Set this party's display name to be presented to other parties in the call.
setPresentedDomain(String) - Method in interface com.avaya.collaboration.call.Participant
Set the domain part of this party's address to be presented to other parties in the call.
setPresentedHandle(String) - Method in interface com.avaya.collaboration.call.Participant
Set the handle part of this party's address to be presented to other parties in the call.
setProducerName(String) - Method in interface com.avaya.collaboration.eventing.EventMetaData
(Optional) - Set the producer name.
setProducerVersion(String) - Method in interface com.avaya.collaboration.eventing.EventMetaData
(Optional) - Set the producer version.
setPropertiesFile(String) - Static method in class com.avaya.zephyr.platform.dal.api.ServiceUtil
 
setPropertiesXmlFileRead(boolean) - Static method in class com.avaya.zephyr.platform.dal.api.ServiceUtil
 
setReplyTo(String) - Method in interface com.avaya.collaboration.email.EmailRequest
Set the replyTo.
setSd(ServiceDescriptor) - Static method in class com.avaya.zephyr.platform.dal.api.ServiceUtil
 
setSearchQuery(SearchQuery[]) - Method in interface com.avaya.collaboration.call.speech.search.SearchOptions
Set the search queries used for the speech search.
setSender(String) - Method in interface com.avaya.collaboration.sms.SmsRequest
Set the sender.
setServiceProfile(String) - Method in interface com.avaya.collaboration.eventing.EventFilter
Set the service profile to filter against
setSOL_PIPE(String) - Static method in class com.avaya.collaboration.util.SystemStatus
 
setSource(String[]) - Method in interface com.avaya.collaboration.call.media.PlayItem
Sets the source that identifies the list of audio resources and text-to-speech (TTS) strings to be played on the call.
setStartTime(Calendar) - Method in interface com.avaya.collaboration.conference.scheduled.SchedConf
(Optional) - Sets the start time for the conference.
setSubConcepts(Concept[]) - Method in interface com.avaya.collaboration.call.speech.search.query.Concept
Set the list of concepts to match
setSubject(String) - Method in interface com.avaya.collaboration.conference.scheduled.SchedConf
Sets the subject.
setSubject(String) - Method in interface com.avaya.collaboration.email.EmailRequest
Set the subject.
setTerminationKey(String) - Method in interface com.avaya.collaboration.call.media.DigitOptions
Sets the termination key that stops a digit collection operation.
setText(String) - Method in interface com.avaya.collaboration.sms.SmsRequest
Set the text message body
setTextBody(String) - Method in interface com.avaya.collaboration.email.EmailRequest
Set the text body.
setThreshold(float) - Method in interface com.avaya.collaboration.call.speech.search.query.Concept
Sets the threshold for matching this concept
setTimeout(int) - Method in interface com.avaya.collaboration.call.media.DigitOptions
Sets the number of milliseconds to wait to receive the first digit.
setUser(String) - Method in interface com.avaya.collaboration.call.sip.SipURI
Sets the user part of this SipURI.
setUser(String) - Method in interface com.avaya.collaboration.eventing.EventFilter
Set the user to filter against.
setUser(String) - Method in interface com.avaya.collaboration.eventing.EventMetaData
(Optional) - Set a user associated with an event.
setUserName(String) - Method in interface com.avaya.collaboration.sms.SmsRequest
Set the user name.
setValue(String) - Method in interface com.avaya.collaboration.call.sip.SipAddress
Set the value of the field.
setVersion(String) - Method in class com.avaya.zephyr.platform.dal.api.ServiceDescriptor
 
setVoiceXMLScript(URI) - Method in interface com.avaya.collaboration.call.speech.voicexml.VoiceXMLDialogItem
Sets the URI of the source of the VoiceXML document.
SIP - Static variable in class com.avaya.collaboration.call.ProtocolType
Protocol type that uses SIP communication protocol.
SipAddress - Interface in com.avaya.collaboration.call.sip
Wrapper class of javax.servlet.sip.Address.
SipMessageListener - Interface in com.avaya.collaboration.call.sip
Listener interface through which the service is informed of SIP message going to a Participant.
SipMessageListenerAbstract - Class in com.avaya.collaboration.call.sip
Abstract listener class through which the service is informed of SIP message going to a Participant.
SipMessageListenerAbstract() - Constructor for class com.avaya.collaboration.call.sip.SipMessageListenerAbstract
 
SipRequest - Interface in com.avaya.collaboration.call.sip
Wrapper class of javax.servlet.sip.SipServletRequest.
SipResponse - Interface in com.avaya.collaboration.call.sip
Wrapper class of javax.servlet.sip.SipServletResponse.
SIPS - Static variable in class com.avaya.collaboration.call.ProtocolType
Protocol type that uses SIPS communication protocol for security.
SipURI - Interface in com.avaya.collaboration.call.sip
Wrapper class of javax.servlet.sip.SipURI.
SmsFactory - Class in com.avaya.collaboration.sms
Factory used to create an SmsRequest, which would then be used to send an SMS to one or more recipients.
SmsFactory() - Constructor for class com.avaya.collaboration.sms.SmsFactory
 
SmsListener - Interface in com.avaya.collaboration.sms
A service writer who wishes to receive responses to an SmsRequest#send() operation will need to implement this interface.
SmsRequest - Interface in com.avaya.collaboration.sms
Represents an SmsRequest object which can be used to send a text messages to one or more destinations.
SmsResponse - Interface in com.avaya.collaboration.sms
Represents an SmsResponse object which can be used to get information about a response to an SmsRequest#send() operation.
SpeechFactory - Class in com.avaya.collaboration.call.speech.search
A factory to create speech objects used in speech requests.
SpeechSearchListener - Interface in com.avaya.collaboration.call.speech.search
An instance of the SpeechSearchListener is passed into the SpeechService search request methods.
SpeechSearchListenerAbstract - Class in com.avaya.collaboration.call.speech.search
 
SpeechSearchListenerAbstract() - Constructor for class com.avaya.collaboration.call.speech.search.SpeechSearchListenerAbstract
 
SpeechSearchMatch - Interface in com.avaya.collaboration.call.speech.search.match
The match results from a speech search.
SpeechService - Interface in com.avaya.collaboration.call.speech.search
This is the interface used to invoke speech operations including search based on provided queries.
SSL - Static variable in class com.avaya.collaboration.ssl.util.SSLProtocolType
 
SSLProtocolType - Class in com.avaya.collaboration.ssl.util
Supported SSL protocols are SSLv3.0 and TLSv1.0
SSLUtilityException - Exception in com.avaya.collaboration.ssl.util
Exception used to indicate error conditions in the Avaya Aura® Collaboration Environment SSLUtility API.
SSLUtilityException(String) - Constructor for exception com.avaya.collaboration.ssl.util.SSLUtilityException
 
SSLUtilityException(String, Throwable) - Constructor for exception com.avaya.collaboration.ssl.util.SSLUtilityException
 
SSLUtilityFactory - Class in com.avaya.collaboration.ssl.util
Factory used to create SSLContext with platform's trust store and key store.
START_TIME_TOO_LATE - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode
 
STARTED - Static variable in class com.avaya.collaboration.call.speech.voicexml.VoiceXMLDialogCause
Event sent by the VoiceXML interpreter to signal that the dialog started
startSearch(Call, SearchOptions, SpeechSearchListener) - Method in interface com.avaya.collaboration.call.speech.search.SpeechService
Starts searching the speech on a call using search queries.
startSearch(Participant, SearchOptions, SpeechSearchListener) - Method in interface com.avaya.collaboration.call.speech.search.SpeechService
Starts searching the speech of a participant on a call using search queries.
startSearchFailed(UUID, Exception) - Method in interface com.avaya.collaboration.call.speech.search.SpeechSearchListener
Notification of a speech search failure.
startSearchFailed(UUID, Exception) - Method in class com.avaya.collaboration.call.speech.search.SpeechSearchListenerAbstract
 
startVoiceXMLDialog(Participant, VoiceXMLDialogItem, VoiceXMLDialogListener) - Method in interface com.avaya.collaboration.call.speech.search.SpeechService
Sends a VoiceXML request to the media server for a participant on an established call.
stop(Participant, UUID) - Method in interface com.avaya.collaboration.call.media.MediaService
Stops a current play or digit collection or VoiceXMLDialog operation for the participant
STOPPED - Static variable in class com.avaya.collaboration.call.media.DigitCollectorOperationCause
The digit collection operation was stopped explicitly by the client service invoking MediaService.stop(Participant, java.util.UUID)
STOPPED - Static variable in class com.avaya.collaboration.call.media.PlayOperationCause
The play operation was stopped explicitly by the client service invoking MediaService.stop(Participant participant, UUID id)
stopSearch(UUID) - Method in interface com.avaya.collaboration.call.speech.search.SpeechService
Stop the speech search on the media server using the search identifier.
stopVoiceXMLDialog(UUID) - Method in interface com.avaya.collaboration.call.speech.search.SpeechService
Stop the VoiceXML dialog on the media server using the dialog identifier
subscribe(EventSubscriptionAttributes) - Method in interface com.avaya.collaboration.eventing.EventingService
Subscribe for an event.
SUMMARY - Static variable in class com.avaya.collaboration.call.speech.search.match.MatchReportingStrategy
Provides matching results on the top most concepts and top most phrases in the search query.
suspend() - Method in interface com.avaya.collaboration.call.Call
Suspends the call to proceed further.
SYSTEM_FAILED - Static variable in class com.avaya.collaboration.call.CallTerminationCause
Call terminated because of System failure.
SystemGlobalData - Interface in com.avaya.collaboration.businessdata.api
This interface provides methods to retrieve enterprise wide service independent data in the Avaya Collaboration Environment.
SystemStatus - Class in com.avaya.collaboration.util
SystemStatus methods are available to all services to obtain system status to "Check if system is in Overload", "Check if system is in deny new service state", "Get the system CPU occupancy", "Get the system platform version", "Get the system SDP API version" , "Get the MemoryUtilization" and "Get the StatusMessage"

T

TARGET_BLOCKED - Static variable in class com.avaya.collaboration.call.CallTerminationCause
Call terminated because target was blocked.
TARGET_BUSY - Static variable in class com.avaya.collaboration.call.CallTerminationCause
Call terminated because target was busy.
TARGET_DID_NOT_RESPOND - Static variable in class com.avaya.collaboration.call.CallTerminationCause
Call terminated because target did not respond.
TARGET_DOES_NOT_EXIST - Static variable in class com.avaya.collaboration.call.CallTerminationCause
Call terminated because target does not exist.
terminated(UUID, String) - Method in interface com.avaya.collaboration.call.speech.search.SpeechSearchListener
Notification of a terminated event from a speech search.
terminated(UUID, String) - Method in class com.avaya.collaboration.call.speech.search.SpeechSearchListenerAbstract
 
TERMINATION_KEY - Static variable in class com.avaya.collaboration.call.media.DigitCollectorOperationCause
If the collection ended and the termination key was met.
TEST_MODE_ERROR - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode
 
TheCallListener - Interface in com.avaya.collaboration.call
TheCallListener allows service to be informed of call events (such as new call, alerting or answered).
TheEventListener - Interface in com.avaya.collaboration.eventing
TheEventListener allows a snap-in to be informed of events published through the Eventing Framework.
TheServiceLifeCycle - Interface in com.avaya.collaboration.service
TheServiceLifeCycle allows service to provide service life cycle callback methods.
TheSipMessageListener - Interface in com.avaya.collaboration.call.sip
TheSipMessageListener allows service to be informed of SIP message going to Participants.
TIMEOUT - Static variable in class com.avaya.collaboration.call.media.DigitCollectorOperationCause
If the collection completes and there was no DTMF entered i.e.
TIMEOUT - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode
 
TLS - Static variable in class com.avaya.collaboration.ssl.util.SSLProtocolType
 
toString() - Method in exception com.avaya.collaboration.conference.scheduled.SchedConfException
Returns a String representation of this object.
toString() - Method in exception com.avaya.collaboration.eventing.EventingException
Returns a String representation of this object.

U

UNEXPECTED_ERROR - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode
 
UNEXPECTED_SERVER_RESPONSE - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode
 
UNRECOGNIZED_SERVER_ERROR - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode
 
unsubscribe(String) - Method in interface com.avaya.collaboration.eventing.EventingService
Unsubscribe a subscription.
unsubscribeAll() - Method in interface com.avaya.collaboration.eventing.EventingService
Unsubscribe from all existing subscriptions that have been made by the specific version of the snap-in invoking this method.
UNSUPPORTED_MEDIA_TYPE - Static variable in class com.avaya.collaboration.call.CallTerminationCause
Unsupported media type
UserData - Interface in com.avaya.collaboration.data.api
This interface provides methods to retrieve various user's personal data in Avaya Aura® Collaboration Environment.
UserDataSample - Class in com.avaya.collaboration.data.api.sample
Sample code for creating the UserData reference
UserDataSample() - Constructor for class com.avaya.collaboration.data.api.sample.UserDataSample
 

V

valueOf(String) - Static method in class com.avaya.collaboration.call.CallTerminationCause
 
valueOf(String) - Static method in class com.avaya.collaboration.call.media.DigitCollectorOperationCause
 
valueOf(String) - Static method in class com.avaya.collaboration.call.media.PlayOperationCause
 
valueOf(String) - Static method in class com.avaya.collaboration.call.MediaType
 
valueOf(String) - Static method in class com.avaya.collaboration.call.ProtocolType
 
valueOf(String) - Static method in class com.avaya.collaboration.call.speech.search.match.MatchReportingStrategy
 
valueOf(String) - Static method in class com.avaya.collaboration.call.speech.search.query.OperatorType
 
valueOf(String) - Static method in class com.avaya.collaboration.call.speech.voicexml.VoiceXMLDialogCause
 
valueOf(String) - Static method in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode
 
valueOf(String) - Static method in class com.avaya.collaboration.data.api.AddressType
 
valueOf(String) - Static method in class com.avaya.collaboration.data.api.EmailType
 
valueOf(String) - Static method in class com.avaya.collaboration.data.api.MobileType
 
valueOf(String) - Static method in class com.avaya.collaboration.eventing.EventingResultCode
 
valueOf(String) - Static method in class com.avaya.collaboration.ssl.util.SSLProtocolType
 
values() - Static method in class com.avaya.collaboration.call.CallTerminationCause
 
values() - Static method in class com.avaya.collaboration.call.media.DigitCollectorOperationCause
 
values() - Static method in class com.avaya.collaboration.call.media.PlayOperationCause
 
values() - Static method in class com.avaya.collaboration.call.MediaType
 
values() - Static method in class com.avaya.collaboration.call.ProtocolType
 
values() - Static method in class com.avaya.collaboration.call.speech.search.match.MatchReportingStrategy
 
values() - Static method in class com.avaya.collaboration.call.speech.search.query.OperatorType
 
values() - Static method in class com.avaya.collaboration.call.speech.voicexml.VoiceXMLDialogCause
 
values() - Static method in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode
 
values() - Static method in class com.avaya.collaboration.data.api.AddressType
 
values() - Static method in class com.avaya.collaboration.data.api.EmailType
 
values() - Static method in class com.avaya.collaboration.data.api.MobileType
 
values() - Static method in class com.avaya.collaboration.eventing.EventingResultCode
 
values() - Static method in class com.avaya.collaboration.ssl.util.SSLProtocolType
 
VIDEO - Static variable in class com.avaya.collaboration.call.MediaType
 
VoiceXMLDialogCause - Class in com.avaya.collaboration.call.speech.voicexml
Enumeration of events generated by a VoiceXML dialog request.
VoiceXMLDialogItem - Interface in com.avaya.collaboration.call.speech.voicexml
 
VoiceXMLDialogListener - Interface in com.avaya.collaboration.call.speech.voicexml
 
VoiceXMLDialogListenerAbstract - Class in com.avaya.collaboration.call.speech.voicexml
An instance of the VoiceXMLDialogListener is passed into methods that are invoked on the SpeechService to report the result of the VoiceXML operations.
VoiceXMLDialogListenerAbstract() - Constructor for class com.avaya.collaboration.call.speech.voicexml.VoiceXMLDialogListenerAbstract
 

W

warn(Object, Throwable) - Method in class com.avaya.collaboration.util.logger.Logger
This method logs a message at the WARN level, and adds the stack trace for the Throwable.
warn(Object) - Method in class com.avaya.collaboration.util.logger.Logger
This method logs a message at the WARN level.

X

XML_PARSER_ERROR_ON_SERVER - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode
 
XML_UNMARSHALL_ERROR - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode
 
A C D E F G H I L M N O P R S T U V W X 
Avaya Aura®
Collaboration Environment
Version 3.0 API

Copyright © 2014 Avaya. All Rights Reserved.