Interface CommandParams

Command parameters are handed over to a command for execution. It contains all possible combinations of parameters that can be used in a command. We will try to improve how this is documented, but ATM it just has all parameters, even though you may need none, or just a few.

Note: For your specific commands, you can also pass other parameters.

Important for the docs

Most properties are actually not visible (you will get them in the types though). So actually you will usually create one of these:

• CommandParamsEntityById
• CommandParamsEntityInContentBlock
• CommandParamsEntityInList
• CommandAddParams
• CommandAddExistingParams
• CommandDataParams
• CommandCopyParams
• CommandCodeParams
• CommandDeleteParams
• CommandMetadataParams
• CommandNewParams

Because of this, most of the properties below are NOT documented, as their purpose can change depending on the command used.

Package: Api.Js.SxcJs

Properties

call

The purpose of this varies by Command.

Declaration

public call?: string

Property Value

Type	Description
string

contentType

The purpose of this varies by Command.

Declaration

public contentType?: string

Property Value

Type	Description
string

entityGuid

The purpose of this varies by Command.

Declaration

public entityGuid?: string

Property Value

Type	Description
string

entityId

The purpose of this varies by Command.

Declaration

public entityId?: number

Property Value

Type	Description
number

entityTitle

The purpose of this varies by Command.

Declaration

public entityTitle?: string

Property Value

Type	Description
string

fields

The purpose of this varies by Command.

Declaration

public fields?: string

Property Value

Type	Description
string

filters

The purpose of this varies by Command.

Declaration

public filters?: string

Property Value

Type	Description
string

index

The purpose of this varies by Command.

Declaration

public index?: number

Property Value

Type	Description
number

metadata

The purpose of this varies by Command.

Declaration

public metadata?: CommandParamsMetadata

Property Value

Type	Description
CommandParamsMetadata

parent

The purpose of this varies by Command.

Declaration

public parent?: string

Property Value

Type	Description
string

prefill

The purpose of this varies by Command.

Declaration

public prefill?: Record<string, boolean | string | number | Date>

Property Value

Type	Description
Record<string, boolean | string | number | Date>

title

The purpose of this varies by Command.

Declaration

public title?: string

Property Value

Type	Description
string

useModuleList

The purpose of this varies by Command.

Declaration

public useModuleList?: true

Property Value

Type	Description
true