From f34902dfdd28afde03b7904d6cc890ef486f8093 Mon Sep 17 00:00:00 2001 From: Pedro Lopez Date: Sun, 1 Mar 2020 15:00:15 -0400 Subject: [PATCH] chore: mark version v1.2.0 --- docs/._Contact.html | Bin 0 -> 4096 bytes docs/Base.html | 6 +- docs/BusinessContact.html | 6 +- docs/Chat.html | 116 ++++++++- docs/Client.html | 183 +++++++++++++- docs/Client.js.html | 83 ++++++- docs/ClientInfo.html | 6 +- docs/Contact.html | 6 +- docs/GroupChat.html | 119 ++++++++- docs/GroupNotification.html | 248 +++++++++++++++++++ docs/Location.html | 6 +- docs/Message.html | 6 +- docs/MessageMedia.html | 6 +- docs/PrivateChat.html | 121 ++++++++- docs/PrivateContact.html | 6 +- docs/Util.html | 6 +- docs/global.html | 192 ++++++++++++++- docs/index.html | 284 +++++++++++++++++++++- docs/scripts/jsdoc-toc.js | 2 +- docs/structures_Base.js.html | 6 +- docs/structures_BusinessContact.js.html | 6 +- docs/structures_Chat.js.html | 79 +++++- docs/structures_ClientInfo.js.html | 6 +- docs/structures_Contact.js.html | 6 +- docs/structures_GroupChat.js.html | 6 +- docs/structures_GroupNotification.js.html | 158 ++++++++++++ docs/structures_Location.js.html | 6 +- docs/structures_Message.js.html | 6 +- docs/structures_MessageMedia.js.html | 6 +- docs/structures_PrivateChat.js.html | 6 +- docs/structures_PrivateContact.js.html | 6 +- docs/util_Constants.js.html | 26 +- docs/util_Util.js.html | 6 +- package.json | 2 +- 34 files changed, 1609 insertions(+), 124 deletions(-) create mode 100644 docs/._Contact.html create mode 100644 docs/GroupNotification.html create mode 100644 docs/structures_GroupNotification.js.html diff --git a/docs/._Contact.html b/docs/._Contact.html new file mode 100644 index 0000000000000000000000000000000000000000..4a30fe9341250682fc2453816f26741bbaa562a5 GIT binary patch literal 4096 zcmeI#Jqp4=5C!0;M8qaoS%`!ITd}aU@&KZk6c!?^$p(XK5|Xv>DpnrBYj_RMU>{k3 z0t#X+%m>3V0}p1(MXgmw6&MSjCN9nC$;{9IFaYcmV0!xkR2=*?^1Rvba4sGR904>x zLKT$rwx4YKB2AU-E0OD6E`va5*`2y3V_A!(d3)K_Y{M91j4{R-V~l-eKAWcQ9B&=v sl*v5VWxk{^$u< - whatsapp-web.js 1.1.0 » Class: Base + whatsapp-web.js 1.2.0 » Class: Base @@ -15,7 +15,7 @@ @@ -50,7 +50,7 @@
diff --git a/docs/BusinessContact.html b/docs/BusinessContact.html index 1076acd..37173a0 100644 --- a/docs/BusinessContact.html +++ b/docs/BusinessContact.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.1.0 » Class: BusinessContact + whatsapp-web.js 1.2.0 » Class: BusinessContact @@ -15,7 +15,7 @@ @@ -227,7 +227,7 @@
diff --git a/docs/Chat.html b/docs/Chat.html index 03f9246..4ef84a4 100644 --- a/docs/Chat.html +++ b/docs/Chat.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.1.0 » Class: Chat + whatsapp-web.js 1.2.0 » Class: Chat @@ -15,7 +15,7 @@ @@ -26,7 +26,7 @@
class

Chat

-

Source: structures/Chat.js:10

+

Source: structures/Chat.js:11

Represents a Chat on WhatsApp

@@ -83,20 +83,35 @@
clearMessages()
+
clearState()
+
+
+
delete()
+
+
-
delete()
+
fetchMessages(searchOptions)
sendMessage(content, options)
+
sendSeen()
+
+
+
sendStateRecording()
+
+
+
sendStateTyping()
+
+
unarchive()
@@ -169,6 +184,11 @@
async
+

clearState()

+

Stops typing or recording in chat immediately.

+
+
+
async

delete() → Promise containing Boolean

Deletes the chat

@@ -179,6 +199,72 @@
async
+

fetchMessages(searchOptions) → Promise containing Array of Message

+

Loads chat messages, sorted from earliest to latest.

+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
+

searchOptions

+ 		+

Object

+ 		+

 

+ 		+

Options for searching messages. Right now only limit is supported.

+

Values in searchOptions have the following properties:

+ + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
+

limit

+ 		+

Number

+ 		+

Yes

+ 		+

The amount of messages to return. Note that the actual number of returned messages may be smaller if there aren't enough messages in the conversation. Set this to Infinity to load all messages.

+

Defaults to 50.

+
+
+
+
+
Returns
+
+

Promise containing Array of Message 

+
+
+
async

sendMessage(content, options) → Promise containing Message

Send a message to this chat

@@ -230,6 +316,26 @@
async
+

sendSeen() → Promise containing Boolean

+

Set the message as seen

+
+
Returns
+
+

Promise containing Boolean 

result

+

+
+
+
async
+

sendStateRecording()

+

Simulate recording audio in chat. This will last for 25 seconds.

+
+
+
async
+

sendStateTyping()

+

Simulate typing in chat. This will last for 25 seconds.

+
+
+
async

unarchive()

un-archives this chat

@@ -244,7 +350,7 @@
diff --git a/docs/Client.html b/docs/Client.html index 98b5413..ec7c208 100644 --- a/docs/Client.html +++ b/docs/Client.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.1.0 » Class: Client + whatsapp-web.js 1.2.0 » Class: Client @@ -15,7 +15,7 @@ @@ -51,13 +51,13 @@
getChatById(chatId)
+
getChats()
+
+
-
getChats()
-
-
getContactById(contactId)
@@ -67,14 +67,20 @@
getState()
+
initialize()
+
+
+
resetState()
+
+
-
initialize()
+
sendMessage(chatId, content, options)
-
sendMessage(chatId, content, options)
+
sendSeen(chatId)
setStatus(status)
@@ -104,10 +110,19 @@
disconnected
+
group_join
+
+
+
group_leave
+
+
+
group_update
+
+
message
@@ -117,13 +132,13 @@
message_create
-
message_revoke_everyone
-
-
+
message_revoke_everyone
+
+
message_revoke_me
@@ -149,9 +164,13 @@
Client#event:auth_failure
Client#event:ready
Client#event:message
+
Client#event:message_ack
Client#event:message_create
Client#event:message_revoke_me
Client#event:message_revoke_everyone
+
Client#event:group_join
+
Client#event:group_leave
+
Client#event:group_update
Client#event:disconnected
Client#event:change_state
@@ -314,6 +333,11 @@
async
+

resetState()

+

Force reset of connection state for the client

+
+
+
async

sendMessage(chatId, content, options) → Promise containing Message

Send a message to a specific chatId

@@ -378,6 +402,44 @@
async
+

sendSeen(chatId) → Promise containing boolean

+

Mark as seen for the Chat

+
+

Parameter

+ + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
+

chatId

+ 		+

string

+ 		+

 

+ 		+
+
+
+
Returns
+
+

Promise containing boolean 

result

+

+
+
+
async

setStatus(status)

Sets the current user's status message

@@ -554,6 +616,105 @@
+

group_join

+

Emitted when a user joins the chat via invite link or is added by an admin.

+
+

Parameter

+ + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
+

notification

+ 		+

GroupNotification

+ 		+

 

+ 		+

GroupNotification with more information about the action

+
+
+
+
+

group_leave

+

Emitted when a user leaves the chat or is removed by an admin.

+
+

Parameter

+ + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
+

notification

+ 		+

GroupNotification

+ 		+

 

+ 		+

GroupNotification with more information about the action

+
+
+
+
+

group_update

+

Emitted when group settings are updated, such as subject, description or picture.

+
+

Parameter

+ + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
+

notification

+ 		+

GroupNotification

+ 		+

 

+ 		+

GroupNotification with more information about the action

+
+
+
+

message

Emitted when a new message is received.

@@ -796,7 +957,7 @@
diff --git a/docs/Client.js.html b/docs/Client.js.html index 143188b..84afbec 100644 --- a/docs/Client.js.html +++ b/docs/Client.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.1.0 » Source: Client.js + whatsapp-web.js 1.2.0 » Source: Client.js @@ -15,7 +15,7 @@ @@ -41,11 +41,7 @@ const { WhatsWebURL, UserAgent, DefaultOptions, Events, WAState } = require const { ExposeStore, LoadUtils } = require('./util/Injected'); const ChatFactory = require('./factories/ChatFactory'); const ContactFactory = require('./factories/ContactFactory'); -const ClientInfo = require('./structures/ClientInfo'); -const Message = require('./structures/Message'); -const MessageMedia = require('./structures/MessageMedia'); -const Location = require('./structures/Location'); - +const { ClientInfo, Message, MessageMedia, Location, GroupNotification } = require('./structures'); /** * Starting point for interacting with the WhatsApp Web API * @extends {EventEmitter} @@ -54,9 +50,13 @@ const Location = require('./structures/Location'); * @fires Client#auth_failure * @fires Client#ready * @fires Client#message + * @fires Client#message_ack * @fires Client#message_create * @fires Client#message_revoke_me * @fires Client#message_revoke_everyone + * @fires Client#group_join + * @fires Client#group_leave + * @fires Client#group_update * @fires Client#disconnected * @fires Client#change_state */ @@ -180,6 +180,33 @@ class Client extends EventEmitter { await page.exposeFunction('onAddMessageEvent', msg => { if (!msg.isNewMsg) return; + if (msg.type === 'gp2') { + const notification = new GroupNotification(this, msg); + if (msg.subtype === 'add' || msg.subtype === 'invite') { + /** + * Emitted when a user joins the chat via invite link or is added by an admin. + * @event Client#group_join + * @param {GroupNotification} notification GroupNotification with more information about the action + */ + this.emit(Events.GROUP_JOIN, notification); + } else if (msg.subtype === 'remove' || msg.subtype === 'leave') { + /** + * Emitted when a user leaves the chat or is removed by an admin. + * @event Client#group_leave + * @param {GroupNotification} notification GroupNotification with more information about the action + */ + this.emit(Events.GROUP_LEAVE, notification); + } else { + /** + * Emitted when group settings are updated, such as subject, description or picture. + * @event Client#group_update + * @param {GroupNotification} notification GroupNotification with more information about the action + */ + this.emit(Events.GROUP_UPDATE, notification); + } + return; + } + const message = new Message(this, msg); /** @@ -305,7 +332,19 @@ class Client extends EventEmitter { async destroy() { await this.pupBrowser.close(); } + /** + * Mark as seen for the Chat + * @param {string} chatId + * @returns {Promise&lt;boolean>} result + * + */ + async sendSeen(chatId) { + const result = await this.pupPage.evaluate(async (chatId) => { + return window.WWebJS.sendSeen(chatId); + }, chatId); + return result; + } /** * Send a message to a specific chatId * @param {string} chatId @@ -319,6 +358,8 @@ class Client extends EventEmitter { quotedMessageId: options.quotedMessageId, mentionedJidList: Array.isArray(options.mentions) ? options.mentions.map(contact => contact.id._serialized) : [] }; + + const sendSeen = typeof options.sendSeen === 'undefined' ? true : options.sendSeen; if (content instanceof MessageMedia) { internalOptions.attachment = content; @@ -331,7 +372,7 @@ class Client extends EventEmitter { content = ''; } - const newMessage = await this.pupPage.evaluate(async (chatId, message, options) => { + const newMessage = await this.pupPage.evaluate(async (chatId, message, options, sendSeen) => { let chat = window.Store.Chat.get(chatId); let msg; if (!chat) { // The chat is not available in the previously chatted list @@ -341,16 +382,25 @@ class Client extends EventEmitter { //get the topmost chat object and assign the new chatId to it . //This is just a workaround.May cause problem if there are no chats at all. Need to dig in and emulate how whatsapp web does let chat = window.Store.Chat.models[0]; + if (!chat) + throw 'Chat List empty! Need at least one open conversation with any of your contact'; + let originalChatObjId = chat.id; chat.id = newChatId; + msg = await window.WWebJS.sendMessage(chat, message, options); chat.id = originalChatObjId; //replace the chat with its original id } } - else - msg = await window.WWebJS.sendMessage(chat, message, options); + else { + if(sendSeen) { + window.WWebJS.sendSeen(chatId); + } + + msg = await window.WWebJS.sendMessage(chat, message, options, sendSeen); + } return msg.serialize(); - }, chatId, content, internalOptions); + }, chatId, content, internalOptions, sendSeen); return new Message(this, newMessage); } @@ -461,6 +511,15 @@ class Client extends EventEmitter { }, chatId); } + /** + * Force reset of connection state for the client + */ + async resetState(){ + await this.pupPage.evaluate(() => { + window.Store.AppState.phoneWatchdog.shiftTimer.forceRunNow(); + }); + } + } module.exports = Client; @@ -474,7 +533,7 @@ module.exports = Client;
diff --git a/docs/ClientInfo.html b/docs/ClientInfo.html index be5f90a..b9ab5ed 100644 --- a/docs/ClientInfo.html +++ b/docs/ClientInfo.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.1.0 » Class: ClientInfo + whatsapp-web.js 1.2.0 » Class: ClientInfo @@ -15,7 +15,7 @@ @@ -187,7 +187,7 @@
diff --git a/docs/Contact.html b/docs/Contact.html index 4cca527..22e6a21 100644 --- a/docs/Contact.html +++ b/docs/Contact.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.1.0 » Class: Contact + whatsapp-web.js 1.2.0 » Class: Contact @@ -15,7 +15,7 @@ @@ -196,7 +196,7 @@
diff --git a/docs/GroupChat.html b/docs/GroupChat.html index d248290..7a0278a 100644 --- a/docs/GroupChat.html +++ b/docs/GroupChat.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.1.0 » Class: GroupChat + whatsapp-web.js 1.2.0 » Class: GroupChat @@ -15,7 +15,7 @@ @@ -104,6 +104,9 @@
clearMessages()
+
clearState()
+
+
delete()
@@ -114,6 +117,9 @@
demoteParticipants(participantIds)
+
fetchMessages(searchOptions)
+
+
getInviteCode()
@@ -136,6 +142,15 @@
sendMessage(content, options)
+
sendSeen()
+
+
+
sendStateRecording()
+
+
+
sendStateTyping()
+
+
setDescription(description)
@@ -354,6 +369,13 @@
async
+

clearState()

+

Stops typing or recording in chat immediately.

+
+
Inherited from
+
Chat#clearState
+
+
async

delete() → Promise containing Boolean

Deletes the chat

@@ -398,6 +420,72 @@
async
+

fetchMessages(searchOptions) → Promise containing Array of Message

+

Loads chat messages, sorted from earliest to latest.

+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
+

searchOptions

+ 		+

 

+ 		+

 

+ 		+

Options for searching messages. Right now only limit is supported.

+

Values in searchOptions have the following properties:

+ + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
+

limit

+ 		+

 

+ 		+

Yes

+ 		+

The amount of messages to return. Note that the actual number of returned messages may be smaller if there aren't enough messages in the conversation. Set this to Infinity to load all messages.

+

Defaults to 50.

+
+
+
+
+
Inherited from
+
Chat#fetchMessages
+
Returns
+
+
+
async

getInviteCode()

Gets the invite code for a specific group

@@ -531,6 +619,31 @@
async
+

sendSeen() → Promise containing Boolean

+

Set the message as seen

+
+
Inherited from
+
Chat#sendSeen
+
Returns
+
+

result

+
+
+
async
+

sendStateRecording()

+

Simulate recording audio in chat. This will last for 25 seconds.

+
+
Inherited from
+
Chat#sendStateRecording
+
+
async
+

sendStateTyping()

+

Simulate typing in chat. This will last for 25 seconds.

+
+
Inherited from
+
Chat#sendStateTyping
+
+
async

setDescription(description)

Updates the group description

@@ -613,7 +726,7 @@
diff --git a/docs/GroupNotification.html b/docs/GroupNotification.html new file mode 100644 index 0000000..12e679d --- /dev/null +++ b/docs/GroupNotification.html @@ -0,0 +1,248 @@ + + + + + + + whatsapp-web.js 1.2.0 » Class: GroupNotification + + + + + + + + +
+
+
+
+
+
class
+

GroupNotification

+

Source: structures/GroupNotification.js:10

+
+

Represents a GroupNotification on WhatsApp

+
+
+
+
+
+
+

Properties

+
+
+
+
author
+
+
+
body
+
+
+
chatId
+
+
+
+
+
+
+
id
+
+
+
recipientIds
+
+
+
timestamp
+
+
+
+
+
+
+
type
+
+
+
+
+
+
+
+

Methods

+
+
+
+
getChat()
+
+
+
getContact()
+
+
+
+
+
+
+
getRecipients()
+
+
+
reply(content, options)
+
+
+
+
+
+
+
+
+
+
+

new GroupNotification()

+
+
Extends
+
Base
+
+
+
+

Properties

+
+

author +  string

+

ContactId for the user that produced the GroupNotification.

+
+
+

body +  string

+

Extra content

+
+
+

chatId +  string

+

ID for the Chat that this groupNotification was sent for.

+
+
+

id +  object

+

ID that represents the groupNotification

+
+
+

recipientIds +  Array of string

+

Contact IDs for the users that were affected by this GroupNotification.

+
+
+

timestamp +  number

+

Unix timestamp for when the groupNotification was created

+
+
+

type +  GroupNotificationTypes

+

GroupNotification type

+
+
+
+

Methods

+
+

getChat() → Promise containing Chat

+

Returns the Chat this groupNotification was sent in

+
+
Returns
+
+

Promise containing Chat 

+
+
+

getContact() → Promise containing Contact

+

Returns the Contact this GroupNotification was produced by

+
+
Returns
+
+

Promise containing Contact 

+
+
+
async
+

getRecipients() → Promise containing Array of Contact

+

Returns the Contacts affected by this GroupNotification.

+
+
Returns
+
+

Promise containing Array of Contact 

+
+
+
async
+

reply(content, options) → Promise containing Message

+

Sends a message to the same chat this GroupNotification was produced in.

+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
+

content

+ 		+

(string, MessageMedia, or Location)

+ 		+

 

+ 		+
+

options

+ 		+

object

+ 		+

 

+ 		+
+
+
+
Returns
+
+

Promise containing Message 

+
+
+
+
+
+
+ +
+
+
+ +
+ + + + + + + + + \ No newline at end of file diff --git a/docs/Location.html b/docs/Location.html index b4131ba..7258f94 100644 --- a/docs/Location.html +++ b/docs/Location.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.1.0 » Class: Location + whatsapp-web.js 1.2.0 » Class: Location @@ -15,7 +15,7 @@ @@ -149,7 +149,7 @@
diff --git a/docs/Message.html b/docs/Message.html index 47d4259..4a69d10 100644 --- a/docs/Message.html +++ b/docs/Message.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.1.0 » Class: Message + whatsapp-web.js 1.2.0 » Class: Message @@ -15,7 +15,7 @@ @@ -371,7 +371,7 @@
diff --git a/docs/MessageMedia.html b/docs/MessageMedia.html index af2551f..ce80045 100644 --- a/docs/MessageMedia.html +++ b/docs/MessageMedia.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.1.0 » Class: MessageMedia + whatsapp-web.js 1.2.0 » Class: MessageMedia @@ -15,7 +15,7 @@ @@ -152,7 +152,7 @@
diff --git a/docs/PrivateChat.html b/docs/PrivateChat.html index f203b91..a724d87 100644 --- a/docs/PrivateChat.html +++ b/docs/PrivateChat.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.1.0 » Class: PrivateChat + whatsapp-web.js 1.2.0 » Class: PrivateChat @@ -15,7 +15,7 @@ @@ -83,20 +83,35 @@
clearMessages()
+
clearState()
+
+
+
delete()
+
+
-
delete()
+
fetchMessages(searchOptions)
sendMessage(content, options)
+
sendSeen()
+
+
+
sendStateRecording()
+
+
+
sendStateTyping()
+
+
unarchive()
@@ -186,6 +201,13 @@
async
+

clearState()

+

Stops typing or recording in chat immediately.

+
+
Inherited from
+
Chat#clearState
+
+
async

delete() → Promise containing Boolean

Deletes the chat

@@ -197,6 +219,72 @@
async
+

fetchMessages(searchOptions) → Promise containing Array of Message

+

Loads chat messages, sorted from earliest to latest.

+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
+

searchOptions

+ 		+

 

+ 		+

 

+ 		+

Options for searching messages. Right now only limit is supported.

+

Values in searchOptions have the following properties:

+ + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
+

limit

+ 		+

 

+ 		+

Yes

+ 		+

The amount of messages to return. Note that the actual number of returned messages may be smaller if there aren't enough messages in the conversation. Set this to Infinity to load all messages.

+

Defaults to 50.

+
+
+
+
+
Inherited from
+
Chat#fetchMessages
+
Returns
+
+
+
async

sendMessage(content, options) → Promise containing Message

Send a message to this chat

@@ -249,6 +337,31 @@
async
+

sendSeen() → Promise containing Boolean

+

Set the message as seen

+
+
Inherited from
+
Chat#sendSeen
+
Returns
+
+

result

+
+
+
async
+

sendStateRecording()

+

Simulate recording audio in chat. This will last for 25 seconds.

+
+
Inherited from
+
Chat#sendStateRecording
+
+
async
+

sendStateTyping()

+

Simulate typing in chat. This will last for 25 seconds.

+
+
Inherited from
+
Chat#sendStateTyping
+
+
async

unarchive()

un-archives this chat

@@ -265,7 +378,7 @@
diff --git a/docs/PrivateContact.html b/docs/PrivateContact.html index 3e1a74a..b291e94 100644 --- a/docs/PrivateContact.html +++ b/docs/PrivateContact.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.1.0 » Class: PrivateContact + whatsapp-web.js 1.2.0 » Class: PrivateContact @@ -15,7 +15,7 @@ @@ -220,7 +220,7 @@
diff --git a/docs/Util.html b/docs/Util.html index e20adb1..65bb6e8 100644 --- a/docs/Util.html +++ b/docs/Util.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.1.0 » Class: Util + whatsapp-web.js 1.2.0 » Class: Util @@ -15,7 +15,7 @@ @@ -50,7 +50,7 @@
diff --git a/docs/global.html b/docs/global.html index 054717d..24562e4 100644 --- a/docs/global.html +++ b/docs/global.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.1.0 » Globals + whatsapp-web.js 1.2.0 » Globals @@ -15,7 +15,7 @@ @@ -36,6 +36,9 @@
Events
+
GroupNotificationTypes
+
+
@@ -46,13 +49,13 @@
MessageTypes
+
Status
+
+
-
Status
-
-
WAState
@@ -244,6 +247,45 @@ + + +

GROUP_JOIN

+ + +

 

+ + +

 

+ + + + + + +

GROUP_LEAVE

+ + +

 

+ + +

 

+ + + + + + +

GROUP_UPDATE

+ + +

 

+ + +

 

+ + + +

QR_RECEIVED

@@ -289,6 +331,144 @@
read-only
+

GroupNotificationTypes +  string

+

Group notification types

+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
+

ADD

+ 		+

 

+ 		+

 

+ 		+
+

INVITE

+ 		+

 

+ 		+

 

+ 		+
+

REMOVE

+ 		+

 

+ 		+

 

+ 		+
+

LEAVE

+ 		+

 

+ 		+

 

+ 		+
+

SUBJECT

+ 		+

 

+ 		+

 

+ 		+
+

DESCRIPTION

+ 		+

 

+ 		+

 

+ 		+
+

PICTURE

+ 		+

 

+ 		+

 

+ 		+
+

ANNOUNCE

+ 		+

 

+ 		+

 

+ 		+
+

RESTRICT

+ 		+

 

+ 		+

 

+ 		+
+
+
+
+
read-only

MessageAck  number

Message ACK

@@ -811,7 +991,7 @@
diff --git a/docs/index.html b/docs/index.html index 196bda4..ac6dead 100644 --- a/docs/index.html +++ b/docs/index.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.1.0 » Home + whatsapp-web.js 1.2.0 » Home @@ -15,7 +15,7 @@ @@ -27,7 +27,7 @@

- whatsapp-web.js 1.1.0 + whatsapp-web.js 1.2.0

+
+ Chat#fetchMessages(searchOptions) +
+
+
Chat#id
@@ -344,6 +354,21 @@ client.initialize();
+
+ Chat#sendSeen() +
+
+
+
+ Chat#sendStateRecording() +
+
+
+
+ Chat#sendStateTyping() +
+
+
Chat#timestamp
@@ -444,10 +469,25 @@ client.initialize();
+
+ Client#event:group_join +
+
+
+
+ Client#event:group_leave +
+
+
+
+ Client#event:group_update +
+
+
Client#event:message
@@ -488,15 +528,15 @@ client.initialize();
-
-
-
-
Client#getChats()
+
+
+
+
Client#getContactById(contactId)
@@ -517,11 +557,21 @@ client.initialize();
+
+ Client#resetState() +
+
+
Client#sendMessage(chatId, content, options)
+
+ Client#sendSeen(chatId) +
+
+
Client#setStatus(status)
@@ -692,7 +742,12 @@ client.initialize();
- Events.MESSAGE_ACK + Events.GROUP_JOIN +
+
+
+
+ Events.GROUP_LEAVE
@@ -700,6 +755,16 @@ client.initialize();
+
+ Events.GROUP_UPDATE +
+
+
+
+ Events.MESSAGE_ACK +
+
+
Events.MESSAGE_CREATE
@@ -715,15 +780,15 @@ client.initialize();
+
+
+
+
Events.MESSAGE_REVOKED_ME
-
-
-
-
Events.QR_RECEIVED
@@ -785,6 +850,11 @@ client.initialize();
+
+ GroupChat#clearState() +
+
+
GroupChat#createdAt
@@ -809,6 +879,11 @@ client.initialize();
+
+ GroupChat#fetchMessages(searchOptions) +
+
+
GroupChat#getInviteCode()
@@ -873,6 +948,21 @@ client.initialize();
+
+ GroupChat#sendSeen() +
+
+
+
+ GroupChat#sendStateRecording() +
+
+
+
+ GroupChat#sendStateTyping() +
+
+
GroupChat#setDescription(description)
@@ -903,6 +993,149 @@ client.initialize();
+
+
+

GroupNotification

+
+
+
+
+ GroupNotification() +
+
+
+
+ GroupNotification#author +
+
+
+
+ GroupNotification#body +
+
+
+
+ GroupNotification#chatId +
+
+
+
+
+
+
+
+ GroupNotification#getChat() +
+
+
+
+ GroupNotification#getContact() +
+
+
+
+ GroupNotification#getRecipients() +
+
+
+
+ GroupNotification#id +
+
+
+
+
+
+
+
+ GroupNotification#recipientIds +
+
+
+
+ GroupNotification#reply(content, options) +
+
+
+
+ GroupNotification#timestamp +
+
+
+
+ GroupNotification#type +
+
+
+
+
+
+
+
+
+
+

GroupNotificationTypes

+
+
+
+
+ GroupNotificationTypes.ADD +
+
+
+
+ GroupNotificationTypes.ANNOUNCE +
+
+
+
+ GroupNotificationTypes.DESCRIPTION +
+
+
+
+
+
+
+
+ GroupNotificationTypes.INVITE +
+
+
+
+ GroupNotificationTypes.LEAVE +
+
+
+
+ GroupNotificationTypes.PICTURE +
+
+
+
+
+
+
+
+ GroupNotificationTypes.REMOVE +
+
+
+
+ GroupNotificationTypes.RESTRICT +
+
+
+
+ GroupNotificationTypes.SUBJECT +
+
+
+
+
+
+
+

Location

@@ -1264,6 +1497,11 @@ client.initialize();
+
+ PrivateChat#clearState() +
+
+
PrivateChat#delete()
@@ -1273,6 +1511,11 @@ client.initialize();
+
+ PrivateChat#fetchMessages(searchOptions) +
+
+
PrivateChat#id
@@ -1302,6 +1545,21 @@ client.initialize();
+
+ PrivateChat#sendSeen() +
+
+
+
+ PrivateChat#sendStateRecording() +
+
+
+
+ PrivateChat#sendStateTyping() +
+
+
PrivateChat#timestamp
@@ -1557,7 +1815,7 @@ client.initialize();
diff --git a/docs/scripts/jsdoc-toc.js b/docs/scripts/jsdoc-toc.js index 3ad0a65..02c2838 100644 --- a/docs/scripts/jsdoc-toc.js +++ b/docs/scripts/jsdoc-toc.js @@ -6,7 +6,7 @@ treeNode.tree({ autoEscape: false, closedIcon: '⇢', - data: [{"label":"Globals","id":"global","children":[]},{"label":"Base","id":"Base","children":[]},{"label":"BusinessContact","id":"BusinessContact","children":[]},{"label":"Chat","id":"Chat","children":[]},{"label":"Client","id":"Client","children":[]},{"label":"ClientInfo","id":"ClientInfo","children":[]},{"label":"Contact","id":"Contact","children":[]},{"label":"GroupChat","id":"GroupChat","children":[]},{"label":"Location","id":"Location","children":[]},{"label":"Message","id":"Message","children":[]},{"label":"MessageMedia","id":"MessageMedia","children":[]},{"label":"PrivateChat","id":"PrivateChat","children":[]},{"label":"PrivateContact","id":"PrivateContact","children":[]},{"label":"Util","id":"Util","children":[]}], + data: [{"label":"Globals","id":"global","children":[]},{"label":"Base","id":"Base","children":[]},{"label":"BusinessContact","id":"BusinessContact","children":[]},{"label":"Chat","id":"Chat","children":[]},{"label":"Client","id":"Client","children":[]},{"label":"ClientInfo","id":"ClientInfo","children":[]},{"label":"Contact","id":"Contact","children":[]},{"label":"GroupChat","id":"GroupChat","children":[]},{"label":"GroupNotification","id":"GroupNotification","children":[]},{"label":"Location","id":"Location","children":[]},{"label":"Message","id":"Message","children":[]},{"label":"MessageMedia","id":"MessageMedia","children":[]},{"label":"PrivateChat","id":"PrivateChat","children":[]},{"label":"PrivateContact","id":"PrivateContact","children":[]},{"label":"Util","id":"Util","children":[]}], openedIcon: ' ⇣', saveState: false, useContextMenu: false diff --git a/docs/structures_Base.js.html b/docs/structures_Base.js.html index 455b708..568476a 100644 --- a/docs/structures_Base.js.html +++ b/docs/structures_Base.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.1.0 » Source: structures/Base.js + whatsapp-web.js 1.2.0 » Source: structures/Base.js @@ -15,7 +15,7 @@ @@ -60,7 +60,7 @@ module.exports = Base;
diff --git a/docs/structures_BusinessContact.js.html b/docs/structures_BusinessContact.js.html index 6369b3c..109ac3a 100644 --- a/docs/structures_BusinessContact.js.html +++ b/docs/structures_BusinessContact.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.1.0 » Source: structures/BusinessContact.js + whatsapp-web.js 1.2.0 » Source: structures/BusinessContact.js @@ -15,7 +15,7 @@ @@ -59,7 +59,7 @@ module.exports = BusinessContact;
diff --git a/docs/structures_Chat.js.html b/docs/structures_Chat.js.html index 7c9a9fe..8cdcdca 100644 --- a/docs/structures_Chat.js.html +++ b/docs/structures_Chat.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.1.0 » Source: structures/Chat.js + whatsapp-web.js 1.2.0 » Source: structures/Chat.js @@ -15,7 +15,7 @@ @@ -32,6 +32,7 @@ 
'use strict';
 
 const Base = require('./Base');
+const Message = require('./Message');
 
 /**
  * Represents a Chat on WhatsApp
@@ -41,7 +42,7 @@ class Chat extends Base {
     constructor(client, data) {
         super(client);
 
-        if(data) this._patch(data);
+        if (data) this._patch(data);
     }
 
     _patch(data) {
@@ -100,6 +101,14 @@ class Chat extends Base {
         return this.client.sendMessage(this.id._serialized, content, options);
     }
 
+    /**
+     * Set the message as seen
+     * @returns {Promise&lt;Boolean>} result
+     */
+    async sendSeen() {
+        return this.client.sendSeen(this.id._serialized);
+    }
+
     /**
      * Clears all messages from the chat
      * @returns {Promise&lt;Boolean>} result
@@ -133,10 +142,70 @@ class Chat extends Base {
     async unarchive() {
         return this.client.unarchiveChat(this.id._serialized);
     }
+
+    /**
+     * Loads chat messages, sorted from earliest to latest.
+     * @param {Object} searchOptions Options for searching messages. Right now only limit is supported.
+     * @param {Number} [searchOptions.limit=50] The amount of messages to return. Note that the actual number of returned messages may be smaller if there aren't enough messages in the conversation. Set this to Infinity to load all messages.
+     * @returns {Promise&lt;Array&lt;Message>>}
+     */
+    async fetchMessages(searchOptions) {
+        if(!searchOptions || !searchOptions.limit) {
+            searchOptions = {limit: 50};
+        }
+        let messages = await this.client.pupPage.evaluate(async (chatId, limit) => {
+            const msgFilter = m => !m.isNotification; // dont include notification messages
+            
+            const chat = window.Store.Chat.get(chatId);
+            let msgs = chat.msgs.models.filter(msgFilter);
+            
+            while(msgs.length &lt; limit) {
+                const loadedMessages = await chat.loadEarlierMsgs();
+                if(!loadedMessages) break;
+                msgs = [...msgs, ...loadedMessages.filter(msgFilter)];
+            }
+
+            return msgs.splice(0, limit).map(m => m.serialize());
+
+        }, this.id._serialized, searchOptions.limit);
+
+        messages.sort((a, b) => (a.t > b.t) ? 1 : -1);
+        return messages.map(m => new Message(this.client, m));
+    }
+   
+    /**
+     * Simulate typing in chat. This will last for 25 seconds.
+     */
+    async sendStateTyping() {
+        return this.client.pupPage.evaluate(chatId => {
+            window.WWebJS.sendChatstate('typing', chatId);
+            return true;
+        }, this.id._serialized);
+    }
     
+    /**
+     * Simulate recording audio in chat. This will last for 25 seconds.
+     */
+    async sendStateRecording() {
+        return this.client.pupPage.evaluate(chatId => {
+            window.WWebJS.sendChatstate('recording', chatId);
+            return true;
+        }, this.id._serialized);
+    }
+
+    /**
+     * Stops typing or recording in chat immediately.
+     */
+    async clearState() {
+        return this.client.pupPage.evaluate(chatId => {
+            window.WWebJS.sendChatstate('stop', chatId);
+            return true;
+        }, this.id._serialized);
+    }
 }
 
-module.exports = Chat;
+module.exports = Chat; +
@@ -146,7 +215,7 @@ module.exports = Chat;
diff --git a/docs/structures_ClientInfo.js.html b/docs/structures_ClientInfo.js.html index 09583a9..b9ebef0 100644 --- a/docs/structures_ClientInfo.js.html +++ b/docs/structures_ClientInfo.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.1.0 » Source: structures/ClientInfo.js + whatsapp-web.js 1.2.0 » Source: structures/ClientInfo.js @@ -15,7 +15,7 @@ @@ -89,7 +89,7 @@ module.exports = ClientInfo;
diff --git a/docs/structures_Contact.js.html b/docs/structures_Contact.js.html index 6e25d2a..77e4548 100644 --- a/docs/structures_Contact.js.html +++ b/docs/structures_Contact.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.1.0 » Source: structures/Contact.js + whatsapp-web.js 1.2.0 » Source: structures/Contact.js @@ -15,7 +15,7 @@ @@ -153,7 +153,7 @@ module.exports = Contact;
diff --git a/docs/structures_GroupChat.js.html b/docs/structures_GroupChat.js.html index 36d439c..6b4dc55 100644 --- a/docs/structures_GroupChat.js.html +++ b/docs/structures_GroupChat.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.1.0 » Source: structures/GroupChat.js + whatsapp-web.js 1.2.0 » Source: structures/GroupChat.js @@ -15,7 +15,7 @@ @@ -209,7 +209,7 @@ module.exports = GroupChat;
diff --git a/docs/structures_GroupNotification.js.html b/docs/structures_GroupNotification.js.html new file mode 100644 index 0000000..3582ee4 --- /dev/null +++ b/docs/structures_GroupNotification.js.html @@ -0,0 +1,158 @@ + + + + + + + whatsapp-web.js 1.2.0 » Source: structures/GroupNotification.js + + + + + + + + +
+
+
+ +
+
+

Source: structures/GroupNotification.js

+
+
+ 
'use strict';
+
+const Base = require('./Base');
+
+/**
+ * Represents a GroupNotification on WhatsApp
+ * @extends {Base}
+ */
+class GroupNotification extends Base {
+    constructor(client, data) {
+        super(client);
+
+        if(data) this._patch(data);
+    }
+
+    _patch(data) {
+        /**
+         * ID that represents the groupNotification
+         * @type {object}
+         */
+        this.id = data.id;
+
+        /**
+         * Extra content
+         * @type {string}
+         */
+        this.body = data.body || '';
+
+        /** 
+         * GroupNotification type
+         * @type {GroupNotificationTypes}
+         */
+        this.type = data.subtype;
+        
+        /**
+         * Unix timestamp for when the groupNotification was created
+         * @type {number}
+         */
+        this.timestamp = data.t;
+
+        /**
+         * ID for the Chat that this groupNotification was sent for.
+         * 
+         * @type {string}
+         */
+        this.chatId = typeof (data.to) === 'object' ? data.to._serialized : data.to;
+
+        /**
+         * ContactId for the user that produced the GroupNotification.
+         * @type {string}
+         */
+        this.author = typeof (data.author) === 'object' ? data.author._serialized : data.author;
+        
+        /**
+         * Contact IDs for the users that were affected by this GroupNotification.
+         * @type {Array&lt;string>}
+         */
+        this.recipientIds = [];
+
+        if (data.recipients) {
+            this.recipientIds = data.recipients;
+        }
+
+        return super._patch(data);
+    }
+
+    /**
+     * Returns the Chat this groupNotification was sent in
+     * @returns {Promise&lt;Chat>}
+     */
+    getChat() {
+        return this.client.getChatById(this.chatId);
+    }
+
+    /**
+     * Returns the Contact this GroupNotification was produced by
+     * @returns {Promise&lt;Contact>}
+     */
+    getContact() {
+        return this.client.getContactById(this.author);
+    }
+
+    /**
+     * Returns the Contacts affected by this GroupNotification.
+     * @returns {Promise&lt;Array&lt;Contact>>}
+     */
+    async getRecipients() {
+        return await Promise.all(this.recipientIds.map(async m => await this.client.getContactById(m)));
+    }
+
+    /**
+     * Sends a message to the same chat this GroupNotification was produced in.
+     * 
+     * @param {string|MessageMedia|Location} content 
+     * @param {object} options
+     * @returns {Promise&lt;Message>}
+     */
+    async reply(content, options={}) {
+        return this.client.sendMessage(this.chatId, content, options);
+    }
+    
+}
+
+module.exports = GroupNotification;
+
+
+
+
+ +
+
+
+ +
+ + + + + + + + + \ No newline at end of file diff --git a/docs/structures_Location.js.html b/docs/structures_Location.js.html index b4951b1..ec229a0 100644 --- a/docs/structures_Location.js.html +++ b/docs/structures_Location.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.1.0 » Source: structures/Location.js + whatsapp-web.js 1.2.0 » Source: structures/Location.js @@ -15,7 +15,7 @@ @@ -71,7 +71,7 @@ module.exports = Location;
diff --git a/docs/structures_Message.js.html b/docs/structures_Message.js.html index 8311873..cc8a48e 100644 --- a/docs/structures_Message.js.html +++ b/docs/structures_Message.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.1.0 » Source: structures/Message.js + whatsapp-web.js 1.2.0 » Source: structures/Message.js @@ -15,7 +15,7 @@ @@ -262,7 +262,7 @@ module.exports = Message;
diff --git a/docs/structures_MessageMedia.js.html b/docs/structures_MessageMedia.js.html index c3ee4f5..a901041 100644 --- a/docs/structures_MessageMedia.js.html +++ b/docs/structures_MessageMedia.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.1.0 » Source: structures/MessageMedia.js + whatsapp-web.js 1.2.0 » Source: structures/MessageMedia.js @@ -15,7 +15,7 @@ @@ -69,7 +69,7 @@ module.exports = MessageMedia;
diff --git a/docs/structures_PrivateChat.js.html b/docs/structures_PrivateChat.js.html index 2090d21..4930749 100644 --- a/docs/structures_PrivateChat.js.html +++ b/docs/structures_PrivateChat.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.1.0 » Source: structures/PrivateChat.js + whatsapp-web.js 1.2.0 » Source: structures/PrivateChat.js @@ -15,7 +15,7 @@ @@ -51,7 +51,7 @@ module.exports = PrivateChat;
diff --git a/docs/structures_PrivateContact.js.html b/docs/structures_PrivateContact.js.html index 54dc2ab..199fb76 100644 --- a/docs/structures_PrivateContact.js.html +++ b/docs/structures_PrivateContact.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.1.0 » Source: structures/PrivateContact.js + whatsapp-web.js 1.2.0 » Source: structures/PrivateContact.js @@ -15,7 +15,7 @@ @@ -51,7 +51,7 @@ module.exports = PrivateContact;
diff --git a/docs/util_Constants.js.html b/docs/util_Constants.js.html index aa5840d..89e0de4 100644 --- a/docs/util_Constants.js.html +++ b/docs/util_Constants.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.1.0 » Source: util/Constants.js + whatsapp-web.js 1.2.0 » Source: util/Constants.js @@ -15,7 +15,7 @@ @@ -67,6 +67,9 @@ exports.Events = { MESSAGE_REVOKED_EVERYONE: 'message_revoke_everyone', MESSAGE_REVOKED_ME: 'message_revoke_me', MESSAGE_ACK: 'message_ack', + GROUP_JOIN: 'group_join', + GROUP_LEAVE: 'group_leave', + GROUP_UPDATE: 'group_update', QR_RECEIVED: 'qr', DISCONNECTED: 'disconnected', STATE_CHANGED: 'change_state', @@ -92,6 +95,23 @@ exports.MessageTypes = { UNKNOWN: 'unknown' }; +/** + * Group notification types + * @readonly + * @enum {string} + */ +exports.GroupNotificationTypes = { + ADD: 'add', + INVITE: 'invite', + REMOVE: 'remove', + LEAVE: 'leave', + SUBJECT: 'subject', + DESCRIPTION: 'description', + PICTURE: 'picture', + ANNOUNCE: 'announce', + RESTRICT: 'restrict', +}; + /** * Chat types * @readonly @@ -146,7 +166,7 @@ exports.MessageAck = {
diff --git a/docs/util_Util.js.html b/docs/util_Util.js.html index 728a7fe..f5c9bad 100644 --- a/docs/util_Util.js.html +++ b/docs/util_Util.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.1.0 » Source: util/Util.js + whatsapp-web.js 1.2.0 » Source: util/Util.js @@ -15,7 +15,7 @@ @@ -73,7 +73,7 @@ module.exports = Util; diff --git a/package.json b/package.json index c2f50fc..7914990 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "whatsapp-web.js", - "version": "1.1.0-post", + "version": "1.2.0", "description": "Library for interacting with the WhatsApp Web API ", "main": "./index.js", "scripts": {