phpDocumentor TestlinkAPI
[ class tree: TestlinkAPI ] [ index: TestlinkAPI ] [ all elements ]

Class: TestlinkXMLRPCServer

Source Location: /xmlrpc.php

Class TestlinkXMLRPCServer

Class Overview

The entry class for serving XML-RPC Requests

See examples for additional detail

Located in /xmlrpc.php [line 83]

IXR_Server
   |
   --TestlinkXMLRPCServer
Author(s): API Tags:
Example:  python client sample
Example:  php client sample
Example:  ruby client sample
Example:  java client sample

Information Tags:
Version:  1.0
Since:  Class available since Release 1.8.0

Properties

Methods

[ Top ]
Property Summary
static mixed   $actionOnDuplicatedNameParamName   string for parameter names are all defined statically
static mixed   $assignedToParamName   string for parameter names are all defined statically
static mixed   $authorLoginParamName   string for parameter names are all defined statically
static mixed   $automatedParamName   string for parameter names are all defined statically
static mixed   $bugIDParamName   string for parameter names are all defined statically
static mixed   $buildIDParamName   string for parameter names are all defined statically
static mixed   $buildNameParamName   string for parameter names are all defined statically
static mixed   $buildNotesParamName   string for parameter names are all defined statically
static mixed   $checkDuplicatedNameParamName   string for parameter names are all defined statically
static mixed   $customFieldNameParamName   string for parameter names are all defined statically
static mixed   $deepParamName   string for parameter names are all defined statically
static mixed   $detailsParamName   string for parameter names are all defined statically
static mixed   $devKeyParamName   string for parameter names are all defined statically
static mixed   $executedParamName   string for parameter names are all defined statically
static mixed   $executeStatusParamName   string for parameter names are all defined statically
static mixed   $executionOrderParamName   string for parameter names are all defined statically
static mixed   $executionTypeParamName   string for parameter names are all defined statically
static mixed   $expectedResultsParamName   string for parameter names are all defined statically
static mixed   $guessParamName   string for parameter names are all defined statically
static mixed   $importanceParamName   string for parameter names are all defined statically
static mixed   $internalIDParamName   string for parameter names are all defined statically
static mixed   $keywordIDParamName   string for parameter names are all defined statically
static mixed   $keywordNameParamName   string for parameter names are all defined statically
static mixed   $noteParamName   string for parameter names are all defined statically
static mixed   $orderParamName   string for parameter names are all defined statically
static mixed   $parentIDParamName   string for parameter names are all defined statically
static mixed   $requirementsParamName   string for parameter names are all defined statically
static mixed   $statusParamName   string for parameter names are all defined statically
static mixed   $stepsParamName   string for parameter names are all defined statically
static mixed   $summaryParamName   string for parameter names are all defined statically
static mixed   $testCaseExternalIDParamName   string for parameter names are all defined statically
static mixed   $testCaseIDParamName   string for parameter names are all defined statically
static mixed   $testCaseNameParamName   string for parameter names are all defined statically
static mixed   $testCasePrefixParamName   string for parameter names are all defined statically
static mixed   $testModeParamName   string for parameter names are all defined statically
static mixed   $testPlanIDParamName   string for parameter names are all defined statically
static mixed   $testProjectIDParamName   string for parameter names are all defined statically
static mixed   $testProjectNameParamName   string for parameter names are all defined statically
static mixed   $testSuiteIDParamName   string for parameter names are all defined statically
static mixed   $testSuiteNameParamName   string for parameter names are all defined statically
static mixed   $timeStampParamName   string for parameter names are all defined statically
static mixed   $urgencyParamName   string for parameter names are all defined statically
static mixed   $version  
static mixed   $versionNumberParamName   string for parameter names are all defined statically
mixed   $codeStatus  
mixed   $statusCode   An array containing strings for valid statuses

[ Top ]
Method Summary
TestlinkXMLRPCServer   __construct()   Constructor sets up the IXR_Server and db connection
string   about()   Gives basic information about the API
void   addTestCaseToTestPlan()   Add a test case version to a test plan
void   assignRequirements()  
boolean   authenticate()   authenticates a user based on the devKey provided
boolean   checkBuildID()   Helper method to see if the buildID provided is valid for testplan
boolean   checkGuess()   Helper method to see if the guess is set
void   checkReqSpecQuality()  
boolean   checkStatus()   Helper method to see if the status provided is valid
void   checkTestCaseAncestry()  
boolean   checkTestCaseID()   Helper method to see if the tcid provided is valid
boolean   checkTestCaseIdentity()   Helper method to see if the testcase identity provided is valid Identity can be specified in one of these modes:
boolean   checkTestCaseName()   Helper method to see if the testcasename provided is valid
void   checkTestCaseVersionNumber()  
boolean   checkTestPlanID()   Helper method to see if the tplanid provided is valid
boolean   checkTestProjectID()   Helper method to see if the TestProjectID provided is valid
boolean   checkTestSuiteID()   Helper method to see if the TestSuiteID provided is valid
boolean   checkTestSuiteName()   test suite name provided is valid
mixed   createBuild()   Creates a new build for a specific test plan
void   createTestCase()   createTestCase
mixed   createTestProject()   create a test project
mixed   createTestSuite()   create a test suite
if   getBuildsForTestPlan()   Gets a list of builds within a test plan
void   getFirstLevelTestSuitesForTestProject()  
mixed   getLastExecutionResult()   Gets the result of LAST EXECUTION for a particular testcase on a test plan, but WITHOUT checking for a particular build
mixed   getLatestBuildForTestPlan()   Gets the latest build by choosing the maximum build id for a specific test plan
mixed   getProjects()   Gets a list of all projects
mixed   getProjectTestPlans()   Gets a list of test plans within a project
mixed   getTestCaseAttachments()   Gets attachments for specified test case.
mixed   getTestCaseCustomFieldDesignValue()   Gets value of a Custom Field with scope='design' for a given Test case
mixed   getTestCaseIDByName()   Find a test case by its name
mixed   getTestCasesForTestPlan()   getTestCasesForTestPlan List test cases linked to a test plan
mixed   getTestCasesForTestSuite()   List test cases within a test suite
mixed   getTestSuitesForTestPlan()   List test suites within a test plan alphabetically
string   repeat()   Repeats a message back
mixed   reportTCResult()   Reports a result for a single test case
string   sayHello()   Lets you see if the server is up and running
boolean   setTestMode()   turn on/off testMode
void   updateTestCase()   Update an existing test case
void   userHasRight()  

[ Top ]
Properties
static mixed   $actionOnDuplicatedNameParamName = "actiononduplicatedname" [line 174]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $assignedToParamName = "assignedto" [line 159]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $authorLoginParamName = "authorlogin" [line 168]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $automatedParamName = "automated" [line 155]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $bugIDParamName = "bugid" [line 181]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $buildIDParamName = "buildid" [line 147]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $buildNameParamName = "buildname" [line 153]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $buildNotesParamName = "buildnotes" [line 154]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $checkDuplicatedNameParamName = "checkduplicatedname" [line 173]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $customFieldNameParamName = "customfieldname" [line 164]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $deepParamName = "deep" [line 151]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $detailsParamName = "details" [line 180]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $devKeyParamName = "devKey" [line 140]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $executedParamName = "executed" [line 158]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $executeStatusParamName = "executestatus" [line 160]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $executionOrderParamName = "executionorder" [line 177]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $executionTypeParamName = "executiontype" [line 169]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $expectedResultsParamName = "expectedresults" [line 167]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $guessParamName = "guess" [line 150]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $importanceParamName = "importance" [line 170]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $internalIDParamName = "internalid" [line 172]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $keywordIDParamName = "keywordid" [line 157]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $keywordNameParamName = "keywords" [line 175]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $noteParamName = "notes" [line 148]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $orderParamName = "order" [line 171]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $parentIDParamName = "parentid" [line 182]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $requirementsParamName = "requirements" [line 179]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $statusParamName = "status" [line 146]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $stepsParamName = "steps" [line 166]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $summaryParamName = "summary" [line 165]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $testCaseExternalIDParamName = "testcaseexternalid" [line 142]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $testCaseIDParamName = "testcaseid" [line 141]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $testCaseNameParamName = "testcasename" [line 156]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $testCasePrefixParamName = "testcaseprefix" [line 163]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $testModeParamName = "testmode" [line 152]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $testPlanIDParamName = "testplanid" [line 143]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $testProjectIDParamName = "testprojectid" [line 144]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $testProjectNameParamName = "testprojectname" [line 162]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $testSuiteIDParamName = "testsuiteid" [line 145]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $testSuiteNameParamName = "testsuitename" [line 161]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $timeStampParamName = "timestamp" [line 149]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $urgencyParamName = "urgency" [line 178]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
static mixed   $version = "1.0 Beta 5" [line 85]
API Tags:
Access:  public


[ Top ]
static mixed   $versionNumberParamName = "version" [line 176]

string for parameter names are all defined statically

API Tags:
Access:  public


[ Top ]
mixed   $codeStatus [line 194]
API Tags:
Access:  public


[ Top ]
mixed   $statusCode [line 193]

An array containing strings for valid statuses

Will be initialized using user configuration via config_get()

API Tags:
Access:  public


[ Top ]
Methods
Constructor __construct  [line 200]

  TestlinkXMLRPCServer __construct( )

Constructor sets up the IXR_Server and db connection


API Tags:
Access:  public


[ Top ]
about  [line 1250]

  string about( struct $args  )

Gives basic information about the API

Parameters:
struct   $args:  not used

API Tags:
Access:  public


[ Top ]
addTestCaseToTestPlan  [line 2243]

  void addTestCaseToTestPlan( args['testprojectid'] $args, args['testplanid'] 1, args['testcaseexternalid'] 2, args['version'] 3, args['executionorder'] 4, args['urgency'] 5  )

Add a test case version to a test plan

Parameters:
args['testplanid']   1: 
args['testcaseexternalid']   2: 
args['version']   3: 
args['executionorder']   4:  - OPTIONAL
args['urgency']   5:  - OPTIONAL
args['testprojectid']   $args: 

API Tags:
Access:  public


[ Top ]
assignRequirements  [line 2426]

  void assignRequirements( $args  )

Parameters:
   $args: 

API Tags:
Access:  public


[ Top ]
authenticate  [line 337]

  boolean authenticate( [ $messagePrefix = '']  )

authenticates a user based on the devKey provided

This is the only method that should really be used directly to authenticate

Parameters:
   $messagePrefix: 

API Tags:
Access:  protected


[ Top ]
checkBuildID  [line 586]

  boolean checkBuildID( )

Helper method to see if the buildID provided is valid for testplan

This is the only method that should be called directly to check the buildID


API Tags:
Access:  protected


[ Top ]
checkGuess  [line 571]

  boolean checkGuess( )

Helper method to see if the guess is set

This is the only method that should be called directly to check the guess param

Guessing is set to true by default


API Tags:
Access:  protected


[ Top ]
checkReqSpecQuality  [line 2529]

  void checkReqSpecQuality( )



[ Top ]
checkStatus  [line 418]

  boolean checkStatus( )

Helper method to see if the status provided is valid

This is the only method that should be called directly to check the status


API Tags:
Access:  protected


[ Top ]
checkTestCaseAncestry  [line 2497]

  void checkTestCaseAncestry( )



[ Top ]
checkTestCaseID  [line 442]

  boolean checkTestCaseID( )

Helper method to see if the tcid provided is valid

This is the only method that should be called directly to check the tcid


API Tags:
Access:  protected


[ Top ]
checkTestCaseIdentity  [line 1849]

  boolean checkTestCaseIdentity( )

Helper method to see if the testcase identity provided is valid Identity can be specified in one of these modes:

test case internal id test case external id (PREFIX-NNNN)

This is the only method that should be called directly to check test case identoty

If everything OK, test case internal ID is setted.


API Tags:
Access:  protected


[ Top ]
checkTestCaseName  [line 390]

  boolean checkTestCaseName( )

Helper method to see if the testcasename provided is valid

This is the only method that should be called directly to check the testcasename


API Tags:
Access:  protected


[ Top ]
checkTestCaseVersionNumber  [line 2205]

  void checkTestCaseVersionNumber( )


API Tags:
Access:  protected


[ Top ]
checkTestPlanID  [line 466]

  boolean checkTestPlanID( )

Helper method to see if the tplanid provided is valid

This is the only method that should be called directly to check the tplanid


API Tags:
Access:  protected


[ Top ]
checkTestProjectID  [line 512]

  boolean checkTestProjectID( [ $messagePrefix = '']  )

Helper method to see if the TestProjectID provided is valid

This is the only method that should be called directly to check the TestProjectID

Parameters:
   $messagePrefix: 

API Tags:
Access:  protected


[ Top ]
checkTestSuiteID  [line 541]

  boolean checkTestSuiteID( )

Helper method to see if the TestSuiteID provided is valid

This is the only method that should be called directly to check the TestSuiteID


API Tags:
Access:  protected


[ Top ]
checkTestSuiteName  [line 2820]

  boolean checkTestSuiteName( [ $messagePrefix = '']  )

test suite name provided is valid

Parameters:
   $messagePrefix: 

API Tags:
Access:  protected


[ Top ]
createBuild  [line 1270]

  mixed createBuild( struct $args, string $args["devKey"], int $args["testplanid"], string $args["buildname"];, string $args["buildnotes"];  )

Creates a new build for a specific test plan

Parameters:
struct   $args: 
string   $args["devKey"]: 
int   $args["testplanid"]: 
string   $args["buildname"];: 
string   $args["buildnotes"];: 

API Tags:
Access:  public


[ Top ]
createTestCase  [line 1636]

  void createTestCase( $args  )

createTestCase

Parameters:
   $args: 

API Tags:
Access:  public


[ Top ]
createTestProject  [line 1439]

  mixed createTestProject( struct $args, string $args["devKey"], int $args["testprojectname"], int $args["testcaseprefix"], int $args["notes"]  )

create a test project

Parameters:
struct   $args: 
string   $args["devKey"]: 
int   $args["testprojectname"]: 
int   $args["testcaseprefix"]: 
int   $args["notes"]: 

API Tags:
Access:  public


[ Top ]
createTestSuite  [line 2734]

  mixed createTestSuite( struct $args, string $args["devKey"], int $args["testprojectid"], string $args["testsuitename"], string $args["details"], int $args["parentid"], int $args["order"], int $args["checkduplicatedname"], int $args["actiononduplicatedname"]  )

create a test suite

Parameters:
struct   $args: 
string   $args["devKey"]: 
int   $args["testprojectid"]: 
string   $args["testsuitename"]: 
string   $args["details"]: 
int   $args["parentid"]:  optional, if do not provided means test suite must be top level.
int   $args["order"]:  optional. Order inside parent container
int   $args["checkduplicatedname"]:  optional, default true. will check if there are siblings with same name.
int   $args["actiononduplicatedname"]:  optional applicable only if $args["checkduplicatedname"]=true what to do if already a sibling exists with same name.

API Tags:
Access:  public


[ Top ]
getBuildsForTestPlan  [line 1374]

  if getBuildsForTestPlan( struct $args, string $args["devKey"], int $args["testplanid"]  )

Gets a list of builds within a test plan

Parameters:
struct   $args: 
string   $args["devKey"]: 
int   $args["testplanid"]: 

API Tags:
Return:  no errors no build present => null array of builds
Access:  public


[ Top ]
getFirstLevelTestSuitesForTestProject  [line 2381]

  void getFirstLevelTestSuitesForTestProject( $args  )

Parameters:
   $args: 

API Tags:
Access:  public


[ Top ]
getLastExecutionResult  [line 1136]

  mixed getLastExecutionResult( struct $args, string $args["devKey"], int $args["tplanid"], int $args["testcaseid"]  )

Gets the result of LAST EXECUTION for a particular testcase on a test plan, but WITHOUT checking for a particular build

Parameters:
struct   $args: 
string   $args["devKey"]: 
int   $args["tplanid"]: 
int   $args["testcaseid"]: 

API Tags:
Access:  public


[ Top ]
getLatestBuildForTestPlan  [line 1066]

  mixed getLatestBuildForTestPlan( struct $args, string $args["devKey"], int $args["tplanid"]  )

Gets the latest build by choosing the maximum build id for a specific test plan

Parameters:
struct   $args: 
string   $args["devKey"]: 
int   $args["tplanid"]: 

API Tags:
Access:  public


[ Top ]
getProjects  [line 1318]

  mixed getProjects( struct $args, string $args["devKey"]  )

Gets a list of all projects

Parameters:
struct   $args: 
string   $args["devKey"]: 

API Tags:
Access:  public


[ Top ]
getProjectTestPlans  [line 1343]

  mixed getProjectTestPlans( struct $args, string $args["devKey"], int $args["testprojectid"]  )

Gets a list of test plans within a project

Parameters:
struct   $args: 
string   $args["devKey"]: 
int   $args["testprojectid"]: 

API Tags:
Access:  public


[ Top ]
getTestCaseAttachments  [line 2679]

  mixed getTestCaseAttachments( struct $args, string $args["devKey"], int $args["testcaseid"]  )

Gets attachments for specified test case.

The attachment file content is Base64 encoded. To save the file to disk in client, Base64 decode the content and write file in binary mode.

Parameters:
struct   $args: 
string   $args["devKey"]:  Developer key
int   $args["testcaseid"]:  ID of the specified test case.

API Tags:
Access:  public


[ Top ]
getTestCaseCustomFieldDesignValue  [line 2054]

  mixed getTestCaseCustomFieldDesignValue( struct $args, string $args["devKey"]:, string $args["testcaseexternalid"]:, string $args["testprojectid"]:, string $args["customfieldname"]:  )

Gets value of a Custom Field with scope='design' for a given Test case

Parameters:
struct   $args: 
string   $args["devKey"]::  used to check if operation can be done. if devKey is not valid => abort.
string   $args["testcaseexternalid"]:: 
string   $args["testprojectid"]:: 
string   $args["customfieldname"]::  custom field name

API Tags:
Access:  public


[ Top ]
getTestCaseIDByName  [line 1596]

  mixed getTestCaseIDByName( struct $args, string $args["devKey"], string $args["testcasename"], string $args["testsuitename"], string $args["testprojectname"]  )

Find a test case by its name

Searching is case sensitive. The test case will only be returned if there is a definite match. If possible also pass the string for the test suite name.

No results will be returned if there are test cases with the same name that match the criteria provided.

Parameters:
struct   $args: 
string   $args["devKey"]: 
string   $args["testcasename"]: 
string   $args["testsuitename"]:  - optional
string   $args["testprojectname"]:  - optional

API Tags:
Access:  public


[ Top ]
getTestCasesForTestPlan  [line 1934]

  mixed getTestCasesForTestPlan( struct $args, string $args["devKey"], int $args["testplanid"], int $args["testcaseid"], int $args["buildid"], int $args["keywordid"], boolean $args["executed"], int $args["$assignedto"], string $args["executestatus"], array $args["executiontype"]  )

getTestCasesForTestPlan List test cases linked to a test plan

Parameters:
struct   $args: 
string   $args["devKey"]: 
int   $args["testplanid"]: 
int   $args["testcaseid"]:  - optional
int   $args["buildid"]:  - optional
int   $args["keywordid"]:  - optional
boolean   $args["executed"]:  - optional
int   $args["$assignedto"]:  - optional
string   $args["executestatus"]:  - optional
array   $args["executiontype"]:  - optional

API Tags:
Access:  public


[ Top ]
getTestCasesForTestSuite  [line 1545]

  mixed getTestCasesForTestSuite( struct $args, string $args["devKey"], int $args["testsuiteid"], boolean $args["deep"], boolean $args["details"]  )

List test cases within a test suite

By default test cases that are contained within child suites will be returned. Set the deep flag to false if you only want test cases in the test suite provided and no child test cases.

Parameters:
struct   $args: 
string   $args["devKey"]: 
int   $args["testsuiteid"]: 
boolean   $args["deep"]:  - optional (default is true)
boolean   $args["details"]:  - optional (default is simple) use full if you want to get summary,steps & expected_results

API Tags:
Access:  public


[ Top ]
getTestSuitesForTestPlan  [line 1410]

  mixed getTestSuitesForTestPlan( struct $args, string $args["devKey"], int $args["testplanid"]  )

List test suites within a test plan alphabetically

Parameters:
struct   $args: 
string   $args["devKey"]: 
int   $args["testplanid"]: 

API Tags:
Access:  public


[ Top ]
repeat  [line 1236]

  string repeat( struct $args  )

Repeats a message back

Parameters:
struct   $args:  should contain $args['str'] parameter

API Tags:
Access:  public


[ Top ]
reportTCResult  [line 1779]

  mixed reportTCResult( struct $args, string $args["devKey"], int $args["testcaseid"], int $args["testplanid"], string $args["status"], int $args["buildid"], int $args["buildname"], string $args["notes"], bool $args["guess"], string $args["bugid"]  )

Reports a result for a single test case

See examples for additional detail

Parameters:
struct   $args: 
string   $args["devKey"]: 
int   $args["testcaseid"]: 
int   $args["testplanid"]: 
string   $args["status"]:  - status is $validStatusList
int   $args["buildid"]:  - optional. if not present and $args["buildname"] exists then $args["buildname"] will be checked and used if valid else build with HIGHEST ID will be used
int   $args["buildname"]:  - optional. if not present Build with higher internal ID will be used
string   $args["notes"]:  - optional
bool   $args["guess"]:  - optional defining whether to guess optinal params or require them explicitly default is true (guess by default)
string   $args["bugid"]:  - optional

API Tags:
Return:  [status] => true/false of success [id] => result id or error code [message] => optional message for error message string
Access:  public
Example:  python client sample
Example:  ruby client sample
Example:  php client sample
Example:  java client sample


[ Top ]
sayHello  [line 1224]

  string sayHello( struct $args  )

Lets you see if the server is up and running

Parameters:
struct   $args:  not used

API Tags:
Return:  "Hello!"
Access:  public


[ Top ]
setTestMode  [line 1817]

  boolean setTestMode( struct $args  )

turn on/off testMode

This method is meant primarily for testing and debugging during development

Parameters:
struct   $args: 

API Tags:
Access:  public


[ Top ]
updateTestCase  [line 1735]

  void updateTestCase( $args  )

Update an existing test case

Parameters:
   $args: 

API Tags:
Access:  public


[ Top ]
userHasRight  [line 371]

  void userHasRight( $roleQuestion  )

Parameters:
   $roleQuestion: 

API Tags:
Access:  protected


[ Top ]
Constants
BUILD_GUESS_DEFAULT_MODE = OFF [line 89]

[ Top ]
OFF = false [line 87]

[ Top ]
ON = true [line 88]

[ Top ]

Documentation generated on Fri, 03 Apr 2009 14:13:35 +0200 by phpDocumentor 1.4.1