Class PushService

Index

Constructors

Methods

applyCompositionAxes processFlattenedRecord push setStateManager

Constructors

constructor

new PushService(
    syncEngine: SyncEngine,
    contextUser: UserInfo,
    stateManager?: SyncStateManager,
): PushService
Parameters
- syncEngine: SyncEngine
- contextUser: UserInfo
- OptionalstateManager: SyncStateManager
Returns PushService
- Defined in packages/MetadataSync/src/services/PushService.ts:171

Methods

`Protected`applyCompositionAxes

applyCompositionAxes(
    entity: BaseEntity,
    record: RecordData,
    entityName: string,
    entityDir: string,
    batchContext: BatchContext,
    resolutionCollector: SyncResolutionCollector,
    options: PushOptions,
    callbacks?: PushCallbacks,
    entityConfig?: EntityConfig,
    recordProvider?: IMetadataProvider,
    depth?: number,
): Promise<void>
Applies first-class composition axes onto the entity before Save (§5):
1. embeds (peer first via {fkField}_EnsureObject() or companion.Ensure())
2. collections (owner.Collection.Create() or match by PK, apply fields, recursive composition)
3. extension (owner.EnsureISAChild(name?), set leaf fields, recursive composition)
Parameters
- entity: BaseEntity
- record: RecordData
- entityName: string
- entityDir: string
- batchContext: BatchContext
- resolutionCollector: SyncResolutionCollector
- options: PushOptions
- Optionalcallbacks: PushCallbacks
- OptionalentityConfig: EntityConfig
- OptionalrecordProvider: IMetadataProvider
- depth: number = 0
Returns Promise<void>
- Defined in packages/MetadataSync/src/services/PushService.ts:2452

`Protected`processFlattenedRecord

processFlattenedRecord(
    flattenedRecord: FlattenedRecord,
    entityDir: string,
    options: PushOptions,
    batchContext: BatchContext,
    callbacks?: PushCallbacks,
    entityConfig?: EntityConfig,
    allowDefer?: boolean,
    recordProvider?: IMetadataProvider,
): Promise<ProcessRecordResult>
Parameters
- flattenedRecord: FlattenedRecord
- entityDir: string
- options: PushOptions
- batchContext: BatchContext
- Optionalcallbacks: PushCallbacks
- OptionalentityConfig: EntityConfig
- allowDefer: boolean = true
- OptionalrecordProvider: IMetadataProvider
Returns Promise<ProcessRecordResult>
- Defined in packages/MetadataSync/src/services/PushService.ts:962

push

push(options: PushOptions, callbacks?: PushCallbacks): Promise<PushResult>
Parameters
- options: PushOptions
- Optionalcallbacks: PushCallbacks
Returns Promise<PushResult>
- Defined in packages/MetadataSync/src/services/PushService.ts:259

setStateManager

setStateManager(stateManager: SyncStateManager): void
Set or replace the state manager after construction.
Parameters
- stateManager: SyncStateManager
Returns void
- Defined in packages/MetadataSync/src/services/PushService.ts:183