listview

@nishans/core / Exports / ListView

Class: ListView#

A class to represent list view of Notion

noinheritdoc

Hierarchy#

View<IListView>
↳ ListView

Index#

Constructors#

constructor

Properties#

Methods#

Constructors#

constructor#

+ new ListView(arg: NishanArg): ListView

Parameters:#

Name	Type
`arg`	NishanArg

Returns: ListView

Inherited from: View

Defined in: core/src/View/ListView.ts:9

Properties#

cache#

• cache: ICache

Inherited from: View.cache

Defined in: endpoints/dist/src/Cache.d.ts:4

getConfigs#

• Protected getConfigs: () => Configs

Inherited from: View.getConfigs

Defined in: endpoints/dist/src/Cache.d.ts:15

headers#

• headers: { headers: { cookie: string ; x-notion-active-user-header: string } }

Type declaration:#

Name	Type
`headers`	{ `cookie`: string ; `x-notion-active-user-header`: string }

Inherited from: View.headers

Defined in: endpoints/dist/src/Cache.d.ts:7

id#

• id: string

Inherited from: View.id

Defined in: core/src/Data.ts:33

init_cache#

• init_cache: boolean= false

Inherited from: View.init_cache

Defined in: core/src/Data.ts:35

interval#

• interval: number

Inherited from: View.interval

Defined in: endpoints/dist/src/Cache.d.ts:6

logger#

• Protected logger: Logger

Inherited from: View.logger

Defined in: core/src/Data.ts:36

shard_id#

• shard_id: number

Inherited from: View.shard_id

Defined in: core/src/Operations.ts:9

space_id#

• space_id: string

Inherited from: View.space_id

Defined in: core/src/Operations.ts:8

stack#

• stack: IOperation[]

Inherited from: View.stack

Defined in: core/src/Operations.ts:7

token#

• token: string

Inherited from: View.token

Defined in: endpoints/dist/src/Cache.d.ts:5

type#

Inherited from: View.type

Defined in: core/src/Data.ts:34

user_id#

• user_id: string

Inherited from: View.user_id

Defined in: endpoints/dist/src/Cache.d.ts:13

Methods#

addToChildArray#

▸ ProtectedaddToChildArray(parent: TData, position: RepositionParams): void

Adds the passed block id in the child container array of parent

Parameters:#

Name	Type
`parent`	TData
`position`	RepositionParams

Returns: void

created Operation and a function to update the cache and the class data

Inherited from: View

Defined in: core/src/Data.ts:86

createFilters#

▸ createFilters(args: TViewFilterCreateInput[]): void

Parameters:#

Name	Type
`args`	TViewFilterCreateInput[]

Returns: void

Inherited from: View

Defined in: core/src/View/View.ts:171

createSorts#

▸ createSorts(args: TSortCreateInput[]): void

Parameters:#

Name	Type
`args`	TSortCreateInput[]

Returns: void

Inherited from: View

Defined in: core/src/View/View.ts:84

deleteCachedData#

▸ ProtecteddeleteCachedData(): void

Delete the cached data using the id

Returns: void

Inherited from: View

Defined in: core/src/Data.ts:76

deleteFilter#

▸ deleteFilter(arg: FilterType<ISchemaFiltersMapValue>): Promise<void>

Parameters:#

Name	Type
`arg`	FilterType<ISchemaFiltersMapValue>

Returns: Promise<void>

Inherited from: View

Defined in: core/src/View/View.ts:220

deleteFilters#

▸ deleteFilters(args: FilterTypes<ISchemaFiltersMapValue>, multiple?: boolean): Promise<void>

Parameters:#

Name	Type
`args`	FilterTypes<ISchemaFiltersMapValue>
`multiple?`	boolean

Returns: Promise<void>

Inherited from: View

Defined in: core/src/View/View.ts:224

deleteIterate#

▸ ProtecteddeleteIterate<TD>(args: FilterTypes<TD>, options: IterateAndDeleteOptions<IListView>, transform: (id: string) => undefined | TD, cb?: (id: string, data: TD) => void | Promise<any>): Promise<TD[]>

Type parameters:#

Name
`TD`

Parameters:#

Name	Type
`args`	FilterTypes<TD>
`options`	IterateAndDeleteOptions<IListView>
`transform`	(`id`: string) => undefined \| TD
`cb?`	(`id`: string, `data`: TD) => void \| Promise<any>

Returns: Promise<TD[]>

Inherited from: View

Defined in: core/src/Data.ts:118

deleteSort#

▸ deleteSort(arg: FilterTypes<ISchemaSortsMapValue>): Promise<void>

Parameters:#

Name	Type
`arg`	FilterTypes<ISchemaSortsMapValue>

Returns: Promise<void>

Inherited from: View

Defined in: core/src/View/View.ts:148

deleteSorts#

▸ deleteSorts(args: FilterTypes<ISchemaSortsMapValue>, multiple?: boolean): Promise<void>

Parameters:#

Name	Type
`args`	FilterTypes<ISchemaSortsMapValue>
`multiple?`	boolean

Returns: Promise<void>

Inherited from: View

Defined in: core/src/View/View.ts:152

emptyStack#

▸ emptyStack(): void

Returns: void

Inherited from: View

Defined in: core/src/Operations.ts:18

executeOperation#

▸ executeOperation(): Promise<void>

Returns: Promise<void>

Inherited from: View

Defined in: core/src/Operations.ts:26

getCachedData#

▸ getCachedData(): IListView

Get the cached data using the current data id

Returns: IListView

Inherited from: View

Defined in: core/src/Data.ts:62

getCachedParentData#

▸ getCachedParentData(): TCollectionBlock

Returns: TCollectionBlock

Inherited from: View

Defined in: core/src/View/View.ts:54

getCollection#

▸ getCollection(): ICollection

Returns: ICollection

Inherited from: View

Defined in: core/src/View/View.ts:48

getIterate#

▸ ProtectedgetIterate<RD, C>(args: FilterTypes<RD>, options: IterateAndGetOptions<IListView, C>, transform: (id: string) => undefined | RD, cb?: (id: string, data: RD, container: C) => any): Promise<C>

Type parameters:#

Name
`RD`
`C`

Parameters:#

Name	Type
`args`	FilterTypes<RD>
`options`	IterateAndGetOptions<IListView, C>
`transform`	(`id`: string) => undefined \| RD
`cb?`	(`id`: string, `data`: RD, `container`: C) => any

Returns: Promise<C>

Inherited from: View

Defined in: core/src/Data.ts:138

getLastEditedProps#

▸ ProtectedgetLastEditedProps(): object

Returns: object

Name	Type
`last_edited_by_id`	string
`last_edited_by_table`	string
`last_edited_time`	number

Inherited from: View

Defined in: core/src/Data.ts:48

getProps#

▸ getProps(): object

Returns: object

Name	Type
`cache`	ICache
`interval`	number
`logger`	Logger
`shard_id`	number
`space_id`	string
`stack`	IOperation[]
`token`	string
`user_id`	string

Inherited from: View

Defined in: core/src/Data.ts:148

initializeCache#

▸ initializeCache(): Promise<void>

Returns: Promise<void>

Inherited from: View

Defined in: endpoints/dist/src/Cache.d.ts:22

initializeCacheForSpecificData#

Parameters:#

Name	Type
`id`	string
`type`	block \| collection \| collection_view \| space \| notion_user \| space_view \| user_root \| user_settings

Returns: Promise<void>

Inherited from: View

Defined in: endpoints/dist/src/Cache.d.ts:25

initializeCacheForThisData#

▸ ProtectedinitializeCacheForThisData(): Promise<void>

Returns: Promise<void>

Inherited from: View

Defined in: core/src/Data.ts:111

printStack#

▸ printStack(): void

Returns: void

Inherited from: View

Defined in: core/src/Operations.ts:22

reposition#

▸ reposition(arg: RepositionParams): void

Parameters:#

Name	Type
`arg`	RepositionParams

Returns: void

Inherited from: View

Defined in: core/src/View/View.ts:58

returnNonCachedData#

▸ returnNonCachedData(ids: UpdateCacheManuallyParam): UpdateCacheManuallyParam

Parameters:#

Name	Type
`ids`	UpdateCacheManuallyParam

Returns: UpdateCacheManuallyParam

Inherited from: View

Defined in: endpoints/dist/src/Cache.d.ts:21

saveToCache#

▸ saveToCache(recordMap: Partial<RecordMap>): void

Save the passed recordMap to cache

Parameters:#

Name	Type	Description
`recordMap`	Partial<RecordMap>	RecordMap map to save to cache

Returns: void

Inherited from: View

Defined in: endpoints/dist/src/Cache.d.ts:20

update#

▸ update(param: TViewCreateInput): ITView

Update the current view

Parameters:#

Name	Type
`param`	TViewCreateInput

Returns: ITView

Inherited from: View

Defined in: core/src/View/View.ts:67

updateCacheIfNotPresent#

▸ updateCacheIfNotPresent(arg: UpdateCacheManuallyParam): Promise<void>

Parameters:#

Name	Type
`arg`	UpdateCacheManuallyParam

Returns: Promise<void>

Inherited from: View

Defined in: endpoints/dist/src/Cache.d.ts:24

updateCacheLocally#

Update the cache of the data using only the passed keys

Parameters:#

Name	Type	Description
`arg`	Partial<IListView>
`keys`	readonly (id \| name \| type \| format \| alive \| version \| parent_id \| parent_table \| query2)[]
`appendToStack?`	boolean	-

Returns: void

Inherited from: View

Defined in: core/src/Data.ts:95

updateCacheManually#

▸ updateCacheManually(arg: string | UpdateCacheManuallyParam): Promise<void>

Parameters:#

Name	Type
`arg`	string \| UpdateCacheManuallyParam

Returns: Promise<void>

Inherited from: View

Defined in: endpoints/dist/src/Cache.d.ts:23

updateCachedData#

▸ updateCachedData(): Promise<void>

Returns: Promise<void>

Inherited from: View

Defined in: core/src/Data.ts:69

updateFilter#

▸ updateFilter(arg: UpdateType<ISchemaFiltersMapValue, TViewFilterUpdateInput>): Promise<void>

Parameters:#

Name	Type
`arg`	UpdateType<ISchemaFiltersMapValue, TViewFilterUpdateInput>

Returns: Promise<void>

Inherited from: View

Defined in: core/src/View/View.ts:184

updateFilters#

▸ updateFilters(args: UpdateTypes<ISchemaFiltersMapValue, TViewFilterUpdateInput>, multiple?: boolean): Promise<void>

Parameters:#

Name	Type
`args`	UpdateTypes<ISchemaFiltersMapValue, TViewFilterUpdateInput>
`multiple?`	boolean

Returns: Promise<void>

Inherited from: View

Defined in: core/src/View/View.ts:188

updateFormatPositionProperties#

▸ updateFormatPositionProperties(args: UpdateTypes<ISchemaFormatMapValue, number>, multiple?: boolean): Promise<void>

Parameters:#

Name	Type
`args`	UpdateTypes<ISchemaFormatMapValue, number>
`multiple?`	boolean

Returns: Promise<void>

Inherited from: View

Defined in: core/src/View/View.ts:311

updateFormatPositionProperty#

▸ updateFormatPositionProperty(arg: UpdateType<ISchemaFormatMapValue, number>): Promise<void>

Parameters:#

Name	Type
`arg`	UpdateType<ISchemaFormatMapValue, number>

Returns: Promise<void>

Inherited from: View

Defined in: core/src/View/View.ts:307

updateFormatProperties#

▸ updateFormatProperties(args: UpdateTypes<ISchemaFormatMapValue, Partial<{ position: number ; visible: boolean ; width: number }>>, multiple?: boolean): Promise<void>

Parameters:#

Name	Type
`args`	UpdateTypes<ISchemaFormatMapValue, Partial<{ `position`: number ; `visible`: boolean ; `width`: number }>>
`multiple?`	boolean

Returns: Promise<void>

Inherited from: View

Defined in: core/src/View/View.ts:345

updateFormatProperty#

▸ updateFormatProperty(arg: UpdateType<ISchemaFormatMapValue, Partial<{ position: number ; visible: boolean ; width: number }>>): Promise<void>

Parameters:#

Name	Type
`arg`	UpdateType<ISchemaFormatMapValue, Partial<{ `position`: number ; `visible`: boolean ; `width`: number }>>

Returns: Promise<void>

Inherited from: View

Defined in: core/src/View/View.ts:341

updateFormatVisibilityProperties#

▸ updateFormatVisibilityProperties(args: UpdateTypes<ISchemaFormatMapValue, boolean>, multiple?: boolean): Promise<void>

Parameters:#

Name	Type
`args`	UpdateTypes<ISchemaFormatMapValue, boolean>
`multiple?`	boolean

Returns: Promise<void>

Inherited from: View

Defined in: core/src/View/View.ts:251

updateFormatVisibilityProperty#

▸ updateFormatVisibilityProperty(arg: UpdateType<ISchemaFormatMapValue, boolean>): Promise<void>

Parameters:#

Name	Type
`arg`	UpdateType<ISchemaFormatMapValue, boolean>

Returns: Promise<void>

Inherited from: View

Defined in: core/src/View/View.ts:247

updateFormatWidthProperties#

▸ updateFormatWidthProperties(args: UpdateTypes<ISchemaFormatMapValue, number>, multiple?: boolean): Promise<void>

Parameters:#

Name	Type
`args`	UpdateTypes<ISchemaFormatMapValue, number>
`multiple?`	boolean

Returns: Promise<void>

Inherited from: View

Defined in: core/src/View/View.ts:281

updateFormatWidthProperty#

▸ updateFormatWidthProperty(arg: UpdateType<ISchemaFormatMapValue, number>): Promise<void>

Parameters:#

Name	Type
`arg`	UpdateType<ISchemaFormatMapValue, number>

Returns: Promise<void>

Inherited from: View

Defined in: core/src/View/View.ts:277

updateIterate#

▸ ProtectedupdateIterate<TD, RD, C>(args: UpdateTypes<TD, RD>, options: IterateAndUpdateOptions<IListView, C>, transform: (id: string) => undefined | TD, cb?: (id: string, data: TD, updated\_data: RD, container: C) => any): Promise<C>

Type parameters:#

Name	Default
`TD`	-
`RD`	-
`C`	any

Parameters:#

Name	Type
`args`	UpdateTypes<TD, RD>
`options`	IterateAndUpdateOptions<IListView, C>
`transform`	(`id`: string) => undefined \| TD
`cb?`	(`id`: string, `data`: TD, `updated\_data`: RD, `container`: C) => any

Returns: Promise<C>

Inherited from: View

Defined in: core/src/Data.ts:128

updateLastEditedProps#

Parameters:#

Name Type

Name	Type
`data?`	INotionUser \| IText \| ITodo \| IHeader \| ISubHeader \| ISubSubHeader \| IBulletedList \| INumberedList \| IToggle \| IQuote \| IDivider \| ICallout \| IPage \| ICollectionView \| ICollectionViewPage \| ILinkToPage \| IVideo \| IAudio \| IImage \| IWebBookmark \| ICode \| IFile \| ITOC \| IEquation \| IBreadcrumb \| IFactory \| IEmbed \| ITweet \| ICodepen \| IMaps \| IFigma \| IDrive \| IGist \| IColumnList \| IColumn \| ICollection \| ITableView \| IListView \| IBoardView \| IGalleryView \| ICalendarView \| ITimelineView \| ISpace \| ISpaceView \| IUserRoot \| IUserSettings

Returns: void

Inherited from: View

Defined in: core/src/Data.ts:52

updateSort#

▸ updateSort(arg: UpdateType<ISchemaSortsMapValue, TSortUpdateInput>): Promise<void>

Parameters:#

Name	Type
`arg`	UpdateType<ISchemaSortsMapValue, TSortUpdateInput>

Returns: Promise<void>

Inherited from: View

Defined in: core/src/View/View.ts:112

updateSorts#

▸ updateSorts(args: UpdateTypes<ISchemaSortsMapValue, TSortUpdateInput>, multiple?: boolean): Promise<void>

Parameters:#

Name	Type
`args`	UpdateTypes<ISchemaSortsMapValue, TSortUpdateInput>
`multiple?`	boolean

Returns: Promise<void>

Inherited from: View

Defined in: core/src/View/View.ts:116