Interface AdminApi

Describes Ceramic Admin API functionality

Hierarchy

AdminApi

Index

Properties

Methods

getIndexedModelData getIndexedModels nodeStatus startIndexingModelData startIndexingModels stopIndexingModelData stopIndexingModels

Properties

pin

Methods

getIndexedModelData

getIndexedModelData(): Promise<ModelData[]>
List indexed model streams with additional model data (such as the defined field indices)

Returns Promise<ModelData[]>
- Defined in packages/common/src/ceramic-api.ts:91

getIndexedModels

getIndexedModels(): Promise<StreamID[]>
Deprecated
List indexed model streams

Returns Promise<StreamID[]>
- Defined in packages/common/src/ceramic-api.ts:86

nodeStatus

nodeStatus(): Promise<NodeStatusResponse>
Returns a JSON object with various diagnostic and introspection information about the running node.

Returns Promise<NodeStatusResponse>
- Defined in packages/common/src/ceramic-api.ts:80

startIndexingModelData

startIndexingModelData(modelData: ModelData[]): Promise<void>
Adds model streams to index as specified by ModelData
Parameters
- modelData: ModelData[]
  
  array of model streams with field indices to index
Returns Promise<void>
- Defined in packages/common/src/ceramic-api.ts:106

startIndexingModels

startIndexingModels(modelsIDs: StreamID[]): Promise<void>
Adds model streams to index

Deprecated
Parameters
- modelsIDs: StreamID[]
  
  array of model stream IDs to add to index. This parameter is deprecated and indices should be specified instead
Returns Promise<void>
- Defined in packages/common/src/ceramic-api.ts:100

stopIndexingModelData

stopIndexingModelData(modelData: ModelData[]): Promise<void>
Removes model streams from index
Parameters
- modelData: ModelData[]
  
  array of model data to remove from index
Returns Promise<void>
- Defined in packages/common/src/ceramic-api.ts:122

stopIndexingModels

stopIndexingModels(modelsIDs: StreamID[]): Promise<void>
Deprecated
Removes model streams from index
Parameters
- modelsIDs: StreamID[]
  
  array of model stream IDs to remove from index
Returns Promise<void>
- Defined in packages/common/src/ceramic-api.ts:115