mirror of
https://github.com/cheveguerra/whatsapp-web.js.git
synced 2026-04-18 03:29:14 +00:00
251 lines
7.1 KiB
HTML
251 lines
7.1 KiB
HTML
<!doctype html>
|
|
<html>
|
|
|
|
<head>
|
|
<meta name="generator" content="JSDoc 3.6.7">
|
|
<meta charset="utf-8">
|
|
<title>whatsapp-web.js 1.15.8 » Source: structures/Contact.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>15.<wbr>8</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/Contact.js</h1>
|
|
</header>
|
|
<article>
|
|
<pre class="prettyprint linenums"><code>'use strict';
|
|
|
|
const Base = require('./Base');
|
|
|
|
/**
|
|
* ID that represents a contact
|
|
* @typedef {Object} ContactId
|
|
* @property {string} server
|
|
* @property {string} user
|
|
* @property {string} _serialized
|
|
*/
|
|
|
|
/**
|
|
* Represents a Contact on WhatsApp
|
|
* @extends {Base}
|
|
*/
|
|
class Contact extends Base {
|
|
constructor(client, data) {
|
|
super(client);
|
|
|
|
if(data) this._patch(data);
|
|
}
|
|
|
|
_patch(data) {
|
|
/**
|
|
* ID that represents the contact
|
|
* @type {ContactId}
|
|
*/
|
|
this.id = data.id;
|
|
|
|
/**
|
|
* Contact's phone number
|
|
* @type {string}
|
|
*/
|
|
this.number = data.userid;
|
|
|
|
/**
|
|
* Indicates if the contact is a business contact
|
|
* @type {boolean}
|
|
*/
|
|
this.isBusiness = data.isBusiness;
|
|
|
|
/**
|
|
* Indicates if the contact is an enterprise contact
|
|
* @type {boolean}
|
|
*/
|
|
this.isEnterprise = data.isEnterprise;
|
|
|
|
this.labels = data.labels;
|
|
|
|
/**
|
|
* The contact's name, as saved by the current user
|
|
* @type {?string}
|
|
*/
|
|
this.name = data.name;
|
|
|
|
/**
|
|
* The name that the contact has configured to be shown publically
|
|
* @type {string}
|
|
*/
|
|
this.pushname = data.pushname;
|
|
|
|
this.sectionHeader = data.sectionHeader;
|
|
|
|
/**
|
|
* A shortened version of name
|
|
* @type {?string}
|
|
*/
|
|
this.shortName = data.shortName;
|
|
|
|
this.statusMute = data.statusMute;
|
|
this.type = data.type;
|
|
this.verifiedLevel = data.verifiedLevel;
|
|
this.verifiedName = data.verifiedName;
|
|
|
|
/**
|
|
* Indicates if the contact is the current user's contact
|
|
* @type {boolean}
|
|
*/
|
|
this.isMe = data.isMe;
|
|
|
|
/**
|
|
* Indicates if the contact is a user contact
|
|
* @type {boolean}
|
|
*/
|
|
this.isUser = data.isUser;
|
|
|
|
/**
|
|
* Indicates if the contact is a group contact
|
|
* @type {boolean}
|
|
*/
|
|
this.isGroup = data.isGroup;
|
|
|
|
/**
|
|
* Indicates if the number is registered on WhatsApp
|
|
* @type {boolean}
|
|
*/
|
|
this.isWAContact = data.isWAContact;
|
|
|
|
/**
|
|
* Indicates if the number is saved in the current phone's contacts
|
|
* @type {boolean}
|
|
*/
|
|
this.isMyContact = data.isMyContact;
|
|
|
|
/**
|
|
* Indicates if you have blocked this contact
|
|
* @type {boolean}
|
|
*/
|
|
this.isBlocked = data.isBlocked;
|
|
|
|
return super._patch(data);
|
|
}
|
|
|
|
/**
|
|
* Returns the contact's profile picture URL, if privacy settings allow it
|
|
* @returns {Promise&lt;string>}
|
|
*/
|
|
async getProfilePicUrl() {
|
|
return await this.client.getProfilePicUrl(this.id._serialized);
|
|
}
|
|
|
|
/**
|
|
* Returns the contact's formatted phone number, (12345678901@c.us) => (+1 (234) 5678-901)
|
|
* @returns {Promise&lt;string>}
|
|
*/
|
|
async getFormattedNumber() {
|
|
return await this.client.getFormattedNumber(this.id._serialized);
|
|
}
|
|
|
|
/**
|
|
* Returns the contact's countrycode, (1541859685@c.us) => (1)
|
|
* @returns {Promise&lt;string>}
|
|
*/
|
|
async getCountryCode() {
|
|
return await this.client.getCountryCode(this.id._serialized);
|
|
}
|
|
|
|
/**
|
|
* Returns the Chat that corresponds to this Contact.
|
|
* Will return null when getting chat for currently logged in user.
|
|
* @returns {Promise&lt;Chat>}
|
|
*/
|
|
async getChat() {
|
|
if(this.isMe) return null;
|
|
|
|
return await this.client.getChatById(this.id._serialized);
|
|
}
|
|
|
|
/**
|
|
* Blocks this contact from WhatsApp
|
|
* @returns {Promise&lt;boolean>}
|
|
*/
|
|
async block() {
|
|
if(this.isGroup) return false;
|
|
|
|
await this.client.pupPage.evaluate(async (contactId) => {
|
|
const contact = window.Store.Contact.get(contactId);
|
|
await window.Store.BlockContact.blockContact(contact);
|
|
}, this.id._serialized);
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Unblocks this contact from WhatsApp
|
|
* @returns {Promise&lt;boolean>}
|
|
*/
|
|
async unblock() {
|
|
if(this.isGroup) return false;
|
|
|
|
await this.client.pupPage.evaluate(async (contactId) => {
|
|
const contact = window.Store.Contact.get(contactId);
|
|
await window.Store.BlockContact.unblockContact(contact);
|
|
}, this.id._serialized);
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Gets the Contact's current "about" info. Returns null if you don't have permission to read their status.
|
|
* @returns {Promise&lt;?string>}
|
|
*/
|
|
async getAbout() {
|
|
const about = await this.client.pupPage.evaluate(async (contactId) => {
|
|
return window.Store.Wap.statusFind(contactId);
|
|
}, this.id._serialized);
|
|
|
|
if (typeof about.status !== 'string')
|
|
return null;
|
|
|
|
return about.status;
|
|
}
|
|
|
|
}
|
|
|
|
module.exports = Contact;
|
|
</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 February 25, 2022.
|
|
</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> |