TrackingGroupCollection Class
A collection of ITrackingGroup.
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/merge-tree/legacy.
For more information about our API support guarantees, see here.
Signature
export declare class TrackingGroupCollection
Constructors
| Constructor | Alerts | Description |
|---|---|---|
| (constructor)(trackable) | Beta | Constructs a new instance of the TrackingGroupCollection class |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| empty | Beta | readonly | boolean | |
| trackingGroups | Beta | readonly | Set<TrackingGroup> |
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| copyTo(trackable) | Beta | void | |
| link(trackingGroup) | Beta | void | |
| matches(trackingCollection) | Beta | boolean | |
| unlink(trackingGroup) | Beta | boolean |
Constructor Details
(constructor)
Constructs a new instance of the TrackingGroupCollection class
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
constructor(trackable: Trackable);
Parameters
| Parameter | Type | Description |
|---|---|---|
| trackable | Trackable |
Property Details
empty
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
get empty(): boolean;
Type: boolean
trackingGroups
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
get trackingGroups(): Set<TrackingGroup>;
Type: Set<TrackingGroup>
Method Details
copyTo
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
copyTo(trackable: Trackable): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| trackable | Trackable |
link
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
link(trackingGroup: ITrackingGroup): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| trackingGroup | ITrackingGroup |
matches
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
matches(trackingCollection: TrackingGroupCollection): boolean;
Parameters
| Parameter | Type | Description |
|---|---|---|
| trackingCollection | TrackingGroupCollection |
Returns
Return type: boolean
unlink
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
unlink(trackingGroup: ITrackingGroup): boolean;
Parameters
| Parameter | Type | Description |
|---|---|---|
| trackingGroup | ITrackingGroup |
Returns
Return type: boolean