Avaya Breeze?
Version 3.2 API

Avaya Breeze?
Version 3.2 API Specification

This document is the API specification for version 3.2 of the Avaya Breeze.

See: Description

Packages 
Package Description
com.avaya.collaboration.authorization
Provides Authorization Helper API classes to retrieve access tokens and validate them.
com.avaya.collaboration.authorization.client
Helper APIs to aid Authorization Clients to obtain access tokens from Authorization Service.
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
Provides sample code which uses Authorization Helper APIs.
com.avaya.collaboration.bus
The Collaboration Bus is used to send and receive messages between services.
com.avaya.collaboration.bus.factory
Factory to create Collaboration Bus objects.
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
Attributes, Licensing, and the Avaya Breeze Service Archive (.svar) properties File
com.avaya.collaboration.call
Provides classes and interfaces for dealing with call.
com.avaya.collaboration.call.media
Provides classes and interfaces for bringing media to call.
com.avaya.collaboration.call.media.sample
Example code that illustrates how to use media operations and the media listener.
com.avaya.collaboration.call.sample
Sample call listener code for callable service.
com.avaya.collaboration.call.sip
Provides classes and interfaces for doing SIP header manipulation.
com.avaya.collaboration.call.speech.search
Provides classes and interfaces for starting speech search on a call.
com.avaya.collaboration.call.speech.search.exception
Exceptions specific to speech search operations.
com.avaya.collaboration.call.speech.search.match
Report a match on a speech search.
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
These are the operators available for a speech search query.
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
Provides classes and interfaces for starting voice XML dialog on a call.
com.avaya.collaboration.call.speech.voicexml.sample
Example code that illustrates how to run a VoiceXML dialog.
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
Provides example code for use of the Scheduled Conference API.
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
Factory that supplies various data access objects.
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
Provides examples for using the user data API.
com.avaya.collaboration.email
Provides an API useful for sending an email.
com.avaya.collaboration.email.sample
Provides examples for using the Email API.
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
Provides constants, grouped by event family, that are useful for handling events.
com.avaya.collaboration.eventing.sample
Provides example code for use of the Eventing Framework API.
com.avaya.collaboration.http
Provides an API useful for retrieving http/https proxy settings.
com.avaya.collaboration.http.sample
Provides examples for using the Http API.
com.avaya.collaboration.service
Provides class and interface for injecting service life cycle (initialize/destroy of service) callbacks.
com.avaya.collaboration.service.activity
Provides an API useful for recording service activity.
com.avaya.collaboration.service.activity.sample
Provides an example for using ServiceActivityData API
com.avaya.collaboration.sms
Provides an API useful for sending SMS messages.
com.avaya.collaboration.sms.sample
Provides examples for using the SMS API.
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
Sample code snippet that illustrates the use of SSLUtility API.
com.avaya.collaboration.util
Contains general purpose utility classes and interfaces.
com.avaya.collaboration.util.logger
Provides the Collaboration Logger class.
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
Provides classes that allow a service to be notified of changes to service attribute values.
com.avaya.zephyr.platform.dm.sample
Provides example code showing the use of AbstractDmListener to receive service attribute change notifications.
Avaya Breeze?
Version 3.2 API

Copyright © 2016 Avaya. All Rights Reserved.