FilesExpand file tree

 master

/

issues_comments.go

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

153 lines (130 loc) · 5.01 KB

 master

/

issues_comments.go

Copy path

Top

File metadata and controls

• Code
• Blame

153 lines (130 loc) · 5.01 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

// Copyright 2013 The go-github AUTHORS. All rights reserved.

//

// Use of this source code is governed by a BSD-style

// license that can be found in the LICENSE file.

package github

import (

"context"

"fmt"

"time"

)

// IssueComment represents a comment left on an issue.

type IssueComment struct {

ID *int64 `json:"id,omitempty"`

NodeID *string `json:"node_id,omitempty"`

Body *string `json:"body,omitempty"`

User *User `json:"user,omitempty"`

Reactions *Reactions `json:"reactions,omitempty"`

CreatedAt *time.Time `json:"created_at,omitempty"`

UpdatedAt *time.Time `json:"updated_at,omitempty"`

// AuthorAssociation is the comment author's relationship to the issue's repository.

// Possible values are "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MEMBER", "OWNER", or "NONE".

AuthorAssociation *string `json:"author_association,omitempty"`

URL *string `json:"url,omitempty"`

HTMLURL *string `json:"html_url,omitempty"`

IssueURL *string `json:"issue_url,omitempty"`

}

func (i IssueComment) String() string {

return Stringify(i)

}

// IssueListCommentsOptions specifies the optional parameters to the

// IssuesService.ListComments method.

type IssueListCommentsOptions struct {

// Sort specifies how to sort comments. Possible values are: created, updated.

Sort string `url:"sort,omitempty"`

// Direction in which to sort comments. Possible values are: asc, desc.

Direction string `url:"direction,omitempty"`

// Since filters comments by time.

Since time.Time `url:"since,omitempty"`

ListOptions

}

// ListComments lists all comments on the specified issue. Specifying an issue

// number of 0 will return all comments on all issues for the repository.

//

// GitHub API docs: https://developer.github.com/v3/issues/comments/#list-comments-on-an-issue

func (s *IssuesService) ListComments(ctx context.Context, owner string, repo string, number int, opt *IssueListCommentsOptions) ([]*IssueComment, *Response, error) {

var u string

if number == 0 {

u = fmt.Sprintf("repos/%v/%v/issues/comments", owner, repo)

} else {

u = fmt.Sprintf("repos/%v/%v/issues/%d/comments", owner, repo, number)

}

u, err := addOptions(u, opt)

if err != nil {

return nil, nil, err

}

req, err := s.client.NewRequest("GET", u, nil)

if err != nil {

return nil, nil, err

}

// TODO: remove custom Accept header when this API fully launches.

req.Header.Set("Accept", mediaTypeReactionsPreview)

var comments []*IssueComment

resp, err := s.client.Do(ctx, req, &comments)

if err != nil {

return nil, resp, err

}

return comments, resp, nil

}

// GetComment fetches the specified issue comment.

//

// GitHub API docs: https://developer.github.com/v3/issues/comments/#get-a-single-comment

func (s *IssuesService) GetComment(ctx context.Context, owner string, repo string, commentID int64) (*IssueComment, *Response, error) {

u := fmt.Sprintf("repos/%v/%v/issues/comments/%d", owner, repo, commentID)

req, err := s.client.NewRequest("GET", u, nil)

if err != nil {

return nil, nil, err

}

// TODO: remove custom Accept header when this API fully launches.

req.Header.Set("Accept", mediaTypeReactionsPreview)

comment := new(IssueComment)

resp, err := s.client.Do(ctx, req, comment)

if err != nil {

return nil, resp, err

}

return comment, resp, nil

}

// CreateComment creates a new comment on the specified issue.

//

// GitHub API docs: https://developer.github.com/v3/issues/comments/#create-a-comment

func (s *IssuesService) CreateComment(ctx context.Context, owner string, repo string, number int, comment *IssueComment) (*IssueComment, *Response, error) {

u := fmt.Sprintf("repos/%v/%v/issues/%d/comments", owner, repo, number)

req, err := s.client.NewRequest("POST", u, comment)

if err != nil {

return nil, nil, err

}

c := new(IssueComment)

resp, err := s.client.Do(ctx, req, c)

if err != nil {

return nil, resp, err

}

return c, resp, nil

}

// EditComment updates an issue comment.

// A non-nil comment.Body must be provided. Other comment fields should be left nil.

//

// GitHub API docs: https://developer.github.com/v3/issues/comments/#edit-a-comment

func (s *IssuesService) EditComment(ctx context.Context, owner string, repo string, commentID int64, comment *IssueComment) (*IssueComment, *Response, error) {

u := fmt.Sprintf("repos/%v/%v/issues/comments/%d", owner, repo, commentID)

req, err := s.client.NewRequest("PATCH", u, comment)

if err != nil {

return nil, nil, err

}

c := new(IssueComment)

resp, err := s.client.Do(ctx, req, c)

if err != nil {

return nil, resp, err

}

return c, resp, nil

}

// DeleteComment deletes an issue comment.

//

// GitHub API docs: https://developer.github.com/v3/issues/comments/#delete-a-comment

func (s *IssuesService) DeleteComment(ctx context.Context, owner string, repo string, commentID int64) (*Response, error) {

u := fmt.Sprintf("repos/%v/%v/issues/comments/%d", owner, repo, commentID)

req, err := s.client.NewRequest("DELETE", u, nil)

if err != nil {

return nil, err

}

return s.client.Do(ctx, req, nil)

}