mirror of
https://github.com/cheveguerra/whatsapp-web.js.git
synced 2026-04-18 11:39:14 +00:00
135 lines
4.4 KiB
HTML
135 lines
4.4 KiB
HTML
<!doctype html>
|
|
<html>
|
|
|
|
<head>
|
|
<meta name="generator" content="JSDoc 3.6.7">
|
|
<meta charset="utf-8">
|
|
<title>whatsapp-web.js 1.19.1 » Source: structures/Buttons.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>19.<wbr>1</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/Buttons.js</h1>
|
|
</header>
|
|
<article>
|
|
<pre class="prettyprint linenums"><code>'use strict';
|
|
|
|
const MessageMedia = require('./MessageMedia');
|
|
const Util = require('../util/Util');
|
|
|
|
/**
|
|
* Button spec used in Buttons constructor
|
|
* @typedef {Object} ButtonSpec
|
|
* @property {string=} id - Custom ID to set on the button. A random one will be generated if one is not passed.
|
|
* @property {string} body - The text to show on the button.
|
|
*/
|
|
|
|
/**
|
|
* @typedef {Object} FormattedButtonSpec
|
|
* @property {string} buttonId
|
|
* @property {number} type
|
|
* @property {Object} buttonText
|
|
*/
|
|
|
|
/**
|
|
* Message type buttons
|
|
*/
|
|
class Buttons {
|
|
/**
|
|
* @param {string|MessageMedia} body
|
|
* @param {ButtonSpec[]} buttons - See {@link ButtonSpec}
|
|
* @param {string?} title
|
|
* @param {string?} footer
|
|
*/
|
|
constructor(body, buttons, title, footer) {
|
|
/**
|
|
* Message body
|
|
* @type {string|MessageMedia}
|
|
*/
|
|
this.body = body;
|
|
|
|
/**
|
|
* title of message
|
|
* @type {string}
|
|
*/
|
|
this.title = title;
|
|
|
|
/**
|
|
* footer of message
|
|
* @type {string}
|
|
*/
|
|
this.footer = footer;
|
|
|
|
if (body instanceof MessageMedia) {
|
|
this.type = 'media';
|
|
this.title = '';
|
|
}else{
|
|
this.type = 'chat';
|
|
}
|
|
|
|
/**
|
|
* buttons of message
|
|
* @type {FormattedButtonSpec[]}
|
|
*/
|
|
this.buttons = this._format(buttons);
|
|
if(!this.buttons.length){ throw '[BT01] No buttons';}
|
|
|
|
}
|
|
|
|
/**
|
|
* Creates button array from simple array
|
|
* @param {ButtonSpec[]} buttons
|
|
* @returns {FormattedButtonSpec[]}
|
|
* @example
|
|
* Input: [{id:'customId',body:'button1'},{body:'button2'},{body:'button3'},{body:'button4'}]
|
|
* Returns: [{ buttonId:'customId',buttonText:{'displayText':'button1'},type: 1 },{buttonId:'n3XKsL',buttonText:{'displayText':'button2'},type:1},{buttonId:'NDJk0a',buttonText:{'displayText':'button3'},type:1}]
|
|
*/
|
|
_format(buttons){
|
|
buttons = buttons.slice(0,3); // phone users can only see 3 buttons, so lets limit this
|
|
return buttons.map((btn) => {
|
|
return {'buttonId':btn.id ? String(btn.id) : Util.generateHash(6),'buttonText':{'displayText':btn.body},'type':1};
|
|
});
|
|
}
|
|
|
|
}
|
|
|
|
module.exports = Buttons;</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.7 on January 15, 2023.
|
|
</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> |