IChat Interface Reference

Chat class default interface. More...

import "Skype4COM.idl";

List of all members.

Public Member Functions
HRESULT	OpenWindow ()
	This command opens a chat window.
HRESULT	SendMessage ([in] BSTR MessageText,[out, retval] IChatMessage **pVal)
	This command sends a chat message.
HRESULT	Leave ()
	This command leaves a chat.
HRESULT	AddMembers ([in] IUserCollection *pMembers)
	This command adds new members to a chat.
HRESULT	Bookmark ()
	This command bookmarks a chat.
HRESULT	Unbookmark ()
	This command removes the bookmark for a chat.
HRESULT	SetPassword ([in] BSTR Password,[in, defaultvalue("")] BSTR Hint)
	Sets chat password.
HRESULT	Join (void)
	Joins the chat.
HRESULT	Kick ([in] BSTR Handle)
	Kicks member from chat.
HRESULT	KickBan ([in] BSTR Handle)
	Kicks and ban member from chat.
HRESULT	Disband (void)
	Ends chat.
HRESULT	EnterPassword ([in] BSTR Password)
	Enters chat password.
HRESULT	ClearRecentMessages (void)
	Clears recent chat messages.
HRESULT	AcceptAdd (void)
	Accepts shared group add.
Properties
BSTR	Name [get]
	This commmand queries the chat name.
IChatMessageCollection	Messages [get]
	This commmand queries chat messages.
DATE	Timestamp [get]
	This command queries the chat timestamp.
IUser	Adder [get]
	This command queries who added a user to a chat.
TChatStatus	Status [get]
	This command queries a chat status.
IUserCollection	Posters [get]
	This command queries users who have posted messages to a chat.
IUserCollection	Members [get]
	This command queries the members of a chat.
BSTR	Topic [get, set]
	This command queries/sets a chat topic.
IUserCollection	ActiveMembers [get]
	This command queries the active members of a chat.
BSTR	FriendlyName [get]
	This command queries the "friendly" name of a chat.
IChatMessageCollection	RecentMessages [get]
	This command queries the most recent chat messages.
VARIANT_BOOL	Bookmarked [get]
	This command queries if a chat is bookmarked.
BSTR	TopicXML [get, set]
	Returns/sets chat topic in XML format.
IChatMemberCollection	MemberObjects [get]
	Returns chat member objects collection.
BSTR	Blob [get]
	Returns chat blob.
LONG	Options [get, set]
	Returns/sets chat options.
BSTR	PasswordHint [get]
	Returns chat password hint.
BSTR	GuideLines [get, set]
	Returns/sets chat guidelines.
BSTR	Description [get, set]
	Returns/sets chat description.
BSTR	DialogPartner [get]
	Returns chat dialog partner.
DATE	ActivityTimestamp [get]
	Returns chat activity timestamp.
TChatMemberRole	MyRole [get]
	Returns my chat role.
IUserCollection	Applicants [get]
	Returns chat applicants collection.
BSTR	AlertString [set]
	Sets chat alert string.
TChatType	Type [get]
	Returns chat type.
TChatMyStatus	MyStatus [get]
	Returns my chat status.

---

Detailed Description

Chat class default interface.

---

Member Function Documentation

HRESULT AddMembers

(

[in] IUserCollection *

pMembers

)

This command adds new members to a chat.

Parameters:

[in]

pMembers

receives the interface pointer for the UserCollection object.

HRESULT EnterPassword

(

[in] BSTR

Password

)

Enters chat password.

Parameters:

[in]

Password

contains password string.

HRESULT SendMessage	(	[in] BSTR	MessageText,
		[out, retval] IChatMessage **	pVal
	)

This command sends a chat message.

Parameters:

[in]	MessageText	contains the message text.
[out]	pVal	receives the interface pointer for the ChatMessage object.

HRESULT SetPassword	(	[in] BSTR	Password,
		[in, defaultvalue("")] BSTR	Hint
	)

Sets chat password.

Parameters:

[in]	Password	contains password.
[in]	Hint	contains password hint.

See also:

IChat::PasswordHint

---

Property Documentation

HRESULT Options [get, set]

Returns/sets chat options.

See also:

TChatOptions

HRESULT Status [get]

This command queries a chat status.

Deprecated:

ICall::Status is deprecated, use the IChat::Type and IChat::MyStatus instead.

---

The documentation for this interface was generated from the following file:

• Skype4COM.idl