Class PlatformService Abstract

Hierarchy

PlatformService

Constructors

constructor

new PlatformService(): PlatformService

Returns PlatformService

Properties

Protected displayMetricsChanged

displayMetricsChanged: Subject<void> = ...

Protected fileTransferStarted

fileTransferStarted: Subject<FileTransfer> = ...

supportsWindowControls

supportsWindowControls: boolean = false

Protected themeChanged

themeChanged: Subject<PlatformTheme> = ...

Accessors

displayMetricsChanged$

get displayMetricsChanged$(): Observable<void>

- Defined in tabby-core/src/api/platform.ts:117
Returns Observable<void>

fileTransferStarted$

get fileTransferStarted$(): Observable<FileTransfer>

- Defined in tabby-core/src/api/platform.ts:116
Returns Observable<FileTransfer>

themeChanged$

get themeChanged$(): Observable<PlatformTheme>

- Defined in tabby-core/src/api/platform.ts:118
Returns Observable<PlatformTheme>

Methods

exec

exec(app: string, argv: string[]): Promise<void>

- Defined in tabby-core/src/api/platform.ts:205
Parameters
- app: string
- argv: string[]
Returns Promise<void>

Abstract getAppVersion

getAppVersion(): string

- Defined in tabby-core/src/api/platform.ts:234
Returns string

getConfigPath

getConfigPath(): null | string

- Defined in tabby-core/src/api/platform.ts:181
Returns null | string

Abstract getOSRelease

getOSRelease(): string

- Defined in tabby-core/src/api/platform.ts:233
Returns string

getTheme

getTheme(): PlatformTheme

- Defined in tabby-core/src/api/platform.ts:229
Returns PlatformTheme

getWinSCPPath

getWinSCPPath(): null | string

- Defined in tabby-core/src/api/platform.ts:201
Returns null | string

installPlugin

installPlugin(name: string, version: string): Promise<void>

- Defined in tabby-core/src/api/platform.ts:193
Parameters
- name: string
- version: string
Returns Promise<void>

installShellIntegration

installShellIntegration(): Promise<void>

- Defined in tabby-core/src/api/platform.ts:217
Returns Promise<void>

isProcessRunning

isProcessRunning(name: string): Promise<boolean>

- Defined in tabby-core/src/api/platform.ts:189
Parameters
- name: string
Returns Promise<boolean>

isShellIntegrationInstalled

isShellIntegrationInstalled(): Promise<boolean>

- Defined in tabby-core/src/api/platform.ts:213
Returns Promise<boolean>

isShellIntegrationSupported

isShellIntegrationSupported(): boolean

- Defined in tabby-core/src/api/platform.ts:209
Returns boolean

Abstract listFonts

listFonts(): Promise<string[]>

- Defined in tabby-core/src/api/platform.ts:236
Returns Promise<string[]>

Abstract loadConfig

loadConfig(): Promise<string>

- Defined in tabby-core/src/api/platform.ts:126
Returns Promise<string>

Abstract openExternal

openExternal(url: string): void

- Defined in tabby-core/src/api/platform.ts:235
Parameters
- url: string
Returns void

openPath

openPath(path: string): void

- Defined in tabby-core/src/api/platform.ts:225
Parameters
- path: string
Returns void

Abstract pickDirectory

pickDirectory(): Promise<string>

- Defined in tabby-core/src/api/platform.ts:240
Returns Promise<string>

Abstract popupContextMenu

popupContextMenu(menu: MenuItemOptions[], event?: MouseEvent): void

- Defined in tabby-core/src/api/platform.ts:238
Parameters
- menu: MenuItemOptions[]
- Optional event: MouseEvent
Returns void

Abstract quit

quit(): void

- Defined in tabby-core/src/api/platform.ts:241
Returns void

Abstract readClipboard

readClipboard(): string

- Defined in tabby-core/src/api/platform.ts:124
Returns string

Abstract saveConfig

saveConfig(content: string): Promise<void>

- Defined in tabby-core/src/api/platform.ts:127
Parameters
- content: string
Returns Promise<void>

Abstract setClipboard

setClipboard(content: ClipboardContent): void

- Defined in tabby-core/src/api/platform.ts:125
Parameters
- content: ClipboardContent
Returns void

Abstract setErrorHandler

setErrorHandler(handler: ((_: any) => void)): void

- Defined in tabby-core/src/api/platform.ts:237
Parameters
- handler: ((_: any) => void)
  - - (_: any): void
    - Parameters
      - _: any
      Returns void
Returns void

showItemInFolder

showItemInFolder(path: string): void

- Defined in tabby-core/src/api/platform.ts:185
Parameters
- path: string
Returns void

Abstract showMessageBox

showMessageBox(options: MessageBoxOptions): Promise<MessageBoxResult>

- Defined in tabby-core/src/api/platform.ts:239
Parameters
- options: MessageBoxOptions
Returns Promise<MessageBoxResult>

Abstract startDownload

startDownload(name: string, mode: number, size: number): Promise<null | FileDownload>

- Defined in tabby-core/src/api/platform.ts:129
Parameters
- name: string
- mode: number
- size: number
Returns Promise<null | FileDownload>

Abstract startUpload

startUpload(options?: FileUploadOptions): Promise<FileUpload[]>

- Defined in tabby-core/src/api/platform.ts:130
Parameters
- Optional options: FileUploadOptions
Returns Promise<FileUpload[]>

Abstract startUploadDirectory

startUploadDirectory(paths?: string[]): Promise<DirectoryUpload>

- Defined in tabby-core/src/api/platform.ts:131
Parameters
- Optional paths: string[]
Returns Promise<DirectoryUpload>

startUploadFromDragEvent

startUploadFromDragEvent(event: DragEvent, multiple?: boolean): Promise<DirectoryUpload>

- Defined in tabby-core/src/api/platform.ts:133
Parameters
- event: DragEvent
- multiple: boolean = false
Returns Promise<DirectoryUpload>

uninstallPlugin

uninstallPlugin(name: string): Promise<void>

- Defined in tabby-core/src/api/platform.ts:197
Parameters
- name: string
Returns Promise<void>

uninstallShellIntegration

uninstallShellIntegration(): Promise<void>

- Defined in tabby-core/src/api/platform.ts:221
Returns Promise<void>

Generated using TypeDoc