Home Manual Reference Source Test
import Atviseproject from 'atscm/src/lib/config/Atviseproject.ts'
public class | source

Atviseproject

An atscm project's configuration.

Test:

Static Member Summary

Static Public Members
public static get

AtscmRelatedNodes: NodesConfiguration

Server nodes atscm manages itself.

public static get

EditorRelatedNodes: NodesConfiguration

An array of editor related node ids.

public static get

ServerRelatedNodes: NodesConfiguration

An array of server related node ids.

public static get

The atvise-server's host. Defaults to localhost.

public static get

ignoreNodes: NodesConfiguration

These nodes (and their subnodes, if any) will be ignored by atscm.

public static get

The login to use.

public static get

nodes: NodesConfiguration

The atvise-server nodes that atscm should sync.

public static get

nodesToWatch: NodesConfiguration

The atvise-server nodes to watch in the corresponding tasks.

public static get

port: AtserverPortConfiguration

The atvise-server ports to use.

public static get

If atvise builder sort order nodes should be stored.

public static get

Remove atv:refpx and atv:refpy attributes from XML to minimize diffs between pulls.

public static get

Sort XML attributes to minimize diffs between pulls.

public static get

The connection timeout, in milliseconds.

public static get

The transformers to use in this project.

public static get

The version control system to optimize tasks for.

public static get

xmlTransformerOptions: {"sortXMLAttributes": *, "removeBuilderRefs": *}

Static Method Summary

Static Public Methods
public static

inspect(): {"host": *, "port": *, "login": *, "useTransformers": *, "nodes": *, "nodesToWatch": *, "ignoreNodes": *}

Returns an object containing the properties to inspect.

Static Public Members

public static get AtscmRelatedNodes: NodesConfiguration source

Server nodes atscm manages itself. These include the serverscripts used during pull/push for example.

public static get EditorRelatedNodes: NodesConfiguration source

An array of editor related node ids. They should be ignored in a atscm project.

Test:

public static get ServerRelatedNodes: NodesConfiguration source

An array of server related node ids. They should be ignored in a atscm project as they are read-only.

Test:

public static get host: string source

The atvise-server's host. Defaults to localhost.

public static get ignoreNodes: NodesConfiguration source

These nodes (and their subnodes, if any) will be ignored by atscm. Defaults to Atviseproject.EditorRelatedNodes combined with Atviseproject.ServerRelatedNodes.

public static get login: undefined source

The login to use. Return false if no login is required (default).

Test:

public static get nodes: NodesConfiguration source

The atvise-server nodes that atscm should sync. Defaults to the nodes AGENT, SYSTEM, ObjectTypes.PROJECT and VariableTypes.PROJECT*.

Test:

public static get nodesToWatch: NodesConfiguration source

The atvise-server nodes to watch in the corresponding tasks. Defaults to all nodes containing displays.

Test:

public static get port: AtserverPortConfiguration source

The atvise-server ports to use.

public static get preserveSortOrderNodes: boolean source

If atvise builder sort order nodes should be stored.

public static get removeBuilderRefs: boolean source

Remove atv:refpx and atv:refpy attributes from XML to minimize diffs between pulls. This will eventually default to true in a future atscm version.

public static get sortXMLAttributes: boolean source

Sort XML attributes to minimize diffs between pulls. This will eventually default to true in a future atscm version.

public static get timeout: number source

The connection timeout, in milliseconds.

public static get useTransformers: undefined source

The transformers to use in this project. Returns a DisplayTransformer, a ScriptTransformer and a NewlinesTransformer by default.

public static get vcs: undefined source

The version control system to optimize tasks for.

public static get xmlTransformerOptions: {"sortXMLAttributes": *, "removeBuilderRefs": *} source

Static Public Methods

public static inspect(): {"host": *, "port": *, "login": *, "useTransformers": *, "nodes": *, "nodesToWatch": *, "ignoreNodes": *} source

Returns an object containing the properties to inspect.

Return:

{"host": *, "port": *, "login": *, "useTransformers": *, "nodes": *, "nodesToWatch": *, "ignoreNodes": *}

Test: