Class ViewerScopedEntityCompanion<TFields, TIDField, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>

constructor

• new ViewerScopedEntityCompanion<
      TFields extends Record<string, any>,
      TIDField extends string | number | symbol,
      TViewerContext extends ViewerContext,
      TEntity extends
          ReadonlyEntity<TFields, TIDField, TViewerContext, TSelectedFields>,
      TPrivacyPolicy extends
          EntityPrivacyPolicy<
              TFields,
              TIDField,
              TViewerContext,
              TEntity,
              TSelectedFields,
          >,
      TSelectedFields extends string
      | number
      | symbol,
  >(
      entityCompanion: EntityCompanion<
          TFields,
          TIDField,
          TViewerContext,
          TEntity,
          TPrivacyPolicy,
          TSelectedFields,
      >,
      viewerContext: TViewerContext,
  ): ViewerScopedEntityCompanion<
      TFields,
      TIDField,
      TViewerContext,
      TEntity,
      TPrivacyPolicy,
      TSelectedFields,
  >

  Type Parameters

  • TFields extends Record<string, any>
  • TIDField extends string | number | symbol
  • TViewerContext extends ViewerContext
  • TEntity extends ReadonlyEntity<TFields, TIDField, TViewerContext, TSelectedFields>
  • TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TIDField, TViewerContext, TEntity, TSelectedFields>
  • TSelectedFields extends string | number | symbol

  Parameters

  • entityCompanion: EntityCompanion<
        TFields,
        TIDField,
        TViewerContext,
        TEntity,
        TPrivacyPolicy,
        TSelectedFields,
    >
  • viewerContext: TViewerContext

  Returns ViewerScopedEntityCompanion<
      TFields,
      TIDField,
      TViewerContext,
      TEntity,
      TPrivacyPolicy,
      TSelectedFields,
  >

ReadonlyentityCompanion

getLoaderFactory

• getLoaderFactory(): ViewerScopedEntityLoaderFactory<
      TFields,
      TIDField,
      TViewerContext,
      TEntity,
      TPrivacyPolicy,
      TSelectedFields,
  >

  Vend a viewer-scoped entity loader.

  Returns ViewerScopedEntityLoaderFactory<
      TFields,
      TIDField,
      TViewerContext,
      TEntity,
      TPrivacyPolicy,
      TSelectedFields,
  >

getMetricsAdapter

• getMetricsAdapter(): IEntityMetricsAdapter

  Get the IEntityMetricsAdapter for this companion.

  Returns IEntityMetricsAdapter

getMutatorFactory

• getMutatorFactory(): ViewerScopedEntityMutatorFactory<
      TFields,
      TIDField,
      TViewerContext,
      TEntity,
      TPrivacyPolicy,
      TSelectedFields,
  >

  Vend a viewer-scoped entity mutator factory.

  Returns ViewerScopedEntityMutatorFactory<
      TFields,
      TIDField,
      TViewerContext,
      TEntity,
      TPrivacyPolicy,
      TSelectedFields,
  >

getQueryContextProvider

• getQueryContextProvider(): EntityQueryContextProvider

  Get the query context provider for this entity.

  Returns EntityQueryContextProvider