@storyteq/platform-integration 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -61,6 +61,9 @@ createMediaPage
|
|
|
61
61
|
.on('created', (media) => {
|
|
62
62
|
console.log({ media });
|
|
63
63
|
});
|
|
64
|
+
.on('batch-created', (batch) => {
|
|
65
|
+
console.log({ batch });
|
|
66
|
+
});
|
|
64
67
|
```
|
|
65
68
|
|
|
66
69
|
### CRM Analytics page
|
|
@@ -92,6 +95,7 @@ const createMediaPage = new StoryteqPlatform.createMediaPage(
|
|
|
92
95
|
assetManagerScope: [], // Scope the asset selection to a set of asset providers
|
|
93
96
|
publish: [ {} ], // Upon rendering completion, publish to this channel
|
|
94
97
|
mediaRecreateHash: '11abcaaaa0abcdabcabcabca49abx321',
|
|
98
|
+
// creationType: 'batch', // if left empty, it will default to single media create form
|
|
95
99
|
ui: {
|
|
96
100
|
forceMediaPreviewBeforeCreate: 'always',
|
|
97
101
|
customizationItems: [
|
|
@@ -139,6 +143,9 @@ createMediaPage
|
|
|
139
143
|
.on('created', (media) => {
|
|
140
144
|
console.log({ media });
|
|
141
145
|
});
|
|
146
|
+
.on('batch-created', (batch) => {
|
|
147
|
+
console.log({ batch });
|
|
148
|
+
});
|
|
142
149
|
```
|
|
143
150
|
|
|
144
151
|
#### General configuration Attributes
|
|
@@ -147,6 +154,10 @@ createMediaPage
|
|
|
147
154
|
\
|
|
148
155
|
By setting the value of ```mediaRecreateHash``` to a media hash, all parameter values that was used to create this media will be directly applied in the media create form.
|
|
149
156
|
|
|
157
|
+
##### creationType
|
|
158
|
+
\
|
|
159
|
+
Optional parameter. Leaving it empty will result in spwaning the single media creation form. But by setting ```creationType``` to the string value ```batch```, you will instead spawn the batch creation form. This form allows you to create several media in one go.
|
|
160
|
+
|
|
150
161
|
#### UI Configuration Attributes
|
|
151
162
|
|
|
152
163
|
##### forceMediaPreviewBeforeCreate
|
|
@@ -168,20 +179,24 @@ Possible configurations:
|
|
|
168
179
|
|---------------------|------------------------------------------------------------------------------------------------|--------------------------------|
|
|
169
180
|
| host_product_name | Name of your company/product | Free text (string) |
|
|
170
181
|
| media_alias | Alias of media/creative | Free text (string) |
|
|
182
|
+
| media_alias_plural | Alias of media/creative in plural form | Free text (string) |
|
|
183
|
+
| batch_alias | Alias of batch | Free text (string) |
|
|
171
184
|
| button_media_create | Media create button custom description/text | Free text (string) |
|
|
172
|
-
| end_screen_title | Title of the screen indicating a media has been created/published
|
|
173
|
-
| end_screen_subtitle | Subtitle of the screen indicating a media has been created/published
|
|
185
|
+
| end_screen_title | Title of the screen indicating a media or media batch has been created/published | Free text (string) |
|
|
186
|
+
| end_screen_subtitle | Subtitle of the screen indicating a media or media batch has been created/published | Free text (string) |
|
|
174
187
|
| color_theme_hex | Color theme of UI elements such as buttons, loading bars, etc. | Hex code (string) |
|
|
175
188
|
| full_screen | Choice of having the create form cover the whole screen or not | true/false |
|
|
176
189
|
| cancelable | Shows a cancel button on the create media form that will event a 'canceled' event when pressed | true/false (defaults to false) |
|
|
190
|
+
| show_end_screen_for_batches | Showing end screen dialog after creating a batch | true/false (defaults to false) |
|
|
177
191
|
|
|
178
192
|
##### endScreenActions
|
|
179
193
|
\
|
|
180
194
|
```endScreenActions``` is an array of configuration objects that allows you to customize the UI of the 'end screen', by adding certain actions.
|
|
181
|
-
The end screen is what appears after you have initiated the creation/publishing of a media.
|
|
195
|
+
The end screen is what appears after you have initiated the creation/publishing of a media or media batch.
|
|
182
196
|
\
|
|
183
197
|
Possible configurations:
|
|
184
198
|
|
|
185
199
|
| Attribute/Action | Description | Option(s) |
|
|
186
200
|
|----------------------|----------------------------------------------------------------------------|-----------------------------------|
|
|
187
201
|
| create_another_media | By including this, a button will appear that allow you to recreate a media | Free text (string, inside button) |
|
|
202
|
+
| create_another_batch | By including this, a button will appear that allow you to recreate a batch | Free text (string, inside button) |
|