forked from absmach/magistrala
-
Notifications
You must be signed in to change notification settings - Fork 0
/
subscriptions.go
46 lines (37 loc) · 1.19 KB
/
subscriptions.go
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
// Copyright (c) Mainflux
// SPDX-License-Identifier: Apache-2.0
package notifiers
import "context"
// Subscription represents a user Subscription.
type Subscription struct {
ID string
OwnerID string
Contact string
Topic string
}
// Page represents page metadata with content.
type Page struct {
PageMetadata
Total uint
Subscriptions []Subscription
}
// PageMetadata contains page metadata that helps navigation.
type PageMetadata struct {
Offset uint
// Limit values less than 0 indicate no limit.
Limit int
Topic string
Contact string
}
// SubscriptionsRepository specifies a Subscription persistence API.
type SubscriptionsRepository interface {
// Save persists a subscription. Successful operation is indicated by non-nil
// error response.
Save(ctx context.Context, sub Subscription) (string, error)
// Retrieve retrieves the subscription for the given id.
Retrieve(ctx context.Context, id string) (Subscription, error)
// RetrieveAll retrieves all the subscriptions for the given page metadata.
RetrieveAll(ctx context.Context, pm PageMetadata) (Page, error)
// Remove removes the subscription for the given ID.
Remove(ctx context.Context, id string) error
}