Class Category

A Category represents a category within a project. It has various configuration settings. It also has a list of fields for that category.

Index

Constructors

Properties

allFieldsFieldMask category project

Methods

constructSearchFieldMask createFieldMask getConfig getFieldIdFromLabel getFields getId getItemConfig getItems getProject getTestConfig isFolderCategory

Constructors

constructor

new Category(category, project): Category
Parameters
- category: string
- project: Project
Returns Category
- Defined in ts/sdk/objects/Category.ts:211

Properties

`Private` allFieldsFieldMask

allFieldsFieldMask: ItemFieldMask

`Private` category

category: string

`Private` project

project: Project

Methods

constructSearchFieldMask

constructSearchFieldMask(options): ItemsFieldMask
Construct a search mask from chosen options
Parameters
- options: IFieldMaskOptions
Returns ItemsFieldMask
an ItemsFieldMask object
- Defined in ts/sdk/objects/Category.ts:289

createFieldMask

createFieldMask(fieldIds?): ItemFieldMask
An ItemFieldMask allows you to specify which fields out of the Category fields of an Item should be considered valid.
Parameters
- Optional fieldIds: number[]
  If specified, a valid set of field ids for this Category. Otherwise, the returned ItemFieldMask expresses that all fields in the Item are to be considered valid.
Returns ItemFieldMask
an ItemFieldMask.

Throws
throws an Error if any of the field ids specified in fieldIds do not exist in the Category.
- Defined in ts/sdk/objects/Category.ts:270

getConfig

getConfig(): ICategoryConfig
Returns ICategoryConfig
- Defined in ts/sdk/objects/Category.ts:233

getFieldIdFromLabel

getFieldIdFromLabel(label): number[]
Return field ids from the Category which match the given label. These labels are searched in a case-insensitive way.
Parameters
- label: string
Returns number[]
a non-empty array of field ids if the label is present in the Category.
- Defined in ts/sdk/objects/Category.ts:247

getFields

getFields(): XRFieldTypeAnnotated[]
Returns XRFieldTypeAnnotated[]
- Defined in ts/sdk/objects/Category.ts:237

getId

getId(): string
Returns string
- Defined in ts/sdk/objects/Category.ts:229

getItemConfig

getItemConfig(): ItemConfiguration
Returns ItemConfiguration
- Defined in ts/sdk/objects/Category.ts:222

getItems

getItems(options?): Promise<Item[]>
Get all of the items of this Category.
Parameters
- Optional options: ICategoryItemOptions
  An optional ICategoryItemOptions describing search options.
Returns Promise<Item[]>
An array of Items of this Category, configured according to the options given.
- Defined in ts/sdk/objects/Category.ts:298

getProject

getProject(): Project
Returns Project
- Defined in ts/sdk/objects/Category.ts:219

getTestConfig

getTestConfig(): TestManagerConfiguration
Returns TestManagerConfiguration
- Defined in ts/sdk/objects/Category.ts:225

isFolderCategory

isFolderCategory(): boolean
Returns boolean
- Defined in ts/sdk/objects/Category.ts:257

Generated using TypeDoc