IProxy Interface Reference

List of all members.


Detailed Description

The interface for use by the xml-rpc.net framework.

The interface methods translate into other method names at the server end, as we are using .NET name styling. It also puts all methods in the same interface. This may change. Users are not expected to use this interface directly.

Definition at line 283 of file IProxy.cs.


Public Member Functions

General Methods


GetVersionResult GetVersion ()
 Get the version of the server.
GetTimezoneResult GetTimezone ()
 Get the timezone of the server.
Login/out


LoginResult Login (LoginParam param)
 Login to the server.
void Logout ()
 Logout of the server.
Product Related Methods


ProductIds GetSelectableProducts ()
 Get a list of the products (ids) that the user can search against.
ProductIds GetEnterableProducts ()
 Get a list of the products (ids) that the user can post bugs against.
ProductIds GetAccessibleProducts ()
 Get a list of the products (ids) that the user can search or enter bug against.
GetProductsResult GetProducts (ProductIds param)
 Get a list of products from a list of ids.
Bug Related Methods


CreateBugResult CreateBug (CreateBugParam param)
 Create a new bug.
GetBugsResult GetBugs (BugIds param)
 Get a list of bugs from a list of ids.
GetLegalValuesForBugFieldResult GetLegalValuesForBugField (GetLegalValuesForBugFieldParam param)
 Get a list of legal values for a field in a bug.
Experimental Methods
These are here as part of the development of patches, etc.

void AppendComment (AppendCommentParam param)
 Append a comment.
string SetBugResolution (SetBugResolutionParam param)
 Change the resolution of a bug.

Member Function Documentation

GetVersionResult GetVersion (  ) 

Get the version of the server.

Returns:
The version of the server as a string

Referenced by Server::GetVersion().

GetTimezoneResult GetTimezone (  ) 

Get the timezone of the server.

Returns:
The timezone information as a string, in RFC 2822 format

Referenced by Server::GetTimezone().

LoginResult Login ( LoginParam  param  ) 

Login to the server.

Parameters:
param Login, password and optional remember value
Returns:
If successful, the user's numeric id

Referenced by Server::Login().

ProductIds GetSelectableProducts (  ) 

Get a list of the products (ids) that the user can search against.

Returns:
A list of product ids

Referenced by Server::GetSelectableProductIds().

ProductIds GetEnterableProducts (  ) 

Get a list of the products (ids) that the user can post bugs against.

Returns:
A list of product ids

Referenced by Server::GetEnterableProductIds().

ProductIds GetAccessibleProducts (  ) 

Get a list of the products (ids) that the user can search or enter bug against.

Returns:
A list of product ids

Referenced by Server::GetAccessibleProductIds().

GetProductsResult GetProducts ( ProductIds  param  ) 

Get a list of products from a list of ids.

Parameters:
param A list of product ids
Returns:
A list of products

Referenced by Server::GetProducts().

CreateBugResult CreateBug ( CreateBugParam  param  ) 

Create a new bug.

Parameters:
param Various information about the new bug
Returns:
The id of the newly created bug

Referenced by Product::CreateBug().

GetBugsResult GetBugs ( BugIds  param  ) 

Get a list of bugs from a list of ids.

Parameters:
param A list of bug ids
Returns:
A list of bugs

Referenced by Server::GetBugs(), and Bug::Update().

GetLegalValuesForBugFieldResult GetLegalValuesForBugField ( GetLegalValuesForBugFieldParam  param  ) 

Get a list of legal values for a field in a bug.

Parameters:
param Which field, possibly product
Returns:
The legal values for the field

void AppendComment ( AppendCommentParam  param  ) 

Append a comment.

Works with Bugzilla trunk (3.1.2+) only

Parameters:
param Bug id, comment, etc

Referenced by Bug::AppendComment().

string SetBugResolution ( SetBugResolutionParam  param  ) 

Change the resolution of a bug.

This requires an unpublished patch

Parameters:
param Bug id and resolution

Referenced by Server::SetBugResolution().


The documentation for this interface was generated from the following file:
Generated on Thu Jan 17 07:31:46 2008 for BugzillaProxy by  doxygen 1.5.4