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
|
// Copyright (c) 2024 Canonical Ltd
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License version 3 as
// published by the Free Software Foundation.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
package client
import (
"bytes"
"encoding/json"
)
type NotifyOptions struct {
// Type is the notice's type. Currently only notices of type CustomNotice
// can be added.
Type NoticeType
// Key is the notice's key. For "custom" notices, this must be in
// "domain.com/key" format.
Key string
}
// Notify records an occurrence of a notice with the specified options,
// returning the notice ID.
func (client *Client) Notify(opts *NotifyOptions) (string, error) {
var payload = struct {
Action string `json:"action"`
Type string `json:"type"`
Key string `json:"key"`
}{
Action: "add",
Type: string(opts.Type),
Key: opts.Key,
}
var body bytes.Buffer
if err := json.NewEncoder(&body).Encode(&payload); err != nil {
return "", err
}
result := struct {
ID string `json:"id"`
}{}
_, err := client.doSync("POST", "/v2/notices", nil, nil, &body, &result)
if err != nil {
return "", err
}
return result.ID, err
}
type NoticeType string
const (
// SnapRunInhibitNotice is recorded when "snap run" is inhibited due refresh.
SnapRunInhibitNotice NoticeType = "snap-run-inhibit"
)
|
