cap-nodejs

CAP Node.js API

---

CAP Node.js API / cap-dashboard-nest/src / CapDashboardService

Class: CapDashboardService

Defined in: cap-dashboard-nest/src/cap-dashboard.service.ts:32

Extends

• CapDashboardCoreService

Constructors

Constructor

new CapDashboardService(publishStorage, receivedStorage, capService?, publisher?, options?, schedulerOptions?): CapDashboardService

Defined in: cap-dashboard-nest/src/cap-dashboard.service.ts:33

Parameters

publishStorage

PublishStoragePort

receivedStorage

ReceivedStoragePort

capService?

CapService

publisher?

PublisherPort

options?

CapDashboardServiceOptions

schedulerOptions?

ResolvedCapSchedulerOptions = DEFAULT_RETRY_OPTIONS

Returns

CapDashboardService

Overrides

CapDashboardCoreService.constructor

Methods

flushOutbox()

flushOutbox(): Promise<ActionResultDto>

Defined in: cap-dashboard-core/dist/dashboard.service.d.ts:50

Returns

Promise<ActionResultDto>

Inherited from

CapDashboardCoreService.flushOutbox

---

getInboxById()

getInboxById(id, full?): Promise<InboxItemDto | undefined>

Defined in: cap-dashboard-core/dist/dashboard.service.d.ts:47

Parameters

id

string

full?

boolean

Returns

Promise<InboxItemDto | undefined>

Inherited from

CapDashboardCoreService.getInboxById

---

getOutboxById()

getOutboxById(id, full?): Promise<OutboxItemDto | undefined>

Defined in: cap-dashboard-core/dist/dashboard.service.d.ts:43

Parameters

id

string

full?

boolean

Returns

Promise<OutboxItemDto | undefined>

Inherited from

CapDashboardCoreService.getOutboxById

---

listInbox()

listInbox(query): Promise<InboxPageDto>

Defined in: cap-dashboard-core/dist/dashboard.service.d.ts:46

Parameters

query

ListQueryDto

Returns

Promise<InboxPageDto>

Inherited from

CapDashboardCoreService.listInbox

---

listOutbox()

listOutbox(query): Promise<OutboxPageDto>

Defined in: cap-dashboard-core/dist/dashboard.service.d.ts:42

Parameters

query

ListQueryDto

Returns

Promise<OutboxPageDto>

Inherited from

CapDashboardCoreService.listOutbox

---

markInboxProcessed()

markInboxProcessed(id): Promise<ActionResultDto>

Defined in: cap-dashboard-core/dist/dashboard.service.d.ts:49

Parameters

id

string

Returns

Promise<ActionResultDto>

Inherited from

CapDashboardCoreService.markInboxProcessed

---

markOutboxPublished()

markOutboxPublished(id): Promise<ActionResultDto>

Defined in: cap-dashboard-core/dist/dashboard.service.d.ts:45

Parameters

id

string

Returns

Promise<ActionResultDto>

Inherited from

CapDashboardCoreService.markOutboxPublished

---

retryInbox()

retryInbox(id, _opts?): Promise<ActionResultDto>

Defined in: cap-dashboard-core/dist/dashboard.service.d.ts:48

Parameters

id

string

_opts?

RetryOptions

Returns

Promise<ActionResultDto>

Inherited from

CapDashboardCoreService.retryInbox

---

retryOutbox()

retryOutbox(id, _opts?): Promise<ActionResultDto>

Defined in: cap-dashboard-core/dist/dashboard.service.d.ts:44

Parameters

id

string

_opts?

RetryOptions

Returns

Promise<ActionResultDto>

Inherited from

CapDashboardCoreService.retryOutbox

This site is open source. Improve this page.