Call (Avaya Aura(R) Collaboration Environment API)

```
public interface Call
```
Represents a call, or session, for providing operations like allow, drop, or divertTo, and to change display names/addresses presented to the parties in a call. Note that the call, or session, could support various media types, so is not restricted to voice.
Service can be informed of subsequent call events (such as alerting or answered) by extending CallListenerAbstract and overriding corresponding callback methods.

Since:

2.0

See Also:
Participant, CallListener, CallListenerAbstract

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addParticipant(Participant party)` Alert multiple destinations for the initial call.
`void`	`allow()` Allow the call to proceed to the original target.
`void`	`divertTo(String target)` Divert the call to a `target`.
`void`	`drop()` Drop the call.
`void`	`enableMediaBeforeAnswer()` Instruct Collaboration Environment to set up resources to allow media operations before a call is answered.
`List`	`getAlertingParties()` Get a list of the parties that are alerting on this call.
`Participant`	`getAnsweringParty()` Get details about the party that answered the call.
`Object`	`getAttribute(String name)` Retrieve an attribute that was previously stored with the setAttribute method.
`Participant`	`getCalledParty()` Get a reference to the called party.
`Participant`	`getCallingParty()` Get a reference to the calling party.
`String`	`getCollectedDigits()` Returns digits collected during the call setup
`String`	`getContextId()` Get the context ID associated with this call.
`String`	`getId()` Every call, or session, has a unique identifier.
`String`	`getUCID()` Get the Universal Call ID associated with this call.
`void`	`initiate()` Initiates an outgoing call to the target defined while creating the call instance.
`Boolean`	`isCalledPhase()` Returns true if server is invoked in imsterm phase, false otherwise.
`Boolean`	`isCallingPhase()` Returns true if server is invoked in imsorig phase, false otherwise.
`Call`	`setAttribute(String name, Object attribute)` Store an attribute for later retrieval.
`void`	`setCollectedDigits(String collectedDigits)` Sets the collected digits portion of the initial invitation message sent to the called party
`void`	`setContextId(String contextId)` Set the context ID associated with this call.
`void`	`suspend()` Suspends the call to proceed further.

- Method Detail
  - getId
```
String getId()
```
    Every call, or session, has a unique identifier. Get the unique identifier of this call.
    
    Returns:
    the unique identifier of the call
  - allow
```
void allow()
```
    Allow the call to proceed to the original target. To receive notification of subsequent events (e.g., alerting, answered) on this call, the service must extend CallListener and override corresponding callback methods.
    
    Throws:
    
    IllegalStateException - In case of an exception in the underlying service.
  - drop
```
void drop()
```
    Drop the call. If the underlying protocol does not provide a specific call dropping feature, drop might instead result in sending an error response to the calling party which has the effect of dropping the call.
    
    Throws:
    
    IllegalStateException - In case of an exception in the underlying service.
  - divertTo
```
void divertTo(String target)
```
    Divert the call to a target. The target can be a simple telephone number (either E.164 or any digit string that matches your system's dial plan). It can also be of the form handle@domain or simply handle (where handle is either a name or telephone number (the case above), and domain is either a host or domain name). When no domain is supplied, the domain used for the redirection will be the same as the domain of the calledParty.
    To receive notification of subsequent events (e.g., alerting, answered) on this call, the service must extend CallListener and and override corresponding callback methods.
    
    Parameters:
    target - address of the party to which to divert the call
    
    Throws:
    
    IllegalArgumentException - if target is null, blank, or poorly formed
    
    IllegalStateException - in case of an exception in the underlying service
  - getCallingParty
```
Participant getCallingParty()
```
    Get a reference to the calling party. Details about the calling party can then be obtained from this reference, and the calling party's presentation to other parties can be set through this reference.
    
    Returns:
    the calling party
  - getCalledParty
```
Participant getCalledParty()
```
    Get a reference to the called party. Details about the called party can then be obtained from this reference, and the called party's presentation to other parties can be set through this reference.
    
    Returns:
    the called party
  - getAlertingParties
```
List getAlertingParties()
```
    Get a list of the parties that are alerting on this call. During a call, more than 1 party could be alerting. This could happen, for example, if some downstream element presents the call to multiple parties. Since this is a copy of the list, any changes you make to any Participant in the list, or to the list itself, will be ignored.
    
    Returns:
    a copy of the list of alerting parties (the list will be empty if this is invoked before a party has started alerting)
  - getAnsweringParty
```
Participant getAnsweringParty()
```
    Get details about the party that answered the call. Since this is a copy of the answering party, any change you make to this Participant will be ignored.
    
    Returns:
    a copy of the party that answered, or null if the call has not yet been answered
  - setAttribute
```
Call setAttribute(String name,
                Object attribute)
```
    Store an attribute for later retrieval.
  - If the attribute is Serializable, it can be stored by any service with access to the call.
  - If the attribute is not Serializable, it can only be stored by the service which created the call.
    
    A service can get a reference to a call using CallFactory#getCall(String) or using the call passed to it in one of the callback methods (such as CallListenerAbstract#callAnswered(Call)).
    
    If an object of the same name is already bound to this Call, the object is replaced. This can be used by the service writer to hold some data that will be needed at a later point in the call.

Parameters:: name - the name of the object to retain; cannot be null; attribute - the object to retain; cannot be null
Returns:: the call instance
Throws:: SerializationException - if attempting to store a non Serializable attribute from a service which did not create this call

getAttribute
```
Object getAttribute(String name)
```
Retrieve an attribute that was previously stored with the setAttribute method.
If the attribute is Serializable, it can be retrieved by any service with access to the call.
If the attribute is not Serializable, it can only be retrieved by the service which created the call.

A service can get a reference to a call using CallFactory#getCall(String) or using the call passed to it in one of the callback methods (such as CallListenerAbstract#callAnswered(Call)).

Interface Call

Method Summary

Method Detail

getId

allow

drop

divertTo

getCallingParty

getCalledParty

getAlertingParties

getAnsweringParty

setAttribute

getAttribute

suspend

initiate

isCallingPhase

isCalledPhase

getUCID

getContextId

setContextId

addParticipant

enableMediaBeforeAnswer

getCollectedDigits

setCollectedDigits