summaryrefslogtreecommitdiff
path: root/internal/db/webpush.go
diff options
context:
space:
mode:
Diffstat (limited to 'internal/db/webpush.go')
-rw-r--r--internal/db/webpush.go54
1 files changed, 54 insertions, 0 deletions
diff --git a/internal/db/webpush.go b/internal/db/webpush.go
new file mode 100644
index 000000000..22bf449de
--- /dev/null
+++ b/internal/db/webpush.go
@@ -0,0 +1,54 @@
+// GoToSocial
+// Copyright (C) GoToSocial Authors admin@gotosocial.org
+// SPDX-License-Identifier: AGPL-3.0-or-later
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// 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 Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+package db
+
+import (
+ "context"
+
+ "github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
+)
+
+// WebPush contains functions related to Web Push notifications.
+type WebPush interface {
+ // GetVAPIDKeyPair retrieves the server's existing VAPID key pair, if there is one.
+ // If there isn't one, it generates a new one, stores it, and returns that.
+ GetVAPIDKeyPair(ctx context.Context) (*gtsmodel.VAPIDKeyPair, error)
+
+ // DeleteVAPIDKeyPair deletes the server's VAPID key pair.
+ DeleteVAPIDKeyPair(ctx context.Context) error
+
+ // GetWebPushSubscriptionByTokenID retrieves an access token's Web Push subscription.
+ // There may not be one, in which case an error will be returned.
+ GetWebPushSubscriptionByTokenID(ctx context.Context, tokenID string) (*gtsmodel.WebPushSubscription, error)
+
+ // PutWebPushSubscription creates an access token's Web Push subscription.
+ PutWebPushSubscription(ctx context.Context, subscription *gtsmodel.WebPushSubscription) error
+
+ // UpdateWebPushSubscription updates an access token's Web Push subscription.
+ // There may not be one, in which case an error will be returned.
+ UpdateWebPushSubscription(ctx context.Context, subscription *gtsmodel.WebPushSubscription, columns ...string) error
+
+ // DeleteWebPushSubscriptionByTokenID deletes an access token's Web Push subscription, if there is one.
+ DeleteWebPushSubscriptionByTokenID(ctx context.Context, tokenID string) error
+
+ // GetWebPushSubscriptionsByAccountID retrieves an account's list of Web Push subscriptions.
+ GetWebPushSubscriptionsByAccountID(ctx context.Context, accountID string) ([]*gtsmodel.WebPushSubscription, error)
+
+ // DeleteWebPushSubscriptionsByAccountID deletes an account's list of Web Push subscriptions.
+ DeleteWebPushSubscriptionsByAccountID(ctx context.Context, accountID string) error
+}