TelepathyGLib.RoomInfo

g GObject.Object GObject.Object TelepathyGLib.RoomInfo TelepathyGLib.RoomInfo GObject.Object->TelepathyGLib.RoomInfo

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

get_channel_type ()

get_description ()

get_handle ()

get_handle_name ()

get_invite_only (known)

get_members_count (known)

get_name ()

get_requires_password (known)

get_room_id ()

get_server ()

get_subject ()

Virtual Methods

Inherited:

GObject.Object (7)

Properties

None

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name

Type

Access

Description

parent

GObject.Object

r

priv

TelepathyGLib.RoomInfoPriv

r

Class Details

class TelepathyGLib.RoomInfo(**kwargs)
Bases:

GObject.Object

Abstract:

No

Structure:

TelepathyGLib.RoomInfoClass

Data structure representing a TelepathyGLib.RoomInfo.

New in version 0.19.0.

get_channel_type()
Returns:

a string representing the D-Bus interface name of the channel type of the room

Return type:

str

New in version 0.19.0.

get_description()
Returns:

a description of the room’s overall purpose

Return type:

str

New in version 0.19.0.

get_handle()
Returns:

the #TpHandle of the room

Return type:

int

New in version 0.19.0.

get_handle_name()
Returns:

the identifier of the room (as would be returned by inspecting the #TpHandle returned by TelepathyGLib.RoomInfo.get_handle())

Return type:

str

New in version 0.19.0.

get_invite_only(known)
Parameters:

known (bool) – either None, or a location in which to store True if the returned value is meaningful

Returns:

True if you cannot join the room, but must be invited

Return type:

bool

New in version 0.19.0.

get_members_count(known)
Parameters:

known (bool) – either None, or a location in which to store True if the returned value is meaningful

Returns:

the number of members in the room

Return type:

int

New in version 0.19.0.

get_name()
Returns:

the human-readable name of the room if different from the handle

Return type:

str

New in version 0.19.0.

get_requires_password(known)
Parameters:

known (bool) – either None, or a location in which to store True if the returned value is meaningful

Returns:

True if the room requires a password to enter

Return type:

bool

New in version 0.19.0.

get_room_id()
Returns:

the human-readable identifier of the room

Return type:

str

New in version 0.19.0.

get_server()
Returns:

the DNS name of the server hosting the room

Return type:

str

New in version 0.19.0.

get_subject()
Returns:

the current subject of conversation in the room

Return type:

str

New in version 0.19.0.