Home       Trees       Indices       Help   
Skype4Py
Package Skype4Py :: Module call :: Class ICall
[frames] | no frames]

Class ICall

source code

  object --+    
           |    
utils.Cached --+
               |
              ICall

Represents a voice/video call.

Instance Methods
 
__repr__(self)
repr(x)		 source code
 
Answer(self)
Answers the call.		 source code
bool
CanTransfer(self, Target)
Queries if a call can be transferred to a contact or phone number.		 source code
unicode, dict or None
CaptureMicDevice(self, DeviceType=None, Set=None)
Queries or sets the mic capture device.		 source code
 
Finish(self)
Ends the call.		 source code
 
Forward(self)
Forwards a call.		 source code
 
Hold(self)
Puts the call on hold.		 source code
unicode, dict or None
InputDevice(self, DeviceType=None, Set=None)
Queries or sets the sound input device.		 source code
IConference
Join(self, Id)
Joins with another call to form a conference.		 source code
 
MarkAsSeen(self)
Marks the call as seen.		 source code
unicode, dict or None
OutputDevice(self, DeviceType=None, Set=None)
Queries or sets the sound output device.		 source code
 
RedirectToVoicemail(self)
Redirects a call to voicemail.		 source code
 
Resume(self)
Resumes the held call.		 source code
 
StartVideoReceive(self)
Starts video receive.		 source code
 
StartVideoSend(self)
Starts video send.		 source code
 
StopVideoReceive(self)
Stops video receive.		 source code
 
StopVideoSend(self)
Stops video send.		 source code
 
Transfer(self, *Targets)
Transfers a call to one or more contacts or phone numbers.		 source code

Inherited from utils.Cached: __copy__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Static Methods

Inherited from utils.Cached: __new__

Class Variables

Inherited from utils.Cached: _cache_

Properties
int ConferenceId
ConferenceId.
datetime.datetime Datetime
Date and time of the call.
unicode DTMF
Set this property to send DTMF codes.
int Duration
Duration of the call in seconds.
Call failure reason FailureReason
Call failure reason.
unicode ForwardedBy
Skypename of the user who forwarded a call.
int Id
Call Id.
bool InputStatus
True if call voice input is enabled.
tuple of IParticipant Participants
Participants of a conference call not hosted by the user.
unicode PartnerDisplayName
The DisplayName of the remote caller.
unicode PartnerHandle
The Skypename of the remote caller.
unicode PstnNumber
PSTN number of the call.
unicode PstnStatus
PSTN number status.
int Rate
Call rate.
unicode RateCurrency
Call rate currency.
int RatePrecision
Call rate precision.
unicode RateToText
Returns the call rate as a text with currency and properly formatted value.
float RateValue
Call rate value.
bool Seen
Queries/sets the seen status of the call.
Call status Status
The call status.
unicode Subject
Call subject.
unicode TargetIdentify
Target number for incoming SkypeIn calls.
float Timestamp
Call date and time expressed as a timestamp.
bool TransferActive
Returns True if the call has been transfered.
unicode TransferredBy
Returns the Skypename of the user who transferred the call.
unicode TransferredTo
Returns the Skypename of the user or phone number the call has been transferred to.
Call status TransferStatus
Returns the call transfer status.
Call type Type
Call type.
Call video send status VideoReceiveStatus
Call video receive status.
Call video send status VideoSendStatus
Call video send status.
Call video status VideoStatus
Call video status.
int VmAllowedDuration
Returns the permitted duration of a voicemail in seconds.
int VmDuration
Returns the duration of a voicemail.

Inherited from object: __class__

Method Details

__repr__(self)
(Representation operator)

source code 

repr(x)

Overrides: object.__repr__
(inherited documentation)

CanTransfer(self, Target)

source code 

Queries if a call can be transferred to a contact or phone number.

Parameters:
  • Target (unicode) - Skypename or phone number the call is to be transfered to.
Returns: bool
True if call can be transfered, False otherwise.

CaptureMicDevice(self, DeviceType=None, Set=None)

source code 

Queries or sets the mic capture device.

Parameters:
  • DeviceType (Call IO device type or None) - Mic capture device type or None.
  • Set (unicode, int or None) - Value the device should be set to or None.
Returns: unicode, dict or None
If DeviceType and Set are None, returns a dictionary of device types and their values. Dictionary contains only those device types, whose values were set. If the DeviceType is not None but Set is None, returns the current value of the device or None if the device wasn't set. If Set is not None, sets a new value for the device.

Note: This command functions for active calls only.

InputDevice(self, DeviceType=None, Set=None)

source code 

Queries or sets the sound input device.

Parameters:
  • DeviceType (Call IO device type or None) - Sound input device type or None.
  • Set (unicode, int or None) - Value the device should be set to or None.
Returns: unicode, dict or None
If DeviceType and Set are None, returns a dictionary of device types and their values. Dictionary contains only those device types, whose values were set. If the DeviceType is not None but Set is None, returns the current value of the device or None if the device wasn't set. If Set is not None, sets a new value for the device.

Note: This command functions for active calls only.

Join(self, Id)

source code 

Joins with another call to form a conference.

Parameters:
  • Id (int) - Call Id of the other call to join to the conference.
Returns: IConference
Conference object.

OutputDevice(self, DeviceType=None, Set=None)

source code 

Queries or sets the sound output device.

Parameters:
  • DeviceType (Call IO device type or None) - Sound output device type or None.
  • Set (unicode, int or None) - Value the device should be set to or None.
Returns: unicode, dict or None
If DeviceType and Set are None, returns a dictionary of device types and their values. Dictionary contains only those device types, whose values were set. If the DeviceType is not None but Set is None, returns the current value of the device or None if the device wasn't set. If Set is not None, sets a new value for the device.

Note: This command functions for active calls only.

Transfer(self, *Targets)

source code 

Transfers a call to one or more contacts or phone numbers.

Parameters:
  • Targets (unicode) - one or more phone numbers or Skypenames the call is beeing transferred to.

See Also: CanTransfer

Note: You can transfer an incoming call to a group by specifying more than one target, first one of the group to answer will get the call.


Property Details

ConferenceId

ConferenceId.

Get Method:
_GetConferenceId(self)
Type:
int

Datetime

Date and time of the call.

Get Method:
_GetDatetime(self)
Type:
datetime.datetime

See Also: Timestamp

DTMF

Set this property to send DTMF codes.

Set Method:
_SetDTMF(self, value)
Type:
unicode

Note: This command functions for active calls only.

Duration

Duration of the call in seconds.

Get Method:
_GetDuration(self)
Type:
int

FailureReason

Call failure reason. Read if Status == clsFailed.

Get Method:
_GetFailureReason(self)
Type:
Call failure reason

ForwardedBy

Skypename of the user who forwarded a call.

Get Method:
_GetForwardedBy(self)
Type:
unicode

Id

Call Id.

Get Method:
_GetId(self)
Type:
int

InputStatus

True if call voice input is enabled.

Get Method:
_GetInputStatus(self)
Type:
bool

Participants

Participants of a conference call not hosted by the user.

Get Method:
_GetParticipants(self)
Type:
tuple of IParticipant

PartnerDisplayName

The DisplayName of the remote caller.

Get Method:
_GetPartnerDisplayName(self)
Type:
unicode

PartnerHandle

The Skypename of the remote caller.

Get Method:
_GetPartnerHandle(self)
Type:
unicode

PstnNumber

PSTN number of the call.

Get Method:
_GetPstnNumber(self)
Type:
unicode

PstnStatus

PSTN number status.

Get Method:
_GetPstnStatus(self)
Type:
unicode

Rate

Call rate. Expressed using RatePrecision. If you're just interested in the call rate expressed in current currency, use RateValue instead.

Get Method:
_GetRate(self)
Type:
int

See Also: RateCurrency, RatePrecision, RateToText, RateValue

RateCurrency

Call rate currency.

Get Method:
_GetRateCurrency(self)
Type:
unicode

See Also: Rate, RatePrecision, RateToText, RateValue

RatePrecision

Call rate precision. Expressed as a number of times the call rate has to be divided by 10.

Get Method:
_GetRatePrecision(self)
Type:
int

See Also: Rate, RateCurrency, RateToText, RateValue

RateToText

Returns the call rate as a text with currency and properly formatted value.

Get Method:
_GetRateToText(self)
Type:
unicode

See Also: Rate, RateCurrency, RatePrecision, RateValue

RateValue

Call rate value. Expressed in current currency.

Get Method:
_GetRateValue(self)
Type:
float

See Also: Rate, RateCurrency, RatePrecision, RateToText

Seen

Queries/sets the seen status of the call. True if the call was seen, False otherwise.

Get Method:
_GetSeen(self)
Set Method:
_SetSeen(self, value)
Type:
bool

Note: You cannot alter the call seen status from seen to unseen.

Status

The call status.

Get Method:
_GetStatus(self)
Set Method:
_SetStatus(self, value)
Type:
Call status

Subject

Call subject.

Get Method:
_GetSubject(self)
Type:
unicode

TargetIdentify

Target number for incoming SkypeIn calls.

Get Method:
_GetTargetIdentify(self)
Type:
unicode

Timestamp

Call date and time expressed as a timestamp.

Get Method:
_GetTimestamp(self)
Type:
float

See Also: Datetime

TransferActive

Returns True if the call has been transfered.

Get Method:
_GetTransferActive(self)
Type:
bool

TransferredBy

Returns the Skypename of the user who transferred the call.

Get Method:
_GetTransferredBy(self)
Type:
unicode

TransferredTo

Returns the Skypename of the user or phone number the call has been transferred to.

Get Method:
_GetTransferredTo(self)
Type:
unicode

TransferStatus

Returns the call transfer status.

Get Method:
_GetTransferStatus(self)
Type:
Call status

Type

Call type.

Get Method:
_GetType(self)
Type:
Call type

VideoReceiveStatus

Call video receive status.

Get Method:
_GetVideoReceiveStatus(self)
Type:
Call video send status

VideoSendStatus

Call video send status.

Get Method:
_GetVideoSendStatus(self)
Type:
Call video send status

VideoStatus

Call video status.

Get Method:
_GetVideoStatus(self)
Type:
Call video status

VmAllowedDuration

Returns the permitted duration of a voicemail in seconds.

Get Method:
_GetVmAllowedDuration(self)
Type:
int

VmDuration

Returns the duration of a voicemail.

Get Method:
_GetVmDuration(self)
Type:
int

   Home       Trees       Indices       Help   
Skype4Py
Generated by Epydoc 3.0.1 on Wed Nov 05 14:54:59 2008 http://epydoc.sourceforge.net