new GroupChat()

Extends
Chat

Properties

archived  unknown

Indicates if the Chat is archived

Inherited from
Chat#archived

createdAt  date

Gets the date at which the group was created

description  string

Gets the group description

id  unknown

ID that represents the chat

Inherited from
Chat#id

isGroup  unknown

Indicates if the Chat is a Group Chat

Inherited from
Chat#isGroup

isMuted  unknown

Indicates if the chat is muted or not

Inherited from
Chat#isMuted

isReadOnly  unknown

Indicates if the Chat is readonly

Inherited from
Chat#isReadOnly

lastMessage  unknown

Last message fo chat

Inherited from
Chat#lastMessage

muteExpiration  unknown

Unix timestamp for when the mute expires

Inherited from
Chat#muteExpiration

name  unknown

Title of the chat

Inherited from
Chat#name

owner  ContactId

Gets the group owner

participants  Array of GroupParticipant

Gets the group participants

pinned  unknown

Indicates if the Chat is pinned

Inherited from
Chat#pinned

timestamp  unknown

Unix timestamp for when the last activity occurred

Inherited from
Chat#timestamp

unreadCount  unknown

Amount of messages unread

Inherited from
Chat#unreadCount

Methods

async

addParticipants(participantIds, options) → Promise containing (Object with AddParticipantsResult properties or string)

Adds a list of participants by ID to the group

Parameters

Name Type Optional Description

participantIds

(string or Array of string)

 

options

AddParticipnatsOptions

 

An object thay handles options for adding participants

Returns

Promise containing (Object with AddParticipantsResult properties or string) 

Returns an object with the resulting data or an error message as a string

async

approveGroupMembershipRequests(options) → Promise containing Array of MembershipRequestActionResult

Approves membership requests if any

Parameter

Name Type Optional Description

options

MembershipRequestActionOptions

 

Options for performing a membership request action

Returns

Promise containing Array of MembershipRequestActionResult 

Returns an array of requester IDs whose membership requests were approved and an error for each requester, if any occurred during the operation. If there are no requests, an empty array will be returned

async

archive()

Archives this chat

Inherited from
Chat#archive
async

changeLabels(labelIds) → Promise containing void

Add or remove labels to this Chat

Parameter

Name Type Optional Description

labelIds

 

 

Inherited from
Chat#changeLabels
Returns
async

clearMessages() → Promise containing Boolean

Clears all messages from the chat

Inherited from
Chat#clearMessages
Returns

result

async

clearState()

Stops typing or recording in chat immediately.

Inherited from
Chat#clearState
async

delete() → Promise containing Boolean

Deletes the chat

Inherited from
Chat#delete
Returns

result

async

deletePicture() → Promise containing boolean

Deletes the group's picture.

Returns

Promise containing boolean 

Returns true if the picture was properly deleted. This can return false if the user does not have the necessary permissions.

async

demoteParticipants(participantIds) → Promise containing {status: number}

Demotes participants by IDs to regular users

Parameter

Name Type Optional Description

participantIds

Array of string

 

Returns

Promise containing {status: number} 

Object with status code indicating if the operation was successful

async

fetchMessages(searchOptions) → Promise containing Array of Message

Loads chat messages, sorted from earliest to latest.

Parameters

Name Type Optional Description

searchOptions

 

 

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

Values in searchOptions have the following properties:

Name Type Optional Description

limit

 

Yes

The amount of messages to return. If no limit is specified, the available messages will be returned. 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.

fromMe

 

Yes

Return only messages from the bot number or vise versa. To get all messages, leave the option undefined.

Inherited from
Chat#fetchMessages
Returns
async

getContact() → Promise containing Contact

Returns the Contact that corresponds to this Chat.

Inherited from
Chat#getContact
Returns
async

getGroupMembershipRequests() → Promise containing Array of GroupMembershipRequest

Gets an array of membership requests

Returns

Promise containing Array of GroupMembershipRequest 

An array of membership requests

async

getInviteCode() → Promise containing string

Gets the invite code for a specific group

Returns

Promise containing string 

Group's invite code

async

getLabels() → Promise containing Array of Label

Returns array of all Labels assigned to this Chat

Inherited from
Chat#getLabels
Returns
async

leave() → Promise

Makes the bot leave the group

Returns

Promise 

async

markUnread()

Mark this chat as unread

Inherited from
Chat#markUnread
async

mute(unmuteDate)

Mutes this chat forever, unless a date is specified

Parameter

Name Type Optional Description

unmuteDate

 

 

Date at which the Chat will be unmuted, leave as is to mute forever

Value can be null.

Inherited from
Chat#mute
async

pin() → Promise containing boolean

Pins this chat

Inherited from
Chat#pin
Returns

New pin state. Could be false if the max number of pinned chats was reached.

async

promoteParticipants(participantIds) → Promise containing {status: number}

Promotes participants by IDs to admins

Parameter

Name Type Optional Description

participantIds

Array of string

 

Returns

Promise containing {status: number} 

Object with status code indicating if the operation was successful

async

rejectGroupMembershipRequests(options) → Promise containing Array of MembershipRequestActionResult

Rejects membership requests if any

Parameter

Name Type Optional Description

options

MembershipRequestActionOptions

 

Options for performing a membership request action

Returns

Promise containing Array of MembershipRequestActionResult 

Returns an array of requester IDs whose membership requests were rejected and an error for each requester, if any occurred during the operation. If there are no requests, an empty array will be returned

async

removeParticipants(participantIds) → Promise containing {status: number}

Removes a list of participants by ID to the group

Parameter

Name Type Optional Description

participantIds

Array of string

 

Returns

Promise containing {status: number} 

async

revokeInvite() → Promise containing string

Invalidates the current group invite code and generates a new one

Returns

Promise containing string 

New invite code

async

sendMessage(content[, options]) → Promise containing Message

Send a message to this chat

Parameters

Name Type Optional Description

content

 

 

options

 

Yes

Inherited from
Chat#sendMessage
Returns

Message that was just sent

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

setAddMembersAdminsOnly([adminsOnly]) → Promise containing boolean

Updates the group setting to allow only admins to add members to the group.

Parameter

Name Type Optional Description

adminsOnly

boolean

Yes

Enable or disable this option

Defaults to true.

Returns

Promise containing boolean 

Returns true if the setting was properly updated. This can return false if the user does not have the necessary permissions.

async

setDescription(description) → Promise containing boolean

Updates the group description

Parameter

Name Type Optional Description

description

string

 

Returns

Promise containing boolean 

Returns true if the description was properly updated. This can return false if the user does not have the necessary permissions.

async

setInfoAdminsOnly([adminsOnly]) → Promise containing boolean

Updates the group settings to only allow admins to edit group info (title, description, photo).

Parameter

Name Type Optional Description

adminsOnly

boolean

Yes

Enable or disable this option

Defaults to true.

Returns

Promise containing boolean 

Returns true if the setting was properly updated. This can return false if the user does not have the necessary permissions.

async

setMessagesAdminsOnly([adminsOnly]) → Promise containing boolean

Updates the group settings to only allow admins to send messages.

Parameter

Name Type Optional Description

adminsOnly

boolean

Yes

Enable or disable this option

Defaults to true.

Returns

Promise containing boolean 

Returns true if the setting was properly updated. This can return false if the user does not have the necessary permissions.

async

setPicture(media) → Promise containing boolean

Sets the group's picture.

Parameter

Name Type Optional Description

media

MessageMedia

 

Returns

Promise containing boolean 

Returns true if the picture was properly updated. This can return false if the user does not have the necessary permissions.

async

setSubject(subject) → Promise containing boolean

Updates the group subject

Parameter

Name Type Optional Description

subject

string

 

Returns

Promise containing boolean 

Returns true if the subject was properly updated. This can return false if the user does not have the necessary permissions.

async

syncHistory() → Promise containing boolean

Sync chat history conversation

Inherited from
Chat#syncHistory
Returns

True if operation completed successfully, false otherwise.

async

unarchive()

un-archives this chat

Inherited from
Chat#unarchive
async

unmute()

Unmutes this chat

Inherited from
Chat#unmute
async

unpin() → Promise containing boolean

Unpins this chat

Inherited from
Chat#unpin
Returns

New pin state