A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

A

AbstractPageExtensions - Class in com.adaptavist.hapi.confluence.extensions
add(List<Label>) - Method in LabelUpdater
AddLabelCommandFactory - Class in com.adaptavist.hapi.confluence.pages.implementation
AddLabelCommandFactory(com.atlassian.confluence.labels.service.LabelsService, com.atlassian.confluence.languages.LocaleManager, com.atlassian.confluence.util.i18n.I18NBeanFactory) - Constructor in AddLabelCommandFactory
addLabels(com.atlassian.confluence.pages.AbstractPage, java.lang.String) - Method in AbstractPageExtensions
Adds a list of labels to a page
addLabels(com.atlassian.confluence.pages.AbstractPage, java.lang.String) - Method in PagesImplementation
applicationLinks - Field in Hapi

B

build() - Method in PageDraftBuilder
buildAndValidateCommand(java.lang.String, com.atlassian.user.User, com.atlassian.confluence.pages.AbstractPage) - Method in AddLabelCommandFactory
buildAndValidateCommand(com.adaptavist.hapi.confluence.pages.delegate.PageCreationDelegate) - Method in CreatePageCommandFactory
buildAndValidateCommand(java.lang.String) - Method in ValidateLabelCommandFactory
buildAndValidateCommands(java.lang.String, com.atlassian.user.User, com.atlassian.confluence.pages.AbstractPage) - Method in RemoveLabelCommandFactory
buildCreateDelegate(com.atlassian.confluence.spaces.Space, java.lang.String) - Method in PageDelegateFactory

C

clear() - Method in LabelUpdater
CqlArgumentException - Class in com.adaptavist.hapi.confluence.cql.exceptions
CqlArgumentException() - Constructor in CqlArgumentException
CqlImplementation - Class in com.adaptavist.hapi.confluence.cql
CqlImplementation(com.onresolve.scriptrunner.canned.confluence.utils.CQLSearchUtils) - Constructor in CqlImplementation
CqlParseException - Class in com.adaptavist.hapi.confluence.cql.exceptions
CqlParseException() - Constructor in CqlParseException
create(com.atlassian.confluence.spaces.Space, java.lang.String, Closure<?>) - Method in Pages
Creates a page with a given title in a space, example usage:
 Pages.create(Spaces.getByKey("SR"), "New Page Title") {
     setLabels("new-label")
     setParentPage("Title of a page in the same space")
 }
create(com.atlassian.confluence.spaces.Space, java.lang.String, Closure<?>) - Method in PagesImplementation
CreatePageCommandFactory - Class in com.adaptavist.hapi.confluence.pages.implementation
CreatePageCommandFactory.SimplePageProvider - Class in com.adaptavist.hapi.confluence.pages.implementation
CreatePageCommandFactory.SimplePageProvider() - Constructor in CreatePageCommandFactory.SimplePageProvider
CreatePageCommandFactory(com.atlassian.confluence.content.service.PageService, com.atlassian.confluence.util.i18n.I18NBeanFactory, com.atlassian.confluence.languages.LocaleManager, com.adaptavist.hapi.confluence.pages.implementation.PageDraftBuilder) - Constructor in CreatePageCommandFactory
CreatePageException - Class in com.adaptavist.hapi.confluence.pages.exceptions
CreatePageException() - Constructor in CreatePageException
currentLabels - Field in LabelUpdater

D

deactivate(com.atlassian.user.User) - Method in UserExtensions
Deactivates a user, example usage:
 Users.getInactiveUsers(Duration.of(90, ChronoUnit.DAYS)).each { user ->
     user.deactivate()
 }
 
deactivate(com.atlassian.user.User) - Method in UsersImplementation
DeactivateUserException - Class in com.adaptavist.hapi.confluence.users.exceptions
DeactivateUserException() - Constructor in DeactivateUserException
DefaultHapiDarkFeatureFlag - Class in com.adaptavist.hapi.confluence
DefaultHapiDarkFeatureFlag(com.atlassian.sal.api.features.DarkFeatureManager) - Constructor in DefaultHapiDarkFeatureFlag

E

F

from - Field in ReplaceLabelUpdater

G

get() - Method in LabelUpdater
getById(long) - Method in Pages
Get a page by its ID.
getById(long) - Method in PagesImplementation
getByKey(java.lang.String) - Method in Users
Retrieves a User by string corresponding to the user's userKey
 Users.getByKey('ff8080818b0052d3018b006f216d0000')
 
getByKey(java.lang.String) - Method in UsersImplementation
getByName(java.lang.String) - Method in Users
Retrieves a User by name
 Users.getByName('username')
 
getByName(java.lang.String) - Method in UsersImplementation
getCompletions(java.lang.String, org.codehaus.groovy.ast.expr.Expression, com.onresolve.scriptrunner.stc.completions.request.CompletionRequestContext) - Method in LabelCompletionProvider
getCompletions(java.lang.String, org.codehaus.groovy.ast.expr.Expression, com.onresolve.scriptrunner.stc.completions.request.CompletionRequestContext) - Method in SpaceKeyCompletionProvider
getCompletions(java.lang.String, org.codehaus.groovy.ast.expr.Expression, com.onresolve.scriptrunner.stc.completions.request.CompletionRequestContext) - Method in UserKeyCompletionProvider
getCompletions(java.lang.String, org.codehaus.groovy.ast.expr.Expression, com.onresolve.scriptrunner.stc.completions.request.CompletionRequestContext) - Method in UsernameCompletionProvider
getFrom() - Method in ReplaceLabelUpdater
getInactiveUsers(java.time.Duration) - Method in Users
Get users who have been inactive for a specified amount of time, example usage:
 Users.getInactiveUsers(Duration.of(90, ChronoUnit.DAYS))
 
getInactiveUsers(java.time.Duration) - Method in UsersImplementation
getLoggedInUser() - Method in Users
Get the current logged in user, may be null if the logged in user is anonymous, example usage:
 Users.getLoggedInUser()
 
getLoggedInUser() - Method in UsersImplementation
getMethodParameterDescriptors() - Method in LabelCompletionProvider
getMethodParameterDescriptors() - Method in SpaceKeyCompletionProvider
getMethodParameterDescriptors() - Method in UserKeyCompletionProvider
getMethodParameterDescriptors() - Method in UsernameCompletionProvider
GetPageException - Class in com.adaptavist.hapi.confluence.pages.exceptions
GetPageException() - Constructor in GetPageException
getTo() - Method in ReplaceLabelUpdater
GetUsersException - Class in com.adaptavist.hapi.confluence.users.exceptions
GetUsersException() - Constructor in GetUsersException

H

Hapi - Class in com.adaptavist.hapi.confluence
Hapi() - Constructor in Hapi
HapiDarkFeatureFlag - Interface in com.adaptavist.hapi.confluence
hasNext() - Method in UserIterator

I

isEnabled() - Method in DefaultHapiDarkFeatureFlag
isEnabled() - Method in HapiDarkFeatureFlag

J

K

L

LabelCompletionProvider - Class in com.adaptavist.hapi.confluence.pages.editor.completions
LabelCompletionProvider(com.onresolve.scriptrunner.canned.confluence.autocomplete.LabelSuggestionProvider) - Constructor in LabelCompletionProvider
LabelException - Class in com.adaptavist.hapi.confluence.pages.exceptions
LabelException() - Constructor in LabelException
labels - Field in PageCreationDelegate
LabelUpdater - Class in com.adaptavist.hapi.confluence.pages.updater
LabelUpdater(Set<String>) - Constructor in LabelUpdater

M

MAX_RESULTS - Field in UserKeyCompletionProvider
MAX_RESULTS - Field in UsernameCompletionProvider
MAX_VALUE - Field in PageDraftBuilder.PageDraftCreationException
message - Property in PageDraftBuilder.PageDraftCreationException
MIN_VALUE - Field in PageDraftBuilder.PageDraftCreationException

N

next() - Method in UserIterator
NO_SPACE_EXCEPTION - Field in PageDraftBuilder.PageDraftCreationException
NO_TITLE_EXCEPTION - Field in PageDraftBuilder.PageDraftCreationException
noNullLabels() - Method in LabelUpdater

O

P

page - Property in CreatePageCommandFactory.SimplePageProvider
PageCreationDelegate - Class in com.adaptavist.hapi.confluence.pages.delegate
PageCreationDelegate(com.atlassian.confluence.spaces.Space, java.lang.String, com.atlassian.confluence.content.service.PageService, com.adaptavist.hapi.confluence.pages.implementation.ValidateLabelCommandFactory) - Constructor in PageCreationDelegate
PageDelegateFactory - Class in com.adaptavist.hapi.confluence.pages.delegate
PageDelegateFactory(com.atlassian.confluence.content.service.PageService, com.adaptavist.hapi.confluence.pages.implementation.ValidateLabelCommandFactory) - Constructor in PageDelegateFactory
PageDraftBuilder - Class in com.adaptavist.hapi.confluence.pages.implementation
PageDraftBuilder.PageDraftCreationException - Enum in com.adaptavist.hapi.confluence.pages.implementation
PageDraftBuilder() - Constructor in PageDraftBuilder
PageIterator - Class in com.adaptavist.hapi.confluence.cql
PageIterator(Iterator<AbstractPage>, java.lang.String, com.onresolve.scriptrunner.canned.confluence.utils.CQLSearchUtils) - Constructor in PageIterator
Pages - Class in com.adaptavist.hapi.confluence.pages
pages - Field in Hapi
Pages() - Constructor in Pages
PagesImplementation - Class in com.adaptavist.hapi.confluence.pages.implementation
PagesImplementation(com.adaptavist.hapi.confluence.pages.implementation.AddLabelCommandFactory, com.adaptavist.hapi.confluence.pages.implementation.RemoveLabelCommandFactory, com.adaptavist.hapi.confluence.pages.implementation.CreatePageCommandFactory, com.adaptavist.hapi.confluence.pages.delegate.PageDelegateFactory, com.adaptavist.hapi.confluence.users.implementation.UsersImplementation, com.atlassian.confluence.content.service.SpaceService, com.atlassian.confluence.content.service.PageService) - Constructor in PagesImplementation
pageTitle - Field in PageCreationDelegate
parentPage - Field in PageCreationDelegate

Q

query(java.lang.String) - Method in CqlImplementation

R

remove(List<Label>) - Method in LabelUpdater
RemoveLabelCommandFactory - Class in com.adaptavist.hapi.confluence.pages.implementation
RemoveLabelCommandFactory(com.atlassian.confluence.labels.service.LabelsService, com.atlassian.confluence.languages.LocaleManager, com.atlassian.confluence.util.i18n.I18NBeanFactory, com.atlassian.confluence.labels.LabelManager) - Constructor in RemoveLabelCommandFactory
removeLabels(com.atlassian.confluence.pages.AbstractPage, java.lang.String) - Method in AbstractPageExtensions
Removes label(s) from a page
removeLabels(com.atlassian.confluence.pages.AbstractPage, java.lang.String) - Method in PagesImplementation
replace(com.atlassian.confluence.labels.Label, com.atlassian.confluence.labels.Label) - Method in LabelUpdater
replaceLabel(com.atlassian.confluence.pages.AbstractPage, Closure<?>) - Method in AbstractPageExtensions
Removes a label from a page, example usage:
 Pages.search('space = DS').each { page ->
     page.replaceLabel {
         from = "oldLabel"
         to = "newLabel"
     }
 }
 
replaceLabel(com.atlassian.confluence.pages.AbstractPage, Closure<?>) - Method in PagesImplementation
ReplaceLabelUpdater - Class in com.adaptavist.hapi.confluence.pages.updater
ReplaceLabelUpdater() - Constructor in ReplaceLabelUpdater
runAnonymously(Callable<T>) - Method in Users
Run an action with no logged in user, returning the result, example usage:
 def pages = Users.runAnonymously {
     Pages.search('space = ds')
 }
runAnonymously(Callable<T>) - Method in UsersImplementation
runAs(com.atlassian.confluence.user.ConfluenceUser, Callable<T>) - Method in Users
Run an action as a different user, returning the result, example usage:
 def pages = Users.runAs(Users.getByName('username')) {
     Pages.search('space = ds')
 }
runAs(com.atlassian.confluence.user.ConfluenceUser, Callable<T>) - Method in UsersImplementation
runInactiveUsersQuery(java.util.Date, int, int, boolean) - Method in UsersImplementation

S

search(java.lang.String) - Method in Pages
Executes the CQL and returns matching pages.
set(List<Label>) - Method in LabelUpdater
setLabels(java.lang.String) - Method in PageCreationDelegate
setParentPage(java.lang.String) - Method in PageCreationDelegate
setParentPage(com.atlassian.confluence.pages.Page) - Method in PageDraftBuilder
setSpace(com.atlassian.confluence.spaces.Space) - Method in PageDraftBuilder
setTitle(java.lang.String) - Method in PageDraftBuilder
space - Field in PageCreationDelegate
SpaceKeyCompletionProvider - Class in com.adaptavist.hapi.confluence.pages.editor.completions
SpaceKeyCompletionProvider(com.onresolve.scriptrunner.canned.confluence.autocomplete.SpaceKeySuggestionProvider) - Constructor in SpaceKeyCompletionProvider
stream() - Method in PageIterator
Stream pages matching CQL query, this method can only be called once per search.

T

to - Field in ReplaceLabelUpdater
toString() - Method in PageIterator

U

updateLabels(com.atlassian.confluence.pages.AbstractPage, Closure<?>) - Method in AbstractPageExtensions
Update labels on a page.
updateLabels(com.atlassian.confluence.pages.AbstractPage, Closure<?>) - Method in PagesImplementation
UserExtensions - Class in com.adaptavist.hapi.confluence.extensions
UserIterator - Class in com.adaptavist.hapi.confluence.users
UserIterator(groovy.lang.Closure) - Constructor in UserIterator
UserKeyCompletionProvider - Class in com.adaptavist.hapi.confluence.users.editor.completions
UserKeyCompletionProvider(com.onresolve.scriptrunner.canned.confluence.autocomplete.UsernameSuggestionProvider) - Constructor in UserKeyCompletionProvider
UsernameCompletionProvider - Class in com.adaptavist.hapi.confluence.users.editor.completions
UsernameCompletionProvider(com.onresolve.scriptrunner.canned.confluence.autocomplete.UsernameSuggestionProvider) - Constructor in UsernameCompletionProvider
Users - Class in com.adaptavist.hapi.confluence.users
users - Field in Hapi
Users() - Constructor in Users
UsersImplementation - Class in com.adaptavist.hapi.confluence.users.implementation
UsersImplementation(com.atlassian.confluence.user.UserAccessor, com.onresolve.scriptrunner.querydsl.SRDatabaseAccessor) - Constructor in UsersImplementation

V

validate(com.atlassian.confluence.content.service.page.CreatePageCommand, com.atlassian.user.User, com.atlassian.confluence.pages.Page) - Method in CreatePageCommandFactory
validate(List<Object>) - Method in LabelUpdater
ValidateLabelCommandFactory - Class in com.adaptavist.hapi.confluence.pages.implementation
ValidateLabelCommandFactory(com.atlassian.confluence.labels.service.LabelsService, com.atlassian.confluence.languages.LocaleManager, com.atlassian.confluence.util.i18n.I18NBeanFactory) - Constructor in ValidateLabelCommandFactory

W

X

Y

Z

_

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _