SyncPluginInstance
Unofficial
Plugin instance for Obsidian Sync, managing cloud synchronization of vault data.
Import:
import type { SyncPluginInstance } from '@obsidian-typings/obsidian-public-latest';Signature:
export interface SyncPluginInstance extends InternalPluginInstance<SyncPlugin>Extends: InternalPluginInstance<SyncPlugin>
Properties
| Property | Type | Description | |
|---|---|---|---|
| app | App | Reference to the app. | |
| description | string | Human-readable description of this plugin. (Inherited from InternalPluginInstance) | |
| id | string | Unique identifier for this plugin. (Inherited from InternalPluginInstance) | |
| name | string | Human-readable display name of this plugin. (Inherited from InternalPluginInstance) | |
| plugin | SyncPlugin | Reference to the sync plugin registration. |
Methods
| Method | Returns | Description | |
|---|---|---|---|
| init(app, plugin) | void | Initialize the plugin instance with app and plugin references. (Inherited from InternalPluginInstance) | |
| onDisable(app, plugin) | void | Called when the plugin is disabled. (Inherited from InternalPluginInstance) | |
| onEnable(app, plugin) | Promise<void> | Called when the plugin is enabled. (Inherited from InternalPluginInstance) | |
| onUserDisable(app) | void | Called when the user manually disables the plugin. (Inherited from InternalPluginInstance) | |
| onUserEnable(app) | void | Called when the user manually enables the plugin. (Inherited from InternalPluginInstance) |
Links to this page: