@univerjs-pro/exchange-client v0.5.0-beta.1 • Docs

Class: ExchangeService

Extends

Disposable

Implements

Constructors

new ExchangeService()

new ExchangeService(_configService, _requestService): ExchangeService

Parameters

Parameter	Type
`_configService`	`IConfigService`
`_requestService`	`RequestService`

Returns

ExchangeService

Overrides

Disposable.constructor

Defined in

packages/exchange-client/src/services/exchange.service.ts:88

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`_disposed`	`protected`	`boolean`	`false`	`Disposable`.`_disposed`	submodules/univer/packages/core/src/shared/lifecycle.ts:93
`requestState$`	`readonly`	`Observable`<`IRequestState`>	`undefined`	-	packages/exchange-client/src/services/exchange.service.ts:86

Methods

dispose()

dispose(): void

Returns

void

Implementation of

IDisposable.dispose

Overrides

Disposable.dispose

Defined in

packages/exchange-client/src/services/exchange.service.ts:95

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:96

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:100

exportDOCXBySnapshot()

exportDOCXBySnapshot(snapshot): Promise<undefined | File>

Export DOCX file by document data

Parameters

Parameter	Type
`snapshot`	`IDocumentData`

Returns

Promise<undefined | File>

Implementation of

IExchangeService.exportDOCXBySnapshot

Defined in

packages/exchange-client/src/services/exchange.service.ts:116

exportDOCXByUnitId()

exportDOCXByUnitId(unitId): Promise<undefined | File>

Export DOCX file by unit id

Parameters

Parameter	Type
`unitId`	`string`

Returns

Promise<undefined | File>

Implementation of

IExchangeService.exportDOCXByUnitId

Defined in

packages/exchange-client/src/services/exchange.service.ts:112

exportXLSXBySnapshot()

exportXLSXBySnapshot(data): Promise<undefined | File>

Export XLSX file by workbook data

Parameters

Parameter	Type
`data`	`IWorkbookData`

Returns

Promise<undefined | File>

Implementation of

IExchangeService.exportXLSXBySnapshot

Defined in

packages/exchange-client/src/services/exchange.service.ts:147

exportXLSXByUnitId()

exportXLSXByUnitId(unitId): Promise<undefined | File>

Export XLSX file by unit id

Parameters

Parameter	Type
`unitId`	`string`

Returns

Promise<undefined | File>

Implementation of

IExchangeService.exportXLSXByUnitId

Defined in

packages/exchange-client/src/services/exchange.service.ts:143

importDOCXToSnapshot()

importDOCXToSnapshot(file): Promise<undefined | IDocumentData>

Import DOCX file to document data

Parameters

Parameter	Type
`file`	`string` \| `File`

Returns

Promise<undefined | IDocumentData>

Implementation of

IExchangeService.importDOCXToSnapshot

Defined in

packages/exchange-client/src/services/exchange.service.ts:100

importFileToUnitId()

importFileToUnitId(file, univerType): Promise<undefined | string>

Import file to unit id

Parameters

Parameter	Type
`file`	`string` \| `File`
`univerType`	`UniverType`

Returns

Promise<undefined | string>

Implementation of

IExchangeService.importFileToUnitId

Defined in

packages/exchange-client/src/services/exchange.service.ts:152

importXLSXToSnapshot()

importXLSXToSnapshot(file): Promise<undefined | IWorkbookData>

Import XLSX file to workbook data

Parameters

Parameter	Type
`file`	`string` \| `File`

Returns

Promise<undefined | IWorkbookData>

Implementation of

IExchangeService.importXLSXToSnapshot

Defined in

packages/exchange-client/src/services/exchange.service.ts:120

Exchangeoperateservice Requestservice