Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IPickerTerm

Selected terms

Hierarchy

  • ITermData
  • ITerm
    • IPickerTerm

Index

Properties

Methods

Properties

Optional CustomProperties

CustomProperties: any

Optional CustomSortOrder

CustomSortOrder: any | null

Optional Description

Description: string

Optional Id

Id: string

Optional IsAvailableForTagging

IsAvailableForTagging: boolean

Optional IsDeprecated

IsDeprecated: boolean

Optional IsKeyword

IsKeyword: boolean

Optional IsPinned

IsPinned: boolean

Optional IsPinnedRoot

IsPinnedRoot: boolean

Optional IsReused

IsReused: boolean

Optional IsRoot

IsRoot: boolean

Optional IsSourceTerm

IsSourceTerm: boolean

Optional LastModifiedDate

LastModifiedDate: string

Optional LocalCustomProperties

LocalCustomProperties: any

Optional MergedTermIds

MergedTermIds: any[]

Optional Name

Name: string

Optional Owner

Owner: string

Optional PathDepth

PathDepth: number

Optional PathOfTerm

PathOfTerm: string

Optional TermsCount

TermsCount: number

labels

labels: ILabels

parent

parent: ITerm

pinSourceTermSet

pinSourceTermSet: ITermSet

reusedTerms

reusedTerms: ITerms

sourceTerm

sourceTerm: ITerm

termSet

termSet: ITermSet

termSets

termSets: ITermSets

terms

terms: ITerms

Methods

addTerm

  • addTerm(name: string, lcid: number, isAvailableForTagging?: boolean, id?: string): Promise<ITerm & ITermData>

  • Parameters

    • name: string
    • lcid: number
    • Optional isAvailableForTagging: boolean
    • Optional id: string

    Returns Promise<ITerm & ITermData>

createLabel

  • createLabel(name: string, lcid: number, isDefault?: boolean): Promise<ILabelData & ILabel>

  • Parameters

    • name: string
    • lcid: number
    • Optional isDefault: boolean

    Returns Promise<ILabelData & ILabel>

deprecate

  • deprecate(doDeprecate: boolean): Promise<void>

  • Parameters

    • doDeprecate: boolean

    Returns Promise<void>

get

  • get(): Promise<ITermData & ITerm>

  • Returns Promise<ITermData & ITerm>

getDescription

  • getDescription(lcid: number): Promise<string>

  • Parameters

    • lcid: number

    Returns Promise<string>

inBatch

  • inBatch(batch: IObjectPathBatch): this

  • Parameters

    • batch: IObjectPathBatch

    Returns this

select

  • select(...selects: string[]): this

  • Parameters

    • Rest ...selects: string[]

    Returns this

setDescription

  • setDescription(description: string, lcid: number): Promise<void>

  • Parameters

    • description: string
    • lcid: number

    Returns Promise<void>

setLocalCustomProperty

  • setLocalCustomProperty(name: string, value: string): Promise<void>

  • Parameters

    • name: string
    • value: string

    Returns Promise<void>

update

  • update(properties: object): Promise<ITermData & ITerm>

  • Parameters

    • properties: object
      • Name: string

    Returns Promise<ITermData & ITerm>

usingCaching

  • usingCaching(options?: ICachingOptions): this

  • Parameters

    • Optional options: ICachingOptions

    Returns this

Generated using TypeDoc