Function registerProjectDataProviderEngineFactory

registerProjectDataProviderEngineFactory<
    SupportedProjectInterfaces extends
        (keyof ProjectDataProviderInterfaces)[],
>(
    pdpFactoryId: string,
    projectInterfaces: SupportedProjectInterfaces,
    pdpEngineFactory: IProjectDataProviderEngineFactory<
        SupportedProjectInterfaces,
    >,
    attributes?: { [property: string]: unknown },
    documentation?: NetworkObjectDocumentation,
): Promise<Dispose>
Add a new Project Data Provider Factory to PAPI that uses the given engine.
Type Parameters
- SupportedProjectInterfaces extends (keyof ProjectDataProviderInterfaces)[]
Parameters
- pdpFactoryId: string
  Unique id for this PDP factory.
- projectInterfaces: SupportedProjectInterfaces
  The standardized sets of methods (projectInterfaces) supported by the Project Data Provider Engines produced by this factory. Indicates what sort of project data should be available on the PDPEs created by this factory.
- pdpEngineFactory: IProjectDataProviderEngineFactory<SupportedProjectInterfaces>
  Used in a ProjectDataProviderFactory to create ProjectDataProviders.
- Optionalattributes: { [property: string]: unknown }
  Optional registration-level attributes. The platform overwrites the projectInterfaces field — that field is always the platform-canonical value.
- Optionaldocumentation: NetworkObjectDocumentation
  Optional NetworkObjectDocumentation for the factory itself. Set documentation['x-experimental']: true to mark all methods on this factory as experimental.
Returns Promise<Dispose>
Promise that resolves to a disposable object when the registration operation completes.
- Defined in lib/papi-dts/papi.d.ts:6378

Function registerProjectDataProviderEngineFactory

Type Parameters

Parameters

Returns Promise<Dispose>

Settings