Roster item.

This represents one contact from an XMPP contact list known as roster.

Instance Variable entity The JID of the contact. (type: JID)
Instance Variable name The associated nickname for this contact. (type: unicode)
Instance Variable subscriptionTo Subscription state to contact's presence. If True, the roster owner is subscribed to the presence information of the contact. (type: bool)
Instance Variable subscriptionFrom Contact's subscription state. If True, the contact is subscribed to the presence information of the roster owner. (type: bool)
Instance Variable pendingOut Whether the subscription request to this contact is pending. (type: bool)
Instance Variable groups Set of groups this contact is categorized in. Groups are represented by an opaque identifier of type unicode. (type: set)
Instance Variable approved Signals pre-approved subscription. (type: bool)
Instance Variable remove Signals roster item removal. (type: bool)
Method __init__ Undocumented
Method toElement Render to a DOM representation.
Class Method fromElement Undocumented
Method __getJID Undocumented
Method __setJID Undocumented
Method __getAsk Undocumented
Method __setAsk Undocumented
entity =
The JID of the contact. (type: JID)
name =
The associated nickname for this contact. (type: unicode)
subscriptionTo =
Subscription state to contact's presence. If True, the roster owner is subscribed to the presence information of the contact. (type: bool)
subscriptionFrom =
Contact's subscription state. If True, the contact is subscribed to the presence information of the roster owner. (type: bool)
pendingOut =
Whether the subscription request to this contact is pending. (type: bool)
groups =
Set of groups this contact is categorized in. Groups are represented by an opaque identifier of type unicode. (type: set)
approved =
Signals pre-approved subscription. (type: bool)
remove =
Signals roster item removal. (type: bool)
def __init__(self, entity, subscriptionTo=False, subscriptionFrom=False, name=u'', groups=None): (source)
Undocumented
def __getJID(self): (source)
Undocumented
def __setJID(self, value): (source)
Undocumented
def __getAsk(self): (source)
Undocumented
def __setAsk(self, value): (source)
Undocumented
def toElement(self, rosterSet=False): (source)

Render to a DOM representation.

If rosterSet is set, some attributes, that may not be sent as a roster set, will not be rendered.

@classmethod
def fromElement(Class, element): (source)
Undocumented
API Documentation for wokkel, generated by pydoctor at 2018-12-06 14:45:46.