public interface Participant
A Participant consists of an address and a display name. The display name is often used by the device to provide textual information about the party. For example, some office telephone systems display a caller's name instead of, or in addition to, the caller's address.
The address is generally of the form handle@domain. Depending on the underlying communications protocol, a Participant will always have a handle but might not have the domain part of an address. The domain could be a domain or IP address. In the example address 5551515@mycompany.com, the handle is 5551515, and the domain is mycompany.com.
The Participant also provides a way to specify how a party will be presented to other parties in the call. This feature would be useful, for example, in a service that hides the caller's identity.
Call
Modifier and Type | Method and Description |
---|---|
String |
getAddress()
Convenience method that returns an address string of the form
handle@domain, where handle is the same as would be
provided with
getHandle , and domain is the same as
would be provide with getDomain . |
Call |
getCall()
Get the Call instance associated with the Participant, null if not
associated.
|
String |
getDisplayName()
Get the display name of the participant as provided by the network or
endpoint.
|
String |
getDomain()
Get the domain part of the party's address as provided by the network or
endpoint.
|
String |
getHandle()
Get the handle part of the party's address as provided by the network or
endpoint.
|
String |
getPresentedDisplayName()
Get the display name to be presented to other parties in the call, as
previously set by the client service.
|
String |
getPresentedDomain()
Get the domain part of this party's address to be presented to other
parties in the call, as previously set by the client service.
|
String |
getPresentedHandle()
Get the handle part of this party's address to be presented to other
parties in the call, as previously set by the client service.
|
ProtocolType |
getType()
Get the protocol type used by the participant.
|
Participant |
setPresentedDisplayName(String displayName)
Set this party's display name to be presented to other parties in the
call.
|
Participant |
setPresentedDomain(String domain)
Set the domain part of this party's address to be presented to other
parties in the call.
|
Participant |
setPresentedHandle(String handle)
Set the handle part of this party's address to be presented to other
parties in the call.
|
String getAddress()
getHandle
, and domain is the same as
would be provide with getDomain
.String getDisplayName()
setPresentedDisplayName
method.Call getCall()
String getDomain()
setPresentedDomain
method.String getHandle()
setPresentedHandle
method.ProtocolType getType()
String getPresentedDisplayName()
String getPresentedDomain()
String getPresentedHandle()
Participant setPresentedDisplayName(String displayName)
If this Participant is the calling party, this method sets the display name that will be presented to the called party. If this Participant is the called party, this method sets the display name that will be presented to the calling party.
This method can be used when it is desirable that this display differ from that provided by the network or endpoint. For example, the presented display could be used to mask the calling party's name from the called party.
displayName
- the display name to present to other parties in the callParticipant setPresentedDomain(String domain)
If this Participant is the calling party, this method sets the domain in the address that will be presented to the called party. If this Participant is the called party, this method sets the domain in the address that will be presented to the calling party.
This method (possibly together with setPresentedHandle
) can
be used when it is desirable to hide this party's address from other
parties in the call.
domain
- the domain to present to other parties in the callParticipant setPresentedHandle(String handle)
If this Participant is the calling party, this method sets the handle in the address that will be presented to the called party. If this Participant is the called party, this method sets the handle in the address that will be presented to the calling party.
This method (possibly together with setPresentedDomain
) can
be used when it is desirable to hide this party's address from other
parties in the call.
handle
- the handle to present to other parties in the callCopyright © 2014 Avaya. All Rights Reserved.