Infohub JS API
Loading...
Searching...
No Matches
CatalogueServices Class Reference

Public Member Functions

 constructor (ctx)
async createCatalogue (cat_data, cb)
async getCatalogue (cat_id, query, cb, cat_data=null)
 getCatalogueByShortId (project_sid, cb, query={ members:['info'] })
async getCatalogueList (cb, query=null)

Public Attributes

 _ctx = null

Function Documentation

◆ constructor()

constructor ( ctx)
Since
1.0, 09.2025, jh
Parameters
{Context}ctx - Context instance

◆ createCatalogue()

async createCatalogue ( cat_data,
cb )
Parameters
{*}cat_data
Returns
{Promise<Function>} Callback function

◆ getCatalogue()

async getCatalogue ( cat_id,
query,
cb,
cat_data = null )

Get catalogue by ID.

If catalogue does not exist and cat_data is given, a new catalogue is created using cat_data

Parameters
{*}cat_id
{*}query = { 'members' : 'info,properties' 'properties' : 'nodes' : }
{*}cb Callback function
{*}cat_data
Returns
{Promise<ApiResponse>} By Callback function

◆ getCatalogueByShortId()

getCatalogueByShortId ( project_sid,
cb,
query = { members: ['info'] } )
Parameters
{*}project_sid
{*}cb
{*}query

◆ getCatalogueList()

async getCatalogueList ( cb,
query = null )

Get list of catalogues.

Parameters
{*}cb callback
{*}query optional query filter

Member Data Documentation

◆ _ctx

_ctx = null