Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • VlocityAttributes

Index

Constructors

constructor

  • Parameters

    • config: any

    Returns VlocityAttributes

Properties

config

config: any

Methods

createUpdateApplicableObjectsInput

  • Returns the instance of UpdateApplicableObjectsInput to update applicable objects

    Returns UpdateApplicableObjectsInput

getAllObjects

  • getAllObjects(): Promise<any>
  • method

    getAllObjects - returns all object classes

    example
    
       // Invoke API via method getAllObjects()
       productconsole
      .getVlocityAttributesSdk().getAllObjects()
      .then(result => {
        Logger.info("getAllObjects() remote action success " + result);
      })
      .catch(error => {
        Logger.info("getAllObjects() remote action failed " + error);
      });
    

    Returns Promise<any>

    • Promise that returns a success or failure message.

getApplicableObjects

  • getApplicableObjects(attributeId: any): Promise<any>
  • method

    getApplicableObjects - returns applicable object classes for an attribute

    example
    
       // Invoke API via method getApplicableObjects()
       const attributeId = "";
       productconsole
      .getVlocityAttributesSdk().getApplicableObjects(attributeId)
      .then(result => {
        Logger.info("getApplicableObjects() remote action success " + result);
      })
      .catch(error => {
        Logger.info("getApplicableObjects() remote action failed " + error);
      });
    
    throws

    {Error} - "attributeId :: getApplicableObjects() must be defined"

    Parameters

    • attributeId: any

    Returns Promise<any>

    • Promise that returns a success or failure message.

getObjects

  • getObjects(attributeId: any): Promise<unknown>
  • method

    getObjects - get objects.

    example
    
       // objectId as parameter to the getObjects method
       const attributeId = "";
       // Invoke API via method getObjects()
       productconsole
      .getVlocityAttributesSdk().getObjects(attributeId)
      .then(result => {
        Logger.info("vlocity objects remote action success " + result);
      })
      .catch(error => {
        Logger.info("vlocity objects remote action failed " + error);
      });
    
    throws

    {Error} - "attributeId :: getObjects() must be defined"

    Parameters

    • attributeId: any

    Returns Promise<unknown>

    • Promise that returns a success or failure message.

saveApplicableObjects

  • method

    saveApplicableObjects - update applicable objects

    example
    
       // Instantiate the input object for saveApplicableObjects using createUpdateApplicableObjectsInput() to specify parameters
       // attributeId, newApplicableObjectClasses and newNonApplicableObjectClasses as parameters to the createGetFacetDetailsInput
       const input = productconsole.getVlocityAttributesSdk.createGetFacetDetailsInput();
       input.attributeId = "";
       input.newApplicableObjectClasses = [];
       input.newNonApplicableObjectClasses = [];
       // Invoke API via method saveApplicableObjects()
       productconsole
      .getVlocityAttributesSdk().saveApplicableObjects(input)
      .then(result => {
        Logger.info("vlocity save applicable objects remote action success " + result);
      })
      .catch(error => {
        Logger.info("vlocity save applicable objects remote action failed " + error);
      });
    
    throws

    {Error} - "UpdateApplicableObjectsInput :: saveApplicableObjects() must be defined"

    throws

    {Error} - "UpdateApplicableObjectsInput :: saveApplicableObjects() must have attributeId defined"

    throws

    {Error} - "UpdateApplicableObjectsInput :: saveApplicableObjects() must have newApplicableObjectClasses defined"

    throws

    {Error} - "UpdateApplicableObjectsInput :: saveApplicableObjects() must have newNonApplicableObjectClasses defined"

    Parameters

    Returns Promise<any>

    • Promise that returns a success or failure message.

transformObjects

  • transformObjects(allObjects: any, appliedObjects: any): { allObjects: any; appliedObjects: any }
  • method

    transformObjects - returns modified allObjects and applied objects

    Parameters

    • allObjects: any
    • appliedObjects: any

    Returns { allObjects: any; appliedObjects: any }

    • modified allObjects and applied objects
    • allObjects: any
    • appliedObjects: any

Generated using TypeDoc