Class CollectionSubject

Hierarchy

Subject
- CollectionSubject

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CollectionSubject(collection: Collection, named_filters?: Array<string>, ids?: Array<string>): CollectionSubject

Overrides CollectionsSubject.constructor
- Defined in src/subject/subject-types/collection-subject.ts:50
Parameters
- collection: Collection
- Default value named_filters: Array<string> = []
- Default value ids: Array<string> = []
Returns CollectionSubject

Properties

app

app: App

collection

collection: Collection

ids

ids: Array<string>

name

name: string

named_filters

named_filters: Array<string>

Methods

__createResource

__createResource(context: Context, body: Item): Promise<ResourceCreated>

- Defined in src/subject/subject-types/collection-subject.ts:174
Parameters
- context: Context
- body: Item
Returns Promise<ResourceCreated>

__excludeItemsNotPassingCheck

__excludeItemsNotPassingCheck(context: Context, collection: Collection, result: AssignAttachmentsResult): Promise<void>

- Defined in src/subject/subject-types/collection-subject.ts:205
Parameters
- context: Context
- collection: Collection
- result: AssignAttachmentsResult
Returns Promise<void>

__listResources

__listResources(context: Context, params: LooseObject): Promise<{ attachments: {}; fieldsWithAttachments: {}; items: Item[] }>

- Defined in src/subject/subject-types/collection-subject.ts:126
Parameters
- context: Context
- params: LooseObject
Returns Promise<{ attachments: {}; fieldsWithAttachments: {}; items: Item[] }>

createResource

createResource(context: Context, body: Item): Promise<ResourceCreated>

- Defined in src/subject/subject-types/collection-subject.ts:81
Parameters
- context: Context
- body: Item
Returns Promise<ResourceCreated>

delete

delete(): void

- Defined in src/subject/subject-types/collection-subject.ts:85
Returns void

getChildSubject

getChildSubject(path_element: string | Array<string>): Promise<SingleResource | CollectionSubject>

Overrides Subject.getChildSubject
- Defined in src/subject/subject-types/collection-subject.ts:89
Parameters
- path_element: string | Array<string>
Returns Promise<SingleResource | CollectionSubject>

getName

getName(): string

Overrides Subject.getName
- Defined in src/subject/subject-types/collection-subject.ts:48
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>

listResources

listResources(context: Context, params: LooseObject): Promise<CollectionResponse>

- Defined in src/subject/subject-types/collection-subject.ts:103
Parameters
- context: Context
- params: LooseObject
Returns Promise<CollectionResponse>

performAction

performAction(context: Context, action_name: CreateActionName | ShowActionName | DeleteActionName, params: Item): Promise<void | CollectionResponse | ResourceCreated>

Overrides Subject.performAction
- Defined in src/subject/subject-types/collection-subject.ts:62
Parameters
- context: Context
- action_name: CreateActionName | ShowActionName | DeleteActionName
- params: Item
Returns Promise<void | CollectionResponse | ResourceCreated>

Generated using TypeDoc