Interface IndexerMsI

Provides outward-facing methods of the indexer.

Hierarchy

IndexerMsI

Implemented by

IndexerMsMain

Index

Methods

deleteAccount getAccountState getAllIndexers getEntityPendingRequests indexAccount invokeDomainMethod

Methods

deleteAccount

deleteAccount(args: AccountIndexerRequestArgs): Promise<void>
Remove the indexer for the given account, either for transactions or content or both.
Parameters
- args: AccountIndexerRequestArgs
  
  The indexer configuration.
Returns Promise<void>
- Defined in packages/framework/src/services/indexer/interface.ts:39

getAccountState

getAccountState(args: GetAccountIndexingEntityStateRequestArgs): Promise<undefined | AccountIndexerState>
Returns the indexing state of the given account.
Parameters
- args: GetAccountIndexingEntityStateRequestArgs
  
  The account to get the state of.
Returns Promise<undefined | AccountIndexerState>
- Defined in packages/framework/src/services/indexer/interface.ts:25

getAllIndexers

getAllIndexers(): string[]
Returns all indexer IDs.

Returns string[]
- Defined in packages/framework/src/services/indexer/interface.ts:52

getEntityPendingRequests

getEntityPendingRequests(args: GetEntityPendingRequestsRequestArgs): Promise<EntityRequest[]>
Returns all pending and processed transaction requests.
Parameters
- args: GetEntityPendingRequestsRequestArgs
Returns Promise<EntityRequest[]>
- Defined in packages/framework/src/services/indexer/interface.ts:45

indexAccount

indexAccount(args: AccountIndexerRequestArgs): Promise<void>
Registers a new indexer for the given account, either for transactions or content or both.
Parameters
- args: AccountIndexerRequestArgs
  
  The indexer configuration.
Returns Promise<void>
- Defined in packages/framework/src/services/indexer/interface.ts:20

invokeDomainMethod

invokeDomainMethod(args: InvokeMethodRequestArgs): Promise<unknown>
Invokes a domain method with the given account. This will be forwarded through the broker to the worker. @todo: Correct?
Parameters
- args: InvokeMethodRequestArgs
  
  The account, the method and additional arguments to pass to the method.
Returns Promise<unknown>
- Defined in packages/framework/src/services/indexer/interface.ts:33

Generated using TypeDoc