spaceview

@nishans/core / Exports / SpaceView

Class: SpaceView#

A class to represent spaceview of Notion

noinheritdoc

Hierarchy#

  • Data<ISpaceView>

    ↳ SpaceView

Index#

Constructors#

Properties#

Methods#

Constructors#

constructor#

+ new SpaceView(arg: NishanArg): SpaceView

Parameters:#

NameType
argNishanArg

Returns: SpaceView

Defined in: core/src/SpaceView.ts:14

Properties#

cache#

• cache: ICache

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

getConfigs#

• Protected getConfigs: () => Configs

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

headers#

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

Type declaration:#

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

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

id#

• id: string

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

init_cache#

• init_cache: boolean= false

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

interval#

• interval: number

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

logger#

• Protected logger: Logger

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

shard_id#

• shard_id: number

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

space_id#

• space_id: string

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

stack#

• stack: IOperation[]

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

token#

• token: string

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

type#

• type: block | collection | collection_view | space | notion_user | space_view | user_root | user_settings

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

user_id#

• user_id: string

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

NameType
parentTData
positionRepositionParams

Returns: void

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

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

deleteCachedData#

â–¸ ProtecteddeleteCachedData(): void

Delete the cached data using the id

Returns: void

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

deleteIterate#

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

Type parameters:#

Name
TD

Parameters:#

NameType
argsFilterTypes<TD>
optionsIterateAndDeleteOptions<ISpaceView>
transform(id: string) => undefined | TD
cb?(id: string, data: TD) => void | Promise<any>

Returns: Promise<TD[]>

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

emptyStack#

â–¸ emptyStack(): void

Returns: void

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

executeOperation#

â–¸ executeOperation(): Promise<void>

Returns: Promise<void>

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

getBookmarkedPage#

â–¸ getBookmarkedPage(arg: FilterType<TPage>): Promise<ITPage>

Parameters:#

NameType
argFilterType<TPage>

Returns: Promise<ITPage>

Defined in: core/src/SpaceView.ts:55

getBookmarkedPages#

â–¸ getBookmarkedPages(args: FilterTypes<TPage>, multiple?: boolean): Promise<ITPage>

Parameters:#

NameType
argsFilterTypes<TPage>
multiple?boolean

Returns: Promise<ITPage>

Defined in: core/src/SpaceView.ts:59

getCachedData#

â–¸ getCachedData(): ISpaceView

Get the cached data using the current data id

Returns: ISpaceView

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

getCachedParentData#

â–¸ getCachedParentData(): IUserRoot

Returns: IUserRoot

Defined in: core/src/SpaceView.ts:19

getIterate#

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

Type parameters:#

Name
RD
C

Parameters:#

NameType
argsFilterTypes<RD>
optionsIterateAndGetOptions<ISpaceView, C>
transform(id: string) => undefined | RD
cb?(id: string, data: RD, container: C) => any

Returns: Promise<C>

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

getLastEditedProps#

â–¸ ProtectedgetLastEditedProps(): object

Returns: object

NameType
last_edited_by_idstring
last_edited_by_tablestring
last_edited_timenumber

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

getProps#

â–¸ getProps(): object

Returns: object

NameType
cacheICache
intervalnumber
loggerLogger
shard_idnumber
space_idstring
stackIOperation[]
tokenstring
user_idstring

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

getSpace#

â–¸ getSpace(): Promise<Space>

Get the corresponding space associated with this space view

Returns: Promise<Space>

The corresponding space object

Defined in: core/src/SpaceView.ts:39

initializeCache#

â–¸ initializeCache(): Promise<void>

Returns: Promise<void>

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

initializeCacheForSpecificData#

â–¸ initializeCacheForSpecificData(id: string, type: block | collection | collection_view | space | notion_user | space_view | user_root | user_settings): Promise<void>

Parameters:#

NameType
idstring
typeblock | collection | collection_view | space | notion_user | space_view | user_root | user_settings

Returns: Promise<void>

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

initializeCacheForThisData#

â–¸ ProtectedinitializeCacheForThisData(): Promise<void>

Returns: Promise<void>

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

printStack#

â–¸ printStack(): void

Returns: void

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

reposition#

â–¸ reposition(arg: RepositionParams): void

Parameters:#

NameType
argRepositionParams

Returns: void

Defined in: core/src/SpaceView.ts:23

returnNonCachedData#

â–¸ returnNonCachedData(ids: UpdateCacheManuallyParam): UpdateCacheManuallyParam

Parameters:#

NameType
idsUpdateCacheManuallyParam

Returns: UpdateCacheManuallyParam

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

saveToCache#

â–¸ saveToCache(recordMap: Partial<RecordMap>): void

Save the passed recordMap to cache

Parameters:#

NameTypeDescription
recordMapPartial<RecordMap>RecordMap map to save to cache

Returns: void

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

update#

â–¸ update(arg: Partial<Pick<ISpaceView, notify_desktop | notify_email | notify_mobile | joined | created_getting_started>>): void

Update the current space view

Parameters:#

NameTypeDescription
argPartial<Pick<ISpaceView, notify_desktop | notify_email | notify_mobile | joined | created_getting_started>>Options to update the spaceView

Returns: void

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

updateBookmarkedPage#

â–¸ updateBookmarkedPage(arg: UpdateTypes<TPage, boolean>): Promise<void>

Toggle a single page from the bookmark list

Parameters:#

NameTypeDescription
argUpdateTypes<TPage, boolean>id string or a predicate filter function

Returns: Promise<void>

Defined in: core/src/SpaceView.ts:85

updateBookmarkedPages#

â–¸ updateBookmarkedPages(args: UpdateTypes<TPage, boolean>, multiple?: boolean): Promise<void>

Toggle multiple pages from the bookmark list

Parameters:#

NameTypeDescription
argsUpdateTypes<TPage, boolean>-
multiple?booleanwhether multiple or single item is targeted

Returns: Promise<void>

Defined in: core/src/SpaceView.ts:94

updateCacheIfNotPresent#

â–¸ updateCacheIfNotPresent(arg: UpdateCacheManuallyParam): Promise<void>

Parameters:#

NameType
argUpdateCacheManuallyParam

Returns: Promise<void>

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

updateCacheLocally#

â–¸ updateCacheLocally(arg: Partial<ISpaceView>, keys: readonly (id | space_id | alive | version | parent_id | parent_table | notify_desktop | notify_email | notify_mobile | joined | created_getting_started | created_onboarding_templates | sidebar_hidden_templates | visited_templates | bookmarked_pages)[], appendToStack?: boolean): void

Update the cache of the data using only the passed keys

Parameters:#

NameTypeDescription
argPartial<ISpaceView>
keysreadonly (id | space_id | alive | version | parent_id | parent_table | notify_desktop | notify_email | notify_mobile | joined | created_getting_started | created_onboarding_templates | sidebar_hidden_templates | visited_templates | bookmarked_pages)[]
appendToStack?boolean-

Returns: void

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

updateCacheManually#

â–¸ updateCacheManually(arg: string | UpdateCacheManuallyParam): Promise<void>

Parameters:#

NameType
argstring | UpdateCacheManuallyParam

Returns: Promise<void>

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

updateCachedData#

â–¸ updateCachedData(): Promise<void>

Returns: Promise<void>

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

updateIterate#

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

Type parameters:#

NameDefault
TD-
RD-
Cany

Parameters:#

NameType
argsUpdateTypes<TD, RD>
optionsIterateAndUpdateOptions<ISpaceView, C>
transform(id: string) => undefined | TD
cb?(id: string, data: TD, updated\_data: RD, container: C) => any

Returns: Promise<C>

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

updateLastEditedProps#

â–¸ ProtectedupdateLastEditedProps(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): void

Parameters:#

NameType
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

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

Edit this page