Home       Trees       Indices       Help   
Skype4Py
Package Skype4Py :: Module chat :: Class Chat
[frames] | no frames]

Class Chat

source code

  object --+    
           |    
utils.Cached --+
               |
              Chat
Represents a Skype chat.
Instance Methods
 
__repr__(self)
repr(x)		 source code
 
AcceptAdd(self)
Accepts a shared group add request.		 source code
 
AddMembers(self, *Members)
Adds new members to the chat.		 source code
 
Bookmark(self)
Bookmarks the chat in Skype client.		 source code
 
ClearRecentMessages(self)
Clears recent chat messages.		 source code
 
Disband(self)
Ends the chat.		 source code
 
EnterPassword(self, Password)
Enters chat password.		 source code
 
Join(self)
Joins the chat.		 source code
 
Kick(self, *Handles)
Kicks member(s) from chat.		 source code
 
KickBan(self, *Handles)
Kicks and bans member(s) from chat.		 source code
 
Leave(self)
Leaves the chat.		 source code
 
OpenWindow(self)
Opens the chat window.		 source code
ChatMessage
SendMessage(self, MessageText)
Sends a chat message.		 source code
 
SetPassword(self, Password, Hint='')
Sets the chat password.		 source code
 
Unbookmark(self)
Unbookmarks the chat.		 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
UserCollection ActiveMembers
Active members of a chat.
datetime.datetime ActivityDatetime
Returns chat activity timestamp as datetime.
float ActivityTimestamp
Returns chat activity timestamp.
User Adder
Returns the user that added current user to the chat.
unicode AlertString
Chat alert string.
UserCollection Applicants
Chat applicants.
str Blob
Chat blob.
bool Bookmarked
Tells if this chat is bookmarked.
datetime.datetime Datetime
Chat timestamp as datetime.
unicode Description
Chat description.
str DialogPartner
Skypename of the chat dialog partner.
unicode FriendlyName
Friendly name of the chat.
unicode GuideLines
Chat guidelines.
ChatMemberCollection MemberObjects
Chat members as member objects.
UserCollection Members
Chat members.
ChatMessageCollection Messages
All chat messages.
enums.chatMemberRole* MyRole
My chat role in a public chat.
enums.chatStatus* MyStatus
My status in a public chat.
str Name
Chat name as used by Skype to identify this chat.
enums.chatOption* Options
Chat options.
unicode PasswordHint
Chat password hint.
UserCollection Posters
Users who have posted messages to this chat.
ChatMessageCollection RecentMessages
Most recent chat messages.
enums.chs* Status
Status.
float Timestamp
Chat timestamp.
unicode Topic
Chat topic.
unicode TopicXML
Chat topic in XML format.
enums.chatType* Type
Chat type.

Inherited from object: __class__

Method Details

__repr__(self)
(Representation operator)

source code 

repr(x)

Overrides: object.__repr__
(inherited documentation)

AddMembers(self, *Members)

source code 
Adds new members to the chat.
Parameters:
  • Members (User) - One or more users to add.

EnterPassword(self, Password)

source code 
Enters chat password.
Parameters:
  • Password (unicode) - Password

Kick(self, *Handles)

source code 
Kicks member(s) from chat.
Parameters:
  • Handles (str) - Skype username(s).

KickBan(self, *Handles)

source code 
Kicks and bans member(s) from chat.
Parameters:
  • Handles (str) - Skype username(s).

SendMessage(self, MessageText)

source code 
Sends a chat message.
Parameters:
  • MessageText (unicode) - Message text
Returns: ChatMessage
Message object

SetPassword(self, Password, Hint='')

source code 
Sets the chat password.
Parameters:
  • Password (unicode) - Password
  • Hint (unicode) - Password hint

Property Details

ActiveMembers

Active members of a chat.
Get Method:
_GetActiveMembers(self)
Type:
UserCollection

ActivityDatetime

Returns chat activity timestamp as datetime.
Get Method:
_GetActivityDatetime(self)
Type:
datetime.datetime

ActivityTimestamp

Returns chat activity timestamp.
Get Method:
_GetActivityTimestamp(self)
Type:
float

See Also: ActivityDatetime

Adder

Returns the user that added current user to the chat.
Get Method:
_GetAdder(self)
Type:
User

AlertString

Chat alert string. Only messages containing words from this string will cause a notification to pop up on the screen.
Set Method:
_SetAlertString(self, Value)
Type:
unicode

Applicants

Chat applicants.
Get Method:
_GetApplicants(self)
Type:
UserCollection

Blob

Chat blob.
Get Method:
_GetBlob(self)
Type:
str

Bookmarked

Tells if this chat is bookmarked.
Get Method:
_GetBookmarked(self)
Type:
bool

Datetime

Chat timestamp as datetime.
Get Method:
_GetDatetime(self)
Type:
datetime.datetime

Description

Chat description.
Get Method:
_GetDescription(self)
Set Method:
_SetDescription(self, Value)
Type:
unicode

DialogPartner

Skypename of the chat dialog partner.
Get Method:
_GetDialogPartner(self)
Type:
str

FriendlyName

Friendly name of the chat.
Get Method:
_GetFriendlyName(self)
Type:
unicode

GuideLines

Chat guidelines.
Get Method:
_GetGuideLines(self)
Set Method:
_SetGuideLines(self, Value)
Type:
unicode

MemberObjects

Chat members as member objects.
Get Method:
_GetMemberObjects(self)
Type:
ChatMemberCollection

Members

Chat members.
Get Method:
_GetMembers(self)
Type:
UserCollection

Messages

All chat messages.
Get Method:
_GetMessages(self)
Type:
ChatMessageCollection

MyRole

My chat role in a public chat.
Get Method:
_GetMyRole(self)
Type:
enums.chatMemberRole*

MyStatus

My status in a public chat.
Get Method:
_GetMyStatus(self)
Type:
enums.chatStatus*

Name

Chat name as used by Skype to identify this chat.
Get Method:
_GetName(self)
Type:
str

Options

Chat options. A mask.
Get Method:
_GetOptions(self)
Set Method:
_SetOptions(self, Value)
Type:
enums.chatOption*

PasswordHint

Chat password hint.
Get Method:
_GetPasswordHint(self)
Type:
unicode

Posters

Users who have posted messages to this chat.
Get Method:
_GetPosters(self)
Type:
UserCollection

RecentMessages

Most recent chat messages.
Get Method:
_GetRecentMessages(self)
Type:
ChatMessageCollection

Status

Status.
Get Method:
_GetStatus(self)
Type:
enums.chs*

Timestamp

Chat timestamp.
Get Method:
_GetTimestamp(self)
Type:
float

See Also: Datetime

Topic

Chat topic.
Get Method:
_GetTopic(self)
Set Method:
_SetTopic(self, Value)
Type:
unicode

TopicXML

Chat topic in XML format.
Get Method:
_GetTopicXML(self)
Set Method:
_SetTopicXML(self, Value)
Type:
unicode

Type

Chat type.
Get Method:
_GetType(self)
Type:
enums.chatType*

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