Package Skype4Py :: Module chat :: Class IChat
[frames] | no frames]

Class IChat

source code

  object --+    
           |    
utils.Cached --+
               |
              IChat

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, Handle)
Kicks a member from chat.
source code
 
KickBan(self, Handle)
Kicks and bans a member from chat.
source code
 
Leave(self)
Leaves the chat.
source code
 
OpenWindow(self)
Opens the chat window.
source code
IChatMessage
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__

Class Variables

Inherited from utils.Cached: _cache_

Properties
tuple of IUser ActiveMembers
Active members of a chat.
datetime.datetime ActivityDatetime
Returns chat activity timestamp as datetime.
float ActivityTimestamp
Returns chat activity timestamp.
IUser Adder
Returns the user that added current user to the chat.
unicode AlertString
Chat alert string.
tuple of IUser Applicants
Chat applicants.
unicode Blob
Chat blob.
bool Bookmarked
Tells if this chat is bookmarked.
datetime.datetime Datetime
Chat timestamp as datetime.
unicode Description
Chat description.
unicode DialogPartner
Skypename of the chat dialog partner.
unicode FriendlyName
Friendly name of the chat.
unicode GuideLines
Chat guidelines.
tuple of IChatMember MemberObjects
Chat members as member objects.
tuple of IUser Members
Chat members.
tuple of IChatMessage Messages
All chat messages.
Chat member role MyRole
My chat role in a public chat.
My chat status MyStatus
My status in a public chat.
unicode Name
Chat name as used by Skype to identify this chat.
Chat options Options
Chat options.
unicode PasswordHint
Chat password hint.
tuple of IUser Posters
Users who have posted messages to this chat.
tuple of IChatMessage RecentMessages
Most recent chat messages.
Chat status Status
Status.
float Timestamp
Chat timestamp.
unicode Topic
Chat topic.
unicode TopicXML
Chat topic in XML format.
Chat type 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 (IUser) - One or more users to add.

EnterPassword(self, Password)

source code 

Enters chat password.

Parameters:
  • Password (unicode) - Password

Kick(self, Handle)

source code 

Kicks a member from chat.

Parameters:
  • Handle (unicode) - Handle

KickBan(self, Handle)

source code 

Kicks and bans a member from chat.

Parameters:
  • Handle (unicode) - Handle

SendMessage(self, MessageText)

source code 

Sends a chat message.

Parameters:
  • MessageText (unicode) - Message text
Returns: IChatMessage
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:
tuple of IUser

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:
IUser

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:
tuple of IUser

Blob

Chat blob.

Get Method:
_GetBlob(self)
Type:
unicode

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:
unicode

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:
tuple of IChatMember

Members

Chat members.

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

Messages

All chat messages.

Get Method:
_GetMessages(self)
Type:
tuple of IChatMessage

MyRole

My chat role in a public chat.

Get Method:
_GetMyRole(self)
Type:
Chat member role

MyStatus

My status in a public chat.

Get Method:
_GetMyStatus(self)
Type:
My chat status

Name

Chat name as used by Skype to identify this chat.

Get Method:
_GetName(self)
Type:
unicode

Options

Chat options. A mask.

Get Method:
_GetOptions(self)
Set Method:
_SetOptions(self, value)
Type:
Chat options

PasswordHint

Chat password hint.

Get Method:
_GetPasswordHint(self)
Type:
unicode

Posters

Users who have posted messages to this chat.

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

RecentMessages

Most recent chat messages.

Get Method:
_GetRecentMessages(self)
Type:
tuple of IChatMessage

Status

Status.

Get Method:
_GetStatus(self)
Type:
Chat status

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:
Chat type