Infinity.CommunicationJoinedGroup¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
|
Virtual Methods¶
- Inherited:
Properties¶
- Inherited:
Name |
Type |
Flags |
Short Description |
|---|---|---|---|
r/w/co |
The communication method to use for this group |
||
r/w/co |
A connection to the group’s publisher |
Signals¶
- Inherited:
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
|---|---|---|---|
parent_instance |
r |
Class Details¶
- class Infinity.CommunicationJoinedGroup(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
Infinity.CommunicationJoinedGroupis an opaque data type. You should only access it via the public API functions.- get_publisher()¶
- Returns:
A
Infinity.XmlConnection, orNone.- Return type:
Returns a
Infinity.XmlConnectionto the group’s publisher, orNoneif the publisher is no longer a group member.
- remove_member(connection)¶
- Parameters:
connection (
Infinity.XmlConnection) – A connection to a member of self.
Removes connection as self's member. On the remote site, the corresponding
Infinity.CommunicationGroupneeds to be freed (which may be aInfinity.CommunicationJoinedGroupor aInfinity.CommunicationHostedGroup).
Property Details¶
- Infinity.CommunicationJoinedGroup.props.method¶
- Name:
method- Type:
- Default Value:
- Flags:
The communication method to use for this group
- Infinity.CommunicationJoinedGroup.props.publisher¶
- Name:
publisher- Type:
- Default Value:
- Flags:
A connection to the group’s publisher