Package Skype4Py :: Module callchannel :: Class ICallChannelManager
[frames] | no frames]

Class ICallChannelManager

source code

             object --+    
                      |    
utils.EventHandlingBase --+
                          |
                         ICallChannelManager

Instatinate this class to create a call channel manager. A call channel manager will automatically create a data channel for voice calls based on the APP2APP protocol.

  1. Usage.

    You should access this class using the alias at the package level:

       import Skype4Py
    
       skype = Skype4Py.Skype()
    
       ccm = Skype4Py.CallChannelManager()
       ccm.Connect(skype)
    

    For possible constructor arguments, read the ICallChannelManager.__init__ description.

  2. Events.

    This class provides events.

    The events names and their arguments lists can be found in ICallChannelManagerEvents class.

    The usage of events is described in EventHandlingBase class which is a superclass of this class. Follow the link for more information.

Instance Methods
 
__del__(self) source code
 
__init__(self, Events=None)
__init__.
source code
 
Connect(self, Skype)
Connects this call channel manager instance to Skype.
source code
 
CreateApplication(self, ApplicationName=None)
Creates an APP2APP application context.
source code
 
Disconnect(self)
Disconnects from Skype.
source code

Inherited from utils.EventHandlingBase: RegisterEventHandler, UnregisterEventHandler

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

Instance Variables
callable OnChannels
Event handler for ICallChannelManagerEvents.Channels event.
callable OnCreated
Event handler for ICallChannelManagerEvents.Created event.
callable OnMessage
Event handler for ICallChannelManagerEvents.Message event.
Properties
tuple of ICallChannel Channels
All call data channels.
Call channel type ChannelType
Queries/sets the default channel type.
bool Created
Returns True if the application context has been created.
unicode Name
Queries/sets the application context name.

Inherited from object: __class__

Method Details

__init__(self, Events=None)
(Constructor)

source code 

__init__.

Parameters:
  • Events (An optional object with event handlers. See EventHandlingBase for more information on events.) - Events
Overrides: object.__init__

Connect(self, Skype)

source code 

Connects this call channel manager instance to Skype. This is the first thing you should do after creating this object.

Parameters:
  • Skype (ISkype) - Skype object

See Also: Disconnect

CreateApplication(self, ApplicationName=None)

source code 

Creates an APP2APP application context. The application is automatically created using IApplication.Create.

Parameters:
  • ApplicationName (unicode) - Application name

Disconnect(self)

source code 

Disconnects from Skype.

See Also: Connect


Instance Variable Details

OnChannels

Event handler for ICallChannelManagerEvents.Channels event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnCreated

Event handler for ICallChannelManagerEvents.Created event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

OnMessage

Event handler for ICallChannelManagerEvents.Message event. See EventHandlingBase for more information on events.
Get Method:
unreachable(self)
Set Method:
unreachable(self, value)

Property Details

Channels

All call data channels.

Get Method:
_GetChannels(self)
Type:
tuple of ICallChannel

ChannelType

Queries/sets the default channel type.

Get Method:
_GetChannelType(self)
Set Method:
_SetChannelType(self, ChannelType)
Type:
Call channel type

Created

Returns True if the application context has been created.

Get Method:
_GetCreated(self)
Type:
bool

Name

Queries/sets the application context name.

Get Method:
_GetName(self)
Set Method:
_SetName(self, Name)
Type:
unicode