notifications.go
author Mikael Berthe <mikael@lilotux.net>
Mon, 29 Jul 2019 21:57:47 +0200
changeset 253 0e8c8026cf40
parent 243 7386c6a454a8
permissions -rw-r--r--
Update dependencies
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
130
c450bb73f59a Update credits
Mikael Berthe <mikael@lilotux.net>
parents: 120
diff changeset
     1
/*
207
301d5b94be3f Update copyrights
Mikael Berthe <mikael@lilotux.net>
parents: 159
diff changeset
     2
Copyright 2017-2018 Mikael Berthe
130
c450bb73f59a Update credits
Mikael Berthe <mikael@lilotux.net>
parents: 120
diff changeset
     3
c450bb73f59a Update credits
Mikael Berthe <mikael@lilotux.net>
parents: 120
diff changeset
     4
Licensed under the MIT license.  Please see the LICENSE file is this directory.
c450bb73f59a Update credits
Mikael Berthe <mikael@lilotux.net>
parents: 120
diff changeset
     5
*/
c450bb73f59a Update credits
Mikael Berthe <mikael@lilotux.net>
parents: 120
diff changeset
     6
138
23d3a518d0ad Update package name in source files
Mikael Berthe <mikael@lilotux.net>
parents: 132
diff changeset
     7
package madon
95
94f139efff39 Add GetNotifications()
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     8
94f139efff39 Add GetNotifications()
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     9
import (
212
21d7dc38c0e4 GetNotifications: Add excludeTypes
Mikael Berthe <mikael@lilotux.net>
parents: 207
diff changeset
    10
	"fmt"
95
94f139efff39 Add GetNotifications()
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    11
	"strconv"
94f139efff39 Add GetNotifications()
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    12
94f139efff39 Add GetNotifications()
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    13
	"github.com/sendgrid/rest"
94f139efff39 Add GetNotifications()
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    14
)
94f139efff39 Add GetNotifications()
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    15
94f139efff39 Add GetNotifications()
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    16
// GetNotifications returns the list of the user's notifications
212
21d7dc38c0e4 GetNotifications: Add excludeTypes
Mikael Berthe <mikael@lilotux.net>
parents: 207
diff changeset
    17
// excludeTypes is an array of notifications to exclude ("follow", "favourite",
21d7dc38c0e4 GetNotifications: Add excludeTypes
Mikael Berthe <mikael@lilotux.net>
parents: 207
diff changeset
    18
// "reblog", "mention").  It can be nil.
156
70aadba26338 Add field "All" to LimitParams, change Limit behaviour
Mikael Berthe <mikael@lilotux.net>
parents: 155
diff changeset
    19
// If lopt.All is true, several requests will be made until the API server
70aadba26338 Add field "All" to LimitParams, change Limit behaviour
Mikael Berthe <mikael@lilotux.net>
parents: 155
diff changeset
    20
// has nothing to return.
70aadba26338 Add field "All" to LimitParams, change Limit behaviour
Mikael Berthe <mikael@lilotux.net>
parents: 155
diff changeset
    21
// If lopt.Limit is set (and not All), several queries can be made until the
70aadba26338 Add field "All" to LimitParams, change Limit behaviour
Mikael Berthe <mikael@lilotux.net>
parents: 155
diff changeset
    22
// limit is reached.
212
21d7dc38c0e4 GetNotifications: Add excludeTypes
Mikael Berthe <mikael@lilotux.net>
parents: 207
diff changeset
    23
func (mc *Client) GetNotifications(excludeTypes []string, lopt *LimitParams) ([]Notification, error) {
95
94f139efff39 Add GetNotifications()
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    24
	var notifications []Notification
155
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 149
diff changeset
    25
	var links apiLinks
212
21d7dc38c0e4 GetNotifications: Add excludeTypes
Mikael Berthe <mikael@lilotux.net>
parents: 207
diff changeset
    26
	var params apiCallParams
21d7dc38c0e4 GetNotifications: Add excludeTypes
Mikael Berthe <mikael@lilotux.net>
parents: 207
diff changeset
    27
21d7dc38c0e4 GetNotifications: Add excludeTypes
Mikael Berthe <mikael@lilotux.net>
parents: 207
diff changeset
    28
	if len(excludeTypes) > 0 {
21d7dc38c0e4 GetNotifications: Add excludeTypes
Mikael Berthe <mikael@lilotux.net>
parents: 207
diff changeset
    29
		params = make(apiCallParams)
21d7dc38c0e4 GetNotifications: Add excludeTypes
Mikael Berthe <mikael@lilotux.net>
parents: 207
diff changeset
    30
		for i, eType := range excludeTypes {
243
7386c6a454a8 Change the way parameter lists are handled internally
Mikael Berthe <mikael@lilotux.net>
parents: 238
diff changeset
    31
			qID := fmt.Sprintf("[%d]exclude_types", i)
212
21d7dc38c0e4 GetNotifications: Add excludeTypes
Mikael Berthe <mikael@lilotux.net>
parents: 207
diff changeset
    32
			params[qID] = eType
21d7dc38c0e4 GetNotifications: Add excludeTypes
Mikael Berthe <mikael@lilotux.net>
parents: 207
diff changeset
    33
		}
21d7dc38c0e4 GetNotifications: Add excludeTypes
Mikael Berthe <mikael@lilotux.net>
parents: 207
diff changeset
    34
	}
21d7dc38c0e4 GetNotifications: Add excludeTypes
Mikael Berthe <mikael@lilotux.net>
parents: 207
diff changeset
    35
238
1c0042e76902 Do not use a global API version
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
    36
	if err := mc.apiCall("v1/notifications", rest.Get, params, lopt, &links, &notifications); err != nil {
120
579912e9d0ef Refactor API calls
Mikael Berthe <mikael@lilotux.net>
parents: 102
diff changeset
    37
		return nil, err
95
94f139efff39 Add GetNotifications()
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    38
	}
155
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 149
diff changeset
    39
	if lopt != nil { // Fetch more pages to reach our limit
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 149
diff changeset
    40
		var notifSlice []Notification
156
70aadba26338 Add field "All" to LimitParams, change Limit behaviour
Mikael Berthe <mikael@lilotux.net>
parents: 155
diff changeset
    41
		for (lopt.All || lopt.Limit > len(notifications)) && links.next != nil {
155
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 149
diff changeset
    42
			newlopt := links.next
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 149
diff changeset
    43
			links = apiLinks{}
238
1c0042e76902 Do not use a global API version
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
    44
			if err := mc.apiCall("v1/notifications", rest.Get, nil, newlopt, &links, &notifSlice); err != nil {
155
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 149
diff changeset
    45
				return nil, err
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 149
diff changeset
    46
			}
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 149
diff changeset
    47
			notifications = append(notifications, notifSlice...)
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 149
diff changeset
    48
			notifSlice = notifSlice[:0] // Clear struct
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 149
diff changeset
    49
		}
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 149
diff changeset
    50
	}
95
94f139efff39 Add GetNotifications()
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    51
	return notifications, nil
94f139efff39 Add GetNotifications()
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    52
}
94f139efff39 Add GetNotifications()
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    53
94f139efff39 Add GetNotifications()
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    54
// GetNotification returns a notification
102
187aa2a668a5 Update comment
Mikael Berthe <mikael@lilotux.net>
parents: 99
diff changeset
    55
// The returned notification can be nil if there is an error or if the
187aa2a668a5 Update comment
Mikael Berthe <mikael@lilotux.net>
parents: 99
diff changeset
    56
// requested notification does not exist.
159
408aa794d9bb s/int/int64/ for IDs and time integers
Mikael Berthe <mikael@lilotux.net>
parents: 156
diff changeset
    57
func (mc *Client) GetNotification(notificationID int64) (*Notification, error) {
132
639bbcddb4fe Make identifiers less ambiguous
Mikael Berthe <mikael@lilotux.net>
parents: 130
diff changeset
    58
	if notificationID < 1 {
120
579912e9d0ef Refactor API calls
Mikael Berthe <mikael@lilotux.net>
parents: 102
diff changeset
    59
		return nil, ErrInvalidID
95
94f139efff39 Add GetNotifications()
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    60
	}
94f139efff39 Add GetNotifications()
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    61
159
408aa794d9bb s/int/int64/ for IDs and time integers
Mikael Berthe <mikael@lilotux.net>
parents: 156
diff changeset
    62
	var endPoint = "notifications/" + strconv.FormatInt(notificationID, 10)
120
579912e9d0ef Refactor API calls
Mikael Berthe <mikael@lilotux.net>
parents: 102
diff changeset
    63
	var notification Notification
238
1c0042e76902 Do not use a global API version
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
    64
	if err := mc.apiCall("v1/"+endPoint, rest.Get, nil, nil, nil, &notification); err != nil {
120
579912e9d0ef Refactor API calls
Mikael Berthe <mikael@lilotux.net>
parents: 102
diff changeset
    65
		return nil, err
95
94f139efff39 Add GetNotifications()
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    66
	}
99
6ec2a44a1bd1 Return error rather than empty entities
Mikael Berthe <mikael@lilotux.net>
parents: 98
diff changeset
    67
	if notification.ID == 0 {
6ec2a44a1bd1 Return error rather than empty entities
Mikael Berthe <mikael@lilotux.net>
parents: 98
diff changeset
    68
		return nil, ErrEntityNotFound
6ec2a44a1bd1 Return error rather than empty entities
Mikael Berthe <mikael@lilotux.net>
parents: 98
diff changeset
    69
	}
95
94f139efff39 Add GetNotifications()
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    70
	return &notification, nil
94f139efff39 Add GetNotifications()
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    71
}
96
5496be0e3d4f Add ClearNotifications()
Mikael Berthe <mikael@lilotux.net>
parents: 95
diff changeset
    72
148
ae2cbcf18b55 Add DismissNotification (Mastodon 1.3+)
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    73
// DismissNotification deletes a notification
159
408aa794d9bb s/int/int64/ for IDs and time integers
Mikael Berthe <mikael@lilotux.net>
parents: 156
diff changeset
    74
func (mc *Client) DismissNotification(notificationID int64) error {
148
ae2cbcf18b55 Add DismissNotification (Mastodon 1.3+)
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    75
	if notificationID < 1 {
ae2cbcf18b55 Add DismissNotification (Mastodon 1.3+)
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    76
		return ErrInvalidID
ae2cbcf18b55 Add DismissNotification (Mastodon 1.3+)
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    77
	}
ae2cbcf18b55 Add DismissNotification (Mastodon 1.3+)
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    78
ae2cbcf18b55 Add DismissNotification (Mastodon 1.3+)
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    79
	endPoint := "notifications/dismiss"
159
408aa794d9bb s/int/int64/ for IDs and time integers
Mikael Berthe <mikael@lilotux.net>
parents: 156
diff changeset
    80
	params := apiCallParams{"id": strconv.FormatInt(notificationID, 10)}
238
1c0042e76902 Do not use a global API version
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
    81
	err := mc.apiCall("v1/"+endPoint, rest.Post, params, nil, nil, &Notification{})
155
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 149
diff changeset
    82
	return err
148
ae2cbcf18b55 Add DismissNotification (Mastodon 1.3+)
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    83
}
ae2cbcf18b55 Add DismissNotification (Mastodon 1.3+)
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    84
96
5496be0e3d4f Add ClearNotifications()
Mikael Berthe <mikael@lilotux.net>
parents: 95
diff changeset
    85
// ClearNotifications deletes all notifications from the Mastodon server for
5496be0e3d4f Add ClearNotifications()
Mikael Berthe <mikael@lilotux.net>
parents: 95
diff changeset
    86
// the authenticated user
138
23d3a518d0ad Update package name in source files
Mikael Berthe <mikael@lilotux.net>
parents: 132
diff changeset
    87
func (mc *Client) ClearNotifications() error {
238
1c0042e76902 Do not use a global API version
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
    88
	err := mc.apiCall("v1/notifications/clear", rest.Post, nil, nil, nil, &Notification{})
155
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 149
diff changeset
    89
	return err
96
5496be0e3d4f Add ClearNotifications()
Mikael Berthe <mikael@lilotux.net>
parents: 95
diff changeset
    90
}