• 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 UserExtensions

This holds all the user related extension methods

Inheritance
System.Object
UserExtensions
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 static class UserExtensions

Methods

| Improve this Doc View Source

GetAsync(IUserDomain, String, CancellationToken)

Get user information See: https://docs.atlassian.com/jira/REST/latest/#d2e5339

Declaration
public static Task<User> GetAsync(this IUserDomain jiraClient, string username, CancellationToken cancellationToken = null)
Parameters
Type Name Description
IUserDomain jiraClient

IWorkDomain to bind the extension method to

System.String username
System.Threading.CancellationToken cancellationToken

CancellationToken

Returns
Type Description
System.Threading.Tasks.Task<User>

User

| Improve this Doc View Source

GetMyselfAsync(IUserDomain, CancellationToken)

Get currrent user information See: https://docs.atlassian.com/jira/REST/latest/#d2e4253

Declaration
public static Task<User> GetMyselfAsync(this IUserDomain jiraClient, CancellationToken cancellationToken = null)
Parameters
Type Name Description
IUserDomain jiraClient

IWorkDomain to bind the extension method to

System.Threading.CancellationToken cancellationToken

CancellationToken

Returns
Type Description
System.Threading.Tasks.Task<User>

User

| Improve this Doc View Source

SearchAsync(IUserDomain, String, Boolean, Boolean, Int32, Int32, CancellationToken)

Returns a list of users that match the search string. This resource cannot be accessed anonymously. See: https://docs.atlassian.com/jira/REST/latest/#api/2/user-findUsers

Declaration
public static Task<IList<User>> SearchAsync(this IUserDomain jiraClient, string query, bool includeActive = true, bool includeInactive = false, int startAt = 0, int maxResults = 20, CancellationToken cancellationToken = null)
Parameters
Type Name Description
IUserDomain jiraClient

IWorkDomain to bind the extension method to

System.String query

A query string used to search username, name or e-mail address

System.Boolean includeActive

If true, then active users are included in the results (default true)

System.Boolean includeInactive

If true, then inactive users are included in the results (default false)

System.Int32 startAt
System.Int32 maxResults

Maximum number of results returned, default is 20

System.Threading.CancellationToken cancellationToken

CancellationToken

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IList<User>>

SearchResult

  • Improve this Doc
  • View Source
Back to top Copyright © 2017 Dapplo