Class Attachment

This class is a wrapper container for a PConnect object.

When constructed will store a copy of the fully resolved component props (see getComponentProps). The container holds a reference to all instantiated children.

A few life cycle hooks are initiated

  • initContainer is called immediately after construction
  • updateContainer is called anytime the state associated with the pconnect is changed
  • destroyContainer is called on all children whenever

Hierarchy (view full)

Constructors

constructor

Properties

componentName config files id pconnect unsubscribe updates counter

Accessors

children

Methods

createChild downloadFile getId initialize isContainerInitialized isVisible onDestroy onInit onUpdate register removeFile shouldUpdate triggerFieldChange unregister updateChildren updateFieldValue uploadFile getComponentProps getRoutingInfo

Constructors

constructor

  • new Attachment(pconnect, id): Attachment

  • The constructor for PContainer.

    Parameters

    • pconnect: PConnect

      The PConnect object which is the configuration for this container

    • id: string

      The ID of the container, used as a key to retrieve the container later.

    Returns Attachment

Properties

componentName

componentName: string

The name of this container as retrieved by container.getComponentName()

config

config: AttachmentProps

The configuration of this container.

files

files: FileStatus[]

id

id: string

The ID of the container, used as a key to retrieve the container later.

pconnect

pconnect: PConnect

The PConnect object which is the configuration for this container

unsubscribe

unsubscribe: (() => void)

A method to unsubscribe this container from listening to state changes

updates

updates: EventObserver = ...

A stream of state update events.

In general updates are managed by the DX Engine. However, in some cases you may need to react to state changes in the component directly. In this scenario a consumer can call container.updates.subscribe(fn), where the fn will be called when the state of the container changes. Use container.config to retrieve the latest state of the container.

Staticcounter

counter: number = 0

Accessors

children

  • get children(): PContainer<any>[]

  • Get the children of this container. This list of children is managed by the DX Engine, where each child itself is the correct PContainer instance for a PConnect object coming from the Constellation Core.

    Returns PContainer<any>[]

  • set children(children): void

  • Fully replace the children of this container.

    To allow for cleanupm, the onDestroy method of the existing children are called before they are replaced.

    Parameters

    Returns void

Methods

createChild

  • createChild(type, label): Promise<PContainer<any>>

  • Create a new child PContainer of the given type, with the given label.

    The child will be created with the same context and container name as the current PContainer. The label will be used to construct a new property name, and the value will be set to @P .<label>.

    Parameters

    • type: string

      The type of the child to be created.

    • label: string

      The label of the child to be created.

    Returns Promise<PContainer<any>>

    The newly created PContainer.

downloadFile

  • downloadFile(fileId): Promise<string>

  • Downloads a file from the list of files.

    Parameters

    • fileId: string

      the ID of the file to be removed

    Returns Promise<string>

    the data as a base64 encoded string

getId

initialize

  • initialize(): void

  • Initializes the container by setting up its configuration and component name, and generating a unique identifier. It subscribes to the store for state changes to determine when updates are necessary.

    Returns void

isContainerInitialized

isVisible

onDestroy

  • onDestroy(): void

  • Clean up all resources when the container is destroyed. This is called when the container is no longer referenced by the core.

    Returns void

onInit

  • onInit(): Promise<void>

  • Abstract initialization method to be implemented by instances of container types. onInit is called after default initialization of the PContainer is completed

    Returns Promise<void>

onUpdate

  • onUpdate(): Promise<void>

  • Abstract update method to be implemented by instances of container types. onUpdate is called everytime the state association with this container instance is updated by the Constellation Core.

    Returns Promise<void>

register

removeFile

  • removeFile(fileId): Promise<void>

  • Removes a file from the list of files to be uploaded. If the file has already been uploaded to Pega, the file is marked for deletion. If the file has not been uploaded to Pega, the file is removed from the list of files to be uploaded.

    Parameters

    • fileId: string

      the ID of the file to be removed

    Returns Promise<void>

shouldUpdate

triggerFieldChange

unregister

updateChildren

updateFieldValue

uploadFile

  • uploadFile(event): Promise<void>

  • Handles file upload event using the getAttachmentUtils() API from PCore. The status for each file is tracked in the files attribute of this container. For each file that is succesfully uploaded the uploaded flag is set to true. The state of the upload status is updated accordingly using getStateUtils() such that finising the assignment attaches the correct information in the request to Pega.

    Parameters

    • event: Event

      a file input change event or a drag event

    Returns Promise<void>

StaticgetComponentProps

StaticgetRoutingInfo

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods