|
|||||||||
| 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.Voicemail
public final class Voicemail
Wrapper class that includes voicemail-specific methods and properties. In the Skype Conversation API, Voicemail is actually something of a misnomer for what would be more accurately called Voice Message. The traditional Voicemail use case involves recording a voice message when an incoming call does not get answered in a pre-determined amount of time. In the Skype Conversation API, voicemail does not depend on a call going unanswered - you can post a voice message asynchronously into any dialog conversation at any time. In fact, a high-level action flow directing unanswered incoming live sessions to voicemail is not something provided by the Conversation API - implementation of this use case is largely up to your UI. The fact that your UI must retrieve incoming Voicemails by monitoring changes to a Conversation instance's Messages illustrates this conceptual difference between traditional voicemail and voice messages. The message type Message.POSTED_VOICE_MESSAGE indicates that a Message instance should be handled as a voice message instead of by displaying its body text in the Conversation UI. Message.GetVoiceMessage enables you to retrieve the associated Voicemail instance; Voicemail.StartPlayback enables you to listen to the message audio. To put it another way, the object chain goes like this:
| Nested Class Summary | |
|---|---|
static class |
Voicemail.FailureReason
|
static class |
Voicemail.Property
Properties of the Voicemail class |
static class |
Voicemail.Status
|
static class |
Voicemail.Type
|
| Field Summary | |
|---|---|
int |
mAllowedDuration
|
byte[] |
mChatMsgGuid
|
Conversation |
mConversation
|
int |
mDuration
|
Voicemail.FailureReason |
mFailureReason
|
java.lang.String |
mPartnerDisplayName
|
java.lang.String |
mPartnerHandle
|
int |
mPlaybackProgress
|
Voicemail.Status |
mStatus
|
java.lang.String |
mSubject
|
int |
mTimestamp
|
Voicemail.Type |
mType
|
| Fields inherited from class com.skype.ipc.SidObject |
|---|
mSidCached, mSidOid, mSidRoot, mSidTimestamp |
| Constructor Summary | |
|---|---|
Voicemail(int oid,
SidRoot root)
|
|
| Method Summary | |
|---|---|
void |
cancel()
Canceling recording of your own auto-answer greeting message. |
boolean |
checkPermission()
check if we can send voicemail (unauth,blocked,no priv etc cases). |
void |
delete()
first from server, and then the local copy |
int |
getAllowedDuration()
max allowed duration in seconds |
byte[] |
getChatMsgGuid()
GUID of the message that the VM is tied to |
Conversation |
getConversation()
CONVERSATION_ID of corresponding conversation |
int |
getDuration()
duration in seconds |
Voicemail.FailureReason |
getFailureReason()
|
java.lang.String |
getPartnerDisplayName()
user's display name of the other party |
java.lang.String |
getPartnerHandle()
registered username of the other party |
int |
getPlaybackProgress()
VM playback progress in seconds |
java.lang.String |
getPropertyAsString(int prop)
|
java.lang.String |
getPropertyAsString(Voicemail.Property prop)
|
Voicemail.Status |
getStatus()
|
java.lang.String |
getSubject()
DEPRECATED: subject line |
int |
getTimestamp()
timestamp of creation |
Voicemail.Type |
getType()
|
int |
moduleId()
|
byte[] |
sidGetBinaryProperty(PropertyEnumConverting prop)
|
EnumConverting |
sidGetEnumProperty(PropertyEnumConverting prop)
|
int |
sidGetIntProperty(PropertyEnumConverting prop)
|
SidObject |
sidGetObjectProperty(PropertyEnumConverting prop)
|
java.lang.String |
sidGetStringProperty(PropertyEnumConverting prop)
|
SidGetResponding |
sidMultiGet(Voicemail.Property[] requested)
generic multiget of a list of Property |
static SidGetResponding[] |
sidMultiGet(Voicemail.Property[] requested,
Voicemail[] objects)
generic multiget of list of Property for a list of Voicemail |
protected void |
sidOnChangedProperty(int propertyId,
int value,
java.lang.String svalue)
|
void |
sidSetProperty(PropertyEnumConverting prop,
byte[] newValue)
|
void |
sidSetProperty(PropertyEnumConverting prop,
int newValue)
|
void |
sidSetProperty(PropertyEnumConverting prop,
SidObject newValue)
|
void |
sidSetProperty(PropertyEnumConverting prop,
java.lang.String newValue)
|
void |
startPlayback()
Initiates playback of a voice message |
void |
startRecording()
Start recording your own auto-answer greeting message (leave message after the beep...) only. |
void |
stopPlayback()
Terminates playback of a voice message |
void |
stopRecording()
Stop recording of your own auto-answer greeting message only. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public Voicemail.Type mType
public java.lang.String mPartnerHandle
public java.lang.String mPartnerDisplayName
public Voicemail.Status mStatus
public Voicemail.FailureReason mFailureReason
public java.lang.String mSubject
public int mTimestamp
public int mDuration
public int mAllowedDuration
public int mPlaybackProgress
public Conversation mConversation
public byte[] mChatMsgGuid
| Constructor Detail |
|---|
public Voicemail(int oid,
SidRoot root)
| Method Detail |
|---|
public void startRecording()
public void stopRecording()
public void startPlayback()
public void stopPlayback()
public void delete()
public void cancel()
public boolean checkPermission()
public SidGetResponding sidMultiGet(Voicemail.Property[] requested)
requested - the list of requested properties of Voicemail
public static SidGetResponding[] sidMultiGet(Voicemail.Property[] requested,
Voicemail[] objects)
requested - the list of requested properties
public Voicemail.Type getType()
public java.lang.String getPartnerHandle()
public java.lang.String getPartnerDisplayName()
public Voicemail.Status getStatus()
public Voicemail.FailureReason getFailureReason()
public java.lang.String getSubject()
public int getTimestamp()
public int getDuration()
public int getAllowedDuration()
public int getPlaybackProgress()
public Conversation getConversation()
public byte[] getChatMsgGuid()
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 byte[] sidGetBinaryProperty(PropertyEnumConverting prop)
sidGetBinaryProperty in interface SidGetRespondingsidGetBinaryProperty in class SidObjectpublic java.lang.String getPropertyAsString(int prop)
public java.lang.String getPropertyAsString(Voicemail.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 SidObject
public void sidSetProperty(PropertyEnumConverting prop,
byte[] 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 | ||||||||