Class ViewsApi

Hierarchy

BaseResourceAPI<View>
- ViewsApi

Index

Methods

Methods

create

create(items: ExternalView[]): Promise<View[]>

- Defined in packages/stable/src/api/templates/viewsApi.ts:15
Parameters
- items: ExternalView[]
Returns Promise<View[]>

delete

delete(ids: ExternalId[], options?: undefined | { ignoreUnknownIds: boolean }): Promise<{}>

- Defined in packages/stable/src/api/templates/viewsApi.ts:46
Parameters
- ids: ExternalId[]
- Optional options: undefined | { ignoreUnknownIds: boolean }
Returns Promise<{}>

list

list(query?: ViewFilterQuery): CursorAndAsyncIterator<View>

- Defined in packages/stable/src/api/templates/viewsApi.ts:23
Parameters
- Optional query: ViewFilterQuery
Returns CursorAndAsyncIterator<View>

resolve

resolve<T>(resolveRequest: ViewResolveRequest): CursorAndAsyncIterator<T>

- Defined in packages/stable/src/api/templates/viewsApi.ts:27
Type parameters
- T
Parameters
- resolveRequest: ViewResolveRequest
Returns CursorAndAsyncIterator<T>

upsert

upsert(items: ExternalView[]): Promise<View[]>

- Defined in packages/stable/src/api/templates/viewsApi.ts:19
Parameters
- items: ExternalView[]
Returns Promise<View[]>