Home       Trees       Indices       Help   
Skype4Py
Package Skype4Py :: Module user :: Class Group
[frames] | no frames]

Class Group

source code

  object --+    
           |    
utils.Cached --+
               |
              Group
Represents a group of Skype users.
Instance Methods
 
__repr__(self)
repr(x)		 source code
 
Accept(self)
Accepts an invitation to join a shared contact group.		 source code
 
AddUser(self, Username)
Adds new a user to the group.		 source code
 
Decline(self)
Declines an invitation to join a shared contact group.		 source code
 
RemoveUser(self, Username)
Removes a user from the group.		 source code
 
Share(self, MessageText='')
Shares a contact group.		 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__

Properties
str CustomGroupId
Persistent group ID.
unicode DisplayName
Display name of the group.
int Id
Group Id.
bool IsExpanded
Tells if the group is expanded in the client.
bool IsVisible
Tells if the group is visible in the client.
UserCollection OnlineUsers
Users of the group that are online
enums.grp* Type
Group type.
UserCollection Users
Users in this group.

Inherited from object: __class__

Method Details

__repr__(self)
(Representation operator)

source code 

repr(x)

Overrides: object.__repr__
(inherited documentation)

AddUser(self, Username)

source code 
Adds new a user to the group.
Parameters:
  • Username (str) - Skypename of the new user.

RemoveUser(self, Username)

source code 
Removes a user from the group.
Parameters:
  • Username (str) - Skypename of the user.

Share(self, MessageText='')

source code 
Shares a contact group.
Parameters:
  • MessageText (unicode) - Message text for group members.

Property Details

CustomGroupId

Persistent group ID. The custom group ID is a persistent value that does not change.
Get Method:
_GetCustomGroupId(self)
Type:
str

DisplayName

Display name of the group.
Get Method:
_GetDisplayName(self)
Set Method:
_SetDisplayName(self, Value)
Type:
unicode

Id

Group Id.
Get Method:
_GetId(self)
Type:
int

IsExpanded

Tells if the group is expanded in the client.
Get Method:
_GetIsExpanded(self)
Type:
bool

IsVisible

Tells if the group is visible in the client.
Get Method:
_GetIsVisible(self)
Type:
bool

OnlineUsers

Users of the group that are online
Get Method:
_GetOnlineUsers(self)
Type:
UserCollection

Type

Group type.
Get Method:
_GetType(self)
Type:
enums.grp*

Users

Users in this group.
Get Method:
_GetUsers(self)
Type:
UserCollection

   Home       Trees       Indices       Help   
Skype4Py
Generated by Epydoc 3.0.1 on Sat Sep 26 16:13:06 2009 http://epydoc.sourceforge.net