import { _SPInstance, _SPCollection } from "../spqueryable.js"; /** * Describes a collection of Form objects * */ export declare class _TermStore extends _SPInstance { /** * Gets the term groups associated with this tenant */ get groups(): ITermGroups; /** * Gets the term sets associated with this tenant */ get sets(): ITermSets; /** * Allows you to locate terms within the termStore * * @param params Search parameters used to locate the terms, label is required * @returns Array of terms including set information for each term */ searchTerm(params: ISearchTermParams): Promise>[]>; } export interface ITermStore extends _TermStore { } export declare const TermStore: import("../spqueryable.js").ISPInvokableFactory; export declare class _TermGroups extends _SPCollection { /** * Gets a term group by id * * @param id Id of the term group to access */ getById(id: string): ITermGroup; } export interface ITermGroups extends _TermGroups { } export declare const TermGroups: import("../spqueryable.js").ISPInvokableFactory; export declare class _TermGroup extends _SPInstance { /** * Gets the term sets associated with this tenant */ get sets(): ITermSets; } export interface ITermGroup extends _TermGroup { } export declare const TermGroup: import("../spqueryable.js").ISPInvokableFactory; export declare class _TermSets extends _SPCollection { /** * Gets a term group by id * * @param id Id of the term group to access */ getById(id: string): ITermSet; } export interface ITermSets extends _TermSets { } export declare const TermSets: import("../spqueryable.js").ISPInvokableFactory; export declare class _TermSet extends _SPInstance { /** * Gets all the terms in this set */ get terms(): ITerms; get parentGroup(): ITermGroup; get children(): IChildren; get relations(): IRelations; getTermById(id: string): ITerm; /** * Gets all the terms in this termset in an ordered tree using the appropriate sort ordering * ** This is an expensive operation and you should strongly consider caching the results ** * * @param props Optional set of properties controlling how the tree is retrieved. */ getAllChildrenAsOrderedTree(props?: Partial): Promise; } export interface ITermSet extends _TermSet { } export declare const TermSet: import("../spqueryable.js").ISPInvokableFactory; export declare class _Children extends _SPCollection { } export interface IChildren extends _Children { } export declare const Children: import("../spqueryable.js").ISPInvokableFactory; export declare class _Terms extends _SPCollection { /** * Gets a term group by id * * @param id Id of the term group to access */ getById(id: string): ITerm; } export interface ITerms extends _Terms { } export declare const Terms: import("../spqueryable.js").ISPInvokableFactory; export declare class _Term extends _SPInstance { get children(): IChildren; get relations(): IRelations; get set(): ITermSet; } export interface ITerm extends _Term { } export declare const Term: import("../spqueryable.js").ISPInvokableFactory; export declare class _Relations extends _SPCollection { /** * Gets a term group by id * * @param id Id of the term group to access */ getById(id: string): IRelation; } export interface IRelations extends _Relations { } export declare const Relations: import("../spqueryable.js").ISPInvokableFactory; export declare class _Relation extends _SPInstance { get fromTerm(): ITerm; get toTerm(): ITerm; get set(): ITermSet; } export interface IRelation extends _Relation { } export declare const Relation: import("../spqueryable.js").ISPInvokableFactory; export interface ITermStoreInfo { id: string; name: string; defaultLanguageTag: string; languageTags: string[]; administrators?: ITaxonomyUserInfo; } export interface ITermGroupInfo { id: string; description: string; name: string; displayName: string; createdDateTime: string; lastModifiedDateTime: string; type: string; scope: "global" | "system" | "siteCollection"; } export interface ITermSetInfo { id: string; localizedNames: { name: string; languageTag: string; }[]; description: string; createdDateTime: string; customSortOrder: string[]; properties?: ITaxonomyProperty[]; childrenCount: number; groupId: string; isOpen: boolean; isAvailableForTagging: boolean; contact: string; } export interface ITermInfo { childrenCount: number; id: string; labels: { name: string; isDefault: boolean; languageTag: string; }[]; createdDateTime: string; customSortOrder?: ITermSortOrderInfo[]; lastModifiedDateTime: string; descriptions: { description: string; languageTag: string; }[]; properties?: ITaxonomyProperty[]; localProperties?: ITaxonomyLocalProperty[]; isDeprecated: boolean; isAvailableForTagging: { setId: string; isAvailable: boolean; }[]; topicRequested?: boolean; parent?: ITermInfo; set?: ITermSetInfo; relations?: IRelationInfo[]; children?: ITermInfo[]; } export interface ISearchTermParams { /** * The term label to search for. */ label: string; /** * The setId to scope down the search under a termSet. */ setId?: string; /** * The parentTermId to scope down the search under a termSet, under a parent term. */ parentTermId?: string; /** * The languageTag to scope down the search to a specific language. */ languageTag?: string; /** * Indicates what type of string matching should be performed when searching. */ stringMatchOption?: "ExactMatch" | "StartsWith"; } declare type SearchTermPickedProps = "childrenCount" | "createdDateTime" | "descriptions" | "id" | "isAvailableForTagging" | "isDeprecated" | "labels" | "lastModifiedDateTime" | "set"; export interface ITermSortOrderInfo { setId: string; order: string[]; } export interface IOrderedTermInfo extends ITermInfo { children: ITermInfo[]; defaultLabel: string; } export interface IRelationInfo { id: string; relationType: string; } export interface ITaxonomyUserInfo { user: { displayName: string; email: string; id: string; }; } export interface ITaxonomyProperty { key: string; value: string; } export interface ITaxonomyLocalProperty { setId: string; properties: ITaxonomyProperty[]; } export interface IGetOrderedTreeProps { retrieveProperties: boolean; } export {}; //# sourceMappingURL=types.d.ts.map