blob: 5d5e827285f12cc350edca258221234ab3607ce2 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
/*
* SIP Communicator, the OpenSource Java VoIP and Instant Messaging client.
*
* Distributable under LGPL license.
* See terms of license at gnu.org.
*/
package net.java.sip.communicator.service.protocol;
import java.util.*;
import net.java.sip.communicator.service.protocol.event.CallParticipantListener;
import net.java.sip.communicator.service.gui.*;
/**
* The CallParticipant is an interface that represents participants in a call.
* Users of the PhoneUIService need to implement this interface (or one of its
* default implementations such DefaultCallParticipant) in order to be able to
* register call participant in the user interface.
*
* <p>For SIP calls for example, it would be necessary to create a
* SipCallParticipant class that would provide sip specific implementations of
* various methods (getAddress() for example would return the participant's sip
* URI).
*
* @author Emil Ivov
*/
public interface CallParticipant
{
/**
* Returns a unique identifier representing this participant. Identifiers
* returned by this method should remain unique across calls. In other
* words, if it returned the value of "A" for a given participant it should
* not return that same value for any other participant and return a
* different value even if the same person (address) is participating in
* another call. Values need not remain unique after restarting the program.
*
* @return an identifier representing this call participant.
*/
public String getParticipantID();
/**
* Returns a reference to the call that this participant belongs to.
* @return a reference to the call containing this participant.
*/
public Call getCall();
/**
* Returns a human readable name representing this participant.
* @return a String containing a name for that participant.
*/
public String getDisplayName();
/**
* Returns a String locator for that participant. A locator might be a SIP
* URI, an IP address or a telephone number.
* @return the participant's address or phone number.
*/
public String getAddress();
/**
* Returns an object representing the current state of that participant.
* CallParticipantState may vary among CONNECTING, RINGING, CALLING, BISY,
* CONNECTED, and others, and it reflects the state of the connection between
* us and that participant.
* @return a CallParticipantState instance representin the participant's
* state.
*/
public CallParticipantState getState();
/**
* Determines whether or not this is the participant that originated the
* call (as opposed to the one that was called).
*
* @return true if this is the participant that calls us and falls if
* otherwise.
*/
public boolean isCaller();
/**
* Allows the user interface to register a listener interested in changes
* @param listener a listener instance to register with this participant.
*/
public void addCallParticipantListener(CallParticipantListener listener);
/**
* Unregisters the specified listener.
* @param listener the listener to unregister.
*/
public void removeCallParticipantListener(CallParticipantListener listener);
/**
* Returns the date (time) when this call participant acquired its current
* status. This method is to be used by the phone ui interface in order
* to show the duration of a call.
* @return a java.util.Date object containing the date when this call
* participant entered its current state.
*/
public Date getCurrentStateStartDate();
/**
* Returns a string representation of the participant in the form of
* <br>
* Display Name <address>;status=CallParticipantStatus
* @return a string representation of the participant and its state.
*/
public String toString();
/**
* The method returns an image representation of the call participant (e.g.
* a photo). Generally, the image representation is acquired from the
* underlying telephony protocol and is transferred over the network during
* call negotiation.
* @return byte[] a byte array containing the image or null if no image is
* available.
*/
public byte[] getImage();
}
|
