|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.skype.ipc.SidObject
com.skype.api.Participant
public final 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 class |
Participant.Property
Properties of the Participant class |
static class |
Participant.Rank
Recognized values for the P_RANK property. |
static class |
Participant.TextStatus
Recognized values for the P_TEXT_STATUS property. |
static class |
Participant.VideoStatus
Recognized values for the P_VIDEO_STATUS property. |
static class |
Participant.VoiceStatus
Recognized values for the P_VOICE_STATUS property. |
| Field Summary | |
|---|---|
java.lang.String |
mAdder
|
Conversation |
mConversation
|
java.lang.String |
mDebugInfo
|
java.lang.String |
mIdentity
|
Skype.LeaveReason |
mLastLeavereason
|
java.lang.String |
mLastVoiceError
|
java.lang.String |
mLiveCountry
|
java.lang.String |
mLiveFwdIdentities
|
java.lang.String |
mLiveIdentity
|
java.lang.String |
mLivePriceForMe
|
int |
mLiveStartTimestamp
|
Skype.IdentityType |
mLiveType
|
java.lang.String |
mQualityProblems
|
Participant.Rank |
mRank
|
Participant.Rank |
mRequestedRank
|
int |
mSoundLevel
|
Participant.TextStatus |
mTextStatus
|
java.lang.String |
mTransferredBy
|
java.lang.String |
mTransferredTo
|
Participant.VideoStatus |
mVideoStatus
|
Participant.VoiceStatus |
mVoiceStatus
|
| Fields inherited from class com.skype.ipc.SidObject |
|---|
mSidCached, mSidOid, mSidRoot, mSidTimestamp |
| Constructor Summary | |
|---|---|
Participant(int oid,
SidRoot root)
|
|
| Method Summary | |
|---|---|
boolean |
canSetRankTo(Participant.Rank rank)
Checks whether the current user can set this Participant's conversation privileges to the specified RANK. |
java.lang.String |
getAdder()
[ALL] Identity of the user who added this participant to the conversation, type: Sid.String |
Conversation |
getConversation()
[ALL] ID of corresponding conversation. |
java.lang.String |
getDebugInfo()
[OTHERS] call (audio and video) debug info |
java.lang.String |
getIdentity()
[ALL] skypename OR pstn_number OR namespace:identity |
Skype.LeaveReason |
getLastLeavereason()
[OTHERS] last reason for leaving conversation or live session. |
java.lang.String |
getLastVoiceError()
[OTHERS] DEPRECATED, use last_leavereason instead |
java.lang.String |
getLiveCountry()
[OTHERS] participant livesession country code - used for emergency calls only atm |
java.lang.String |
getLiveFwdIdentities()
[OTHERS] list of identities where the live session is being forwarded (if they are disclosed), space separated |
java.lang.String |
getLiveIdentity()
[ALL] identity that was used to establish current live session with that participant (can be different from participant identity) |
java.lang.String |
getLivePriceForMe()
[OTHERS] 'price_per_minute_float currency' - eg '0.01 EUR'. |
int |
getLiveStartTimestamp()
[ALL] time of joining the live session |
Skype.IdentityType |
getLiveType()
[ALL] participant type during livesession as specified in IDENTITYTYPE |
java.lang.String |
getPropertyAsString(int prop)
|
java.lang.String |
getPropertyAsString(Participant.Property prop)
|
java.lang.String |
getQualityProblems()
[ALL] space separated tokens values: CPU_INUSE CPU_SLOW CPU_HIGH HIGH_ECHO HIGH_NOISE MUTED_INPUT LOW_INPUT MUTED_INPUT_ACTIVITY FW_STRONG FW_BAD NOT_UDP CALL_BW_LOW RECORD_ERROR + values in video debug info |
Participant.Rank |
getRank()
[ALL] Participant.RANK |
Participant.Rank |
getRequestedRank()
Not set (should be: requested Participant.RANK, higher than the current one) |
int |
getSoundLevel()
[ALL] current 'loudness' level when SPEAKING (0..10) |
Participant.TextStatus |
getTextStatus()
[ALL] the typing indicator |
java.lang.String |
getTransferredBy()
[OTHERS] Transferor identity (transferee side) |
java.lang.String |
getTransferredTo()
[OTHERS] Identity of recipient of transfer (transferor side, caller side) |
Video |
getVideo()
Retrieves a reference to the Video object that corresponds to the Participant. |
Participant.VideoStatus |
getVideoStatus()
[ALL] video status |
Participant.VoiceStatus |
getVoiceStatus()
[ALL] voice status |
void |
hangup()
Removes this participant from the current live session. |
Participant |
mgetInfo()
multiget the following properties - P_VOICE_STATUS - P_TEXT_STATUS - P_VIDEO_STATUS - P_RANK - P_LIVE_TYPE - P_LIVE_PRICE_FOR_ME - P_IDENTITY |
static Participant[] |
mgetInfo(Participant[] objects)
multiget the following properties for a list of Participant - P_VOICE_STATUS - P_TEXT_STATUS - P_VIDEO_STATUS - P_RANK - P_LIVE_TYPE - P_LIVE_PRICE_FOR_ME - P_IDENTITY |
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 * @param rank Target Participant.RANK value. |
EnumConverting |
sidGetEnumProperty(PropertyEnumConverting prop)
|
int |
sidGetIntProperty(PropertyEnumConverting prop)
|
SidObject |
sidGetObjectProperty(PropertyEnumConverting prop)
|
java.lang.String |
sidGetStringProperty(PropertyEnumConverting prop)
|
SidGetResponding |
sidMultiGet(Participant.Property[] requested)
generic multiget of a list of Property |
static SidGetResponding[] |
sidMultiGet(Participant.Property[] requested,
Participant[] objects)
generic multiget of list of Property for a list of Participant |
protected void |
sidOnChangedProperty(int propertyId,
int value,
java.lang.String svalue)
|
void |
sidSetProperty(PropertyEnumConverting prop,
int newValue)
|
void |
sidSetProperty(PropertyEnumConverting prop,
SidObject newValue)
|
void |
sidSetProperty(PropertyEnumConverting prop,
java.lang.String newValue)
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public Conversation mConversation
public java.lang.String mIdentity
public Participant.Rank mRank
public Participant.Rank mRequestedRank
public Participant.TextStatus mTextStatus
public Participant.VoiceStatus mVoiceStatus
public Participant.VideoStatus mVideoStatus
public java.lang.String mLiveIdentity
public java.lang.String mLivePriceForMe
public java.lang.String mLiveFwdIdentities
public int mLiveStartTimestamp
public int mSoundLevel
public java.lang.String mDebugInfo
public java.lang.String mLastVoiceError
public java.lang.String mQualityProblems
public Skype.IdentityType mLiveType
public java.lang.String mLiveCountry
public java.lang.String mTransferredBy
public java.lang.String mTransferredTo
public java.lang.String mAdder
public Skype.LeaveReason mLastLeavereason
| Constructor Detail |
|---|
public Participant(int oid,
SidRoot root)
| Method Detail |
|---|
public boolean canSetRankTo(Participant.Rank rank)
public void setRankTo(Participant.Rank rank)
public void ring(java.lang.String identityToUse,
boolean videoCall,
int nrofRedials,
int redialPeriod,
boolean autoStartVm,
java.lang.String origin)
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)
public Video getVideo()
public void hangup()
public void retire()
public SidGetResponding sidMultiGet(Participant.Property[] requested)
requested - the list of requested properties of Participant
public static SidGetResponding[] sidMultiGet(Participant.Property[] requested,
Participant[] objects)
requested - the list of requested properties
public Participant mgetInfo()
public static Participant[] mgetInfo(Participant[] objects)
objects - targets of the request
public Conversation getConversation()
public java.lang.String getIdentity()
public Participant.Rank getRank()
public Participant.Rank getRequestedRank()
public Participant.TextStatus getTextStatus()
public Participant.VoiceStatus getVoiceStatus()
public Participant.VideoStatus getVideoStatus()
public java.lang.String getLiveIdentity()
public java.lang.String getLivePriceForMe()
public java.lang.String getLiveFwdIdentities()
public int getLiveStartTimestamp()
public int getSoundLevel()
public java.lang.String getDebugInfo()
public java.lang.String getLastVoiceError()
public java.lang.String getQualityProblems()
public Skype.IdentityType getLiveType()
public java.lang.String getLiveCountry()
public java.lang.String getTransferredBy()
public java.lang.String getTransferredTo()
public java.lang.String getAdder()
public Skype.LeaveReason getLastLeavereason()
public java.lang.String sidGetStringProperty(PropertyEnumConverting prop)
sidGetStringProperty in interface SidGetRespondingsidGetStringProperty in class SidObjectpublic SidObject sidGetObjectProperty(PropertyEnumConverting prop)
sidGetObjectProperty in interface SidGetRespondingsidGetObjectProperty in class SidObjectpublic int sidGetIntProperty(PropertyEnumConverting prop)
sidGetIntProperty in interface SidGetRespondingsidGetIntProperty in class SidObjectpublic EnumConverting sidGetEnumProperty(PropertyEnumConverting prop)
sidGetEnumProperty in interface SidGetRespondingsidGetEnumProperty in class SidObjectpublic java.lang.String getPropertyAsString(int prop)
public java.lang.String getPropertyAsString(Participant.Property prop)
protected void sidOnChangedProperty(int propertyId,
int value,
java.lang.String svalue)
sidOnChangedProperty in class SidObject
public void sidSetProperty(PropertyEnumConverting prop,
java.lang.String newValue)
sidSetProperty in interface SidGetRespondingsidSetProperty in class SidObject
public void sidSetProperty(PropertyEnumConverting prop,
SidObject newValue)
sidSetProperty in interface SidGetRespondingsidSetProperty in class SidObject
public void sidSetProperty(PropertyEnumConverting prop,
int newValue)
sidSetProperty in interface SidGetRespondingsidSetProperty in class SidObjectpublic int moduleId()
moduleId in class SidObject
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||