Package Api.Js.SxcJs Namespace Api.Js.SxcJs

Classes

ContextIdentifier

ContextIdentifier is used to initialize a Sxc object outside of the default context.

Log

A log object which will collect log entries for another ojbect

QuickEditConfig

Quick Edit Configuration which has an enable and specific button configurations

QuickEditConfigRoot

Quick Edit - Full configuration at root, with enable and rules for modules and innerBlocks

Sxc

The typical sxc-instance object for a specific DNN module or content-block

SxcCms

This is in charge of sxc.cms on the instance level. ATM it just has the run command. In future, it may also have dedicated command like layout etc.

SxcData

Data Service for an App / Sxc-Instance to get/create data of a specific Content-Type

SxcDataServiceBase

Base class doing common checks. This is internal and not important, but we can't keep it out of the docs.

SxcGlobalCms

Global Content-Management System on the $2sxc.cms. It is only available if the page is in edit mode / the page feature 2sxc.JsCms has been activated.

SxcGlobalEnvironment

Provides environment information to $2sxc - usually page-id, api-root and stuff like that

SxcGlobalHttp

Global HTTP Service for information and helpers on $2sxc.http

SxcPart

Base class for anything attached to an sxc-instance. This is internal and not important, but we can't keep it out of the docs.

SxcWebApi

helper API to run ajax / REST calls to the server it will ensure that the headers etc. are set correctly and that urls are rewritten

A workflow manager of a Toolbar which will run stuff before / after commands. When toolbars are created, they will add a Manager and then raise an event for in-page code to add workflow steps. Normally the toolbar with raise a toolbar-init event where you can then add steps.

UrlParams

Helper object to read url params. Available on $2sxc.urlParams

WorkflowStepCodeArguments

Arguments for WorkflowStepCode. Will be passed to your code and should also be returned by your code. This also allows cancelling further execution.

Interfaces

CommandAddExistingParams

Parameters used for the command add-existing.
The contentType name determines what items will be shown in the dialog. Depending on your use case, you will need to use the CommandParamsEntityInList or CommandParamsEntityInContentBlock parameters as well.
⤴️ back to All Command Names

CommandAddParams

Parameters used for the command add.
The contentType determines what items will be created, the index where. Depending on your use case, you will need to use the CommandParamsEntityInList or CommandParamsEntityInContentBlock parameters as well.
⤴️ back to All Command Names

CommandCodeParams

Parameters used for the command code on toolbars (new in v14.4).
⤴️ back to All Command Names

CommandContentTypeParams

Parameters used for the command contenttype.
The content-type name determines what items will be loaded to manage the fields.
⤴️ back to All Command Names

CommandCopyParams

Parameters used for the command copy. Will copy the entity on entityId.
⤴️ back to All Command Names

CommandDataParams

Parameters used for the command data.
The content-type name determines what items will be managed.
⤴️ back to All Command Names

CommandDeleteParams

Parameters used for the command delete.
⤴️ back to All Command Names

CommandMetadataParams

Parameters used for the command metadata.
Will do either one of these:

if it has an entityId, will just open edit for that Entity
if it has no entityId, will open new for the current contentType and assign to the target specified by metadata:
⤴️ back to All Command Names

CommandNewParams

Parameters used for the command new
The ContentType name determines what kind of item will be created.
Can also contain prefill to add values to the new item.
Can also contain list-information, in which case it's added to that list. Depending on your use case, you will need to use the CommandParamsEntityInList or CommandParamsEntityInContentBlock parameters as well.
⤴️ back to All Command Names

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:

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

Table of Contents

Package Api.Js.SxcJs Namespace Api.Js.SxcJs

Classes

Interfaces

Enums