IPWorks MQ 2020 Python Edition

Questions / Feedback?

on_sync Event

This event fires upon a complete information synchronization with the server.

Syntax

class XMPPSyncEventParams(object):

# In class XMPP:
@property
def on_sync() -> Callable[[XMPPSyncEventParams], None]: ...
@on_sync.setter
def on_sync(event_hook: Callable[[XMPPSyncEventParams], None]) -> None: ...

Remarks

The on_sync event will fire after each successful call to the retrieve_roster method. When the event fires, the buddy list, or roster, will be completely retrieved and the buddies properties will be filled out accordingly:

Id the jabber ids associated with the buddies
Group the group associated with each entry (if a buddy is in more than one group, they will have multiple entries in the buddy list)
Subscription the subscription type for each buddy

Please refer to buddies properties property for more information.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks MQ 2020 Python Edition - Version 20.0 [Build 8155]