Wrapper class that includes voicemail-specific methods and properties. More...
#include <skype-embedded_2.h>
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:
@n Contact->Conversation->Message->Voicemail @n
There are three basic types of Voicemail objects:
@n <voicemail alt="Sent voicemail to people in this conversation."><message length="5" ></message></voicemail> @n
Definition at line 2028 of file skype-embedded_2.h.
| typedef VoicemailRef Voicemail::Ref |
Definition at line 2037 of file skype-embedded_2.h.
| typedef VoicemailRefs Voicemail::Refs |
Definition at line 2038 of file skype-embedded_2.h.
| anonymous enum |
Definition at line 2039 of file skype-embedded_2.h.
Definition at line 2094 of file skype-embedded_2.h.
| enum Voicemail::PROPERTY |
Properties of the Voicemail class
| P_TYPE |
type: TYPE |
| P_PARTNER_HANDLE |
registered username of the other party, type: Sid::String |
| P_PARTNER_DISPNAME |
user's display name of the other party, type: Sid::String |
| P_STATUS |
type: STATUS |
| P_FAILUREREASON |
type: FAILUREREASON |
| P_SUBJECT |
subject line, type: Sid::String |
| P_TIMESTAMP |
timestamp of creation, type: uint |
| P_DURATION |
duration in seconds, type: uint |
| P_ALLOWED_DURATION |
max allowed duration in seconds, type: uint |
| P_PLAYBACK_PROGRESS |
VM playback progress in seconds, type: uint |
| P_CONVO_ID |
CONVERSATION_ID of corresponding conversation, type: ConversationRef |
| P_CHATMSG_GUID |
GUID of the message that the VM is tied to, type: Sid::Binary |
Definition at line 2053 of file skype-embedded_2.h.
| enum Voicemail::STATUS |
| NOTDOWNLOADED | |
| DOWNLOADING | |
| UNPLAYED | |
| BUFFERING | |
| PLAYING | |
| PLAYED | |
| BLANK | |
| RECORDING | |
| RECORDED | |
| UPLOADING | |
| UPLOADED | |
| DELETING | |
| FAILED | |
| DELETING_FAILED | |
| CHECKING | |
| CANCELLED |
Definition at line 2075 of file skype-embedded_2.h.
| enum Voicemail::TYPE |
Definition at line 2068 of file skype-embedded_2.h.
| Voicemail::~Voicemail | ( | ) | [virtual] |
Definition at line 965 of file skype-embedded_2.cpp.
| bool Voicemail::Cancel | ( | ) |
Canceling recording of your own auto-answer greeting message. To stop recording of and cancel an outgoing Voicemail, use Conversation::LeaveLiveSession.
| bool Voicemail::CheckPermission | ( | bool & | result | ) |
check if we can send voicemail (unauth,blocked,no priv etc cases). only OUTGOING
| bool Voicemail::Delete | ( | ) |
first from server, and then the local copy
| bool Voicemail::GetPropAllowedDuration | ( | uint & | allowed_duration | ) |
Voicemail::P_ALLOWED_DURATION property get accessor
| bool Voicemail::GetPropChatmsgGuid | ( | Sid::Binary & | chatmsg_guid | ) |
Voicemail::P_CHATMSG_GUID property get accessor
| bool Voicemail::GetPropConvoId | ( | ConversationRef & | convo_id | ) |
Voicemail::P_CONVO_ID property get accessor
| bool Voicemail::GetPropDuration | ( | uint & | duration | ) |
Voicemail::P_DURATION property get accessor
| bool Voicemail::GetPropFailurereason | ( | FAILUREREASON & | failurereason | ) |
Voicemail::P_FAILUREREASON property get accessor
| bool Voicemail::GetPropPartnerDispname | ( | Sid::String & | partner_dispname | ) |
Voicemail::P_PARTNER_DISPNAME property get accessor
| bool Voicemail::GetPropPartnerHandle | ( | Sid::String & | partner_handle | ) |
Voicemail::P_PARTNER_HANDLE property get accessor
| bool Voicemail::GetPropPlaybackProgress | ( | uint & | playback_progress | ) |
Voicemail::P_PLAYBACK_PROGRESS property get accessor
| bool Voicemail::GetPropStatus | ( | STATUS & | status | ) |
Voicemail::P_STATUS property get accessor
| bool Voicemail::GetPropSubject | ( | Sid::String & | subject | ) |
Voicemail::P_SUBJECT property get accessor
| bool Voicemail::GetPropTimestamp | ( | uint & | timestamp | ) |
Voicemail::P_TIMESTAMP property get accessor
| bool Voicemail::GetPropType | ( | TYPE & | type | ) |
Voicemail::P_TYPE property get accessor
| VoicemailRef Voicemail::ref | ( | ) | [inline] |
Definition at line 2040 of file skype-embedded_2.h.
| bool Voicemail::StartPlayback | ( | ) |
Initiates playback of a voice message
| bool Voicemail::StartRecording | ( | ) |
Start recording your own auto-answer greeting message (leave message after the beep...) only. Recording of outgoing Voicemail messages start automatically (using Conversation::StartVoiceMessage) after playback of the remote side greeting message has finished.
| bool Voicemail::StopPlayback | ( | ) |
Terminates playback of a voice message
| bool Voicemail::StopRecording | ( | ) |
Stop recording of your own auto-answer greeting message only. To stop recording of and send an outgoing Voicemail, use Conversation::PostVoiceMessage.
(c) Skype Technologies S.A. Confidential/Proprietary
Last updated: Fri Mar 16 2012