ProjectUpload Method

Does some checks to make sure the given parameters are valid, then uploads the given zones and joints to the Dashboard. The URL and authentication token are taken from the last Dashboard login made through HyperX. If any problems are encountered when uploading, this method will throw a UserException with a message describing what went wrong.

Definition

Namespace: HyperX.Scripting
Assembly: HyperX.Scripting (in HyperX.Scripting.dll) Version: 9.0.0.0 (9.0.0)
C#
public bool Upload(
	string uploadSetName,
	string company,
	string program,
	List<string> tags,
	string notes,
	HashSet<int> zoneIds,
	HashSet<int> jointIds
)

Parameters

uploadSetName  String
The name of the set of data uploaded to the Dashboard.
company  String
The name of the company to associate with the upload set. This company object must be made through the Dashboard UI.
program  String
The name of the program to associated with the upload set. A new program will be created if the program name does not already exist.
tags  ListString
The list of tags to be associated with the upload set. Any tags that do not exist will be created automatically on upload.
notes  String
The notes to be associated with the upload set.
zoneIds  HashSetInt32
The zone IDs to include in the upload set.
jointIds  HashSetInt32
The joint IDs to include in the upload set.

Return Value

Boolean
Returns true if the upload succeeded. Returns false otherwise.

See Also