File

src/api/webApi/classes/detailsApi.interface.ts

Description

API for accessing the detail information of an item in the catalogue.

Index

Methods

Methods

getDetails
getDetails(summary: DistributionSummary, context: string)

Get details.

Parameters :
Name Type Optional
summary DistributionSummary No
context string No
getDetailsById
getDetailsById(id: string, context: string)
Parameters :
Name Type Optional
id string No
context string No
import { DistributionSummary } from '../data/distributionSummary.interface';
import { DistributionDetails } from '../data/distributionDetails.interface';

/**
 * API for accessing the detail information of an item in the catalogue.
 */
export interface DetailsApi {
  /**
   * Get details.
   */
  getDetails(summary: DistributionSummary, context: string): Promise<null | DistributionDetails>;

  getDetailsById(id: string, context: string): Promise<null | DistributionDetails>;
}

results matching ""

    No results matching ""