Home       Trees       Indices       Help   
Skype4Py
Package Skype4Py :: Module application :: Class IApplication
[frames] | no frames]

Class IApplication

source code

  object --+    
           |    
utils.Cached --+
               |
              IApplication

Represents an application in APP2APP protocol. Use ISkype.Application to instatinate.

Instance Methods
 
__repr__(self)
repr(x)		 source code
IApplicationStream or None
Connect(self, Username, WaitConnected=False)
Connects application to user.		 source code
 
Create(self)
Creates the APP2APP application in Skype client.		 source code
 
Delete(self)
Deletes the APP2APP application in Skype client.		 source code
 
SendDatagram(self, Text, Streams=None)
Sends datagram to application streams.		 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
tuple of IUser ConnectableUsers
All connectable users.
tuple of IUser ConnectingUsers
All users connecting at the moment.
unicode Name
Name of the application.
tuple of IApplicationStream ReceivedStreams
All streams that received data and can be read.
tuple of IApplicationStream SendingStreams
All streams that send data and at the moment.
tuple of IApplicationStream Streams
All currently connected application streams.

Inherited from object: __class__

Method Details

__repr__(self)
(Representation operator)

source code 

repr(x)

Overrides: object.__repr__
(inherited documentation)

Connect(self, Username, WaitConnected=False)

source code 

Connects application to user.

Parameters:
  • Username (unicode) - Name of the user to connect to.
  • WaitConnected (bool) - If True, causes the method to wait untill the connection is established.
Returns: IApplicationStream or None
If WaitConnected is True, returns the stream which can be used to send the data. Otherwise returns None.

SendDatagram(self, Text, Streams=None)

source code 

Sends datagram to application streams.

Parameters:
  • Text (unicode) - Text to send.
  • Streams (sequence of IApplicationStream) - Streams to send the datagram to or None if all currently connected streams should be used.

Property Details

ConnectableUsers

All connectable users.

Get Method:
_GetConnectableUsers(self)
Type:
tuple of IUser

ConnectingUsers

All users connecting at the moment.

Get Method:
_GetConnectingUsers(self)
Type:
tuple of IUser

Name

Name of the application.

Get Method:
_GetName(self)
Type:
unicode

ReceivedStreams

All streams that received data and can be read.

Get Method:
_GetReceivedStreams(self)
Type:
tuple of IApplicationStream

SendingStreams

All streams that send data and at the moment.

Get Method:
_GetSendingStreams(self)
Type:
tuple of IApplicationStream

Streams

All currently connected application streams.

Get Method:
_GetStreams(self)
Type:
tuple of IApplicationStream

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