|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.skype.api.SkypeObject
com.skype.api.Participant
public class Participant
Conversation participant class. Instances of this class represent contacts when in the context of conversations. Amongst others, this class has a Ring method for requesting live status with the target contact. This class also holds typing indicator property and access rights for the contact in context of public conversations.
| Nested Class Summary | |
|---|---|
static class |
Participant.DTMF
|
static interface |
Participant.ParticipantListener
|
static class |
Participant.PROPERTY
Properties of the Participant class |
static class |
Participant.RANK
Recognized values for the P_RANK property. |
static class |
Participant.TEXT_STATUS
Recognized values for the P_TEXT_STATUS property. |
static class |
Participant.VIDEO_STATUS
Recognized values for the P_VIDEO_STATUS property. |
static class |
Participant.VOICE_STATUS
Recognized values for the P_VOICE_STATUS property. |
| Field Summary |
|---|
| Fields inherited from class com.skype.api.SkypeObject |
|---|
mObjectId, mPropCache, skype |
| Constructor Summary | |
|---|---|
Participant(int oid,
Skype skype)
|
|
| Method Summary | |
|---|---|
boolean |
CanSetRankTo(Participant.RANK rank)
Checks whether the current user can set this Participant's conversation privileges to the specified RANK. |
byte[] |
GetBinProperty(Participant.PROPERTY prop)
|
boolean |
GetBooleanProperty(Participant.PROPERTY prop)
|
int |
GetIntProperty(Participant.PROPERTY prop)
|
java.lang.Object |
GetPropertyAsEnum(int propid)
|
java.lang.String |
GetStrProperty(Participant.PROPERTY prop)
|
Video |
GetVideo()
Retrieves a reference to the Video object that corresponds to the Participant. |
void |
Hangup()
Removes this participant from the current live session. |
static int |
moduleID()
|
void |
Retire()
Forcibly removes this participant from conversation. |
void |
Ring(java.lang.String identityToUse,
boolean videoCall,
int nrofRedials,
int redialPeriod,
boolean autoStartVM,
java.lang.String origin)
Initiates live conversation attempt with Participant. |
void |
RingIt()
Rings this participant, using P_LIVE_IDENTITY property if set. |
void |
SetLiveIdentityToUse(java.lang.String identityToUse)
Sets LIVE_IDENTITY property, an alternate identity to use when ringing, such as a PSTN. |
void |
SetRankTo(Participant.RANK rank)
Sets Participant's conversation privileges to the given RANK |
| Methods inherited from class com.skype.api.SkypeObject |
|---|
close, getOid |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public Participant(int oid,
Skype skype)
| Method Detail |
|---|
public static final int moduleID()
public java.lang.Object GetPropertyAsEnum(int propid)
GetPropertyAsEnum in class SkypeObjectpublic java.lang.String GetStrProperty(Participant.PROPERTY prop)
public int GetIntProperty(Participant.PROPERTY prop)
public boolean GetBooleanProperty(Participant.PROPERTY prop)
public byte[] GetBinProperty(Participant.PROPERTY prop)
public boolean CanSetRankTo(Participant.RANK rank)
rank - Participant.RANK value to check for. public void SetRankTo(Participant.RANK rank)
rank - Target Participant.RANK value.
public void Ring(java.lang.String identityToUse,
boolean videoCall,
int nrofRedials,
int redialPeriod,
boolean autoStartVM,
java.lang.String origin)
identityToUse - Ring an alternate identity, such as a PSTN number. videoCall - Enable video. nrofRedials - Unused. redialPeriod - Unused. autoStartVM - Unused. On dialog, if falling on VM, greeting and recording will be automatically started. origin - When call is initiated from web link, must contain the URI that was usedpublic void RingIt()
public void SetLiveIdentityToUse(java.lang.String identityToUse)
identityToUse - Empty string will reset it to default, i.e IDENTITY property value public Video GetVideo()
public void Hangup()
public void Retire()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||