Payload Definition
The payload definitions related to the Showroom library functions are as follows.
setInit
| Property | Type | Require | Description |
|---|---|---|---|
| partnerUniqueId | String | true | Partner ID |
setThemeUniqueId
| Property | Type | Require | Description |
|---|---|---|---|
| X | String | true | Theme ID |
setMemberToken
| Property | Type | Require | Description |
|---|---|---|---|
| X | String | true | JWT token passed when entering the live player |
setMemberObject
| Property | Type | Require | Description |
|---|---|---|---|
| age | String | true | Age, 10s: '10', 20s: '20', 30s: '30', ..., other: 'etc' |
| gender | 'e' || 'w' || 'm' | true | Gender., Male: 'm', Female: 'w', other: 'e' |
| memberId | String | true | User Identifier ID |
| nickname | String | true | Nickname |
load
| Property | Type | Require | Description |
|---|---|---|---|
| elementId | String | false | ID of the HTML element to display the showroom |
loadBanner
| Property | Type | Require | Description |
|---|---|---|---|
| bannerGroupId | String | true | Banner Group ID |
| elementId | String | false | ID of the HTML element to display the banner |
loadRecentLive
| Property | Type | Require | Description |
|---|---|---|---|
| elementId | String | false | ID of the HTML element to display recent live broadcasts |
loadScheduledLive
| Property | Type | Require | Description |
|---|---|---|---|
| elementId | String | false | ID of the HTML element to display upcoming live broadcasts |
loadLiveCalendar
| Property | Type | Require | Description |
|---|---|---|---|
| elementId | String | false | ID of the HTML element to display the live calendar |
loadVodCuration
| Property | Type | Require | Description |
|---|---|---|---|
| curationId | String | true | VOD curation ID |
| elementId | String | false | ID of the HTML element to display the VOD curation |
loadClipCuration
| Property | Type | Require | Description |
|---|---|---|---|
| curationId | String | true | CLIP curation ID |
| elementId | String | false | ID of the HTML element to display the CLIP curation |
Updated 5 months ago