UiPreviewMessageTabDef

Represents the registration of a custom Marketing Cloud Preview and Test modal tab, created using custom Lightning web components. You can register and show multiple tabs in the Preview and Test experience.

This type extends Metadata and inherits its fields.

UiPreviewMessageTabDef components have the suffix .uiPreviewMessageTabDef and are stored in the uiPreviewMessageTabDef folder.

Introduced in API version 63.0.

There are no additional access requirements that are specific to this type.

• Type: boolean
• Required: Yes
• Description: Required.

• Type: boolean
• Required: No
• Description: Indicates whether the configuration is protected (true) or not (false).

• Type: string
• Required: Yes
• Description: Required.

• Type: string
• Required: Yes
• Description: Required.

• Type: SupportedChannel (enumeration of type string)

• Required: Yes

• Description: Required.

  A string indicating the type of channel.

  Values are:

• Possible values:

  • Email
  • Sms
  • WhatsApp

• Type: string

• Required: Yes

• Description: Required.

  The case-sensitive, user-defined label displayed as the name of the tab. Maximum length is 255 characters.

This example is a custom Lightning web component’s HTML file.

1<template>
2    <div>A custom tab</div>
3    <div>Preview data</div>
4    <div>{previewData}</div>
5</template>

Here’s the component’s JavaScript file.

1import { LightningElement, api } from "lwc";
2
3export default class CustomTab extends LightningElement {
4    @api previewData;
5}

Here’s the component’s configuration file.

1<?xml version="1.0" encoding="UTF-8"?>
2<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
3    <apiVersion>63.0</apiVersion>
4    <isExposed>true</isExposed>
5    <capabilities>
6        <capability>lightning__dynamicComponent</capability>
7    </capabilities>
8</LightningComponentBundle>

This example package.xml references the component’s definition.

1<?xml version="1.0" encoding="UTF-8"?>
2
3<UiPreviewMessageTabDef xmlns="http://soap.sforce.com/2006/04/metadata">
4    <isActive>true</isActive>
5    <label>TestUiPreviewMessageTab</label>
6    <lightningComponentDef>customTab</lightningComponentDef>
7    <supportedChannel>Email</supportedChannel>
8    <tabName>My Tab</tabName>
9    <isProtected>false</isProtected>
10</UiPreviewMessageTabDef>