The definitions are used by the xml-rpc.net framework. User should use the IServer interface in the Bugzilla namespace instead.
The purpose of this file is to define the proxy interface for use by xml-rpc. The xml-rpc interface of bugzilla is in essence a flat interface of functions, with names suggesting some kind of coherence between the different functions.
Bugzilla's authentication system is based on cookies. This can be handled by the xml-rpc.net system. In order to make it as easy as possibly, all interface functions are attached to the same proxy. At the C# interface level, functions are named following C# sharp standard. The XmlRpcMethod attribute before each function tells which bugzilla RPC method is actually called by the interface.
The standard of the Bugzilla webservice is to have functions that takes parameters use a struct (perl:hash) and values returned, also return a struct (or nothing). In this interface this is organized by having each function (that takes a parameter) take a struct called param, of a type that is named after the function. Return types are likewise named after the method. So, e.g. "Login" uses a parameter type called "LoginParam", and returns a type called LoginResult. The meaning of these parameter and result types are described using C# inline docs in the actual structs.
Definition in file IProxy.cs.
Go to the source code of this file.
Namespaces | |
namespace | Bugzproxy |
namespace | Bugzproxy::ProxyStructs |
Classes | |
struct | GetVersionResult |
Result for call to IProxy.GetVersion. More... | |
struct | GetTimezoneResult |
Result for call to IProxy.GetTimezone. More... | |
struct | LoginParam |
Parameter struct for the IProxy.Login method. More... | |
struct | LoginResult |
Parameter struct for the result of the IProxy.Login method. More... | |
struct | ProductIds |
A list of product ids. This is used in several methods, both as a param and as a result type. More... | |
struct | ProductInfo |
Information about a single product. More... | |
struct | GetProductsResult |
A list of Products. More... | |
struct | BugIds |
A list of bug ids. This is used in several functions, both as a param and as a result type. More... | |
struct | BugInfo |
Information about a single bug. More... | |
struct | GetBugsResult |
A list of Bugs. More... | |
struct | CreateBugParam |
Information needed to create a bug. More... | |
struct | CreateBugResult |
Result of call to IProxy.CreateBug. More... | |
struct | GetLegalValuesForBugFieldParam |
Parameter for IProxy.GetLegalValuesForBugField call. More... | |
struct | GetLegalValuesForBugFieldResult |
Result of call to IProxy.GetLegalValuesForBugField. More... | |
struct | AppendCommentParam |
Parameter for IProxy.AppendComment call. More... | |
struct | SetBugResolutionParam |
Parameter for call to IProxy.SetBugResolution. More... | |
interface | IProxy |
The interface for use by the xml-rpc.net framework. More... |