github.com/google/go-github/v50@v50.2.0/github/event.go (about)

     1  // Copyright 2018 The go-github AUTHORS. All rights reserved.
     2  //
     3  // Use of this source code is governed by a BSD-style
     4  // license that can be found in the LICENSE file.
     5  
     6  package github
     7  
     8  import (
     9  	"encoding/json"
    10  )
    11  
    12  // Event represents a GitHub event.
    13  type Event struct {
    14  	Type       *string          `json:"type,omitempty"`
    15  	Public     *bool            `json:"public,omitempty"`
    16  	RawPayload *json.RawMessage `json:"payload,omitempty"`
    17  	Repo       *Repository      `json:"repo,omitempty"`
    18  	Actor      *User            `json:"actor,omitempty"`
    19  	Org        *Organization    `json:"org,omitempty"`
    20  	CreatedAt  *Timestamp       `json:"created_at,omitempty"`
    21  	ID         *string          `json:"id,omitempty"`
    22  }
    23  
    24  func (e Event) String() string {
    25  	return Stringify(e)
    26  }
    27  
    28  // ParsePayload parses the event payload. For recognized event types,
    29  // a value of the corresponding struct type will be returned.
    30  func (e *Event) ParsePayload() (payload interface{}, err error) {
    31  	switch *e.Type {
    32  	case "BranchProtectionRuleEvent":
    33  		payload = &BranchProtectionRuleEvent{}
    34  	case "CheckRunEvent":
    35  		payload = &CheckRunEvent{}
    36  	case "CheckSuiteEvent":
    37  		payload = &CheckSuiteEvent{}
    38  	case "CodeScanningAlertEvent":
    39  		payload = &CodeScanningAlertEvent{}
    40  	case "CommitCommentEvent":
    41  		payload = &CommitCommentEvent{}
    42  	case "ContentReferenceEvent":
    43  		payload = &ContentReferenceEvent{}
    44  	case "CreateEvent":
    45  		payload = &CreateEvent{}
    46  	case "DeleteEvent":
    47  		payload = &DeleteEvent{}
    48  	case "DeployKeyEvent":
    49  		payload = &DeployKeyEvent{}
    50  	case "DeploymentEvent":
    51  		payload = &DeploymentEvent{}
    52  	case "DeploymentStatusEvent":
    53  		payload = &DeploymentStatusEvent{}
    54  	case "DiscussionEvent":
    55  		payload = &DiscussionEvent{}
    56  	case "DiscussionCommentEvent":
    57  		payload = &DiscussionCommentEvent{}
    58  	case "ForkEvent":
    59  		payload = &ForkEvent{}
    60  	case "GitHubAppAuthorizationEvent":
    61  		payload = &GitHubAppAuthorizationEvent{}
    62  	case "GollumEvent":
    63  		payload = &GollumEvent{}
    64  	case "InstallationEvent":
    65  		payload = &InstallationEvent{}
    66  	case "InstallationRepositoriesEvent":
    67  		payload = &InstallationRepositoriesEvent{}
    68  	case "IssueCommentEvent":
    69  		payload = &IssueCommentEvent{}
    70  	case "IssuesEvent":
    71  		payload = &IssuesEvent{}
    72  	case "LabelEvent":
    73  		payload = &LabelEvent{}
    74  	case "MarketplacePurchaseEvent":
    75  		payload = &MarketplacePurchaseEvent{}
    76  	case "MemberEvent":
    77  		payload = &MemberEvent{}
    78  	case "MembershipEvent":
    79  		payload = &MembershipEvent{}
    80  	case "MergeGroupEvent":
    81  		payload = &MergeGroupEvent{}
    82  	case "MetaEvent":
    83  		payload = &MetaEvent{}
    84  	case "MilestoneEvent":
    85  		payload = &MilestoneEvent{}
    86  	case "OrganizationEvent":
    87  		payload = &OrganizationEvent{}
    88  	case "OrgBlockEvent":
    89  		payload = &OrgBlockEvent{}
    90  	case "PackageEvent":
    91  		payload = &PackageEvent{}
    92  	case "PageBuildEvent":
    93  		payload = &PageBuildEvent{}
    94  	case "PingEvent":
    95  		payload = &PingEvent{}
    96  	case "ProjectEvent":
    97  		payload = &ProjectEvent{}
    98  	case "ProjectCardEvent":
    99  		payload = &ProjectCardEvent{}
   100  	case "ProjectColumnEvent":
   101  		payload = &ProjectColumnEvent{}
   102  	case "PublicEvent":
   103  		payload = &PublicEvent{}
   104  	case "PullRequestEvent":
   105  		payload = &PullRequestEvent{}
   106  	case "PullRequestReviewEvent":
   107  		payload = &PullRequestReviewEvent{}
   108  	case "PullRequestReviewCommentEvent":
   109  		payload = &PullRequestReviewCommentEvent{}
   110  	case "PullRequestReviewThreadEvent":
   111  		payload = &PullRequestReviewThreadEvent{}
   112  	case "PullRequestTargetEvent":
   113  		payload = &PullRequestTargetEvent{}
   114  	case "PushEvent":
   115  		payload = &PushEvent{}
   116  	case "ReleaseEvent":
   117  		payload = &ReleaseEvent{}
   118  	case "RepositoryEvent":
   119  		payload = &RepositoryEvent{}
   120  	case "RepositoryDispatchEvent":
   121  		payload = &RepositoryDispatchEvent{}
   122  	case "RepositoryImportEvent":
   123  		payload = &RepositoryImportEvent{}
   124  	case "RepositoryVulnerabilityAlertEvent":
   125  		payload = &RepositoryVulnerabilityAlertEvent{}
   126  	case "SecretScanningAlertEvent":
   127  		payload = &SecretScanningAlertEvent{}
   128  	case "StarEvent":
   129  		payload = &StarEvent{}
   130  	case "StatusEvent":
   131  		payload = &StatusEvent{}
   132  	case "TeamEvent":
   133  		payload = &TeamEvent{}
   134  	case "TeamAddEvent":
   135  		payload = &TeamAddEvent{}
   136  	case "UserEvent":
   137  		payload = &UserEvent{}
   138  	case "WatchEvent":
   139  		payload = &WatchEvent{}
   140  	case "WorkflowDispatchEvent":
   141  		payload = &WorkflowDispatchEvent{}
   142  	case "WorkflowJobEvent":
   143  		payload = &WorkflowJobEvent{}
   144  	case "WorkflowRunEvent":
   145  		payload = &WorkflowRunEvent{}
   146  	}
   147  	err = json.Unmarshal(*e.RawPayload, &payload)
   148  	return payload, err
   149  }
   150  
   151  // Payload returns the parsed event payload. For recognized event types,
   152  // a value of the corresponding struct type will be returned.
   153  //
   154  // Deprecated: Use ParsePayload instead, which returns an error
   155  // rather than panics if JSON unmarshaling raw payload fails.
   156  func (e *Event) Payload() (payload interface{}) {
   157  	var err error
   158  	payload, err = e.ParsePayload()
   159  	if err != nil {
   160  		panic(err)
   161  	}
   162  	return payload
   163  }