Class ImageFormatFile

Hierarchy

LeafSubject
- ImageFormatFile

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ImageFormatFile(app: App, file_id: string, file_name: string, format_name: string): ImageFormatFile

Overrides CollectionsSubject.constructor
- Defined in src/subject/subject-types/image-format/image-format.ts:37
Parameters
- app: App
- file_id: string
- file_name: string
- format_name: string
Returns ImageFormatFile

Properties

app

app: App

file_id

file_id: string

file_name

file_name: string

format_name

format_name: string

name

name: string

Methods

createFormattedVersion

createFormattedVersion(file_id: string, format_name: string): Promise<File>

- Defined in src/subject/subject-types/image-format/image-format.ts:107
Parameters
- file_id: string
- format_name: string
Returns Promise<File>

getChildSubject

getChildSubject(): Promise<null>

Inherited from CurrentSession.getChildSubject

Overrides Subject.getChildSubject
- Defined in src/subject/subject.ts:46
Returns Promise<null>

getFormat

getFormat(): never

- Defined in src/subject/subject-types/image-format/image-format.ts:51
Returns never

getFormatData

getFormatData(format_name: string): never

- Defined in src/subject/subject-types/image-format/image-format.ts:102
Parameters
- format_name: string
Returns never

getFormattedVersion

getFormattedVersion(format_obj: FormatObject): Promise<File | null>

- Defined in src/subject/subject-types/image-format/image-format.ts:85
Parameters
- format_obj: FormatObject
Returns Promise<File | null>

getName

getName(): string

Overrides Subject.getName
- Defined in src/subject/subject-types/image-format/image-format.ts:143
Returns string

getSubject

getSubject(subject_path_equiv: SubjectPathEquiv): Promise<Subject | null>

Inherited from SingleResource.getSubject
- Defined in src/subject/subject.ts:27
Parameters
- subject_path_equiv: SubjectPathEquiv
Returns Promise<Subject | null>

performAction

performAction(_: Context, action_name: ShowActionName, __: any): Promise<File>

Overrides Subject.performAction
- Defined in src/subject/subject-types/image-format/image-format.ts:59
Parameters
- _: Context
- action_name: ShowActionName
- __: any
Returns Promise<File>

Generated using TypeDoc