RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

MAFSizerBatchModel

Extends
  • BaseModel

Summary

MAFSizerBatchModel Constructor

.

Description

Model Class for a MAF Sizer Batch

Constructor

protected

new MAFSizerBatchModel(siteId)

MAFSizerBatchModel Constructor

Parameters

  • siteId number

    The Site ID associated with this MAF Sizer Batch

Source

Members

articleSummariesArray.<{index: ?number, name: string, fruitCount: number, fruitWeight: number}>

An Array of Summary Data Objects for each Article

Type

  • Array.<{index: ?number, name: string, fruitCount: number, fruitWeight: number}>

Source

fruitSummariesArray.<{sizeIndex: number, sizeName: string, articleIndex: number, articleName: string, fruitCount: number, fruitWeight: number}>

An Array of Summary Data Objects for each Fruit Size and Article

Type

  • Array.<{sizeIndex: number, sizeName: string, articleIndex: number, articleName: string, fruitCount: number, fruitWeight: number}>

Source

outletFruitSummariesArray.<{outletNumber: number, sizeIndex: number, sizeName: string, articleIndex: number, articleName: string, fruitCount: number, fruitWeight: number}>

An Array of Summary Data Objects for each Outlet by Fruit Size and Article

Type

  • Array.<{outletNumber: number, sizeIndex: number, sizeName: string, articleIndex: number, articleName: string, fruitCount: number, fruitWeight: number}>

Source

outletSummariesArray.<{number: number, fruitCount: number, fruitWeight: number, seenArticles: Array.<number>, activeArticles: Array.<number>}>

An Array of Summary Data Objects for each Outlet

Type

  • Array.<{number: number, fruitCount: number, fruitWeight: number, seenArticles: Array.<number>, activeArticles: Array.<number>}>

Source

Methods

static

fromJSON(json, siteId) → {MAFSizerBatchModel}

Create a new MAFSizerBatchModel from a JSON Object or JSON String

Parameters

  • json Object.<string, any> | string

    A JSON Object or JSON String

  • siteId number

    The Site ID associated with this MAF Sizer Batch

Returns

  • MAFSizerBatchModel

Source