Docs for m2-core, m2-components
  1. Classes
  2. EntityChangesMessage

File

projects/m2-core/src/lib/model/callback/internal/EntityChangesMessage.ts

Extends

CallbackMessage

Implements

IEntityChanges

Index

Properties
Methods

Constructor

constructor(entityType: ModelEntityType | string, createdEntities?: T[], editedEntities?: T[], deletedEntityIds?: ID[], newActiveEntity?: T, parentEntityId?: ID, parentType?: ModelEntityType | string)
Parameters :
Name Type Optional
entityType ModelEntityType | string No
createdEntities T[] Yes
editedEntities T[] Yes
deletedEntityIds ID[] Yes
newActiveEntity T Yes
parentEntityId ID Yes
parentType ModelEntityType | string Yes

Properties

Public Optional createdEntities
Type : T[]
Public Optional deletedEntities
Type : T[]
Public Optional deletedEntityIds
Type : ID[]
Public Optional editedEntities
Type : T[]
Public entityType
Type : ModelEntityType | string
Public Optional newActiveEntity
Type : T
Public Optional parentEntityId
Type : ID
Public Optional parentType
Type : ModelEntityType | string
Public type
Type : CallbackMessageType
Default value : 'EntityChangesMessage'
Public origin
Default value : -1

Methods

Static build
build(entityType: ModelEntityType | string, changes: IEntityChanges<T | ID>, parentEntityId?: ID, parentType?: ModelEntityType | string)
Type parameters :
  • T
  • ID
Parameters :
Name Type Optional
entityType ModelEntityType | string No
changes IEntityChanges<T | ID> No
parentEntityId ID Yes
parentType ModelEntityType | string Yes
Returns : EntityChangesMessage<T, ID>
Static getMsgType
getMsgType(msg: CallbackMessage)
Parameters :
Name Type Optional
msg CallbackMessage No
Returns : CallbackMessageType
Static isServerSideMsg
isServerSideMsg(msg: CallbackMessage)
Parameters :
Name Type Optional
msg CallbackMessage No
Returns : boolean

results matching ""

    No results matching ""