Interface: INotionService

Defined in: src/types/index.ts:1144

Contract of the Notion adapter facade.

Methods

useInitNotion()

useInitNotion(config): void

Defined in: src/types/index.ts:1145

Parameters

config

NotionConfig

Returns

void

---

useNotionAppendBlocks()

useNotionAppendBlocks(blockId, children): Promise<FetchResult<NotionBlock>>

Defined in: src/types/index.ts:1162

Parameters

blockId

string

children

unknown[]

Returns

Promise<FetchResult<NotionBlock>>

---

useNotionArchivePage()

useNotionArchivePage(pageId): Promise<FetchResult<NotionPage>>

Defined in: src/types/index.ts:1156

Parameters

pageId

string

Returns

Promise<FetchResult<NotionPage>>

---

useNotionCreateDatabase()

useNotionCreateDatabase(parent, title, properties): Promise<FetchResult<NotionDatabase>>

Defined in: src/types/index.ts:1173

Parameters

parent

NotionParent

title

NotionRichText[]

properties

Record<string, NotionPropertySchema>

Returns

Promise<FetchResult<NotionDatabase>>

---

useNotionCreatePage()

useNotionCreatePage(parent, properties, children?): Promise<FetchResult<NotionPage>>

Defined in: src/types/index.ts:1147

Parameters

parent

NotionParent

properties

Record<string, unknown>

children?

unknown[]

Returns

Promise<FetchResult<NotionPage>>

---

useNotionDeleteBlock()

useNotionDeleteBlock(blockId): Promise<FetchResult<NotionBlock>>

Defined in: src/types/index.ts:1167

Parameters

blockId

string

Returns

Promise<FetchResult<NotionBlock>>

---

useNotionGetBlock()

useNotionGetBlock(blockId): Promise<FetchResult<NotionBlock>>

Defined in: src/types/index.ts:1157

Parameters

blockId

string

Returns

Promise<FetchResult<NotionBlock>>

---

useNotionGetBlockChildren()

useNotionGetBlockChildren(blockId, options?): Promise<FetchResult<NotionBlockList>>

Defined in: src/types/index.ts:1158

Parameters

blockId

string

options?

page_size?

number

start_cursor?

string

Returns

Promise<FetchResult<NotionBlockList>>

---

useNotionGetDatabase()

useNotionGetDatabase(databaseId): Promise<FetchResult<NotionDatabase>>

Defined in: src/types/index.ts:1168

Parameters

databaseId

string

Returns

Promise<FetchResult<NotionDatabase>>

---

useNotionGetPage()

useNotionGetPage(pageId): Promise<FetchResult<NotionPage>>

Defined in: src/types/index.ts:1146

Parameters

pageId

string

Returns

Promise<FetchResult<NotionPage>>

---

useNotionGetUser()

useNotionGetUser(userId): Promise<FetchResult<NotionUser>>

Defined in: src/types/index.ts:1183

Parameters

userId

string

Returns

Promise<FetchResult<NotionUser>>

---

useNotionListAllBlockChildren()

useNotionListAllBlockChildren(blockId): Promise<FetchResult<NotionBlock[]>>

Defined in: src/types/index.ts:1189

Parameters

blockId

string

Returns

Promise<FetchResult<NotionBlock[]>>

---

useNotionListAllDatabasePages()

useNotionListAllDatabasePages(databaseId, filter?, sorts?): Promise<FetchResult<NotionPage[]>>

Defined in: src/types/index.ts:1190

Parameters

databaseId

string

filter?

NotionFilter

sorts?

NotionSort[]

Returns

Promise<FetchResult<NotionPage[]>>

---

useNotionListUsers()

useNotionListUsers(options?): Promise<FetchResult<NotionUserList>>

Defined in: src/types/index.ts:1184

Parameters

options?

page_size?

number

start_cursor?

string

Returns

Promise<FetchResult<NotionUserList>>

---

useNotionQueryDatabase()

useNotionQueryDatabase(databaseId, query?): Promise<FetchResult<NotionPageList>>

Defined in: src/types/index.ts:1169

Parameters

databaseId

string

query?

NotionDatabaseQuery

Returns

Promise<FetchResult<NotionPageList>>

---

useNotionSearchContent()

useNotionSearchContent(query): Promise<FetchResult<NotionSearchResult>>

Defined in: src/types/index.ts:1188

Parameters

query

NotionSearchQuery

Returns

Promise<FetchResult<NotionSearchResult>>

---

useNotionUpdateBlock()

useNotionUpdateBlock(blockId, content): Promise<FetchResult<NotionBlock>>

Defined in: src/types/index.ts:1163

Parameters

blockId

string

content

Record<string, unknown>

Returns

Promise<FetchResult<NotionBlock>>

---

useNotionUpdateDatabase()

useNotionUpdateDatabase(databaseId, title, properties?): Promise<FetchResult<NotionDatabase>>

Defined in: src/types/index.ts:1178

Parameters

databaseId

string

title

NotionRichText[]

properties?

Record<string, NotionPropertySchema>

Returns

Promise<FetchResult<NotionDatabase>>

---

useNotionUpdatePage()

useNotionUpdatePage(pageId, properties): Promise<FetchResult<NotionPage>>

Defined in: src/types/index.ts:1152

Parameters

pageId

string

properties

Record<string, unknown>

Returns

Promise<FetchResult<NotionPage>>