collectionblock

@nishans/core / Exports / CollectionBlock

Class: CollectionBlock<T>#

A class to represent collectionblock type in Notion

noinheritdoc

Type parameters#

Name	Type
`T`	ICollectionViewPage \| ICollectionView

Hierarchy#

Block<T, TCollectionBlockInput>
↳ CollectionBlock
↳↳ CollectionViewPage
↳↳ CollectionView

Index#

Constructors#

constructor

Properties#

Methods#

Constructors#

constructor#

+ new CollectionBlock<T>(arg: NishanArg & { type: block }): CollectionBlock<T>

Type parameters:#

Name	Type
`T`	TCollectionBlock

Parameters:#

Name	Type
`arg`	NishanArg & { `type`: block }

Returns: CollectionBlock<T>

Inherited from: Block

Defined in: core/src/CollectionBlock.ts:31

Properties#

cache#

• cache: ICache

Inherited from: Block.cache

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

getConfigs#

• Protected getConfigs: () => Configs

Inherited from: Block.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: Block.headers

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

id#

• id: string

Inherited from: Block.id

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

init_cache#

• init_cache: boolean= false

Inherited from: Block.init_cache

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

interval#

• interval: number

Inherited from: Block.interval

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

logger#

• Protected logger: Logger

Inherited from: Block.logger

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

shard_id#

• shard_id: number

Inherited from: Block.shard_id

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

space_id#

• space_id: string

Inherited from: Block.space_id

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

stack#

• stack: IOperation[]

Inherited from: Block.stack

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

token#

• token: string

Inherited from: Block.token

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

type#

Inherited from: Block.type

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

user_id#

• user_id: string

Inherited from: Block.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: Block

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

convertTo#

▸ convertTo(type: TBasicBlockType): void

Convert the current block to a different basic block

Parameters:#

Name	Type	Description
`type`	TBasicBlockType	`TBasicBlockType` basic block types

Returns: void

Inherited from: Block

Defined in: core/src/Block.ts:107

createViews#

▸ createViews(params: TViewCreateInput[]): ITView

Parameters:#

Name	Type
`params`	TViewCreateInput[]

Returns: ITView

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

delete#

▸ delete(): void

Delete the current block

Returns: void

Inherited from: Block

Defined in: core/src/Block.ts:117

deleteCachedData#

▸ ProtecteddeleteCachedData(): void

Delete the cached data using the id

Returns: void

Inherited from: Block

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

deleteIterate#

▸ ProtecteddeleteIterate<TD>(args: FilterTypes<TD>, options: IterateAndDeleteOptions<T>, 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<T>
`transform`	(`id`: string) => undefined \| TD
`cb?`	(`id`: string, `data`: TD) => void \| Promise<any>

Returns: Promise<TD[]>

Inherited from: Block

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

deleteView#

▸ deleteView(arg?: FilterType<TView>): Promise<void>

Delete a single root page from the space

Parameters:#

Name	Type	Description
`arg?`	FilterType<TView>	Criteria to filter the page to be deleted

Returns: Promise<void>

Defined in: core/src/CollectionBlock.ts:104

deleteViews#

▸ deleteViews(args?: FilterTypes<TView>, multiple?: boolean): Promise<void>

Delete multiple root_pages or root_collection_view_pages

Parameters:#

Name	Type	Description
`args?`	FilterTypes<TView>	-
`multiple?`	boolean	whether or not multiple root pages should be deleted

Returns: Promise<void>

Defined in: core/src/CollectionBlock.ts:113

duplicate#

▸ duplicate(infos: { id?: undefined | string }[]): Promise<ITBlock>

Duplicate the current block

Parameters:#

Name	Type	Description
`infos`	{ `id?`: undefined \| string }[]	Array of objects containing information regarding the position and id of the duplicated block

Returns: Promise<ITBlock>

A block map

Inherited from: Block

Defined in: core/src/Block.ts:32

emptyStack#

▸ emptyStack(): void

Returns: void

Inherited from: Block

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

executeOperation#

▸ executeOperation(): Promise<void>

Returns: Promise<void>

Inherited from: Block

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

getCachedData#

▸ getCachedData(): T

Get the cached data using the current data id

Returns: T

Inherited from: Block

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

getCachedParentData#

▸ getCachedParentData(): TData

Returns: TData

Inherited from: Block

Defined in: core/src/Block.ts:17

getCollection#

▸ getCollection(): Promise<Collection>

Fetch the corresponding collection of the collection block using the collection_id

Returns: Promise<Collection>

The corresponding collection object

Defined in: core/src/CollectionBlock.ts:40

getIterate#

▸ ProtectedgetIterate<RD, C>(args: FilterTypes<RD>, options: IterateAndGetOptions<T, 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<T, C>
`transform`	(`id`: string) => undefined \| RD
`cb?`	(`id`: string, `data`: RD, `container`: C) => any

Returns: Promise<C>

Inherited from: Block

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: Block

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: Block

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

getViews#

▸ getViews(args?: FilterTypes<TView>, multiple?: boolean): Promise<ITView>

Get all the views associated with the collection block

Parameters:#

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

Returns: Promise<ITView>

An array of view objects of the collectionblock

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

initializeCache#

▸ initializeCache(): Promise<void>

Returns: Promise<void>

Inherited from: Block

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: Block

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

initializeCacheForThisData#

▸ ProtectedinitializeCacheForThisData(): Promise<void>

Returns: Promise<void>

Inherited from: Block

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

printStack#

▸ printStack(): void

Returns: void

Inherited from: Block

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

reposition#

▸ reposition(arg: RepositionParams): void

Parameters:#

Name	Type
`arg`	RepositionParams

Returns: void

Inherited from: Block

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

returnNonCachedData#

▸ returnNonCachedData(ids: UpdateCacheManuallyParam): UpdateCacheManuallyParam

Parameters:#

Name	Type
`ids`	UpdateCacheManuallyParam

Returns: UpdateCacheManuallyParam

Inherited from: Block

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: Block

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

transfer#

▸ transfer(new_parent_id: string): void

Transfer a block from one parent page to another page

Parameters:#

Name	Type	Description
`new_parent_id`	string	Id of the new parent page

Returns: void

Inherited from: Block

Defined in: core/src/Block.ts:149

update#

▸ update(args: Partial<ICollectionViewInput> | Partial<ICollectionViewPageInput> | Partial<ILinkedDBInput>): void

Update a block's properties and format

Parameters:#

Name	Type	Description
`args`	Partial<ICollectionViewInput> \| Partial<ICollectionViewPageInput> \| Partial<ILinkedDBInput>	Block update format and properties options

Returns: void

Inherited from: Block

Defined in: core/src/Block.ts:89

updateCacheIfNotPresent#

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

Parameters:#

Name	Type
`arg`	UpdateCacheManuallyParam

Returns: Promise<void>

Inherited from: Block

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

updateCacheLocally#

▸ updateCacheLocally(arg: Partial<T>, keys: readonly keyof T[], appendToStack?: boolean): void

Update the cache of the data using only the passed keys

Parameters:#

Name	Type	Description
`arg`	Partial<T>
`keys`	readonly keyof T[]
`appendToStack?`	boolean	-

Returns: void

Inherited from: Block

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: Block

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

updateCachedData#

▸ updateCachedData(): Promise<void>

Returns: Promise<void>

Inherited from: Block

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

updateIterate#

▸ ProtectedupdateIterate<TD, RD, C>(args: UpdateTypes<TD, RD>, options: IterateAndUpdateOptions<T, 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<T, C>
`transform`	(`id`: string) => undefined \| TD
`cb?`	(`id`: string, `data`: TD, `updated\_data`: RD, `container`: C) => any

Returns: Promise<C>

Inherited from: Block

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: Block

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

updateView#

Parameters:#

Name	Type
`arg`	UpdateType<TView, Partial<ITableView> \| Partial<IListView> \| Partial<IBoardView> \| Partial<IGalleryView> \| Partial<ICalendarView> \| Partial<ITimelineView>>

Returns: Promise<ITView>

Defined in: core/src/CollectionBlock.ts:78

updateViews#

Parameters:#

Name	Type
`args`	UpdateTypes<TView, Partial<ITableView> \| Partial<IListView> \| Partial<IBoardView> \| Partial<IGalleryView> \| Partial<ICalendarView> \| Partial<ITimelineView>>
`multiple?`	boolean

Returns: Promise<ITView>

Defined in: core/src/CollectionBlock.ts:82