W-CF Documentation - v11.0.0
    Preparing search index...

    Class ProjectInfo

    Index
    eventAddressDataChanged: ListenableEvent<AddressType, ProjectInfo> = ...
    eventAppDataChanged: ListenableEvent<void, ProjectInfo> = ...
    eventContactDataChanged: ListenableEvent<void, ProjectInfo> = ...
    eventDefaultPriceDateChanged: ListenableEvent<void, ProjectInfo> = ...
    eventEffectiveProjectLanguagesChanged: ListenableEvent<void, ProjectInfo> = ...
    eventProjectDataChanged: ListenableEvent<void, ProjectInfo> = ...
    eventSettingsChanged: ListenableEvent<void, ProjectInfo> = ...
    textFormat: TextFormat

    Text format used for getProjectData()

    "JSON"
    
    • This function can be used to change parts of an address or add a new one. Properties which are undefined will be ignored and not modified. Only properties which should be changed should have a value to reduce server load. See EAIWS API documentation for further information.

      Parameters

      Returns Promise<void>

    • This function can be used to change parts of an contact or add a new one. Properties which are undefined will be ignored and not modified. Only properties which should be changed should have a value to reduce server load. See EAIWS API documentation for further information.

      Parameters

      Returns Promise<void>

    • This function can be used to change parts of the project data. Properties which are undefined will be ignored and not modified. Only properties which should be changed should have a value to reduce server load. See EAIWS API documentation for further information.

      Parameters

      Returns Promise<void>

    • Obsolete, should only be used for backwards compatibility. This function can be used to change parts of the project settings. Properties which are undefined will be ignored and not modified. Only properties which should be changed should have a value to reduce server load. See EAIWS API documentation for further information.

      Parameters

      Returns Promise<void>

    • Resets this instance and clears internal caches.

      Returns void

    • Can be used to fetch multiple address data at the same time from the server. Afterwards getAddressData() can be used to retrieve the cached address.

      Parameters

      Returns Promise<void>

    • Retrieves the address data with the given type. Null will be returned if the address does not exist.

      Parameters

      Returns Promise<AddressData | null>

    • Parameters

      • pAppKey: string
      • pDataPaths: string[]

      Returns Promise<Map<string, string | null>>

    • Retrieves the current default price date of the project.

      Returns Promise<string | undefined>

    • Returns the currently effective project languages taking into account the different fallbacks.

      Returns Promise<string[]>

    • Returns the project data of the current session. Note: Project texts is returned in JSON format.

      Returns Promise<ProjectData>

    • Can be used to trigger an update of the cached project data. Calling this function is only necessary if the project data was modified without using the provided functions of this class.

      Returns void

    • Removes/deletes one or more addresses.

      Parameters

      Returns Promise<void>

    • Removes/deletes one or more contacts.

      Parameters

      • pContactDataIds: number[]

      Returns Promise<void>

    • Parameters

      • pAppKey: string
      • pData: Map<string, string | null>

      Returns Promise<void>

    • Changes the default price date of the project.

      Parameters

      • pDate: string

      Returns Promise<void>