Table of Contents

Variable: createTopic

const createTopic: (attributes: {
  Guid: string;
  ServerAssignedId?: string;
  TopicStatus: string;
  TopicType: string;
} & {
[qualifiedName: `${string}:${string}`]: string | undefined;
}, content: 
  | Topic_Element$Children
  | (
  | string
  | {
  kind: "comment";
  value: string;
}
  | {
  kind: "instruction";
  target: string;
  value: string;
}
  | ReferenceLinks
  | Title
  | Priority
  | Index
  | Labels
  | CreationDate
  | CreationAuthor
  | ModifiedDate
  | ModifiedAuthor
  | DueDate
  | AssignedTo
  | Stage
  | Description
  | BimSnippet_Element
  | DocumentReferences
  | RelatedTopics
  | Comments
  | Viewpoints)[]) => Topic_Element & {
  all: (parent?: {
     attributes: Record<string, string | undefined> & {
      [qualifiedName: `${string}:${string}`]: string | undefined;
     };
     content: (
        | string
        | {
        kind: "comment";
        value: string;
      }
        | {
        kind: "instruction";
        target: string;
        value: string;
      }
        | {
        attributes: Record<string, ... | ...> & {
         [qualifiedName: `${(...)}:${(...)}`]: ... | ...;
        };
        content: (string | XmlComment | XmlInstruction | GenericElement)[];
        name: string;
        namespaces?: Record<string, string>;
        namespaceURI: string;
        prefix?: string;
     })[];
     name: string;
     namespaces?: Record<string, string>;
     namespaceURI: string;
     prefix?: string;
  }) => Topic_Element[];
  descendants: (parent?: {
     attributes: Record<string, string | undefined> & {
      [qualifiedName: `${string}:${string}`]: string | undefined;
     };
     content: (
        | string
        | {
        kind: "comment";
        value: string;
      }
        | {
        kind: "instruction";
        target: string;
        value: string;
      }
        | {
        attributes: Record<string, ... | ...> & {
         [qualifiedName: `${(...)}:${(...)}`]: ... | ...;
        };
        content: (string | XmlComment | XmlInstruction | GenericElement)[];
        name: string;
        namespaces?: Record<string, string>;
        namespaceURI: string;
        prefix?: string;
     })[];
     name: string;
     namespaces?: Record<string, string>;
     namespaceURI: string;
     prefix?: string;
  }) => Topic_Element[];
  elementName: string;
  from: (parent?: {
     attributes: Record<string, string | undefined> & {
      [qualifiedName: `${string}:${string}`]: string | undefined;
     };
     content: (
        | string
        | {
        kind: "comment";
        value: string;
      }
        | {
        kind: "instruction";
        target: string;
        value: string;
      }
        | {
        attributes: Record<string, ... | ...> & {
         [qualifiedName: `${(...)}:${(...)}`]: ... | ...;
        };
        content: (string | XmlComment | XmlInstruction | GenericElement)[];
        name: string;
        namespaces?: Record<string, string>;
        namespaceURI: string;
        prefix?: string;
     })[];
     name: string;
     namespaces?: Record<string, string>;
     namespaceURI: string;
     prefix?: string;
   }) => 
     | Topic_Element
    | undefined;
  is: (element?: {
     attributes: Record<string, string | undefined> & {
      [qualifiedName: `${string}:${string}`]: string | undefined;
     };
     content: (
        | string
        | {
        kind: "comment";
        value: string;
      }
        | {
        kind: "instruction";
        target: string;
        value: string;
      }
        | {
        attributes: Record<string, ... | ...> & {
         [qualifiedName: `${(...)}:${(...)}`]: ... | ...;
        };
        content: (string | XmlComment | XmlInstruction | GenericElement)[];
        name: string;
        namespaces?: Record<string, string>;
        namespaceURI: string;
        prefix?: string;
     })[];
     name: string;
     namespaces?: Record<string, string>;
     namespaceURI: string;
     prefix?: string;
  }) => element is Topic_Element;
  namespaceURI: string;
} & {
  defaults: Partial<{
     Guid: string;
     ServerAssignedId?: string;
     TopicStatus: string;
     TopicType: string;
   } & {
   [qualifiedName: `${string}:${string}`]: string | undefined;
  }>;
  read(element?: {
     attributes: Record<string, string | undefined> & {
      [qualifiedName: `${string}:${string}`]: string | undefined;
     };
     content: (
        | string
        | {
        kind: "comment";
        value: string;
      }
        | {
        kind: "instruction";
        target: string;
        value: string;
      }
        | {
        attributes: Record<string, string | undefined> & {
         [qualifiedName: `${string}:${string}`]: string | undefined;
        };
        content: (string | XmlComment | XmlInstruction | GenericElement)[];
        name: string;
        namespaces?: Record<string, string>;
        namespaceURI: string;
        prefix?: string;
     })[];
     name: string;
     namespaces?: Record<string, string>;
     namespaceURI: string;
     prefix?: string;
   }): 
     | {
     attributes: {
        Guid: string;
        ServerAssignedId?: string;
        TopicStatus: string;
        TopicType: string;
      } & {
      [qualifiedName: `${string}:${string}`]: string | undefined;
     };
     children: {
        AssignedTo: AssignedTo;
        BimSnippet: BimSnippet_Element;
        Comments: Comments;
        CreationAuthor:   | CreationAuthor
           | undefined;
        CreationDate:   | CreationDate
           | undefined;
        Description: Description;
        DocumentReferences: DocumentReferences;
        DueDate: DueDate;
        Index: Index;
        Labels: Labels;
        ModifiedAuthor: ModifiedAuthor;
        ModifiedDate: ModifiedDate;
        Priority: Priority;
        ReferenceLinks: ReferenceLinks;
        RelatedTopics: RelatedTopics;
        Stage: Stage;
        Title: Title | undefined;
        Viewpoints: Viewpoints;
     };
   }
    | undefined;
  update(element: Topic_Element, attributes: Partial<E["attributes"]>, changes: Partial<F>): Topic_Element;
};

Create/read the XML Topic element. Named children follow XSD order and occurrence constraints.

Type Declaration

all

all: (parent?: {
  attributes: Record<string, string | undefined> & {
   [qualifiedName: `${string}:${string}`]: string | undefined;
  };
  content: (
     | string
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
   }
     | {
     attributes: Record<string, ... | ...> & {
      [qualifiedName: `${(...)}:${(...)}`]: ... | ...;
     };
     content: (string | XmlComment | XmlInstruction | GenericElement)[];
     name: string;
     namespaces?: Record<string, string>;
     namespaceURI: string;
     prefix?: string;
  })[];
  name: string;
  namespaces?: Record<string, string>;
  namespaceURI: string;
  prefix?: string;
}) => Topic_Element[];

Parameters

parent?
attributes

Record<string, string | undefined> & { [qualifiedName: `${string}:${string}`]: string | undefined; }

content

( | string | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; } | { attributes: Record<string, ... | ...> & { [qualifiedName: `${(...)}:${(...)}`]: ... | ...; }; content: (string | XmlComment | XmlInstruction | GenericElement)[]; name: string; namespaces?: Record<string, string>; namespaceURI: string; prefix?: string; })[]

name

string

namespaces?

Record<string, string>

namespaceURI

string

prefix?

string

Returns

Topic_Element[]

descendants

descendants: (parent?: {
  attributes: Record<string, string | undefined> & {
   [qualifiedName: `${string}:${string}`]: string | undefined;
  };
  content: (
     | string
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
   }
     | {
     attributes: Record<string, ... | ...> & {
      [qualifiedName: `${(...)}:${(...)}`]: ... | ...;
     };
     content: (string | XmlComment | XmlInstruction | GenericElement)[];
     name: string;
     namespaces?: Record<string, string>;
     namespaceURI: string;
     prefix?: string;
  })[];
  name: string;
  namespaces?: Record<string, string>;
  namespaceURI: string;
  prefix?: string;
}) => Topic_Element[];

Parameters

parent?
attributes

Record<string, string | undefined> & { [qualifiedName: `${string}:${string}`]: string | undefined; }

content

( | string | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; } | { attributes: Record<string, ... | ...> & { [qualifiedName: `${(...)}:${(...)}`]: ... | ...; }; content: (string | XmlComment | XmlInstruction | GenericElement)[]; name: string; namespaces?: Record<string, string>; namespaceURI: string; prefix?: string; })[]

name

string

namespaces?

Record<string, string>

namespaceURI

string

prefix?

string

Returns

Topic_Element[]

elementName

elementName: string = definition.name;

from

from: (parent?: {
  attributes: Record<string, string | undefined> & {
   [qualifiedName: `${string}:${string}`]: string | undefined;
  };
  content: (
     | string
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
   }
     | {
     attributes: Record<string, ... | ...> & {
      [qualifiedName: `${(...)}:${(...)}`]: ... | ...;
     };
     content: (string | XmlComment | XmlInstruction | GenericElement)[];
     name: string;
     namespaces?: Record<string, string>;
     namespaceURI: string;
     prefix?: string;
  })[];
  name: string;
  namespaces?: Record<string, string>;
  namespaceURI: string;
  prefix?: string;
}) => 
  | Topic_Element
  | undefined;

Parameters

parent?
attributes

Record<string, string | undefined> & { [qualifiedName: `${string}:${string}`]: string | undefined; }

content

( | string | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; } | { attributes: Record<string, ... | ...> & { [qualifiedName: `${(...)}:${(...)}`]: ... | ...; }; content: (string | XmlComment | XmlInstruction | GenericElement)[]; name: string; namespaces?: Record<string, string>; namespaceURI: string; prefix?: string; })[]

name

string

namespaces?

Record<string, string>

namespaceURI

string

prefix?

string

Returns

| Topic_Element | undefined

is

is: (element?: {
  attributes: Record<string, string | undefined> & {
   [qualifiedName: `${string}:${string}`]: string | undefined;
  };
  content: (
     | string
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
   }
     | {
     attributes: Record<string, ... | ...> & {
      [qualifiedName: `${(...)}:${(...)}`]: ... | ...;
     };
     content: (string | XmlComment | XmlInstruction | GenericElement)[];
     name: string;
     namespaces?: Record<string, string>;
     namespaceURI: string;
     prefix?: string;
  })[];
  name: string;
  namespaces?: Record<string, string>;
  namespaceURI: string;
  prefix?: string;
}) => element is Topic_Element;

Parameters

element?
attributes

Record<string, string | undefined> & { [qualifiedName: `${string}:${string}`]: string | undefined; }

content

( | string | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; } | { attributes: Record<string, ... | ...> & { [qualifiedName: `${(...)}:${(...)}`]: ... | ...; }; content: (string | XmlComment | XmlInstruction | GenericElement)[]; name: string; namespaces?: Record<string, string>; namespaceURI: string; prefix?: string; })[]

name

string

namespaces?

Record<string, string>

namespaceURI

string

prefix?

string

Returns

element is Topic_Element

namespaceURI

namespaceURI: string = definition.namespaceURI;

defaults

defaults: Partial<{
  Guid: string;
  ServerAssignedId?: string;
  TopicStatus: string;
  TopicType: string;
} & {
[qualifiedName: `${string}:${string}`]: string | undefined;
}>;

read()

read(element?: {
  attributes: Record<string, string | undefined> & {
   [qualifiedName: `${string}:${string}`]: string | undefined;
  };
  content: (
     | string
     | {
     kind: "comment";
     value: string;
   }
     | {
     kind: "instruction";
     target: string;
     value: string;
   }
     | {
     attributes: Record<string, string | undefined> & {
      [qualifiedName: `${string}:${string}`]: string | undefined;
     };
     content: (string | XmlComment | XmlInstruction | GenericElement)[];
     name: string;
     namespaces?: Record<string, string>;
     namespaceURI: string;
     prefix?: string;
  })[];
  name: string;
  namespaces?: Record<string, string>;
  namespaceURI: string;
  prefix?: string;
}): 
  | {
  attributes: {
     Guid: string;
     ServerAssignedId?: string;
     TopicStatus: string;
     TopicType: string;
   } & {
   [qualifiedName: `${string}:${string}`]: string | undefined;
  };
  children: {
     AssignedTo: AssignedTo;
     BimSnippet: BimSnippet_Element;
     Comments: Comments;
     CreationAuthor:   | CreationAuthor
        | undefined;
     CreationDate:   | CreationDate
        | undefined;
     Description: Description;
     DocumentReferences: DocumentReferences;
     DueDate: DueDate;
     Index: Index;
     Labels: Labels;
     ModifiedAuthor: ModifiedAuthor;
     ModifiedDate: ModifiedDate;
     Priority: Priority;
     ReferenceLinks: ReferenceLinks;
     RelatedTopics: RelatedTopics;
     Stage: Stage;
     Title: Title | undefined;
     Viewpoints: Viewpoints;
  };
}
  | undefined;

Parameters

element?
attributes

Record<string, string | undefined> & { [qualifiedName: `${string}:${string}`]: string | undefined; }

content

( | string | { kind: "comment"; value: string; } | { kind: "instruction"; target: string; value: string; } | { attributes: Record<string, string | undefined> & { [qualifiedName: `${string}:${string}`]: string | undefined; }; content: (string | XmlComment | XmlInstruction | GenericElement)[]; name: string; namespaces?: Record<string, string>; namespaceURI: string; prefix?: string; })[]

name

string

namespaces?

Record<string, string>

namespaceURI

string

prefix?

string

Returns

| { attributes: { Guid: string; ServerAssignedId?: string; TopicStatus: string; TopicType: string; } & { [qualifiedName: `${string}:${string}`]: string | undefined; }; children: { AssignedTo: AssignedTo; BimSnippet: BimSnippet_Element; Comments: Comments; CreationAuthor: | CreationAuthor | undefined; CreationDate: | CreationDate | undefined; Description: Description; DocumentReferences: DocumentReferences; DueDate: DueDate; Index: Index; Labels: Labels; ModifiedAuthor: ModifiedAuthor; ModifiedDate: ModifiedDate; Priority: Priority; ReferenceLinks: ReferenceLinks; RelatedTopics: RelatedTopics; Stage: Stage; Title: Title | undefined; Viewpoints: Viewpoints; }; } | undefined

update()

update(
   element: Topic_Element, 
   attributes: Partial<E["attributes"]>, 
   changes: Partial<F>
): Topic_Element;

Parameters

element

Topic_Element

attributes

Partial<E["attributes"]>

changes

Partial<F>

Returns

Topic_Element

Last updated on 2026-10-17
Raise issue