summaryrefslogtreecommitdiff
path: root/internal/typeutils/asinterfaces.go
blob: d0b1cf617b929ea46e0606b4d68ed0189759e5df (plain)
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
/*
   GoToSocial
   Copyright (C) 2021 GoToSocial Authors admin@gotosocial.org

   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 typeutils

import "github.com/go-fed/activity/streams/vocab"

// Accountable represents the minimum activitypub interface for representing an 'account'.
// This interface is fulfilled by: Person, Application, Organization, Service, and Group
type Accountable interface {
	withJSONLDId
	withTypeName

	withPreferredUsername
	withIcon
	withName
	withImage
	withSummary
	withDiscoverable
	withURL
	withPublicKey
	withInbox
	withOutbox
	withFollowing
	withFollowers
	withFeatured
}

// Statusable represents the minimum activitypub interface for representing a 'status'.
// This interface is fulfilled by: Article, Document, Image, Video, Note, Page, Event, Place, Mention, Profile
type Statusable interface {
	withJSONLDId
	withTypeName

	withSummary
	withInReplyTo
	withPublished
	withURL
	withAttributedTo
	withTo
	withCC
	withSensitive
	withConversation
	withContent
	withAttachment
	withTag
	withReplies
}

// Attachmentable represents the minimum activitypub interface for representing a 'mediaAttachment'.
// This interface is fulfilled by: Audio, Document, Image, Video
type Attachmentable interface {
	withTypeName
	withMediaType
	withURL
	withName
}

// Hashtaggable represents the minimum activitypub interface for representing a 'hashtag' tag.
type Hashtaggable interface {
	withTypeName
	withHref
	withName
}

// Emojiable represents the minimum interface for an 'emoji' tag.
type Emojiable interface {
	withJSONLDId
	withTypeName
	withName
	withUpdated
	withIcon
}

// Mentionable represents the minimum interface for a 'mention' tag.
type Mentionable interface {
	withName
	withHref
}

// Followable represents the minimum interface for an activitystreams 'follow' activity.
type Followable interface {
	withJSONLDId
	withTypeName

	withActor
	withObject
}

// Likeable represents the minimum interface for an activitystreams 'like' activity.
type Likeable interface {
	withJSONLDId
	withTypeName

	withActor
	withObject
}

// Blockable represents the minimum interface for an activitystreams 'block' activity.
type Blockable interface {
	withJSONLDId
	withTypeName

	withActor
	withObject
}

// Announceable represents the minimum interface for an activitystreams 'announce' activity.
type Announceable interface {
	withJSONLDId
	withTypeName

	withActor
	withObject
	withPublished
	withTo
	withCC
}

type withJSONLDId interface {
	GetJSONLDId() vocab.JSONLDIdProperty
}

type withTypeName interface {
	GetTypeName() string
}

type withPreferredUsername interface {
	GetActivityStreamsPreferredUsername() vocab.ActivityStreamsPreferredUsernameProperty
}

type withIcon interface {
	GetActivityStreamsIcon() vocab.ActivityStreamsIconProperty
}

type withName interface {
	GetActivityStreamsName() vocab.ActivityStreamsNameProperty
}

type withImage interface {
	GetActivityStreamsImage() vocab.ActivityStreamsImageProperty
}

type withSummary interface {
	GetActivityStreamsSummary() vocab.ActivityStreamsSummaryProperty
}

type withDiscoverable interface {
	GetTootDiscoverable() vocab.TootDiscoverableProperty
}

type withURL interface {
	GetActivityStreamsUrl() vocab.ActivityStreamsUrlProperty
}

type withPublicKey interface {
	GetW3IDSecurityV1PublicKey() vocab.W3IDSecurityV1PublicKeyProperty
}

type withInbox interface {
	GetActivityStreamsInbox() vocab.ActivityStreamsInboxProperty
}

type withOutbox interface {
	GetActivityStreamsOutbox() vocab.ActivityStreamsOutboxProperty
}

type withFollowing interface {
	GetActivityStreamsFollowing() vocab.ActivityStreamsFollowingProperty
}

type withFollowers interface {
	GetActivityStreamsFollowers() vocab.ActivityStreamsFollowersProperty
}

type withFeatured interface {
	GetTootFeatured() vocab.TootFeaturedProperty
}

type withAttributedTo interface {
	GetActivityStreamsAttributedTo() vocab.ActivityStreamsAttributedToProperty
}

type withAttachment interface {
	GetActivityStreamsAttachment() vocab.ActivityStreamsAttachmentProperty
}

type withTo interface {
	GetActivityStreamsTo() vocab.ActivityStreamsToProperty
}

type withInReplyTo interface {
	GetActivityStreamsInReplyTo() vocab.ActivityStreamsInReplyToProperty
}

type withCC interface {
	GetActivityStreamsCc() vocab.ActivityStreamsCcProperty
}

type withSensitive interface {
	// TODO
}

type withConversation interface {
	// TODO
}

type withContent interface {
	GetActivityStreamsContent() vocab.ActivityStreamsContentProperty
}

type withPublished interface {
	GetActivityStreamsPublished() vocab.ActivityStreamsPublishedProperty
}

type withTag interface {
	GetActivityStreamsTag() vocab.ActivityStreamsTagProperty
}

type withReplies interface {
	GetActivityStreamsReplies() vocab.ActivityStreamsRepliesProperty
}

type withMediaType interface {
	GetActivityStreamsMediaType() vocab.ActivityStreamsMediaTypeProperty
}

// type withBlurhash interface {
// 	GetTootBlurhashProperty() vocab.TootBlurhashProperty
// }

// type withFocalPoint interface {
// 	// TODO
// }

type withHref interface {
	GetActivityStreamsHref() vocab.ActivityStreamsHrefProperty
}

type withUpdated interface {
	GetActivityStreamsUpdated() vocab.ActivityStreamsUpdatedProperty
}

type withActor interface {
	GetActivityStreamsActor() vocab.ActivityStreamsActorProperty
}

type withObject interface {
	GetActivityStreamsObject() vocab.ActivityStreamsObjectProperty
}