API Docs for: 2.2.2
Show:

StoreSchema.Builder Class

A builder for constructing StoreSchema instances.

Rather than having to manually construct the options and instantiating a StoreSchema directly, this builder may be used.

var store = StoreSchema.Builder()
             .withSchemaName('schema_name')
             .withSchema(mySchemaXML)
             .withCallback(callback)
             .build();

Constructor

StoreSchema.Builder

()

Methods

build

() StoreSchema

Construct a StoreSchema instance.

Returns:

withCallback

(
  • callback
)
chainable

Set the callback to be executed when the operation completes.

Parameters:

  • callback Function

    the callback to execute

    • err String

      An error message

    • response Boolean

      operation either succeeds or errors. This will be true.

withSchema

(
  • schemaXML
)
chainable

The XML that defines this schema

Parameters:

  • schemaXML String

    The XML that defines the schema

withSchemaName

(
  • schemaName
)
chainable

The name of the schema.

Parameters:

  • schemaName String

    the name of the schema.