• Articles
  • Api Documentation
Show / Hide Table of Contents
  • Dapplo.Jira
    • AgileExtensions
    • AttachmentExtensions
    • FilterExtensions
    • IJiraClient
    • IssueExtensions
    • JiraClient
    • JiraConfig
    • JiraException
    • ProjectExtensions
    • ServerExtensions
    • SessionExtensions
    • TimeSpanExtensions
    • UserExtensions
    • WorkExtensions
  • Dapplo.Jira.Domains
    • IAgileDomain
    • IAttachmentDomain
    • IFilterDomain
    • IIssueDomain
    • IJiraDomain
    • IProjectDomain
    • IServerDomain
    • ISessionDomain
    • IUserDomain
    • IWorkDomain
  • Dapplo.Jira.Entities
    • AgileIssue
    • AgileIssueFields
    • AllowedValue
    • Attachment
    • AttachmentContainer<T>
    • AvatarUrls
    • BaseId<TId>
    • BaseProperties<TId>
    • Board
    • BoardConfiguration
    • Column
    • ColumnConfig
    • Comment
    • Comments
    • Component
    • ComponentDigest
    • Configuration
    • Epic
    • EpicColor
    • Error
    • EstimationCustomFieldInfo
    • EstimationFieldInfo
    • Field
    • Filter
    • Issue
    • IssueBase
    • IssueFields
    • IssueType
    • IssueWithFields<TFields>
    • LoginInfo
    • Pageable
    • PageableResult
    • PossibleField
    • Priority
    • ProgressInfo
    • Project
    • ProjectCategory
    • ProjectDigest
    • RankingCustomFieldInfo
    • Resolution
    • Results<TResultType>
    • Schema
    • Search
    • SearchResult<TIssue>
    • ServerInfo
    • SharePermission
    • Sprint
    • Status
    • StatusCategory
    • Subscription
    • Subscriptions
    • TimeTracking
    • TimeTrackingConfiguration
    • Transition
    • Transitions
    • User
    • Version
    • Visibility
    • VoteInfo
    • Watches
    • Worklog
    • Worklogs
  • Dapplo.Jira.Enums
    • AdjustEstimate
    • AvatarSizes
    • BoardTypes
  • Dapplo.Jira.Json
    • CustomDateTimeOffsetConverter
  • Dapplo.Jira.Query
    • DatetimeClause
    • Fields
    • IDatetimeClause
    • IDatetimeClauseWithoutValue
    • IFinalClause
    • IIssueClause
    • IProjectClause
    • ISimpleValueClause
    • IssueClause
    • ITextClause
    • ITypeClause
    • IUserClause
    • IVersionClause
    • Operators
    • ProjectClause
    • SimpleValueClause
    • TextClause
    • TypeClause
    • UserClause
    • VersionClause
    • Where

Class JiraClient

A client for accessing the Atlassian JIRA Api via REST, using Dapplo.HttpExtensions

Inheritance
System.Object
JiraClient
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace:Dapplo.Jira
Assembly:Dapplo.Jira.dll
Syntax
public class JiraClient : IProjectDomain, IWorkDomain, IUserDomain, ISessionDomain, IIssueDomain, IFilterDomain, IAttachmentDomain, IServerDomain, IAgileDomain, IJiraDomain, IJiraClient

Properties

| Improve this Doc View Source

Agile

Agile domain

Declaration
public IAgileDomain Agile { get; }
Property Value
Type Description
IAgileDomain
Implements
IJiraClient.Agile
| Improve this Doc View Source

Attachment

Attachment domain

Declaration
public IAttachmentDomain Attachment { get; }
Property Value
Type Description
IAttachmentDomain
Implements
IJiraClient.Attachment
| Improve this Doc View Source

Behaviour

Store the specific HttpBehaviour, which contains a IHttpSettings and also some additional logic for making a HttpClient which works with Jira

Declaration
public IHttpBehaviour Behaviour { get; set; }
Property Value
Type Description
Dapplo.HttpExtensions.IHttpBehaviour
Implements
IJiraClient.Behaviour
| Improve this Doc View Source

Filter

Filter domain

Declaration
public IFilterDomain Filter { get; }
Property Value
Type Description
IFilterDomain
Implements
IJiraClient.Filter
| Improve this Doc View Source

Issue

Issue domain

Declaration
public IIssueDomain Issue { get; }
Property Value
Type Description
IIssueDomain
Implements
IJiraClient.Issue
| Improve this Doc View Source

JiraAgileRestUri

The agile rest URI for your JIRA server

Declaration
public Uri JiraAgileRestUri { get; }
Property Value
Type Description
System.Uri
Implements
IJiraDomain.JiraAgileRestUri
| Improve this Doc View Source

JiraAuthUri

The base URI for JIRA auth api

Declaration
public Uri JiraAuthUri { get; }
Property Value
Type Description
System.Uri
Implements
IJiraDomain.JiraAuthUri
| Improve this Doc View Source

JiraBaseUri

The base URI for your JIRA server

Declaration
public Uri JiraBaseUri { get; }
Property Value
Type Description
System.Uri
Implements
IJiraClient.JiraBaseUri
| Improve this Doc View Source

JiraRestUri

The rest URI for your JIRA server

Declaration
public Uri JiraRestUri { get; }
Property Value
Type Description
System.Uri
Implements
IJiraDomain.JiraRestUri
| Improve this Doc View Source

Project

Project domain

Declaration
public IProjectDomain Project { get; }
Property Value
Type Description
IProjectDomain
Implements
IJiraClient.Project
| Improve this Doc View Source

Server

Server domain

Declaration
public IServerDomain Server { get; }
Property Value
Type Description
IServerDomain
Implements
IJiraClient.Server
| Improve this Doc View Source

Session

Session domain

Declaration
public ISessionDomain Session { get; }
Property Value
Type Description
ISessionDomain
Implements
IJiraClient.Session
| Improve this Doc View Source

User

User domain

Declaration
public IUserDomain User { get; }
Property Value
Type Description
IUserDomain
Implements
IJiraClient.User
| Improve this Doc View Source

Work

Work domain

Declaration
public IWorkDomain Work { get; }
Property Value
Type Description
IWorkDomain
Implements
IJiraClient.Work

Methods

| Improve this Doc View Source

Create(Uri, IHttpSettings)

Factory method to create the jira client

Declaration
public static IJiraClient Create(Uri baseUri, IHttpSettings httpSettings = null)
Parameters
Type Name Description
System.Uri baseUri
Dapplo.HttpExtensions.IHttpSettings httpSettings
Returns
Type Description
IJiraClient
| Improve this Doc View Source

SetBasicAuthentication(String, String)

Set Basic Authentication for the current client

Declaration
public void SetBasicAuthentication(string user, string password)
Parameters
Type Name Description
System.String user

username

System.String password

password

Implements
IJiraClient.SetBasicAuthentication(String, String)

Extension Methods

AgileExtensions.GetIssueAsync(IAgileDomain, String, CancellationToken)
AgileExtensions.GetSprintsAsync(IAgileDomain, Int64, String, Pageable, CancellationToken)
AgileExtensions.GetBacklogAsync(IAgileDomain, Int64, Pageable, CancellationToken)
AgileExtensions.GetIssuesOnBoardAsync(IAgileDomain, Int64, Pageable, CancellationToken)
AgileExtensions.GetIssuesInSprintAsync(IAgileDomain, Int64, Int64, Pageable, CancellationToken)
AgileExtensions.GetBoardConfigurationAsync(IAgileDomain, Int64, CancellationToken)
AgileExtensions.GetBoardAsync(IAgileDomain, Int64, CancellationToken)
AgileExtensions.CreateBoardAsync(IAgileDomain, Board, CancellationToken)
AgileExtensions.DeleteBoardAsync(IAgileDomain, Int64, CancellationToken)
AgileExtensions.GetBoardsAsync(IAgileDomain, String, String, String, Pageable, CancellationToken)
AgileExtensions.GetEpicsAsync(IAgileDomain, Int64, Pageable, CancellationToken)
AgileExtensions.GetIssuesForEpicAsync(IAgileDomain, Int64, Int64, Pageable, CancellationToken)
AgileExtensions.GetIssuesForEpicAsync(IAgileDomain, Int64, Pageable, CancellationToken)
AgileExtensions.GetEpicAsync(IAgileDomain, Int64, CancellationToken)
AgileExtensions.UpdateEpicAsync(IAgileDomain, Epic, CancellationToken)
AgileExtensions.GetIssuesWithoutEpicAsync(IAgileDomain, Int64, Pageable, CancellationToken)
AttachmentExtensions.AttachAsync<TContent>(IAttachmentDomain, String, TContent, String, String, CancellationToken)
AttachmentExtensions.DeleteAsync(IAttachmentDomain, Attachment, CancellationToken)
AttachmentExtensions.DeleteAsync(IAttachmentDomain, Int64, CancellationToken)
AttachmentExtensions.GetContentAsAsync<TResponse>(IAttachmentDomain, Attachment, CancellationToken)
AttachmentExtensions.GetThumbnailAsAsync<TResponse>(IAttachmentDomain, Attachment, CancellationToken)
FilterExtensions.GetFavoritesAsync(IFilterDomain, CancellationToken)
FilterExtensions.GetFiltersAsync(IFilterDomain, CancellationToken)
FilterExtensions.GetAsync(IFilterDomain, Int64, CancellationToken)
FilterExtensions.CreateAsync(IFilterDomain, Filter, CancellationToken)
FilterExtensions.UpdateAsync(IFilterDomain, Filter, CancellationToken)
FilterExtensions.DeleteAsync(IFilterDomain, Filter, CancellationToken)
IssueExtensions.AddCommentAsync(IIssueDomain, String, String, String, CancellationToken)
IssueExtensions.GetAsync<TIssue, TFields>(IIssueDomain, String, CancellationToken)
IssueExtensions.GetAsync(IIssueDomain, String, CancellationToken)
IssueExtensions.GetPossibleTransitionsAsync(IIssueDomain, String, CancellationToken)
IssueExtensions.SearchAsync(IIssueDomain, IFinalClause, Int32, IEnumerable<String>, CancellationToken)
IssueExtensions.SearchAsync(IIssueDomain, String, Int32, IEnumerable<String>, CancellationToken)
IssueExtensions.UpdateCommentAsync(IIssueDomain, String, Comment, CancellationToken)
IssueExtensions.GetIssueTypesAsync(IIssueDomain, CancellationToken)
IssueExtensions.CreateAsync<TFields>(IIssueDomain, IssueWithFields<TFields>, CancellationToken)
IssueExtensions.UpdateAsync<TFields>(IIssueDomain, IssueWithFields<TFields>, Boolean, Boolean, Boolean, CancellationToken)
IssueExtensions.DeleteAsync(IIssueDomain, String, Boolean, CancellationToken)
IssueExtensions.AssignAsync(IIssueDomain, String, User, CancellationToken)
ProjectExtensions.GetAsync(IProjectDomain, String, CancellationToken)
ProjectExtensions.GetAllAsync(IProjectDomain, Nullable<Int32>, CancellationToken)
ServerExtensions.GetUriContentAsync<TResponse>(IServerDomain, Uri, CancellationToken)
ServerExtensions.GetAvatarAsync<TResponse>(IServerDomain, AvatarUrls, AvatarSizes, CancellationToken)
ServerExtensions.GetFieldsAsync(IServerDomain, CancellationToken)
ServerExtensions.GetInfoAsync(IServerDomain, CancellationToken)
ServerExtensions.GetConfigurationAsync(IServerDomain, CancellationToken)
ServerExtensions.GetTimeTrackingConfigurationAsync(IServerDomain, CancellationToken)
ServerExtensions.SetTimeTrackingConfigurationAsync(IServerDomain, TimeTrackingConfiguration, CancellationToken)
SessionExtensions.StartAsync(ISessionDomain, String, String, CancellationToken)
SessionExtensions.EndAsync(ISessionDomain, CancellationToken)
UserExtensions.GetAsync(IUserDomain, String, CancellationToken)
UserExtensions.SearchAsync(IUserDomain, String, Boolean, Boolean, Int32, Int32, CancellationToken)
UserExtensions.GetMyselfAsync(IUserDomain, CancellationToken)
WorkExtensions.GetAsync(IWorkDomain, String, CancellationToken)
WorkExtensions.CreateAsync(IWorkDomain, String, Worklog, AdjustEstimate, String, CancellationToken)
WorkExtensions.UpdateAsync(IWorkDomain, String, Worklog, AdjustEstimate, String, CancellationToken)
WorkExtensions.DeleteAsync(IWorkDomain, String, Worklog, AdjustEstimate, String, CancellationToken)
  • Improve this Doc
  • View Source
Back to top Copyright © 2017 Dapplo