com.skype
Class VoiceMail

java.lang.Object
  com.skype.VoiceMail

All Implemented Interfaces:

Serializable

public final class VoiceMail
extends Object

Class to represent the Skype VoiceMail object.

See Also:

https://developer.skype.com/Docs/ApiDoc/VOICEMAIL_object, Serialized Form

Nested Class Summary

static class	VoiceMail.FailureReason Enumeration of VoiceMail failure reason types
static class	VoiceMail.Status Enumeration of VoiceMail status types.
static class	VoiceMail.Type Enumeration of VoiceMail types.

Method Summary

void	addVoiceMailStatusChangedListener(VoiceMailStatusChangedListener listener) Adds a listener for the status changed event.
void	dispose() Deletes this VoiceMail object.
void	download() Downloads the playback of this VoiceMail object.
boolean	equals(Object compared) Indicates whether some other object is "equal to" this VoiceMail object.
int	getAllowedDuration() Returns the maximum duration of this VoiceMail object in seconds allowed to leave to partner.
Object	getData(String name) Returns the user data to which this object maps to the specified by the name.
int	getDuration() Returns the duration of this VoiceMail object in seconds.
VoiceMail.FailureReason	getFailureReason() Returns the failure reason of this VoiceMail object.
String	getId() Returns the ID of this VoiceMail object.
User	getPartner() Returns the Skype user who is the partner in this voice mail.
String	getPartnerDisplayName() Returns the display name of the Skype user who is the partner in this voice mail.
String	getPartnerId() Returns the Skype ID who is the partner in this voice mail.
Date	getStartTime() Returns the start time of this VoiceMail object.
VoiceMail.Status	getStatus() Returns the current status of this VoiceMail object.
VoiceMail.Type	getType() Returns the type of this VoiceMail object.
int	hashCode() Returns the hash code value for this VoiceMail object.
void	openAndStartPlayback() Opens the Skype window and starts playing this VoiceMail object.
void	removeVoiceMailStatusChangedListener(VoiceMailStatusChangedListener listener) Removes a listener for the status changed event.
void	setData(String name, Object userData) Associates the specified user data with the specified name in this object.
void	startPlayback() Starts the playback of this VoiceMail object.
void	startRecording() Starts the recording of this VoiceMail object.
void	stopPlayback() Stops the playback of this VoiceMail object.
void	stopRecording() Stops the recording of this VoiceMail object.
void	upload() Uploads the playback of this VoiceMail object.
void	waitForFinishing() Waits for finishing.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

hashCode

public int hashCode()

Returns the hash code value for this VoiceMail object. The VoiceMail ID is used as the hash code.

Overrides:

hashCode in class Object

Returns:

the hashcode

equals

public boolean equals(Object compared)

Indicates whether some other object is "equal to" this VoiceMail object. VoiceMail IDs are used for equalness checking.

Overrides:

equals in class Object

Parameters:

compared - the object to compare to.

Returns:

true if this VoiceMail object is the same as the compared argument; false otherwise.

getId

public String getId()

Returns the ID of this VoiceMail object.

Returns:

the ID of this VoiceMail object

addVoiceMailStatusChangedListener

public void addVoiceMailStatusChangedListener(VoiceMailStatusChangedListener listener)
                                       throws SkypeException

Adds a listener for the status changed event. The listener will be triggered every time the status of this VoiceMail object is changed.

Parameters:

listener - the listener to be added

Throws:

SkypeException

removeVoiceMailStatusChangedListener

public void removeVoiceMailStatusChangedListener(VoiceMailStatusChangedListener listener)

Removes a listener for the status changed event. If the listener is already removed, nothing happens.

Parameters:

listener - the listener to be removed

getType

public VoiceMail.Type getType()
                       throws SkypeException

Returns the type of this VoiceMail object.

Returns:

call the type of this VoiceMail object

Throws:

SkypeException - if the connection is bad

getPartner

public User getPartner()
                throws SkypeException

Returns the Skype user who is the partner in this voice mail.

Returns:

the partner Skype user

Throws:

SkypeException - if the connection is bad

getPartnerId

public String getPartnerId()
                    throws SkypeException

Returns the Skype ID who is the partner in this voice mail.

Returns:

the partner Skype user

Throws:

SkypeException - if the connection is bad

getPartnerDisplayName

public String getPartnerDisplayName()
                             throws SkypeException

Returns the display name of the Skype user who is the partner in this voice mail.

Returns:

the diplay name of the partner Skype user

Throws:

SkypeException - if the connection is bad

getStatus

public VoiceMail.Status getStatus()
                           throws SkypeException

Returns the current status of this VoiceMail object.

Returns:

the current status of this VoiceMail object

Throws:

SkypeException - if connection is bad

getFailureReason

public VoiceMail.FailureReason getFailureReason()
                                         throws SkypeException

Returns the failure reason of this VoiceMail object.

Returns:

the failure reason of this VoiceMail object

Throws:

SkypeException - if connection is bad

getStartTime

public Date getStartTime()
                  throws SkypeException

Returns the start time of this VoiceMail object.

Returns:

the start time of this VoiceMail object

Throws:

SkypeException - if connection is bad

getDuration

public int getDuration()
                throws SkypeException

Returns the duration of this VoiceMail object in seconds.

Returns:

the duration of this VoiceMail object

Throws:

SkypeException - if connection is bad

getAllowedDuration

public int getAllowedDuration()
                       throws SkypeException

Returns the maximum duration of this VoiceMail object in seconds allowed to leave to partner.

Returns:

the maximum duration of this VoiceMail object

Throws:

SkypeException - if connection is bad

startPlayback

public void startPlayback()
                   throws SkypeException

Starts the playback of this VoiceMail object.

Throws:

SkypeException - if the connection is bad

stopPlayback

public void stopPlayback()
                  throws SkypeException

Stops the playback of this VoiceMail object.

Throws:

SkypeException - if the connection is bad

upload

public void upload()
            throws SkypeException

Uploads the playback of this VoiceMail object.

Throws:

SkypeException - if the connection is bad

download

public void download()
              throws SkypeException

Downloads the playback of this VoiceMail object.

Throws:

SkypeException - if the connection is bad

startRecording

public void startRecording()
                    throws SkypeException

Starts the recording of this VoiceMail object.

Throws:

SkypeException - if the connection is bad

stopRecording

public void stopRecording()
                   throws SkypeException

Stops the recording of this VoiceMail object.

Throws:

SkypeException - if the connection is bad

dispose

public void dispose()
             throws SkypeException

Deletes this VoiceMail object.

Throws:

SkypeException - if the connection is bad

openAndStartPlayback

public void openAndStartPlayback()
                          throws SkypeException

Opens the Skype window and starts playing this VoiceMail object.

Throws:

SkypeException - if the connection is bad

waitForFinishing

public void waitForFinishing()
                      throws SkypeException

Waits for finishing.

Throws:

IllegalStateException - if the type is not outgoing

SkypeException - if the connection is bad

getData

public final Object getData(String name)

Returns the user data to which this object maps to the specified by the name. Returns null if this object contains no mapping for the name.

Parameters:

name - name whose associated user data is to be returned.

Returns:

the user data to which this object maps the specified name, or null if this object contains no mapping for the name.

See Also:

Map.get(Object)

setData

public final void setData(String name,
                          Object userData)

Associates the specified user data with the specified name in this object.

Parameters:

name - name with which the specified user data is to be associated.

userData - user data to be associated with the specified name.

See Also:

Map.put(Object, Object)