BlockSuite API Documentation / @blocksuite/blocks / AttachmentAdapter

Class: AttachmentAdapter

Extends

• BaseAdapter<Attachment>

Constructors

new AttachmentAdapter()

new AttachmentAdapter(job): AttachmentAdapter

Parameters

• job: Job

Returns

AttachmentAdapter

Inherited from

BaseAdapter.constructor

Source

packages/framework/store/dist/adapter/base.d.ts:46

Properties

configs

protected configs: Map<string, unknown>

Inherited from

BaseAdapter.configs

Source

packages/framework/store/dist/adapter/base.d.ts:44

---

job

job: Job

Inherited from

BaseAdapter.job

Source

packages/framework/store/dist/adapter/base.d.ts:45

Methods

applyConfigs()

applyConfigs(configs): void

Parameters

• configs: Map<string, unknown>

Returns

void

Inherited from

BaseAdapter.applyConfigs

Source

packages/framework/store/dist/adapter/base.d.ts:59

---

fromBlock()

fromBlock(mode): Promise<FromBlockSnapshotResult<Attachment>>

Parameters

• mode: DraftModel

Returns

Promise<FromBlockSnapshotResult<Attachment>>

Inherited from

BaseAdapter.fromBlock

Source

packages/framework/store/dist/adapter/base.d.ts:55

---

fromBlockSnapshot()

fromBlockSnapshot(_payload): Promise<FromBlockSnapshotResult<Attachment>>

Parameters

• _payload: FromBlockSnapshotPayload

Returns

Promise<FromBlockSnapshotResult<Attachment>>

Overrides

BaseAdapter.fromBlockSnapshot

Source

packages/blocks/src/_common/adapters/attachment.ts:38

---

fromDoc()

fromDoc(doc): Promise<FromDocSnapshotResult<Attachment>>

Parameters

• doc: Doc

Returns

Promise<FromDocSnapshotResult<Attachment>>

Inherited from

BaseAdapter.fromDoc

Source

packages/framework/store/dist/adapter/base.d.ts:53

---

fromDocSnapshot()

fromDocSnapshot(_payload): Promise<FromDocSnapshotResult<Attachment>>

Parameters

• _payload: FromDocSnapshotPayload

Returns

Promise<FromDocSnapshotResult<Attachment>>

Overrides

BaseAdapter.fromDocSnapshot

Source

packages/blocks/src/_common/adapters/attachment.ts:32

---

fromSlice()

fromSlice(slice): Promise<FromSliceSnapshotResult<Attachment>>

Parameters

• slice: Slice

Returns

Promise<FromSliceSnapshotResult<Attachment>>

Inherited from

BaseAdapter.fromSlice

Source

packages/framework/store/dist/adapter/base.d.ts:57

---

fromSliceSnapshot()

fromSliceSnapshot(payload): Promise<FromSliceSnapshotResult<Attachment>>

Parameters

• payload: FromSliceSnapshotPayload

Returns

Promise<FromSliceSnapshotResult<Attachment>>

Overrides

BaseAdapter.fromSliceSnapshot

Source

packages/blocks/src/_common/adapters/attachment.ts:44

---

toBlock()

toBlock(payload, doc, parent?, index?): Promise<BlockModel<object>>

Parameters

• payload: ToBlockSnapshotPayload<Attachment>

• doc: Doc

• parent?: string

• index?: number

Returns

Promise<BlockModel<object>>

Inherited from

BaseAdapter.toBlock

Source

packages/framework/store/dist/adapter/base.d.ts:56

---

toBlockSnapshot()

toBlockSnapshot(_payload): Promise<BlockSnapshot>

Parameters

• _payload: ToBlockSnapshotPayload<Attachment>

Returns

Promise<BlockSnapshot>

Overrides

BaseAdapter.toBlockSnapshot

Source

packages/blocks/src/_common/adapters/attachment.ts:71

---

toDoc()

toDoc(payload): Promise<Doc>

Parameters

• payload: ToDocSnapshotPayload<Attachment>

Returns

Promise<Doc>

Inherited from

BaseAdapter.toDoc

Source

packages/framework/store/dist/adapter/base.d.ts:54

---

toDocSnapshot()

toDocSnapshot(_payload): Promise<DocSnapshot>

Parameters

• _payload: ToDocSnapshotPayload<Attachment>

Returns

Promise<DocSnapshot>

Overrides

BaseAdapter.toDocSnapshot

Source

packages/blocks/src/_common/adapters/attachment.ts:65

---

toSlice()

toSlice(payload, doc, parent?, index?): Promise<undefined | Slice>

Parameters

• payload: ToSliceSnapshotPayload<Attachment>

• doc: Doc

• parent?: string

• index?: number

Returns

Promise<undefined | Slice>

Inherited from

BaseAdapter.toSlice

Source

packages/framework/store/dist/adapter/base.d.ts:58

---

toSliceSnapshot()

toSliceSnapshot(payload): Promise<null | SliceSnapshot>

Parameters

• payload: AttachmentToSliceSnapshotPayload

Returns

Promise<null | SliceSnapshot>

Overrides

BaseAdapter.toSliceSnapshot

Source

packages/blocks/src/_common/adapters/attachment.ts:77