Avaya.ClientServices Namespace |
Class | Description | |
---|---|---|
AbstractShape |
Base class for shapes that can be drawn on WhiteboardSurface.
| |
AcceptCallRequestEventArgs |
Class representing a request incoming from the network to
accept an incoming video call with the specified video direction.
VideoMode | |
AcsConfiguration |
User Configuration information for ACS.
This class provides the configuration data that allows a connection and access to be made to an ACS Server
| |
ActiveParticipant |
Class representing active conference participant.
| |
AddContactEventArgs |
EventArgs used to inform about add contact operation result.
| |
AddressValidationResponse |
Interface for address validation response.
| |
AddressValidationWatcher |
A watcher class for monitoring "address validation" operations.
| |
AgentConfiguration |
User configuration information for the Agent service.
This class provides configuration and preference data for the agent service features.
| |
AgentErrorEventArgs |
Event arguments for agent errors.
| |
AgentException |
Represents the exception that is thrown on an Agent Service failure operations.
| |
AgentFeature |
Represents the contact center agent feature or the feature button administered on
the contact center solution.
| |
AgentFeatureInvocationResultWithButtonLampState |
Class used to inform about agent feature invocation result.
| |
AgentInformation | ||
AgentInformationEventArgs |
Represents agent information event arguments.
| |
AgentService |
The AgentService object is accessible from the User object,
providing access to agent features.
| |
AgentStateEventArgs |
Represents agent state event arguments.
| |
AgentWorkModeEventArgs |
Represents agent work mode event arguments.
| |
AllowedVideoDirectionChangedEventArgs |
The event argument representig new allowed video direction.
| |
AllRegistrationsFailureEventArgs | ||
AmmConfiguration |
User Configuration information for AMM.
This class provides the configuration data that allows a connection and access to be made to an AMM Server
| |
AsynchDataProgress |
Represents the message attachment asynchronous data progress.
| |
Attachment |
Attachment class is representing a message optional parameter. It can contain any file uploaded by sending participant.
| |
AudioConfiguration |
Represents the Audio data that is common for a Client.
| |
AudioDetails |
Audio-related details for a session.
| |
AudioMuteFailureEventArgs | ||
AudioMuteStatusChangedEventArgs | ||
Autodial |
The auto dial feature is used to store frequently used or important
numbers. When the button programmed for a given autodial number is
pressed, that stored number will be dialed.
| |
AutodialErrorEventArgs |
Event arguments for autodial errors.
| |
AvayaMessagingConfiguration |
User configuration information for Avaya Messaging provider.
This class provides the configuration data that allows a connection to
Avaya Messaging server.
| |
BaseContact |
Base class used as a common interface for read-only and editable contacts.
| |
BfcpConfiguration |
Represents the BFCP (Binary Floor Control Protocol) data that is common for a Client.
| |
BooleanEventArg | ||
BusyIndicator |
Represent busy indicator feature. An attendent can track busy or the idle status
of a destination extension. This object is provided with notification
whenever the status changes.
| |
ButtonCustomizationErrorEventArgs |
Event arguments for button customization errors.
| |
ButtonModuleService |
The ButtonModuleService object is accessible from the User object,
providing access to the button customization feature.
| |
Call |
The Call class is a facade object that may be used to represent a 2-party or
conference call. When a Call instance represents a 2-party call,
conference-related methods are unsupported.
The client application can use Conference property regardless of whether the call
is a point to point or a conference call. Calling conference operations on a normal
point to point call returns failure.
The Call also supports video control methods, which can be applied to either a
2-party or a conference call.
| |
CallCreationInfo | ||
CallEndedEventArgs |
The event arguments used to report conference call ended reason.
| |
CallEventArgs |
A class representing event arguments for a call.
Call | |
CallFailureEventArgs |
The event argument used to report point-to-point and conference call related errors to the application.
| |
CallFailureException |
Exception representing a call operation failure.
| |
CallFeatureService |
The CallFeatureService object is accessible from the User object,
providing access to additional business communication features.
| |
CallForwardingInformation |
Interface representing forwarding information of an incoming call.
Remarks The following provides an example of the History-Info header within SIP incoming message: ... History - Info: "Jane" sip:UserA@ims.example.com ? Reason = SIP3B cause 3D302 ; index = 1; foo = bar ... Where:
| |
CallForwardingStatus |
A base class used to implement CallForwardingStatus for Internal and External calls.
| |
CallLogItem |
Represents information about a call log item. Each call record is represented by CallLogItem object that
provides several attributes such as call start time, remote address, call duration, etc. In addition, each
CallLogItem may be associated with a Contact object which may be used to provide picture caller ID or
a customized name for the remote party of a call log item.
| |
CallLogOperationData |
Contains call log items used as an argument in Call Log Service operations.
| |
CallLogOperationStatusArgs |
Event argument related to Call Log Service completion handler
| |
CallLogParticipant |
This class represents information about remote party for a call log entry.
It contains remote address, remote number, display name and other information about called or calling user.
| |
CallLogService |
Call Log Service provides history entries for calls that have been made or received on the client.
| |
CallLogServiceEventArgs |
Class containing call log items that's used in CallLogService events handlers.
| |
CallPickupAlertEventArgs |
Event arguments for call pickup feature.
| |
CallPickupAlertStatus |
Enhanced call-pickup alert details.
| |
CallPrecedenceLevelChangedEventArgs |
The event arguments used to report change in precedence level of call.
| |
CallPreemptedEventArgs |
The event arguments used to send event when call is preempted.
| |
CallRecordingStateChangedEventArgs | ||
CallSecureIndicationChangedEventArgs |
Event arguments to report change in secure status of call.
| |
CallService |
The CallService object is accessible from the User object,
providing access to call related services and information.
| |
CancellableDataRetrieval |
Represents cancel of asynchronous data retrieval for the current operation.
| |
Capability |
A class representing whether a certain operation can be supported based on the current state of the object
upon which the action is taken. For instance, a Capability instance returned from a Conference object may
indicate whether the conference call can support muting of a selected participant, based on the participant
| |
CertificateExpiryEventArgs |
The event argument used to report the client identity certificate's expiration status to the application.
| |
CertificateManager |
Certificate manager class allows application developers to configure and make
use of the library's client/server certificate trust validation logic. It allows
specification of a client identity certificate, configure a private trust store
and perform certificate trust validation of all the connections, the application
is making on its own.
| |
CertificateStoreException |
Exception specifying the reasons of the client identity certificate
provisioning.
| |
CertificateValidationException |
Exception specifying the reason of certificate trust validation error.
| |
CesConfiguration |
User Configuration information for CES.
This class provides the configuration data that allows a connection and access to be made to an CES Server
| |
Challenge |
Challenge object for use with a CredentialProvider to determine which Credentials to use for authentication
| |
Chat |
The Chat object provides access to conference chat related capabilities and actions.
| |
ChatFailureEventArgs |
The event argument used to report chat related errors to the application.
| |
ChatMessage | ||
ChatMessageEventArgs | ||
Circle |
Circle objects represent circular shape that can be added to whiteboard surface.
| |
Client |
A Client is the primary interface to the Avaya Client Services library.
| |
ClientConfiguration |
Configuration data that is common for a Client.
| |
Collaboration |
The Collaboration object provides access to collaboration related capabilities and actions.
| |
CollaborationCapabilities |
The CollaborationCapabilities object provides access to collaboration capabilities.
| |
CollaborationContentSharingEventArgs | ||
CollaborationDetails | ||
CollaborationEventArgs | ||
CollaborationFailureEventArgs | ||
CollaborationLibrarySharingEventArgs | ||
CollaborationParticipantsEventArgs | ||
CollaborationReceiveStatistics | ||
CollaborationService |
The CollaborationService object provides service for creating and removing Collaboration objects.
| |
CollaborationStatistics | ||
CollaborationWhiteboardEventArgs | ||
Conference |
The Conference object is accessible from the Call object, and
provides access to conferencing related capabilities and actions.
| |
ConferenceConfiguration |
Class representing user Configuration information for a Conference.
This class provides the configuration data for Conferences and Collaboration
| |
ConferenceConnectionFailureEventArgs |
The event argument used to report conference connection related errors to the application.
| |
ConferenceEncryptionStatusEventArg |
An event argument used when reporting events related to the encryption status of a Conference object.
| |
ConferenceEndTimeEventArg |
An event argument used when reporting events related to the meeting end time of a Conference object.
| |
ConferenceMobileLink | ||
ConferenceMobileLinkConnectedEventArgs |
The event arguments to provide the connection details when mobile link successfully connected to the specific room system.
| |
ConferenceMobileLinkDiscoveryWatcher |
A watcher class for room system(s) discovery.
| |
ConferenceNewSlideEventArg | ||
ConferencePropertyEventArgs |
An event argument used when reporting events related to a Boolean property of a Conference object.
| |
ConferenceRecordingStatusEventArg |
An event argument used when reporting events related to the recording status of a Conference object.
| |
ConferenceRoomSystemInformation |
Class representing the conference room system information received from the conference server.
It is used to report the list of room system(s) that were discovered through the mobile
link discovery mechanism.
| |
ConferenceSlide | Unsupported:
Conference slide viewing is currently not supported. Class representing a slide that has been presented on a conference call. | |
ConferenceSlideViewer | Unsupported:
Conference slide viewing is currently not supported. The conference slide viewer allows a client application to view the list of slides shared during a conference call and subscribe to notifications of new slides. | |
ConferenceStatusChangedEventArgs | ||
ConferenceStreamingStatusEventArg |
An event argument used when reporting events related to the streaming status of a Conference object.
| |
ConnectionPolicy |
Defines the server connection policy used by an Identity.
| |
Contact |
Represents an immutable contact object which exposes all possible contact details. The contact object can also be used to subscribe for presence updates.
| |
ContactBoolField |
Represents a boolean field associated with a contact.
| |
ContactChangedEventArgs |
EventArgs used to inform about any changes that have occurred on particular contact object.
| |
ContactDoubleField |
Represents a double field associated with a contact.
| |
ContactEmailAddressField |
Represents an email address field associated with a contact.
| |
ContactEmailFieldList |
List of contact email addresses.
| |
ContactErrorEventArgs |
EventArgs used to inform about contact service operation error.
| |
ContactException |
Common exception for contact operations.
| |
ContactField |
Each field in a contact has a structure associated with it which describes where it came from and if it can
be modified. This is the base class for all the fields stored in the Contact object.
| |
ContactGroup |
Represents contact group object which exposes all possible contact group details.
It allows to add and remove contacts to/from group and update name of the group.
| |
ContactGroupRetrievalWatcher |
A watcher class for monitoring ContactGroup retrievals.
| |
ContactGroupsLoadingErrorEventArgs |
EventArgs used to report contact groups loading operation finish for single provider. This is triggered
for every configured provider and used for unsuccessful result.
| |
ContactIMAddressField |
Contact field which is storing IM address values and inherits the meta data description of the field.
| |
ContactIMAddressFieldList |
List of contact handles.
| |
ContactLimits |
This class defines current limits for various enterprise contact service operations supported by current provider.
| |
ContactListEventArgs |
EventArgs used for informing client about added or removed contacts.
| |
ContactMultiValueField<Avaya::ClientServices::ContactEmailAddressField ^> | ||
ContactMultiValueField<Avaya::ClientServices::ContactIMAddressField ^> | ||
ContactMultiValueField<Avaya::ClientServices::ContactPhoneField ^> | ||
ContactMultiValueField<Avaya::ClientServices::ContactStringField ^> | ||
ContactPhoneField |
Represents a phone number field associated with a contact.
Only one phone address can be default for a given contact.
| |
ContactPhoneFieldList |
List of contact phone numbers.
| |
ContactPresenceChangedEventArgs | ||
ContactRetrievalWatcher |
A watcher class for monitoring Contact retrievals.
| |
ContactSearchRequest |
Encapsulates search parameters for performing extended contact search.
| |
ContactService |
The ContactService object is accessible from the User object, and it
provides access to functionality associated with contacts.
| |
ContactServiceErrorEventArgs |
Provide the contact source type that the provider is responsible for
and the failure reason.
| |
ContactsLoadingErrorEventArgs |
EventArgs used to report contact loading operation finish for single provider. This is triggered
for every configured provider and used for unsuccessful result.
| |
ContactsLoadingEventArgs |
EventArgs used to report contact loading operation finish for single provider. This is triggered
for every configured provider and used for successful result.
| |
ContactsServiceFailedEventArgs |
EventArgs used to inform about failure of contact service operation.
| |
ContactStringField |
Represents a string field associated with a contact.
| |
ContactStringFieldList |
List of contact strings.
| |
ContentSharing |
The ContentSharing object provides access to content sharing related capabilities and actions.
| |
ContentSharingCanvas |
WPF Canvas for rendering ContentSharing.
| |
ContentSharingCapabilities | ||
ContentSharingCursorEventArgs | ||
ContentSharingEventArgs | ||
ContentSharingFrameEventArgs | ||
ContentSharingRectEventArgs | ||
ControllableEndpoint |
The details of a controllable endpoint for shared control.
| |
ControllableEndpointsUpdatedEventArgs |
Event arguments for the availability of controllable endpoints for shared control.
| |
ControllingEndpoint |
The details of a shared control controlling endpoint.
| |
Conversation |
Interface for all conversation related tasks and properties.
| |
ConversationRetrievalWatcher |
A watcher class for monitoring Conversation retrievals.
| |
ConversationTimeEventArgs |
Event argument provided to the event handlers registered for notifications of changes to any of the conversation's time-based properties.
| |
CrisisAlert |
This class represents the details about the crisis alert raised in the system.
| |
CustomizedButton |
The parameters that can be present in the a customized button.
| |
DataCollectionChangedEventArgsT |
The event argument used to indicate that the set of data items in a data collection has changed.
| |
DataRetrievalEventArgsT |
Event argument used to provide data retrieval progress updates.
| |
DataRetrievalWatcherT, E |
This class defines an interface that client applications use to perform data retrieval operations
for both static and dynamic collections of objects within the SDK.
| |
DataTransferOptionalParameters |
Set of optional parameters for DataTransferService.
| |
DataTransferResultArgs |
Set of additional values that are passed to DataTransferWithParametersCompletionHandler.
| |
DataTransferService |
The DataTransferService object provides a set of APIs that allow app
to transfer (download, update or remove) any files through a URL
securely including auto configure setting file, trust cert file, custom
logo file, etc.
| |
DataTransferServiceConfiguration |
User configuration information for data transfer service.
This class provides configuration and preference data for the data transfer service features.
| |
DataTransferServiceErrorEventArgs |
EventArgs used to inform about DataTransferService operation error.
| |
DialingRulesConfiguration |
The dialing rules configuration to be applied to transform
a user supplied number into a dialable number.
| |
DirectorySearchFailureEventArgs | ||
DownloadOptionalParameters |
Set of optional parameters for Download service.
| |
DownloadResultArgs |
Set of additional values that are passed to DownloadWithParametersCompletionHandler.
| |
DownloadService |
The DownloadService object provides a set of APIs that allow app to download
any files through a URL securely including auto configure setting file,
trust cert file, custom logo file, etc.
| |
DownloadServiceConfiguration |
User configuration information for the download service.
This class provides configuration and preference data for the download service features.
| |
DownloadServiceErrorEventArgs |
EventArgs used to inform about Download Service operation error.
| |
DownloadWatcher |
A watcher class for monitoring Download requests.
| |
DroppedParticipant |
Class representing dropped conference participant.
| |
Ec500Configuration |
User Configuration information for EC500 Feature Name Extensions (FNE's).
| |
EditableContact |
Mutable contact object which exposes all provided contact details.
| |
EditableContactBoolField |
The EditableContactBoolField class extends the ContactStringField class to provide the application with the ability to edit a String field in a contact.
The editable version of a contact field is obtained from the EditableContact class.
| |
EditableContactDoubleField |
The EditableContactDoubleField class extends the ContactStringField class to provide the application with the ability to edit a String field in a contact.
The editable version of a contact field is obtained from the EditableContact class.
| |
EditableContactEmailAddressField |
EditableContact field which is storing email address values and inherits the meta data description of the field.
| |
EditableContactEmailFieldList |
List of editable contact email addresses.
| |
EditableContactIMAddressField |
The EditableContactIMAddressField class extends the ContactStringField class to provide the application with the ability to edit a String field in a contact.
The editable version of a contact field is obtained from the EditableContact class.
| |
EditableContactIMAddressFieldList |
List of editable contact IM addresses.
| |
EditableContactMultiValueField<Avaya::ClientServices::EditableContactEmailAddressField ^> | ||
EditableContactMultiValueField<Avaya::ClientServices::EditableContactIMAddressField ^> | ||
EditableContactMultiValueField<Avaya::ClientServices::EditableContactPhoneField ^> | ||
EditableContactMultiValueField<Avaya::ClientServices::EditableContactStringField ^> | ||
EditableContactPhoneField |
The EditableContactPhoneField class extends the ContactStringField class to provide the application with the ability to edit a String field in a contact.
The editable version of a contact field is obtained from the EditableContact class.
| |
EditableContactPhoneFieldList |
List of editable contact phone numbers.
| |
EditableContactStringField |
The EditableContactStringField class extends the ContactStringField class to provide the application with the ability to edit a String field in a contact.
The editable version of a contact field is obtained from the EditableContact class.
| |
EditableContactStringFieldList |
List of editable contact strings.
| |
EnhancedCallForwardingFeatureEventArgs |
Event arguments for the Enhanced Call Forwarding feature.
| |
EnhancedCallForwardingStatus | ||
EnrollmentCredential |
Represents the enrollment credential that can be used to respond to an enrollment credential challenge.
| |
ExportChatEventArgs |
EventArgs used to inform about ExportChat/CancelExportChat operation result.
| |
ExportMessagingConversationEventArgs |
EventArgs used to inform about ExportMessagingConversation/CancelExportChat operation result.
| |
ExportService |
The ExportService object is accessible from the User object,
providing the ability to export conference chats and messaging conversations.
These conversations are exported in HTML format. Any attachments to these conversations are exported as well.
| |
ExtensionToggleFeatureEventArgs |
Event arguments for a feature that can be toggled between enabled and
disabled states and optionally applied to a destination extension.
| |
ExtraFieldKey |
Describes fields for local contacts that are available in ExtraFields parameter.
| |
ExtraPropertiesEventArgs |
A map of extra call properties the application may be interested in.
An event argument carrying the complete list of extra properties associated with the call.
| |
FeatureException |
The exception that is thrown on a call feature failure.
| |
FeatureInvocation |
Class to map a feature invocation response to a request.
| |
FeatureInvocationParameters |
The associated parameters for a feature invocation.
| |
FeatureLabelErrorEventArgs |
Event arguments for Feature label errors.
| |
FeatureParameters |
This is a union of the parameters of the FNU features.
The caller should know which parameters to populate for a specific feature.
| |
FeatureStatusEventArgs |
Represents associated arguments for an event of a call feature.
| |
FeatureStatusParameters |
The parameters that can be present in the status for any supported
feature.
| |
FeatureTypeEventArgs |
Represents feature type event arguments.
| |
ForwardingFeatureEventArgs |
Event arguments for a call forwarding feature.
| |
HIDButtonPressEventArg |
An event argument used when reporting events related to HID button presses.
| |
HIDDeviceConnectionStatusEventArgs |
Event arguments used when reporting connection status of the HID device.
| |
HIDService |
This service provides information about the Human Interface Device (HID)
devices connected to the machine, along with associated button presses
that are NOT automatically handled by the SDK.
| |
HttpClientConfiguration |
Represents the data that is common for a SIP Client.
| |
HttpUserConfiguration | ||
IntegerEventArgs | ||
IPOfficeConfiguration |
User Configuration information for IP Office.
This class provides the configuration data that allows a connection and access to be made to IP Office Server
| |
LdapConfiguration |
User Configuration information for LDAP.
This class provides the configuration data that allows a connection and access to be made to an LDAP Server
| |
LeaveConversationResponse |
Interface for leave conversation response.
| |
LeaveConversationsWatcher |
A watcher class for monitoring "leave conversation" operations.
| |
LibraryDocument | Unsupported:
The library sharing feature is currently not supported. Class that represents information about a document stored at a conferencing server library. | |
LibraryDocumentUploadEventArgs | ||
LibraryManager | Unsupported:
The library sharing feature is currently not supported. Interface that represents library management functions such as add, edit, remove documents from the document library. | |
LibraryManagerUploadProgress | ||
LibrarySharing | Unsupported:
The library sharing feature is currently not supported. Interface representing a set of methods the client application can invoke to share or receive shared document from a conference server supplied document library. | |
LibrarySharingDocumentEventArgs | ||
LibrarySharingPageContentEventArgs | ||
LineAppearance |
Represents line information configured on server.
| |
ListEventArgsT | ||
LocalContactConfiguration |
This class provides the User configuration data that connects user and local contacts
| |
LogMessageEventArgs |
Provides data for a LogMessage event.
| |
MaxSupportedVideoResolutionsCapability |
A class representing multi video resolution capabilities of the Client SDK .
| |
MediaConfiguration |
Media Configuration data.
| |
MeetingMinuteEventArgs | ||
MeetingMinutes | Unsupported:
The meeting minutes feature is currently not supported. | |
Message |
Interface for all Message related tasks and properties.
| |
MessageBodyPart |
The MessageBodyPart models SIP message body part. When there is a multi - part message, there can be more
than one message body part.
| |
MessageBodyPartEventArgs | ||
MessageDeliveryDetails |
This class defines delivery details of message.
| |
MessageListEventArgs |
EventArgs used for informing client about added or deleted messages.
| |
MessageRetrievalWatcher |
A watcher class for monitoring Message retrievals.
| |
MessageTimeEventArgs |
EventArgs used for additional information on LastModifiedDateChanged event.
| |
MessagingCancelEventArgs |
EventArgs used to inform that request with given id was cancelled.
| |
MessagingConfiguration |
User configuration information for the messaging service.
This class provides configuration and preference data for the messaging service features.
| |
MessagingConversationNumberEventArgs |
EventArgs used to notify that count of unreaded conversations has changed.
| |
MessagingFailureEventArgs |
EventArgs used to inform about particular error.
| |
MessagingLimits |
This class defines current limits for various messaging service operations.
| |
MessagingParticipant |
Interface for all messaging participant related tasks and properties.
| |
MessagingParticipantListEventArgs | ||
MessagingParticipantPhoneNumber |
Represents a participant's phone number.
| |
MessagingProviderConversationsEventArgs |
EventArgs used to notify about messaging provider type.
| |
MessagingProviderFailureEventArgs |
EventArgs used to notify about messaging provider type.
| |
MessagingProviderLimitsEventArgs |
EventArgs used to notify that messaging limits changed.
| |
MessagingProviderNumberEventArgs |
EventArgs used to notify about messaging provider type.
| |
MessagingProviderRemoveConversationEventArgs |
EventArgs used to notify about messaging provider type.
| |
MessagingProviderRoutableDomainsEventArgs |
EventArgs used to notify about messaging provider type.
| |
MessagingProviderTypeEventArgs |
EventArgs used to notify about messaging provider type.
| |
MessagingService |
The MessagingService object is accessible from the User object, and
provides access to messaging related capabilities and actions.
| |
MinuteMessage | Unsupported:
The meeting minutes feature is currently not supported. | |
OtherPhoneActivationFailureException |
Exception specifying the reasons of the why other phone service
activation/deactivation failed.
| |
OtherPhoneService |
This service provides the user with the ability to direct media to any other phone
(typically a cell phone/ home phone) while controlling signaling from the client.
Access to this service is provided by the OtherPhoneService property on the User class.
| |
OutboundSubscriptionConfiguration |
Represents data for Outbound Subscription.
| |
Participant |
Interface for all specific participant objects used in components i.e. Messaging, Call.
| |
ParticipantEventArgs |
An event argument used when reporting events related to a Call or Conference participant.
| |
ParticipantMediaEventArgs | ||
PendingParticipant | Unsupported:
The pending participant feature is currently not supported. The PendingParticipant class represents a participant pending to join the conference. | |
PendingParticipantCancelledEventArgs |
The event argument used to report pending participant actions related failures to the application.
| |
PpmConfiguration |
User Configuration information for PPM.
This class provides the configuration data that allows a connection and access to be made to a PPM Server
| |
Presence |
Presence information for a user.
| |
PresenceAccessControlList |
The class encapsulates presence access control list related features available to the user.
| |
PresenceAccessControlPolicyEventArgs |
The event argument used to report PresenceAccessControlListPolicy to the application.
| |
PresenceAccessControlRulesEventArgs |
The event argument used to report either list of users allowed to track local user's presence,
or list of users not allowed to track local user's presence.
| |
PresenceConfiguration |
User configuration information for the presence service.
This class provides configuration and preference data for the presence service features.
| |
PresenceEventArgs |
Event arguments for incoming presence events provided by the presence service.
| |
PresenceFailureEventArgs |
Event arguments for presence failures returned by the presence service.
| |
PresenceListSubscription |
An ad hoc presence list subscription.
| |
PresencePublishFailureEventArgs |
Event arguments for presence publish failures returned by the presence service events.
| |
PresenceService |
The class encapsulates all of presence related features available to the user.
| |
PresenceWatcher |
Class representing either a remote user who is already tracking local user's presence,
or a remote user who is asking for permission to track local user's presence.
| |
PresenceWatcherRequestEventArgs |
The event argument used to report either receipt
or cancellation of a request to track local user's presence.
| |
ProtocolEventArgs |
Represents signaling protocol related events.
| |
ProtocolException |
Exception representing a signaling protocol failure.
| |
QueueStatistics |
Queue statistics feature provides statistics about particular skill.
| |
RegistrationFailureEventArgs | ||
RegistrationGroup |
A group of signaling servers to register with simultaneously.
| |
ReloadRequestEventArgs | ||
RemoteAddressChangedEventArgs | ||
RemoteAlertingEventArgs | ||
RemoteControlSessionDisconnectEventArgs |
The event argument used when raising an event to signal that the shared control session connection with the ControllingEndpoint has been disconnected.
| |
RemoteControlSessionEventArgs |
Event arguments used for shared control session events related to a ControllingEndpoint.
| |
ResolveContactsRequest |
A request for Resolve Contacts searches.
| |
ResourceDiscoveryEventArgs | ||
ScepConfiguration | ||
SearchContactsWatcher |
A watcher class for Contact searches.
| |
SearchConversation |
Interface for conversation returned from MessagingService.SearchConversations operation.
| |
SearchConversationsWatcher |
A watcher class for monitoring Conversation search operations.
| |
SearchTerminalsRequest |
Encapsulates search parameters for performing terminals search.
| |
SearchTerminalsWatcher |
A watcher class for Terminal searches.
| |
SecurityPolicyConfiguration |
Configuration information for SecurityPolicyConfiguration.
This class provides configuration and preference data for Security Policies (i.e certificates)
| |
SelfContactEventArgs |
Event Args used for ContactService.SelfContact return result.
| |
SendSlideEventArgs | ||
ServerInfo |
Represents a generic server to communicate with.
| |
ServiceObservingErrorEventArgs |
Event arguments for reporting errors that occur during a service observing session.
| |
ServiceObservingEventArgs |
Represents event arguments for ServiceObservingEnabled event.
| |
ServiceObservingStatusParameters |
This class provides the details about the service observing feature parameters.
| |
ServiceStatus |
A class representing whether a certain service can be used based on the current status.
| |
SettingsFileParser |
Represents a parser that reads Avaya endpoint settings file format.
| |
Shape |
Shape objects represent free shape that can be added to whiteboard surface.
| |
SharedControlCompletionHandlerEventArgs |
Event arguments for shared control completion handler.
| |
SharedControlService |
This service provides the user with the ability to direct media to the Desk Phone (Hard Phone)
while issuing signaling commands from the Desk Phone and/or the client.
Access to the shared control service is provided by the SharedControlService property on the User class.
| |
SharedControlSessionConnectEventArgs |
The event argument used when raising an event to signal that the shared control session connection with the ControllableEndpoint has been established.
| |
SharedControlSessionEventArgs |
Event arguments used for shared control session events related to a ControllableEndpoint.
| |
SharingApplicationWindow | ||
SharingApplicationWindowStateChangedEventArgs | ||
SharingDisplay | ||
SignalingPingConfiguration |
Represents data for Ping Signaling.
| |
SignalingServer |
Represents a call (SIP) server to communicate with.
| |
SignalingServerEventArgs | ||
SignalingServerGroup |
A group of registration groups to register with individually.
| |
SignalingServerGroupEventArgs | ||
SipAgentConfiguration |
User Configuration information for SIP Agent Feature provider.
This class provides the configuration data that allows a connection and access to SIP contact center agent features.
| |
SipClientConfiguration |
Represents the data that is common for a SIP Client.
| |
SipUserConfiguration |
Configuration information for a SipSignalingEngine.
| |
Skill |
Represents agent's skill information.
| |
Slide | ||
SlideEventArgs | ||
Slider |
The Slider object provides access to slider-related actions.
| |
SliderSlide |
The SliderSlide object provides slide metadata and allows the download of related images.
| |
SliderSlidesEventArgs |
The event args used in Slider events.
| |
StartCallRequestEventArgs |
Class representing an incoming request to start a video call that is
already created by the Client SDK.
VideoMode | |
StatisticsData |
Represents VuStats statistics data gathered from the server.
| |
StatisticsDataEventArgs |
Represents received statistics data event arguments.
| |
StringEventArg | ||
StringEventArgs | ||
StringListEventArgs | ||
TeamButton |
Represents team button feature. A monitoring station can perform speed dial
or pick up a call on the monitoring extension. This object is provided with notification
whenever the status changes.
| |
TeamButtonIncomingCall |
Represents team button incoming call storing the caller/callee detains and
providing call pickup functionality.
| |
TeamButtonIncomingCallEventArgs |
Event arguments for the Team Button incoming calls updates.
| |
Terminal | ||
ToggleFeatureEventArgs |
Event arguments for a feature that can be toggled between enabled and
disabled states.
| |
TransferStatusEventArgs |
Event fired to report status of an in-progress transfer.
| |
UnifiedPortalConferencingConfiguration |
Conferencing configuration returned by Unified Portal.
| |
UnifiedPortalConfiguration |
Configuration information for Unified Portal.
This class provides the configuration data that allows a connection and access to be made to an Unified Portal Server.
| |
UnifiedPortalErrorEventArgs |
EventArgs used to inform about Unified Portal service operation error.
| |
UnifiedPortalMeetingInfo |
Meeting info returned by Unified Portal.
Shall be used to populate CallCreationInfo when creating HTTP Meet-me conference call.
| |
UnifiedPortalResources |
Resources returned by Unified Portal.
| |
UnifiedPortalService |
The UnifiedPortalService provides access to Unified Portal features.
| |
UpdateContactEventArgs |
EventArgs used to inform about changes on particular contact object.
| |
User |
Represents a user (an extension or user account) for which
various services and features can be provided by
the Avaya Client Services library.
| |
UserConfiguration |
Configuration information for a User.
| |
UserCreatedException |
Exception representing a create user failure.
| |
UserCredential |
Represents a user credential that can be used to respond to an authentication credential challenge.
| |
UserEventArgs | ||
UserToUserInformation |
User-to-User Information (UUI), known as call control UUI data, is
a small piece of data inserted by an application initiating the call and utilized by the application receiving the call.
The syntax and semantics for the UUI data used by a specific application
are defined by a UUI package.
| |
VideoChannel | ||
VideoChannelEventArgs | ||
VideoChannelFailureEventArgs | ||
VideoChannelReceiveStatusEventArgs |
A class representing a video channel's video receive status change.
| |
VideoChannelsEventArgs | ||
VideoChannelsFailureEventArgs | ||
VideoConfiguration |
Represents the video data that is common for a Client.
| |
VideoDetails |
Video-related details for a session.
| |
VideoLayoutEventArgs | ||
VideoLayoutsEventArgs | ||
VideoModeEventArgs | ||
VideoResolutionCapability |
Class representing the maximum resolution that can supported for
a video stream during a multi video stream conference call.
Different video streams will have a different maximum resolution
based on the capabilities of the conference server and the limitations
of local CPU/platform, and provisioned bandwidth and resolution settings.
| |
VideoResolutionPreferenceForMainVideoStreaming | ||
VideoResolutionPreferenceForMultiVideoStreaming |
Class representing a video resolution preference set by the
application for each video stream received during a multi-video stream
enabled conference call.
| |
VideoStatistics |
Video statistics for a call.
| |
VideoTransmitStatistics |
Transmitted video statistics for a session.
| |
VideoUserConfiguration |
User Configuration information for Video.
This class provides the configuration data associated between a user and video properties
| |
VirtualRoom |
Virtual room configured for user.
| |
VisualVoiceMailFailureEventArgs |
The event argument used to communicate visual voicemail errors to the application.
| |
VisualVoiceMailMessage |
An object representing a single voicemail message, with capabilities, properties and methods that allow the application to determine how to display and manipulate the voicemail message.
| |
VisualVoiceMailMessagesEventArgs |
The event argument used in notifications where multiple visual voicemail messages are involved.
| |
VisualVoiceMailRetrievalWatcher |
A watcher class for monitoring voicemail message retrievals.
| |
VisualVoiceMailService |
Represents the Visual Voicemail Service.
| |
VoiceMessagingService |
The VoiceMessagingService object is accessible from the User object,
providing voicemail status updates.
| |
VoiceMessagingStatus |
Voice messaging status parameters.
| |
VoiceMessagingStatusEventArgs |
Voice messaging parameters.
| |
WcsConfiguration |
User Configuration information for WCS.
This class provides the configuration data that allows a connection and access to be made to an WCS Server
| |
Whiteboard |
The Whiteboard object provides access to whiteboard related capabilities and actions.
| |
WhiteboardCanvas |
WPF Canvas for rendering ContentSharing.
| |
WhiteboardEventArgs | ||
WhiteboardShapeEventArgs | ||
WhiteboardSurface |
The WhiteboardSurface object represents an independent whiteboard surface (page) containing all shapes
drawn on a given whiteboard surface.
| |
WhiteboardText |
Text object represent text that can be added to WhiteboardSurface.
| |
WhiteboardUserEventArgs | ||
ZangConfiguration |
User Configuration information for Zang.
This class provides the configuration data that allows a connection and access to be made to an Zang Server
|
Structure | Description | |
---|---|---|
MessagingQuery |
Messaging query data.
This class provides data for the messaging service search.
|
Interface | Description | |
---|---|---|
BaseContactField |
A base class for all contact-related field classes which defines the common attributes for all field types.
| |
BaseContactMultiValueFieldT |
Interface for multi-value contact field. It must be defined in order to provide
information about capabilities when there aren't any items.
| |
ICredentialProvider |
Inteface used to represent a CredentialProvider.
A credential provider needs to know how to handle a Challenge and provide a Credential response.
| |
IEnrollmentCredentialProvider |
Interface used to represent a EnrollmentCredentialProvider.
An enrollment credential provider needs to know how to handle a Challenge and provide a Credential response.
|
Delegate | Description | |
---|---|---|
ActiveParticipantParticipantActionCompletionHandler |
Declare a delegate that handles the Participant request.
| |
AgentServiceAgentFeatureButtonLampCompletionHandler |
Declares a completion handler for asynchronous agent service operations.
| |
AgentServiceAgentServiceCompletionHandler |
Declares a completion handler for asynchronous agent service operations.
| |
AgentServiceSupervisorAssistCompletionHandler |
Declares a completion handler that handles the result of supervisor assistance request.
| |
AttachmentCompletionHandler |
Completion handler for asynchronous attachment operations.
| |
ButtonModuleServiceButtonCustomizationCompletionHandler |
Declares a completion handler that handles the result of button customization request.
| |
CallCallCompletionHandler |
Declare a delegate that handles the Call request.
| |
CallJoinStatusHandler |
Declares a completion handler that handles the result of a call join request.
| |
CallReadAudioDetailsCompletionHandler |
Declares a delegate used to report the status of a ReadAudioDetails request.
| |
CallReadVideoDetailsCompletionHandler |
Declares a delegate used to report the status of a ReadVideoDetails request.
| |
CallTransferStatusHandler |
Declares a completion handler that handles the result of the Call transfer request.
| |
CallFeatureServiceAutodialUpdateCompletionHandler |
Declares a completion handler that handles the result of an Autodial request.
| |
CallFeatureServiceFeatureCompletionHandler |
Declares a completion handler that handles the result of feature invocation requests.
| |
CallFeatureServiceFeatureLabelCompletionHandler |
Declares a completion handler that handles the result of setting personalized label request.
| |
CallLogServiceCallLogActionCompletionHandler |
Delegate for Call log action completion handler. CallLogOperationStatusArgs provides
the status of the operation as well as list of call log items relevant to the operation.
For delete operation, call log items reported in CallLogOperationStatusArgs reflects
those objects successfully deleted. These objects are identical objects used to make
delete request. As such, "equals" or "==" operation should result in correct match to those
objects managed by the client.
| |
CertificateManagerCertificateEnrollmentCompletionHandler |
A delegate method to be called upon completion of identity certificate enrollment.
| |
CertificateManagerCertificateValidatorCompletionHandler |
A delegate method to be called upon completion of certificate trust validation.
| |
ChatParticipantsCompletionHandler |
Declare a delegate that handles the GetChatParticipants request.
| |
ChatSendMessageCompletionHandler |
Declare a delegate that handles the chat message.
| |
ClientCreateUserCompletionHandler |
Declare a delegate that handles the CreateUser request.
| |
CollaborationCollaborationCompletionHandler |
Declare a delegate that handles the collaboration async operations.
| |
CollaborationGetParticipantsCompletionHandler |
Declare a delegate that handles the GetParticipants request.
| |
CollaborationReadCollaborationDetailsCompletionHandler |
Declare a delegate that handles the collaboration data.
| |
CollaborationReceivingSharingControlCompletionHandler |
Delegate used to report that receiving sharing control operation finished.
| |
CollaborationServiceCollaborationServiceCompletionHandler |
Declare a delegate that handles the Collaboration request.
| |
ConferenceConferenceActionCompletionHandler |
Defines the delegate used as the completion handler for requests on the Conference object.
| |
ConferenceConferenceActionCompletionHandlerWithStringResult |
Defines the delegate used as the completion handler for requests on the Conference object that return a string as the result.
| |
ConferenceMobileLinkMobileLinkActionCompletionHandler |
Declare a delegate that handles the mobile link action request.
| |
ConferenceSlideViewerConferenceSlideViewerSubscriptionCompletionHandler |
Declare a delegate that handles the slide viewer subscription request.
| |
ConferenceSlideViewerConferenceSlideViewerUnsubscriptionCompletionHandler |
Declare a delegate that handles the slide viewer unsubscription request.
| |
ContactContactPresenceCompletionHandler |
Delegate for Contact Presence completion handler.
| |
ContactRetrievePictureCompletionHandler |
Delegate for picture retrieval completion handler.
| |
ContactGroupContactGroupOperationCompletionHandler |
Delegate for contact group operations completion handler.
| |
ContactServiceAddContactCompletionHandler |
Defines the delegate used for the completion handler passed to the AddContact(EditableContact, ContactServiceAddContactCompletionHandler) method.
| |
ContactServiceContactActionCompletionHandler |
Defines the delegate used for the completion handler passed to methods on the Contact service
unless another delegate type is specified.
| |
ContactServiceCreateContactGroupCompletionHandler |
Defines the delegate used for the completion handler passed to the CreateContactGroup(String, HashSetContact, ContactServiceCreateContactGroupCompletionHandler) method.
| |
ContactServiceDeleteContactGroupCompletionHandler |
Defines the delegate used for the completion handler passed to the DeleteContactGroup(ContactGroup, ContactServiceDeleteContactGroupCompletionHandler) method.
| |
ContactServiceGetSelfContactCompletionHandler |
Defines the delegate used for the completion handler passed to the GetSelfContact(ContactServiceGetSelfContactCompletionHandler) method.
| |
ContactServiceUpdateContactCompletionHandler |
Defines the delegate used for the completion handler passed to the UpdateContact(EditableContact, ContactServiceUpdateContactCompletionHandler) method.
| |
ContentSharingContentSharingCompletionHandler |
Declare a delegate that handles the content sharing async operations.
| |
ContentSharingRemoteControlCompletionHandler |
Declare a delegate that handles the content sharing async operations.
| |
ContentSharingRemoteControlParticipantsCompletionHandler |
Delegate used to obtain participants that support remote control.
| |
ConversationAddParticipantAddressesCompletionHandler |
Completion handler for AddParticipantAddresses operation.
| |
ConversationCompletionHandler |
Completion handler for asynchronous conversation operations.
| |
CredentialCallback |
Callback to the requester with an UserCredential that can be used for authentication.
The UserCredential should be based on the Challenge used
| |
DataTransferServiceDataTransferCompletionHandler |
Declares a delegate used to report the result of a data transfer request.
| |
DataTransferServiceDataTransferWithDataCompletionHandlerT |
Declares a delegate used to report the result of a data transfer request with received data.
| |
DownloadServiceDownloadCompletionHandlerT |
Declares a delegate used to report the result of a Download request.
| |
DownloadServiceDownloadWithParametersCompletionHandlerT |
Declares a delegate used to report the result of a Download request with optional parameters.
| |
DroppedParticipantParticipantActionCompletionHandler |
Declare a delegate that handles the Dropped participant's request.
| |
EditableContactRetrievePictureCompletionHandler |
Delegate for picture retrieval completion handler.
| |
EnrollmentCredentialCallback |
Callback to the requester with an EnrollmentCredential that can be used for client identity certificate enrollment.
| |
ExportServiceExportChatCompletionHandler |
Defines the delegate used for the completion handler passed to the ExportChat(Conference, String, String, ExportServiceExportChatCompletionHandler) method.
| |
ExportServiceExportMessagingConversationCompletionHandler |
Defines the delegate used for the completion handler passed to the ExportMessagingConversation(Conversation, String, String, ExportServiceExportMessagingConversationCompletionHandler) method.
| |
LibraryManagerLibraryManagerCancelUploadDocumentHandler |
Declare a delegate that handles the CancelUploadDocument request.
| |
LibraryManagerLibraryManagerDeleteDocumentHandler |
Declare a delegate that handles the DeleteDocument request.
| |
LibraryManagerLibraryManagerGetContentHandler |
Declare a delegate that handles the GetContent request.
| |
LibraryManagerLibraryManagerGetDocumentHandler |
Declare a delegate that handles the GetDocument request.
| |
LibraryManagerLibraryManagerGetUploadDocumentProgressHandler |
Declare a delegate that handles the GetUploadDocumentProgress request.
| |
LibraryManagerLibraryManagerRenameDocumentHandler |
Declare a delegate that handles the RenameDocument request.
| |
LibraryManagerLibraryManagerUploadDocumentHandler |
Declare a delegate that handles the UploadDocument request.
| |
LibrarySharingLibrarySharingCompletionHandler | ||
MeetingMinutesMeetingMinutesCompletionHandler |
Declare a delegate that handles the meeting minutes message.
| |
MessageCompletionHandler |
Completion handler for asynchronous message operations.
| |
MessageMessageCompletionHandler |
Completion handler for asynchronous message operations.
| |
MessageMessageDeliveryDetailsCompletionHandler |
Completion handler for asynchronous message delivery details retrieval.
| |
MessagingParticipantRetrievePictureCompletionHandler |
Delegate for picture retrieval completion handler.
| |
MessagingServiceCompletionHandler |
Completion handler for asynchronous service operations.
| |
OtherPhoneServiceOtherPhoneServiceCompletionHandler |
Delegate for other phone number activation completion handler .
OtherPhoneActivationFailureException provides
the status of the operation.
| |
ParticipantSendMessageCompletionHandler |
Declares a delegate used to report the status of a request to send a chat message.
| |
PendingParticipantParticipantActionCompletionHandler |
Declare a delegate that handles the Pending participant's request.
| |
PresenceAccessControlListPresenceWatcherCompletionHandler |
Declare a delegate that handles the presence watcher request.
| |
SettingsFileParserGetSettingsFileVariable |
Declares a delegate that is called to get the value of a variable.
when it is not specified in the settings file.
| |
SettingsFileParserOnAdditionalSettingsFileRequested |
Declares a delegate that is called when an additional settings file is
requested.
| |
SettingsFileParserSetSettingsFileVariable |
Declares a delegate that is called to set the value of the variable.
| |
SharedControlServiceSharedControlActionCompletionHandler |
The completion handler that receives the result of a Shared Control request.
| |
SliderSlideFetchImageCompletionHandler |
Delegate used to return image data related to slide.
| |
TeamButtonFeatureCompletionHandler |
Declares a completion handler that handles the result of feature invocation requests.
| |
TeamButtonFeatureLabelCompletionHandler |
Declares a completion handler that handles the result of feature label update requests.
| |
TeamButtonIncomingCallFeatureCompletionHandler |
Declares a completion handler that handles the result of feature invocation requests.
| |
UnifiedPortalServiceGetPortalUserTokenCompletionHandler |
Declares a delegate used to report the status of a GetPortalUserToken request.
| |
UnifiedPortalServiceGetResourcesCompletionHandler |
Declares a delegate used to report the status of a GetResources request.
| |
UnifiedPortalServiceRequestToJoinMeetingCompletionHandler |
Declares a delegate used to report the status of a RequestJoinMeeting request.
| |
UnifiedPortalServiceSendClientInfoCompletionHandler |
Declares a delegate used to report the status of a SendClientInfo request.
| |
VisualVoiceMailMessageCompletionHandler |
Completion handler for asynchronous message operations.
| |
VisualVoiceMailServiceCompletionHandler | ||
WhiteboardWhiteboardCompletionHandler |
Declare a delegate that handles the whiteboard operations.
| |
WhiteboardSurfaceWhiteboardCompletionHandler |
Declare a delegate that handles the whiteboard operations.
Note that this delegate is different from WhiteboardCompletionHandler found in Whiteboard class.
| |
WhiteboardSurfaceWhiteboardSurfaceCompletionHandler |
Declare a delegate that handles the whiteboard surface operations.
|
Enumeration | Description | |
---|---|---|
AccessControlBehavior |
Enumeration that describes the types of the ACL - confirm policy handling.
| |
AcousticEchoCancelAlgorithm |
Definition of the supported Echo Cancellation Algorithms.
| |
AddressDigit |
Address digits for dialing in the off-hook state.
| |
AgentError |
AgentError represents different errors that may occur during an agent feature interaction
with the contact center solution.
| |
AgentFeatureType |
Defines the list of supported agent features. This enumeration is applicable for all of the features
supported by client services, not tailored based on capabilities provisioned for an agent in
the network (available features).
| |
AgentLogoutOverrideType |
Represents a policy indicating whether the agent will be forced to
log out at a certain time or the agent is overriding the forced logout.
| |
AgentState |
All supported agent states for contact center solution agent.
| |
AgentWorkMode |
All supported agent work modes for contact center solution agent.
Agent work mode are used by client application to change agent work mode.
Unlike AgentState which is used only for representing state (not used for changing
state or work mode)
| |
AlertType |
Incoming call alert types.
| |
AllowedVideoDirection |
Enumeration of different allowed video directions that can be used
by the local application for a call session.
| |
AttachmentStatus |
Represents the message attachment status.
| |
AuthenticationMethod | ||
AutodialError |
Errors generated for autodial operations.
| |
BfcpMode |
Definition of BfcpMode.
| |
ButtonCustomizationError |
Errors generated while adding, removing, moving or
setting personalized label for customized button.
| |
ButtonCustomizationPolicy |
Enumeration indicating whether the application supports button customization.
Own / Bridged Call Line Appearances, SIP Telephony Features (including Auto Dial feature),
Agent Features, etc are a few examples of "buttons" configured for a user on CM / SMGR,
that can be customized w.r.t. visual location on the button module, label representing the button, etc.
| |
ButtonLampState |
All supported button lamp state.
| |
ButtonType | ||
CallDenialPolicy |
Enumeration that describes call denial policy.
| |
CallEndReason |
The event arguments provide call end reason.
| |
CallError |
Point-to-point and conference call related error codes.
These error codes are reported upon failure of a call related operation.
| |
CallForwardingCause |
Enum represents call forward causes
| |
CallLogAddressSourceType |
Describes the source type of the remote user's address.
For example, the remote address was provided by the client or
by the network or if the remote address represents a
conference participant.
| |
CallLogItemActionType |
Describes the action type that generated the call log item or
the call log event.
| |
CallLogItemReadStatus |
Describes the read status of call log item
| |
CallLogItemSourceType |
Describes the media source type of the call log.
| |
CallLogOperationStatus |
Enumeration that indicates success or failure of an operation performed by the CallLogService.
| |
CallPrecedenceLevel |
Call Precedence Level
DoD(Department of defence) UC networks support Precedence - Based Assured Services(PBAS) for delivery of UC services.
Connections and resources that belong to a call from a user are marked with a precedence level
and domain identifier and can only be preempted by calls of higher precedence from users in the same service domain.
Precedence provides for preferred handling of PBAS service requests.PBAS involves assigning and validating priority
levels to calls, and prioritized treatment of service requests.
There are five precedence levels; from lowest to highest
they are ROUTINE, PRIORITY, IMMEDIATE, FLASH, and FLASH OVERRIDE.
Maximum precedence level of a user is set at the subscription time by the UC network administrator
based on the user’s validated need.When initiating a session, the user may select a precedence level
up to and including the maximum authorized precedence level for that user, on a per call basis.
The network at the user's originating interface ensures that the selected precedence level
does not exceed the maximum level assigned to that extension.
When JITC Multilevel call precedence and preemption(MLPP) is enabled at server, A call will
default automatically to the ROUTINE precedence unless a higher precedence is dialed.
| |
CallPreemptionReason |
Call Preemption reasons based on Reason Header for Preemption Events(RFC 4411) - IETF
and Department of Defense Unified Capabilities Requirements 2013.
Call preemption occurs when a precedence call is sent to a preemptable endpoint
that is busy with a call of lower precedence and has no idle appearances.
This causes the lower precedence call to be preempted, regardless of whether
the lower precedence call and the new higher precedence call are of the same media type.
When preemption occurs, the active busy user receive a continuous preemption tone until user
acknowledges the preemption by invoking complete preemption method and the other party receives
a preemption tone for a minimum of 3 seconds.
After acknowledging the preemption, the extension to which the precedence call is directed will
be provided with precedence ringing and the calling party will receive an audible ring - back
precedence tone.
Preemption may take one of two forms.
First, the called party may be busy with a lower precedence call that is preempted
in favor of completing the higher precedence call from the calling party.
Second, the network resources may be busy with calls; some of which are of lower
precedence than the call requested by the calling party.One or more of these lower
precedence calls are preempted in order to complete the higher precedence call
| |
CallRecordingActionType |
Describes the Call Recording action types.
| |
CallRecordingState | ||
CallState |
The state of a call.
| |
CallType |
Definition of the supported call types.
| |
CameraControl | ||
CapabilityDenialReason |
Capability denial reason codes. Returned in CapabilityInfo object when
a queried capability is not supported.
| |
CertificateEnrollmentResult |
Certificate enrollment related error codes.
| |
CertificateStoreResult |
Certificate store related error codes.
| |
CertificateValidationResult |
Certificate validation related error codes.
| |
ChallengeAuthorizationMethod | ||
ChatError |
Chat related error codes.
| |
ChatMessageStatus |
Represents possible states for a chat message.
| |
CollaborationContentSharingMode |
Collaboration content sharing mode.
| |
CollaborationRenderType |
Defines the different types of collaboration renderer that the client application
needs to create to display collaboration content.
| |
CollaborationStatus | ||
ConferenceConnectionError |
Conference connection related error codes.
These error codes are reported upon failure of a conference connection.
| |
ConferenceEncryptionStatus | ||
ConferenceMobileLinkConnectionStatus | ||
ConferenceRecordingStatus | ||
ConferenceRoomSystemStatus |
Enumeration representing conferencing room system's status.
| |
ConferenceStreamingStatus | ||
ContactEmailAddressType |
Describes the type associated with the email address.
| |
ContactError |
Error codes related to contact operations.
| |
ContactPhoneNumberType |
Defines the types of phone numbers that can be associated with a contact.
| |
ContactServiceFailureReason |
Reasons of failure for contact service operations.
| |
ContactSourceType |
Determines source types for contacts.
| |
ConversationStatus |
Represents the server reconciled status of the conversation.
| |
ConversationType |
Represents the conversation type.
| |
DataCollectionChangeType |
The type of change that has occurred in a data collection.
| |
DataRetrievalStatus |
Describes the status of a data retrieval operation.
| |
DataSharingMode |
Data sharing mode.
| |
DataTransferServiceError |
Error codes related to DataTransferService operations.
| |
DenialReason |
The reason for the denial of an incoming call.
| |
DirectorySearchError | ||
DownloadServiceError |
Error codes related to Download Service operations.
| |
DtmfTone |
DTMF tone types.
| |
etSharingApplicationWindowState | ||
ExportStatus |
Export service progress status
| |
FailbackPolicy |
Defines how failing back to a server with a higher priority than the
current server is handled.
| |
FeatureAction |
The feature actions that can be used when invoking a feature.
| |
FeatureFailureReason |
The reason for a call feature failure.
| |
FeatureLabelError |
Errors generated for setting personalized label.
| |
FeatureStatus |
The available feature status values.
| |
FeatureType |
Supported call feature types.
| |
ForwardingOverride |
Specifies whether the forwarding destination of monitored station will be
ignored by Team Button speed dial invocation if any of forwarding features is
enabled on the monitored station.
| |
HIDButtonType | ||
HIDDeviceConnectionStatus | ||
IncomingVideoStatus |
Status of video for an incoming call.
| |
JoinStatus |
Join status.
| |
Layer2PriorityMarking | ||
LdapDirectoryType |
Directory type.
| |
LdapScopeType |
Scope of the LDAP search.
| |
LibraryDocumentType | ||
LibraryManagerUploadProgressDocumentUploadProgressType | ||
LocalizedStringIdentifier |
Export service localized string identifiers.
In the exported HTML file, there are certain strings that can be localized, depending on the language set in the App.
Application can use ExportService.SetLocalizedStrings() to pass the localized strings to Client SDK.
The Client SDK uses the strings corresponding to the identifiers in the exported HTML.
| |
LogLevel |
Log levels used by Avaya Client Services.
| |
MediaAddressMode |
Enum indicating the IP address type preference to use when negotiating media
streams when the client connects to dual stack server from a dual stack
client network.
| |
MediaDirection |
Supported media(audio, video) directions.
| |
MediaEncryptionType |
Supported media encryption types.
| |
MediaTransportPreference |
The list of Media Transport network preferences.
This structure provides a list of choices based on the network type preference.A feature(i.e.VoIP calls, or video)
can be enabled based on network connectivity.
It is necessary to allow a feature to be enabled based on the preference of network connectivity.
All transports(enabled) and No Media(disabled) are independent of network type.
The Wifi only state is included to indicate that the feature enablement is dependent on wifi connectivity.
| |
MeetingMediaType |
Meeting media types.
| |
MessageDeliveryState |
Represents delivery state of a message.
| |
MessageImportance |
Represents the message importance.
| |
MessageReadState |
Represents read state of a message.
| |
MessageStatus |
Represents the state of a message.
| |
MessageType |
Describes the possible types of messages that can be included in a conversation.
| |
MessagingDisplayOrder |
Represents the order in which participant full name
is generated ("FirstName LastName" or "LastName FirstName").
| |
MessagingError |
Error types for messaging component.
| |
MessagingParticipantPhoneNumberType |
Represents the type of phone number.
| |
MessagingParticipantSourceType |
Represents the messaging source that the participant comes from.
| |
MessagingParticipantType |
Represents the participant type.
| |
MessagingProviderType |
Enumeration representing messaging provider types.
| |
MessagingReasonType |
Provides additional reason information for the Left and Closed message types.
| |
MinuteStatus |
States for a meeting minute message in a conference.
| |
MinuteType |
Enum of minute types.
| |
MissedCallReason |
Enum represents missed call reason types.
| |
Modality |
Represents the modality of MessagingParticipant.
| |
OpusFormatProfile |
Definition of Avaya recommended profiles for OPUS codec.
| |
OtherPhoneServiceError |
Other phone service related error codes.
| |
OverloadStatus | ||
ParticipantConnectionStatus | ||
ParticipantMediaStatus |
The status of participant media known by conference server.
This status indicates what was negotiated between participant and conference server.
The status could be changed if participant updates media by executing any network operation.
For example local audio(microphone) mute will not affect participant audio status, if it is not reported to the conference server.
| |
PendingLogoutReason |
Represents the policies used to describe the use of reason codes for pending logout.
| |
PendingParticipantAdmissionCancellationReasonCode |
Admission request cancellation codes.
| |
PresenceAccessControlListPolicy |
Enumeration that describes different access control list policies.
| |
PresenceError |
Enumeration representing failure of a presence operation, for example, a failed presence request sent to the presence server.
| |
PresenceLocationMode |
Enumeration representing the location-based "mode" of a user.
| |
PresenceOptions |
Optional elements of a presence object.
Presence information of a user may or may not include manually specified presence state,
location mode and a note.
| |
PresenceState |
Enumeration representing presence state of a user.
| |
ProviderSourceType |
This enumeration is used to indicate where the data in each field in the contact object came from.
| |
ProxyMode | ||
ReasonCodeLength |
Represents the policy used to describe the length of reason codes
used by agents for logout and work mode change operations.
| |
ReasonCodeMode |
Represents the policies used to describe the use of reason codes for various agent operations.
| |
RecipientMessageState |
Represents delivery state of a message at the individual chat participant (i.e.recipient) level.
| |
RefreshType |
Enumeration representing messaging polling refresh modes.
| |
RegistrationError |
User registration related errors.
| |
ReloadRequestType |
The type of a data reload request.
| |
ResolveContactsScopeType |
Type of scope used for ContactService.ResolveContacts(ResolveContactsRequest ^) method.
| |
ResourceDiscoveryItemType |
Identifies the type of a discovered resource item that is of interest to the client application.
These items are received from a connected server as part of a registration response or through
a resource discovery process.
| |
RingPattern |
The ring pattern for enhanced call-pickup alert.
| |
RingType |
The ring type for enhanced call-pickup alert.
| |
SearchScopeType |
Type of scope used for ContactService.SearchContacts(SearchContactsWatcher ^,System::String ^,SearchScopeType,SearchSourceType,uint32_t,uint32_t) method.
| |
SearchSourceType |
Type of source used for ContactService.SearchContacts(SearchContactsWatcher ^,String ^,SearchScopeType,SearchSourceType,uint32_t,uint32_t) method.
| |
SecurityPolicy |
Security policy configuration for certificate revocation.
| |
SensitivityLevel |
Represents the sensitivity of the conversation.
| |
ServiceObservingError |
Codes for errors that may occur during a service observing feature interaction.
| |
ServiceObservingMode |
All supported service observing mode.
| |
ServiceObservingType |
The service observing modes a supervisor may choose to use in order to monitor handling of a customer call by an agent.
| |
ServiceStatusDisabledReasons |
Service disabled reason codes. Returned in ServiceStatus object when
a queried service is not enabled.
| |
ShapeStatus |
Enum indicating selection status of AbstractShape on the server side, in other
words, if our action is confirmed by server.
| |
SharedControlDisconnectReason |
Enumeration describing possible reasons for shared control link disconnection.
| |
SignalingAddressMode | ||
SignalingEnvironment |
The SignalingEnvironment defines how the connections to the server(s)
are established and recovered after failures.
| |
StatisticsDataResourceType |
Statistics data resource type.
| |
SupervisorCallType |
Supervisor call type.
| |
TLSProtocolVersion |
Configure the following TLS version.
| |
TransferStatus |
The status of an in-progress transfer.
| |
TransportType |
Transport type to use for a connection to a signaling server.
| |
TrustStoreMode |
Configuration specifying the type of trust store to be used for certificate validation.
| |
UnifiedPortalError |
Error codes related to Unified Portal operations.
| |
UserCreatedFailureReason |
The reason for a user failure.
| |
VideoDisabledReason | ||
VideoLayoutType |
Enumeration of all of the video layouts supported during a conference call.
Local user can select from any of these layouts to effect the video image rendered on the client.
With the exception of Dynamic, the rest of the layout options allow user
to specify a fixed layout of the video rendered on the local client.
When the layout is set to be dynamic, the conference server updates the layout of the rendered
video automatically.
The list of actual video layouts available may change dynamically while on a call,
dependent on the capabilities of the conferencing system, number of video participants
on a call, and whether local user is a lecturer or not.
The integers provided with each layout below represent indices of different video
windows (a.k.a., sub-frame), as recognized by the conferencing system. These video window
ids can be used to pin a participant's video.
| |
VideoMode |
Enumeration of different video modes that can be requested
by the local application for a call session.
| |
VideoResolutionForMainVideoStreaming | ||
VideoResolutionForMultiVideoStreaming |
Enumeration of video resolutions supported for multi video streaming
conference calls.
| |
VisualVoiceMailError |
Error types for visual voicemail component.
| |
VisualVoiceMailFileDownloadStatus |
Visual voicemail audio file download status.
| |
WhiteboardTool |
Indicates current tool for Whiteboard.
|