DatStat Illume 4.5 SDK Class Reference

WebServiceContext Members

WebServiceContext overview

Public Instance Constructors

WebServiceContext Constructor Initializes a new instance of a WebServiceContext object.

Public Instance Properties

Connected Returns a boolean value indicating if there is currently a connection to the DatStat DesignerService.
DesignerServiceProxy Get or set a web proxy used when communicating over the network to the DatStat DesignerService. Note that resetting the proxy will NOT automatically connect or re-connect to a DesignerService.
DesignerServiceURL Get or set the uniform resource locator (URL) of the DatStat DesignerService. Note that resetting the URL will NOT automatically connect or re-connect to a DesignerService.
RuntimeSDKConnection This property is used internally when the connection is managed by the Runtime SDK.
User If connected, returns an SDK_User object for the currently connected user.

Public Instance Methods

AddExistingParticipants Adds one or more existing participants to a participant list.
AddParticipantOverloaded. This method will add a new participant to the given participant list.
Connect Connects to the Illume DesignerService using the given user and password.
CreateParticipantList Creates a new participant list with the given name in the indicated project. An SDK_ParticipantList object representing this new list is returned.
CreateQueryOverloaded. Returns an SDK_Query object for the given survey.
DeleteParticipant Given a participant list and the id of a participant, this method will delete that participant from that participant list.
DeleteParticipantList This method will delete the named participant list from the system.
Disconnect If connected, this method will close the connection to the Illume DesignerService.
DownloadSurveyData This method returns all results for a survey and writes the results to the given TextWriter stream in the format specified by the enum value SDK_ResultsType for outputType.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
ExecuteQueryOverloaded. Executes a query defined in an SDK_Query object and returns the raw data to a TextWriter or returns a DataSet object containing Raw and/or Summary tables.
GetAccessibleSurveys This method returns an array of SDK_SurveyDetail that is all published surveys the current SDK user has access to.
GetDictionaryEntriesOverloaded. Returns an array of SDK_DictionaryEntry for the indicated survey and variable names.
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetParticipant Given a participant list, and the ID of a participant, returns the participant if found. If the participant or the participant list is invalid, this method will throw an exception.
GetParticipantList This method will retrieve the named participant list from the system and return it as an SDK_ParticipantList. If the list is not found or if there is an error during retrieval, an exception will be thrown with an appropriate error message.
GetSurveyDetail Returns an SDK_SurveyDetail object for the passed surveyName.
GetSurveyId Returns an integer value that is the Id for the passed surveyName.
GetType (inherited from Object)Gets the Type of the current instance.
ImportParticipantsOverloaded. This method will import and add new participants to a participant list from a file stream.
MakeSubmission Makes one or more submissions in the survey named surveyName using the variable/response pairs given in dataHashArray.
QueryParticipants This method will retrieve one or more participants from a participant list which meet the optional criteria for lastName, firstName, email, and customId.
RunDateRangeQueryOverloaded. Returns results for each requested variable for the given surveyName and date or date range.
RunQuery Executes and returns the results of a query to the given TextWriter stream.
RunSubmissionQuery Writes all survey values for the given submission Id to the passed TextWriter output stream.
StartSurvey Starts the survey if it is currently suspended (stopped). If the survey is not in a state that can be started an appropriate exception is thrown.
SuspendSurvey Suspends the survey if it is currently running. If the survey is not in a state that can be suspended an appropriate exception is thrown.
ToString (inherited from Object)Returns a String that represents the current Object.
UpdateParticipant This method can be used to update the information for a given participant. The changes are reflected in the returned SDK_Participant object.

Protected Instance Methods

Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

WebServiceContext Class | DatStat.SDK.WebServiceWrappers Namespace