Class TagValidation

Hierarchy

Resource
- TagValidation

Constructors

constructor

new TagValidation(name: string, key: string, contextType?: TagValidationContexts, contextID?: number, options?: TagValidationOptions): TagValidation

Overrides Resource.constructor
- Defined in resources/tagValidation.ts:57
Parameters
- name: string
- key: string
- contextType: TagValidationContexts = TagValidationContexts.STEP
- Optional contextID: number
- options: TagValidationOptions = {}
Returns TagValidation

Properties

name

name: string

options

options: TagValidationOptions = ...

tagDefinition

tagDefinition: TagDefinition

Static Readonly childTypes

childTypes: readonly string[] = []

Static Readonly resourceType

resourceType: string = "tag_validation"

Static Optional Readonly resourceTypeRun

resourceTypeRun?: string

Methods

delete

delete(): Promise<void>

Inherited from Resource.delete
- Defined in resources/resource.ts:375
Delete the resource in DataTrue

Returns Promise<void>
Promise

deleteQueryValidation

deleteQueryValidation(index: number): void

- Defined in resources/tagValidation.ts:137
Parameters
- index: number
Returns void

getContextID

getContextID(): undefined | number

Inherited from Resource.getContextID
- Defined in resources/resource.ts:84
Gets the contextID of a resource

Returns undefined | number
contextID of the resource

getContextType

getContextType(): string

Inherited from Resource.getContextType
- Defined in resources/resource.ts:93
Gets the contextType of a resource

Returns string
contextType of the resource

getQueryValidations

getQueryValidations(): readonly QueryValidation[]

- Defined in resources/tagValidation.ts:141
Returns readonly QueryValidation[]

getResourceID

getResourceID(): undefined | number

Inherited from Resource.getResourceID
- Defined in resources/resource.ts:75
Gets the resourceID of a resource

Returns undefined | number
resourceID of the resource

insertQueryValidation

insertQueryValidation(queryValidation: QueryValidation, index?: number): void

- Defined in resources/tagValidation.ts:130
Parameters
- queryValidation: QueryValidation
- index: number = ...
Returns void

report

report(): Promise<TagValidationReport>

- Defined in resources/tagValidation.ts:191
Returns Promise<TagValidationReport>

save

save(): Promise<void>

Inherited from Resource.save
- Defined in resources/resource.ts:178
Save a resource to DataTrue

Returns Promise<void>
Promise

setContextID

setContextID(id: undefined | number): void

Inherited from Resource.setContextID
- Defined in resources/resource.ts:122
Sets the contextID of a resource

Parameters
- id: undefined | number
  
  the contextID to set
Returns void

setContextType

setContextType(contextType: TagValidationContexts): void

- Defined in resources/tagValidation.ts:164
Parameters
- contextType: TagValidationContexts
Returns void

setOptions

setOptions(options: TagValidationOptions, override?: boolean): void

Overrides Resource.setOptions
- Defined in resources/tagValidation.ts:145
Set options from the passed options object

Parameters
- options: TagValidationOptions
- override: boolean = false
Returns void

setResourceID

setResourceID(id: undefined | number): void

Inherited from Resource.setResourceID
- Defined in resources/resource.ts:102
Sets the resourceID of a resource

Parameters
- id: undefined | number
  
  the resourceID to set
Returns void

toJSON

toJSON(): Promise<Record<string, any>>

Overrides Resource.toJSON
- Defined in resources/tagValidation.ts:168
Convert the resource to an Object

Returns Promise<Record<string, any>>
object representation of the resource

toString

toString(): Promise<string>

Inherited from Resource.toString
- Defined in resources/resource.ts:66
Convert the resource to a JSON string

Returns Promise<string>
the resource represented as a JSON string

Static fromID

fromID(id: number): Promise<TagValidation>

Overrides Resource.fromID
- Defined in resources/tagValidation.ts:71
Create a resource from a given ID

Parameters
- id: number
Returns Promise<TagValidation>
Promise of the resource

Static fromJSON

fromJSON(obj: Record<string, any>, copy?: boolean): TagValidation

Overrides Resource.fromJSON
- Defined in resources/tagValidation.ts:76
Create a resource from an object

Parameters
- obj: Record<string, any>
- copy: boolean = false
Returns TagValidation
new Resource

Generated using TypeDoc