Class Images

Hierarchy (view full)

EventEmitter<ImagesEvents>
- Images

Index

Constructors

Properties

#manager _events acl gp

Accessors

Methods

chooseFile fetch fetchMore off on once resize upload uploadUrl

Constructors

constructor

new Images(gp, acl): Images
Parameters
- gp: CoreSDK
- acl: PlayerACL
Returns Images
Overrides EventEmitter.constructor
- Defined in core/images/Images.ts:25

Properties

`Private` #manager

#manager: default<ImageWithReactions> = ...

`Private` _events

_events: EventLite = ...

`Private` acl

acl: PlayerACL

`Private` gp

Accessors

canUpload

get canUpload(): boolean
Returns boolean
- Defined in core/images/Images.ts:29

Methods

chooseFile

chooseFile(): Promise<FilePickerOutput>
Returns Promise<FilePickerOutput>
- Defined in core/images/Images.ts:37

fetch

fetch(query?): Promise<FetchFilesOutput<ImageWithReactions>>
Parameters
- query: FetchImagesInput = {}
Returns Promise<FetchFilesOutput<ImageWithReactions>>
- Defined in core/images/Images.ts:88

fetchMore

fetchMore(query?): Promise<FetchFilesOutput<ImageWithReactions>>
Parameters
- query: FetchImagesInput = {}
Returns Promise<FetchFilesOutput<ImageWithReactions>>
- Defined in core/images/Images.ts:101

off

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

resize

resize(url, width?, height?, crop?): string
Parameters
- url: string
- Optional width: number
- Optional height: number
- Optional crop: boolean
Returns string
- Defined in core/images/Images.ts:33

upload

upload(query?): Promise<ImageWithReactions>
Parameters
- query: Omit<UploadPlayerImageInput, "accessPayload"> = {}
Returns Promise<ImageWithReactions>
- Defined in core/images/Images.ts:46

uploadUrl

uploadUrl(query?): Promise<ImageWithReactions>
Parameters
- query: Omit<UploadPlayerImageInput, "accessPayload" | "file"> & {
  url: string;
  } = ...
Returns Promise<ImageWithReactions>
- Defined in core/images/Images.ts:82