Class SingleResource

Hierarchy

Subject
- SingleResource

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SingleResource(app: App, collection: Collection, resource_id: string): SingleResource

Overrides CollectionsSubject.constructor
- Defined in src/subject/subject-types/single-resource-subject.ts:16
Parameters
- app: App
- collection: Collection
- resource_id: string
Returns SingleResource

Properties

app

app: App

collection

collection: Collection

name

name: string

resource_id

resource_id: string

Methods

__getResource

__getResource(context: Context, __namedParameters: { format: undefined | {} }): Promise<Item>

- Defined in src/subject/subject-types/single-resource-subject.ts:70
Parameters
- context: Context
- __namedParameters: { format: undefined | {} }
  - format: undefined | {}
Returns Promise<Item>

deleteResource

deleteResource(context: Context, _: LooseObject): Promise<void>

- Defined in src/subject/subject-types/single-resource-subject.ts:144
Parameters
- context: Context
- _: LooseObject
Returns Promise<void>

editResource

editResource(context: Context, values_to_patch: any, delete_empty_values: boolean): Promise<SingleItemResponse>

- Defined in src/subject/subject-types/single-resource-subject.ts:100
Parameters
- context: Context
- values_to_patch: any
- delete_empty_values: boolean
Returns Promise<SingleItemResponse>

getChildSubject

getChildSubject(key: string): Promise<null>

Overrides Subject.getChildSubject
- Defined in src/subject/subject-types/single-resource-subject.ts:96
Parameters
- key: string
Returns Promise<null>

getName

getName(): string

Overrides Subject.getName
- Defined in src/subject/subject-types/single-resource-subject.ts:23
Returns string

getResource

getResource(context: Context, args: { attachments?: LooseObject; format?: undefined | {} }): Promise<SingleItemResponse>

- Defined in src/subject/subject-types/single-resource-subject.ts:42
Parameters
- context: Context
- args: { attachments?: LooseObject; format?: undefined | {} }
  - Optional attachments?: LooseObject
  - Optional format?: undefined | {}
Returns Promise<SingleItemResponse>

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: Context, action_name: ActionName, args?: any): Promise<void | SingleItemResponse>

Overrides Subject.performAction
- Defined in src/subject/subject-types/single-resource-subject.ts:26
Parameters
- context: Context
- action_name: ActionName
- Optional args: any
Returns Promise<void | SingleItemResponse>

Generated using TypeDoc