Index (Avaya Breeze API)

A C D E F G H I L M N O P Q R S T U V W X

A

ABANDONED - Static variable in class com.avaya.collaboration.call.CallTerminationCause: Calling party abandoned call before it was answered.
AbstractDMListener - Class in com.avaya.zephyr.platform.dm: Abstract listener class through which the service is notified of changes in service attribute values.
AbstractDMListener() - Constructor for class com.avaya.zephyr.platform.dm.AbstractDMListener
AccessToken - Interface in com.avaya.collaboration.authorization.client: Represents a token returned by the Authorization Service to a client.
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.
addBodyPart(ContentType, String) - Method in interface com.avaya.collaboration.email.EmailRequest: Add a body part to the email message.
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: (Optional) - Add key/value pairs to filter against.
addCriterionIgnoreCase(String, String) - Method in interface com.avaya.collaboration.eventing.EventFilter: (Optional) - 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: Add another participant to the call.
addParticipantFailed(Call, Participant, CallTerminationCause) - Method in interface com.avaya.collaboration.call.CallListener: Indicates that an attempt to add a participant to the 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, String, float) - Method in interface com.avaya.collaboration.call.speech.search.query.Concept: Add a phrase with a unique identifier 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
addPhrase(String, String, float) - Method in interface com.avaya.collaboration.call.speech.search.query.SearchQuery: Add a phrase with a unique identifier 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 ended normally after it was answered.
ALERTING - Static variable in class com.avaya.collaboration.call.ParticipantState: The participant is ringing (alerting).
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: Called 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: A snap-in dropped the call or a participant
AS_NEEDED - Static variable in class com.avaya.collaboration.call.media.MediaServerInclusion: Add an Avaya Aura® Media Server resource to the call only when needed for a media operation.
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
AuthorizationClientHelper - Class in com.avaya.collaboration.authorization.client: Helper used by clients of the Authorization Service that authenticates the client and returns the granted token.
AuthorizationData - Interface in com.avaya.collaboration.authorization.resource: Provides authorization related data that a token is associated with.
AuthorizationHelperException - Exception in com.avaya.collaboration.authorization: Exception which indicates error conditions in the Authorization Helper APIs.
AuthorizationHelperException(String) - Constructor for exception com.avaya.collaboration.authorization.AuthorizationHelperException
AuthorizationHelperException(String, Throwable) - Constructor for exception com.avaya.collaboration.authorization.AuthorizationHelperException
AuthorizationResourceHelper - Class in com.avaya.collaboration.authorization.resource: Helper used by Authorization Resources to validate bearer tokens and retrieve scopes.
AuthorizationScope - Interface in com.avaya.collaboration.authorization.resource: The AuthorizationScope is a component of AuthorizationData, useful for Authorization Resources to determine what scope an access token represents and then decide whether to allow the request to be served or not.
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 executing operations like allow, drop, or divertTo, and to get and/or set certain call-related data and policies.
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: Indicates that the service has intercepted a 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.
callOriginated(Call) - Method in interface com.avaya.collaboration.call.CallListener: Indicates that the first party in a 2-party make-call has answered.
callOriginated(Call) - Method in class com.avaya.collaboration.call.CallListenerAbstract: Indicates that the first party in a 2-party make-call has answered.
CallPolicies - Interface in com.avaya.collaboration.call: View or change various call-related policies.
CallProperties - Class in com.avaya.collaboration.call: This class provides access to various properties of the call.
callTerminated(Call, CallTerminationCause) - Method in interface com.avaya.collaboration.call.CallListener: Indicates that the call has terminated (ended).
callTerminated(Call, CallTerminationCause) - Method in class com.avaya.collaboration.call.CallListenerAbstract: Indicates that the call has terminated (ended).
CallTerminationCause - Class in com.avaya.collaboration.call: An enumeration of the Call Termination Cause which can be used to find reason of call termination.
CallTerminationPolicy - Class in com.avaya.collaboration.call: New Enum.
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.
clearMatchConsumerToUserViaServiceProfile() - Method in interface com.avaya.collaboration.eventing.EventSubscriptionAttributes: (Optional) - Clear the "match consumer to user via service profile" 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.authorization - package com.avaya.collaboration.authorization: Provides Authorization Helper API classes to retrieve access tokens and validate them.
com.avaya.collaboration.authorization.client - package com.avaya.collaboration.authorization.client: Helper APIs to aid Authorization Clients to obtain access tokens from Authorization Service.
com.avaya.collaboration.authorization.resource - package com.avaya.collaboration.authorization.resource: Helper APIs to aid Authorization Resources to validate and parse bearer tokens.
AuthorizationResourceHelper is the helper used to validate a bearer token and fetch AuthorizationData it contains.
AuthorizationData provides authorization information a bearer token represents.
com.avaya.collaboration.authorization.sample - package com.avaya.collaboration.authorization.sample: Provides sample code which uses Authorization Helper APIs.
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: Factory to create Collaboration Bus objects.
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: Attributes, Licensing, and the Avaya Breeze Service Archive (.svar) properties File
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: Example code that illustrates how to use media operations and the media listener.
com.avaya.collaboration.call.sample - package com.avaya.collaboration.call.sample: Sample call listener code for callable service.
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: Provides classes and interfaces for starting speech search on a call.
com.avaya.collaboration.call.speech.search.exception - package com.avaya.collaboration.call.speech.search.exception: Exceptions specific to speech search operations.
com.avaya.collaboration.call.speech.search.match - package com.avaya.collaboration.call.speech.search.match: Report a match on a speech search.
com.avaya.collaboration.call.speech.search.query - package com.avaya.collaboration.call.speech.search.query: These are the types of queries available for defining a speech search.
com.avaya.collaboration.call.speech.search.query.operators - package com.avaya.collaboration.call.speech.search.query.operators: These are the operators available for a speech search query.
com.avaya.collaboration.call.speech.search.sample - package com.avaya.collaboration.call.speech.search.sample: Example code that illustrates how to use speech search operations and the speech search listener.
com.avaya.collaboration.call.speech.voicexml - package com.avaya.collaboration.call.speech.voicexml: Provides classes and interfaces for starting voice XML dialog on a call.
com.avaya.collaboration.call.speech.voicexml.sample - package com.avaya.collaboration.call.speech.voicexml.sample: Example code that illustrates how to run a VoiceXML dialog.
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 Avaya Breeze.
com.avaya.collaboration.dal.factory - package com.avaya.collaboration.dal.factory: Factory that supplies various data access objects.
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 Breeze.
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.http - package com.avaya.collaboration.http: Provides an API useful for retrieving http/https proxy settings.
com.avaya.collaboration.http.sample - package com.avaya.collaboration.http.sample: Provides examples for using the Http 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: The SSLUtility is used to create an SSLContext with the platform's trust store and key store.
com.avaya.collaboration.ssl.util.sample - package com.avaya.collaboration.ssl.util.sample: Sample code snippet that illustrates the use of SSLUtility API.
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: Objects to provide information about a service, such as its version or its properties.
com.avaya.zephyr.platform.dm - package com.avaya.zephyr.platform.dm: Provides classes that allow a service to be notified of changes to service attribute values.
com.avaya.zephyr.platform.dm.sample - package com.avaya.zephyr.platform.dm.sample: Provides example code showing the use of AbstractDmListener to receive service attribute change notifications.
COMMUNICATION_ERROR - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode: Communication with the server failed.
COMPLETE - Static variable in class com.avaya.collaboration.call.media.PlayOperationCause: Play completed because all media generation has completed.
COMPLETE - Static variable in class com.avaya.collaboration.call.media.SendDigitsOperationCause: send digits operation completed because all digit 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 already cancelled.
CONFERENCE_FINISHED - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode: Attempt to modify/cancel a conference failed because the conference has finished.
CONFERENCE_NOT_FOUND - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode: Conference not found.
CONFERENCE_STARTED - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode: Attempt to modify/cancel a conference failed because the conference has started.
CONNECTED - Static variable in class com.avaya.collaboration.call.media.PreAnswerMediaState: Send a 200 OK SIP response in early media phase
CONNECTED - Static variable in class com.avaya.collaboration.call.ParticipantState: The participant is connected.
CONNECTOR_NOT_FOUND - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode: Attempt to locate connector failed.
CONSUMER_PRIVATE_DATA_TOO_LARGE - Static variable in class com.avaya.collaboration.eventing.EventingResultCode
ContentType - Class in com.avaya.collaboration.email: Represents an ContentType Enum class containing the supported MIME types.
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: Creates an Identity instance based on address.
create(String, String) - Method in interface com.avaya.collaboration.call.IdentityFactoryInterface: Creates a new local Identity instance.
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: Returns an instance of an AllOperator.
createAnyOperator() - Static method in class com.avaya.collaboration.call.speech.search.SpeechFactory: Returns an instance of an AnyOperator.
createAtLeastOperator() - Static method in class com.avaya.collaboration.call.speech.search.SpeechFactory: Returns an instance of an AtLeastOperator.
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 an Avaya Aura® 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: Returns an instance of a FirstOperator.
createHttpProperties() - Static method in class com.avaya.collaboration.http.HttpFactory: Creates an HttpProperties object with no parameters.
createLastOperator() - Static method in class com.avaya.collaboration.call.speech.search.SpeechFactory: Returns an instance of a LastOperator.
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 an Avaya Aura® Media Server to play a file to a participant on a call.
createRecordItem() - Static method in class com.avaya.collaboration.call.media.MediaFactory: Returns an instance of a RecordItem that is used to make a request to an Avaya Aura® Media Server to record the audio from a connected participant on a call to a file.
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
createSubscriptionSelectionFilter() - Static method in class com.avaya.collaboration.eventing.EventingFactory: Returns a SubscriptionSelectionFilter object used to set criteria for selecting a set of subscriptions.
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 Avaya Aura® 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_MAX_DURATION_MILLISECONDS - Static variable in interface com.avaya.collaboration.call.media.RecordItem: The default value of the maximum duration is 3600000 milliseconds.
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 Breeze to indicate that the service is being taken out of service.
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: Provides methods to access or modify the properties related to a digit collection operation.
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.
dropParticipant(Participant) - Method in interface com.avaya.collaboration.call.Call: Drop a participant from the call.
DUPLICATE_CONFERENCE - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode: Attempt to schedule a conference failed because a duplicate conference exists.

E

EARLY - Static variable in class com.avaya.collaboration.call.media.PreAnswerMediaState: Send a 183 SIP Progress response in early media phase
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
EmailBodyPart - Interface in com.avaya.collaboration.email: Represents an EmailBodyPart object which can be used to hold a body part of an email.
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: Deprecated.
Use CallPolicies.setPreAnswerMediaState(PreAnswerMediaState) and CallPolicies.setMediaServerInclusion(MediaServerInclusion) instead.

Instruct Avaya Breeze to set up resources to allow media operations before a call is answered. The resources will actually be set up once a call operation (for example, allow or divertTo) or media operation ( MediaService) has been initiated. This method must be invoked in CallListener.callIntercepted(Call).
enableMediaBeforeAnswer(PreAnswerMediaState) - Method in interface com.avaya.collaboration.call.Call: Deprecated.
Use CallPolicies.setPreAnswerMediaState(PreAnswerMediaState) and CallPolicies.setMediaServerInclusion(MediaServerInclusion) insetad.

Instruct Avaya Breeze to set up resources to allow media operations before a call is answered. The resources will actually be set up once a call operation (for example, allow or divertTo) or media operation ( MediaService) has been initiated. This method must be invoked in CallListener.callIntercepted(Call).
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_ACTIVE - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyRestCall: Event type for Participant Active
EVENT_ACTIVE_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyRestCall: Qualified event type for Participant Active
EVENT_ADD_PARTICIPANT_FAILED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCall: Event type for Add Participant Failed
EVENT_ADD_PARTICIPANT_FAILED_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCall: Qualified event type for Add Participant Failed
EVENT_ALERTING - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyRestCall: Event type for Call Alerting
EVENT_ALERTING_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyRestCall: Qualified event type for Call Alerting
EVENT_ANSWERED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyRestCall: Event type for Call Answered
EVENT_ANSWERED_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyRestCall: Qualified event type for Call Answered
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 type for Call Alerting
EVENT_CALL_ALERTING_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCall: Qualified event type for Call Alerting
EVENT_CALL_ANSWERED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCall: Event type for Call Answered
EVENT_CALL_ANSWERED_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCall: Qualified event type for Call Answered
EVENT_CALL_ENDED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCall: Event type for Call Ended
EVENT_CALL_ENDED_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCall: Qualified event type for Call Ended
EVENT_CALL_OFFERED_FROM_CALLING_PARTY - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCall: Event type for Call Offered From Calling Party
EVENT_CALL_OFFERED_FROM_CALLING_PARTY_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCall: Qualified event type for Call Offered From Calling Party
EVENT_CONFERENCED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyRestCall: Event type for Call Conferenced
EVENT_CONFERENCED_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyRestCall: Qualified event type for Call Conferenced
EVENT_FAILED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyRestCall: Event type for Call Failed
EVENT_FAILED_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyRestCall: Qualified event type for Call Failed
EVENT_HELD - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyRestCall: Event type for Participant Held
EVENT_HELD_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyRestCall: Qualified event type for Participant Held
EVENT_OFFERING_CALL_TO_CALLED_PARTY - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCall: Event type for Offering Call To Called Party
EVENT_OFFERING_CALL_TO_CALLED_PARTY_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCall: Qualified event type for Offering Call To Called Party
EVENT_PARTICIPANT_DROPPED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCall: Event type for Participant Dropped
EVENT_PARTICIPANT_DROPPED_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCall: Qualified event type for Participant Dropped
EVENT_PARTICIPANTDROPPED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyRestCall: Event type for Participant Dropped
EVENT_PARTICIPANTDROPPED_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyRestCall: Qualified event type for Participant Dropped
EVENT_PEER_NODE_STATUS_CHANGED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCluster: Notification of a peer node server status change in the same cluster.
EVENT_PEER_NODE_STATUS_CHANGED_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCluster
EVENT_SPEECH_SEARCH_ERROR - Static variable in class com.avaya.collaboration.eventing.families.EventFamilySpeechSearch: Event type for Speech Search Error
EVENT_SPEECH_SEARCH_ERROR_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilySpeechSearch: Qualified Event type for Speech Search Error
EVENT_SPEECH_SEARCH_MATCH - Static variable in class com.avaya.collaboration.eventing.families.EventFamilySpeechSearch: Event type for Speech Search Match
EVENT_SPEECH_SEARCH_MATCH_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilySpeechSearch: Qualified Event type for Speech Search Match
EVENT_SPEECH_SEARCH_STARTED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilySpeechSearch: Event type for Speech Search Started
EVENT_SPEECH_SEARCH_STARTED_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilySpeechSearch: Qualified Event type for Speech Search Started
EVENT_SPEECH_SEARCH_STOPPED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilySpeechSearch: Event type for Speech Search Stopped
EVENT_SPEECH_SEARCH_STOPPED_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilySpeechSearch: Qualified Event type for Speech Search Stopped
EVENT_SUBSCRIPTION_EXPIRING - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyEventing: Event type for Subscription Expiring
EVENT_SUBSCRIPTION_EXPIRING_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyEventing: Qualified event type for Subscription Expiring
EVENT_SUBSCRIPTION_STATUS - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyEventing: Event type for Subscription Status
EVENT_SUBSCRIPTION_STATUS_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyEventing: Qualified event type for Subscription Status
EVENT_TRANSFERRED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyRestCall: Event type for Participant Transferred
EVENT_TRANSFERRED_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyRestCall: Qualified event type for Participant Transferred
EVENT_UNHELD - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyRestCall: Event type for Participant Unheld
EVENT_UNHELD_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyRestCall: Qualified event type for Participant Unheld
EVENT_VOICEMAIL - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyRestVoicemail: Event type for Voicemail events
EVENT_VOICEMAIL_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyRestVoicemail: Qualified event type for Voicemail events
EVENT_WORK_ERROR - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyWorkAssignment: Event type for Work Error
EVENT_WORK_ERROR_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyWorkAssignment: Qualified event type for Work Error
EVENT_WORK_OFFER - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyWorkAssignment: Event type for Work Offer
EVENT_WORK_OFFER_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyWorkAssignment: Qualified event type for Work Offer
EVENT_WORK_QUEUED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyWorkAssignment: Event type for Work Queued
EVENT_WORK_QUEUED_QUALIFIED - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyWorkAssignment: Qualified event type for Work Queued
EventFamilyCall - Class in com.avaya.collaboration.eventing.families: Various constants that define useful values related to the Call event family.
EventFamilyCluster - Class in com.avaya.collaboration.eventing.families: Various constants that define useful values related to the Cluster event family.
EventFamilyEventing - Class in com.avaya.collaboration.eventing.families: Various constants that define useful values related to the Eventing event family.
EventFamilyRestCall - Class in com.avaya.collaboration.eventing.families: Various constants that define useful values related to the Engagement Call Control event family REST CALL.
EventFamilyRestVoicemail - Class in com.avaya.collaboration.eventing.families: Various constants that define useful values related to the Engagement Call Control event family REST VOICEMAIL.
EventFamilySpeechSearch - Class in com.avaya.collaboration.eventing.families: Various constants that define useful values related to the SpeechSearch 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 Breeze 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 Breeze 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.
EventSubscription - Interface in com.avaya.collaboration.eventing: An event subscription.
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.
FAILED - Static variable in class com.avaya.collaboration.call.media.RecordOperationCause: The record operation failed before it could complete.
FAILED - Static variable in class com.avaya.collaboration.call.media.SendDigitsOperationCause: send digits operation failed before it could complete.
FAMILY_NAME - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCall: Family Name for Call Events
FAMILY_NAME - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCluster
FAMILY_NAME - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyEventing: Family Name for Eventing Events
FAMILY_NAME - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyRestCall: Family Name for Engagement Call Control Call Events
FAMILY_NAME - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyRestVoicemail: Family Name for Engagement Call Control Messaging Events
FAMILY_NAME - Static variable in class com.avaya.collaboration.eventing.families.EventFamilySpeechSearch: Family Name for SpeechSearch Events
FAMILY_NAME - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyWorkAssignment: Family Name for WorkAssignment Events
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_UCID - Static variable in class com.avaya.collaboration.eventing.families.EventFamilyCall: Filter ucid
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: Attempt to forward request to conference connector failed.

G

GENERIC_SERVER_ERROR - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode: Server returned a vague error response.
get() - Method in interface com.avaya.collaboration.service.activity.ServiceActivityData: Returns the current activity count.
getAccessToken() - Static method in class com.avaya.collaboration.authorization.client.AuthorizationClientHelper: Authenticates the client with the Authorization Service, obtains an access token and returns it.
getAccessToken(List) - Static method in class com.avaya.collaboration.authorization.client.AuthorizationClientHelper: Authenticates the client with the Authorization Service, obtains an access token and returns it; the client can request for specific scopes during authentication by using the "scopes" parameter.
getAccessTokenForUser(String, String) - Static method in class com.avaya.collaboration.authorization.client.AuthorizationClientHelper: Authenticates the client and the end user with the Authorization Service, obtains an access token and returns it.
getAccessTokenForUser(String, String, List) - Static method in class com.avaya.collaboration.authorization.client.AuthorizationClientHelper: Authenticates the client and the end user with the Authorization Service, obtains an access token and returns it; the client can request for specific scopes during authentication by using the "scopes" parameter.
getAccountId() - Method in interface com.avaya.collaboration.sms.SmsRequest: Get the account ID.
getActiveParties() - Method in interface com.avaya.collaboration.call.Call: Get the list of Participants currently involved in the call.
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(String) - 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.
getAuthorizationData(String) - Static method in class com.avaya.collaboration.authorization.resource.AuthorizationResourceHelper: Returns the authorization data associated with a bearer token.
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.
getBodyParts() - Method in interface com.avaya.collaboration.email.EmailRequest: Get the list of email body parts
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: Returns the CallListener class in the service
getCallPolicies() - Method in interface com.avaya.collaboration.call.Call: Get the object that tracks call-related policies.
getCallTerminationPolicy() - Method in interface com.avaya.collaboration.call.CallPolicies: Get the current call termination policy.
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.
getClientScopeList() - Method in interface com.avaya.collaboration.authorization.resource.AuthorizationData
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 Avaya Breeze server 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 Avaya Breeze server 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 Avaya Breeze server 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 Avaya Breeze server 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 Avaya Breeze server 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 Avaya Breeze server 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 level between 0.0 and 100.0 of the concept matched, where 100 is a perfect match.
getConsumerName() - Method in interface com.avaya.collaboration.eventing.Event: The service name of the consumer.
getConsumerName() - Method in interface com.avaya.collaboration.eventing.EventSubscription: Get the consumer name associated with the subscription.
getConsumerName() - Method in interface com.avaya.collaboration.eventing.EventSubscriptionAttributes: Get the consumer name associated with the subscription.
getConsumerName() - Method in interface com.avaya.collaboration.eventing.SubscriptionSelectionFilter: Get the consumer name.
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.EventSubscription: Get the consumer private data associated with the 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.EventSubscription: Get the consumer version associated with the subscription.
getConsumerVersion() - Method in interface com.avaya.collaboration.eventing.EventSubscriptionAttributes: Get the consumer version associated with the subscription.
getConsumerVersion() - Method in interface com.avaya.collaboration.eventing.SubscriptionSelectionFilter: Get the consumer version.
getContent() - Method in interface com.avaya.collaboration.email.EmailBodyPart: Gets the content of the BodyPart.
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.
getContentType() - Method in interface com.avaya.collaboration.email.EmailBodyPart: Gets an appropriate value for the content-type header for the BodyPart.
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.
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: Returns description for the result code
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 Identity 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: Time, in seconds, from the speech search request until the end 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: Returns the EventListener class in the service
getEventMetaData() - Method in interface com.avaya.collaboration.eventing.Event: Get the event meta data provided by the event producer.
getEventType() - Method in interface com.avaya.collaboration.eventing.SubscriptionSelectionFilter: Get the event type.
getEventTypeList() - Method in interface com.avaya.collaboration.eventing.EventSubscription: Get the list of event types.
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.
getExpiresIn() - Method in interface com.avaya.collaboration.authorization.client.AccessToken: Returns the number of seconds in which the token will expire.
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.EventSubscription: Get the event family associated with the subscription.
getFamily() - Method in interface com.avaya.collaboration.eventing.EventSubscriptionAttributes: Get the event family associated with the subscription.
getFamily() - Method in interface com.avaya.collaboration.eventing.SubscriptionSelectionFilter: Get the family.
getFeatureName() - Method in interface com.avaya.collaboration.authorization.resource.AuthorizationScope
getFeatureValues() - Method in interface com.avaya.collaboration.authorization.resource.AuthorizationScope
getFileUri() - Method in interface com.avaya.collaboration.call.media.RecordItem: Get the URI of the recorded file
getFilter() - Method in interface com.avaya.collaboration.eventing.EventSubscription: Get the event filter 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.
Replaced by getServiceAttribute(String)
getGlobalServiceAttributeList() - Method in interface com.avaya.collaboration.businessdata.api.ServiceData: Deprecated.
Replaced by getServiceAttributeList()
getGlobalServiceEncryptedAttribute(String) - Method in interface com.avaya.collaboration.businessdata.api.ServiceData: Deprecated.
Replaced by getServiceEncryptedAttribute(String)
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.
getHttpProxyHost() - Method in interface com.avaya.collaboration.http.HttpProperties: Get the Http proxy host setting
getHttpProxyPort() - Method in interface com.avaya.collaboration.http.HttpProperties: Get the Http proxy port setting
getHttpsProxyHost() - Method in interface com.avaya.collaboration.http.HttpProperties: Get the Https proxy host setting
getHttpsProxyPort() - Method in interface com.avaya.collaboration.http.HttpProperties: Get the Https proxy port setting
getId() - Method in interface com.avaya.collaboration.call.Call: Every call, or session, has a unique local identifier.
getId() - Method in interface com.avaya.collaboration.call.speech.search.match.SpeechSearchMatch: The identifier for the match.
getId() - Method in interface com.avaya.collaboration.call.speech.search.query.Phrase: Get the query identifier for the phrase.
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.
getKeyManagers() - Static method in class com.avaya.collaboration.ssl.util.SSLUtilityFactory: Returns the platform's Certificate KeyManagers as a List.
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() - Method in interface com.avaya.collaboration.call.media.RecordItem: Returns the maximum duration for a record request in milliseconds.
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.
getMediaServerInclusion() - Method in interface com.avaya.collaboration.call.CallPolicies: Get the current Avaya Aura® Media Server inclusion policy
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.
getParentUCID() - Method in interface com.avaya.collaboration.call.Call: Get the parent's Universal Call ID associated with this call.
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: Get the search 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 the system's 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.
getPreAnswerMediaState() - Method in interface com.avaya.collaboration.call.CallPolicies: Get the current call pre-answer media state
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.
getProtocolString() - Method in class com.avaya.collaboration.ssl.util.SSLProtocolType: Returns the protocol name
getPublicationTimestamp() - Method in interface com.avaya.collaboration.eventing.Event: Returns the time from the epoch in milliseconds when the event was published.
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.
getScopes() - Method in interface com.avaya.collaboration.authorization.client.AccessToken: Returns a list of scopes associated with the token.
getSdkVersionBuiltWith() - Method in class com.avaya.zephyr.platform.dal.api.ServiceDescriptor: Get the version of the SDK the service was built with.
getSdkVersionForService(String, String) - Method in class com.avaya.zephyr.platform.dal.api.ServiceDescriptor: Get the version of the SDK the service was built with based on service name and service version.
getSdkVersionOnPlatform() - Static method in class com.avaya.collaboration.util.SystemStatus: Get the SDK version on the 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.
getServiceAttribute(String, String) - Method in interface com.avaya.collaboration.businessdata.api.ServiceData: Returns the value for a service attribute.
getServiceAttribute(String, AddressType, String) - Method in interface com.avaya.collaboration.businessdata.api.ServiceData: Returns the value for a service attribute for a user of the specified address type.
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: Returns an instance of ServiceDescriptor for the service
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.
getServiceName() - Method in class com.avaya.zephyr.platform.dm.AbstractDMListener: Returns the name of the service.
getServiceProfile() - Method in interface com.avaya.collaboration.eventing.EventFilter: Get the service profile.
getServiceVersion() - Method in class com.avaya.zephyr.platform.dm.AbstractDMListener: Returns the version of the service.
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: Time, in seconds, from the speech search request until the start of the match.
getStartTime() - Method in interface com.avaya.collaboration.conference.scheduled.SchedConf: Returns the start time of the conference.
getState() - Method in interface com.avaya.collaboration.call.Participant: Find the current state of the participant.
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.
getStatusCode() - Method in exception com.avaya.collaboration.authorization.client.HttpResponseException: Returns the HTTP response status code
getStatusMessage() - Method in exception com.avaya.collaboration.authorization.client.HttpResponseException: Returns the HTTP response status message
getStatusMessage() - Static method in class com.avaya.collaboration.util.SystemStatus: Get system's status message.
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.authorization.resource.AuthorizationData
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.
getSubscriptionId() - Method in interface com.avaya.collaboration.eventing.EventSubscription: Get the subscription ID associated with the subscription.
getSubscriptionId() - Method in interface com.avaya.collaboration.eventing.SubscriptionSelectionFilter: Get the subscription ID.
getSupplierId() - Method in interface com.avaya.collaboration.businessdata.api.ServiceData: Returns the Supplier Id of the service as specified in the properties.xml file of the service.The service name should be specified when ServiceData instance is acquired using CollaborationDataFactory.getServiceData().
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.
getTerminationKey() - Method in interface com.avaya.collaboration.call.media.RecordItem: Get the termination key used to interrupt a record 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 phrase.
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.
getTrustManagers() - Static method in class com.avaya.collaboration.ssl.util.SSLUtilityFactory: Returns the platform's Certificate TrustManagers as a List.
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.
getUserScopeList() - Method in interface com.avaya.collaboration.authorization.resource.AuthorizationData
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.CallTerminationPolicy
getValue() - Method in class com.avaya.collaboration.call.media.MediaServerInclusion
getValue() - Method in class com.avaya.collaboration.call.media.PreAnswerMediaState
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
HttpFactory - Class in com.avaya.collaboration.http: Factory used to create an HttpProperties, which would then be used to get the Http/Https proxy host and port properties.
HttpProperties - Interface in com.avaya.collaboration.http: Represents an HttpProperties object which can be used to get the proxy properties information.
HttpResponseException - Exception in com.avaya.collaboration.authorization.client: Indicates HTTP error responses propagated by the Authorization Helper APIs.
HttpResponseException(int, String) - Constructor for exception com.avaya.collaboration.authorization.client.HttpResponseException

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: View the properties of an Identity.
IdentityFactory - Class in com.avaya.collaboration.call: Factory used to create an Identity which would then be used to create a call.
IdentityFactoryInterface - Interface in com.avaya.collaboration.call: Factory used to create an Identity.
IDLE - Static variable in class com.avaya.collaboration.call.ParticipantState: The participant is not involved in a connection.
INCLUDED - Static variable in class com.avaya.collaboration.call.media.MediaServerInclusion: Add an Avaya Aura® Media Server resource to the call for the duration of the call.
IncomingMessageListener - Interface in com.avaya.collaboration.call.sip: IncomingMessageListener allows the service to be notified of incoming SIP messages, so that the service could inspect or mutate information in the SIP message.
IncomingSipMessageListener - Interface in com.avaya.collaboration.call.sip: Listener interface through which the service is informed of an incoming SIP message before the framework would invoke one of the CallListener methods.
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 Breeze to indicate that the service is ready.
INITIALIZATION_ERROR - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode: Initialization of the conference API has failed
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.
INVALID_COMBINATION_OF_SUBSCRIPTION_ATTRIBUTES - Static variable in class com.avaya.collaboration.eventing.EventingResultCode
INVALID_COMBINATION_OF_SUBSCRIPTION_SELECTION_FILTER_ATTRIBUTES - Static variable in class com.avaya.collaboration.eventing.EventingResultCode
InvalidAddressTypeException - Exception in com.avaya.collaboration.businessdata.api: The user address type is null.
InvalidAddressTypeException(String) - Constructor for exception com.avaya.collaboration.businessdata.api.InvalidAddressTypeException
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 the service is invoked for the called party, false otherwise.
isCallingPhase() - Method in interface com.avaya.collaboration.call.Call: Returns true if the service is invoked for the calling party, false otherwise.
isDeliverToPreferredVersion() - Method in interface com.avaya.collaboration.eventing.EventSubscription: Returns true if the "deliver to preferred version" option has been selected.
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.
isMatchConsumerToUserViaServiceProfile() - Method in interface com.avaya.collaboration.eventing.EventSubscription: Returns true if the "match consumer to user via service profile" option has been selected.
isMatchConsumerToUserViaServiceProfile() - Method in interface com.avaya.collaboration.eventing.EventSubscriptionAttributes: Returns true if the "match consumer to user via service profile" option has been selected.
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.EventSubscription: Returns true if the "populate consumer preferred version" option has been selected.
isPopulateConsumerPreferredVersion() - Method in interface com.avaya.collaboration.eventing.EventSubscriptionAttributes: Returns true if the "populate consumer preferred version" option has been selected.
isSignedService() - Method in interface com.avaya.collaboration.businessdata.api.ServiceData: Indicates whether the service has been signed by Avaya or not.The service name and service version should be specified when ServiceData instance is acquired using CollaborationDataFactory.getServiceData().
isValid(String) - Static method in class com.avaya.collaboration.authorization.resource.AuthorizationResourceHelper: Validates the bearer token coming from the Authorization header.
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.
MEDIA_SERVER_FAILURE - Static variable in class com.avaya.collaboration.call.CallTerminationCause: Media server failure.
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 Avaya Aura® Media Server requests.
MediaListener - Interface in com.avaya.collaboration.call.media: The result of the media request is passed to the callback methods on this class.
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
MediaServerInclusion - Class in com.avaya.collaboration.call.media: Defines the various policies for including an Avaya Aura® Media Server in a call.
MediaService - Interface in com.avaya.collaboration.call.media: This is the interface used to invoke Avaya Aura® Media Server operations including playing a file, recording, sending and collecting digits.
MediaType - Class in com.avaya.collaboration.call: Enumeration of the media types.
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.
MULTIPLE_FILTER_TYPES_SPECIFIED - Static variable in class com.avaya.collaboration.eventing.EventingResultCode

N

NETWORK_FAILED - Static variable in class com.avaya.collaboration.call.CallTerminationCause: Received network failure indication trying to reach target.
NETWORK_SUGGESTED_RETRY - Static variable in class com.avaya.collaboration.call.CallTerminationCause: Received network failure trying to reach target, but suggested to try again with negotiated parameters.
NO_PARTICIPANT_REMAINS - Static variable in class com.avaya.collaboration.call.CallTerminationPolicy: The call will be terminated when the last party in the call leaves.
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

objectChanged(Object, Object) - Method in class com.avaya.zephyr.platform.dm.AbstractDMListener: Callback indicating that an attribute was changed.
OK - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode: Operation succeeded
OK - Static variable in class com.avaya.collaboration.eventing.EventingResultCode
ONE_PARTICIPANT_REMAINS - Static variable in class com.avaya.collaboration.call.CallTerminationPolicy: The call will be terminated when only a single party remains in the call.
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: Organization not found.
ORIGINATING - Static variable in class com.avaya.collaboration.call.ParticipantState: The participant is making a call.
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
OutgoingMessageListener - Interface in com.avaya.collaboration.call.sip: OutgoingMessageListener allows a service to be informed of SIP messages going to Participants.
OutgoingSipMessageListener - Interface in com.avaya.collaboration.call.sip: Listener interface through which the service is informed of SIP messages going to a Participant.
OutgoingSipMessageListenerAbstract - Class in com.avaya.collaboration.call.sip: Abstract listener class through which the service is informed of SIP message going to a Participant.
OutgoingSipMessageListenerAbstract() - Constructor for class com.avaya.collaboration.call.sip.OutgoingSipMessageListenerAbstract

P

Participant - Interface in com.avaya.collaboration.call: Each party in the call (e.g., calling party, called party) is represented by a Participant.
PARTICIPANT_DROPPED - Static variable in class com.avaya.collaboration.call.CallTerminationCause: The participant left the call (the participant hung up).
PARTICIPANT_DROPPED - Static variable in class com.avaya.collaboration.call.media.RecordOperationCause: The record operation completed because the participant dropped or the call ended.
participantDropped(Call, Participant, CallTerminationCause) - Method in interface com.avaya.collaboration.call.CallListener: Indicates that a participant in Call dropped out of the call or was dropped from the call.
participantDropped(Call, Participant, CallTerminationCause) - Method in class com.avaya.collaboration.call.CallListenerAbstract: Indicates that a participant in Call dropped out of the call or was dropped from the call.
ParticipantFactory - Class in com.avaya.collaboration.call: Factory used to create a participant which would then be used to create a call, or which can then be added to a call.
ParticipantState - Class in com.avaya.collaboration.call: Indicates the state that a Participant currently has in a @link 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: Get information about a phrase.
play(Call, PlayItem, MediaListener) - Method in interface com.avaya.collaboration.call.media.MediaService: Play a list of audio sources to all the connected participants on a call, including a participant that connects while the source is playing.
play(Participant, PlayItem, MediaListener) - Method in interface com.avaya.collaboration.call.media.MediaService: Play a list of audio sources to a connected 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
PlayItem - Interface in com.avaya.collaboration.call.media: Provides methods to access or modify the properties related to a play operation.
PlayOperationCause - Class in com.avaya.collaboration.call.media: Enumeration of reasons with which play operation can get completed.
PreAnswerMediaState - Class in com.avaya.collaboration.call.media: Enumeration of SIP responses in early media phase.
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.

Q

querySubscriptions(SubscriptionSelectionFilter) - Method in interface com.avaya.collaboration.eventing.EventingService: Retrieve a list of subscriptions according to the given filter criteria.

R

record(Participant, RecordItem, MediaListener) - Method in interface com.avaya.collaboration.call.media.MediaService: Records the audio from a connected participant on a call.
recordCompleted(UUID, RecordOperationCause) - Method in interface com.avaya.collaboration.call.media.MediaListener: This is invoked when a record request has completed.
recordCompleted(UUID, RecordOperationCause) - Method in class com.avaya.collaboration.call.media.MediaListenerAbstract
RecordItem - Interface in com.avaya.collaboration.call.media: Provides methods to access or modify the properties related to a record operation.
RecordOperationCause - Class in com.avaya.collaboration.call.media: Enumeration of reasons with which record operation can get completed.
register(Object) - Static method in class com.avaya.collaboration.dal.factory.CollaborationDataFactory: Registers with the Avaya Breeze 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.
REJECTED - Static variable in class com.avaya.collaboration.call.CallTerminationCause: The called party rejected the call
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.
requestReceived(SipRequest, Map) - Method in interface com.avaya.collaboration.call.sip.IncomingSipMessageListener: Invoked when a SIP request has been received.
RESOURCE_ERROR - Static variable in class com.avaya.collaboration.eventing.EventingResultCode
responseReceived(SipResponse, Map) - Method in interface com.avaya.collaboration.call.sip.IncomingSipMessageListener: Invoked when a SIP response has been received.
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

SampleAbstractDMListener - Class in com.avaya.zephyr.platform.dm.sample: Sample code: Service attribute change listener
The code below illustrates how a service listener should be used to receive notifications for change in service attribute.
SampleAbstractDMListener() - Constructor for class com.avaya.zephyr.platform.dm.sample.SampleAbstractDMListener
SampleAuthorizationClient - Class in com.avaya.collaboration.authorization.sample: Sample code to get an access token using AuthorizationClientHelper.
SampleAuthorizationResource - Class in com.avaya.collaboration.authorization.sample: Sample code to validate an access token and retrieve scopes.
SampleCallableService - Class in com.avaya.collaboration.call.sample: Sample Code: Callable Service.
SampleCallableService() - Constructor for class com.avaya.collaboration.call.sample.SampleCallableService
SampleCBClient - Class in com.avaya.collaboration.bus.sample: Sample Collaboration Bus Client

NOTE: For use of Collaboration Bus in an Enterprise Java Bean, please see the section "Use Of Collaboration Bus in an Enterprise Java Bean" in the MessageReceiver.
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
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.
SampleHttp - Class in com.avaya.collaboration.http.sample: Sample code: Get Http/Https proxy settings (IP address and port).
SampleHttp() - Constructor for class com.avaya.collaboration.http.sample.SampleHttp
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.
SampleQuerySubscriptions - Class in com.avaya.collaboration.eventing.sample: Sample code: Query Subscriptions
The code below illustrates how an event consumer can query the Eventing Framework for subscriptions that it has created.
SampleSchedConf - Class in com.avaya.collaboration.conference.scheduled.sample: Sample code: Schedule a Conference.
SampleSendDigits - Class in com.avaya.collaboration.call.media.sample: Sample Code: Send digits to called party when call is answered
SampleSendDigits() - Constructor for class com.avaya.collaboration.call.media.sample.SampleSendDigits
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 using the platform's key store and trust store.
The code below illustrates how the SSL Util API SSLUtilityFactory is used to create and initialize SSLContext.
SampleSSLUtil() - Constructor for class com.avaya.collaboration.ssl.util.sample.SampleSSLUtil
SampleSSLUtilSetCertManagers - Class in com.avaya.collaboration.ssl.util.sample: Sample code: How to use the SSL Util API to set the Certificate keyManagers & trustManagers while creating an ssl connection.
The code below illustrates how the SSL Util API SSLUtilityFactory is used to set the Certificate KeyManagers and TrustManagers of the platform while creating an ssl connection.
SampleSSLUtilSetCertManagers() - Constructor for class com.avaya.collaboration.ssl.util.sample.SampleSSLUtilSetCertManagers
SampleUnifiedSpeechCall - Class in com.avaya.collaboration.call.speech.search.sample: Sample Code: Start a Speech Search on a call
SampleUnifiedSpeechCall() - Constructor for class com.avaya.collaboration.call.speech.search.sample.SampleUnifiedSpeechCall
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 Breeze 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 Breeze 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.
sendDigits(Participant, String, MediaListener) - Method in interface com.avaya.collaboration.call.media.MediaService: Sends digits (DTMF tones) to a participant on a call.
sendDigitsCompleted(UUID, SendDigitsOperationCause) - Method in interface com.avaya.collaboration.call.media.MediaListener: This is invoked when a send digits request gets completed.
sendDigitsCompleted(UUID, SendDigitsOperationCause) - Method in class com.avaya.collaboration.call.media.MediaListenerAbstract
SendDigitsOperationCause - Class in com.avaya.collaboration.call.media: Enumeration of reasons with which send digit operation can get completed.
sendingOut(SipRequest, Participant) - Method in interface com.avaya.collaboration.call.sip.OutgoingSipMessageListener: Indicates that request is about to be sent to targetParticipant.
sendingOut(SipResponse, Participant) - Method in interface com.avaya.collaboration.call.sip.OutgoingSipMessageListener: Indicates that response is about to be sent to targetParticipant.
sendingOut(SipResponse, Participant) - Method in class com.avaya.collaboration.call.sip.OutgoingSipMessageListenerAbstract: Indicates that response is about to be sent to targetParticipant.
sendingOut(SipRequest, Participant) - Method in interface com.avaya.collaboration.call.sip.SipMessageListener: Deprecated.

Indicates that request is about to be sent to targetParticipant.
sendingOut(SipResponse, Participant) - Method in interface com.avaya.collaboration.call.sip.SipMessageListener: Deprecated.

Indicates that response is about to be sent to targetParticipant.
sendingOut(SipResponse, Participant) - Method in class com.avaya.collaboration.call.sip.SipMessageListenerAbstract: Deprecated.

Indicates that response 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
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.
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: Deprecated.
Use Call.setAttribute(String, Serializable) instead. Store an attribute for later retrieval. If the attribute is not Serializable, it can only be stored by the service which created the call.
A service can get a reference to a call using CallFactory.getCall(String) or using the call passed to it in one of the callback methods (such as CallListenerAbstract.callAnswered(Call) ).
If an object of the same name is already bound to this Call, the object is replaced. This can be used by the service writer to hold some data that will be needed at a later point in the call.
setAttribute(String, Serializable) - Method in interface com.avaya.collaboration.call.Call: Store an attribute for later retrieval.
setCallTerminationPolicy(CallTerminationPolicy) - Method in interface com.avaya.collaboration.call.CallPolicies: Set the termination policy for this call.
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.
setConsumerName(String) - Method in interface com.avaya.collaboration.eventing.EventSubscriptionAttributes: (Optional) - Set the consumer name associated with this subscription.
setConsumerName(String) - Method in interface com.avaya.collaboration.eventing.SubscriptionSelectionFilter: (Optional) - Set the consumer name to filter against.
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.
setConsumerVersion(String) - Method in interface com.avaya.collaboration.eventing.SubscriptionSelectionFilter: (Optional) - Set the consumer version to filter against.
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: (Optional) - 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.
setEventType(String) - Method in interface com.avaya.collaboration.eventing.SubscriptionSelectionFilter: (Optional) - Set the event type to filter against.
setFamily(String) - Method in interface com.avaya.collaboration.eventing.SubscriptionSelectionFilter: (Optional) - Set the family to filter against.
setFileUri(String) - Method in interface com.avaya.collaboration.call.media.RecordItem: Sets the URI of the recorded wave file.
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.
setId(UUID) - Method in interface com.avaya.collaboration.call.speech.search.query.SearchQuery: Set the identifier for the search query.
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.
setMatchConsumerToUserViaServiceProfile() - Method in interface com.avaya.collaboration.eventing.EventSubscriptionAttributes: (Optional) - Set the "match consumer to user via service profile" option when subscribing.
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.
setMaxDuration(int) - Method in interface com.avaya.collaboration.call.media.RecordItem: (Optional) - sets the maximum duration of a record request in milliseconds.
setMaxParticipants(int) - Method in interface com.avaya.collaboration.conference.scheduled.SchedConf: (Optional) - Sets the number of conference participants.
setMediaServerInclusion(MediaServerInclusion) - Method in interface com.avaya.collaboration.call.CallPolicies: Set the Avaya Aura® Media Server inclusion policy for this call.
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.
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.
setPreAnswerMediaState(PreAnswerMediaState) - Method in interface com.avaya.collaboration.call.CallPolicies: Set the pre-answer media state for this call.
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.
setReplyTo(String) - Method in interface com.avaya.collaboration.email.EmailRequest: Set the replyTo.
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: (Optional) - Set the service profile to filter against.
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.
setSubscriptionId(String) - Method in interface com.avaya.collaboration.eventing.SubscriptionSelectionFilter: (Optional) - Set the subscription ID to filter against.
setTerminationKey(String) - Method in interface com.avaya.collaboration.call.media.DigitOptions: Sets the termination key that stops a digit collection operation.
setTerminationKey(String) - Method in interface com.avaya.collaboration.call.media.RecordItem: (Optional) - sets the termination key used to stop a record 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: (Optional) - 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.
setVoiceXMLScript(URI) - Method in interface com.avaya.collaboration.call.speech.voicexml.VoiceXMLDialogItem: Sets the URI of the source of the VoiceXML document.
shutdown() - Static method in class com.avaya.collaboration.authorization.client.AuthorizationClientHelper: Shuts down the helper library and releases any system resources associated with it.
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: Deprecated.
Use IncomingSipMessageListener or OutgoingSipMessageListener.
SipMessageListenerAbstract - Class in com.avaya.collaboration.call.sip: Deprecated.
Use IncomingSipMessageListener or OutgoingSipMessageListener.
SipMessageListenerAbstract() - Constructor for class com.avaya.collaboration.call.sip.SipMessageListenerAbstract: Deprecated.
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: Abstract listener class through which the service is informed of speech search events.
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.
SSLProtocolType - Class in com.avaya.collaboration.ssl.util: The supported SSL protocol types.
SSLUtilityException - Exception in com.avaya.collaboration.ssl.util: Exception used to indicate error conditions in the Avaya Breeze 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 an SSLContext with the platform's trust store and key store.
START_TIME_TOO_LATE - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode: The conference cannot be scheduled because the start time is too far in the future.
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 Avaya Aura® Media Server for a participant on an established call.
stop(Participant, UUID) - Method in interface com.avaya.collaboration.call.media.MediaService: Stops a current media operation for the participant.
stop(Call, UUID) - Method in interface com.avaya.collaboration.call.media.MediaService: Stops a current play operation that was started on the call.
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)
STOPPED - Static variable in class com.avaya.collaboration.call.media.RecordOperationCause: The record 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 Avaya Aura® Media Server using the search identifier.
stopVoiceXMLDialog(UUID) - Method in interface com.avaya.collaboration.call.speech.search.SpeechService: Stop the VoiceXML dialog on the Avaya Aura® Media Server using the dialog identifier
subscribe(EventSubscriptionAttributes) - Method in interface com.avaya.collaboration.eventing.EventingService: Subscribe for an event.
SUBSCRIBE_FOR_SUBSCRIPTIONS_IN_PROGRESS - Static variable in class com.avaya.collaboration.eventing.EventingResultCode
SubscriptionSelectionFilter - Interface in com.avaya.collaboration.eventing: A filter used to select subscriptions.
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: System failure encountered attempting to reach target.
SystemGlobalData - Interface in com.avaya.collaboration.businessdata.api: This interface provides methods to retrieve enterprise wide service independent data in the Avaya Breeze.
SystemStatus - Class in com.avaya.collaboration.util: Methods in this class are available to all services to obtain system status to "Check if the system is in overload", "Check if the system is in deny new service state", "Get the system CPU occupancy", "Get the system's platform version", "Get the SDK API version" , "Get the memory utilization" and "Get the current system status message"

T

TARGET_BLOCKED - Static variable in class com.avaya.collaboration.call.CallTerminationCause: Called target blocked call.
TARGET_BUSY - Static variable in class com.avaya.collaboration.call.CallTerminationCause: Called target was busy.
TARGET_DID_NOT_RESPOND - Static variable in class com.avaya.collaboration.call.CallTerminationCause: Called target did not respond.
TARGET_DOES_NOT_EXIST - Static variable in class com.avaya.collaboration.call.CallTerminationCause: Called target was not found.
TEMPORARILY_UNAVAILABLE - Static variable in class com.avaya.collaboration.call.CallTerminationCause: The called party rejected the call indicating it is temporarily unavailable.
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.
TERMINATION_KEY_PRESSED - Static variable in class com.avaya.collaboration.call.media.RecordOperationCause: The record operation was interrupted because the termination key was pressed.
TEST_MODE_ERROR - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode: An error occurred because the conference connector is configured for test mode.
TEXT_HTML - Static variable in class com.avaya.collaboration.email.ContentType: text/html
TEXT_PLAIN - Static variable in class com.avaya.collaboration.email.ContentType: text/plain
TEXT_RTF - Static variable in class com.avaya.collaboration.email.ContentType: text/rtf
TEXT_VCARD - Static variable in class com.avaya.collaboration.email.ContentType: text/x-vcard
TEXT_XML - Static variable in class com.avaya.collaboration.email.ContentType: text/xml
TheCallListener - Interface in com.avaya.collaboration.call: TheCallListener annotation allows a 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: Deprecated.
Extend SipMessageListenerAbstract or implement SipMessageListener instead.
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: Operation timed out.
TLS - Static variable in class com.avaya.collaboration.ssl.util.SSLProtocolType: TLS
TLSv1_2 - Static variable in class com.avaya.collaboration.ssl.util.SSLProtocolType: TLS 1.2
toString() - Method in exception com.avaya.collaboration.conference.scheduled.SchedConfException: Returns a String representation of this object.
toString() - Method in class com.avaya.collaboration.email.ContentType
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 error encountered.
UNEXPECTED_SERVER_RESPONSE - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode: Server returned an unexpected response.
UNRECOGNIZED_SERVER_ERROR - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode: Server returned an unrecognized error response.
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 Breeze.
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.CallTerminationPolicy
valueOf(String) - Static method in class com.avaya.collaboration.call.media.DigitCollectorOperationCause
valueOf(String) - Static method in class com.avaya.collaboration.call.media.MediaServerInclusion
valueOf(String) - Static method in class com.avaya.collaboration.call.media.PlayOperationCause
valueOf(String) - Static method in class com.avaya.collaboration.call.media.PreAnswerMediaState
valueOf(String) - Static method in class com.avaya.collaboration.call.media.RecordOperationCause
valueOf(String) - Static method in class com.avaya.collaboration.call.media.SendDigitsOperationCause
valueOf(String) - Static method in class com.avaya.collaboration.call.MediaType
valueOf(String) - Static method in class com.avaya.collaboration.call.ParticipantState
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.email.ContentType
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.CallTerminationPolicy
values() - Static method in class com.avaya.collaboration.call.media.DigitCollectorOperationCause
values() - Static method in class com.avaya.collaboration.call.media.MediaServerInclusion
values() - Static method in class com.avaya.collaboration.call.media.PlayOperationCause
values() - Static method in class com.avaya.collaboration.call.media.PreAnswerMediaState
values() - Static method in class com.avaya.collaboration.call.media.RecordOperationCause
values() - Static method in class com.avaya.collaboration.call.media.SendDigitsOperationCause
values() - Static method in class com.avaya.collaboration.call.MediaType
values() - Static method in class com.avaya.collaboration.call.ParticipantState
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.email.ContentType
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: Provides methods to access the URI of the VoiceXML dialog script.
VoiceXMLDialogListener - Interface in com.avaya.collaboration.call.speech.voicexml: Listener interface through which the service is informed of events in a VoiceXML dialog.
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.
wasServiceCalled() - Method in interface com.avaya.collaboration.call.Call: Returns true if the service was invoked as a Callable service, false if invoked as a Calling Party or Called Party service.
WORK_ASSIGNMENT - Static variable in class com.avaya.collaboration.data.api.AddressType: Work assignment address configured in System Manager

X

XML_PARSER_ERROR_ON_SERVER - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode: The conference service could not parse the XML that Avaya Breeze sent to it.
XML_UNMARSHALL_ERROR - Static variable in class com.avaya.collaboration.conference.scheduled.SchedConfResultCode: The XML in the response could not be unmarshalled.

A C D E F G H I L M N O P Q R S T U V W X