Options
All
  • Public
  • Public/Protected
  • All
Menu

Class JsonResultsAdapter

A JsonResultsAdapter instance is used to provide custom extraction and parsing logic on the json results returned by any web service. This facility makes it possible for breeze to talk to virtually any web service and return objects that will be first class 'breeze' citizens.

Hierarchy

  • JsonResultsAdapter

Index

Constructors

Properties

Constructors

constructor

  • JsonResultsAdapter constructor

    example

    // var jsonResultsAdapter = new JsonResultsAdapter({ name: "test1e", extractResults: function(json) { return json.results; }, visitNode: function(node, mappingContext, nodeContext) { var entityType = normalizeTypeName(node.$type); var propertyName = nodeContext.propertyName; var ignore = propertyName && propertyName.substr(0, 1) === "$";

    return { entityType: entityType, nodeId: node.$id, nodeRefId: node.$ref, ignore: ignore, passThru: false // default }; } });

    var dataService = new DataService( { serviceName: "breeze/foo", jsonResultsAdapter: jsonResultsAdapter });

    var entityManager = new EntityManager( { dataService: dataService });

    Parameters

    Returns JsonResultsAdapter

Properties

Optional extractDeletedKeys

extractDeletedKeys: (data: {}) => any[]

A function that is called once per save operation to extract any deleted keys from any json received over the wire. Must return an array. This method has a default implementation which is to simply returns the "deletedKeys" property from any json returned as a result of executing the save.

Type declaration

    • (data: {}): any[]

    • Parameters

      • data: {}

      Returns any[]

extractKeyMappings

extractKeyMappings: (data: {}) => KeyMapping[]

A function that is called once per save operation to extract the key mappings from any json received over the wire. Must return an array. This method has a default implementation which simply returns the "keyMappings" property from any json returned as a result of executing the save.

Type declaration

extractResults

extractResults: Function

A Function that is called once per query operation to extract the 'payload' from any json received over the wire. This method has a default implementation which simply returns the "results" property from any json returned as a result of executing the query.

extractSaveResults

extractSaveResults: Function

A function that is called once per save operation to extract the entities from any json received over the wire. Must return an array. This method has a default implementation which simply returns the "entities" property from any json returned as a result of executing the save.

name

name: string

The name of this adapter. This name is used to uniquely identify and locate this instance when an 'exported' JsonResultsAdapter is later imported.

visitNode

visitNode: Function

A visitor method that will be called on each node of the returned payload.

Generated using TypeDoc