/
template.go
406 lines (355 loc) · 11.6 KB
/
template.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
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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
// Copyright 2016 LINE Corporation
//
// LINE Corporation licenses this file to you under the Apache License,
// version 2.0 (the "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at:
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations
// under the License.
package linebot
import (
"encoding/json"
)
// TemplateType type
type TemplateType string
// TemplateType constants
const (
TemplateTypeButtons TemplateType = "buttons"
TemplateTypeConfirm TemplateType = "confirm"
TemplateTypeCarousel TemplateType = "carousel"
TemplateTypeImageCarousel TemplateType = "image_carousel"
)
// TemplateActionType type
type TemplateActionType string
// TemplateActionType constants
const (
TemplateActionTypeURI TemplateActionType = "uri"
TemplateActionTypeMessage TemplateActionType = "message"
TemplateActionTypePostback TemplateActionType = "postback"
TemplateActionTypeDatetimePicker TemplateActionType = "datetimepicker"
)
// ImageAspectRatioType type
type ImageAspectRatioType string
// ImageAspectRatioType constants
const (
ImageAspectRatioTypeRectangle ImageAspectRatioType = "rectangle"
ImageAspectRatioTypeSquare ImageAspectRatioType = "square"
)
// ImageSizeType type
type ImageSizeType string
// ImageSizeType constants
const (
ImageSizeTypeCover ImageSizeType = "cover"
ImageSizeTypeContain ImageSizeType = "contain"
)
// Template interface
type Template interface {
json.Marshaler
Template()
}
// ButtonsTemplate type
type ButtonsTemplate struct {
ThumbnailImageURL string
ImageAspectRatio ImageAspectRatioType
ImageSize ImageSizeType
ImageBackgroundColor string
Title string
Text string
Actions []TemplateAction
}
// MarshalJSON method of ButtonsTemplate
func (t *ButtonsTemplate) MarshalJSON() ([]byte, error) {
return json.Marshal(&struct {
Type TemplateType `json:"type"`
ThumbnailImageURL string `json:"thumbnailImageUrl,omitempty"`
ImageAspectRatio ImageAspectRatioType `json:"imageAspectRatio,omitempty"`
ImageSize ImageSizeType `json:"imageSize,omitempty"`
ImageBackgroundColor string `json:"imageBackgroundColor,omitempty"`
Title string `json:"title,omitempty"`
Text string `json:"text"`
Actions []TemplateAction `json:"actions"`
}{
Type: TemplateTypeButtons,
ThumbnailImageURL: t.ThumbnailImageURL,
ImageAspectRatio: t.ImageAspectRatio,
ImageSize: t.ImageSize,
ImageBackgroundColor: t.ImageBackgroundColor,
Title: t.Title,
Text: t.Text,
Actions: t.Actions,
})
}
// WithImageOptions method, ButtonsTemplate can set imageAspectRatio, imageSize and imageBackgroundColor
func (t *ButtonsTemplate) WithImageOptions(imageAspectRatio ImageAspectRatioType, imageSize ImageSizeType, imageBackgroundColor string) *ButtonsTemplate {
t.ImageAspectRatio = imageAspectRatio
t.ImageSize = imageSize
t.ImageBackgroundColor = imageBackgroundColor
return t
}
// ConfirmTemplate type
type ConfirmTemplate struct {
Text string
Actions []TemplateAction
}
// MarshalJSON method of ConfirmTemplate
func (t *ConfirmTemplate) MarshalJSON() ([]byte, error) {
return json.Marshal(&struct {
Type TemplateType `json:"type"`
Text string `json:"text"`
Actions []TemplateAction `json:"actions"`
}{
Type: TemplateTypeConfirm,
Text: t.Text,
Actions: t.Actions,
})
}
// CarouselTemplate type
type CarouselTemplate struct {
Columns []*CarouselColumn
ImageAspectRatio ImageAspectRatioType
ImageSize ImageSizeType
}
// CarouselColumn type
type CarouselColumn struct {
ThumbnailImageURL string `json:"thumbnailImageUrl,omitempty"`
ImageBackgroundColor string `json:"imageBackgroundColor,omitempty"`
Title string `json:"title,omitempty"`
Text string `json:"text"`
Actions []TemplateAction `json:"actions"`
}
// MarshalJSON method of CarouselTemplate
func (t *CarouselTemplate) MarshalJSON() ([]byte, error) {
return json.Marshal(&struct {
Type TemplateType `json:"type"`
Columns []*CarouselColumn `json:"columns"`
ImageAspectRatio ImageAspectRatioType `json:"imageAspectRatio,omitempty"`
ImageSize ImageSizeType `json:"imageSize,omitempty"`
}{
Type: TemplateTypeCarousel,
Columns: t.Columns,
ImageAspectRatio: t.ImageAspectRatio,
ImageSize: t.ImageSize,
})
}
// WithImageOptions method, CarouselTemplate can set imageAspectRatio and imageSize
func (t *CarouselTemplate) WithImageOptions(imageAspectRatio ImageAspectRatioType, imageSize ImageSizeType) *CarouselTemplate {
t.ImageAspectRatio = imageAspectRatio
t.ImageSize = imageSize
return t
}
// WithImageOptions method, CarouselColumn can set imageBackgroundColor
func (t *CarouselColumn) WithImageOptions(imageBackgroundColor string) *CarouselColumn {
t.ImageBackgroundColor = imageBackgroundColor
return t
}
// ImageCarouselTemplate type
type ImageCarouselTemplate struct {
Columns []*ImageCarouselColumn
}
// ImageCarouselColumn type
type ImageCarouselColumn struct {
ImageURL string `json:"imageUrl"`
Action TemplateAction `json:"action"`
}
// MarshalJSON method of ImageCarouselTemplate
func (t *ImageCarouselTemplate) MarshalJSON() ([]byte, error) {
return json.Marshal(&struct {
Type TemplateType `json:"type"`
Columns []*ImageCarouselColumn `json:"columns"`
}{
Type: TemplateTypeImageCarousel,
Columns: t.Columns,
})
}
// Template implements Template interface
func (*ConfirmTemplate) Template() {}
// Template implements Template interface
func (*ButtonsTemplate) Template() {}
// Template implements Template interface
func (*CarouselTemplate) Template() {}
// Template implements Template interface
func (*ImageCarouselTemplate) Template() {}
// NewConfirmTemplate function
func NewConfirmTemplate(text string, left, right TemplateAction) *ConfirmTemplate {
return &ConfirmTemplate{
Text: text,
Actions: []TemplateAction{left, right},
}
}
// NewButtonsTemplate function
// `thumbnailImageURL` and `title` are optional. they can be empty.
func NewButtonsTemplate(thumbnailImageURL, title, text string, actions ...TemplateAction) *ButtonsTemplate {
return &ButtonsTemplate{
ThumbnailImageURL: thumbnailImageURL,
Title: title,
Text: text,
Actions: actions,
}
}
// NewCarouselTemplate function
func NewCarouselTemplate(columns ...*CarouselColumn) *CarouselTemplate {
return &CarouselTemplate{
Columns: columns,
}
}
// NewCarouselColumn function
// `thumbnailImageURL` and `title` are optional. they can be empty.
func NewCarouselColumn(thumbnailImageURL, title, text string, actions ...TemplateAction) *CarouselColumn {
return &CarouselColumn{
ThumbnailImageURL: thumbnailImageURL,
Title: title,
Text: text,
Actions: actions,
}
}
// NewImageCarouselTemplate function
func NewImageCarouselTemplate(columns ...*ImageCarouselColumn) *ImageCarouselTemplate {
return &ImageCarouselTemplate{
Columns: columns,
}
}
// NewImageCarouselColumn function
func NewImageCarouselColumn(imageURL string, action TemplateAction) *ImageCarouselColumn {
return &ImageCarouselColumn{
ImageURL: imageURL,
Action: action,
}
}
// TemplateAction interface
type TemplateAction interface {
json.Marshaler
TemplateAction()
}
// URITemplateAction type
type URITemplateAction struct {
Label string
URI string
}
// MarshalJSON method of URITemplateAction
func (a *URITemplateAction) MarshalJSON() ([]byte, error) {
return json.Marshal(&struct {
Type TemplateActionType `json:"type"`
Label string `json:"label,omitempty"`
URI string `json:"uri"`
}{
Type: TemplateActionTypeURI,
Label: a.Label,
URI: a.URI,
})
}
// MessageTemplateAction type
type MessageTemplateAction struct {
Label string
Text string
}
// MarshalJSON method of MessageTemplateAction
func (a *MessageTemplateAction) MarshalJSON() ([]byte, error) {
return json.Marshal(&struct {
Type TemplateActionType `json:"type"`
Label string `json:"label,omitempty"`
Text string `json:"text"`
}{
Type: TemplateActionTypeMessage,
Label: a.Label,
Text: a.Text,
})
}
// PostbackTemplateAction type
type PostbackTemplateAction struct {
Label string
Data string
Text string
DisplayText string
}
// MarshalJSON method of PostbackTemplateAction
func (a *PostbackTemplateAction) MarshalJSON() ([]byte, error) {
return json.Marshal(&struct {
Type TemplateActionType `json:"type"`
Label string `json:"label,omitempty"`
Data string `json:"data"`
Text string `json:"text,omitempty"`
DisplayText string `json:"displayText,omitempty"`
}{
Type: TemplateActionTypePostback,
Label: a.Label,
Data: a.Data,
Text: a.Text,
DisplayText: a.DisplayText,
})
}
// DatetimePickerTemplateAction type
type DatetimePickerTemplateAction struct {
Label string
Data string
Mode string
Initial string
Max string
Min string
}
// MarshalJSON method of DatetimePickerTemplateAction
func (a *DatetimePickerTemplateAction) MarshalJSON() ([]byte, error) {
return json.Marshal(&struct {
Type TemplateActionType `json:"type"`
Label string `json:"label,omitempty"`
Data string `json:"data"`
Mode string `json:"mode"`
Initial string `json:"initial,omitempty"`
Max string `json:"max,omitempty"`
Min string `json:"min,omitempty"`
}{
Type: TemplateActionTypeDatetimePicker,
Label: a.Label,
Data: a.Data,
Mode: a.Mode,
Initial: a.Initial,
Max: a.Max,
Min: a.Min,
})
}
// TemplateAction implements TemplateAction interface
func (*URITemplateAction) TemplateAction() {}
// TemplateAction implements TemplateAction interface
func (*MessageTemplateAction) TemplateAction() {}
// TemplateAction implements TemplateAction interface
func (*PostbackTemplateAction) TemplateAction() {}
// TemplateAction implements TemplateAction interface
func (*DatetimePickerTemplateAction) TemplateAction() {}
// NewURITemplateAction function
func NewURITemplateAction(label, uri string) *URITemplateAction {
return &URITemplateAction{
Label: label,
URI: uri,
}
}
// NewMessageTemplateAction function
func NewMessageTemplateAction(label, text string) *MessageTemplateAction {
return &MessageTemplateAction{
Label: label,
Text: text,
}
}
// NewPostbackTemplateAction function
func NewPostbackTemplateAction(label, data, text, displayText string) *PostbackTemplateAction {
return &PostbackTemplateAction{
Label: label,
Data: data,
Text: text,
DisplayText: displayText,
}
}
// NewDatetimePickerTemplateAction function
func NewDatetimePickerTemplateAction(label, data, mode, initial, max, min string) *DatetimePickerTemplateAction {
return &DatetimePickerTemplateAction{
Label: label,
Data: data,
Mode: mode,
Initial: initial,
Max: max,
Min: min,
}
}