Class Images

Hierarchy

EventEmitter<ImagesEvents>
- Images

Index

Constructors

constructor

Properties

Accessors

canUpload

Methods

Constructors

constructor

new Images(gp: CoreSDK, acl: PlayerACL): Images

Overrides EventEmitter.constructor
- Defined in core/images/Images.ts:24
Parameters
- gp: CoreSDK
- acl: PlayerACL
Returns Images

Properties

Private #manager

#manager: default<ImageInfo> = ...

Private _events

_events: EventLite = ...

Accessors

canUpload

get canUpload(): boolean

- Defined in core/images/Images.ts:28
Returns boolean

Methods

chooseFile

chooseFile(): Promise<FilePickerOutput>

- Defined in core/images/Images.ts:36
Returns Promise<FilePickerOutput>

fetch

fetch(query?: FetchImagesInput): Promise<FetchFilesOutput<ImageInfo>>

- Defined in core/images/Images.ts:87
Parameters
- query: FetchImagesInput = {}
Returns Promise<FetchFilesOutput<ImageInfo>>

fetchMore

fetchMore(query?: FetchImagesInput): Promise<FetchFilesOutput<ImageInfo>>

- Defined in core/images/Images.ts:100
Parameters
- query: FetchImagesInput = {}
Returns Promise<FetchFilesOutput<ImageInfo>>

off

off<ET>(type: ET, handler: ((event: ImagesEvents[ET]) => void)): void

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

on

on<ET>(type: ET, handler: ((event: ImagesEvents[ET]) => void)): void

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

once

once<ET>(type: ET, handler: ((event: ImagesEvents[ET]) => void)): void

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

resize

resize(url: string, width?: number, height?: number, crop?: boolean): string

- Defined in core/images/Images.ts:32
Parameters
- url: string
- Optional width: number
- Optional height: number
- Optional crop: boolean
Returns string

upload

upload(query?: Omit<UploadPlayerImageInput, "accessPayload">): Promise<ImageInfo>

- Defined in core/images/Images.ts:45
Parameters
- query: Omit<UploadPlayerImageInput, "accessPayload"> = {}
Returns Promise<ImageInfo>

uploadUrl

uploadUrl(query?: Omit<UploadPlayerImageInput, "accessPayload" | "file"> & { url: string }): Promise<ImageInfo>

- Defined in core/images/Images.ts:81
Parameters
- query: Omit<UploadPlayerImageInput, "accessPayload" | "file"> & { url: string } = ...
Returns Promise<ImageInfo>

Generated using TypeDoc