Class Extension

constructor

• new Extension(options?): Extension

• Parameters

  • options: ExtensionOptions = {}

  Returns Extension

channel

container

file

params

text

user

addTag

• addTag(target, tag): Promise<void>

• Add a tag to a container or file.

  Parameters

  • target: File | Container

    Container or file to add the tag to
  • tag: string

    Tag value to add

  Returns Promise<void>

close

• close(): void

• Signal to Flywheel that this application is ready to close, and terminate the message channel.

  Returns void

executeDataView

• executeDataView(id, body): Promise<DataViewResponse>

• Execute an ad-hoc view, returning data in the preferred format.

  Parameters

  • id: string

    ID of the container
  • body: DataViewPayloadBody

    Object specifying the criteria of a DataView to be created.

  Returns Promise<DataViewResponse>

getArchiveMembers

• getArchiveMembers(file): Promise<ArchiveMemberInfo>

• Get information about the files within an archive file.

  Parameters

  • file: File

    Archive file instance

  Returns Promise<ArchiveMemberInfo>

  Since

  Flywheel 16.3.0

• getArchiveMembers(container, file): Promise<ArchiveMemberInfo>

• Parameters

  • container: Container
  • file: File

  Returns Promise<ArchiveMemberInfo>

  Deprecated

  container is not required as of Flywheel 16.3.0

getChildContainers

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

• 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
  • query: SearchParameters = {}

    Search parameters

  Returns Promise<Paginated<Container[]>>

  A pagination response with current and total items

getContainer

• getContainer(type, id): Promise<Container>

• Get a container in the hierarchy.

  Parameters

  • type: ContainerType

    Type of the container
  • id: string

    ID of the container

  Returns Promise<Container>

getContainerPermissions

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

• 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, options?): Promise<File>

• Get a file record by unique ID.

  Parameters

  • fileId: string

    file_id that identifies the file across the Flywheel site
  • options: {
        version?: number;
    } = {}

    Additional options, such as a specific version of the file

    • Optional version?: number

  Returns Promise<File>

  File record

  Since

  Flywheel 16.18.0

getFileBlob

• getFileBlob(file, options?): Promise<Blob>

• Get the contents of a file as a binary Blob.

  Parameters

  • file: File

    File instance
  • Optional options: FileGetOptions

    Options for this action

  Returns Promise<Blob>

  Since

  Flywheel 16.3.0

• getFileBlob(container, file, options?): Promise<Blob>

• Parameters

  • container: Container

    Container that the file is attached to
  • file: File
  • Optional options: FileGetOptions

  Returns Promise<Blob>

  Deprecated

  container is not required as of Flywheel 16.3.0

getFileText

• getFileText(file, options?): Promise<string>

• Get the contents of a file as a string.

  Parameters

  • file: File

    File instance
  • Optional options: FileGetOptions

    Options for this action

  Returns Promise<string>

  Since

  Flywheel 16.3.0

• getFileText(container, file, options?): Promise<string>

• Parameters

  • container: Container

    Container that the file is attached to
  • file: File
  • Optional options: FileGetOptions

  Returns Promise<string>

  Deprecated

  container is not required as of Flywheel 16.3.0

getFileUrl

• getFileUrl(file, options?): Promise<string>

• Get a parameterized URL to a file that will expire in a limited amount of time.

  Parameters

  • file: File

    File instance
  • Optional options: FileGetOptions

    Options for this action

  Returns Promise<string>

  Since

  Flywheel 16.3.0

• getFileUrl(container, file, options?): Promise<string>

• Parameters

  • container: Container

    Container that the file is attached to
  • file: File
  • Optional options: FileGetOptions

  Returns Promise<string>

  Deprecated

  container is not required as of Flywheel 16.3.0

listContainers

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

• Get a list of containers of a certain type, and matching a query if provided.

  Parameters

  • type: ContainerType

    Type of container to retrieve
  • query: SearchParameters = {}

    Search parameters

  Returns Promise<Paginated<Container[]>>

  A pagination response with current and total items

readSetting

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

• Get a setting associated to a container in the hierarchy.

  Parameters

  • containerId: string = 'site'

    ID of the container. Defaults to 'site'
  • settingKey: string

    Key of the setting

  Returns Promise<any>

removeTag

• removeTag(target, tag): Promise<void>

• Remove a tag from a container or file.

  Parameters

  • target: File | Container

    Container or file to remove the tag from
  • tag: string

    Tag value to remove

  Returns Promise<void>

updateContainerInfo

• updateContainerInfo(container, info): Promise<void>

• 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, info): Promise<void>

• 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>
• updateFileInfo(container, file, info): Promise<void>

• Parameters

  • container: Container

    Container that the file is attached to
  • file: File
  • info: InfoUpdate

  Returns Promise<void>

  Deprecated

  container is not required as of Flywheel 16.3.0

updateViewport

• updateViewport(viewport): void

• 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, file, options?): Observable<FileUploadEvent>

• 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: File

    File instance from an <input> element or FileList
  • 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

uploadText

• uploadText(text): Promise<void>

• Upload a string back to the component which instantiated this extension. Used for editing strings in place without an associated file.

  Parameters

  • text: string

    String contents to be passed back to Flywheel Available from Flywheel 17.4.0

  Returns Promise<void>

  Promise signaling completion of upload

waitForConnection

• waitForConnection(): Promise<Extension>

• Wait for Flywheel to connect to this application.

  Returns Promise<Extension>

writeSetting

• writeSetting(containerId?, settingKey, data): Promise<void>

• Update a setting for the given container in the hierarchy.

  Parameters

  • containerId: string = 'site'

    ID of the container. Defaults to 'site'
  • settingKey: string

    Key of the setting
  • data: any

    Value of the setting

  Returns Promise<void>