whatsapp-web.js/docs/structures_List.js.html

<!doctype html>
<html>

<head>
  <meta name="generator" content="JSDoc 3.6.11">
  <meta charset="utf-8">
  <title>whatsapp-web.js 1.34.7 &raquo; Source: structures/List.js</title>
  <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Karla:400,400i,700,700i" type="text/css">
  <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Noto+Serif:400,400i,700,700i" type="text/css">
  <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
  <link href="css/baseline.css" rel="stylesheet">
</head>

<body onload="prettyPrint()">
  <nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
    <div id="jsdoc-navbar-container">
      <div id="jsdoc-navbar-content">
        <a href="index.html" class="jsdoc-navbar-package-name">whatsapp-web.<wbr>js 1.<wbr>34.<wbr>7</a>
      </div>
    </div>
  </nav>
  <div id="jsdoc-body-container">
    <div id="jsdoc-content">
      <div id="jsdoc-content-container">
        <div id="jsdoc-banner" role="banner">
        </div>
        <div id="jsdoc-main" role="main">
          <header class="page-header">
            <h1>Source: structures/List.js</h1>
          </header>
          <article>
            <pre class="prettyprint linenums"><code>&#x27;use strict&#x27;;

const Util &#x3D; require(&#x27;../util/Util&#x27;);

/**
 * Message type List
 */
class List {
    /**
     * @param {string} body
     * @param {string} buttonText
     * @param {Array&amp;lt;any&gt;} sections
     * @param {string?} title
     * @param {string?} footer
     */
    constructor(body, buttonText, sections, title, footer) {
        /**
         * Message body
         * @type {string}
         */
        this.description &#x3D; body;

        /**
         * List button text
         * @type {string}
         */
        this.buttonText &#x3D; buttonText;

        /**
         * title of message
         * @type {string}
         */
        this.title &#x3D; title;

        /**
         * footer of message
         * @type {string}
         */
        this.footer &#x3D; footer;

        /**
         * sections of message
         * @type {Array&amp;lt;any&gt;}
         */
        this.sections &#x3D; this._format(sections);
    }

    /**
     * Creates section array from simple array
     * @param {Array&amp;lt;any&gt;} sections
     * @returns {Array&amp;lt;any&gt;}
     * @example
     * Input: [{title:&#x27;sectionTitle&#x27;,rows:[{id:&#x27;customId&#x27;, title:&#x27;ListItem2&#x27;, description: &#x27;desc&#x27;},{title:&#x27;ListItem2&#x27;}]}}]
     * Returns: [{&#x27;title&#x27;:&#x27;sectionTitle&#x27;,&#x27;rows&#x27;:[{&#x27;rowId&#x27;:&#x27;customId&#x27;,&#x27;title&#x27;:&#x27;ListItem1&#x27;,&#x27;description&#x27;:&#x27;desc&#x27;},{&#x27;rowId&#x27;:&#x27;oGSRoD&#x27;,&#x27;title&#x27;:&#x27;ListItem2&#x27;,&#x27;description&#x27;:&#x27;&#x27;}]}]
     */
    _format(sections) {
        if (!sections.length) {
            throw &#x27;[LT02] List without sections&#x27;;
        }
        if (
            sections.length &gt; 1 &amp;amp;&amp;amp;
            sections.filter((s) &#x3D;&gt; typeof s.title &#x3D;&#x3D; &#x27;undefined&#x27;).length &gt; 1
        ) {
            throw &quot;[LT05] You can&#x27;t have more than one empty title.&quot;;
        }
        return sections.map((section) &#x3D;&gt; {
            if (!section.rows.length) {
                throw &#x27;[LT03] Section without rows&#x27;;
            }
            return {
                title: section.title ? section.title : undefined,
                rows: section.rows.map((row) &#x3D;&gt; {
                    if (!row.title) {
                        throw &#x27;[LT04] Row without title&#x27;;
                    }
                    return {
                        rowId: row.id ? row.id : Util.generateHash(6),
                        title: row.title,
                        description: row.description ? row.description : &#x27;&#x27;,
                    };
                }),
            };
        });
    }
}

module.exports &#x3D; List;
</code></pre>
          </article>
        </div>
      </div>
      <nav id="jsdoc-toc-nav" role="navigation"></nav>
    </div>
  </div>
  <footer id="jsdoc-footer" class="jsdoc-footer">
    <div id="jsdoc-footer-container">
      <p>
        Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> 3.6.11 on April 24, 2026.
      </p>
    </div>
  </footer>
  <script src="scripts/jquery.min.js"></script>
  <script src="scripts/tree.jquery.js"></script>
  <script src="scripts/prettify.js"></script>
  <script src="scripts/jsdoc-toc.js"></script>
  <script src="scripts/linenumber.js"></script>
  <script src="scripts/scrollanchor.js"></script>
</body>

</html>