CollaboratorsManager
Table of contents
Tracks remote peers and exposes the collaborator-related queries used by the editor and its overlays. Encapsulates the visibility clock that periodically re-evaluates which collaborators should be visible based on activity.
Accessed via Editor.collaborators.
class CollaboratorsManager {}Constructor
Constructs a new instance of the CollaboratorsManager class
Parameters
| Name | Description |
|---|---|
|
Methods
getCollaborators( )
Returns a list of presence records for all peer collaborators. This will return the latest presence record for each connected user.
getCollaborators(): TLInstancePresence[];getCollaboratorsOnCurrentPage( )
Returns a list of presence records for all peer collaborators on the current page. This will return the latest presence record for each connected user.
getCollaboratorsOnCurrentPage(): TLInstancePresence[];getVisibleCollaborators( )
Returns a list of presence records for peer collaborators who should currently be shown in the UI. Filters CollaboratorsManager.getCollaborators by activity state (active / idle / inactive) and visibility rules such as following and highlighted users. Re-evaluates on the visibility clock, so callers don't need to drive their own activity timer.
getVisibleCollaborators(): TLInstancePresence[];getVisibleCollaboratorsOnCurrentPage( )
Returns a list of presence records for peer collaborators who should currently be shown in the UI, filtered to those on the current page.
getVisibleCollaboratorsOnCurrentPage(): TLInstancePresence[];