Class Files

Hierarchy (view full)

EventEmitter<FilesEvents>
- Files

Index

Constructors

Properties

#manager _events acl gp

Accessors

Methods

chooseFile fetch fetchMore loadContent off on once upload uploadContent uploadUrl

Constructors

constructor

new Files(gp, acl): Files
Parameters
- gp: CoreSDK
- acl: PlayerACL
Returns Files
Overrides EventEmitter.constructor
- Defined in core/files/Files.ts:23

Properties

`Private` #manager

#manager: default<FileInfo> = ...

`Private` _events

_events: EventLite = ...

`Private` acl

acl: PlayerACL

`Private` gp

Accessors

canUpload

get canUpload(): boolean
Returns boolean
- Defined in core/files/Files.ts:27

Methods

chooseFile

chooseFile(accept): Promise<FilePickerOutput>
Parameters
- accept: string
Returns Promise<FilePickerOutput>
- Defined in core/files/Files.ts:31

fetch

fetch(query?): Promise<FetchFilesOutput<FileInfo>>
Parameters
- query: FetchFilesInput = {}
Returns Promise<FetchFilesOutput<FileInfo>>
- Defined in core/files/Files.ts:78

fetchMore

fetchMore(query?): Promise<FetchFilesOutput<FileInfo>>
Parameters
- query: FetchFilesInput = {}
Returns Promise<FetchFilesOutput<FileInfo>>
- Defined in core/files/Files.ts:91

loadContent

loadContent(src): Promise<string>
Parameters
- src: string
Returns Promise<string>
- Defined in core/files/Files.ts:61

off

off<ET>(type, handler): void
Type Parameters
- ET extends keyof FilesEvents
Parameters
- type: ET
- handler: ((event, ...args) => void)
  - - (event, ...args): void
    - Parameters
      event: FilesEvents[ET]
      Rest ...args: any
      Returns void
Returns void
Inherited from EventEmitter.off
- Defined in core/events/EventEmitter.ts:12

on

on<ET>(type, handler): void
Type Parameters
- ET extends keyof FilesEvents
Parameters
- type: ET
- handler: ((event, ...args) => void)
  - - (event, ...args): void
    - Parameters
      event: FilesEvents[ET]
      Rest ...args: any
      Returns void
Returns void
Inherited from EventEmitter.on
- Defined in core/events/EventEmitter.ts:9

once

once<ET>(type, handler): void
Type Parameters
- ET extends keyof FilesEvents
Parameters
- type: ET
- handler: ((event, ...args) => void)
  - - (event, ...args): void
    - Parameters
      event: FilesEvents[ET]
      Rest ...args: any
      Returns void
Returns void
Inherited from EventEmitter.once
- Defined in core/events/EventEmitter.ts:15

upload

upload(query): Promise<FileInfo>
Parameters
- query: UploadPlayerFileInput
Returns Promise<FileInfo>
- Defined in core/files/Files.ts:40

uploadContent

uploadContent(query): Promise<FileInfo>
Parameters
- query: Omit<UploadPlayerFileInput, "file"> & {
  content: string;
  filename: string;
  }
Returns Promise<FileInfo>
- Defined in core/files/Files.ts:53

uploadUrl

uploadUrl(query): Promise<FileInfo>
Parameters
- query: Omit<UploadPlayerFileInput, "file"> & {
  filename: string;
  url: string;
  }
Returns Promise<FileInfo>
- Defined in core/files/Files.ts:57