helpers

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. def activityMessage(message: String)(implicit context: Context): Html

   

   Convert link notations in the activity message.

5. def addCollaborator(userName: String, repositoryName: String, collaboratorName: String, role: String)(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): Unit

   

   Add collaborator (user or group) to the repository.

   Add collaborator (user or group) to the repository.

   Definition Classes

   RepositoryService

6. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

7. def assets(implicit context: Context): String

   

   Returns the url to the root of assets.

8. def authenticate(settings: SystemSettings, userName: String, password: String)(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): Option[Account]

   

   Definition Classes

   AccountService

9. def avatar(commit: CommitInfo, size: Int)(implicit context: Context): Html

   

   Returns <img> which displays the avatar icon for the given mail address.

   Returns <img> which displays the avatar icon for the given mail address. This method looks up Gravatar if avatar icon has not been configured in user settings.

10. def avatar(userName: String, size: Int, tooltip: Boolean = false, mailAddress: String = "")(implicit context: Context): Html

    

    Returns <img> which displays the avatar icon for the given user name.

    Returns <img> which displays the avatar icon for the given user name. This method looks up Gravatar if avatar icon has not been configured in user settings.

11. def avatarLink(commit: CommitInfo, size: Int)(implicit context: Context): Html

    

    Generates the avatar link to the account page.

    Generates the avatar link to the account page. If user does not exist or disabled, this method returns avatar image without link.

12. def avatarLink(userName: String, size: Int, mailAddress: String = "", tooltip: Boolean = false, label: Boolean = false)(implicit context: Context): Html

    

    Generates the avatar link to the account page.

    Generates the avatar link to the account page. If user does not exist or disabled, this method returns avatar image without link.

13. def baseUrl(implicit request: HttpServletRequest): String

    

    Definition Classes

    SystemSettingsService

14. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

15. def closeIssuesFromMessage(message: String, userName: String, owner: String, repository: String)(implicit s: Session): Unit

    

    Definition Classes

    IssuesService

16. def commitStateIcon(state: CommitState): Html

    

17. def commitStateText(state: CommitState, commitId: String): String

    

18. def convertRefsLinks(text: String, repository: RepositoryInfo, issueIdPrefix: String = "#", escapeHtml: Boolean = true)(implicit context: Context): String

    

    Converts issue id, username and commit id to link in the given text.

    Converts issue id, username and commit id to link in the given text.

    Attributes

    protected

    Definition Classes

    LinkConverter

19. def countIssue(condition: IssueSearchCondition, onlyPullRequest: Boolean, repos: (String, String)*)(implicit s: Session): Int

    

    Returns the count of the search result against issues.

    Returns the count of the search result against issues.

    condition

    the search condition

    onlyPullRequest

    if true then counts only pull request, false then counts both of issue and pull request.

    repos

    Tuple of the repository owner and the repository name

    returns

    the count of the search result

    Definition Classes

    IssuesService

20. def countIssueGroupByLabels(owner: String, repository: String, condition: IssueSearchCondition, filterUser: Map[String, String])(implicit s: Session): Map[String, Int]

    

    Returns the Map which contains issue count for each labels.

    Returns the Map which contains issue count for each labels.

    owner

    the repository owner

    repository

    the repository name

    condition

    the search condition

    returns

    the Map which contains issue count for each labels (key is label name, value is issue count)

    Definition Classes

    IssuesService

21. def createAccount(userName: String, password: String, fullName: String, mailAddress: String, isAdmin: Boolean, url: Option[String])(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): Unit

    

    Definition Classes

    AccountService

22. def createComment(owner: String, repository: String, loginUser: String, issueId: Int, content: String, action: String)(implicit s: Session): Int

    

    Definition Classes

    IssuesService

23. def createGroup(groupName: String, url: Option[String])(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): Unit

    

    Definition Classes

    AccountService

24. def createIssue(owner: String, repository: String, loginUser: String, title: String, content: Option[String], assignedUserName: Option[String], milestoneId: Option[Int], isPullRequest: Boolean = false)(implicit s: Session): Int

    

    Definition Classes

    IssuesService

25. def createIssueComment(owner: String, repository: String, commit: CommitInfo)(implicit s: Session): Unit

    

    Definition Classes

    IssuesService

26. def createIssueLink(repository: RepositoryInfo, issueId: Int)(implicit context: Context): String

    

    Creates a link to the issue or the pull request from the issue id.

    Creates a link to the issue or the pull request from the issue id.

    Attributes

    protected

    Definition Classes

    LinkConverter

27. def createReferComment(owner: String, repository: String, fromIssue: Issue, message: String, loginAccount: Account)(implicit s: Session): Unit

    

    Definition Classes

    IssuesService

28. def cut(value: String, length: Int): String

    

29. def date(date: Date): String

    

    Format java.util.Date to "yyyy-MM-dd".

30. def datetime(date: Date): String

    

    Format java.util.Date to "yyyy-MM-dd HH:mm:ss".

31. def datetimeAgo(date: Date): String

    

    Format java.util.Date to "x {seconds/minutes/hours/days/months/years} ago"

32. def datetimeAgoRecentOnly(date: Date): String

    

    Format java.util.Date to "x {seconds/minutes/hours/days} ago" If duration over 1 month, format to "d MMM (yyyy)"

33. def datetimeRFC3339(date: Date): String

    

    Format java.util.Date to "yyyy-MM-dd'T'hh:mm:ss'Z'".

34. def decorateHtml(html: String, repository: RepositoryInfo)(implicit context: Context): String

    

35. def deleteComment(commentId: Int)(implicit s: Session): Int

    

    Definition Classes

    IssuesService

36. def deleteIssueLabel(owner: String, repository: String, issueId: Int, labelId: Int)(implicit s: Session): Int

    

    Definition Classes

    IssuesService

37. def deleteRepository(userName: String, repositoryName: String)(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): Unit

    

    Definition Classes

    RepositoryService

38. def detectAndRenderLinks(text: String, repository: RepositoryInfo)(implicit context: Context): String

    

39. def editorType(fileName: String): String

    

    Returns file type for AceEditor.

40. def encodeRefName(value: String): String

    

    URL encode except '/'.

41. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

42. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

43. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

44. def getAccountByMailAddress(mailAddress: String)(implicit context: Context): Option[Account]

    

    Definition Classes

    RequestCache

45. def getAccountByMailAddress(mailAddress: String, includeRemoved: Boolean = false)(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): Option[Account]

    

    Definition Classes

    AccountService

46. def getAccountByUserName(userName: String)(implicit context: Context): Option[Account]

    

    Definition Classes

    RequestCache

47. def getAccountByUserName(userName: String, includeRemoved: Boolean = false)(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): Option[Account]

    

    Definition Classes

    AccountService

48. def getAccountsByUserNames(userNames: Set[String], knowns: Set[Account], includeRemoved: Boolean = false)(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): Map[String, Account]

    

    Definition Classes

    AccountService

49. def getAllRepositories(userName: String)(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): List[(String, String)]

    

    Returns the repositories without private repository that user does not have access right.

    Returns the repositories without private repository that user does not have access right. Include public repository, private own repository and private but collaborator repository.

    userName

    the user name of collaborator

    returns

    the repository information list

    Definition Classes

    RepositoryService

50. def getAllUsers(includeRemoved: Boolean = true)(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): List[Account]

    

    Definition Classes

    AccountService

51. def getAssignableUserNames(owner: String, repository: String)(implicit s: Session): List[String]

    

    Definition Classes

    IssuesService

52. def getAvatarImageHtml(userName: String, size: Int, mailAddress: String = "", tooltip: Boolean = false)(implicit context: Context): Html

    

    Returns <img> which displays the avatar icon.

    Returns <img> which displays the avatar icon. Looks up Gravatar if avatar icon has not been configured in user settings.

    Attributes

    protected

    Definition Classes

    AvatarImageProvider

53. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

54. def getCollaboratorUserNames(userName: String, repositoryName: String, filter: Seq[Role] = Nil)(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): List[String]

    

    Returns the list of all collaborator name and permission which is sorted with ascending order.

    Returns the list of all collaborator name and permission which is sorted with ascending order. If a group is added as a collaborator, this method returns users who are belong to that group.

    Definition Classes

    RepositoryService

55. def getCollaborators(userName: String, repositoryName: String)(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): List[(Collaborator, Boolean)]

    

    Returns the list of collaborators name (user name or group name) which is sorted with ascending order.

    Returns the list of collaborators name (user name or group name) which is sorted with ascending order.

    Definition Classes

    RepositoryService

56. def getComment(owner: String, repository: String, commentId: String)(implicit s: Session): Option[model.IssueCommentComponent.IssueComments.TableElementType]

    

    Definition Classes

    IssuesService

57. def getComments(owner: String, repository: String, issueId: Int)(implicit s: Session): List[model.IssueCommentComponent.IssueComments.TableElementType]

    

    Definition Classes

    IssuesService

58. def getCommentsForApi(owner: String, repository: String, issueId: Int)(implicit s: Session): List[(IssueComment, Account, Issue)]

    
    returns

    IssueComment and commentedUser and Issue

    Definition Classes

    IssuesService

59. def getCommitStatues(issueList: Seq[(String, String, Int)])(implicit s: Session): Map[(String, String, Int), CommitStatusInfo]

    

    Definition Classes

    IssuesService

60. def getForkedRepositories(userName: String, repositoryName: String)(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): List[(String, String)]

    

    Definition Classes

    RepositoryService

61. def getGroupMembers(groupName: String)(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): List[GroupMember]

    

    Definition Classes

    AccountService

62. def getGroupNames(userName: String)(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): List[String]

    

    Definition Classes

    AccountService

63. def getGroupsByUserName(userName: String)(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): List[String]

    

    Definition Classes

    AccountService

64. def getIssue(userName: String, repositoryName: String, issueId: String)(implicit context: Context): Option[Issue]

    

    Definition Classes

    RequestCache

65. def getIssue(owner: String, repository: String, issueId: String)(implicit s: Session): Option[model.IssueComponent.Issues.TableElementType]

    

    Definition Classes

    IssuesService

66. def getIssueLabel(owner: String, repository: String, issueId: Int, labelId: Int)(implicit s: Session): Option[model.IssueLabelComponent.IssueLabels.TableElementType]

    

    Definition Classes

    IssuesService

67. def getIssueLabels(owner: String, repository: String, issueId: Int)(implicit s: Session): List[Label]

    

    Definition Classes

    IssuesService

68. def getRepository(userName: String, repositoryName: String)(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): Option[RepositoryInfo]

    

    Returns the specified repository information.

    Returns the specified repository information.

    userName

    the user name of the repository owner

    repositoryName

    the repository name

    returns

    the repository information

    Definition Classes

    RepositoryService

69. def getRepositoryNamesOfUser(userName: String)(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): List[String]

    

    Returns the repository names of the specified user.

    Returns the repository names of the specified user.

    userName

    the user name of repository owner

    returns

    the list of repository names

    Definition Classes

    RepositoryService

70. def getUserRepositories(userName: String, withoutPhysicalInfo: Boolean = false)(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): List[RepositoryInfo]

    

    Definition Classes

    RepositoryService

71. def getVisibleRepositories(loginAccount: Option[Account], repositoryUserName: Option[String] = None, withoutPhysicalInfo: Boolean = false)(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): List[RepositoryInfo]

    

    Returns the list of visible repositories for the specified user.

    Returns the list of visible repositories for the specified user. If repositoryUserName is given then filters results by repository owner.

    loginAccount

    the logged in account

    repositoryUserName

    the repository owner (if None then returns all repositories which are visible for logged in user)

    withoutPhysicalInfo

    if true then the result does not include physical repository information such as commit count, branches and tags

    returns

    the repository information which is sorted in descending order of lastActivityDate.

    Definition Classes

    RepositoryService

72. def hasDeveloperRole(owner: String, repository: String, loginAccount: Option[Account])(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): Boolean

    

    Definition Classes

    RepositoryService

73. def hasGuestRole(owner: String, repository: String, loginAccount: Option[Account])(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): Boolean

    

    Definition Classes

    RepositoryService

74. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

75. def insertRepository(repositoryName: String, userName: String, description: Option[String], isPrivate: Boolean, originRepositoryName: Option[String] = None, originUserName: Option[String] = None, parentRepositoryName: Option[String] = None, parentUserName: Option[String] = None)(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): Unit

    

    Creates a new repository.

    Creates a new repository.

    repositoryName

    the repository name

    userName

    the user name of the repository owner

    description

    the repository description

    isPrivate

    the repository type (private is true, otherwise false)

    originRepositoryName

    specify for the forked repository. (default is None)

    originUserName

    specify for the forked repository. (default is None)

    Definition Classes

    RepositoryService

76. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

77. def isLastAdministrator(account: Account)(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): Boolean

    

    Definition Classes

    AccountService

78. def isPast(date: Date): Boolean

    

    Test whether the given Date is past date.

79. def isRenderable(fileName: String): Boolean

    

    Tests whether the given file is renderable.

    Tests whether the given file is renderable. It's tested by the file extension.

80. def issueLink(repository: RepositoryInfo, issueId: Int)(implicit context: Context): Html

    

    Creates a link to the issue or the pull request from the issue id.

81. def json(obj: AnyRef): String

    

    Render a given object as the JSON string.

82. def link(value: String, repository: RepositoryInfo)(implicit context: Context): Html

    

    Converts commit id, issue id and username to the link.

83. def loadSystemSettings(): SystemSettings

    

    Definition Classes

    SystemSettingsService

84. def markdown(markdown: String, repository: RepositoryInfo, enableWikiLink: Boolean, enableRefsLink: Boolean, enableLineBreaks: Boolean, enableAnchor: Boolean = true, enableTaskList: Boolean = false, hasWritePermission: Boolean = false, pages: List[String] = Nil)(implicit context: Context): Html

    

    Converts Markdown of Wiki pages to HTML.

85. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

86. final def notify(): Unit

    

    Definition Classes

    AnyRef

87. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

88. def plural(count: Int, singular: String, plural: String = ""): String

    

    Returns singular if count is 1, otherwise plural.

    Returns singular if count is 1, otherwise plural. If plural is not specified, returns singular + "s" as plural.

89. def pre(value: Html): Html

    

90. def registerIssueLabel(owner: String, repository: String, issueId: Int, labelId: Int)(implicit s: Session): Int

    

    Definition Classes

    IssuesService

91. def removeCollaborators(userName: String, repositoryName: String)(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): Unit

    

    Remove all collaborators from the repository.

    Remove all collaborators from the repository.

    Definition Classes

    RepositoryService

92. def removeHtml(html: Html): Html

    

    Remove html tags from the given Html instance.

93. def removeUserRelatedData(userName: String)(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): Unit

    

    Definition Classes

    AccountService

94. def renameRepository(oldUserName: String, oldRepositoryName: String, newUserName: String, newRepositoryName: String)(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): Unit

    

    Definition Classes

    RepositoryService

95. def renderMarkup(filePath: List[String], fileContent: String, branch: String, repository: RepositoryInfo, enableWikiLink: Boolean, enableRefsLink: Boolean, enableAnchor: Boolean)(implicit context: Context): Html

    

    Render the given source (only markdown is supported in default) as HTML.

    Render the given source (only markdown is supported in default) as HTML. You can test if a file is renderable in this method by isRenderable().

96. def saveRepositoryDefaultBranch(userName: String, repositoryName: String, defaultBranch: String)(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): Unit

    

    Definition Classes

    RepositoryService

97. def saveRepositoryOptions(userName: String, repositoryName: String, description: Option[String], isPrivate: Boolean, issuesOption: String, externalIssuesUrl: Option[String], wikiOption: String, externalWikiUrl: Option[String], allowFork: Boolean)(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): Unit

    

    Save repository options.

    Save repository options.

    Definition Classes

    RepositoryService

98. def saveSystemSettings(settings: SystemSettings): Unit

    

    Definition Classes

    SystemSettingsService

99. def searchIssue(condition: IssueSearchCondition, pullRequest: Boolean, offset: Int, limit: Int, repos: (String, String)*)(implicit s: Session): List[IssueInfo]

    

    Returns the search result against issues.

    Returns the search result against issues.

    condition

    the search condition

    pullRequest

    if true then returns only pull requests, false then returns only issues.

    offset

    the offset for pagination

    limit

    the limit for pagination

    repos

    Tuple of the repository owner and the repository name

    returns

    the search result (list of tuples which contain issue, labels and comment count)

    Definition Classes

    IssuesService

100. def searchIssuesByKeyword(owner: String, repository: String, query: String)(implicit s: Session): List[(Issue, Int, String)]

     

     Search issues by keyword.

     Search issues by keyword.

     owner

     the repository owner

     repository

     the repository name

     query

     the keywords separated by whitespace.

     returns

     issues with comment count and matched content of issue or comment

     Definition Classes

     IssuesService

101. def searchPullRequestByApi(condition: IssueSearchCondition, offset: Int, limit: Int, repos: (String, String)*)(implicit s: Session): List[(Issue, Account, Int, PullRequest, Repository, Account)]

     

     for api

     for api

     returns

     (issue, issueUser, commentCount, pullRequest, headRepo, headOwner)

     Definition Classes

     IssuesService

102. final def synchronized[T0](arg0: ⇒ T0): T0

     

     Definition Classes

     AnyRef

103. val timeUnits: List[(Long, String)]

     

104. def toString(): String

     

     Definition Classes

     AnyRef → Any

105. def updateAccount(account: Account)(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): Unit

     

     Definition Classes

     AccountService

106. def updateAssignedUserName(owner: String, repository: String, issueId: Int, assignedUserName: Option[String])(implicit s: Session): Int

     

     Definition Classes

     IssuesService

107. def updateAvatarImage(userName: String, image: Option[String])(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): Unit

     

     Definition Classes

     AccountService

108. def updateClosed(owner: String, repository: String, issueId: Int, closed: Boolean)(implicit s: Session): Int

     

     Definition Classes

     IssuesService

109. def updateComment(commentId: Int, content: String)(implicit s: Session): Int

     

     Definition Classes

     IssuesService

110. def updateGroup(groupName: String, url: Option[String], removed: Boolean)(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): Unit

     

     Definition Classes

     AccountService

111. def updateGroupMembers(groupName: String, members: List[(String, Boolean)])(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): Unit

     

     Definition Classes

     AccountService

112. def updateIssue(owner: String, repository: String, issueId: Int, title: String, content: Option[String])(implicit s: Session): Int

     

     Definition Classes

     IssuesService

113. def updateLastActivityDate(userName: String, repositoryName: String)(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): Unit

     

     Updates the last activity date of the repository.

     Updates the last activity date of the repository.

     Definition Classes

     RepositoryService

114. def updateLastLoginDate(userName: String)(implicit s: scala.slick.driver.JdbcProfile.SimpleQL.Session): Unit

     

     Definition Classes

     AccountService

115. def updateMilestoneId(owner: String, repository: String, issueId: Int, milestoneId: Option[Int])(implicit s: Session): Int

     

     Definition Classes

     IssuesService

116. def url(userName: String)(implicit context: Context): String

     

     Generates the url to the account page.

117. def url(repository: RepositoryInfo)(implicit context: Context): String

     

     Generates the url to the repository.

118. def urlEncode(value: Option[String]): String

     

119. def urlEncode(value: String): String

     

120. def user(userName: String, mailAddress: String = "", styleClass: String = "")(implicit context: Context): Html

     

     Generates the text link to the account page.

     Generates the text link to the account page. If user does not exist or disabled, this method returns user name as text without link.

121. final def wait(): Unit

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

122. final def wait(arg0: Long, arg1: Int): Unit

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

123. final def wait(arg0: Long): Unit

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )