-
Notifications
You must be signed in to change notification settings - Fork 0
/
ChannelPreviewResult.ts
95 lines (86 loc) · 2.59 KB
/
ChannelPreviewResult.ts
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
import {FormResult, Intent} from './FormResult';
/**
* @hidden
*/
export interface ChannelPreviewResponse {
previews?: string[];
displayOptions?: PreviewDisplayOptions;
errors?: {[ref: string]: string[]};
toasts?: Array<{intent: Intent; message: string}>;
}
/**
* Options to control how previews are displayed.
*/
export interface PreviewDisplayOptions {
minWidth?: number;
minHeight?: number;
}
/**
* Result of {@link Channel.preview}. All previews must be a full HTML page. There must be exactly one preview per
* recipient, and they must be added to this result in the same order as the recipients were given to
* {@link Channel.preview}.
*/
export class ChannelPreviewResult extends FormResult {
private previews: string[];
private displayOptions?: PreviewDisplayOptions;
/**
* @param previews the complete set of HTML previews, if already known
*/
public constructor(previews?: string[]) {
super();
this.previews = previews || [];
}
/**
* Add a single HTML preview
* @param preview to add
*/
public addPreview(preview: string): this {
this.previews.push(preview);
return this;
}
/**
* Provide the complete set of HTML previews
* @param previews to provide
*/
public setPreviews(previews: string[]): this {
this.previews = previews;
return this;
}
/**
* Set options to control how the preview is displayed
* @param displayOptions to control the preview
*/
public setDisplayOptions(displayOptions: PreviewDisplayOptions): this {
this.displayOptions = displayOptions;
return this;
}
/**
* Add an error to display to the user for a particular form field
* @param form the type of content form that the error applies to (settings or template)
* @param section the section within the form that the error applies to
* @param field the field within the section that the error applies to
* @param error message to display to the user
*/
public addError(form: 'settings' | 'template', section: string, field: string, error: string): this {
return this.addErrorInternal(`${form}.${section}.${field}`, error);
}
/**
* @hidden
* Used internally to get the complete response
*/
public getResponse(): ChannelPreviewResponse {
if (
(!this.previews || this.previews.length === 0) &&
Object.keys(this.errors).length === 0 &&
this.toasts.length === 0
) {
this.addToast('danger', 'Failed to generate preview');
}
return {
previews: this.previews,
displayOptions: this.displayOptions,
errors: this.errors,
toasts: this.toasts
};
}
}