Key Category | Key | Type | Description |
---|---|---|---|
Root | JSON Object | ||
Root | JSON Object | ||
widgets | JSON Object | Specifies the list of widgets that are made available through the .
The possible values are:
1. | |
widgets | StringArray | Restricts access to specific User Roles supported in the . Possible values are:
1. | |
blocks | BooleanJSON Object | Determines whether the "Add Block" button shows up in Venue Editor for a LivePage. The possible values are:
1. false - (default value) - ie, everybody can Add new block
2. true - nobody has access to Add new block
3. JSON object specifying value for each user role. Eg: | |
blocks | StringArray | Specifies the list of blocks available to be added on a LivePage. The possible values are:
1. | |
blocksdefaultLivepages | JSON Object | JSON object listing predefined blocks along with default configuration. Read full specs at predefinedBlocks | |
predefinedBlocks | BooleanJSON Object | Determines whether a user is able to view and edit the "Block Settings" section (that consists of Width, Bounding Box, Height, etc...) in Venue Editor for a LivePage. The possible values are:
1. false - (default value) - ie, everybody can view and edit the settings
2. true - nobody can view and edit the settings
3. JSON object specifying value for each user role. Eg: | |
predefinedBlocks | BooleanJSON Object | Determines whether a user is able to change the type of Block in the Venue Editor for a LivePage. The possible values are: 1. false - (default value) - ie, everybody can change the type 2. true - nobody can change the type 3. JSON object specifying value for each user role. Eg: { "SPONSOR": true, "MANAGER": false } | |
predefinedBlocks | BooleanJSON Object | Determines whether a user is able to view and edit the settings of a Block in the Venue Editor for a LivePage. The possible values are: 1. false - (default value) - ie, everybody can view and edit the settings 2. true - nobody can view or edit the settings 3. JSON object specifying value for each user role. Eg: { "SPONSOR": true, "MANAGER": false } | |
predefinedBlocks | BooleanJSON Object | Determines whether a user is able to delete a block in the Venue Editor for a LivePage. The possible values are: 1. false - (default value) - ie, everybody can delete the block 2. true - nobody can delete the block 3. JSON object specifying value for each user role. Eg: { "SPONSOR": true, "MANAGER": false } | |
predefinedBlocks | String | Refers to "Type Name" as listed in Blocks | |
defaultLivepages | String | Title of LivePage | |
predefinedBlocks | JSON Object | JSON representation of a Block as defined at Blocks | |
defaultMenus | String | Name of the menu group | |
Root | String | Comma-separated list of features. Eg: Sticky menu, Live stream, Chat, Direct message, Participants list, Speakers and agenda, Content blocks, Notifications, Responsive template, Light and dark mode | |
Root | String | Comma-separated list of keywords. Eg: 1-Day, Multi-Track, Conference, Seminar, Meeting, Breakout | |
Root | String | Description. Limit to 250. | |
defaultLivepages | String | Unique slug for the LivePage. When instantiating the venue for a project, if the slug is already taken, it will be automatically suffixed with some additional characters to make it unique. | |
defaultLivepages | String | Title of LivePage | |
defaultLivepages | Boolean | Flag to determine whether the LivePage should be made public. | |
defaultLivepages | String | LivePage Template name as defined in the venue. | |
Root | JSON Object | ||
Root | JSON Object | ||
Root | String | Name of the author / company | |
Root | String | Version number to differentiate between releases. Recommended to use semantic versioning - ie MAJOR.MINOR.PATCH | |
defaultMenus | String | Name of the menu group | |
defaultMenus | Array | Array of JSON objects, where each object represents a menu item. The format of each menu item follows:
|