Class: SkypeR::Object::VoiceMail

Inherits:
Base
  • Object
show all
Defined in:
lib/skyper/object.rb

Overview

VOICEMAIL object

Version

* Protocol 5

Properties

* TYPE - type of voicemail object
      o INCOMING - voicemail received from partner
      o OUTGOING - voicemail sent to partner
      o DEFAULT_GREETING - Skype default greeting from partner
      o CUSTOM_GREETING - partner's recorded custom greeting
      o UNKNOWN 
* PARTNER_HANDLE - username for voicemail sender (for incoming) or recipient (for outgoing)
* PARTNER_DISPNAME - user displayname for partner
* STATUS - current status of voicemail object
      o NOTDOWNLOADED - voicemail is stored on server (has not been downloaded yet)
      o DOWNLOADING - downloading from server to local machine
      o UNPLAYED - voicemail has been downloaded but not played back yet
      o BUFFERING - buffering for playback
      o PLAYING - currently played back
      o PLAYED - voicemail has been played back
      o BLANK - intermediate status when new object is created but recording has not begun
      o RECORDING - voicemail currently being recorded
      o RECORDED - voicemail recorded but not yet uploaded to the server
      o UPLOADING - voicemail object is currently being uploaded to server
      o UPLOADED - upload to server finished but not yet deleted; object is also locally stored
      o DELETING - pending delete
      o FAILED - downloading voicemail/greeting failed
      o UNKNOWN 
* FAILUREREASON possible values
      o MISC_ERROR
      o CONNECT_ERROR
      o NO_VOICEMAIL_PRIVILEGE
      o NO_SUCH_VOICEMAIL
      o FILE_READ_ERROR
      o FILE_WRITE_ERROR
      o RECORDING_ERROR
      o PLAYBACK_ERROR
      o UNKNOWN 
* SUBJECT - not used
* TIMESTAMP
* DURATION - actual voicemail duration in seconds
* ALLOWED_DURATION - maximum voicemail duration in seconds allowed to leave to partner
* INPUT - New in API version 3.5.0.202 Can have following values:
      o SOUNDCARD="default" - default is currently the only acceptable value.
      o PORT="port_no" - the ID of the audio port (1..65535)
      o FILE="filename.wav" - the path and name of the audio file. 
* OUTPUT - can have all the same values as INPUT property. New in API version 3.5.0.202
* CAPTURE_MIC - can have all the same values as INPUT and OUTPUT properties. New in API version 3.5.0.202

Method Summary

Methods inherited from Base

#update_attributes