Interface SaveDomainOptions

interface SaveDomainOptions {
    containerPath?: string;
    domainDesign?: any;
    domainId?: number;
    failure?: RequestFailure<any>;
    includeWarnings?: boolean;
    options?: any;
    queryName?: string;
    schemaName?: string;
    scope?: any;
    success?: RequestSuccess<any>;
}

Hierarchy (view full)

Properties

containerPath? domainDesign? domainId? failure? includeWarnings? options? queryName? schemaName? scope? success?

Properties

Optional containerPath

containerPath?: string

The container path in which the requested Domain is defined. If not supplied, the current container path will be used.

Optional domainDesign

domainDesign?: any

The domain design to save.

Optional domainId

domainId?: number

Id of the domain. This is an alternate way to identify the domain to update. SchemaName and queryName will be ignored if this value is not undefined or null.

Optional failure

failure?: RequestFailure<any>

This will be called upon failure to complete a request.

Optional includeWarnings

includeWarnings?: boolean

Set to true to prevent save from completing when a server side warning occurs.

Optional options

options?: any

Domain Kind specific properties. If not supplied, will be ignored. Note: Certain domain kind specific properties are read-only and cannot be updated. Read-only properties for 'IntList' & 'VarList' domain kinds: listId, domainId, keyName, keyType, and lastIndexed.

Optional queryName

queryName?: string

Name of the query.

Optional schemaName

schemaName?: string

Name of the schema.

Optional scope

scope?: any

A scoping object for the success and failure callback functions (default to this).

Optional success

success?: RequestSuccess<any>

This will be called upon successfully completing a request.

Settings

Member Visibility

Theme

On This Page

containerPathdomainDesigndomainIdfailureincludeWarningsoptionsqueryNameschemaNamescopesuccess

Generated using TypeDoc