Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ServiceObjectSchema

Represents the base class for all item and folder schemas. Represents the base class for all item and folder schemas.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • internal

    Initializes a new instance of the ServiceObjectSchema class.

    Returns ServiceObjectSchema

Properties

Private firstClassProperties

firstClassProperties: PropertyDefinition[]

Private firstClassSummaryProperties

firstClassSummaryProperties: PropertyDefinition[]

Private indexedProperties

indexedProperties: IndexedPropertyDefinition[]

Private properties

properties: Dictionary<string, PropertyDefinition>

Private visibleProperties

visibleProperties: PropertyDefinition[]

Static ExtendedProperties

ExtendedProperties: PropertyDefinition

Defines the ExtendedProperties property. Defines the ExtendedProperties property.

Static Private allSchemaProperties

allSchemaProperties: PropertyDefinitionDictionary

Accessors

FirstClassProperties

  • internal

    Gets the list of first class properties for this service object type.

    Returns PropertyDefinition[]

FirstClassSummaryProperties

  • internal

    Gets the list of first class summary properties for this service object type.

    Returns PropertyDefinition[]

IndexedProperties

  • internal

    Gets the list of indexed properties for this service object type.

    Returns IndexedPropertyDefinition[]

Methods

GetEnumerator

  • Returns PropertyDefinition[]

RegisterIndexedProperty

  • internal

    Registers an indexed property.

    Parameters

    Returns void

RegisterInternalProperty

  • RegisterInternalProperty(registeringSchemaClass: any, property: PropertyDefinition): void
  • internal

    Registers an internal schema property.

    Parameters

    • registeringSchemaClass: any

      SchemaClass calling this method - workaround for fieldUri registration oterhwise it registers super/parent class static properties as well. TypeScript does not provide a way to detect inherited property, hasOwnProperty returns true for parent static property

    • property: PropertyDefinition

      The property to register.

    Returns void

RegisterProperties

  • RegisterProperties(): void
  • internal

    Registers properties.

    remarks

    IMPORTANT NOTE: PROPERTIES MUST BE REGISTERED IN SCHEMA ORDER (i.e. the same order as they are defined in types.xsd)

    Returns void

Private RegisterProperty

  • RegisterProperty(registeringSchemaClass: any, property: PropertyDefinition): void
  • RegisterProperty(registeringSchemaClass: any, property: PropertyDefinition, isInternal: boolean): void
  • internal

    Registers a schema property. - workaround for fieldUri registration oterhwise it registers super/parent class static properties as well. TypeScript does not provide a way to detect inherited property, hasOwnProperty returns true

    Parameters

    • registeringSchemaClass: any

      SchemaClass calling this method - workaround for fieldUri registration oterhwise it registers super/parent class static properties as well. TypeScript does not provide a way to detect inherited property, hasOwnProperty returns true for parent static property

    • property: PropertyDefinition

      The property to register.

    Returns void

  • Parameters

    • registeringSchemaClass: any

      SchemaClass calling this method - workaround for fieldUri registration oterhwise it registers super/parent class static properties as well. TypeScript does not provide a way to detect inherited property, hasOwnProperty returns true for parent static property

    • property: PropertyDefinition

      The property to register.

    • isInternal: boolean

      Indicates whether the property is internal or should be visible to developers.

    Returns void

TryGetPropertyDefinition

  • internal

    Tries to get property definition.

    Parameters

    Returns boolean

    True if property definition exists.

Protected init

  • init(): void

  • Returns void

Static FindPropertyDefinition

  • internal

    Finds the property definition.

    Parameters

    • uri: string

      The URI.

    Returns PropertyDefinitionBase

    Property definition.

  • internal

    Finds the property definition.

    Parameters

    • uri: string

      The URI.

    Returns PropertyDefinitionBase

    Property definition.

Generated using TypeDoc