# InstanceFileSyncService

Roblox Engine API class from Roblox Studio 0.744.0.7441077 (version-7aaa6838d36c4448).

- Inherits from, nearest first: [Instance](https://rapi.sleaze.dev/classes/Instance.md), [Object](https://rapi.sleaze.dev/classes/Object.md)
- Tags: Not creatable, Not replicated, Service
- Memory category: Instances
- HTML page: https://rapi.sleaze.dev/classes/InstanceFileSyncService/
- Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/InstanceFileSyncService

A service for interacting with file sync from a plugin.

## Methods

### GetAllInstances

```luau
InstanceFileSyncService:GetAllInstances(): { Instance }
```

- Tags: Plugin security

Returns an array of all instances currently involved in file synchronization.

Returns: Returns an array of [`Instances`](https://rapi.sleaze.dev/index/types/Instances.md).

### GetStatus

```luau
InstanceFileSyncService:GetStatus(instance: Instance): Enum.InstanceFileSyncStatus
```

- Tags: Plugin security

Returns the synchronization status of a specific instance.

Parameters:

- `instance`: The instance to check.

Returns: Returns the `InstanceFileSyncStatus` for the instance.

### GetSyncedInstance

```luau
InstanceFileSyncService:GetSyncedInstance(filePath: string): Instance
```

- Tags: Plugin security

Returns the instance corresponding to a given file path.

Parameters:

- `filePath`: The absolute path to the file.

Returns: Returns the Instance being synced to the file path, if one exists. Otherwise, returns nil.

### GetSyncingCollaborators

```luau
InstanceFileSyncService:GetSyncingCollaborators(instance: Instance): { any }
```

- Tags: Roblox script security

### GetTooltip

```luau
InstanceFileSyncService:GetTooltip(instance: Instance): string?
```

- Tags: Roblox script security

## Events

### StatusChanged

```luau
InstanceFileSyncService.StatusChanged: RBXScriptSignal<(instance: Instance, status: Enum.InstanceFileSyncStatus)>
```

- Tags: Plugin security

Fires when the synchronization status of an instance changes.

### SyncingCollaboratorsChanged

```luau
InstanceFileSyncService.SyncingCollaboratorsChanged: RBXScriptSignal<(instance: Instance)>
```

- Tags: Roblox script security

## Inherited members

- From [Instance](https://rapi.sleaze.dev/classes/Instance.md): `Archivable`, `archivable`, `Attributes`, `AttributesReplicate`, `AttributesSerialize`, `HistoryId`, `Name`, `Parent`, `PredictionMode`, `PropertyStatusStudio`, `RobloxLocked`, `SerializedOverrides`, `SourceAssetId`, `Tags`, `UniqueId`, `numExpectedDirectChildren`, `DataCost`, `Capabilities`, `DefinesCapabilities`, `IsInSandbox`, `Sandboxed`, `AddTag`, `ClearAllChildren`, `Clone`, `Destroy`, `FindFirstAncestor`, `FindFirstAncestorOfClass`, `FindFirstAncestorWhichIsA`, `FindFirstChild`, `FindFirstChildOfClass`, `FindFirstChildWhichIsA`, `FindFirstDescendant`, `GetActor`, `GetAttribute`, `GetAttributeChangedSignal`, `GetAttributes`, `GetChildren`, `GetDebugId`, `GetDescendants`, `GetFullName`, `GetStyled`, `GetStyledPropertyChangedSignal`, `GetTags`, `HasTag`, `IsAncestorOf`, `IsDescendantOf`, `IsPropertyModified`, `QueryDescendants`, `RemoveTag`, `ResetPropertyToDefault`, `SetAttribute`, `WaitForChild`, `Remove`, `children`, `clone`, `destroy`, `findFirstChild`, `getChildren`, `isDescendantOf`, `remove`, `AncestryChanged`, `AttributeChanged`, `ChildAdded`, `ChildRemoved`, `DescendantAdded`, `DescendantRemoving`, `Destroying`, `StyledPropertiesChanged`, `childAdded`
- From [Object](https://rapi.sleaze.dev/classes/Object.md): `ClassName`, `className`, `GetPropertyChangedSignal`, `IsA`, `isA`, `Changed`