Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Avaya Conferencing Provider API
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.avaya.conferencing.api.acp.control
Class EndPoint

java.lang.Object
  extended by com.avaya.conferencing.api.acp.control.AbstractConferencingObject<EndPoint>
      extended by com.avaya.conferencing.api.acp.control.EndPoint
All Implemented Interfaces:
ConferencingObject<EndPoint>
public abstract class EndPoint
extends AbstractConferencingObject<EndPoint>

Represents an EndPoint that is connected to an Avaya Conferencing Provider, i.e. a caller into a conference call.

Since:
5.1.0.0.29

Nested Class Summary
static class EndPoint.DisconnectReason
          Reasons why an EndPoint has been disconnected.
static class EndPoint.QAPriority
          Priority of an EndPoint within the EndPointQueue with ConferencingObjectQueue.Purposes.QA_QUESTIONS.
 
Field Summary
static java.lang.String ACTIVE
          The property name for isActive().
static java.lang.String AUTHENTICATION
          The property name for getAuthentication().
static java.lang.String AUXILIARY_CODE
          The property name for getAuxiliaryCode().
static java.lang.String CALL_TYPE_DESCRIPTION
          The property name for getCallTypeDescription().
static java.lang.String CONFERENCE_START_TIME
          The property name for getConferenceStartTime().
static java.lang.String CUSTOM_FIELDS
          The property name for getCustomFields().
static java.lang.String DISCONNECT_REASON
          The property name for getDisconnectReason().
static java.lang.String FROM_DISPLAY
          The property name for getFromDisplay().
static java.lang.String FROM_NUMBER
          The property name for getFromNumber().
static java.lang.String FROM_URI
          The property name for getFromURI().
static java.lang.String HELP_QUEUE_JOIN_TIME
          The property name for getHelpQueueJoinTime().
static java.lang.String INCOMING_MEDIA_RESOURCE_POOL
          The property name for getIncomingMediaResourcePool()
static java.lang.String MESSAGE_SET
          The property name for getMessageSet().
static java.lang.String NAME
          The property name for getName().
static java.lang.String ORGANIZATION_NAME
          The property name for getOrganizationName().
static java.lang.String PARTICIPANT_CODE
          The property name for getParticipantCode().
static java.lang.String PIN
          The property name for getPin().
static java.lang.String QA_PRIORITY
          The property name for getQAPriority().
static java.lang.String SECURE_PARAMS_VALIDATED
          The property name for isSecureParamsValidated().
static java.lang.String SELF_IDENTIFICATION_CODE
          The property name for getSelfIdentificationCode().
static java.lang.String START_TIME
          The property name for getStartTime().
static java.lang.String TALKING
          The property name for isTalking().
static java.lang.String TO_NUMBER
          The property name for getToNumber().
static java.lang.String TO_URI
          The property name for getToURI().
static java.lang.String UNIQUE_PARTICIPANT_IDENTIFIER
          The property name for getUniqueParticipantIdentifier().
 
Fields inherited from class com.avaya.conferencing.api.acp.control.AbstractConferencingObject
VERBOSE_TO_STRING
 
Fields inherited from interface com.avaya.conferencing.api.acp.control.ConferencingObject
STATE
 
Constructor Summary
EndPoint()
           
 
Method Summary
abstract  void addDTMFListener(DTMFListener listener)
          Registers a DTMFListener with this EndPoint.
 CPEndPointAuthentication getAuthentication()
          Returns the CPAuthentication of this EndPoint.
 java.lang.String getAuxiliaryCode()
          Gets the auxiliary code associated with the EndPoint.
 java.lang.String getCallTypeDescription()
          Gets the description of the call type for the EndPoint.
 java.util.Date getConferenceStartTime()
          Gets the time when this EndPoint was placed in the current Conference or null if not currently in a Conference.
 java.util.List<java.lang.String> getCustomFields()
          Gets the custom fields associated with the EndPoint.
 EndPoint.DisconnectReason getDisconnectReason()
          Returns either null if the EndPoint is active or the reason why the EndPoint was disconnected.
 java.lang.String getFromDisplay()
          Gets the caller's (that is the EndPoint's) origin if present.
 java.lang.String getFromNumber()
          Gets the caller's (that is the EndPoint's) phone number if present.
 java.lang.String getFromURI()
          Gets the caller's (that is the EndPoint's) originating URI.
 java.util.Date getHelpQueueJoinTime()
          Gets the time when this EndPoint joined a help queue or null if the EndPoint is not in a help queue.
 MediaResourcePool getIncomingMediaResourcePool()
          Gets the MediaResourcePool that the EndPoint came in on.
 MessageSet getMessageSet()
          Gets the MessageSet associated with this EndPoint.
 java.lang.String getName()
          Gets the name associated with the EndPoint.
 java.lang.String getOrganizationName()
          Gets the company name associated with the EndPoint.
 java.lang.String getParticipantCode()
          Gets the participant code associated with the EndPoint or an empty string if no participant code has been associated with the EndPoint.
 java.lang.String getPin()
          Gets the PIN associated with the EndPoint.
 EndPoint.QAPriority getQAPriority()
          Gets the EndPoint.QAPriority associated with the EndPoint.
 java.lang.String getSelfIdentificationCode()
          Gets the self-identification code associated with the EndPoint or an empty string if either: no self-identification code has been associated with the EndPoint; or the self-identification feature is not supported by the ConferencingProvider.
 java.util.Date getStartTime()
          Gets the time when this EndPoint connected to the ConferencingProvider.
 java.lang.String getToNumber()
          Gets the callee's (that is the EndPoint's) phone number, that is the number dialled by the caller, also known as DNIS.
 java.lang.String getToURI()
          Gets the callee's (that is the EndPoint's) destination URI, that is URI that the caller connected to.
 java.lang.String getUniqueParticipantIdentifier()
          Returns the EndPoint's unique participant identifier
 boolean isActive()
          Returns true if the EndPoint is connected.
 boolean isSecureParamsValidated()
          Returns true if the EndPoint's unique participant identifier and secret PIN (if applicable) have been validated sucessfully.
 boolean isTalking()
          Returns true if the EndPoint is currently talking.
abstract  void removeDTMFListener(DTMFListener listener)
          Unregisters a DTMFListener from this EndPoint.
 
Methods inherited from class com.avaya.conferencing.api.acp.control.AbstractConferencingObject
equals, execute, getVerbs, hashCode, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.avaya.conferencing.api.acp.control.ConferencingObject
addAvailableVerbsChangeListener, addPropertyChangeListener, addPropertyChangeListener, addStateChangeListener, executeAs, getAllVerbs, getAllVerbsAs, getAllVerbsAs, getConnection, getId, getProperties, getProperties, getPropertyClass, getPropertyClasses, getPropertyType, getPropertyValue, getPropertyValues, getState, getVerbsAs, removeAvailableVerbsChangeListener, removePropertyChangeListener, removePropertyChangeListener, removeStateChangeListener
 

Field Detail

TALKING

public static final java.lang.String TALKING
The property name for isTalking().

Since:
5.1.0.0.29

NAME

public static final java.lang.String NAME
The property name for getName().

Since:
5.1.0.0.29

ORGANIZATION_NAME

public static final java.lang.String ORGANIZATION_NAME
The property name for getOrganizationName().

Since:
5.1.0.0.29

TO_NUMBER

public static final java.lang.String TO_NUMBER
The property name for getToNumber().

Since:
5.1.0.0.29

FROM_NUMBER

public static final java.lang.String FROM_NUMBER
The property name for getFromNumber().

Since:
5.1.0.0.29

FROM_DISPLAY

public static final java.lang.String FROM_DISPLAY
The property name for getFromDisplay().

Since:
5.1.0.0.34

TO_URI

public static final java.lang.String TO_URI
The property name for getToURI().

Since:
5.1.0.0.29

FROM_URI

public static final java.lang.String FROM_URI
The property name for getFromURI().

Since:
5.1.0.0.29

ACTIVE

public static final java.lang.String ACTIVE
The property name for isActive().

Since:
5.1.0.0.29

AUTHENTICATION

public static final java.lang.String AUTHENTICATION
The property name for getAuthentication().

Since:
5.1.0.0.29

HELP_QUEUE_JOIN_TIME

public static final java.lang.String HELP_QUEUE_JOIN_TIME
The property name for getHelpQueueJoinTime().

Since:
5.1.0.0.38

START_TIME

public static final java.lang.String START_TIME
The property name for getStartTime().

Since:
5.1.0.0.38

CONFERENCE_START_TIME

public static final java.lang.String CONFERENCE_START_TIME
The property name for getConferenceStartTime().

Since:
5.1.0.0.45

MESSAGE_SET

public static final java.lang.String MESSAGE_SET
The property name for getMessageSet().

Since:
5.1.0.0.34

CUSTOM_FIELDS

public static final java.lang.String CUSTOM_FIELDS
The property name for getCustomFields().

Since:
5.1.0.0.34

PARTICIPANT_CODE

public static final java.lang.String PARTICIPANT_CODE
The property name for getParticipantCode().

Since:
5.1.0.0.39

AUXILIARY_CODE

public static final java.lang.String AUXILIARY_CODE
The property name for getAuxiliaryCode().

Since:
5.1.0.0.39

PIN

public static final java.lang.String PIN
The property name for getPin().

Since:
5.1.0.0.39

SELF_IDENTIFICATION_CODE

public static final java.lang.String SELF_IDENTIFICATION_CODE
The property name for getSelfIdentificationCode().

Since:
5.1.0.0.39

DISCONNECT_REASON

public static final java.lang.String DISCONNECT_REASON
The property name for getDisconnectReason().

Since:
5.1.0.0.40

INCOMING_MEDIA_RESOURCE_POOL

public static final java.lang.String INCOMING_MEDIA_RESOURCE_POOL
The property name for getIncomingMediaResourcePool()

CALL_TYPE_DESCRIPTION

public static final java.lang.String CALL_TYPE_DESCRIPTION
The property name for getCallTypeDescription().

Since:
5.1.0.0.41

QA_PRIORITY

public static final java.lang.String QA_PRIORITY
The property name for getQAPriority().

Since:
5.1.0.0.41

UNIQUE_PARTICIPANT_IDENTIFIER

public static final java.lang.String UNIQUE_PARTICIPANT_IDENTIFIER
The property name for getUniqueParticipantIdentifier().

Since:
5.2.0.0.1

SECURE_PARAMS_VALIDATED

public static final java.lang.String SECURE_PARAMS_VALIDATED
The property name for isSecureParamsValidated().

Since:
5.2.0.0.1
Constructor Detail

EndPoint

public EndPoint()
Method Detail

addDTMFListener

public abstract void addDTMFListener(DTMFListener listener)
Registers a DTMFListener with this EndPoint.

Parameters:
listener - The listener.
Since:
5.1.0.0.29

getAuthentication

public final CPEndPointAuthentication getAuthentication()
Returns the CPAuthentication of this EndPoint.

Returns:
The CPAuthentication of this EndPoint.
Since:
5.1.0.0.29

getCustomFields

public final java.util.List<java.lang.String> getCustomFields()
Gets the custom fields associated with the EndPoint.

Returns:
the custom fields associated with the EndPoint.
Since:
5.1.0.0.34

getFromDisplay

public final java.lang.String getFromDisplay()
Gets the caller's (that is the EndPoint's) origin if present. Note: this is similar to getFromNumber() and getFromURI() but it can be modified using the ModifyDetails operation, while the other properties cannot.

Returns:
the caller's (that is the EndPoint's) phone number.
Since:
5.1.0.0.34
See Also:
getFromURI(), getFromNumber()

getFromNumber

public final java.lang.String getFromNumber()
Gets the caller's (that is the EndPoint's) phone number if present. Note: an EndPoint may not have a phone number, they will always have a URI.

Returns:
the caller's (that is the EndPoint's) phone number.
Since:
5.1.0.0.29
See Also:
getFromURI(), getFromDisplay()

getFromURI

public final java.lang.String getFromURI()
Gets the caller's (that is the EndPoint's) originating URI. The URI schemes returned by this method can include the following: The Connection.getSupportedURISchemes() method returns the complete list of URI schemes supported by the specific Connection.

Returns:
the caller's (that is the EndPoint's) originating URI.
Since:
5.1.0.0.29
See Also:
getFromNumber(), getFromDisplay()

getHelpQueueJoinTime

public final java.util.Date getHelpQueueJoinTime()
Gets the time when this EndPoint joined a help queue or null if the EndPoint is not in a help queue.

Returns:
The time when this EndPoint joined a help queue or null if the EndPoint is not in a help queue.
Since:
5.1.0.0.38

getMessageSet

public final MessageSet getMessageSet()
Gets the MessageSet associated with this EndPoint.

Returns:
The MessageSet associated with this EndPoint.
Since:
5.1.0.0.34

getName

public final java.lang.String getName()
Gets the name associated with the EndPoint.

Returns:
the name associated with the EndPoint.
Since:
5.1.0.0.29

getCallTypeDescription

public final java.lang.String getCallTypeDescription()
Gets the description of the call type for the EndPoint.

Returns:
the description of the call type for the EndPoint.
Since:
5.1.0.0.41

getPin

public final java.lang.String getPin()
Gets the PIN associated with the EndPoint.

Returns:
the PIN associated with the EndPoint.
Since:
5.1.0.0.39

getAuxiliaryCode

public final java.lang.String getAuxiliaryCode()
Gets the auxiliary code associated with the EndPoint.

Returns:
the auxiliary code associated with the EndPoint.
Since:
5.1.0.0.39

getQAPriority

public final EndPoint.QAPriority getQAPriority()
Gets the EndPoint.QAPriority associated with the EndPoint.

Returns:
the EndPoint.QAPriority associated with the EndPoint.
Since:
5.1.0.0.41

getParticipantCode

public final java.lang.String getParticipantCode()
Gets the participant code associated with the EndPoint or an empty string if no participant code has been associated with the EndPoint. If present, this will be either one of Conference.getConfereeCodes() or Conference.getModeratorCodes()

Returns:
the participant code associated with the EndPoint.
Since:
5.1.0.0.39

getSelfIdentificationCode

public final java.lang.String getSelfIdentificationCode()
Gets the self-identification code associated with the EndPoint or an empty string if either: no self-identification code has been associated with the EndPoint; or the self-identification feature is not supported by the ConferencingProvider.

Returns:
the the self identification code associated with the EndPoint.
Since:
5.1.0.0.39

getOrganizationName

public final java.lang.String getOrganizationName()
Gets the company name associated with the EndPoint.

Returns:
the company name associated with the EndPoint.
Since:
5.1.0.0.29

getStartTime

public final java.util.Date getStartTime()
Gets the time when this EndPoint connected to the ConferencingProvider.

Returns:
Gets the time when this EndPoint connected to the ConferencingProvider.
Since:
5.1.0.0.38

getConferenceStartTime

public final java.util.Date getConferenceStartTime()
Gets the time when this EndPoint was placed in the current Conference or null if not currently in a Conference.

Returns:
Gets the time when this EndPoint was placed in the current Conference or null if not currently in a Conference.
Since:
5.1.0.0.45

getToNumber

public final java.lang.String getToNumber()
Gets the callee's (that is the EndPoint's) phone number, that is the number dialled by the caller, also known as DNIS. Note: an EndPoint may not have connected to a phone number, they will always have connected to a URI.

Returns:
the callee's phone number, that is the number dialled by the caller, also known as DNIS.
Since:
5.1.0.0.29
See Also:
getToURI()

getToURI

public final java.lang.String getToURI()
Gets the callee's (that is the EndPoint's) destination URI, that is URI that the caller connected to. The URI schemes returned by this method can include the following:. The Connection.getSupportedURISchemes() method returns the complete list of URI schemes supported by the specific Connection.

Returns:
the callee's (that is the EndPoint's) destination URI, that is URI that the caller connected to.
Since:
5.1.0.0.29

isActive

public final boolean isActive()
Returns true if the EndPoint is connected.

Returns:
true if the EndPoint is connected.
Since:
5.1.0.0.29

getDisconnectReason

public final EndPoint.DisconnectReason getDisconnectReason()
Returns either null if the EndPoint is active or the reason why the EndPoint was disconnected.

Returns:
either null if the EndPoint is active or the reason why the EndPoint was disconnected.
Since:
5.1.0.0.40

isTalking

public final boolean isTalking()
Returns true if the EndPoint is currently talking.

Returns:
true if the EndPoint is currently talking.
Since:
5.1.0.0.29

getUniqueParticipantIdentifier

public final java.lang.String getUniqueParticipantIdentifier()
Returns the EndPoint's unique participant identifier

Returns:
the EndPoint's unique participant identifier.
Since:
5.2.0.0.1

isSecureParamsValidated

public final boolean isSecureParamsValidated()
Returns true if the EndPoint's unique participant identifier and secret PIN (if applicable) have been validated sucessfully.

Returns:
true if the EndPoint's unique participant identifier and secret PIN (if applicable) have been validated successfully.
Since:
5.2.0.0.1

getIncomingMediaResourcePool

public final MediaResourcePool getIncomingMediaResourcePool()
Gets the MediaResourcePool that the EndPoint came in on. If the call was an outgoing one, null is returned.

Returns:
either null, or the MediaResourcePool the EndPoint was established with.
Since:
5.1.0.0.41

removeDTMFListener

public abstract void removeDTMFListener(DTMFListener listener)
Unregisters a DTMFListener from this EndPoint.

Parameters:
listener - The listener.
Since:
5.1.0.0.29
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Avaya Conferencing Provider API
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2008-2009 Avaya. All Rights Reserved.