Evergage Core API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

attributes

attributes: object

'name' : String 'url' : String 'imageUrl' : String 'description' : String 'promotable' : boolean 'archived' : boolean

Type declaration

Optional dimensions

dimensions: object

Type declaration

  • [index: string]: string[]

id

id: string

Optional location

location: Location

Methods

Optional toFlatJSON

  • toFlatJSON(): object
  • toFlatJSON(attributeNames?: string[]): object
  • toFlatJSON(attributeNames?: string[], locale?: string): object
  • Converts all non-complex attributes to a flat JSON like structure. Attributes are returned using the default locale.

    Returns object

    Flat JSON version of requested attributes

    • [attributeName: string]: any
  • Converts all non-complex attributes to a flat JSON like structure. Attributes are returned using the default locale.

    Parameters

    • Optional attributeNames: string[]

    Returns object

    Flat JSON version of requested attributes

    • [attributeName: string]: any
  • Converts all non-complex attributes to a flat JSON like structure. Attributes are returned using the default locale.

    Parameters

    • Optional attributeNames: string[]
    • Optional locale: string

    Returns object

    Flat JSON version of requested attributes

    • [attributeName: string]: any

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc