Class TaxonomySession

Hierarchy

Index

Methods

Methods

public customFromJson(initValue: any): boolean

Parameters

  • initValue: any

Returns

boolean

public fromJson(initValue: any)

Parameters

  • initValue: any

public getDefaultKeywordsTermStore(): TermStore

Returns

TermStore

public getDefaultSiteCollectionTermStore(): TermStore

Returns

TermStore

public static getTaxonomySession(context: ClientContext): TaxonomySession

Parameters

Returns

TaxonomySession

public getTerm(guid: Guid): Term

Parameters

Returns

Term

public getTermSetsByName(termSetName: string, lcid: number): TermSetCollection

Parameters

  • termSetName: string
  • lcid: number

Returns

TermSetCollection

public getTermSetsByTermLabel(requiredTermLabels: Array<string>, lcid: number): TermSetCollection

Parameters

  • requiredTermLabels: Array<string>
  • lcid: number

Returns

TermSetCollection

public getTerms(termLabel: string, trimUnavailable: boolean): TermCollection

Parameters

  • termLabel: string
  • trimUnavailable: boolean

Returns

TermCollection

public getTerms(labelMatchInformation: LabelMatchInformation): TermCollection

Parameters

Returns

TermCollection

public getTermsById(termIds: Guid[]): TermCollection

Parameters

Returns

TermCollection

public getTermsInDefaultLanguage(termLabel: string, defaultLabelOnly: boolean, stringMatchOption: StringMatchOption, resultCollectionSize: number, trimUnavailable: boolean, trimDeprecated: boolean): TermCollection

Parameters

  • termLabel: string
  • defaultLabelOnly: boolean
  • stringMatchOption: StringMatchOption
  • resultCollectionSize: number
  • trimUnavailable: boolean
  • trimDeprecated: boolean

Returns

TermCollection

public getTermsInWorkingLocale(termLabel: string, defaultLabelOnly: boolean, stringMatchOption: StringMatchOption, resultCollectionSize: number, trimUnavailable: boolean, trimDeprecated: boolean): TermCollection

Parameters

  • termLabel: string
  • defaultLabelOnly: boolean
  • stringMatchOption: StringMatchOption
  • resultCollectionSize: number
  • trimUnavailable: boolean
  • trimDeprecated: boolean

Returns

TermCollection

public getTermsWithCustomProperty(customPropertyName: string, trimUnavailable: boolean): TermCollection

Parameters

  • customPropertyName: string
  • trimUnavailable: boolean

Returns

TermCollection

public getTermsWithCustomProperty(customPropertyMatchInformation: CustomPropertyMatchInformation): TermCollection

Parameters

Returns

TermCollection

public get_context(): ClientRuntimeContext

Returns

ClientRuntimeContext

public get_objectVersion(): string

Returns

string

public get_offlineTermStoreNames(): Array<string>

Returns

Array<string>

public get_path(): ObjectPath

Returns

ObjectPath

public get_serverObjectIsNull(): boolean

Returns

boolean

public get_termStores(): TermStoreCollection

Returns

TermStoreCollection

public get_typedObject(): ClientObject

Returns

ClientObject

public isObjectPropertyInstantiated(propertyName: string): boolean

Parameters

  • propertyName: string

Returns

boolean

public isPropertyAvailable(propertyName: string): boolean

Parameters

  • propertyName: string

Returns

boolean

public refreshLoad()

public retrieve()

public retrieve(propertyNames: Array<string>)

Parameters

  • propertyNames: Array<string>

public set_objectVersion(value: string)

Parameters

  • value: string

public updateCache()