Extension | Flywheel Extension SDK

Hierarchy

Extension

Index

Constructors

constructor

Properties

Constructors

constructor

new Extension(options?: ExtensionOptions): Extension

- Defined in src/extension.ts:25
Parameters
- Default value options: ExtensionOptions = {}
Returns Extension

Properties

channel

channel: Channel

container

container: Container

file

file: File

params

params: ViewerParameters

user

user: User

Methods

addTag

addTag(target: Container | File, tag: string): Promise<void>

- Defined in src/extension.ts:435
Add a tag to a container or file.

Parameters
- target: Container | File
  
  Container or file to add the tag to
- tag: string
  
  Tag value to add
Returns Promise<void>

close

close(): void

- Defined in src/extension.ts:73
Signal to Flywheel that this application is ready to close, and terminate the message channel.

Returns void

executeDataView

executeDataView(id: ContainerID, body: DataViewPayloadBody): Promise<DataViewResponse>

- Defined in src/extension.ts:296
Execute an ad-hoc view, returning data in the preferred format.

Parameters
- id: ContainerID
  
  ID of the container
- body: DataViewPayloadBody
  
  Object specifying the criteria of a DataView to be created.
Returns Promise<DataViewResponse>

getArchiveMembers

getArchiveMembers(file: File): Promise<ArchiveMemberInfo>
getArchiveMembers(container: Container, file: File): Promise<ArchiveMemberInfo>

- Defined in src/extension.ts:269
Get information about the files within an archive file.

since

Flywheel 16.3.0

Parameters
- file: File
  
  Archive file instance
Returns Promise<ArchiveMemberInfo>
- Defined in src/extension.ts:273
deprecated

container is not required as of Flywheel 16.3.0

Parameters
- container: Container
- file: File
Returns Promise<ArchiveMemberInfo>

getChildContainers

getChildContainers(parent: Container, type: ContainerType, query?: SearchParameters): Promise<Paginated<Container[]>>

- Defined in src/extension.ts:116
Get a list of containers that are children of the given parent container, of a given type, and matching a query if provided.

Parameters
- parent: Container
  
  Parent container
- type: ContainerType
  
  Type of child container to retrieve
- Default value query: SearchParameters = {}
  
  Search parameters
Returns Promise<Paginated<Container[]>>

A pagination response with current and total items

getContainer

getContainer(type: ContainerType, id: ContainerID): Promise<Container>

- Defined in src/extension.ts:93
Get a container in the hierarchy.

Parameters
- type: ContainerType
  
  Type of the container
- id: ContainerID
  
  ID of the container
Returns Promise<Container>

getContainerPermissions

getContainerPermissions(container: Container): Promise<Set<PermissionAction>>

- Defined in src/extension.ts:151
Get the set of permission actions that the user can take on a container.

Parameters
- container: Container
  
  Container in the hierarchy
Returns Promise<Set<PermissionAction>>

getFile

getFile(fileId: string, options?: { version?: number }): Promise<File>

- Defined in src/extension.ts:173
Get a file record by unique ID.

since

Flywheel 16.18.0

Parameters
- fileId: string
  
  file_id that identifies the file across the Flywheel site
- Default value options: { version?: number } = {}
  
  Additional options, such as a specific version of the file
  - Optional version?: number
Returns Promise<File>

File record

getFileBlob

getFileBlob(file: File, options?: FileGetOptions): Promise<Blob>
getFileBlob(container: Container, file: File, options?: FileGetOptions): Promise<Blob>

- Defined in src/extension.ts:194
Get the contents of a file as a binary Blob.

since

Flywheel 16.3.0

Parameters
- file: File
  
  File instance
- Optional options: FileGetOptions
  
  Options for this action
Returns Promise<Blob>
- Defined in src/extension.ts:199
deprecated

container is not required as of Flywheel 16.3.0

Parameters
- container: Container
  
  Container that the file is attached to
- file: File
- Optional options: FileGetOptions
Returns Promise<Blob>

getFileText

getFileText(file: File, options?: FileGetOptions): Promise<string>
getFileText(container: Container, file: File, options?: FileGetOptions): Promise<string>

- Defined in src/extension.ts:223
Get the contents of a file as a string.

since

Flywheel 16.3.0

Parameters
- file: File
  
  File instance
- Optional options: FileGetOptions
  
  Options for this action
Returns Promise<string>
- Defined in src/extension.ts:228
deprecated

container is not required as of Flywheel 16.3.0

Parameters
- container: Container
  
  Container that the file is attached to
- file: File
- Optional options: FileGetOptions
Returns Promise<string>

getFileUrl

getFileUrl(file: File, options?: FileGetOptions): Promise<string>
getFileUrl(container: Container, file: File, options?: FileGetOptions): Promise<string>

- Defined in src/extension.ts:240
Get a parameterized URL to a file that will expire in a limited amount of time.

since

Flywheel 16.3.0

Parameters
- file: File
  
  File instance
- Optional options: FileGetOptions
  
  Options for this action
Returns Promise<string>
- Defined in src/extension.ts:245
deprecated

container is not required as of Flywheel 16.3.0

Parameters
- container: Container
  
  Container that the file is attached to
- file: File
- Optional options: FileGetOptions
Returns Promise<string>

listContainers

listContainers(type: ContainerType, query?: SearchParameters): Promise<Paginated<Container[]>>

- Defined in src/extension.ts:133
Get a list of containers of a certain type, and matching a query if provided.

Parameters
- type: ContainerType
  
  Type of container to retrieve
- Default value query: SearchParameters = {}
  
  Search parameters
Returns Promise<Paginated<Container[]>>

A pagination response with current and total items

readSetting

readSetting(containerId?: ContainerID, settingKey: string): Promise<any>

- Defined in src/extension.ts:394
Get a setting associated to a container in the hierarchy.

Parameters
- Default value containerId: ContainerID = "site"
  
  ID of the container. Defaults to 'site'
- settingKey: string
  
  Key of the setting
Returns Promise<any>

removeTag

removeTag(target: Container | File, tag: string): Promise<void>

- Defined in src/extension.ts:456
Remove a tag from a container or file.

Parameters
- target: Container | File
  
  Container or file to remove the tag from
- tag: string
  
  Tag value to remove
Returns Promise<void>

updateContainerInfo

updateContainerInfo(container: Container, info: InfoUpdate): Promise<void>

- Defined in src/extension.ts:315
Update the custom info of a container.

Parameters
- container: Container
  
  Container instance
- info: InfoUpdate
  
  Object specifying which info keys to set or delete, or a total replace object
Returns Promise<void>

updateFileInfo

updateFileInfo(file: File, info: InfoUpdate): Promise<void>
updateFileInfo(container: Container, file: File, info: InfoUpdate): Promise<void>

- Defined in src/extension.ts:325
Update the custom info of a file.

Parameters
- file: File
  
  File instance
- info: InfoUpdate
  
  Object specifying which info keys to set or delete, or a total replace object
Returns Promise<void>
- Defined in src/extension.ts:330
deprecated

container is not required as of Flywheel 16.3.0

Parameters
- container: Container
  
  Container that the file is attached to
- file: File
- info: InfoUpdate
Returns Promise<void>

updateViewport

updateViewport(viewport: { height?: number; width?: number }): void

- Defined in src/extension.ts:83
Update the height and/or width of the extension frame.

Parameters
- viewport: { height?: number; width?: number }
  
  Viewport dimensions
  - Optional height?: number
  - Optional width?: number
Returns void

uploadFile

uploadFile(container: Container, file: DOMFile, options?: { filename?: string; preserveMetadata?: boolean }): Observable<FileUploadEvent>

- Defined in src/extension.ts:366
Upload a file to a container. Upload progress is emitted as observable events. Use .toPromise() on the return value to get a Promise that resolves when the upload is complete.

Parameters
- container: Container
  
  Container that the file will be attached to
- file: DOMFile
  
  File instance from an <input> element or FileList
- Default value options: { filename?: string; preserveMetadata?: boolean } = {}
  - Optional filename?: string
    
    Override the name of the file, default to source filesystem name
  - Optional preserveMetadata?: boolean
    
    Copy info metadata from latest version to the new file version, if there is an existing version of the file. Available from Flywheel 16.8.0.
Returns Observable<FileUploadEvent>

Observable that emits upload progress events

waitForConnection

waitForConnection(): Promise<Extension>

- Defined in src/extension.ts:55
Wait for Flywheel to connect to this application.

Returns Promise<Extension>

writeSetting

writeSetting(containerId?: ContainerID, settingKey: string, data: any): Promise<void>

- Defined in src/extension.ts:414
Update a setting for the given container in the hierarchy.

Parameters
- Default value containerId: ContainerID = "site"
  
  ID of the container. Defaults to 'site'
- settingKey: string
  
  Key of the setting
- data: any
  
  Value of the setting
Returns Promise<void>

Generated using TypeDoc

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Default value options: ExtensionOptions = {}

Returns Extension

Properties

channel

container

file

params

user

Methods

addTag

Parameters

target: Container | File

tag: string

Returns Promise<void>

close

Returns void

executeDataView

Parameters

id: ContainerID

body: DataViewPayloadBody

Returns Promise<DataViewResponse>

getArchiveMembers

Parameters

file: File

Returns Promise<ArchiveMemberInfo>

Parameters

container: Container

file: File

Returns Promise<ArchiveMemberInfo>

getChildContainers

Parameters

parent: Container

type: ContainerType

Default value query: SearchParameters = {}

Returns Promise<Paginated<Container[]>>

getContainer

Parameters

type: ContainerType

id: ContainerID

Returns Promise<Container>

getContainerPermissions

Parameters

container: Container

Returns Promise<Set<PermissionAction>>

getFile

Parameters

fileId: string

Default value options: { version?: number } = {}

Optional version?: number

Returns Promise<File>

getFileBlob

Parameters

file: File

Optional options: FileGetOptions

Returns Promise<Blob>

Parameters

container: Container

file: File

Optional options: FileGetOptions

Returns Promise<Blob>

getFileText

Parameters

file: File

Optional options: FileGetOptions

Returns Promise<string>

Parameters

container: Container

file: File

Optional options: FileGetOptions

Returns Promise<string>

getFileUrl

Parameters