6916 lines
294 KiB
XML
Executable File
6916 lines
294 KiB
XML
Executable File
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>RSG.Interop.Bugstar</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:RSG.Interop.Bugstar.ActorFactory">
|
|
<summary>
|
|
Cached factory for Bugstar Users and Teams (collectively known as Actors).
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.ActorFactory.Actors">
|
|
<summary>
|
|
Actor cache.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.ActorFactory.#cctor">
|
|
<summary>
|
|
Initialises static members of the <see cref="T:RSG.Interop.Bugstar.ActorFactory"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.ActorFactory.CreateActorById(RSG.Interop.Bugstar.Organisation.Project,System.UInt32)">
|
|
<summary>
|
|
Create user or team from Id (null if Id is not valid actor).
|
|
</summary>
|
|
<param name="project">
|
|
The project to retrieve the actor for.
|
|
</param>
|
|
<param name="id">
|
|
The actors Id.
|
|
</param>
|
|
<returns>
|
|
The actor specified by the Id.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.ActorFactory.CreateUserById(RSG.Interop.Bugstar.Organisation.Project,System.UInt32)">
|
|
<summary>
|
|
Create user from Id (null if Id is not valid user).
|
|
</summary>
|
|
<param name="project">
|
|
The project to retrieve the actor for.
|
|
</param>
|
|
<param name="id">
|
|
The actors Id.
|
|
</param>
|
|
<returns>
|
|
The actor specified by the Id.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.ActorFactory.CreateTeamById(RSG.Interop.Bugstar.Organisation.Project,System.UInt32)">
|
|
<summary>
|
|
Create team from Id (null if Id is not valid team).
|
|
</summary>
|
|
<param name="project">
|
|
The project to retrieve the actor for.
|
|
</param>
|
|
<param name="id">
|
|
The actors Id.
|
|
</param>
|
|
<returns>
|
|
The actor specified by the Id.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.ActorFactory.Clear">
|
|
<summary>
|
|
Clear our actor cache.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Application.BugField">
|
|
<summary>
|
|
Enumeration of the bug fields that the Bugstar application interface supports.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Application.BugField.AssignedTo">
|
|
<summary>
|
|
The owner of the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Application.BugField.Id">
|
|
<summary>
|
|
The bugs id.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Application.BugField.Number">
|
|
<summary>
|
|
MET: Not sure.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Application.BugField.Reporter">
|
|
<summary>
|
|
The QA owner of the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Application.BugField.Attempts">
|
|
<summary>
|
|
The number of attempts made at reproducing the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Application.BugField.Verifications">
|
|
<summary>
|
|
The number of verifications for the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Application.BugField.Severity">
|
|
<summary>
|
|
The severity of the bug (A, B, TODO, etc...).
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Application.BugField.Status">
|
|
<summary>
|
|
The bugs current status (Dev (fixing), Test (Verifying), etc...).
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Application.BugField.Creation">
|
|
<summary>
|
|
When the bug was created.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Application.BugField.Summary">
|
|
<summary>
|
|
The summary of the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Application.BugField.Product">
|
|
<summary>
|
|
The project to add the bug to.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Application.BugField.Platform">
|
|
<summary>
|
|
The platform the bug was found on.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Application.BugField.Version">
|
|
<summary>
|
|
The version of the product the game was found in.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Application.BugField.FixedInVersion">
|
|
<summary>
|
|
The version of the product that the bug was fixed in.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Application.BugField.Component">
|
|
<summary>
|
|
The component to associate the bug with.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Application.BugField.Resolution">
|
|
<summary>
|
|
MET: Not sure.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Application.BugField.Description">
|
|
<summary>
|
|
The bugs detailed description.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Application.BugField.Custom">
|
|
<summary>
|
|
Custom bug fields.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Application.BugMessageBuilder">
|
|
<summary>
|
|
The <see cref="T:RSG.Interop.Bugstar.Application.BugMessageBuilder"/> class is in charge of creating a memory stream
|
|
that is of the correct format to send to the Bugstar application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Application.BugMessageBuilder._stream">
|
|
<summary>
|
|
Payload data.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Application.BugMessageBuilder._writer">
|
|
<summary>
|
|
The writer in charge of creating the memory stream.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Application.BugMessageBuilder.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Application.BugMessageBuilder"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Application.BugMessageBuilder.AddCustomField(System.String,System.String)">
|
|
<summary>
|
|
Adds a custom field with the given name/value.
|
|
</summary>
|
|
<param name="name">
|
|
The string representation of the field to add.
|
|
</param>
|
|
<param name="value">
|
|
The string representation of the value to associate with the field.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Application.BugMessageBuilder.AddCustomField(System.String,System.IO.Stream)">
|
|
<summary>
|
|
Adds a custom field with the given name/streamed value.
|
|
</summary>
|
|
<param name="name">
|
|
The string representation of the field to add.
|
|
</param>
|
|
<param name="value">
|
|
The stream representation of the value to associate with the field.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Application.BugMessageBuilder.AddField(RSG.Interop.Bugstar.Application.BugField,System.String)">
|
|
<summary>
|
|
Adds a standard field with the given value.
|
|
</summary>
|
|
<param name="field">
|
|
The field to add.
|
|
</param>
|
|
<param name="value">
|
|
The value to associate with the field.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Application.BugMessageBuilder.Dispose">
|
|
<summary>
|
|
Disposes of the underlying memory stream.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Application.BugMessageBuilder.FinaliseMessage">
|
|
<summary>
|
|
Finalises the message flushing out the writer to the stream and setting the
|
|
header's body length.
|
|
</summary>
|
|
<returns>
|
|
The stream containing the full bug data that can be sent to Bugstar.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Application.BugMessageBuilder.AddHeader">
|
|
<summary>
|
|
Adds the header data.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Application.BugMessageBuilder.AddFooter">
|
|
<summary>
|
|
Adds the footer data.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Application.BugstarApplication">
|
|
<summary>
|
|
Allows for communication with the Bugstar application that is running on an users
|
|
machine.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Application.BugstarApplication.DefaultPort">
|
|
<summary>
|
|
Default port to use to communicate with the Bugstar application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Application.BugstarApplication._endpoint">
|
|
<summary>
|
|
Endpoint to use to communication with the running Bugstar application.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Application.BugstarApplication.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Application.BugstarApplication"/> class which
|
|
connects to the local machine using default port.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Application.BugstarApplication.#ctor(System.Net.IPAddress,System.Int32)">
|
|
<summary>
|
|
Initialise a new instance of the <see cref="T:RSG.Interop.Bugstar.Application.BugstarApplication"/> class using
|
|
the specified address and port for communication with the application.
|
|
</summary>
|
|
<param name="address">
|
|
The address of the Bugstar application to connect to.
|
|
</param>
|
|
<param name="port">
|
|
The port to connect on.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Application.BugstarApplication.CreateBug(RSG.Interop.Bugstar.Application.PendingBug)">
|
|
<summary>
|
|
Opens up the add new bug window in the Bugstar application with the specified
|
|
pending bug's fields pre populated.
|
|
</summary>
|
|
<param name="bug">
|
|
The object containing all the information required for creating the bug.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Application.BugstarApplication.OpenBug(System.UInt32)">
|
|
<summary>
|
|
Open a bug in the bugstar client.
|
|
</summary>
|
|
<param name="bugNumber">Bug to open.</param>
|
|
<returns>Success.</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Application.BugstarApplication.IsBugstarRunning">
|
|
<summary>
|
|
Checks whether the Bugstar application is currently running on the users
|
|
machine.
|
|
</summary>
|
|
<returns>
|
|
<c>true</c> if an instance of Bugstar is running, otherwise <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Application.BugstarApplication.OpenBugsInNewSearch(System.UInt32,System.Collections.Generic.IList{System.UInt32},System.Boolean,System.String)">
|
|
<summary>
|
|
Opens bugs in a new search in bugstar.
|
|
</summary>
|
|
<param name="bugstarProjectId">Bugstar project ID</param>
|
|
<param name="bugIds">List of bug ids to open in new search.</param>
|
|
<param name="runSearch">Run the search after creating in bugstar.</param>
|
|
<param name="searchName">Optional search name to save the search as.</param>
|
|
<returns>If the search request was sent to running bugstar app.</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Application.BugstarApplication.CreateBugstarCriteriaFile(System.String,System.Collections.Generic.IList{System.UInt32})">
|
|
<summary>
|
|
Creates and saves the bugstar criteria xml file used for opening a search in bugstar.
|
|
</summary>
|
|
<param name="criteriaFilename">Filename to save to</param>
|
|
<param name="bugIds">List of bugIds that will be opened.</param>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Application.PendingBug">
|
|
<summary>
|
|
Represents a bug that is pending creation in Bugstar.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Application.PendingBug.Category">
|
|
<summary>
|
|
Gets or sets the bugs category.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Application.PendingBug.CCList">
|
|
<summary>
|
|
Gets the list of CC's to add to this bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Application.PendingBug.ComponentId">
|
|
<summary>
|
|
Gets or sets the component id for this bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Application.PendingBug.ComponentName">
|
|
<summary>
|
|
Gets or sets the name of the component for this bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Application.PendingBug.Description">
|
|
<summary>
|
|
Gets or sets the bugs description.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Application.PendingBug.FileAttachments">
|
|
<summary>
|
|
Gets the file based attachments to add to the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Application.PendingBug.FoundIn">
|
|
<summary>
|
|
Gets or sets the build version that the bug was found in.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Application.PendingBug.Owner">
|
|
<summary>
|
|
Gets or sets the name of the owner for the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Application.PendingBug.Project">
|
|
<summary>
|
|
Gets or sets the name of the Bugstar project that this bug should be added under.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Application.PendingBug.Reviewer">
|
|
<summary>
|
|
Gets or sets the name of the reviewer to assign to the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Application.PendingBug.StreamedAttachments">
|
|
<summary>
|
|
Gets the list of stream based attachments to add to the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Application.PendingBug.Summary">
|
|
<summary>
|
|
Gets or sets the bugs summary.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Application.PendingBug.Position">
|
|
<summary>
|
|
Gets or sets the bugs position.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Application.PendingBug.Front">
|
|
<summary>
|
|
Gets or sets the bugs camera front vector.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Application.PendingBug.MissionId">
|
|
<summary>
|
|
Gets or sets the bugs mission name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Application.PendingBug.Tags">
|
|
<summary>
|
|
Gets the list of tags to add to the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Application.PendingBug.AddStreamedAttachment(System.String,System.IO.Stream)">
|
|
<summary>
|
|
Adds a new streamed attachment to the bug with the specified filename.
|
|
</summary>
|
|
<param name="filename">
|
|
The name of the file as it should appear in Bugstar.
|
|
</param>
|
|
<param name="stream">
|
|
The stream containing the file's data.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Asserts.GameAssert">
|
|
<summary>
|
|
Represents a single game assert in the game
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Asserts.GameAssert.#ctor(RSG.Interop.Bugstar.Organisation.Project)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Asserts.GameAssert"/> class for the specified
|
|
project.
|
|
</summary>
|
|
<param name="project">
|
|
The project this assert is being created for.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Asserts.GameAssert.#ctor(RSG.Interop.Bugstar.Organisation.Project,System.UInt32,RSG.Interop.Bugstar.Asserts.GameAssertType,System.Int64,System.Collections.Generic.IEnumerable{System.Int64})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Asserts.GameAssert"/> class for the specified
|
|
project.
|
|
</summary>
|
|
<param name="project">
|
|
The project this assert is being created for.
|
|
</param>
|
|
<param name="bugId">Bug this assert belongs too</param>
|
|
<param name="assertType">Type of assert</param>
|
|
<param name="assertId">Assert ID</param>
|
|
<param name="secondaryAssertId">Seocndary assert id</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Asserts.GameAssert.#ctor(RSG.Interop.Bugstar.Organisation.Project,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Asserts.GameAssert"/> class for the specified
|
|
project using the Xml element as the source of the map content.
|
|
</summary>
|
|
<param name="project">
|
|
The project this map is being created for.
|
|
</param>
|
|
<param name="xmlElement">
|
|
The Xml element containing the search data.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Asserts.GameAssert.AssertType">
|
|
<summary>
|
|
Gets or sets game assert type
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Asserts.GameAssert.AssertId">
|
|
<summary>
|
|
Gets or sets main assert ID
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Asserts.GameAssert.SecondaryAssertId">
|
|
<summary>
|
|
Gets or sets additional (optional) secondary assert ID
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Asserts.GameAssert.Project">
|
|
<summary>
|
|
Gets or sets the project this map is a part of.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Asserts.GameAssert.Query">
|
|
<summary>
|
|
Gets the query to use to query Bugstar about this object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Asserts.GameAssert.Serialize">
|
|
<summary>
|
|
Serialises this update request to its XML representation.
|
|
</summary>
|
|
<returns>
|
|
The Xml representation of this object
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Asserts.GameAssert.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Generates an object from its XML representation.
|
|
</summary>
|
|
<param name="node">
|
|
The Xml element containing the missions data.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Asserts.GameAsserts">
|
|
<summary>
|
|
Wrapper for collection of Game Asserts
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Asserts.GameAsserts.#ctor(RSG.Interop.Bugstar.Organisation.Project)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Asserts.GameAssert"/> class for the specified
|
|
project.
|
|
</summary>
|
|
<param name="project">
|
|
The project this assert is being created for.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Asserts.GameAsserts.#ctor(RSG.Interop.Bugstar.Organisation.Project,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Asserts.GameAsserts"/> class for the specified
|
|
project using the Xml element as the source of the map content.
|
|
</summary>
|
|
<param name="project">
|
|
The project this map is being created for.
|
|
</param>
|
|
<param name="xmlElement">
|
|
The Xml element containing the search data.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Asserts.GameAsserts.ChildGameAssert">
|
|
<summary>
|
|
Gets or sets the game asserts
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Asserts.GameAsserts.Project">
|
|
<summary>
|
|
Gets or sets the project this map is a part of.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Asserts.GameAsserts.Query">
|
|
<summary>
|
|
Gets the query to use to query Bugstar about this object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Asserts.GameAsserts.Serialize">
|
|
<summary>
|
|
Serialises this update request to its XML representation.
|
|
</summary>
|
|
<returns>
|
|
The Xml representation of this object
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Asserts.GameAsserts.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Generates an object from its XML representation.
|
|
</summary>
|
|
<param name="node">
|
|
The Xml element containing the missions data.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Asserts.GameAssertType">
|
|
<summary>
|
|
Enum to indicate typeid to assert type
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Asserts.GameAssertType.Runtime">
|
|
<summary>
|
|
Game runtime assert
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Asserts.GameAssertType.Tools">
|
|
<summary>
|
|
Tools assert
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Attachment">
|
|
<summary>
|
|
Bugstar Attachment object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Attachment.DownloadBufferSize">
|
|
<summary>
|
|
Download buffer size.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Attachment.#ctor(RSG.Interop.Bugstar.BugstarConnection,System.UInt32)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Attachment"/> class using the
|
|
specified connection and id.
|
|
</summary>
|
|
<param name="connection">
|
|
The Bugstar connection to use when performing requests.
|
|
</param>
|
|
<param name="id">
|
|
The id of the attachment to retrieve.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Attachment.#ctor(RSG.Interop.Bugstar.BugstarConnection,System.Xml.Linq.XDocument)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Attachment"/> class using the
|
|
specified xml document.
|
|
</summary>
|
|
<param name="connection">
|
|
The Bugstar connection to use when performing requests.
|
|
</param>
|
|
<param name="xmlAttachmentDocument">
|
|
The Xml document containing the attachment information.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Attachment.#ctor(RSG.Interop.Bugstar.BugstarConnection,System.IO.Stream)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Attachment"/> class using the
|
|
specified stream containing xml data.
|
|
</summary>
|
|
<param name="connection">
|
|
The Bugstar connection to use when performing requests.
|
|
</param>
|
|
<param name="stream">
|
|
The stream containing the xml data.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Attachment.Query">
|
|
<summary>
|
|
Gets the query to use to query Bugstar about this object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Attachment.Download(System.String)">
|
|
<summary>
|
|
Download attachment data to file.
|
|
</summary>
|
|
<param name="filename">
|
|
The full path to the file to download the attachment data to.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if the attachment could be downlaoded; otherwise <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Attachment.Download">
|
|
<summary>
|
|
Download attachment data into stream.
|
|
</summary>
|
|
<returns>
|
|
The stream containing the attachment data.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Attachment.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Generates an object from its XML representation.
|
|
</summary>
|
|
<param name="xmlObjectElem">
|
|
The Xml element containing the attachment data.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.AttachmentBuilder">
|
|
<summary>
|
|
Attachment object builder class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.AttachmentBuilder.#ctor(RSG.Interop.Bugstar.Organisation.Project)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.AttachmentBuilder"/> class for the
|
|
specified project.
|
|
</summary>
|
|
<param name="project">
|
|
The project this attachment is being added to.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.AttachmentBuilder.Project">
|
|
<summary>
|
|
Gets the project the attachment is a part of.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.AttachmentBuilder.UploadFilename">
|
|
<summary>
|
|
Gets the filename uploaded to attachment service as.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.AttachmentBuilder.ToAttachment(RSG.Interop.Bugstar.BugstarConnection,System.String)">
|
|
<summary>
|
|
Returns a concrete Attachment object (commits attachment to server).
|
|
</summary>
|
|
<param name="connection">
|
|
The Bugstar connection to use when performing requests.
|
|
</param>
|
|
<param name="filename">
|
|
The file containing the contents to upload.
|
|
</param>
|
|
<returns>
|
|
The newly created attachment.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.AttachmentBuilder.ToAttachment(RSG.Interop.Bugstar.BugstarConnection,System.IO.Stream)">
|
|
<summary>
|
|
Returns a concrete Attachment object (commits attachment to server).
|
|
</summary>
|
|
<param name="connection">
|
|
The Bugstar connection to use when performing requests.
|
|
</param>
|
|
<param name="stream">
|
|
The data stream to upload.
|
|
</param>
|
|
<returns>
|
|
The newly created attachment.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.AttachmentBuilder.ToAttachmentAsync(RSG.Interop.Bugstar.BugstarConnection,System.String)">
|
|
<summary>
|
|
Returns a concrete Attachment object (commits attachment to server).
|
|
</summary>
|
|
<param name="connection">
|
|
The Bugstar connection to use when performing requests.
|
|
</param>
|
|
<param name="filename">
|
|
The file containing the contents to upload.
|
|
</param>
|
|
<returns>
|
|
The newly created attachment.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.AttachmentBuilder.ToAttachmentAsync(RSG.Interop.Bugstar.BugstarConnection,System.IO.Stream)">
|
|
<summary>
|
|
Returns a concrete Attachment object (commits attachment to server).
|
|
</summary>
|
|
<param name="connection">
|
|
The Bugstar connection to use when performing requests.
|
|
</param>
|
|
<param name="stream">
|
|
The data stream to upload.
|
|
</param>
|
|
<returns>
|
|
The newly created attachment.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.AttachmentBuilderException">
|
|
<summary>
|
|
AttachmentBuilder exception class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.AttachmentBuilderException.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.AttachmentBuilderException"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.AttachmentBuilderException.#ctor(System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.AttachmentBuilderException"/> class
|
|
using the specified message.
|
|
</summary>
|
|
<param name="message">
|
|
The error message that explains the reason for the exception.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.AttachmentBuilderException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.AttachmentBuilderException"/> class
|
|
using the specified message and inner exception.
|
|
</summary>
|
|
<param name="message">
|
|
The error message that explains the reason for the exception.
|
|
</param>
|
|
<param name="innerException">
|
|
The exception that is the cause of the current exception. If the innerException
|
|
parameter is not a null reference, the current exception is raised in a catch block
|
|
that handles the inner exception.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.AttachmentBuilderException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.AttachmentBuilderException"/> class
|
|
from serialised data.
|
|
</summary>
|
|
<param name="info">
|
|
The System.Runtime.Serialization.SerializationInfo that holds the serialised
|
|
object data about the exception being thrown.
|
|
</param>
|
|
<param name="context">
|
|
The System.Runtime.Serialization.StreamingContext that contains contextual
|
|
information about the source or destination.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.AttachmentInfo">
|
|
<summary>
|
|
Provides information about a single attachment to a bug.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.AttachmentInfo.#ctor(RSG.Interop.Bugstar.Bug,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.AttachmentInfo"/> class which is associated with the specified
|
|
bug.
|
|
</summary>
|
|
<param name="bug">
|
|
The bug the attachement information belongs to.
|
|
</param>
|
|
<param name="element">
|
|
The Xml element containing the attachment info data.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.AttachmentInfo.ContentType">
|
|
<summary>
|
|
Gets the type of content this attachment contains.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.AttachmentInfo.CreatedAt">
|
|
<summary>
|
|
Gets the timestamp relating to when the attachment was added to the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.AttachmentInfo.CreatedBy">
|
|
<summary>
|
|
Gets the actor corresponding to the user that created this attachment.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.AttachmentInfo.CreatedById">
|
|
<summary>
|
|
Gets the id of the user that created the attachment.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.AttachmentInfo.Id">
|
|
<summary>
|
|
Gets the attachements id.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.AttachmentInfo.IsArchived">
|
|
<summary>
|
|
Gets a value indicating whether the attachment has been archived.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.AttachmentInfo.Name">
|
|
<summary>
|
|
Gets the name of the attachment.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.AttachmentInfo.FileSize">
|
|
<summary>
|
|
Gets the size of the attachment in bytes.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.AttachmentInfo.DownloadAsync(System.IO.Stream)">
|
|
<summary>
|
|
Downloads the attachment placing the results into the supplied stream.
|
|
</summary>
|
|
<param name="stream">
|
|
The stream to download the attachment to.
|
|
</param>
|
|
<returns>
|
|
A task representing the asynchronous operation.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Attributes.BugstarDataAttribute">
|
|
<summary>
|
|
Attribute for specifying the Bugstar REST XML string for a field.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Attributes.BugstarDataAttribute.#ctor(System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Attributes.BugstarDataAttribute"/> using the
|
|
specified data name.
|
|
</summary>
|
|
<param name="dataName">
|
|
The name of the data the field is associated with.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Attributes.BugstarDataAttribute.Data">
|
|
<summary>
|
|
Gets the data name for the field.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Attributes.BugstarDataExtensions">
|
|
<summary>
|
|
Extension methods for Bugstar Data Attribute.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Attributes.BugstarDataExtensions.GetBugstarData(System.Enum)">
|
|
<summary>
|
|
Return Bugstar Data attribute value for an enum.
|
|
</summary>
|
|
<param name="value">
|
|
The enum value for which to retrieve the Bugstar data for.
|
|
</param>
|
|
<returns>
|
|
The Bugstar data associated with the specified enum value.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Attributes.BugstarDataExtensions.GetBugstarEnumFromString``1(System.String)">
|
|
<summary>
|
|
Return enum value for String.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of enum to search.
|
|
</typeparam>
|
|
<param name="value">
|
|
The Bugstar data value we are searching for.
|
|
</param>
|
|
<returns>
|
|
The enum value that has the specified value applied to it as an attribute.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
Thrown if the value is not found.
|
|
</exception>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Attributes.BugstarDataExtensions.TryGetBugstarEnumFromString``1(System.String,``0@)">
|
|
<summary>
|
|
Tries to get the enum value which has a Bugstar data attribute that matches the
|
|
specified value.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of enum to search.
|
|
</typeparam>
|
|
<param name="value">
|
|
The Bugstar data value we are searching for.
|
|
</param>
|
|
<param name="result">
|
|
The resulting enum value if it is found otherwise the default value.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if the string value is valid; otherwise <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Bug">
|
|
<summary>
|
|
Bugstar bug object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Bug.ActualTimeDefault">
|
|
<summary>
|
|
Actual time default in minutes.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Bug.EstimatedTimeDefault">
|
|
<summary>
|
|
Estimated time default in minutes (-1.0f is no estimate).
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Bug.SummaryCharacterLimit">
|
|
<summary>
|
|
Character limit for summary field.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Bug._projectId">
|
|
<summary>
|
|
Project Id for requested bug.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Bug._componentId">
|
|
<summary>
|
|
The id of the component this bug is assigned to.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Bug._ccList">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Interop.Bugstar.Bug.CCList"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Bug._ccListIds">
|
|
<summary>
|
|
The list of ids associated with cc's on this bug.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Bug._component">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Interop.Bugstar.Bug.Component"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Bug._developer">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Interop.Bugstar.Bug.Developer"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Bug._developerId">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Interop.Bugstar.Bug.DeveloperId"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Bug._emailNotification">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Interop.Bugstar.Bug.EmailNotification"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Bug._mission">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Interop.Bugstar.Bug.Mission"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Bug._missionId">
|
|
<summary>
|
|
The id of the mission this bug is a part of.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Bug._reviewer">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Interop.Bugstar.Bug.Reviewer"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Bug._reviewerId">
|
|
<summary>
|
|
The id of the review for this bug.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Bug._tester">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Interop.Bugstar.Bug.Tester"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Bug._testerId">
|
|
<summary>
|
|
The id of the tester this bug is assigned to.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Bug.#ctor(RSG.Interop.Bugstar.Organisation.Project)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Bug"/> class for the specified
|
|
project.
|
|
</summary>
|
|
<param name="project">
|
|
The project this bug is being created for.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Bug.#ctor(RSG.Interop.Bugstar.Organisation.Project,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Bug"/> class for the specified
|
|
project using the Xml element as the source of the bug content.
|
|
</summary>
|
|
<param name="project">
|
|
The project this bug is being created for.
|
|
</param>
|
|
<param name="xmlBugElem">
|
|
The Xml element containing the bug data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Bug.#ctor(RSG.Interop.Bugstar.Organisation.Project,System.Xml.Linq.XDocument)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Bug"/> class for the specified
|
|
project using the Xml document as the source of the bug content.
|
|
</summary>
|
|
<param name="project">
|
|
The project this bug is being created for.
|
|
</param>
|
|
<param name="xmlBugDocument">
|
|
The Xml document containing the bug data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Bug.#ctor(RSG.Interop.Bugstar.Organisation.Project,System.IO.Stream)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Bug"/> class for the specified
|
|
project using the stream as the source of the bug content.
|
|
</summary>
|
|
<param name="project">
|
|
The project this bug is being created for.
|
|
</param>
|
|
<param name="stream">
|
|
The stream containing the bug data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Bug.#ctor(RSG.Interop.Bugstar.Organisation.Project,RSG.Interop.Bugstar.BugCategory,System.String,System.String,System.UInt32,System.UInt32,System.UInt32,System.UInt32,System.UInt32,RSG.Interop.Bugstar.BugPriority,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.UInt32},System.Collections.Generic.IEnumerable{System.UInt32},System.Collections.Generic.IEnumerable{System.String},System.Single,System.Single,RSG.Interop.Bugstar.Workflow,System.Boolean)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Bug"/> class.
|
|
</summary>
|
|
<param name="project">
|
|
The project this bug is being created for.
|
|
</param>
|
|
<param name="summary">
|
|
The bugs summary.
|
|
</param>
|
|
<param name="description">
|
|
The bugs description.
|
|
</param>
|
|
<param name="developer">
|
|
The id of the developer the bug should be assigned to.
|
|
</param>
|
|
<param name="tester">
|
|
The id of the tester the bug should be assigned to.
|
|
</param>
|
|
<param name="reviewer">
|
|
The id of the reviewer the bug should be assigned to.
|
|
</param>
|
|
<param name="category">
|
|
The bugs category.
|
|
</param>
|
|
<param name="component">
|
|
The component to assign the bug to.
|
|
</param>
|
|
<param name="mission">
|
|
The mission to assign the bug to.
|
|
</param>
|
|
<param name="priority">
|
|
The bugs priority.
|
|
</param>
|
|
<param name="tags">
|
|
The list of tags to add to the bug.
|
|
</param>
|
|
<param name="cclist">
|
|
The list of user ids to add to the bugs cc list.
|
|
</param>
|
|
<param name="attachments">
|
|
The list of attachment ids to add to the bug.
|
|
</param>
|
|
<param name="comments">
|
|
The list of comments to add to the bug.
|
|
</param>
|
|
<param name="estimatedTime">
|
|
The estimated time for the bug in minutes.
|
|
</param>
|
|
<param name="actualTime">
|
|
The actual time spent on the bug in minutes.
|
|
</param>
|
|
<param name="workflow">
|
|
The bugs workflow type.
|
|
</param>
|
|
<param name="emailNotificiation">
|
|
Value indicating whether we should send email notifications for the bug.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.ActiveDeadline">
|
|
<summary>
|
|
Gets the active deadline name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.ActiveDeadlineStart">
|
|
<summary>
|
|
Gets the active deadline start date.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.ActiveDeadlineLockdown">
|
|
<summary>
|
|
Gets the active deadline submission lock down date.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.ActiveDeadlineSubmission">
|
|
<summary>
|
|
Gets the active deadline submission date.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.ActiveFrames">
|
|
<summary>
|
|
Gets the active frames for the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.ActualTime">
|
|
<summary>
|
|
Gets the estimated time for the bug (in minutes).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.AttachmentList">
|
|
<summary>
|
|
Gets the list of attachments for the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.Attempts">
|
|
<summary>
|
|
Gets the number of reproduciton attempts.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.Blockers">
|
|
<summary>
|
|
Gets the blockers associated with the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.Category">
|
|
<summary>
|
|
Gets the bugs category.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.Children">
|
|
<summary>
|
|
Gets the dependents associated with the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.ComponentId">
|
|
<summary>
|
|
Gets component Id.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.CCList">
|
|
<summary>
|
|
Gets the list of users on the bugs CC list.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.CCListIds">
|
|
<summary>
|
|
Gets the list of user Ids on the bugs CC list.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.Colour">
|
|
<summary>
|
|
Gets the bugs current colour in Bugstar.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.Comments">
|
|
<summary>
|
|
Gets the list of comments that are associated with the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.Component">
|
|
<summary>
|
|
Gets the component this bug is assigned to.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.CreatedBy">
|
|
<summary>
|
|
Gets the bug creator Id.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.CreatedOn">
|
|
<summary>
|
|
Gets the date the bug was created on.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.DeadlineList">
|
|
<summary>
|
|
Gets the list of deadlines for the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.Dependents">
|
|
<summary>
|
|
Gets the dependents associated with the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.Description">
|
|
<summary>
|
|
Gets the extended description of the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.Developer">
|
|
<summary>
|
|
Gets the developer this bug is assigned to.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.DeveloperId">
|
|
<summary>
|
|
Gets the ID of the developer this bug is assigned to.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.DueDate">
|
|
<summary>
|
|
Gets the due date for this bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.EmailNotification">
|
|
<summary>
|
|
Gets a value indicating whether email notification should be sent for
|
|
changes to this bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.EstimatedTime">
|
|
<summary>
|
|
Gets the estimated time for the bug (in minutes).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.FoundIn">
|
|
<summary>
|
|
Gets the build that the bug was found in.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.Grid">
|
|
<summary>
|
|
Gets the grid that the bug was found in.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.IsOnHold">
|
|
<summary>
|
|
Gets a value indicating whether the bug is currently on hold.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.IsOpen">
|
|
<summary>
|
|
Gets a value indicating whether this bug is considered to be open.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.IsWorking">
|
|
<summary>
|
|
Gets a value indicating whether this bug is currently being worked on.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.LastModifiedBy">
|
|
<summary>
|
|
Gets the Id of the user who last modifed the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.LastModifiedOn">
|
|
<summary>
|
|
Gets the time the bug was last modified.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.Location">
|
|
<summary>
|
|
Gets or sets the player location of the bug on the map.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.MapLocation">
|
|
<summary>
|
|
Gets the map location of the bug on the map.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.TimeOfDayHours">
|
|
<summary>
|
|
Gets the time of day hours in game for when the bug was logged.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.TimeOfDayMinutes">
|
|
<summary>
|
|
Gets the time of day minutes in game for when the bug was logged.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.MapId">
|
|
<summary>
|
|
Gets the Id of the Map the bug was found in.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.Mission">
|
|
<summary>
|
|
Gets the mission this bug is a part of.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.MissionId">
|
|
<summary>
|
|
Gets the mission Id.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.P4Changelists">
|
|
<summary>
|
|
Gets the P4 changelists associated with the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.PlatformIds">
|
|
<summary>
|
|
Gets the platform Ids associated with the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.ParentId">
|
|
<summary>
|
|
Gets the Id of the parent bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.Priority">
|
|
<summary>
|
|
Gets the priority of the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.Project">
|
|
<summary>
|
|
Gets the project this map is a part of.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.ProjectId">
|
|
<summary>
|
|
Gets the project Id for this bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.ReproductionRate">
|
|
<summary>
|
|
Gets the reproduction rate of the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.Query">
|
|
<summary>
|
|
Gets the query to use to query Bugstar about this object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.Reviewer">
|
|
<summary>
|
|
Gets the bug reviewer.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.ReviewerId">
|
|
<summary>
|
|
Gets the ID of the reviewer for this bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.State">
|
|
<summary>
|
|
Gets the current state of the bug (i.e. DEV, CLOSED_FIXED, etc...).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.Summary">
|
|
<summary>
|
|
Gets the bug's summary.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.Tags">
|
|
<summary>
|
|
Gets the list of tags associated with this bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.Tester">
|
|
<summary>
|
|
Gets the tester for thsi bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.TesterId">
|
|
<summary>
|
|
Gets the ID of the tester for this bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.Verifications">
|
|
<summary>
|
|
Gets the number of verified reproductions on the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Bug.Workflow">
|
|
<summary>
|
|
Gets the workflow for the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Bug.Attach(RSG.Interop.Bugstar.Bug,RSG.Interop.Bugstar.Attachment)">
|
|
<summary>
|
|
Add an attachment to a bug.
|
|
</summary>
|
|
<param name="bug">
|
|
The bug to add the attachment to.
|
|
</param>
|
|
<param name="attachment">
|
|
The attachement to add.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if the attachment was successfully added; otherwise <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Bug.GetBugById(RSG.Interop.Bugstar.Organisation.Project,System.UInt32)">
|
|
<summary>
|
|
Gets a bug for a particular project based on the bug's id.
|
|
</summary>
|
|
<param name="project">
|
|
The project the bug is a part of.
|
|
</param>
|
|
<param name="id">
|
|
The id of the bug.
|
|
</param>
|
|
<returns>
|
|
The bug object if we were able to retrieve it; otherwise <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Bug.GetBugByIdAsync(RSG.Interop.Bugstar.Organisation.Project,System.UInt32)">
|
|
<summary>
|
|
Gets a bug for a particular project based on the bug's id.
|
|
</summary>
|
|
<param name="project">
|
|
The project the bug is a part of.
|
|
</param>
|
|
<param name="id">
|
|
The id of the bug.
|
|
</param>
|
|
<returns>
|
|
The task object representing the asynchronous operation.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Bug.GetAttachmentInfoAsync">
|
|
<summary>
|
|
Gets the attachment information for this bug.
|
|
</summary>
|
|
<returns>
|
|
The attachment information associated with this bug.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Bug.GetTimeRecords">
|
|
<summary>
|
|
Gets a list of all time records for this bug.
|
|
</summary>
|
|
<returns>
|
|
The time records for this bug.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Bug.Refresh">
|
|
<summary>
|
|
Refresh bug's content.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Bug.Serialise">
|
|
<summary>
|
|
Serialises bug to its XML representation.
|
|
</summary>
|
|
<returns>
|
|
The Xml representation of this bug.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Bug.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Generates an object from its XML representation.
|
|
</summary>
|
|
<param name="xmlBugElem">
|
|
The Xml element containing the bugs data.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.BugAction">
|
|
<summary>
|
|
Defines the various actions you can perform on a bug.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugAction.Resolve">
|
|
<summary>
|
|
Resolves the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugAction.Version">
|
|
<summary>
|
|
Don't know.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugAction.Waive">
|
|
<summary>
|
|
Waive the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugAction.MarkAsDuplicate">
|
|
<summary>
|
|
Marks the bug as a duplicate of another.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugAction.MarkAsNotSeen">
|
|
<summary>
|
|
Marks the bug as not seen.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugAction.RequestMoreInfo">
|
|
<summary>
|
|
Sends the bug back to the QA owner for more information.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugAction.MarkAsNotInBuild">
|
|
<summary>
|
|
Puts th bug back to the resolved state after it's been marked to be verified but
|
|
isn't in the latest build.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugAction.Close">
|
|
<summary>
|
|
Closes a bug.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugAction.Reopen">
|
|
<summary>
|
|
Reopens a bug.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugAction.Initiate">
|
|
<summary>
|
|
Don't know.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugAction.Postpone">
|
|
<summary>
|
|
Don't know.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.BugActionUtils">
|
|
<summary>
|
|
Common methods for the <see cref="T:RSG.Interop.Bugstar.BugAction"/> enumeration.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugActionUtils.ToBugstarAction(RSG.Interop.Bugstar.BugAction)">
|
|
<summary>
|
|
Converts a <see cref="T:RSG.Interop.Bugstar.BugAction"/> enum value to it's Bugstar string
|
|
representation.
|
|
</summary>
|
|
<param name="action">
|
|
The enum value to convert.
|
|
</param>
|
|
<returns>
|
|
The string representation of the enum value.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.BugBuilder">
|
|
<summary>
|
|
Bug object builder class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugBuilder.#ctor(RSG.Interop.Bugstar.Organisation.Project)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.BugBuilder"/> class which can create
|
|
a bug for the specified project.
|
|
</summary>
|
|
<param name="project">
|
|
The project the bug will be added to.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugBuilder.#ctor(RSG.Interop.Bugstar.Organisation.Project,RSG.Interop.Bugstar.Bug)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.BugBuilder"/> class using an existing <see cref="T:RSG.Interop.Bugstar.Bug"/> which can create
|
|
a bug for the specified project.
|
|
</summary>
|
|
<param name="project">
|
|
The project the bug will be added to.
|
|
</param>
|
|
<param name="bug">
|
|
The bug to copy values from.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.Id">
|
|
<summary>
|
|
Gets or sets the bug Id.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.ActualTime">
|
|
<summary>
|
|
Gets or sets the actual time duration (in minutes).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.Project">
|
|
<summary>
|
|
Gets the project this bug is a part of.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.Category">
|
|
<summary>
|
|
Gets or sets the category of the bug (A, B, C, D, TODO, ...).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.Summary">
|
|
<summary>
|
|
Gets or sets the bug's summary.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.Description">
|
|
<summary>
|
|
Gets or sets the bugs description.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.DeveloperId">
|
|
<summary>
|
|
Gets or sets the id of the developer this bug is assigned to.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.TesterId">
|
|
<summary>
|
|
Gets or sets the id of the tester this bug is assigned to.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.ReviewerId">
|
|
<summary>
|
|
Gets or sets the id of the reviewer of this bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.State">
|
|
<summary>
|
|
Gets or sets the state of the bug (i.e. DEV, CLOSED_FIXED, etc...).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.Priority">
|
|
<summary>
|
|
Gets or sets the priority of the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.Location">
|
|
<summary>
|
|
Gets or sets the location of the bug on the map.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.MapLocation">
|
|
<summary>
|
|
Gets or sets the map location of the bug on the map.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.TimeOfDayHours">
|
|
<summary>
|
|
Gets or sets the time of day hours in game for when the bug was logged.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.TimeOfDayMinutes">
|
|
<summary>
|
|
Gets or sets the time of day minutes in game for when the bug was logged.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.MissionId">
|
|
<summary>
|
|
Gets or sets the mission this bug is a part of.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.ComponentId">
|
|
<summary>
|
|
Gets or sets the component this bug is in.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.DueDate">
|
|
<summary>
|
|
Gets or sets when the bug is due by.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.Grid">
|
|
<summary>
|
|
Gets or sets the grid that the bug was reported.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.CCList">
|
|
<summary>
|
|
Gets or sets the collection of user Ids CC'd to bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.Tags">
|
|
<summary>
|
|
Gets or sets the collection of tags assigned to bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.Attachments">
|
|
<summary>
|
|
Gets the collection of attachments associated with bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.Comments">
|
|
<summary>
|
|
Gets the collection of comments associated with bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.EstimatedTime">
|
|
<summary>
|
|
Gets or sets the estimated duration (in minutes).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.Workflow">
|
|
<summary>
|
|
Gets or sets the bugs workflow.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.SendEmail">
|
|
<summary>
|
|
Gets or sets a value indicating whether emails should be generated for the bug when
|
|
it is created.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.ActiveFrames">
|
|
<summary>
|
|
Gets or sets the active frames.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.Attempts">
|
|
<summary>
|
|
Gets or sets the attempts.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.FoundIn">
|
|
<summary>
|
|
Gets or sets the found in build ID.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.Map">
|
|
<summary>
|
|
Gets or sets the map ID.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.ReproductionRate">
|
|
<summary>
|
|
Gets or sets the reproduction rate.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.Verifications">
|
|
<summary>
|
|
Gets or sets the number of verifications.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.P4Changelists">
|
|
<summary>
|
|
Gets or sets the p4 changelists associated with the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.PlatformIds">
|
|
<summary>
|
|
Gets or sets the collection of platform IDs associated with bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugBuilder.DeadlineIds">
|
|
<summary>
|
|
Gets or sets the collection of platform IDs associated with bug.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugBuilder.ToBug(RSG.Interop.Bugstar.BugstarConnection)">
|
|
<summary>
|
|
Return a concrete Bug object (commits bug to server).
|
|
</summary>
|
|
<param name="connection">
|
|
The Bugstar connection to use when creating the bug.
|
|
</param>
|
|
<returns>
|
|
The bug object for the successfully created bug; or <c>null</c> if the bug couldn't
|
|
be created.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugBuilder.ToBug">
|
|
<summary>
|
|
Return a concrete Bug object (DOES NOT commit bug to server).
|
|
</summary>
|
|
<returns>
|
|
The bug object for the successfully created bug; or <c>null</c> if the bug couldn't
|
|
be created.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.BugBuilderException">
|
|
<summary>
|
|
BugBuilder exception class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugBuilderException.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.BugBuilderException"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugBuilderException.#ctor(System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.BugBuilderException"/> class
|
|
using the specified message.
|
|
</summary>
|
|
<param name="message">
|
|
The error message that explains the reason for the exception.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugBuilderException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.BugBuilderException"/> class
|
|
using the specified message and inner exception.
|
|
</summary>
|
|
<param name="message">
|
|
The error message that explains the reason for the exception.
|
|
</param>
|
|
<param name="innerException">
|
|
The exception that is the cause of the current exception. If the innerException
|
|
parameter is not a null reference, the current exception is raised in a catch block
|
|
that handles the inner exception.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugBuilderException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.BugBuilderException"/> class
|
|
from serialised data.
|
|
</summary>
|
|
<param name="info">
|
|
The System.Runtime.Serialization.SerializationInfo that holds the serialised
|
|
object data about the exception being thrown.
|
|
</param>
|
|
<param name="context">
|
|
The System.Runtime.Serialization.StreamingContext that contains contextual
|
|
information about the source or destination.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.BugCategory">
|
|
<summary>
|
|
Enumeration for Bug class.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugCategory.A">
|
|
<summary>
|
|
A class bug.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugCategory.B">
|
|
<summary>
|
|
B class bug.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugCategory.C">
|
|
<summary>
|
|
C class bug.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugCategory.D">
|
|
<summary>
|
|
D class bug.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugCategory.Task">
|
|
<summary>
|
|
Bug is a larger task.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugCategory.Todo">
|
|
<summary>
|
|
Todo.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugCategory.Track">
|
|
<summary>
|
|
Tracker bug.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugCategory.Wish">
|
|
<summary>
|
|
Wish.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.BugCategoryUtils">
|
|
<summary>
|
|
BugCategory enum extension and utility methods.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugCategoryUtils.FromBugstarString(System.String)">
|
|
<summary>
|
|
Attempts to convert a string to its corresponding <see cref="T:RSG.Interop.Bugstar.BugCategory"/> enum
|
|
value.
|
|
</summary>
|
|
<param name="data">
|
|
The string representation of the enum value.
|
|
</param>
|
|
<returns>
|
|
The <see cref="T:RSG.Interop.Bugstar.BugCategory"/> for the string; or <see cref="F:RSG.Interop.Bugstar.BugCategory.C"/> if the
|
|
string is not recognised.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugCategoryUtils.ToBugstarString(RSG.Interop.Bugstar.BugCategory)">
|
|
<summary>
|
|
Converts a <see cref="T:RSG.Interop.Bugstar.BugCategory"/> enum value to it's Bugstar string
|
|
representation.
|
|
</summary>
|
|
<param name="category">
|
|
The enum value to convert.
|
|
</param>
|
|
<returns>
|
|
The string representation of the enum value.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.BugComment">
|
|
<summary>
|
|
Bugstar Bug comment object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugComment._creator">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Interop.Bugstar.BugComment.Creator"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugComment._creatorId">
|
|
<summary>
|
|
The id of the user that created this comment.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugComment._createdAt">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Interop.Bugstar.BugComment.CreatedAt"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugComment.#ctor(RSG.Interop.Bugstar.Organisation.Project,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.BugComment"/> class for the specified
|
|
project using the Xml element as the source of the comment content.
|
|
</summary>
|
|
<param name="project">
|
|
The project this map is being created for.
|
|
</param>
|
|
<param name="xmlCommentElem">
|
|
The Xml element containing the comment data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugComment.#ctor(RSG.Interop.Bugstar.Organisation.Project,System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.BugComment"/> class for the specified
|
|
project using the specified text as the comments content.
|
|
</summary>
|
|
<param name="project">
|
|
The project this map is being created for.
|
|
</param>
|
|
<param name="text">
|
|
The text to use for the comment.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugComment.Project">
|
|
<summary>
|
|
Gets or sets the project the bug this comment is a part of.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugComment.Text">
|
|
<summary>
|
|
Gets the comments text.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugComment.CreatedAt">
|
|
<summary>
|
|
Gets the timestamp when comment was created.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugComment.CreatorID">
|
|
<summary>
|
|
Gets the id of the user who created the comment.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugComment.Creator">
|
|
<summary>
|
|
Gets the user who created comment.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugComment.Serialise">
|
|
<summary>
|
|
Serialises this comment to its XML representation.
|
|
</summary>
|
|
<returns>
|
|
The Xml representation of this comment.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugComment.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Generates an object from its XML representation.
|
|
</summary>
|
|
<param name="xmlCommentElem">
|
|
The Xml element containing the comments data.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.BugField">
|
|
<summary>
|
|
Bug fields that we can query data for via the REST interface.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugField.Id">
|
|
<summary>
|
|
Id field.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugField.Summary">
|
|
<summary>
|
|
Summary field.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugField.Description">
|
|
<summary>
|
|
Description field.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugField.Grid">
|
|
<summary>
|
|
Map grid.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugField.Location">
|
|
<summary>
|
|
Coordinates on the map.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugField.MapLocation">
|
|
<summary>
|
|
Camera orientation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugField.TimeOfDay">
|
|
<summary>
|
|
Time of day.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugField.State">
|
|
<summary>
|
|
Bug status.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugField.Developer">
|
|
<summary>
|
|
Bug Developer
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugField.Priority">
|
|
<summary>
|
|
Bug Developer
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugField.Category">
|
|
<summary>
|
|
Bug Developer
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugField.QAOwner">
|
|
<summary>
|
|
Bug QA Owner
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugField.EstimatedTime">
|
|
<summary>
|
|
Estimated time on a bug,
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugField.ActualTime">
|
|
<summary>
|
|
Actual time logged on a bug,
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugField.TagList">
|
|
<summary>
|
|
Tags on a bug,
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.BugPriority">
|
|
<summary>
|
|
Enumeration for Bug priority.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugPriority.High">
|
|
<summary>
|
|
Priority 1; the highest bug priority.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugPriority.P2">
|
|
<summary>
|
|
Priority 2.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugPriority.P3">
|
|
<summary>
|
|
Priority 3.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugPriority.P4">
|
|
<summary>
|
|
Priority 4.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugPriority.Low">
|
|
<summary>
|
|
Priority 5; the lowest bug priority.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.BugPriorityUtils">
|
|
<summary>
|
|
BugPriority enum extension and utility methods.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugPriorityUtils.FromBugstarString(System.String)">
|
|
<summary>
|
|
Attempts to convert a string to its corresponding <see cref="T:RSG.Interop.Bugstar.BugPriority"/> enum
|
|
value.
|
|
</summary>
|
|
<param name="data">
|
|
The string representation of the enum value.
|
|
</param>
|
|
<returns>
|
|
The <see cref="T:RSG.Interop.Bugstar.BugPriority"/> for the string; or <see cref="F:RSG.Interop.Bugstar.BugPriority.P3"/> if
|
|
the string is not recognised.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugPriorityUtils.ToBugstarString(RSG.Interop.Bugstar.BugPriority)">
|
|
<summary>
|
|
Converts a <see cref="T:RSG.Interop.Bugstar.BugPriority"/> enum value to it's Bugstar string
|
|
representation.
|
|
</summary>
|
|
<param name="priority">
|
|
The enum value to convert.
|
|
</param>
|
|
<returns>
|
|
The string representation of the enum value.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.BugstarBuild">
|
|
<summary>
|
|
Bugstar Build object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarBuild.#ctor(RSG.Interop.Bugstar.BugstarConnection)">
|
|
<summary>
|
|
Creates a new Bugstar build.
|
|
</summary>
|
|
<param name="connection">
|
|
The connection object required to communicate with Bugstar
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarBuild.#ctor(RSG.Interop.Bugstar.BugstarConnection,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Creates a new Bugstar build using an xml element.
|
|
</summary>
|
|
<param name="connection">
|
|
The connection object required to communicate with Bugstar
|
|
</param>
|
|
<param name="buildElement">
|
|
An XElement holding all of the information for a build object
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarBuild.#ctor(RSG.Interop.Bugstar.Organisation.Project,System.String,System.DateTime,System.String,System.UInt32)">
|
|
<summary>
|
|
Creates a new Bugstar build by passing in all fields.
|
|
</summary>
|
|
<param name="buildDate">
|
|
The date and time this build was created
|
|
</param>
|
|
<param name="buildInfo">
|
|
Additional text information about this build.
|
|
</param>
|
|
<param name="buildName">
|
|
The name that will be shown when this build is referenced in Bugstar
|
|
</param>
|
|
<param name="project">
|
|
The project that holds our connection required to communicate with Bugstar
|
|
</param>
|
|
<param name="platformId">
|
|
The ID corresponding to the platform this build is built for
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugstarBuild.BuildName">
|
|
<summary>
|
|
Gets or sets name used to identify the build.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugstarBuild.BuildDate">
|
|
<summary>
|
|
Gets or sets date that the build is created.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugstarBuild.BuildInfo">
|
|
<summary>
|
|
Gets or sets a short description of the build.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugstarBuild.PlatformId">
|
|
<summary>
|
|
Gets or sets the platform that this build is attached to.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugstarBuild.Project">
|
|
<summary>
|
|
Gets the project this is a part of.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugstarBuild.Query">
|
|
<summary>
|
|
Gets the query to use to query Bugstar about this object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarBuild.GetBuilds(RSG.Interop.Bugstar.Organisation.Project)">
|
|
<summary>
|
|
Return all builds for the project.
|
|
</summary>
|
|
<param name="project">The project</param>
|
|
<returns>The list of all builds for the project</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarBuild.GetBuildByName(RSG.Interop.Bugstar.Organisation.Project,System.String)">
|
|
<summary>
|
|
Return a specific build by name for the project.
|
|
</summary>
|
|
<param name="project">The project</param>
|
|
<param name="name">The build's name</param>
|
|
<returns>Matching build.</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarBuild.Serialise">
|
|
<summary>
|
|
Serializes build to its XML representation.
|
|
</summary>
|
|
<returns>
|
|
The Xml representation of this build.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarBuild.SerialiseIntoElement">
|
|
<summary>
|
|
Serializes build to its XML representation.
|
|
</summary>
|
|
<returns>
|
|
The Xml representation of this build.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarBuild.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Generates an object from its XML representation.
|
|
</summary>
|
|
<param name="xmlBuildElement">
|
|
The Xml element containing the build data.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.BugstarException">
|
|
<summary>
|
|
Class for wrapping any exceptions that the Bugstar interop library throws.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarException.#ctor(System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.BugstarException"/> class using
|
|
the specified message.
|
|
</summary>
|
|
<param name="message">
|
|
The error message that explains the reason for the exception.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.BugstarException"/> class using
|
|
the specified message and inner exception.
|
|
</summary>
|
|
<param name="message">
|
|
The error message that explains the reason for the exception.
|
|
</param>
|
|
<param name="innerException">
|
|
The exception that is the cause of the current exception. If the innerException
|
|
parameter is not a null reference, the current exception is raised in a catch block
|
|
that handles the inner exception.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.BugstarHelper">
|
|
<summary>
|
|
Contains common utility methods related to Bugstar.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarHelper.GetBug(RSG.Interop.Bugstar.BugstarConnection,RSG.Interop.Bugstar.Organisation.Project,System.UInt32)">
|
|
<summary>
|
|
Given an ID, returns the contents of the bug.
|
|
</summary>
|
|
<param name="connection">
|
|
The connection to use while performing the query.
|
|
</param>
|
|
<param name="project">
|
|
The project the bug is a part of.
|
|
</param>
|
|
<param name="bugId">
|
|
The id of the bug we wish to retrieve.
|
|
</param>
|
|
<returns>
|
|
The bug if it exists; otherwise <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarHelper.GetAssertIDFromBug(RSG.Interop.Bugstar.BugstarConnection,RSG.Interop.Bugstar.Organisation.Project,System.UInt32,System.Int64@)">
|
|
<summary>
|
|
Queries B* to get the information of a bug's asert ID information.
|
|
This information will only exist for assert bugs created through automated methods from the game.
|
|
Example payload:
|
|
<GameAssert bugId="3106722">
|
|
<assertId>1862743498</assertId>
|
|
<secondaryId>1724385317</secondaryId>
|
|
<secondaryId>3356144601</secondaryId>
|
|
</GameAssert>
|
|
</summary>
|
|
<param name="connection">B* connection</param>
|
|
<param name="project">project to fix up URL</param>
|
|
<param name="bugID">bug to investigate</param>
|
|
<param name="assertID">output assert ID</param>
|
|
<returns>indicates whether this bug had assertID information</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarHelper.IsBugOpen(RSG.Interop.Bugstar.BugstarConnection,RSG.Interop.Bugstar.Organisation.Project,System.UInt32)">
|
|
<summary>
|
|
Checks if a bug is open, or in "Dev" state.
|
|
</summary>
|
|
<param name="connection">
|
|
The connection to use while performing the query.
|
|
</param>
|
|
<param name="project">
|
|
The project the bug is a part of.
|
|
</param>
|
|
<param name="bugId">
|
|
The id of the bug we wish to check.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if the bug is open; otherwise <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarHelper.FindBugIdsWithText(RSG.Interop.Bugstar.BugstarConnection,RSG.Interop.Bugstar.Organisation.Project,System.String,System.Boolean)">
|
|
<summary>
|
|
Searches through the Bugstar database and returns a list of bugs which contain the
|
|
specified text.
|
|
</summary>
|
|
<param name="connection">
|
|
The connection to use while performing the query.
|
|
</param>
|
|
<param name="project">
|
|
The project the bugs are a part of.
|
|
</param>
|
|
<param name="searchText">
|
|
The text to search for.
|
|
</param>
|
|
<param name="escapeSpecialChars">
|
|
Whether to escape special character, default false
|
|
</param>
|
|
<returns>
|
|
The list of bug ids that were found.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarHelper.GetUserID(RSG.Interop.Bugstar.BugstarConnection,RSG.Interop.Bugstar.Organisation.Project,System.String)">
|
|
<summary>
|
|
Searches through the Bugstar database and returns the user ID that matches the provided username, or null if not found
|
|
</summary>
|
|
<param name="connection">
|
|
The connection to use while performing the query.
|
|
</param>
|
|
<param name="project">
|
|
The project the bugs are a part of.
|
|
</param>
|
|
<param name="username">
|
|
The username to seach for.
|
|
</param>
|
|
<returns>
|
|
The user ID, or null if not found
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarHelper.EditBugData(RSG.Interop.Bugstar.BugstarConnection,RSG.Interop.Bugstar.Organisation.Project,System.UInt32,System.String,System.String,System.Boolean)">
|
|
<summary>
|
|
Edits the contents of a bug.
|
|
</summary>
|
|
<param name="connection">
|
|
The connection to use while performing the query.
|
|
</param>
|
|
<param name="project">
|
|
The project the bug is a part of.
|
|
</param>
|
|
<param name="bugId">
|
|
The id of the bug we wish to edit.
|
|
</param>
|
|
<param name="field">
|
|
The field to edit.
|
|
</param>
|
|
<param name="value">
|
|
The value to set.
|
|
</param>
|
|
<param name="append">
|
|
Whether to append the <paramref name="value"/> to the existing value.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if the bug was successfully edited; otherwise <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarHelper.PerformBugAction(RSG.Interop.Bugstar.BugstarConnection,RSG.Interop.Bugstar.Organisation.Project,System.UInt32,RSG.Interop.Bugstar.BugAction)">
|
|
<summary>
|
|
Performs action on a bug.
|
|
</summary>
|
|
<param name="connection">
|
|
The connection to use while performing the query.
|
|
</param>
|
|
<param name="project">
|
|
The project the bug is a part of.
|
|
</param>
|
|
<param name="bugId">
|
|
The id of the bug we wish to perform an action on.
|
|
</param>
|
|
<param name="action">
|
|
The action to perform.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if the bug was successfully edited; otherwise <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarHelper.AddComment(RSG.Interop.Bugstar.BugstarConnection,RSG.Interop.Bugstar.Organisation.Project,System.UInt32,System.String)">
|
|
<summary>
|
|
Adds comment to the bug
|
|
</summary>
|
|
<param name="connection">
|
|
The connection to use while performing the query.
|
|
</param>
|
|
<param name="project">
|
|
The project the bug is a part of.
|
|
</param>
|
|
<param name="bugId">
|
|
The id of the bug we wish to add a comment to.
|
|
</param>
|
|
<param name="comment">
|
|
The text to add as a comment.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if the bug was successfully edited; otherwise <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarHelper.SetMission(RSG.Interop.Bugstar.BugstarConnection,RSG.Interop.Bugstar.Organisation.Project,System.UInt32,System.UInt32,System.Boolean)">
|
|
<summary>
|
|
Sets mission to the bug
|
|
</summary>
|
|
<param name="connection">
|
|
The connection to use while performing the query.
|
|
</param>
|
|
<param name="project">
|
|
The project the bug is a part of.
|
|
</param>
|
|
<param name="bugId">
|
|
The id of the bug we wish to add a comment to.
|
|
</param>
|
|
<param name="missionId">
|
|
The mission id
|
|
</param>
|
|
<param name="emailNotification">send email notification?</param>
|
|
<returns>
|
|
<c>true</c> if the bug was successfully edited; otherwise <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarHelper.SetDependency(RSG.Interop.Bugstar.BugstarConnection,RSG.Interop.Bugstar.Organisation.Project,System.Collections.Generic.List{System.UInt32},System.Collections.Generic.List{System.UInt32},System.String,System.Boolean,RSG.Interop.Bugstar.Dependencies.DependencyClosedState)">
|
|
<summary>
|
|
Adds a list of blockers to a list of dependents.
|
|
</summary>
|
|
<param name="connection">
|
|
The connection to use while performing the query.
|
|
</param>
|
|
<param name="project">
|
|
The project the bug is a part of.
|
|
</param>
|
|
<param name="dependents">
|
|
the list of dependent bugs.
|
|
</param>
|
|
<param name="blockers">
|
|
The list of blocker bugs.
|
|
</param>
|
|
<param name="comment">
|
|
The comment to add when adding the dependencies.
|
|
</param>
|
|
<param name="emailNotification">
|
|
Value indicating whether email notifications should be sent for this modification.
|
|
</param>
|
|
<param name="dependencyClosedState">
|
|
Defines when to update a dependent bug when the blocker is closed.</param>
|
|
<returns>
|
|
<c>true</c> if the dependency was successfully added; otherwise <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarHelper.SetParentChild(RSG.Interop.Bugstar.BugstarConnection,RSG.Interop.Bugstar.Organisation.Project,RSG.Interop.Bugstar.Hierarchy.ParentChildUpdateAction,RSG.Interop.Bugstar.Bug,System.Collections.Generic.List{RSG.Interop.Bugstar.Bug},System.String,System.Boolean)">
|
|
<summary>
|
|
Adds a parent child relationship returning the success of the operation.
|
|
</summary>
|
|
<param name="connection">
|
|
The connection to use while performing the query.
|
|
</param>
|
|
<param name="project">
|
|
The project the bug is a part of.
|
|
</param>
|
|
<param name="action">
|
|
The parent child update action to perform.
|
|
</param>
|
|
<param name="parent">
|
|
The parent bug.
|
|
</param>
|
|
<param name="children">
|
|
The child bugs.
|
|
</param>
|
|
<param name="comment">
|
|
The comment to add when adding the relationship.
|
|
</param>
|
|
<param name="emailNotification">
|
|
Value indicating whether email notifications should be sent for this modification.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if the parent child relationship was successfully added; otherwise
|
|
<c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarHelper.SetParentChild(RSG.Interop.Bugstar.BugstarConnection,RSG.Interop.Bugstar.Organisation.Project,RSG.Interop.Bugstar.Hierarchy.ParentChildUpdateAction,System.UInt32,System.Collections.Generic.List{System.UInt32},System.String)">
|
|
<summary>
|
|
Adds a parent child relationship returning the success of the operation.
|
|
</summary>
|
|
<param name="connection">
|
|
The connection to use while performing the query.
|
|
</param>
|
|
<param name="project">
|
|
The project the bug is a part of.
|
|
</param>
|
|
<param name="action">
|
|
The parent child update action to perform.
|
|
</param>
|
|
<param name="parentId">
|
|
The id of the parent bug.
|
|
</param>
|
|
<param name="childIds">
|
|
The ids of child bugs.
|
|
</param>
|
|
<param name="comment">
|
|
The comment to add when adding the relationship.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if the parent child relationship was successfully added; otherwise
|
|
<c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarHelper.AddBlockers(RSG.Interop.Bugstar.BugstarConnection,RSG.Interop.Bugstar.Organisation.Project,System.UInt32,System.Collections.Generic.List{System.UInt32},System.String,System.Boolean,RSG.Interop.Bugstar.Dependencies.DependencyClosedState)">
|
|
<summary>
|
|
Adds a list of blockers to the specified bug returning the success of the
|
|
operation.
|
|
</summary>
|
|
<param name="connection">
|
|
The connection to use while performing the query.
|
|
</param>
|
|
<param name="project">
|
|
The project the bug is a part of.
|
|
</param>
|
|
<param name="dependent">
|
|
The bug id of the dependent bug.
|
|
</param>
|
|
<param name="blockers">
|
|
The list of bug ids of the blockers.
|
|
</param>
|
|
<param name="comment">
|
|
The comment to add when adding the dependency.
|
|
</param>
|
|
<param name="emailNotification">
|
|
value indicating if email notification is sent</param>
|
|
<param name="dependencyClosedState">
|
|
set when the blocked bug (dependent) will be opened
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if the blockers were successfully added; otherwise <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarHelper.AddTags(RSG.Interop.Bugstar.BugstarConnection,RSG.Interop.Bugstar.Organisation.Project,System.UInt32,System.Collections.Generic.IEnumerable{System.String},System.Boolean)">
|
|
<summary>
|
|
Adds tag to the bug
|
|
</summary>
|
|
<param name="connection">
|
|
The connection to use while performing the query.
|
|
</param>
|
|
<param name="project">
|
|
The project the bug is a part of.
|
|
</param>
|
|
<param name="bugId">
|
|
The id of the bug we wish to add a comment to.
|
|
</param>
|
|
<param name="tags">
|
|
tags to add
|
|
</param>
|
|
<param name="emailNotification">send email notification?</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarHelper.RemoveTags(RSG.Interop.Bugstar.BugstarConnection,RSG.Interop.Bugstar.Organisation.Project,System.UInt32,System.Collections.Generic.IEnumerable{System.String},System.Boolean)">
|
|
<summary>
|
|
Removes tags from bug
|
|
</summary>
|
|
<param name="connection">
|
|
The connection to use while performing the query.
|
|
</param>
|
|
<param name="project">
|
|
The project the bug is a part of.
|
|
</param>
|
|
<param name="bugId">
|
|
The id of the bug we wish to add a comment to.
|
|
</param>
|
|
<param name="tags">
|
|
tags to add
|
|
</param>
|
|
<param name="emailNotification">send email notification?</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarHelper.AddChangelists(RSG.Interop.Bugstar.BugstarConnection,RSG.Interop.Bugstar.Organisation.Project,System.UInt32,System.Collections.Generic.IEnumerable{System.UInt32},System.Boolean)">
|
|
<summary>
|
|
Add changelists to bug
|
|
</summary>
|
|
<param name="connection">the bugstar connection</param>
|
|
<param name="project">the project</param>
|
|
<param name="bugId">the bug number</param>
|
|
<param name="changelists">changelists to add to the bug</param>
|
|
<param name="emailNotification">send email notification (defaults to false)</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarHelper.AddGameAssert(RSG.Interop.Bugstar.BugstarConnection,RSG.Interop.Bugstar.Organisation.Project,System.UInt32,RSG.Interop.Bugstar.Asserts.GameAssertType,System.Int64,System.Collections.Generic.IEnumerable{System.Int64})">
|
|
<summary>
|
|
Adds a GameAssert to a bug
|
|
</summary>
|
|
<param name="connection">
|
|
The connection to use while performing the query.
|
|
</param>
|
|
<param name="project">
|
|
The project the bug is a part of.
|
|
</param>
|
|
<param name="bugId">
|
|
The id of the bug we wish to add the assert to
|
|
</param>
|
|
<param name="assertType">
|
|
Indiates what type of assert it is.
|
|
</param>
|
|
<param name="assertId">
|
|
The id of the assert we wish to add to the bug
|
|
</param>
|
|
<param name="secondaryAssertIds">
|
|
List of secondary ids
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if the bug was successfully edited; otherwise <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarHelper.GetGameAssertByID(RSG.Interop.Bugstar.BugstarConnection,RSG.Interop.Bugstar.Organisation.Project,System.Int64,RSG.Interop.Bugstar.Asserts.GameAssertType)">
|
|
<summary>
|
|
Gets a GameAssert from a given assert ID
|
|
</summary>
|
|
<param name="connection">
|
|
The connection to use while performing the query.
|
|
</param>
|
|
<param name="project">
|
|
The project the bug is a part of.
|
|
</param>
|
|
<param name="assertId">
|
|
The id of the assert we wish to get
|
|
</param>
|
|
<param name="assertType">
|
|
Optional assert type, defaults to runtime assert
|
|
</param>
|
|
<returns>
|
|
Game Assert of the ID given
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarHelper.AddTime(RSG.Interop.Bugstar.BugstarConnection,RSG.Interop.Bugstar.Organisation.Project,System.UInt32,System.UInt32,RSG.Interop.Bugstar.TimeType,System.String,System.Nullable{System.UInt32},System.Nullable{System.UInt32})">
|
|
<summary>
|
|
Adds time to a bug
|
|
</summary>
|
|
<param name="connection">The connection to use while performing the query.</param>
|
|
<param name="project">The project the bug is a part of.</param>
|
|
<param name="bugId">The id of the bug we wish to add time to</param>
|
|
<param name="timeInMinutes"> The time in minutes attributed to the bug (float)</param>
|
|
<param name="timeType"> The type of time attributed to the bug (Work, Rework, Exporting, Tools Issue, Build Issue, Support)</param>
|
|
<param name="comment">The text of the comment.</param>
|
|
<param name="attributeTimeToId">The id of the user you wish to attribute the time record to. If you are not logged in as an admin you are only allowed to add time to your own userid.</param>
|
|
<param name="attachemntId">The id of an already uploaded attachment to affix to the time record.</param>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.BugstarQueryBuilder">
|
|
<summary>
|
|
Utility class to create immutable BugstarQuery objects.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarQueryBuilder.#ctor(RSG.Base.Net.IRestQuery)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.BugstarQueryBuilder"/> class
|
|
using the provided base query.
|
|
</summary>
|
|
<param name="baseQuery">
|
|
The base query to use.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarQueryBuilder.#ctor(System.Uri)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.BugstarQueryBuilder"/> class
|
|
using the provided base query.
|
|
</summary>
|
|
<param name="baseQuery">
|
|
The base query to use.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugstarQueryBuilder.BaseQuery">
|
|
<summary>
|
|
Gets the base query we are building a query for.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugstarQueryBuilder.RelativeQuery">
|
|
<summary>
|
|
Gets or sets the relative query to build a query for.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugstarQueryBuilder.Method">
|
|
<summary>
|
|
Gets or sets the request method to use when sending this query to the Bugstar
|
|
service.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugstarQueryBuilder.ContentType">
|
|
<summary>
|
|
Gets or sets the content-type for the data sent along with this query.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugstarQueryBuilder.Data">
|
|
<summary>
|
|
Gets or sets the data that will be sent.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugstarQueryBuilder.Parameters">
|
|
<summary>
|
|
Gets the dictionary containing any "get/post" parameters.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarQueryBuilder.ToQuery">
|
|
<summary>
|
|
Return concrete BugstarQuery.
|
|
</summary>
|
|
<returns>
|
|
The <see cref="T:RSG.Interop.Bugstar.BugstarQuery"/> object that this builder creates.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.BugstarServiceBase">
|
|
<summary>
|
|
Provides a base implementation of the <see cref="T:RSG.Interop.Bugstar.IBugstarService"/> interface that can
|
|
be used be the application to give command actions the ability to perform Bugstar
|
|
operations.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugstarServiceBase._bugstarConnection">
|
|
<summary>
|
|
Bugstar connection object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugstarServiceBase._projectId">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Interop.Bugstar.BugstarServiceBase.ProjectId"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarServiceBase.#ctor(RSG.Base.Logging.ILog,System.Uri,System.Uri,System.Uri,System.UInt32,System.Int32)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.BugstarServiceBase"/> class using
|
|
the specified Bugstar connection information.
|
|
</summary>
|
|
<param name="log">
|
|
Log object.
|
|
</param>
|
|
<param name="restService">
|
|
The address of the REST service.
|
|
</param>
|
|
<param name="attachmentService">
|
|
The address of the attachment service.
|
|
</param>
|
|
<param name="authenticationService">
|
|
The address of the authentication service.
|
|
</param>
|
|
<param name="projectId">
|
|
The id of the project the tool is currently running for.
|
|
</param>
|
|
<param name="authenticationCookieTimeout">
|
|
The duration in milliseconds for which the authentication cookie is valid.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarServiceBase.#ctor(RSG.Interop.Bugstar.BugstarConnection,System.UInt32)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.BugstarServiceBase"/> class using
|
|
the specified Bugstar connection.
|
|
</summary>
|
|
<param name="existingBugstarConnection">
|
|
Existing Bugstar connection to use.</param>
|
|
<param name="projectId">
|
|
The id of the project the tool is currently running for.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugstarServiceBase.ProjectId">
|
|
<summary>
|
|
Gets the Bugstar project id for the currently installed tools project.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarServiceBase.GetAvailableProjects">
|
|
<summary>
|
|
Retrieves the list of Bugstar projects the user has access to.
|
|
</summary>
|
|
<returns>
|
|
The list of Bugstar projects the user has access to.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarServiceBase.GetActiveProject">
|
|
<summary>
|
|
Gets the Bugstar project for the currently installed tools project.
|
|
</summary>
|
|
<returns>
|
|
The Bugstar project for the currently installed tools project.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarServiceBase.GetActiveProjectAsync">
|
|
<summary>
|
|
Asynchronously gets the Bugstar project for the currently installed tools project.
|
|
</summary>
|
|
<returns>
|
|
The task object representing the asynchronous operation.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarServiceBase.GetProjectById(System.UInt32)">
|
|
<summary>
|
|
Gets a particular project by id.
|
|
</summary>
|
|
<param name="id">
|
|
The id of the project to retrieve.
|
|
</param>
|
|
<returns>
|
|
The project identified by the id.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarServiceBase.GetProjectByIdAsync(System.UInt32)">
|
|
<summary>
|
|
Asynchronously gets a particular project by id.
|
|
</summary>
|
|
<param name="id">
|
|
The id of the project we wish to retrieve.
|
|
</param>
|
|
<returns>
|
|
The task object representing the asynchronous operation.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarServiceBase.GetBugById(System.UInt32,System.Collections.Generic.Dictionary{System.UInt32,RSG.Interop.Bugstar.Organisation.Project})">
|
|
<summary>
|
|
Gets a particular bug by id.
|
|
</summary>
|
|
<param name="id">The id of the bug we wish to retrieve.</param>
|
|
<param name="projectCache">Structure used to cache projects between repeated calls to this function</param>
|
|
<returns>
|
|
The bug identified by the id.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarServiceBase.GetBugByIdAsync(System.UInt32,System.Collections.Generic.Dictionary{System.UInt32,RSG.Interop.Bugstar.Organisation.Project})">
|
|
<summary>
|
|
Gets a particular bug by id.
|
|
</summary>
|
|
<param name="id">The id of the bug we wish to retrieve.</param>
|
|
<param name="projectCache">Structure used to cache projects between repeated calls to this function</param>
|
|
<returns>
|
|
The bug identified by the id.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarServiceBase.PerformBugAction(RSG.Interop.Bugstar.Organisation.Project,System.UInt32,RSG.Interop.Bugstar.BugAction)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarServiceBase.AddTimeToBug(RSG.Interop.Bugstar.Organisation.Project,System.UInt32,System.UInt32,RSG.Interop.Bugstar.TimeType,System.String)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarServiceBase.PasswordLogin(RSG.Interop.Bugstar.BugstarConnection)">
|
|
<summary>
|
|
The delegate method that can be used to log into Bugstar.
|
|
</summary>
|
|
<param name="connection">
|
|
The Bugstar connection that requires a login.
|
|
</param>
|
|
<returns>
|
|
A value indicating whether the login was successful or not.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarServiceBase.ValidateBugstarConnection">
|
|
<summary>
|
|
Attempts to create a valid Bugstar connection that can be used to run
|
|
requests against the Bugstar REST service.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.BugState">
|
|
<summary>
|
|
Enumeration representing a Bug's state.
|
|
</summary>
|
|
<remarks>
|
|
Friendly-names are defined per-project and can be retrived through REST; see
|
|
https://dev2.bugstar.rockstargames.com:8443/BugstarRestService-1.0/rest/Projects/1546/States.
|
|
</remarks>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugState.Dev">
|
|
<summary>
|
|
Bug is currently assigned to a dev.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugState.Resolved">
|
|
<summary>
|
|
Bug is marked as resolved.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugState.Test_More_Info">
|
|
<summary>
|
|
Bug is currently on the QA owner for more information.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugState.Test_Verify">
|
|
<summary>
|
|
Bug is currently on the QA owner for verification that it's been fixed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugState.Review_Fixed">
|
|
<summary>
|
|
Bug is currently on the reviewer to verify that it's fixed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugState.Review_Waived">
|
|
<summary>
|
|
Bug is currently on the reviewer to confirm that it's waived.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugState.Review_Duplicated">
|
|
<summary>
|
|
Bug is currently on the reviewer to confirm that it's a duplicate.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugState.Review_Not_Seen">
|
|
<summary>
|
|
Bug is currently on the reviewer to confirm that it's not been seen.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugState.Closed_Fixed">
|
|
<summary>
|
|
Bug has successfully been fixed and is now closed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugState.Closed_Waived">
|
|
<summary>
|
|
Bug has been verified as being waived and is now closed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugState.Closed_Duplicate">
|
|
<summary>
|
|
Bug has been verified as being a duplicate and is now closed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugState.Closed_Not_Seen">
|
|
<summary>
|
|
Bug has been verified as not being seen and is now closed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugState.Review_Resolved">
|
|
<summary>
|
|
Not sure.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugState.Planned">
|
|
<summary>
|
|
Bug is currently in the planned state.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugState.Test_Not_Seen">
|
|
<summary>
|
|
Bug has been marked as not seen by the QA owner.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugState.On_Hold">
|
|
<summary>
|
|
Bug is currently on hold.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugState.Dev_Fix_Failed">
|
|
<summary>
|
|
Bug has been returned to the developer as the fix wasn't verified by the QA owner.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugState.Blocked">
|
|
<summary>
|
|
Bug is currently blocked by another task.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugState.Blocked_Planned">
|
|
<summary>
|
|
Bug is currently blocked but in the planned state.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.BugStateUtils">
|
|
<summary>
|
|
BugState enum extension and utility methods.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugStateUtils.FromBugstarString(System.String)">
|
|
<summary>
|
|
Attempts to convert a string to its corresponding <see cref="T:RSG.Interop.Bugstar.BugState"/> enum
|
|
value.
|
|
</summary>
|
|
<param name="data">
|
|
The string representation of the enum value.
|
|
</param>
|
|
<returns>
|
|
The <see cref="T:RSG.Interop.Bugstar.BugState"/> for the string; or an invalid cast if it's not parsed.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugStateUtils.ToBugstarString(RSG.Interop.Bugstar.BugState)">
|
|
<summary>
|
|
Converts a <see cref="T:RSG.Interop.Bugstar.BugState"/> enum value to it's Bugstar string
|
|
representation.
|
|
</summary>
|
|
<param name="state">
|
|
The enum value to convert.
|
|
</param>
|
|
<returns>
|
|
The string representation of the enum value.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.BugTimeRecord">
|
|
<summary>
|
|
Represents a single time record that is associated with a <see cref="T:RSG.Interop.Bugstar.Bug"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugTimeRecord._attributeTimeToId">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Interop.Bugstar.BugTimeRecord.AttributeTimeToId"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugTimeRecord._time">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Interop.Bugstar.BugTimeRecord.Time"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugTimeRecord.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.BugTimeRecord"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugTimeRecord.#ctor(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.BugTimeRecord"/> class using the Xml
|
|
element as the source of the records content.
|
|
</summary>
|
|
<param name="element">
|
|
The Xml element containing the time record data.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugTimeRecord.TimeType">
|
|
<summary>
|
|
Gets the kind of work was done during this period
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugTimeRecord.Time">
|
|
<summary>
|
|
Gets the amount of minutes spent.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugTimeRecord.AttributeTimeToId">
|
|
<summary>
|
|
Gets the id of the user who logged the time.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugTimeRecord.CreatedAt">
|
|
<summary>
|
|
Gets the time when this record was created.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugTimeRecord.BugId">
|
|
<summary>
|
|
Gets the bug Id.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugTimeRecord.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Generates an object from its XML representation.
|
|
</summary>
|
|
<param name="xmlBugElem">
|
|
The Xml element containing the time record data.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.DepartmentTimeType">
|
|
<summary>
|
|
Department time type
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.DepartmentTimeType.Development">
|
|
<summary>
|
|
Development
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.DepartmentTimeType.QA">
|
|
<summary>
|
|
QA
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.BugTimeRecordCreator">
|
|
<summary>
|
|
An update of the bug time record
|
|
Currently can only be done by admin user login.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugTimeRecordCreator.#ctor(System.UInt32,System.UInt32,RSG.Interop.Bugstar.TimeType,System.String,System.Nullable{System.UInt32},System.Nullable{System.UInt32},RSG.Interop.Bugstar.DepartmentTimeType)">
|
|
<summary>
|
|
Creates a bug time record to allow to add time to a bug
|
|
</summary>
|
|
<param name="bugId">The id of the desired bug.</param>
|
|
<param name="timeInMinutes">The time in minutes attributed to the bug (float)</param>
|
|
<param name="timeType">The type of time attributed to the bug (Work, Rework, Exporting, Tools Issue, Build Issue, Support)</param>
|
|
<param name="comment">comment to add to the time added</param>
|
|
<param name="attributeTimeToId"> The id of the user you wish to attribute the time record to.</param>
|
|
<param name="attachmentId">The id of an already uploaded attachment to affix to the time record</param>
|
|
<param name="departmentTimeType"> The type of department time attributed to the bug (Development/QA) </param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugTimeRecordCreator.DepartmentTimeType">
|
|
<summary>
|
|
Gets the department time type
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugTimeRecordCreator.AttachmentId">
|
|
<summary>
|
|
Gets the attachement id, can be null
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugTimeRecordCreator.AttributeTimeToId">
|
|
<summary>
|
|
Gets the user id to attribute time to
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugTimeRecordCreator.BugId">
|
|
<summary>
|
|
Gets the bug id
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugTimeRecordCreator.CommentText">
|
|
<summary>
|
|
Gets the comment text
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugTimeRecordCreator.TimeInMinutes">
|
|
<summary>
|
|
Gets the time in minutes that is going to be added to the bug
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugTimeRecordCreator.TimeType">
|
|
<summary>
|
|
Gets the time type
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugTimeRecordCreator.Serialize">
|
|
<summary>
|
|
Serializes to XDocument
|
|
</summary>
|
|
<returns>serialized xdoc of a time record</returns>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.BuildConfiguration">
|
|
<summary>
|
|
Bugstar BuildConfiguration object. Contains a build, a list of bugs and a list of projects.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BuildConfiguration.#ctor(RSG.Interop.Bugstar.Organisation.Project,RSG.Interop.Bugstar.BugstarBuild)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:RSG.Interop.Bugstar.BuildConfiguration"/> class for the specified
|
|
project.
|
|
</summary>
|
|
<param name="project">The project this BuildConfiguration is being created for. If multiple projects, use the other constructor</param>
|
|
<param name="build">BugstarBuild object to be attached to the configuration</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BuildConfiguration.#ctor(System.Collections.Generic.IEnumerable{RSG.Interop.Bugstar.Organisation.Project})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:RSG.Interop.Bugstar.BuildConfiguration"/> class for the specified
|
|
project.
|
|
</summary>
|
|
<param name="projects">
|
|
The projects this BuildConfiguration is being created for. It assumes that all projects share the same connection.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BuildConfiguration.#ctor(RSG.Interop.Bugstar.Organisation.Project,System.IO.Stream)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:RSG.Interop.Bugstar.BuildConfiguration"/> class for the specified
|
|
project, using a memory stream.
|
|
</summary>
|
|
<param name="project">
|
|
The project this BuildConfiguration is being created for. It assumes that all projects share the same connection.
|
|
</param>
|
|
<param name="stream">
|
|
The stream to deserialize in order to initialize the object.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BuildConfiguration.Projects">
|
|
<summary>
|
|
Gets the project this is a part of.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BuildConfiguration.Bugs">
|
|
<summary>
|
|
Gets the project this is a part of.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BuildConfiguration.Build">
|
|
<summary>
|
|
Gets the build information.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BuildConfiguration.Searchable">
|
|
<summary>
|
|
Gets or sets gets the saved search ID
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BuildConfiguration.Query">
|
|
<summary>
|
|
Gets the query to use to query Bugstar about this object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BuildConfiguration.Serialise">
|
|
<summary>
|
|
Serializes build configuration to its XML representation.
|
|
</summary>
|
|
<returns>
|
|
The Xml representation of this build configuration.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BuildConfiguration.Save(RSG.Interop.Bugstar.BuildConfiguration@)">
|
|
<summary>
|
|
Saves the build configuration to the server
|
|
</summary>
|
|
<param name="savedConfig">BuildConfiguration object that is returned from the save after posting data</param>
|
|
<returns>Indicator as to whether it succeeded in saving the configuration</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BuildConfiguration.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Generates an object from its XML representation.
|
|
</summary>
|
|
<param name="xmlBuildConfigElem">
|
|
The Xml element containing the build configuration data.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Common.Category">
|
|
<summary>
|
|
Represents a bug category as obtained from Bugstar.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Common.Category.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Common.Category"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Common.EnumObject">
|
|
<summary>
|
|
Abstract class which enum values obtained from Bugstar can implement.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Common.EnumObject.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Common.EnumObject"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Common.EnumObject.Name">
|
|
<summary>
|
|
Gets or sets the name of this enum value.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Common.EnumObject.Description">
|
|
<summary>
|
|
Gets or sets the description of the enum value.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Common.EnumObjectList`1">
|
|
<summary>
|
|
Represents a list of enum objects obtained from Bugstar.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of enum object this list contains.
|
|
</typeparam>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Common.EnumObjectList`1.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Common.EnumObjectList`1"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Common.EnumObjectList`1.Items">
|
|
<summary>
|
|
Gets or sets the list of items this list contains.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Common.Priority">
|
|
<summary>
|
|
Represents a bug priority as obtained from Bugstar.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Common.Priority.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Common.Priority"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Common.BugstarObject">
|
|
<summary>
|
|
Abstract base class for Bugstar objects.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Common.BugstarObject.#ctor(RSG.Interop.Bugstar.BugstarConnection)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Common.BugstarObject"/> class using the
|
|
specified connection.
|
|
</summary>
|
|
<param name="connection">
|
|
The connection to use to obtain information about this object.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Common.BugstarObject.Connection">
|
|
<summary>
|
|
Gets or sets the Bugstar connection object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Common.BugstarObject.Query">
|
|
<summary>
|
|
Gets the query to use to query Bugstar about this object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Common.BugstarObject.Id">
|
|
<summary>
|
|
Gets the unique ID of the object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Common.BugstarObject.Equals(RSG.Interop.Bugstar.Common.IBugstarObject)">
|
|
<summary>
|
|
Indicates whether this bugstar object is equal to another one. Equality is
|
|
determined by comparing the object ids.
|
|
</summary>
|
|
<param name="other">
|
|
The item to check equality against.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if the objects have the same id; otherwise, <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Common.BugstarObject.GetHashCode">
|
|
<summary>
|
|
Returns the hash code for this object based off of it's id.
|
|
</summary>
|
|
<returns>
|
|
A hash code for the current object.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Common.BugstarObject.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Deserialise; from XElement.
|
|
</summary>
|
|
<param name="xmlObjectElem">
|
|
The Xml element containing information about this object.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Common.BugstarObject.Deserialise(System.Xml.Linq.XElement,System.String)">
|
|
<summary>
|
|
Deserialises the objects Id from the specified tag.
|
|
</summary>
|
|
<param name="xmlObjectElem">
|
|
The Xml element that contains the Id as a sub-element.
|
|
</param>
|
|
<param name="idTag">
|
|
The name of the sub-element that contains the Id.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Common.Commands">
|
|
<summary>
|
|
Defines a set of constants for the various Bugstar endpoints.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarAction">
|
|
<summary>
|
|
The relative endpoint for setting a bug state.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarAttachments">
|
|
<summary>
|
|
The relative endpoint for retrieving attachment information.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarBugs">
|
|
<summary>
|
|
The relative endpoint for retrieving bug information.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarCategories">
|
|
<summary>
|
|
The relative endpoint for retrieving category information.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarComments">
|
|
<summary>
|
|
The relative endpoint for adding comments.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarComponents">
|
|
<summary>
|
|
The relative endpoint for retrieving component information.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarCreateAttachment">
|
|
<summary>
|
|
The relative endpoint for creating an attachment with the attachment service.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarCurrentuser">
|
|
<summary>
|
|
The relative endpoint for retrieving information about the current user.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarData">
|
|
<summary>
|
|
The relative endpoint for retrieving graph data.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarDatapoints">
|
|
<summary>
|
|
The relative endpoint for retrieving graph data points.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarDownloadAttachment">
|
|
<summary>
|
|
The relative endpoint for downloading an attachment from the attachment service.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarGraphs">
|
|
<summary>
|
|
The relative endpoint for retrieving graph information.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarGrids">
|
|
<summary>
|
|
The relative endpoint for retrieving map grid information.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarGroups">
|
|
<summary>
|
|
The relative endpoint for retrieving group information.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarMaps">
|
|
<summary>
|
|
The relative endpoint for retrieving map information.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarMissions">
|
|
<summary>
|
|
The relative endpoint for retrieving mission information.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarMissionCheckpoint">
|
|
<summary>
|
|
The relative endpoint for retrieving mission checkpoint information.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarParameters">
|
|
<summary>
|
|
The relative endpoint for retrieving search parameters.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarPriorities">
|
|
<summary>
|
|
The relative endpoint for retrieving bug priorities.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarProjects">
|
|
<summary>
|
|
The relative endpoint for retrieving project information.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarRegisterAttachment">
|
|
<summary>
|
|
The relative endpoint for registering an attachment with the attachment service.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarReports">
|
|
<summary>
|
|
The relative endpoint for retrieving report information.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarSearches">
|
|
<summary>
|
|
The relative endpoint for retrieving search information.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarSearchModeOpenbylocation">
|
|
<summary>
|
|
The relative endpoint for searching for bugs by location.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarSearchModeFulltext">
|
|
<summary>
|
|
The relative endpoint for searching for bugs via full text.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarSearchIds">
|
|
<summary>
|
|
The relative endpoint for searching for bugs via full text.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarBugtimerecords">
|
|
<summary>
|
|
The relative endpoint for retrieving bug time record information.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarStudios">
|
|
<summary>
|
|
The relative endpoint for retrieving studio information.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarStylesheet">
|
|
<summary>
|
|
The relative endpoint for retrieving a graphs stylesheet.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarTeams">
|
|
<summary>
|
|
The relative endpoint for retrieving team information.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugTimeRecord">
|
|
<summary>
|
|
The relative endpoint for posting a bugstar time record.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarTeamsv2">
|
|
<summary>
|
|
The relative endpoint for retrieving team information.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarDefaults">
|
|
<summary>
|
|
The relative endpoint for retrieving default information.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarUsers">
|
|
<summary>
|
|
The relative endpoint for retrieving user information.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarBuild">
|
|
<summary>
|
|
The relative endpoint for retrieving a default build configuration.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarBuildConfig">
|
|
<summary>
|
|
The relative endpoint for posting a new build configuration.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarGameAsserts">
|
|
<summary>
|
|
The relative endpoint for retrieving game asserts
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.BugstarGameAssert">
|
|
<summary>
|
|
The relative endpoint for posting game asserts
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.Developers">
|
|
<summary>
|
|
The relative endpoint for retrieving developer ids (bug owners).
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Common.Commands.Testers">
|
|
<summary>
|
|
The relative endpoint for retrieving testers (qaowners).
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Common.IBugstarObject">
|
|
<summary>
|
|
Interface for Bugstar objects
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Common.IBugstarObject.Connection">
|
|
<summary>
|
|
Gets the Bugstar connection object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Common.IBugstarObject.Query">
|
|
<summary>
|
|
Gets the query to use to query Bugstar about this object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Common.IBugstarObject.Id">
|
|
<summary>
|
|
Gets the unique ID of the object.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Dependencies.DependencyBlockageType">
|
|
<summary>
|
|
Defines dependency blockage types.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Dependencies.DependencyBlockageType.Default">
|
|
<summary>
|
|
Default blockage.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Dependencies.DependencyBlockageType.Pipeline">
|
|
<summary>
|
|
Pipeline blockage.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Dependencies.DependencyClosedState">
|
|
<summary>
|
|
Defines who to update a dependent bug when the blocker is closed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Dependencies.DependencyClosedState.Default">
|
|
<summary>
|
|
Default.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Dependencies.DependencyClosedState.TestToVerify">
|
|
<summary>
|
|
Change state to test verifying.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Dependencies.DependencyClosedState.ClosedFixed">
|
|
<summary>
|
|
Change state to closed.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Dependencies.DependencyType">
|
|
<summary>
|
|
Defines the type of dependencies that can exist.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Dependencies.DependencyType.FinishFinish">
|
|
<summary>
|
|
???
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Dependencies.DependencyType.FinishStart">
|
|
<summary>
|
|
Once a dependent bug is finished work on this bug can start.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Dependencies.DependencyUpdate">
|
|
<summary>
|
|
Represents a dependency update action.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Dependencies.DependencyUpdate.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Dependencies.DependencyUpdate"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Dependencies.DependencyUpdate.Blockers">
|
|
<summary>
|
|
Gets or sets the list of blocker bugs.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Dependencies.DependencyUpdate.Uid">
|
|
<summary>
|
|
Gets or sets the unique of this request (???).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Dependencies.DependencyUpdate.Comment">
|
|
<summary>
|
|
Gets or sets the comment to add when making this change.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Dependencies.DependencyUpdate.DependencyBlockageType">
|
|
<summary>
|
|
Gets or sets the dependency blockage type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Dependencies.DependencyUpdate.DependencyClosedState">
|
|
<summary>
|
|
Gets or sets the dependency closed state.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Dependencies.DependencyUpdate.DependencyType">
|
|
<summary>
|
|
Gets or sets the dependency type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Dependencies.DependencyUpdate.Dependents">
|
|
<summary>
|
|
Gets or sets the list of dependent bugs.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Dependencies.DependencyUpdate.EmailNotification">
|
|
<summary>
|
|
Gets or sets a value indicating whether to send emails about this update.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Dependencies.DependencyUpdate.Serialize">
|
|
<summary>
|
|
Serialises this update request to its XML representation.
|
|
</summary>
|
|
<returns>
|
|
The Xml representation of this dependency update.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Dependencies.UpdateDependencyAction">
|
|
<summary>
|
|
Defines the list of actions you can perform when updating bug dependencies.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Dependencies.UpdateDependencyAction.AddDependents">
|
|
<summary>
|
|
Add a list of dependent bugs.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Dependencies.UpdateDependencyAction.RemoveDependents">
|
|
<summary>
|
|
Remove a list of dependent bugs.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Dependencies.UpdateDependencyAction.AddBlockers">
|
|
<summary>
|
|
Add a list of blocker bugs.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Dependencies.UpdateDependencyAction.RemoveBlockers">
|
|
<summary>
|
|
Remove a list of blocker bugs.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Dependencies.UpdateDependencyUtil">
|
|
<summary>
|
|
Common methods for dependency related enumerations.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Dependencies.UpdateDependencyUtil.ToBugString(RSG.Interop.Bugstar.Dependencies.DependencyBlockageType)">
|
|
<summary>
|
|
Converts a <see cref="T:RSG.Interop.Bugstar.Dependencies.DependencyBlockageType"/> enum value to it's Bugstar string
|
|
representation.
|
|
</summary>
|
|
<param name="dependency">
|
|
The enum value to convert.
|
|
</param>
|
|
<returns>
|
|
The string representation of the enum value.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Dependencies.UpdateDependencyUtil.ToBugString(RSG.Interop.Bugstar.Dependencies.DependencyClosedState)">
|
|
<summary>
|
|
Converts a <see cref="T:RSG.Interop.Bugstar.Dependencies.DependencyClosedState"/> enum value to it's Bugstar string
|
|
representation.
|
|
</summary>
|
|
<param name="dependency">
|
|
The enum value to convert.
|
|
</param>
|
|
<returns>
|
|
The string representation of the enum value.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Dependencies.UpdateDependencyUtil.ToBugString(RSG.Interop.Bugstar.Dependencies.DependencyType)">
|
|
<summary>
|
|
Converts a <see cref="T:RSG.Interop.Bugstar.Dependencies.DependencyType"/> enum value to it's Bugstar string
|
|
representation.
|
|
</summary>
|
|
<param name="dependency">
|
|
The enum value to convert.
|
|
</param>
|
|
<returns>
|
|
The string representation of the enum value.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Dependencies.UpdateDependencyUtil.ToBugString(RSG.Interop.Bugstar.Dependencies.UpdateDependencyAction)">
|
|
<summary>
|
|
Converts a <see cref="T:RSG.Interop.Bugstar.Dependencies.UpdateDependencyAction"/> enum value to it's Bugstar string
|
|
representation.
|
|
</summary>
|
|
<param name="action">
|
|
The enum value to convert.
|
|
</param>
|
|
<returns>
|
|
The string representation of the enum value.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Game.MissionCheckpoint">
|
|
<summary>
|
|
Represents a Bugstar mission checkpoint that is associated with a particular mission.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.MissionCheckpoint.#ctor(RSG.Interop.Bugstar.Game.Mission)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Game.MissionCheckpoint"/> class for the
|
|
specified mission.
|
|
</summary>
|
|
<param name="mission">
|
|
The mission this checkpoint is being created for.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.MissionCheckpoint.#ctor(RSG.Interop.Bugstar.Game.Mission,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Game.MissionCheckpoint"/> class for the
|
|
specified map using the Xml element as the source of the map content.
|
|
</summary>
|
|
<param name="mission">
|
|
The mission this checkpoint is being created for.
|
|
</param>
|
|
<param name="element">
|
|
The Xml element containing the grid data.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.MissionCheckpoint.Mission">
|
|
<summary>
|
|
Gets or sets the mission this checkpoint is for.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.MissionCheckpoint.Name">
|
|
<summary>
|
|
Gets or sets the name of the checkpoints.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.MissionCheckpoint.Ordering">
|
|
<summary>
|
|
Gets or sets the index of this checkpoint which dictates the order it is reached in
|
|
the parent mission.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.MissionCheckpoint.ProjectedAttempts">
|
|
<summary>
|
|
Gets or sets the average number of attempts it will take to reach the checkpoint.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.MissionCheckpoint.ProjectedAttemptsMax">
|
|
<summary>
|
|
Gets or sets the maximum number of attempts it should take to reach the checkpoint.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.MissionCheckpoint.ProjectedAttemptsMin">
|
|
<summary>
|
|
Gets or sets the minimum number of attempts it should take to reach the checkpoint.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.MissionCheckpoint.Query">
|
|
<summary>
|
|
Gets the query to use to query Bugstar about this object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.MissionCheckpoint.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Generates an object from its XML representation.
|
|
</summary>
|
|
<param name="node">
|
|
The Xml element containing the graphs data.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Game.Map">
|
|
<summary>
|
|
Represents a Bugstar map that is associated with a particular project.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Game.Map.LogCtx">
|
|
<summary>
|
|
The message context to use when logging information for this object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Game.Map._image">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Interop.Bugstar.Game.Map.Image"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.Map.#ctor(RSG.Interop.Bugstar.Organisation.Project)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Game.Map"/> class for the specified
|
|
project.
|
|
</summary>
|
|
<param name="project">
|
|
The project this map is being created for.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.Map.#ctor(RSG.Interop.Bugstar.Organisation.Project,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Game.Map"/> class for the specified
|
|
project using the Xml element as the source of the map content.
|
|
</summary>
|
|
<param name="project">
|
|
The project this map is being created for.
|
|
</param>
|
|
<param name="xmlElement">
|
|
The Xml element containing the map data.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.Map.Description">
|
|
<summary>
|
|
Gets or sets the description of the map.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.Map.Grids">
|
|
<summary>
|
|
Gets the list of grids this map contains by querying Bugstar for that data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.Map.Image">
|
|
<summary>
|
|
Gets the background image to use for the map by querying Bugstar for that data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.Map.ImageAttachmentId">
|
|
<summary>
|
|
Gets or sets the attachment id for the maps background image.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.Map.LowerLeft">
|
|
<summary>
|
|
Gets or sets the lower left bounds of the map.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.Map.Name">
|
|
<summary>
|
|
Gets or sets the name of the map.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.Map.Project">
|
|
<summary>
|
|
Gets or sets the project this map is a part of.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.Map.Query">
|
|
<summary>
|
|
Gets the query to use to query Bugstar about this object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.Map.UpperRight">
|
|
<summary>
|
|
Gets or sets the upper right bounds of the map.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.Map.GetMapById(RSG.Interop.Bugstar.Organisation.Project,System.UInt32)">
|
|
<summary>
|
|
Queries Bugstar for a map based on the project it's in and its id.
|
|
</summary>
|
|
<param name="project">
|
|
The project to fetch the map for.
|
|
</param>
|
|
<param name="id">
|
|
The id of the map to retrieve.
|
|
</param>
|
|
<returns>
|
|
An instance of the map.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.Map.GetMapByIdAsync(RSG.Interop.Bugstar.Organisation.Project,System.UInt32)">
|
|
<summary>
|
|
Queries Bugstar async'ly for a map based on the project it's in and its id.
|
|
</summary>
|
|
<param name="project">
|
|
The project to fetch the map for.
|
|
</param>
|
|
<param name="id">
|
|
The id of the map to retrieve.
|
|
</param>
|
|
<returns>
|
|
An instance of the map.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.Map.GetGridListAsync">
|
|
<summary>
|
|
Queries Bugstar async'ly for a list of grids associated with this map
|
|
</summary>
|
|
<returns>
|
|
The list grids associated with this map.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.Map.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Generates an object from its XML representation.
|
|
</summary>
|
|
<param name="node">
|
|
The Xml element containing the maps data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.Map.GetGridList">
|
|
<summary>
|
|
Queries Bugstar for a list of grids associated with this map
|
|
</summary>
|
|
<returns>
|
|
The list grids associated with this map.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.Map.GetBackgroundImage">
|
|
<summary>
|
|
First checks the cache to see if the image exists there, otherwise attempts to
|
|
retrieve it from Bugstar.
|
|
</summary>
|
|
<returns>
|
|
The background image associated with this map.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Game.MapGrid">
|
|
<summary>
|
|
Represents a Bugstar map that is associated with a particular project/map.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.MapGrid.#ctor(RSG.Interop.Bugstar.Game.Map)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Game.MapGrid"/> class for the specified
|
|
map.
|
|
</summary>
|
|
<param name="map">
|
|
The map this grid is being created for.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.MapGrid.#ctor(RSG.Interop.Bugstar.Game.Map,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Game.MapGrid"/> class for the specified
|
|
map using the Xml element as the source of the map content.
|
|
</summary>
|
|
<param name="map">
|
|
The map this grid is being created for.
|
|
</param>
|
|
<param name="xmlElement">
|
|
The Xml element containing the grid data.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.MapGrid.Active">
|
|
<summary>
|
|
Gets or sets a value indicating whether the grid is marked as active in Bugstar.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.MapGrid.Colour">
|
|
<summary>
|
|
Gets or sets the colour of the map grid.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.MapGrid.Map">
|
|
<summary>
|
|
Gets or sets the map this grid is a part of.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.MapGrid.Name">
|
|
<summary>
|
|
Gets or sets the grids name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.MapGrid.Points">
|
|
<summary>
|
|
Gets or sets the list of points that make up the spline outline of the section.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.MapGrid.Query">
|
|
<summary>
|
|
Gets the query to use to query Bugstar about this object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.MapGrid.Centre">
|
|
<summary>
|
|
Gets the centre point for this map grid.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.MapGrid.CompareTo(RSG.Interop.Bugstar.Game.MapGrid)">
|
|
<summary>
|
|
Compares this grid against another.
|
|
</summary>
|
|
<param name="other">
|
|
The group to compare this grid against.
|
|
</param>
|
|
<returns>
|
|
A value indicating how this grid compares against the specified grid.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.MapGrid.Equals(RSG.Interop.Bugstar.Game.MapGrid)">
|
|
<summary>
|
|
Indicates whether this MapGrid is equal to another one. Equality is determined by
|
|
the mapgrid id.
|
|
</summary>
|
|
<param name="other">
|
|
The item to check equality against.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if the objects have the same id; otherwise, <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.MapGrid.GetBugs">
|
|
<summary>
|
|
Queries Bugstar for a list of bugs that are assigned to this grid.
|
|
</summary>
|
|
<returns>
|
|
The list of bugs this grid contains.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.MapGrid.GetBugs(System.String)">
|
|
<summary>
|
|
Queries Bugstar for a list of bugs that are assigned to this grid returning only
|
|
the data for the requested fields.
|
|
</summary>
|
|
<param name="fields">
|
|
The comma separated list of fields to retrieve.
|
|
</param>
|
|
<returns>
|
|
The list of bugs this grid contains.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.MapGrid.GetBugs(System.Collections.Generic.IEnumerable{RSG.Interop.Bugstar.BugField})">
|
|
<summary>
|
|
Queries Bugstar for a list of bugs that are assigned to this grid returning only
|
|
the data for the requested fields.
|
|
</summary>
|
|
<param name="fields">
|
|
The list of fields to retrieve.
|
|
</param>
|
|
<returns>
|
|
The list of bugs this grid contains.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.MapGrid.GetBugsAsync(System.String)">
|
|
<summary>
|
|
Queries Bugstar for a list of bugs that are assigned to this grid returning only
|
|
the data for the requested fields.
|
|
</summary>
|
|
<param name="fields">
|
|
The comma separated list of fields to retrieve.
|
|
</param>
|
|
<returns>
|
|
The list of bugs this grid contains.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.MapGrid.GetBugsAsync(System.Collections.Generic.IEnumerable{RSG.Interop.Bugstar.BugField})">
|
|
<summary>
|
|
Queries Bugstar for a list of bugs that are assigned to this grid returning only
|
|
the data for the requested fields.
|
|
</summary>
|
|
<param name="fields">
|
|
The comma separated list of fields to retrieve.
|
|
</param>
|
|
<returns>
|
|
The list of bugs this grid contains.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.MapGrid.GridCentre">
|
|
<summary>
|
|
Gets the map grid centre.
|
|
</summary>
|
|
<returns>Map grid centre point.</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.MapGrid.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Generates an object from its XML representation.
|
|
</summary>
|
|
<param name="node">
|
|
The Xml element containing the grids data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.MapGrid.CalculateGridCenter">
|
|
<summary>
|
|
Get the centre of the map grid
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Game.Mission">
|
|
<summary>
|
|
Represents a Bugstar mission that is associated with a particular project.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Game.Mission.LogCtx">
|
|
<summary>
|
|
The message context to use when logging information for this object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.Mission.#ctor(RSG.Interop.Bugstar.Organisation.Project)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Game.Mission"/> class for the specified
|
|
project.
|
|
</summary>
|
|
<param name="project">
|
|
The project this map is being created for.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.Mission.#ctor(RSG.Interop.Bugstar.Organisation.Project,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Game.Mission"/> class for the specified
|
|
project using the Xml element as the source of the map content.
|
|
</summary>
|
|
<param name="project">
|
|
The project this map is being created for.
|
|
</param>
|
|
<param name="xmlElement">
|
|
The Xml element containing the search data.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.Mission.Active">
|
|
<summary>
|
|
Gets or sets a value indicating whether this mission is actively in use in by the
|
|
game.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.Mission.Checkpoints">
|
|
<summary>
|
|
Gets or sets the list of checkpoints this mission has.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.Mission.Description">
|
|
<summary>
|
|
Gets or sets the description of the mission.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.Mission.Issues">
|
|
<summary>
|
|
Gets or sets the the current issues with the mission.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.Mission.MissionId">
|
|
<summary>
|
|
Gets or sets the unique string id for the mission.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.Mission.Name">
|
|
<summary>
|
|
Gets or sets the missions name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.Mission.Project">
|
|
<summary>
|
|
Gets or sets the project this map is a part of.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.Mission.ProjectedAttempts">
|
|
<summary>
|
|
Gets or sets the average number of attempts it will take to perform the mission.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.Mission.ProjectedAttemptsMax">
|
|
<summary>
|
|
Gets or sets the maximum number of attempts it should take to perform the mission.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.Mission.ProjectedAttemptsMin">
|
|
<summary>
|
|
Gets or sets the minimum number of attempts it should take to perform the mission.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.Mission.Query">
|
|
<summary>
|
|
Gets the query to use to query Bugstar about this object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.Mission.ScriptName">
|
|
<summary>
|
|
Gets or sets the name of the script associated with the mission.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.Mission.Singleplayer">
|
|
<summary>
|
|
Gets or sets a value indicating whether this is a singleplayer mission or not.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.Mission.StoryDescription">
|
|
<summary>
|
|
Gets or sets the story description for the mission.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Game.Mission.Variant">
|
|
<summary>
|
|
Gets or sets the variation of the mission this is.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.Mission.GetMissionById(RSG.Interop.Bugstar.Organisation.Project,System.UInt32)">
|
|
<summary>
|
|
Queries Bugstar for a mission based on the project it's in and its id.
|
|
</summary>
|
|
<param name="project">
|
|
The project to fetch the mission for.
|
|
</param>
|
|
<param name="id">
|
|
The id of the mission to retrieve.
|
|
</param>
|
|
<returns>
|
|
An instance of the mission.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.Mission.CompareTo(RSG.Interop.Bugstar.Game.Mission)">
|
|
<summary>
|
|
Compares this mission against another.
|
|
</summary>
|
|
<param name="other">
|
|
The mission to compare this mission against.
|
|
</param>
|
|
<returns>
|
|
A value indicating how this mission compares against the specified mission.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.Mission.Equals(RSG.Interop.Bugstar.Game.Mission)">
|
|
<summary>
|
|
Indicates whether this Mission is equal to another one. Equality is determined by
|
|
the mission id.
|
|
</summary>
|
|
<param name="other">
|
|
The item to check equality against.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if the objects have the same id; otherwise, <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.Mission.GetBugs">
|
|
<summary>
|
|
Queries Bugstar for a list of bugs that are assigned to this mission.
|
|
</summary>
|
|
<returns>
|
|
The list of bugs this grid contains.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.Mission.GetBugs(System.String)">
|
|
<summary>
|
|
Queries Bugstar for a list of bugs that are assigned to this mission returning only
|
|
the data for the requested fields.
|
|
</summary>
|
|
<param name="fields">
|
|
The comma separated list of fields to retrieve.
|
|
</param>
|
|
<returns>
|
|
The list of bugs this mission contains.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.Mission.GetBugs(System.Collections.Generic.IEnumerable{RSG.Interop.Bugstar.BugField})">
|
|
<summary>
|
|
Queries Bugstar for a list of bugs that are assigned to this mission returning only
|
|
the data for the requested fields.
|
|
</summary>
|
|
<param name="fields">
|
|
The list of fields to retrieve.
|
|
</param>
|
|
<returns>
|
|
The list of bugs this mission contains.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.Mission.GetBugsAsync(System.Collections.Generic.IEnumerable{RSG.Interop.Bugstar.BugField})">
|
|
<summary>
|
|
Queries Bugstar Async'ly for a list of bugs that are assigned to this mission returning only
|
|
the data for the requested fields.
|
|
</summary>
|
|
<param name="fields">
|
|
Collection of bugfields to get for the bugs.
|
|
</param>
|
|
<returns>
|
|
The list of bugs this mission contains.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.Mission.GetBugsAsync(System.String)">
|
|
<summary>
|
|
Queries Bugstar Async'ly for a list of bugs that are assigned to this mission returning only
|
|
the data for the requested fields.
|
|
</summary>
|
|
<param name="fields">
|
|
The comma separated list of fields to retrieve.
|
|
</param>
|
|
<returns>
|
|
The list of bugs this mission contains.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Game.Mission.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Generates an object from its XML representation.
|
|
</summary>
|
|
<param name="node">
|
|
The Xml element containing the missions data.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Hierarchy.ParentChildUpdate">
|
|
<summary>
|
|
Represents a parent child update request.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Hierarchy.ParentChildUpdate.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Hierarchy.ParentChildUpdate"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Hierarchy.ParentChildUpdate.Children">
|
|
<summary>
|
|
Gets or sets the list of children to add to the parent bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Hierarchy.ParentChildUpdate.Comment">
|
|
<summary>
|
|
Gets or sets the comment to add when adding this relationship.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Hierarchy.ParentChildUpdate.Parent">
|
|
<summary>
|
|
Gets or sets the parent bug to add children to.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Hierarchy.ParentChildUpdate.Uid">
|
|
<summary>
|
|
Gets or sets the unique of this request (???).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Hierarchy.ParentChildUpdate.ParentChildUpdateAction">
|
|
<summary>
|
|
Gets or sets the parent child update action to perform.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Hierarchy.ParentChildUpdate.EmailNotification">
|
|
<summary>
|
|
Gets or sets a value indicating whether to send emails about this update.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Hierarchy.ParentChildUpdate.Serialize">
|
|
<summary>
|
|
Serialises this update request to its XML representation.
|
|
</summary>
|
|
<returns>
|
|
The Xml representation of this parent child update.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Hierarchy.ParentChildUpdateAction">
|
|
<summary>
|
|
Defines the various actions you can perform for modifying parent/child relationships.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Hierarchy.ParentChildUpdateAction.AddChildren">
|
|
<summary>
|
|
Action for add a list of children.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Hierarchy.ParentChildUpdateAction.RemoveChildren">
|
|
<summary>
|
|
Action for removing a list of children.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Hierarchy.ParentChildUpdateAction.AddParent">
|
|
<summary>
|
|
Action for adding a parent.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Hierarchy.ParentChildUpdateAction.RemoveParent">
|
|
<summary>
|
|
Action for removing a parent.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Hierarchy.ParentChildUpdateActionUtil">
|
|
<summary>
|
|
Common methods for the <see cref="T:RSG.Interop.Bugstar.Hierarchy.ParentChildUpdateAction"/> enumeration.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Hierarchy.ParentChildUpdateActionUtil.ToBugString(RSG.Interop.Bugstar.Hierarchy.ParentChildUpdateAction)">
|
|
<summary>
|
|
Converts a <see cref="T:RSG.Interop.Bugstar.Hierarchy.ParentChildUpdateAction"/> enum value to it's Bugstar string
|
|
representation.
|
|
</summary>
|
|
<param name="action">
|
|
The enum value to convert.
|
|
</param>
|
|
<returns>
|
|
The string representation of the enum value.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.IBugstarService">
|
|
<summary>
|
|
When implemented represents a service that can be used to acquire a Bugstar connection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.IBugstarService.ProjectId">
|
|
<summary>
|
|
Gets the Bugstar project id for the currently installed tools project.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.IBugstarService.GetAvailableProjects">
|
|
<summary>
|
|
Gets the Bugstar project id for the currently installed tools project.
|
|
</summary>
|
|
<returns>
|
|
The list of projects that the local user has access to.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.IBugstarService.GetActiveProject">
|
|
<summary>
|
|
Gets the Bugstar project for the currently installed tools project.
|
|
</summary>
|
|
<returns>
|
|
The Bugstar project for the currently installed tools project.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.IBugstarService.GetActiveProjectAsync">
|
|
<summary>
|
|
Asynchronously gets the Bugstar project for the currently installed tools project.
|
|
</summary>
|
|
<returns>
|
|
The task object representing the asynchronous operation.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.IBugstarService.GetProjectById(System.UInt32)">
|
|
<summary>
|
|
Gets a particular project by id.
|
|
</summary>
|
|
<param name="id">
|
|
The id of the project we wish to retrieve.
|
|
</param>
|
|
<returns>
|
|
The project identified by the id.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.IBugstarService.GetProjectByIdAsync(System.UInt32)">
|
|
<summary>
|
|
Asynchronously gets a particular project by id.
|
|
</summary>
|
|
<param name="id">
|
|
The id of the project we wish to retrieve.
|
|
</param>
|
|
<returns>
|
|
The task object representing the asynchronous operation.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.IBugstarService.GetBugById(System.UInt32,System.Collections.Generic.Dictionary{System.UInt32,RSG.Interop.Bugstar.Organisation.Project})">
|
|
<summary>
|
|
Gets a particular bug by id.
|
|
</summary>
|
|
<param name="id">The id of the bug we wish to retrieve.</param>
|
|
<param name="projectCache">Structure used to cache projects between repeated calls to this function</param>
|
|
<returns>
|
|
The bug identified by the id.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.IBugstarService.GetBugByIdAsync(System.UInt32,System.Collections.Generic.Dictionary{System.UInt32,RSG.Interop.Bugstar.Organisation.Project})">
|
|
<summary>
|
|
Gets a particular bug by id.
|
|
</summary>
|
|
<param name="id">The id of the bug we wish to retrieve.</param>
|
|
<param name="projectCache">Structure used to cache projects between repeated calls to this function</param>
|
|
<returns>
|
|
The bug identified by the id.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.IBugstarService.PerformBugAction(RSG.Interop.Bugstar.Organisation.Project,System.UInt32,RSG.Interop.Bugstar.BugAction)">
|
|
<summary>
|
|
Sets the Bugstar action for the given bug.
|
|
</summary>
|
|
<param name="project">Project for the bug.</param>
|
|
<param name="bugId">Bug ID</param>
|
|
<param name="action">Action to perform on the bug.</param>
|
|
<returns>True if the action is set.</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.IBugstarService.AddTimeToBug(RSG.Interop.Bugstar.Organisation.Project,System.UInt32,System.UInt32,RSG.Interop.Bugstar.TimeType,System.String)">
|
|
<summary>
|
|
Add time to a given Bug ID.
|
|
</summary>
|
|
<param name="project">Bugstar Project</param>
|
|
<param name="bugId">Bug ID to add time to</param>
|
|
<param name="timeInMinutes">Time in minutes to add.</param>
|
|
<param name="timeType">Type of time to add.</param>
|
|
<param name="comment">Comment to add.</param>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.BugstarTicket">
|
|
<summary>
|
|
Bugstar ticket for logging into Bugstar.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugstarTicket.IsValid">
|
|
<summary>
|
|
Gets a value indicating whether if the ticket is still valid or not.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugstarTicket.Cookie">
|
|
<summary>
|
|
Gets cookie for the ticket.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugstarTicket.ExpirationDateTime">
|
|
<summary>
|
|
Gets the cookie expiration date.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarTicket.TryLoad(System.String,RSG.Interop.Bugstar.BugstarTicket@)">
|
|
<summary>
|
|
Load a ticket from disk.
|
|
</summary>
|
|
<param name="filePath">File path to the ticket.</param>
|
|
<param name="loadedTicket">Ticket instance when loaded.</param>
|
|
<returns>New <see cref="T:RSG.Interop.Bugstar.BugstarTicket"/></returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarTicket.Save(System.String)">
|
|
<summary>
|
|
Save the cookie to the given path.
|
|
</summary>
|
|
<param name="filePath">File path to save the cookie.</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarTicket.Create(System.Net.Cookie,System.DateTime)">
|
|
<summary>
|
|
Create a new ticket.
|
|
</summary>
|
|
<param name="cookie">Cookie for the ticket.</param>
|
|
<param name="expirationDateTime">Expiration date time.</param>
|
|
<returns>New <see cref="T:RSG.Interop.Bugstar.BugstarTicket"/></returns>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Organisation.Actor">
|
|
<summary>
|
|
Defines a base class for actors that can be used for the owners, qa owner and reviewer
|
|
of bugs.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Actor.#ctor(RSG.Interop.Bugstar.Organisation.Project)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Organisation.Actor"/> class for the specified
|
|
project.
|
|
</summary>
|
|
<param name="project">
|
|
The project this actor is being created for.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.Actor.Name">
|
|
<summary>
|
|
Gets or sets the name of the actor.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.Actor.Project">
|
|
<summary>
|
|
Gets the project this actor is associated with.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Organisation.DefaultGroup">
|
|
<summary>
|
|
Represents a default used for bug assigment such as *Default Tools*
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.DefaultGroup.LogCtx">
|
|
<summary>
|
|
The message context to use when logging information for this object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.DefaultGroup._parent">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Interop.Bugstar.Organisation.DefaultGroup.Parent"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.DefaultGroup._parentId">
|
|
<summary>
|
|
The id of the parent of this group.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.DefaultGroup.#ctor(RSG.Interop.Bugstar.Organisation.Project)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Organisation.DefaultGroup"/> class for the
|
|
specified project.
|
|
</summary>
|
|
<param name="project">
|
|
The project this default is being created for.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.DefaultGroup.#ctor(RSG.Interop.Bugstar.Organisation.Project,System.Xml.Linq.XDocument)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Organisation.DefaultGroup"/> class for the
|
|
specified project.
|
|
</summary>
|
|
<param name="project">
|
|
The project this default is being created for.
|
|
</param>
|
|
<param name="xmlDefaultDocument">
|
|
The Xml document containing the default data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.DefaultGroup.#ctor(RSG.Interop.Bugstar.Organisation.Project,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Organisation.DefaultGroup"/> class for the
|
|
specified project using the Xml element as the source of the default group content.
|
|
</summary>
|
|
<param name="project">
|
|
The project this default is being created for.
|
|
</param>
|
|
<param name="xmlElement">
|
|
The Xml element containing the default data.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.DefaultGroup.Parent">
|
|
<summary>
|
|
Gets the parent of this default (or null if there isn't one).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.DefaultGroup.Query">
|
|
<summary>
|
|
Gets the query to use to query Bugstar about this object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.DefaultGroup.GetDefaultById(RSG.Interop.Bugstar.Organisation.Project,System.UInt32)">
|
|
<summary>
|
|
Queries Bugstar for a default based on the project it's in and its id.
|
|
</summary>
|
|
<param name="project">
|
|
The project to fetch the default for.
|
|
</param>
|
|
<param name="id">
|
|
The id of the default to retrieve.
|
|
</param>
|
|
<returns>
|
|
An instance of the default.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.DefaultGroup.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Generates an object from its XML representation.
|
|
</summary>
|
|
<param name="xmlDefaultElem">
|
|
The Xml element containing the defaults data.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Organisation.PermissionType">
|
|
<summary>
|
|
Permission type enumeration.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.PermissionType.None">
|
|
<summary>
|
|
Unknown permission type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.PermissionType.SuperAdmin">
|
|
<summary>
|
|
The user has super admin privileges.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.PermissionType.FeatureTester">
|
|
<summary>
|
|
The user has feature testing permissions.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.PermissionType.TimestarUser">
|
|
<summary>
|
|
The user can make use of timestar.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.PermissionType.TimestarAdmin">
|
|
<summary>
|
|
The user is a timestar admin.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.PermissionType.TimesheetValidator">
|
|
<summary>
|
|
The user can validate timesheets in timestar.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.PermissionType.UserAdmin">
|
|
<summary>
|
|
The user can modify users.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.PermissionType.ComponentAdmin">
|
|
<summary>
|
|
The user can modify components.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.PermissionType.MissionAdmin">
|
|
<summary>
|
|
The user can modify missions.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.PermissionType.SearchAdmin">
|
|
<summary>
|
|
The user can modify all searches.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.PermissionType.BuildAdmin">
|
|
<summary>
|
|
The user can create/modify builds.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.PermissionType.Admin">
|
|
<summary>
|
|
The user is a general admin.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.PermissionType.Developer">
|
|
<summary>
|
|
The user can have bugs assigned to them.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.PermissionType.Tester">
|
|
<summary>
|
|
The user can be a tester.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.PermissionType.Reviewer">
|
|
<summary>
|
|
The user can be a reviewer.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Organisation.PermissionTypeUtils">
|
|
<summary>
|
|
PermissionType enum utility and extension methods.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.PermissionTypeUtils.ConvertStringToPermissionType(System.String)">
|
|
<summary>
|
|
Convert a String into a PermissionType (default: None).
|
|
</summary>
|
|
<param name="s">
|
|
The string to convert.
|
|
</param>
|
|
<returns>
|
|
The permission type that matches the string.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Organisation.Studio">
|
|
<summary>
|
|
Represents a studio that Bugstar is aware of.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.Studio.LogCtx">
|
|
<summary>
|
|
The message context to use when logging information for this object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Studio.#ctor(RSG.Interop.Bugstar.BugstarConnection,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Organisation.Studio"/> class.
|
|
</summary>
|
|
<param name="connection">
|
|
The Bugstar connection to use when performing requests.
|
|
</param>
|
|
<param name="xmlElement">
|
|
The Xml representation of this studio.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.Studio.Name">
|
|
<summary>
|
|
Gets or sets the name of this studio.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.Studio.Query">
|
|
<summary>
|
|
Gets the query to use to query Bugstar about this object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Studio.GetStudioById(RSG.Interop.Bugstar.BugstarConnection,System.UInt32)">
|
|
<summary>
|
|
Attempts to retrieve the studio identified by the specified id.
|
|
</summary>
|
|
<param name="connection">
|
|
The connection to use to query for the information.
|
|
</param>
|
|
<param name="id">
|
|
The id of the studio to retrieve.
|
|
</param>
|
|
<returns>
|
|
An instance of the studio.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Studio.GetStudios(RSG.Interop.Bugstar.BugstarConnection)">
|
|
<summary>
|
|
Return array of all studios in Bugstar.
|
|
</summary>
|
|
<param name="connection">
|
|
The connection to use to query for the information.
|
|
</param>
|
|
<returns>
|
|
An array of studios that Bugstar is aware of.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Studio.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Generates an object from its XML representation.
|
|
</summary>
|
|
<param name="node">
|
|
The Xml element containing the studios data.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Organisation.Team">
|
|
<summary>
|
|
Bugstar team.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.Team.LogCtx">
|
|
<summary>
|
|
The message context to use when logging information for this object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.Team._parent">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Interop.Bugstar.Organisation.Team.Parent"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.Team._parentId">
|
|
<summary>
|
|
The id of the parent team.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Team.#ctor(RSG.Interop.Bugstar.Organisation.Project)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Organisation.Team"/> class for the specified
|
|
project.
|
|
</summary>
|
|
<param name="project">
|
|
The project this team is being created for.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Team.#ctor(RSG.Interop.Bugstar.Organisation.Project,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Organisation.Team"/> class for the specified
|
|
project initialising it with the data contained in the Xml element.
|
|
</summary>
|
|
<param name="project">
|
|
The project this team is being created for.
|
|
</param>
|
|
<param name="xmlElement">
|
|
The Xml representation of this team.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Team.#ctor(RSG.Interop.Bugstar.Organisation.Project,System.Xml.Linq.XDocument)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Organisation.Team"/> class for the specified
|
|
project initialising it with the data contained in the Xml document.
|
|
</summary>
|
|
<param name="project">
|
|
The project this team is being created for.
|
|
</param>
|
|
<param name="xmlTeamDocument">
|
|
The Xml document containing the representation of this document.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.Team.Parent">
|
|
<summary>
|
|
Gets the parent of this team (or null if there isn't one).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.Team.Query">
|
|
<summary>
|
|
Gets the query to use to query Bugstar about this object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Team.GetTeamById(RSG.Interop.Bugstar.Organisation.Project,System.UInt32)">
|
|
<summary>
|
|
Return Bugstar Team object from their ID.
|
|
</summary>
|
|
<param name="project">
|
|
The project to retrieve the team for.
|
|
</param>
|
|
<param name="id">
|
|
The teams Id.
|
|
</param>
|
|
<returns>
|
|
The team specified by the Id.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Team.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Generates an object from its XML representation.
|
|
</summary>
|
|
<param name="xmlTeamElem">
|
|
The Xml element containing the teams data.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Organisation.Component">
|
|
<summary>
|
|
Bug Component object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.Component.LogCtx">
|
|
<summary>
|
|
The message context to use when logging information for this object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.Component._parent">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Interop.Bugstar.Organisation.Component.Parent"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.Component._parentId">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Interop.Bugstar.Organisation.Component.ParentId"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Component.#ctor(RSG.Interop.Bugstar.Organisation.Project)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Organisation.Component"/> class for the specified
|
|
project.
|
|
</summary>
|
|
<param name="project">
|
|
The project this component is being created for.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Component.#ctor(RSG.Interop.Bugstar.Organisation.Project,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Constructor initialised with an xmlElement
|
|
</summary>
|
|
<param name="project">
|
|
The project this component is being created for.
|
|
</param>
|
|
<param name="xmlElement">
|
|
The Xml element containing the component data.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.Component.Description">
|
|
<summary>
|
|
Gets or sets the components description.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.Component.FullName">
|
|
<summary>
|
|
Gets the components full name. The full name is the concatenation of it's
|
|
ancestors names.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.Component.Name">
|
|
<summary>
|
|
Gets or sets the components name
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.Component.Parent">
|
|
<summary>
|
|
Gets the parent component (this is only patched up after all components have been
|
|
deserialised).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.Component.Project">
|
|
<summary>
|
|
Gets or sets the project this component is a part of.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.Component.Query">
|
|
<summary>
|
|
Gets the query to use to query Bugstar about this object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.Component.ParentId">
|
|
<summary>
|
|
Gets the id that corresponds to the parent of this component.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Component.GetComponentById(RSG.Interop.Bugstar.Organisation.Project,System.UInt32)">
|
|
<summary>
|
|
Queries Bugstar for a component based on the project it's in and its id.
|
|
</summary>
|
|
<param name="project">
|
|
The project to fetch the component for.
|
|
</param>
|
|
<param name="id">
|
|
The id of the component to retrieve.
|
|
</param>
|
|
<returns>
|
|
An instance of the component.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Component.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Generates an object from its XML representation.
|
|
</summary>
|
|
<param name="node">
|
|
The Xml element containing the components data.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Organisation.Project">
|
|
<summary>
|
|
Represents a Bugstar project.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.Project.LogCtx">
|
|
<summary>
|
|
The message context to use when logging information for this object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.Project._currentUser">
|
|
<summary>
|
|
Cached current user.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.#ctor(RSG.Interop.Bugstar.BugstarConnection)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Organisation.Project"/> class using the specified
|
|
Bugstar connection.
|
|
</summary>
|
|
<param name="connection">
|
|
The Bugstar connection to use when performing requests.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.#ctor(RSG.Interop.Bugstar.BugstarConnection,System.UInt32)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Organisation.Project"/> class using the specified
|
|
Bugstar connection and project.
|
|
</summary>
|
|
<param name="connection">
|
|
The Bugstar connection to use when performing requests.
|
|
</param>
|
|
<param name="id">Project ID.</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.#ctor(RSG.Interop.Bugstar.BugstarConnection,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Organisation.Project"/> class using the specified
|
|
Bugstar connection and Xml element containing the project data.
|
|
</summary>
|
|
<param name="connection">
|
|
The Bugstar connection to use when performing requests.
|
|
</param>
|
|
<param name="xmlElement">
|
|
The Xml representation of this project.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.Project.Categories">
|
|
<summary>
|
|
Gets the list of categories this project contains by querying Bugstar for the data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.Project.Components">
|
|
<summary>
|
|
Gets the list of components this project contains by querying Bugstar for the data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.Project.CurrentUser">
|
|
<summary>
|
|
Gets the user that is currently logged into the REST services by querying Bugstar
|
|
for that information.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.Project.Maps">
|
|
<summary>
|
|
Gets the list of map this project contains by querying Bugstar for the data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.Project.Missions">
|
|
<summary>
|
|
Gets the list of missions this project contains by querying Bugstar for the data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.Project.Name">
|
|
<summary>
|
|
Gets or sets the name of the project.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.Project.Priorities">
|
|
<summary>
|
|
Gets the list of priorities this project contains by querying Bugstar for the data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.Project.Query">
|
|
<summary>
|
|
Gets the query to use to query Bugstar about this object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.Project.Users">
|
|
<summary>
|
|
Gets the list of users this project contains by querying Bugstar for the data.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetProjectById(RSG.Interop.Bugstar.BugstarConnection,System.UInt32)">
|
|
<summary>
|
|
Queries Bugstar for a project based on its id.
|
|
</summary>
|
|
<param name="connection">
|
|
The connection to use to query for the information.
|
|
</param>
|
|
<param name="id">
|
|
The id of the project to retrieve.
|
|
</param>
|
|
<returns>
|
|
An instance of the project.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetProjectByIdAsync(RSG.Interop.Bugstar.BugstarConnection,System.UInt32)">
|
|
<summary>
|
|
Queries Bugstar for a project based on its id.
|
|
</summary>
|
|
<param name="connection">
|
|
The connection to use to query for the information.
|
|
</param>
|
|
<param name="id">
|
|
The id of the project to retrieve.
|
|
</param>
|
|
<returns>
|
|
The task object representing the asynchronous operation.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetProjects(RSG.Interop.Bugstar.BugstarConnection)">
|
|
<summary>
|
|
Returns an array of all the projects the logged in user has access to in Bugstar.
|
|
</summary>
|
|
<param name="connection">
|
|
The connection to use to query for the information.
|
|
</param>
|
|
<returns>
|
|
An array of the projects.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetProjectsAsync(RSG.Interop.Bugstar.BugstarConnection)">
|
|
<summary>
|
|
Returns an array of all the projects the logged in user has access to in Bugstar.
|
|
</summary>
|
|
<param name="connection">
|
|
The connection to use to query for the information.
|
|
</param>
|
|
<returns>
|
|
An array of the projects.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetCurrentUserAsync">
|
|
<summary>
|
|
Queries Bugstar for information about the current user.
|
|
</summary>
|
|
<returns>
|
|
The current user.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetOpenBugsInArea(RSG.Base.Math.Vector2f,System.Single)">
|
|
<summary>
|
|
Gets the list of bugs that are within a specified distance of a location by
|
|
querying Bugstar for the data returning solely the bug ids.
|
|
</summary>
|
|
<param name="location">
|
|
The location to search around.
|
|
</param>
|
|
<param name="radius">
|
|
The radius to search for. The radius isn't a radius in the traditional sense, but
|
|
half the dimension of the bounding rectangle instead.
|
|
</param>
|
|
<returns>
|
|
The list of bugs that fall within the specified area.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetOpenBugsInArea(RSG.Base.Math.Vector2f,System.Single,System.String)">
|
|
<summary>
|
|
Gets the list of bugs that are within a specified distance of a location by
|
|
querying Bugstar for the data returning bugs containing the specified fields.
|
|
</summary>
|
|
<param name="location">
|
|
The location to search around.
|
|
</param>
|
|
<param name="radius">
|
|
The radius to search for. The radius isn't a radius in the traditional sense, but
|
|
half the dimension of the bounding rectangle instead.
|
|
</param>
|
|
<param name="fields">
|
|
The comma separated list of fields to retrieve.
|
|
</param>
|
|
<returns>
|
|
The list of bugs that fall within the specified area.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetTeamsList">
|
|
<summary>
|
|
Queries Bugstar for a list of the teams associated with this project.
|
|
</summary>
|
|
<returns>
|
|
The list of teams associated with this project.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetTeamsListAsync">
|
|
<summary>
|
|
Queries Bugstar async for a list of the teams associated with this project.
|
|
</summary>
|
|
<returns>
|
|
The list of teams associated with this project.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetDefaultsGroupsList">
|
|
<summary>
|
|
Queries Bugstar for a list of the default groups associated with this project.
|
|
</summary>
|
|
<returns>
|
|
The list of default groups for this project.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetDefaultsGroupsListAsync">
|
|
<summary>
|
|
Queries Bugstar async for a list of the default groups associated with this project.
|
|
</summary>
|
|
<returns>
|
|
The list of default groups for this project.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetUsersList">
|
|
<summary>
|
|
Queries Bugstar for a list of the users associated with this project.
|
|
</summary>
|
|
<returns>
|
|
The list of users this project contains.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetComponents">
|
|
<summary>
|
|
Queries Bugstar for a list of the components associated with this project.
|
|
</summary>
|
|
<returns>
|
|
The list of components this project contains.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetBugsBySearchId(System.UInt32,System.String)">
|
|
<summary>
|
|
Get open bugs by search Id.
|
|
</summary>
|
|
<param name="searchId">Search Id.</param>
|
|
<param name="fields">Fields.</param>
|
|
<returns>Open bugs Bug list.</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetBugsByGroupId(System.UInt32,System.String)">
|
|
<summary>
|
|
Get open bugs by group Id.
|
|
</summary>
|
|
<param name="groupId">Group Id.</param>
|
|
<param name="fields">Fields.</param>
|
|
<returns>Open bugs Bug list.</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetUsersListAsync">
|
|
<summary>
|
|
Queries Bugstar for a list of the users associated with this project.
|
|
</summary>
|
|
<returns>
|
|
The list of users this project contains.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetOwnersList">
|
|
<summary>
|
|
Queries Bugstar for a list of the users associated with this project that can be
|
|
bug owners.
|
|
</summary>
|
|
<returns>
|
|
The list of users this project contains that can be owners.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetOwnersListAsync">
|
|
<summary>
|
|
Queries Bugstar for a list of the users associated with this project that can be
|
|
bug owners.
|
|
</summary>
|
|
<returns>
|
|
The list of users this project contains that can be owners.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetQaOwnersList">
|
|
<summary>
|
|
Queries Bugstar for a list of the users associated with this project that can be
|
|
qa owners.
|
|
</summary>
|
|
<returns>
|
|
The list of users this project contains that can be owners.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetQaOwnersListAsync">
|
|
<summary>
|
|
Queries Bugstar for a list of the users associated with this project that can be
|
|
qa owners.
|
|
</summary>
|
|
<returns>
|
|
The list of users this project contains that can be owners.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetUserByIdAsync(System.UInt32)">
|
|
<summary>
|
|
Queries bugstar asynchronously for user with id provided.
|
|
</summary>
|
|
<param name="id">Id to query with.</param>
|
|
<returns>User object</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetUserById(System.UInt32)">
|
|
<summary>
|
|
Queries bugstar for user with id provided.
|
|
</summary>
|
|
<param name="id">Id to query with.</param>
|
|
<returns>User object</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetComponentsAsync">
|
|
<summary>
|
|
Queries Bugstar for a list of the components associated with this project.
|
|
</summary>
|
|
<returns>
|
|
The list of components this project contains.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetMissionsListAsync">
|
|
<summary>
|
|
Queries Bugstar Async'ly for a list of the missions associated with this project.
|
|
</summary>
|
|
<returns>
|
|
The list of missions this project contains.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetMissionsList">
|
|
<summary>
|
|
Queries Bugstar for a list of the missions associated with this project.
|
|
</summary>
|
|
<returns>
|
|
The list of missions this project contains.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetBugsBySearchIdAsync(System.UInt32,System.String)">
|
|
<summary>
|
|
Get open bugs by search Id.
|
|
</summary>
|
|
<param name="searchId">Search Id.</param>
|
|
<param name="fields">Fields.</param>
|
|
<returns>Open bugs Bug list.</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetBugsByGroupIdAsync(System.UInt32,System.String)">
|
|
<summary>
|
|
Get open bugs by group Id.
|
|
</summary>
|
|
<param name="groupId">Group Id.</param>
|
|
<param name="fields">Fields.</param>
|
|
<returns>Open bugs Bug list.</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetBugById(System.UInt32)">
|
|
<summary>
|
|
Get open bugs by group Id.
|
|
</summary>
|
|
<param name="id">Bug Id.</param>
|
|
<returns>Open bugs Bug list.</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetBugByIdAsync(System.UInt32)">
|
|
<summary>
|
|
Get open bugs by group Id.
|
|
</summary>
|
|
<param name="id">Bug Id.</param>
|
|
<returns>Open bugs Bug list.</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetSearches">
|
|
<summary>
|
|
Get searches for current user.
|
|
</summary>
|
|
<returns>Enumerable of Searches</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetSearchesAsync">
|
|
<summary>
|
|
Get searches for current user.
|
|
</summary>
|
|
<returns>Enumerable of Searches</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetGroups">
|
|
<summary>
|
|
Get groups for current user.
|
|
</summary>
|
|
<returns>Enumerable of Groups</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetGroupsAsync">
|
|
<summary>
|
|
Get groups for current user.
|
|
</summary>
|
|
<returns>Enumerable of Groups</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.CreateBug(RSG.Interop.Bugstar.Bug)">
|
|
<summary>
|
|
Create a new bug.
|
|
</summary>
|
|
<param name="bug">Bug to create.</param>
|
|
<returns>Success.</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.CreateBugAsync(RSG.Interop.Bugstar.Bug)">
|
|
<summary>
|
|
Create a new bug.
|
|
</summary>
|
|
<param name="bug">Bug to create.</param>
|
|
<returns>Success.</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.SetBug(RSG.Interop.Bugstar.Bug)">
|
|
<summary>
|
|
Sets bug data.
|
|
</summary>
|
|
<param name="bug">Bug to update.</param>
|
|
<returns>Success.</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.SetBugAsync(RSG.Interop.Bugstar.Bug)">
|
|
<summary>
|
|
Sets bug data.
|
|
</summary>
|
|
<param name="bug">Bug to update.</param>
|
|
<returns>Success.</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.AddComment(System.UInt32,RSG.Interop.Bugstar.BugComment)">
|
|
<summary>
|
|
Add a cmoment to a bug.
|
|
</summary>
|
|
<param name="bugId">Bug identifier.</param>
|
|
<param name="comment">Comment.</param>
|
|
<returns>Result.</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.AddCommentAsync(System.UInt32,RSG.Interop.Bugstar.BugComment)">
|
|
<summary>
|
|
Add a cmoment to a bug asynchronously.
|
|
</summary>
|
|
<param name="bugId">Bug identifier.</param>
|
|
<param name="comment">Comment.</param>
|
|
<returns>Result.</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetMapList">
|
|
<summary>
|
|
Queries Bugstar for a list of maps associated with this project.
|
|
</summary>
|
|
<returns>
|
|
The list of maps this project contains.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetMapListAsync">
|
|
<summary>
|
|
Queries Bugstar async for a list of maps associated with this project.
|
|
</summary>
|
|
<returns>
|
|
A task representing the action.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.SetBugAction(System.UInt32,RSG.Interop.Bugstar.BugAction)">
|
|
<summary>
|
|
Set a bugs status.
|
|
</summary>
|
|
<param name="bugId">Id of bug to affect.</param>
|
|
<param name="action">Bug state to set.</param>
|
|
<returns>Result of status change.</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.SetBugActionAsync(System.UInt32,RSG.Interop.Bugstar.BugAction)">
|
|
<summary>
|
|
Set a bugs status asynchronously.
|
|
</summary>
|
|
<param name="bugId">Id of bug to affect.</param>
|
|
<param name="action">Bug state to set.</param>
|
|
<returns>Result of status change.</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.AddTimeSpentAsync(RSG.Interop.Bugstar.BugTimeRecordCreator)">
|
|
<summary>
|
|
Add time spent to a bug.
|
|
</summary>
|
|
<param name="bugTimeRecordCreator">Time record.</param>
|
|
<returns>Result of status change.</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Generates an object from its XML representation.
|
|
</summary>
|
|
<param name="node">
|
|
The Xml element containing the projects data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetBugByQuery(System.Uri)">
|
|
<summary>
|
|
Gets a bug given a rest uri.
|
|
</summary>
|
|
<param name="restUri">REST Uri to bug.</param>
|
|
<returns>Constructed Bug object.</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetCurrentUserFast">
|
|
<summary>
|
|
Cached version of GetCurrentUser.
|
|
</summary>
|
|
<returns>The current user.</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetCurrentUserFastAsync">
|
|
<summary>
|
|
Cached version of GetCurrentUserASync.
|
|
</summary>
|
|
<returns>The current user.</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetCurrentUser">
|
|
<summary>
|
|
Queries Bugstar for information about the current user.
|
|
</summary>
|
|
<returns>
|
|
The current user.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetComponentsList">
|
|
<summary>
|
|
Queries Bugstar for a list of components associated with this project.
|
|
</summary>
|
|
<returns>
|
|
The list of components this project contains.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetCategoryList">
|
|
<summary>
|
|
Queries Bugstar for a list of bug categories.
|
|
</summary>
|
|
<returns>
|
|
The list of categories this project contains.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.Project.GetPriorityList">
|
|
<summary>
|
|
Queries Bugstar for the list of bug priorities.
|
|
</summary>
|
|
<returns>
|
|
The list of priorities this project contains.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Organisation.User">
|
|
<summary>
|
|
Bugstar user; permissions, reports and graphs.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.User.LogCtx">
|
|
<summary>
|
|
The message context to use when logging information for this object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.User._imageLock">
|
|
<summary>
|
|
The lock object used to provide thread-safe access to the <see cref="P:RSG.Interop.Bugstar.Organisation.User.Image"/>
|
|
property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.User._image">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Interop.Bugstar.Organisation.User.Image"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.User._imageAttachmentId">
|
|
<summary>
|
|
The image attachment id for the users image.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.User._studio">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Interop.Bugstar.Organisation.User.Studio"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Organisation.User._studioId">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Interop.Bugstar.Organisation.User.StudioId"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.User.#ctor(RSG.Interop.Bugstar.Organisation.Project)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Organisation.User"/> class for the specified
|
|
project.
|
|
</summary>
|
|
<param name="project">
|
|
The project this user is being created for.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.User.#ctor(RSG.Interop.Bugstar.Organisation.Project,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Organisation.User"/> class for the specified
|
|
project initialising it with the data contained in the Xml element.
|
|
</summary>
|
|
<param name="project">
|
|
The project this user is being created for.
|
|
</param>
|
|
<param name="xmlElement">
|
|
The Xml representation of this user.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.User.#ctor(RSG.Interop.Bugstar.Organisation.Project,System.Xml.Linq.XDocument)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Organisation.User"/> class for the specified
|
|
project initialising it with the data contained in the Xml document.
|
|
</summary>
|
|
<param name="project">
|
|
The project this user is being created for.
|
|
</param>
|
|
<param name="xmlUserDocument">
|
|
The Xml document containing the representation of this document.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.User.Email">
|
|
<summary>
|
|
Gets or sets the users email address (e.g. michael.taschler@rockstarnorth.com).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.User.FirstName">
|
|
<summary>
|
|
Gets or sets the users first name (e.g. Michael).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.User.Graphs">
|
|
<summary>
|
|
Gets a list of graphs for this user by query Bugstar for that information.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.User.Groups">
|
|
<summary>
|
|
Gets a list of groups this user has available to them by query Bugstar for that
|
|
information.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.User.Image">
|
|
<summary>
|
|
Gets the image to display for the user.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.User.IsActive">
|
|
<summary>
|
|
Gets a value indicating whether this user is active. An user is marked as inactive
|
|
when they are no longer at the company.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.User.JobTitle">
|
|
<summary>
|
|
Gets or sets the users job title (e.g. Awesome Tools Programmer).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.User.LastName">
|
|
<summary>
|
|
Gets or sets the users surname (e.g. Täschler).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.User.Permissions">
|
|
<summary>
|
|
Gets the permissions table for the user; see string constants for keys.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.User.Query">
|
|
<summary>
|
|
Gets the query to use to query Bugstar about this object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.User.Reports">
|
|
<summary>
|
|
Gets the list of reports this user has by querying Bugstar for that information.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.User.Studio">
|
|
<summary>
|
|
Gets the studio this user is a part of.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.User.UserName">
|
|
<summary>
|
|
Gets or sets the users user name (e.g. michael.taschler).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Organisation.User.StudioId">
|
|
<summary>
|
|
Gets the id that corresponds to the studio this user is a part of.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.User.GetUserById(RSG.Interop.Bugstar.Organisation.Project,System.UInt32)">
|
|
<summary>
|
|
Return Bugstar User object from their ID.
|
|
</summary>
|
|
<param name="project">
|
|
The project to retrieve the user for.
|
|
</param>
|
|
<param name="id">
|
|
The users Id.
|
|
</param>
|
|
<returns>
|
|
The user specified by the Id.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.User.PerformSearch(RSG.Interop.Bugstar.Search.SearchType)">
|
|
<summary>
|
|
Runs a simple search based on the type of object to search for
|
|
</summary>
|
|
<param name="type">
|
|
The type of search to return.
|
|
</param>
|
|
<returns>
|
|
A list of the users searches.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.User.PerformSearchAsync(RSG.Interop.Bugstar.Search.SearchType)">
|
|
<summary>
|
|
Asynchronously queries for the list of searches this user has for the specified
|
|
type.
|
|
</summary>
|
|
<param name="type">
|
|
The type of searches to return.
|
|
</param>
|
|
<returns>
|
|
The task object representing the asynchronous operation.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.User.GetGroupsListAsync">
|
|
<summary>
|
|
Queries Bugstar Async'ly for the list of groups for this user.
|
|
</summary>
|
|
<returns>
|
|
The list of groups this user is a part of.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.User.ReleaseImage">
|
|
<summary>
|
|
Release the reference to the user image (subsequent calls to Image will re-request
|
|
the image). Call this if you no longer need to access the image, but still hold a
|
|
reference to the User.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.User.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Generates an object from its XML representation.
|
|
</summary>
|
|
<param name="xmlUserElem">
|
|
The Xml element containing the users data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.User.GetImage">
|
|
<summary>
|
|
Gets the users image by querying the attachment service for that data.
|
|
</summary>
|
|
<returns>
|
|
A BitmapImage containing the users image.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.User.GetReportsList">
|
|
<summary>
|
|
Queries Bugstar for the list of reports for this user.
|
|
</summary>
|
|
<returns>
|
|
The list of reports the user has.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.User.GetGraphsList">
|
|
<summary>
|
|
Queries Bugstar for the list of graphs for this user.
|
|
Note: Currently this does it slightly inefficiently by searching for a list of id's
|
|
then querying for each graph.
|
|
</summary>
|
|
<returns>
|
|
The list of graphs the user has.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.User.GetGroupsList">
|
|
<summary>
|
|
Queries Bugstar for the list of groups for this user.
|
|
</summary>
|
|
<returns>
|
|
The list of groups this user is a part of.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Organisation.User.GetPermissionsTable">
|
|
<summary>
|
|
Query current user for available permissions.
|
|
</summary>
|
|
<returns>
|
|
The list of permissions the user has set.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Search.Graph">
|
|
<summary>
|
|
Represents a Bugstar graph.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Search.Graph.LogCtx">
|
|
<summary>
|
|
The message context to use when logging information for this object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Search.Graph.#ctor(RSG.Interop.Bugstar.Organisation.User)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Search.Graph"/> class for the specified user.
|
|
</summary>
|
|
<param name="user">
|
|
The user this graph is being created for.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Search.Graph.#ctor(RSG.Interop.Bugstar.Organisation.User,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Search.Graph"/> class for the specified user
|
|
using the Xml element as the source of the graphs content.
|
|
</summary>
|
|
<param name="user">
|
|
The user this graph is being created for.
|
|
</param>
|
|
<param name="xmlElement">
|
|
The Xml element containing the graphs data.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Search.Graph.DataPoints">
|
|
<summary>
|
|
Gets the data points that contain the graph data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Search.Graph.Description">
|
|
<summary>
|
|
Gets or sets the description of the graph.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Search.Graph.GraphType">
|
|
<summary>
|
|
Gets or sets the type of graph this is.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Search.Graph.GroupedField">
|
|
<summary>
|
|
Gets or sets the field the data is grouped by.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Search.Graph.Name">
|
|
<summary>
|
|
Gets or sets the name of the graph.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Search.Graph.Query">
|
|
<summary>
|
|
Gets the query to use to query Bugstar about this object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Search.Graph.User">
|
|
<summary>
|
|
Gets or sets the user this graph belongs to.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Search.Graph.XAxisTitle">
|
|
<summary>
|
|
Gets or sets the title of the graph's x-axis.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Search.Graph.YAxisTitle">
|
|
<summary>
|
|
Gets or sets the title of the graph's y-axis.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Search.Graph.GetGraphById(RSG.Interop.Bugstar.Organisation.User,System.UInt32)">
|
|
<summary>
|
|
Queries Bugstar for a graph based on it's user and id.
|
|
</summary>
|
|
<param name="user">
|
|
The user to fetch the graph for.
|
|
</param>
|
|
<param name="id">
|
|
The id of the graph to retrieve.
|
|
</param>
|
|
<returns>
|
|
An instance of the graph.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Search.Graph.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Generates an object from its XML representation.
|
|
</summary>
|
|
<param name="node">
|
|
The Xml element containing the graphs data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Search.Graph.GetDataPointsList">
|
|
<summary>
|
|
Gets the list of data points for this graph.
|
|
</summary>
|
|
<returns>
|
|
The list of data points for the graph.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Search.GraphType">
|
|
<summary>
|
|
The various types of graphs that Bugstar contains.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Search.GraphType.Pie">
|
|
<summary>
|
|
Pie graph.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Search.GraphType.Bar">
|
|
<summary>
|
|
Bar chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Search.GraphType.Column">
|
|
<summary>
|
|
Column chart.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Search.GraphType.DataScreen">
|
|
<summary>
|
|
Data screen (custom graphs for TVs, etc...)
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Search.Group">
|
|
<summary>
|
|
Represents a group of Bugstar bugs.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Search.Group._user">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Interop.Bugstar.Search.Group.User"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Search.Group._description">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Interop.Bugstar.Search.Group.Description"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Search.Group._name">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Interop.Bugstar.Search.Group.Name"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Search.Group._shareType">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Interop.Bugstar.Search.Group.ShareType"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Search.Group.#ctor(RSG.Interop.Bugstar.Organisation.User)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Search.Group"/> class for the specified user.
|
|
</summary>
|
|
<param name="user">
|
|
The user to create the group for.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Search.Group.#ctor(RSG.Interop.Bugstar.Organisation.User,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Search.Group"/> class for the specified user.
|
|
</summary>
|
|
<param name="user">
|
|
The user to create the group for.
|
|
</param>
|
|
<param name="xmlElement">
|
|
The Xml element containing the groups data.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Search.Group.Description">
|
|
<summary>
|
|
Gets the description of this group.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Search.Group.Name">
|
|
<summary>
|
|
Gets the name of the group.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Search.Group.Query">
|
|
<summary>
|
|
Gets the query to use to query Bugstar about this object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Search.Group.ShareType">
|
|
<summary>
|
|
Gets the way this search is shared.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Search.Group.User">
|
|
<summary>
|
|
Gets the user that owns this group.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Search.Group.CompareTo(RSG.Interop.Bugstar.Search.Group)">
|
|
<summary>
|
|
Compares this Bugstar group against another.
|
|
</summary>
|
|
<param name="other">
|
|
The group to compare this group against.
|
|
</param>
|
|
<returns>
|
|
A value indicating how this group compares against the specified group.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Search.Group.Equals(RSG.Interop.Bugstar.Search.Group)">
|
|
<summary>
|
|
Indicates whether this Group is equal to another one. Equality is determined by
|
|
the group id.
|
|
</summary>
|
|
<param name="other">
|
|
The item to check equality against.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if the objects have the same id; otherwise, <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Search.Group.GetBugs">
|
|
<summary>
|
|
Queries Bugstar for a list of bugs that are a part of this group.
|
|
</summary>
|
|
<returns>
|
|
The list of bugs this group contains.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Search.Group.GetBugs(System.Collections.Generic.IEnumerable{RSG.Interop.Bugstar.BugField},System.Int32)">
|
|
<summary>
|
|
Queries Bugstar for a list of bugs that are a part of this group returning only the
|
|
requested fields.
|
|
</summary>
|
|
<param name="fields">
|
|
The list of fields to retrieve.
|
|
</param>
|
|
<param name="queryPageSize">Optional page size for the query.</param>
|
|
<returns>
|
|
The list of bugs this group contains.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Search.Group.GetBugsAsync(System.Collections.Generic.IEnumerable{RSG.Interop.Bugstar.BugField})">
|
|
<summary>
|
|
Queries Bugstar for a list of bugs that are in this group, only
|
|
returning the data for the requested fields.
|
|
</summary>
|
|
<param name="fields">
|
|
The list of fields to retrieve.
|
|
</param>
|
|
<returns>
|
|
The task object representing the asynchronous operation.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Search.Group.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Generates an object from its XML representation.
|
|
</summary>
|
|
<param name="node">
|
|
The Xml element containing the groups data.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Search.Report">
|
|
<summary>
|
|
Represents a Bugstar report.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Search.Report.#ctor(RSG.Interop.Bugstar.Organisation.User)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Search.Report"/> class for the specified
|
|
user.
|
|
</summary>
|
|
<param name="user">
|
|
The user to create the report for.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Search.Report.#ctor(RSG.Interop.Bugstar.Organisation.User,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.Search.Report"/> class for the specified
|
|
user.
|
|
</summary>
|
|
<param name="user">
|
|
The user to create the report for.
|
|
</param>
|
|
<param name="xmlElement">
|
|
The Xml element containing the reports data.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Search.Report.DataStream">
|
|
<summary>
|
|
Gets the data retrieved when querying Bugstar about this report
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Search.Report.Description">
|
|
<summary>
|
|
Gets or sets the description of the report
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Search.Report.Name">
|
|
<summary>
|
|
Gets or sets the name of the report.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Search.Report.StylesheetStream">
|
|
<summary>
|
|
Gets the stylesheet to use to render this report.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Search.Report.SubType">
|
|
<summary>
|
|
Gets or sets the sub type of the report as seen in url:bugstar:1359032.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Search.Report.Query">
|
|
<summary>
|
|
Gets the query to use to query Bugstar about this object.
|
|
</summary>
|
|
<remarks>
|
|
Note: For reports the following query returns the report data, not the report information
|
|
The Bugstar query for this should be changed at some point.
|
|
e.g.
|
|
.../User/{id}/Reports/{id} - returns id/name/description/etc info
|
|
.../User/{id}/Reports/{id}/Data - returns report data
|
|
.../User/{id}/Reports/{id}/Stylesheet - returns report stylesheet
|
|
</remarks>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Search.Report.User">
|
|
<summary>
|
|
Gets or sets the user that owns this report.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Search.Report.GetReportById(RSG.Interop.Bugstar.Organisation.User,System.UInt32)">
|
|
<summary>
|
|
Queries Bugstar for a report based on it's user and id.
|
|
</summary>
|
|
<param name="user">
|
|
The user to fetch the report for.
|
|
</param>
|
|
<param name="id">
|
|
The id of the report to retrieve.
|
|
</param>
|
|
<returns>
|
|
An instance of the report.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Search.Report.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Generates an object from its XML representation.
|
|
</summary>
|
|
<param name="node">
|
|
The Xml element containing the reports data.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Search.ReportSubType">
|
|
<summary>
|
|
Defines the different types of Bugstar reports that exist.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Search.ReportSubType.Unknown">
|
|
<summary>
|
|
Report is of an unknown type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Search.ReportSubType.Report">
|
|
<summary>
|
|
Represents a normal user generated Bugstar report.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Search.ReportSubType.Screen">
|
|
<summary>
|
|
A report to display on a TV screen.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Search.ReportSubType.Notification">
|
|
<summary>
|
|
A notification report.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Search.ReportSubType.FlashReport">
|
|
<summary>
|
|
A flash based report.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Search.Search">
|
|
<summary>
|
|
Represents a Bugstar search.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Search.Search.BugQueryPageSize">
|
|
<summary>
|
|
The number of bugs to return per page when querying Bugstar for the bugs in this
|
|
search.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Search.Search.#ctor(RSG.Interop.Bugstar.Organisation.User)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:RSG.Interop.Bugstar.Search.Search"/> class for the specified
|
|
user.
|
|
</summary>
|
|
<param name="user">
|
|
The user this search is being created for.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Search.Search.#ctor(RSG.Interop.Bugstar.Organisation.User,System.UInt32)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:RSG.Interop.Bugstar.Search.Search"/> class for the specified
|
|
user.
|
|
</summary>
|
|
<param name="user">
|
|
The user this search is being created for.
|
|
</param>
|
|
<param name="id">
|
|
The id of the search you wish to run
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Search.Search.#ctor(RSG.Interop.Bugstar.Organisation.User,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:RSG.Interop.Bugstar.Search.Search"/> class for the specified user
|
|
using the Xml element as the source of the search content.
|
|
</summary>
|
|
<param name="user">
|
|
The user this search is being created for.
|
|
</param>
|
|
<param name="xmlElement">
|
|
The Xml element containing the search data.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Search.Search.Description">
|
|
<summary>
|
|
Gets or sets the description of the search.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Search.Search.Name">
|
|
<summary>
|
|
Gets or sets the name of the search.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Search.Search.Query">
|
|
<summary>
|
|
Gets the query to use to query Bugstar about this object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Search.Search.SearchType">
|
|
<summary>
|
|
Gets or sets the type of search this is.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Search.Search.ShareType">
|
|
<summary>
|
|
Gets or sets the way in which this search is shared.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Search.Search.User">
|
|
<summary>
|
|
Gets or sets the user this search belongs to.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Search.Search.CompareTo(RSG.Interop.Bugstar.Search.Search)">
|
|
<summary>
|
|
Compares this Bugstar search against another.
|
|
</summary>
|
|
<param name="other">
|
|
The group to compare this search against.
|
|
</param>
|
|
<returns>
|
|
A value indicating how this search compares against the specified search.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Search.Search.Equals(RSG.Interop.Bugstar.Search.Search)">
|
|
<summary>
|
|
Indicates whether this Search is equal to another one. Equality is determined by
|
|
the searches id.
|
|
</summary>
|
|
<param name="other">
|
|
The item to check equality against.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if the objects have the same id; otherwise, <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Search.Search.GetBugs">
|
|
<summary>
|
|
Queries Bugstar for a list of bugs that are returned when invoking this search.
|
|
</summary>
|
|
<returns>
|
|
The list of bugs this search contains.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Search.Search.GetBugs(System.Collections.Generic.IEnumerable{RSG.Interop.Bugstar.BugField})">
|
|
<summary>
|
|
Queries Bugstar for a list of bugs that are returned when invoking this search only
|
|
returning the data for the requested fields.
|
|
</summary>
|
|
<param name="fields">
|
|
The list of fields to retrieve.
|
|
</param>
|
|
<returns>
|
|
The list of bugs this search contains.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Search.Search.GetBugsAsync(System.Collections.Generic.IEnumerable{RSG.Interop.Bugstar.BugField},System.Int32)">
|
|
<summary>
|
|
Queries Bugstar for a list of bugs that are returned when invoking this search only
|
|
returning the data for the requested fields.
|
|
</summary>
|
|
<param name="fields">
|
|
The list of fields to retrieve.
|
|
</param>
|
|
<param name="bugQueryPageSize">Specify an optional page size for the query. This relates to the amount of bugs returned per REST API call.</param>
|
|
<returns>
|
|
The task object representing the asynchronous operation.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Search.Search.GetBugs(System.String)">
|
|
<summary>
|
|
Queries Bugstar for a list of bugs that are returned when invoking this search only
|
|
returning the data for the requested fields.
|
|
</summary>
|
|
<param name="fields">
|
|
The comma separated list of fields to retrieve.
|
|
</param>
|
|
<returns>
|
|
The list of bugs this search contains.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Search.Search.GetSearchQueryString(RSG.Interop.Bugstar.Search.SearchType)">
|
|
<summary>
|
|
Gets the search string to use when querying Bugstar about this search.
|
|
</summary>
|
|
<param name="type">
|
|
The type of search to get the search string for.
|
|
</param>
|
|
<returns>
|
|
The search string to use.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Search.Search.Deserialise(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
Generates an object from its XML representation.
|
|
</summary>
|
|
<param name="node">
|
|
The Xml element containing the graphs data.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Search.SearchType">
|
|
<summary>
|
|
Type of search this is.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Search.SearchType.PublicSearch">
|
|
<summary>
|
|
Basic search.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Search.SearchType.Graph">
|
|
<summary>
|
|
Graph.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Search.SearchType.RestReportInstance">
|
|
<summary>
|
|
Report.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Search.SearchType.Group">
|
|
<summary>
|
|
Group.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Search.ShareType">
|
|
<summary>
|
|
Accessibility of the share
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Search.ShareType.Global">
|
|
<summary>
|
|
Shared with everyone.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Search.ShareType.Shared">
|
|
<summary>
|
|
Some specifically shared this with you.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Search.ShareType.Modifiable">
|
|
<summary>
|
|
Created by the local user and thus modifiable.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.BugstarConnection">
|
|
<summary>
|
|
Bugstar REST service connection.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugstarConnection.LogCtx">
|
|
<summary>
|
|
The message context to use when logging information for this object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugstarConnection.BufferSize">
|
|
<summary>
|
|
Buffer size for document reads.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugstarConnection._authenticationCookieTimeoutDuration">
|
|
<summary>
|
|
The amount of time it takes for the authentication cookie to timeout.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugstarConnection._authenticatedCookie">
|
|
<summary>
|
|
The authenticated cookie to use when executing queries against Bugstar.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarConnection.#cctor">
|
|
<summary>
|
|
Initialises static members of the <see cref="T:RSG.Interop.Bugstar.BugstarConnection"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarConnection.#ctor(System.Uri,System.Uri)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.BugstarConnection"/> class using the
|
|
specified addresses to connect to Bugstar.
|
|
</summary>
|
|
<param name="restService">
|
|
The address of the Bugstar REST service.
|
|
</param>
|
|
<param name="attachmentService">
|
|
The address of the Bugstar attachement service.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarConnection.#ctor(System.Uri,System.Uri,System.Uri,System.Int32)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.BugstarConnection"/> class using the
|
|
specified addresses to connect to Bugstar.
|
|
</summary>
|
|
<param name="restService">
|
|
The address of the Bugstar REST service.
|
|
</param>
|
|
<param name="attachmentService">
|
|
The address of the Bugstar attachement service.
|
|
</param>
|
|
<param name="authenticationService">
|
|
The address of the Bugstar authentication service.
|
|
</param>
|
|
<param name="authenticationCookieTimeout">
|
|
The timeout of the authentication cookie.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugstarConnection.RESTService">
|
|
<summary>
|
|
Gets the root REST service Uri.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugstarConnection.AttachmentService">
|
|
<summary>
|
|
Gets the root attachment service Uri.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugstarConnection.AuthenticationService">
|
|
<summary>
|
|
Gets the authentication service Uri.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugstarConnection.IsReadOnly">
|
|
<summary>
|
|
Gets or sets a value indicating whether the connection is readonly.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugstarConnection.Log">
|
|
<summary>
|
|
Gets the log object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarConnection.IsValidConnection">
|
|
<summary>
|
|
Indicates whether the connection is valid.
|
|
</summary>
|
|
<returns>
|
|
<c>True</c> if the connection is valid; otherwise, <c>False</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarConnection.Login(System.String,System.String,System.String)">
|
|
<summary>
|
|
Attempts to connect to server with the supplied username/password.
|
|
</summary>
|
|
<param name="username">
|
|
The name of the user to login.
|
|
</param>
|
|
<param name="password">
|
|
The password to use.
|
|
</param>
|
|
<param name="domain">
|
|
The domain the user is a part of.
|
|
</param>
|
|
<returns>Ticket created after succesful login.</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarConnection.Login(RSG.Interop.Bugstar.BugstarTicket)">
|
|
<summary>
|
|
Attempts to connect to server with the supplied cookie.
|
|
</summary>
|
|
<param name="bugstarTicket">Bugstar ticket to login with</param>
|
|
<returns>True if login with the given ticket was succesful, otherwise false.</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarConnection.RunQuery(RSG.Base.Net.IRestQuery)">
|
|
<summary>
|
|
Runs a query against the Bugstar REST service logging the operation.
|
|
</summary>
|
|
<param name="query">
|
|
The query to run.
|
|
</param>
|
|
<returns>
|
|
The stream containing the queries response.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarConnection.RunQueryAsync(RSG.Base.Net.IRestQuery)">
|
|
<summary>
|
|
Asynchronously sends a query to the Bugstar server returning the resulting stream
|
|
of data.
|
|
</summary>
|
|
<param name="query">
|
|
The query to run.
|
|
</param>
|
|
<returns>
|
|
The task object representing the asynchronous operation.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarConnection.RunQueryWithXmlResult(RSG.Base.Net.IRestQuery)">
|
|
<summary>
|
|
Runs a query against the Bugstar REST service returning an Xml document that
|
|
contains the queries response.
|
|
</summary>
|
|
<param name="query">
|
|
The query to run.
|
|
</param>
|
|
<returns>
|
|
The Xml document containing the queries response.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarConnection.RunQueryWithXmlResultAsync(RSG.Base.Net.IRestQuery)">
|
|
<summary>
|
|
Asynchronously runs a query against the Bugstar REST service returning an Xml
|
|
document that contains the queries response.
|
|
</summary>
|
|
<param name="query">
|
|
The query to run.
|
|
</param>
|
|
<returns>
|
|
The task object representing the asynchronous operation.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarConnection.AcquireAuthenticatedCookie(System.Net.Cookie)">
|
|
<summary>
|
|
Acquires a newly authenticated cookie to use when running queries against bugstar.
|
|
</summary>
|
|
<param name="cookie">
|
|
The cookie to use for authentication.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarConnection.IsServerAvailable(System.String)">
|
|
<summary>
|
|
Pings REST service to see if we should be able to run rest queries on it
|
|
</summary>
|
|
<param name="host">
|
|
The host to ping.
|
|
</param>
|
|
<returns>
|
|
<c>True</c> if we can ping the server; otherwise, <c>False</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.BugstarQuery">
|
|
<summary>
|
|
Bugstar REST service query.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugstarQuery._queryUri">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Interop.Bugstar.BugstarQuery.QueryUri"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugstarQuery._method">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Interop.Bugstar.BugstarQuery.Method"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugstarQuery._contentType">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Interop.Bugstar.BugstarQuery.ContentType"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugstarQuery._data">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Interop.Bugstar.BugstarQuery.Data"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarQuery.#ctor(System.Uri)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.BugstarQuery"/> class using the
|
|
specified URI as a GET request.
|
|
</summary>
|
|
<param name="query">
|
|
The URI to query.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarQuery.#ctor(System.Uri,RSG.Base.Net.RequestMethod)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.BugstarQuery"/> class using the
|
|
specified URI and request method.
|
|
</summary>
|
|
<param name="query">
|
|
The URI to query.
|
|
</param>
|
|
<param name="method">
|
|
The HTTP request method.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarQuery.#ctor(System.Uri,RSG.Base.Net.RequestMethod,System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.BugstarQuery"/> class using the
|
|
specified URI and request method.
|
|
</summary>
|
|
<param name="query">
|
|
The URI to query.
|
|
</param>
|
|
<param name="method">
|
|
The HTTP request method.
|
|
</param>
|
|
<param name="data">
|
|
The data to send as content with the query.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarQuery.#ctor(RSG.Base.Net.IRestQuery,System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Interop.Bugstar.BugstarQuery"/> class using relative
|
|
query which is appended to a base query.
|
|
</summary>
|
|
<param name="baseQuery">
|
|
The base query for this one.
|
|
</param>
|
|
<param name="relativeQuery">
|
|
The relative query to add to the base one.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugstarQuery.QueryUri">
|
|
<summary>
|
|
Gets the uri for REST query.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugstarQuery.Method">
|
|
<summary>
|
|
Gets the HTTP verb for this query.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugstarQuery.ContentType">
|
|
<summary>
|
|
Gets the content-type for PUT/POST requests.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugstarQuery.Data">
|
|
<summary>
|
|
Gets the POST/PUT data.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.BugstarIcons">
|
|
<summary>
|
|
Provides static properties that gives access to common icons that can be used
|
|
with Bugstar-integrated applications.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugstarIcons.SyncRoot">
|
|
<summary>
|
|
A generic object that provides thread safety access to the image sources.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugstarIcons._bugstar128">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Interop.Bugstar.BugstarIcons.Bugstar128"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugstarIcons._bugstar32">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Interop.Bugstar.BugstarIcons.Bugstar32"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.BugstarIcons._bugstar16">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Interop.Bugstar.BugstarIcons.Bugstar16"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugstarIcons.Bugstar128">
|
|
<summary>
|
|
Gets the Bugstar application icon (128x128).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugstarIcons.Bugstar32">
|
|
<summary>
|
|
Gets the Bugstar application icon (32x32).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.BugstarIcons.Bugstar16">
|
|
<summary>
|
|
Gets the Bugstar application icon (16x16).
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.BugstarIcons.EnsureLoaded(System.String)">
|
|
<summary>
|
|
Ensures that the specified image source is loaded with the specified resource name.
|
|
</summary>
|
|
<param name="resourceName">
|
|
The name of the resource the loaded image source should set as its source.
|
|
</param>
|
|
<returns>
|
|
The image source.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.TimeType">
|
|
<summary>
|
|
Represents the various types of time that can be spent working on a bug.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.TimeType.Unknown">
|
|
<summary>
|
|
Unknown time type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.TimeType.Work">
|
|
<summary>
|
|
Work was done on the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.TimeType.Rework">
|
|
<summary>
|
|
Work had to be done again for the bug.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.TimeType.Exporting">
|
|
<summary>
|
|
Time was spent exporting.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.TimeType.ToolsIssue">
|
|
<summary>
|
|
Time was spent due to a tools issue.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.TimeType.BuildIssue">
|
|
<summary>
|
|
Time was spent due to a build issue.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.TimeType.Support">
|
|
<summary>
|
|
Time was spent providing support.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.TimeType.Default">
|
|
<summary>
|
|
The default type of time.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.TimeTypeUtils">
|
|
<summary>
|
|
TimeType enum extension and utility methods.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.TimeTypeUtils.FromBugstarString(System.String)">
|
|
<summary>
|
|
Attempts to convert a string to its corresponding <see cref="T:RSG.Interop.Bugstar.TimeType"/> enum
|
|
value.
|
|
</summary>
|
|
<param name="data">
|
|
The string representation of the enum value.
|
|
</param>
|
|
<returns>
|
|
The <see cref="T:RSG.Interop.Bugstar.TimeType"/> for the string; or <see cref="F:RSG.Interop.Bugstar.TimeType.Unknown"/> if the
|
|
string is not recognised.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.TimeTypeUtils.ToBugstarString(RSG.Interop.Bugstar.TimeType)">
|
|
<summary>
|
|
Converts a <see cref="T:RSG.Interop.Bugstar.TimeType"/> enum value to it's Bugstar string representation.
|
|
</summary>
|
|
<param name="timeType">
|
|
The enum value to convert.
|
|
</param>
|
|
<returns>
|
|
The string representation of the enum value.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Time.BugstarTime">
|
|
<summary>
|
|
Holds information about Bugstar time.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Time.BugstarTime.LengthOfOneHourInMinutes">
|
|
<summary>
|
|
Gets the length of one Bugstar hour.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Time.BugstarTime.LengthOfWorkDayInHours">
|
|
<summary>
|
|
Gets the length of a single work day in hours.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Time.BugstarTime.#ctor(System.Double,System.Double,System.UInt32)">
|
|
<summary>
|
|
Creates a new instance of <see cref="T:RSG.Interop.Bugstar.Time.BugstarTime"/>
|
|
</summary>
|
|
<param name="days">Number of days</param>
|
|
<param name="hours">Number of hours.</param>
|
|
<param name="minutes">Number of minutes</param>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Time.BugstarTime.Days">
|
|
<summary>
|
|
Gets the amount of days.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Time.BugstarTime.Hours">
|
|
<summary>
|
|
Gets the amount of hours.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Time.BugstarTime.Minutes">
|
|
<summary>
|
|
Gets the amount of minutes.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Time.BugstarTime.TotalDays">
|
|
<summary>
|
|
Gets the total time in days.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Time.BugstarTime.TotalHours">
|
|
<summary>
|
|
Gets the total time in hours.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Interop.Bugstar.Time.BugstarTime.TotalMinutes">
|
|
<summary>
|
|
Gets the total time in whole minutes.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Time.BugstarTime.ConvertBugstarTimeToString(RSG.Interop.Bugstar.Time.BugstarTime)">
|
|
<summary>
|
|
Convert the given time into a string.
|
|
</summary>
|
|
<param name="time">Bugstar time.</param>
|
|
<returns>Bugstar time as string.</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Time.BugstarTime.ToString">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Time.BugstarTimeFormatProvider">
|
|
<summary>
|
|
Formatter for Bugstar time in minutes.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Time.BugstarTimeFormatProvider.Format(System.String,System.Object,System.IFormatProvider)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Time.BugstarTimeFormatProvider.GetFormat(System.Type)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Time.BugstarTimeParser">
|
|
<summary>
|
|
Parses strings into <see cref="T:RSG.Interop.Bugstar.Time.BugstarTime"/>
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Time.BugstarTimeParser.DaysChar">
|
|
<summary>
|
|
Char used to signal days.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Time.BugstarTimeParser.HoursChar">
|
|
<summary>
|
|
Char used to signal hours.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Time.BugstarTimeParser.MinutesChar">
|
|
<summary>
|
|
Char used to signal minutes.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Time.BugstarTimeParser.IsValidTime(System.String)">
|
|
<summary>
|
|
Checks if the given input is a valid time.
|
|
</summary>
|
|
<param name="input">String input.</param>
|
|
<returns>True if this is a valid time input.</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Time.BugstarTimeParser.Parse(System.String)">
|
|
<summary>
|
|
Parse a Bugstar time from a given input.
|
|
</summary>
|
|
<param name="input">String input to parse from.</param>
|
|
<returns><see cref="T:RSG.Interop.Bugstar.Time.BugstarTime"/> representing the parsed time.</returns>
|
|
</member>
|
|
<member name="M:RSG.Interop.Bugstar.Time.BugstarTimeParser.TryParse(System.String,RSG.Interop.Bugstar.Time.BugstarTime@)">
|
|
<summary>
|
|
Try and parse <see cref="T:RSG.Interop.Bugstar.Time.BugstarTime"/>
|
|
</summary>
|
|
<param name="input">String input to parse.</param>
|
|
<param name="bugstarTime"><see cref="T:RSG.Interop.Bugstar.Time.BugstarTime"/> if parsed.</param>
|
|
<returns>True if valid, otherwise false.</returns>
|
|
</member>
|
|
<member name="T:RSG.Interop.Bugstar.Workflow">
|
|
<summary>
|
|
Represents the workflow that a bug can go through.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Workflow.RequiresVerification">
|
|
<summary>
|
|
Bugs required verification after having been resolved.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Workflow.Simple">
|
|
<summary>
|
|
Bugs go straight to the closed state after been resolved.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Interop.Bugstar.Workflow.RequiresBuild">
|
|
<summary>
|
|
Bugs require a build before they can be verified.
|
|
</summary>
|
|
</member>
|
|
</members>
|
|
</doc>
|