A B C D E F G H I L N O P R S T U V X Y Z

A

AnonymousLogin - Class in org.llorllale.youtrack.api.session

A Login for anonymous sessions if your YouTrack supports it (ie.

AnonymousLogin(URL) - Constructor for class org.llorllale.youtrack.api.session.AnonymousLogin

Ctor.

AssignedField - Interface in org.llorllale.youtrack.api

A Field that is attached to an Issue.

assignee() - Method in interface org.llorllale.youtrack.api.UsersOfIssue

The user assigned to the issue, if any.

assignees() - Method in interface org.llorllale.youtrack.api.UsersOfProject

A stream of all users to which issues can be assigned in this Project.

assignTo(User) - Method in interface org.llorllale.youtrack.api.UsersOfIssue

Assigns the Issue to the given User.

asString() - Method in interface org.llorllale.youtrack.api.FieldValue

Returns a string representation of this FieldValue.

asString() - Method in interface org.llorllale.youtrack.api.TimeTrackEntryType

A string representation of this TimeTrackEntryType.

asString() - Method in interface org.llorllale.youtrack.api.Xml

A string representation of this Xml.

asXml() - Method in class org.llorllale.youtrack.api.IssueTimeTracking.EntrySpec

A view of this IssueTimeTracking.EntrySpec as an Xml.

AuthenticationException - Exception in org.llorllale.youtrack.api.session

Signals an error with the credentials that were provided.

AuthenticationException(String) - Constructor for exception org.llorllale.youtrack.api.session.AuthenticationException

Ctor.

B

baseUrl() - Method in interface org.llorllale.youtrack.api.session.Session

The base endpoint URL of the remote YouTrack API.

C

child(String) - Method in interface org.llorllale.youtrack.api.Xml

Returns the first Xml node selected with xpath.

children(String) - Method in interface org.llorllale.youtrack.api.Xml

Returns all descendant Xml nodes selected with xpath.

Comment - Interface in org.llorllale.youtrack.api

A comment created on a YouTrack Issue.

Comments - Interface in org.llorllale.youtrack.api

API for comments on an Issue.

comments() - Method in interface org.llorllale.youtrack.api.Issue

Access to the issue's comments.

Cookie - Interface in org.llorllale.youtrack.api.session

An HTTP cookie held by the user's Session.

cookies() - Method in interface org.llorllale.youtrack.api.session.Session

Session state.

create(Issues.IssueSpec) - Method in interface org.llorllale.youtrack.api.Issues

Creates an issue according to the spec.

create(IssueTimeTracking.EntrySpec) - Method in interface org.llorllale.youtrack.api.IssueTimeTracking

Creates a new entry.

creationDate() - Method in interface org.llorllale.youtrack.api.Comment

The instant when the comment was created.

creationDate() - Method in interface org.llorllale.youtrack.api.Issue

The date the issue was created.

creator() - Method in interface org.llorllale.youtrack.api.UsersOfIssue

The issue's creator.

D

date() - Method in interface org.llorllale.youtrack.api.TimeTrackEntry

The date when the item was entered into the issue's time-tracking.

DefaultYouTrack - Class in org.llorllale.youtrack.api

Default implementation of YouTrack.

DefaultYouTrack(Session) - Constructor for class org.llorllale.youtrack.api.DefaultYouTrack

Primary ctor.

delete() - Method in interface org.llorllale.youtrack.api.Comment

Deletes this Comment from the Issue.

description() - Method in interface org.llorllale.youtrack.api.Issue

The issue's description.

description() - Method in class org.llorllale.youtrack.api.Issues.IssueSpec

The descriptive text for the issue, if specified.

description() - Method in interface org.llorllale.youtrack.api.Project

The project's description.

description() - Method in interface org.llorllale.youtrack.api.TimeTrackEntry

The item's description.

description(String) - Method in interface org.llorllale.youtrack.api.UpdateIssue

Updates the issue's description.

duration() - Method in interface org.llorllale.youtrack.api.TimeTrackEntry

The duration during which the work-item was worked on.

E

email() - Method in interface org.llorllale.youtrack.api.User

The user's email.

enabled() - Method in interface org.llorllale.youtrack.api.ProjectTimeTracking

Whether timetracking is enabled for the Project or not.

EntrySpec(LocalDate, Duration, String, TimeTrackEntryType) - Constructor for class org.llorllale.youtrack.api.IssueTimeTracking.EntrySpec

Primary ctor.

EntrySpec(Duration) - Constructor for class org.llorllale.youtrack.api.IssueTimeTracking.EntrySpec

Assumes that the date is now, the description is empty, and the type is empty.

EntrySpec(Duration, String) - Constructor for class org.llorllale.youtrack.api.IssueTimeTracking.EntrySpec

Assumes the date is now and type is empty.

EntrySpec(LocalDate, Duration) - Constructor for class org.llorllale.youtrack.api.IssueTimeTracking.EntrySpec

Assumes an empty description and type.

EntrySpec(Duration, TimeTrackEntryType) - Constructor for class org.llorllale.youtrack.api.IssueTimeTracking.EntrySpec

Assumes the date is now and an empty description.

EntrySpec(Duration, String, TimeTrackEntryType) - Constructor for class org.llorllale.youtrack.api.IssueTimeTracking.EntrySpec

Assumes the date is now.

EntrySpec(LocalDate, Duration, String) - Constructor for class org.llorllale.youtrack.api.IssueTimeTracking.EntrySpec

Assumes the type is null.

equals(Object) - Method in class org.llorllale.youtrack.api.Issues.IssueSpec

equals(Object) - Method in class org.llorllale.youtrack.api.IssueTimeTracking.EntrySpec

F

Field - Interface in org.llorllale.youtrack.api

A property of issues.

field() - Method in interface org.llorllale.youtrack.api.FieldValue

The owner Field.

field(Field, FieldValue) - Method in interface org.llorllale.youtrack.api.UpdateIssue

Updates the issue's field to the given value and returns a new Issue reflecting those changes.

Fields - Interface in org.llorllale.youtrack.api

Access to all the fields of a project that are configured for issues.

fields() - Method in interface org.llorllale.youtrack.api.Issue

All fields of this Issue.

fields() - Method in class org.llorllale.youtrack.api.Issues.IssueSpec

A view of this spec as fields and values.

fields() - Method in interface org.llorllale.youtrack.api.Project

Returns the Fields API.

fields(Map<Field, FieldValue>) - Method in interface org.llorllale.youtrack.api.UpdateIssue

Updates this issue with the fields provided, returning a new Issue reflecting those changes.

FieldValue - Interface in org.llorllale.youtrack.api

A value for some Field.

G

get(String) - Method in interface org.llorllale.youtrack.api.Issues

The Issue with the given id, if it exists.

get(String) - Method in interface org.llorllale.youtrack.api.Projects

Returns the Project with the given id, if any.

H

hashCode() - Method in class org.llorllale.youtrack.api.Issues.IssueSpec

hashCode() - Method in class org.llorllale.youtrack.api.IssueTimeTracking.EntrySpec

httpResponse() - Method in exception org.llorllale.youtrack.api.session.UnauthorizedException

The response received.

I

id() - Method in interface org.llorllale.youtrack.api.Comment

The comment's ID.

id() - Method in interface org.llorllale.youtrack.api.Issue

The issue's id.

id() - Method in interface org.llorllale.youtrack.api.Project

The project's id.

isEqualTo(FieldValue) - Method in interface org.llorllale.youtrack.api.FieldValue

Whether this value is equal to other and both share the same parent Field.

isSameField(Field) - Method in interface org.llorllale.youtrack.api.Field

Whether this and other both represent the same field.

issue() - Method in interface org.llorllale.youtrack.api.AssignedField

The Issue to which this AssignedField is attached to.

issue() - Method in interface org.llorllale.youtrack.api.Comment

The issue on which this comment was created.

issue() - Method in interface org.llorllale.youtrack.api.Comments

The parent Issue.

Issue - Interface in org.llorllale.youtrack.api

A YouTrack issue.

issue() - Method in interface org.llorllale.youtrack.api.TimeTrackEntry

The parent Issue.

issue() - Method in interface org.llorllale.youtrack.api.UsersOfIssue

The enclosing Issue.

Issues - Interface in org.llorllale.youtrack.api

Issues API.

issues() - Method in interface org.llorllale.youtrack.api.Project

This Project's issues.

Issues.IssueSpec - Class in org.llorllale.youtrack.api

Specifications for building an Issue.

IssueSpec(String, String, Map<Field, FieldValue>) - Constructor for class org.llorllale.youtrack.api.Issues.IssueSpec

Primary ctor.

IssueSpec(String, String) - Constructor for class org.llorllale.youtrack.api.Issues.IssueSpec

Sets no fields.

IssueSpec(String, Map<Field, FieldValue>) - Constructor for class org.llorllale.youtrack.api.Issues.IssueSpec

Specify the issue's summary and description.

IssueSpec(String) - Constructor for class org.llorllale.youtrack.api.Issues.IssueSpec

Specify the issue's summary only.

IssueTimeTracking - Interface in org.llorllale.youtrack.api

API for Issue timetracking.

IssueTimeTracking.EntrySpec - Class in org.llorllale.youtrack.api

Specifications for creating a TimeTrackEntry on an Issue.

L

login() - Method in class org.llorllale.youtrack.api.session.AnonymousLogin

Login - Interface in org.llorllale.youtrack.api.session

Performs the login.

login() - Method in interface org.llorllale.youtrack.api.session.Login

Performs the login function and returns a Session with sufficient state to allow further transactions with YouTrack.

login() - Method in class org.llorllale.youtrack.api.session.PermanentTokenLogin

login() - Method in class org.llorllale.youtrack.api.session.UsernamePasswordLogin

loginName() - Method in interface org.llorllale.youtrack.api.User

The user's login name.

N

name() - Method in interface org.llorllale.youtrack.api.Field

Returns the name of this Field.

name() - Method in interface org.llorllale.youtrack.api.Project

The project's name.

name() - Method in interface org.llorllale.youtrack.api.session.Cookie

The cookie's name.

name() - Method in interface org.llorllale.youtrack.api.User

The user's full name.

node() - Method in interface org.llorllale.youtrack.api.Xml

The Node encapsulated by this Xml.

O

org.llorllale.youtrack.api - package org.llorllale.youtrack.api

Fluent, object-oriented API for YouTrack.

org.llorllale.youtrack.api.session - package org.llorllale.youtrack.api.session

Collection of APIs necessary to create sessions with YouTrack.

P

PermanentTokenLogin - Class in org.llorllale.youtrack.api.session

A Login that makes use of YouTrack's permanent tokens feature to authorize 3rd party application integrations.

PermanentTokenLogin(URL, String) - Constructor for class org.llorllale.youtrack.api.session.PermanentTokenLogin

Ctor.

post(String) - Method in interface org.llorllale.youtrack.api.Comments

Creates a new Comment for this Issue.

project() - Method in interface org.llorllale.youtrack.api.Field

Returns the parent Project.

project() - Method in interface org.llorllale.youtrack.api.Fields

Returns the Project to which this Fields belongs.

project() - Method in interface org.llorllale.youtrack.api.Issue

The Project that the issue was created in.

project() - Method in interface org.llorllale.youtrack.api.Issues

This Issues' Project.

Project - Interface in org.llorllale.youtrack.api

A YouTrack project.

project() - Method in interface org.llorllale.youtrack.api.ProjectTimeTracking

The parent Project.

project() - Method in interface org.llorllale.youtrack.api.UsersOfProject

The Project.

ProjectField - Interface in org.llorllale.youtrack.api

An extended Field that provides its possible values.

projects() - Method in class org.llorllale.youtrack.api.DefaultYouTrack

Projects - Interface in org.llorllale.youtrack.api

Fetches projects from the YouTrack server.

projects() - Method in interface org.llorllale.youtrack.api.YouTrack

Access to the projects API.

ProjectTimeTracking - Interface in org.llorllale.youtrack.api

Access to a project's timetracking settings.

R

refresh() - Method in interface org.llorllale.youtrack.api.Issue

Returns the same Issue after refreshing its data from the server.

S

Session - Interface in org.llorllale.youtrack.api.session

A Session object encapsulates all the state required for conducting further transactions with the remote YouTrack API.

spec() - Method in interface org.llorllale.youtrack.api.Issue

An Issues.IssueSpec serving as a blueprint for this Issue.

stream() - Method in interface org.llorllale.youtrack.api.Comments

A Stream with all comments for this Issue.

stream() - Method in interface org.llorllale.youtrack.api.Fields

Returns a stream of all configured fields for this Project.

stream() - Method in interface org.llorllale.youtrack.api.Issues

A Stream with all issues created for this Project.

stream() - Method in interface org.llorllale.youtrack.api.IssueTimeTracking

Returns a Stream with all available work entries for the Issue.

stream() - Method in interface org.llorllale.youtrack.api.Projects

Returns a Stream with all accessible projects by the user's Session.

summary() - Method in interface org.llorllale.youtrack.api.Issue

The issue's summary.

summary() - Method in class org.llorllale.youtrack.api.Issues.IssueSpec

The summary text for the issue.

summary(String) - Method in interface org.llorllale.youtrack.api.UpdateIssue

Updates the issue's summary.

summaryAndDesc(String, String) - Method in interface org.llorllale.youtrack.api.UpdateIssue

Updates the issue's summary and description.

T

text() - Method in interface org.llorllale.youtrack.api.Comment

The text content of the comment.

textOf(String) - Method in interface org.llorllale.youtrack.api.Xml

Returns the text content of the element selected with xpath if it exists, otherwise an empty optional.

TimeTrackEntry - Interface in org.llorllale.youtrack.api

An entry in an issue's timetracking.

TimeTrackEntryType - Interface in org.llorllale.youtrack.api

The TimeTrackEntry's type.

timetracking() - Method in interface org.llorllale.youtrack.api.Issue

Access to the issue's timetracking.

timetracking() - Method in interface org.llorllale.youtrack.api.Project

Access the project's timetracking settings.

type() - Method in interface org.llorllale.youtrack.api.TimeTrackEntry

The entry's type.

types() - Method in interface org.llorllale.youtrack.api.ProjectTimeTracking

A stream of all timetracking entry types, if timetracking is enabled.

U

UnauthorizedException - Exception in org.llorllale.youtrack.api.session

Signals that the attempted action is forbidden for the current user session.

UnauthorizedException(String, HttpResponse) - Constructor for exception org.llorllale.youtrack.api.session.UnauthorizedException

Ctor.

update(String) - Method in interface org.llorllale.youtrack.api.Comment

Updates the text content of this Comment.

update() - Method in interface org.llorllale.youtrack.api.Issue

The UpdateIssue API for this Issue.

UpdateIssue - Interface in org.llorllale.youtrack.api

API to update an Issue.

updater() - Method in interface org.llorllale.youtrack.api.UsersOfIssue

The user that updated the issue, if any.

User - Interface in org.llorllale.youtrack.api

A registered user in YouTrack.

user(String) - Method in interface org.llorllale.youtrack.api.UsersOfProject

The User with the given login.

UsernamePasswordLogin - Class in org.llorllale.youtrack.api.session

A login for the simple username/password use case.

UsernamePasswordLogin(URL, String, char[]) - Constructor for class org.llorllale.youtrack.api.session.UsernamePasswordLogin

Ctor.

users() - Method in interface org.llorllale.youtrack.api.Issue

Access to the issue's users.

users() - Method in interface org.llorllale.youtrack.api.Project

Access the UsersOfProject API for this Project.

UsersOfIssue - Interface in org.llorllale.youtrack.api

Access the users of an issue.

UsersOfProject - Interface in org.llorllale.youtrack.api

Access the users of a project.

V

value() - Method in interface org.llorllale.youtrack.api.AssignedField

This field's value.

value() - Method in interface org.llorllale.youtrack.api.session.Cookie

The cookie's value.

values() - Method in interface org.llorllale.youtrack.api.ProjectField

Returns all possible values for this Field.

X

Xml - Interface in org.llorllale.youtrack.api

Encapsulation of the XML messages sent to/received from YouTrack.

Y

youtrack() - Method in interface org.llorllale.youtrack.api.Project

Returns the parent YouTrack instance.

YouTrack - Interface in org.llorllale.youtrack.api

Entry point for the YouTrack API.

Z

ZONE_ID - Static variable in interface org.llorllale.youtrack.api.YouTrack

All date/time fields in YouTrack's API are expressed relative to this ZoneId.

A B C D E F G H I L N O P R S T U V X Y Z