Skip to main content

Class: Conversation

Defined in: WAProto/index.d.ts:11061

Represents a Conversation.

Implements​

Constructors​

new Conversation()​

new Conversation(properties?): Conversation

Defined in: WAProto/index.d.ts:11067

Constructs a new Conversation.

Parameters​

properties?​

IConversation

Properties to set

Returns​

Conversation

Properties​

accountLid?​

optional accountLid: null | string

Defined in: WAProto/index.d.ts:11214

Conversation accountLid.

Implementation of​

IConversation.accountLid

archived?​

optional archived: null | boolean

Defined in: WAProto/index.d.ts:11115

Conversation archived.

Implementation of​

IConversation.archived

capiCreatedGroup?​

optional capiCreatedGroup: null | boolean

Defined in: WAProto/index.d.ts:11211

Conversation capiCreatedGroup.

Implementation of​

IConversation.capiCreatedGroup

commentsCount?​

optional commentsCount: null | number

Defined in: WAProto/index.d.ts:11202

Conversation commentsCount.

Implementation of​

IConversation.commentsCount

contactPrimaryIdentityKey?​

optional contactPrimaryIdentityKey: null | Uint8Array<ArrayBufferLike>

Defined in: WAProto/index.d.ts:11136

Conversation contactPrimaryIdentityKey.

Implementation of​

IConversation.contactPrimaryIdentityKey

conversationTimestamp?​

optional conversationTimestamp: null | number | Long

Defined in: WAProto/index.d.ts:11103

Conversation conversationTimestamp.

Implementation of​

IConversation.conversationTimestamp

createdAt?​

optional createdAt: null | number | Long

Defined in: WAProto/index.d.ts:11160

Conversation createdAt.

Implementation of​

IConversation.createdAt

createdBy?​

optional createdBy: null | string

Defined in: WAProto/index.d.ts:11163

Conversation createdBy.

Implementation of​

IConversation.createdBy

description?​

optional description: null | string

Defined in: WAProto/index.d.ts:11166

Conversation description.

Implementation of​

IConversation.description

disappearingMode?​

optional disappearingMode: null | IDisappearingMode

Defined in: WAProto/index.d.ts:11118

Conversation disappearingMode.

Implementation of​

IConversation.disappearingMode

displayName?​

optional displayName: null | string

Defined in: WAProto/index.d.ts:11181

Conversation displayName.

Implementation of​

IConversation.displayName

endOfHistoryTransfer?​

optional endOfHistoryTransfer: null | boolean

Defined in: WAProto/index.d.ts:11091

Conversation endOfHistoryTransfer.

Implementation of​

IConversation.endOfHistoryTransfer

endOfHistoryTransferType?​

optional endOfHistoryTransferType: null | EndOfHistoryTransferType

Defined in: WAProto/index.d.ts:11100

Conversation endOfHistoryTransferType.

Implementation of​

IConversation.endOfHistoryTransferType

ephemeralExpiration?​

optional ephemeralExpiration: null | number

Defined in: WAProto/index.d.ts:11094

Conversation ephemeralExpiration.

Implementation of​

IConversation.ephemeralExpiration

ephemeralSettingTimestamp?​

optional ephemeralSettingTimestamp: null | number | Long

Defined in: WAProto/index.d.ts:11097

Conversation ephemeralSettingTimestamp.

Implementation of​

IConversation.ephemeralSettingTimestamp

id​

id: string

Defined in: WAProto/index.d.ts:11070

Conversation id.

Implementation of​

IConversation.id

isDefaultSubgroup?​

optional isDefaultSubgroup: null | boolean

Defined in: WAProto/index.d.ts:11178

Conversation isDefaultSubgroup.

Implementation of​

IConversation.isDefaultSubgroup

isParentGroup?​

optional isParentGroup: null | boolean

Defined in: WAProto/index.d.ts:11172

Conversation isParentGroup.

Implementation of​

IConversation.isParentGroup

lastMsgTimestamp?​

optional lastMsgTimestamp: null | number | Long

Defined in: WAProto/index.d.ts:11082

Conversation lastMsgTimestamp.

Implementation of​

IConversation.lastMsgTimestamp

lidJid?​

optional lidJid: null | string

Defined in: WAProto/index.d.ts:11193

Conversation lidJid.

Implementation of​

IConversation.lidJid

lidOriginType?​

optional lidOriginType: null | string

Defined in: WAProto/index.d.ts:11199

Conversation lidOriginType.

Implementation of​

IConversation.lidOriginType

limitSharing?​

optional limitSharing: null | boolean

Defined in: WAProto/index.d.ts:11217

Conversation limitSharing.

Implementation of​

IConversation.limitSharing

locked?​

optional locked: null | boolean

Defined in: WAProto/index.d.ts:11205

Conversation locked.

Implementation of​

IConversation.locked

markedAsUnread?​

optional markedAsUnread: null | boolean

Defined in: WAProto/index.d.ts:11124

Conversation markedAsUnread.

Implementation of​

IConversation.markedAsUnread

mediaVisibility?​

optional mediaVisibility: null | MediaVisibility

Defined in: WAProto/index.d.ts:11148

Conversation mediaVisibility.

Implementation of​

IConversation.mediaVisibility

messages​

messages: IHistorySyncMsg[]

Defined in: WAProto/index.d.ts:11073

Conversation messages.

Implementation of​

IConversation.messages

muteEndTime?​

optional muteEndTime: null | number | Long

Defined in: WAProto/index.d.ts:11142

Conversation muteEndTime.

Implementation of​

IConversation.muteEndTime

name?​

optional name: null | string

Defined in: WAProto/index.d.ts:11106

Conversation name.

Implementation of​

IConversation.name

newJid?​

optional newJid: null | string

Defined in: WAProto/index.d.ts:11076

Conversation newJid.

Implementation of​

IConversation.newJid

notSpam?​

optional notSpam: null | boolean

Defined in: WAProto/index.d.ts:11112

Conversation notSpam.

Implementation of​

IConversation.notSpam

oldJid?​

optional oldJid: null | string

Defined in: WAProto/index.d.ts:11079

Conversation oldJid.

Implementation of​

IConversation.oldJid

parentGroupId?​

optional parentGroupId: null | string

Defined in: WAProto/index.d.ts:11175

Conversation parentGroupId.

Implementation of​

IConversation.parentGroupId

participant​

participant: IGroupParticipant[]

Defined in: WAProto/index.d.ts:11127

Conversation participant.

Implementation of​

IConversation.participant

pHash?​

optional pHash: null | string

Defined in: WAProto/index.d.ts:11109

Conversation pHash.

Implementation of​

IConversation.pHash

pinned?​

optional pinned: null | number

Defined in: WAProto/index.d.ts:11139

Conversation pinned.

Implementation of​

IConversation.pinned

pnhDuplicateLidThread?​

optional pnhDuplicateLidThread: null | boolean

Defined in: WAProto/index.d.ts:11190

Conversation pnhDuplicateLidThread.

Implementation of​

IConversation.pnhDuplicateLidThread

pnJid?​

optional pnJid: null | string

Defined in: WAProto/index.d.ts:11184

Conversation pnJid.

Implementation of​

IConversation.pnJid

readOnly?​

optional readOnly: null | boolean

Defined in: WAProto/index.d.ts:11088

Conversation readOnly.

Implementation of​

IConversation.readOnly

shareOwnPn?​

optional shareOwnPn: null | boolean

Defined in: WAProto/index.d.ts:11187

Conversation shareOwnPn.

Implementation of​

IConversation.shareOwnPn

support?​

optional support: null | boolean

Defined in: WAProto/index.d.ts:11169

Conversation support.

Implementation of​

IConversation.support

suspended?​

optional suspended: null | boolean

Defined in: WAProto/index.d.ts:11154

Conversation suspended.

Implementation of​

IConversation.suspended

systemMessageToInsert?​

optional systemMessageToInsert: null | PrivacySystemMessage

Defined in: WAProto/index.d.ts:11208

Conversation systemMessageToInsert.

Implementation of​

IConversation.systemMessageToInsert

tcToken?​

optional tcToken: null | Uint8Array<ArrayBufferLike>

Defined in: WAProto/index.d.ts:11130

Conversation tcToken.

Implementation of​

IConversation.tcToken

tcTokenSenderTimestamp?​

optional tcTokenSenderTimestamp: null | number | Long

Defined in: WAProto/index.d.ts:11151

Conversation tcTokenSenderTimestamp.

Implementation of​

IConversation.tcTokenSenderTimestamp

tcTokenTimestamp?​

optional tcTokenTimestamp: null | number | Long

Defined in: WAProto/index.d.ts:11133

Conversation tcTokenTimestamp.

Implementation of​

IConversation.tcTokenTimestamp

terminated?​

optional terminated: null | boolean

Defined in: WAProto/index.d.ts:11157

Conversation terminated.

Implementation of​

IConversation.terminated

unreadCount?​

optional unreadCount: null | number

Defined in: WAProto/index.d.ts:11085

Conversation unreadCount.

Implementation of​

IConversation.unreadCount

unreadMentionCount?​

optional unreadMentionCount: null | number

Defined in: WAProto/index.d.ts:11121

Conversation unreadMentionCount.

Implementation of​

IConversation.unreadMentionCount

username?​

optional username: null | string

Defined in: WAProto/index.d.ts:11196

Conversation username.

Implementation of​

IConversation.username

wallpaper?​

optional wallpaper: null | IWallpaperSettings

Defined in: WAProto/index.d.ts:11145

Conversation wallpaper.

Implementation of​

IConversation.wallpaper

Methods​

toJSON()​

toJSON(): object

Defined in: WAProto/index.d.ts:11287

Converts this Conversation to JSON.

Returns​

object

JSON object

create()​

static create(properties?): Conversation

Defined in: WAProto/index.d.ts:11224

Creates a new Conversation instance using the specified properties.

Parameters​

properties?​

IConversation

Properties to set

Returns​

Conversation

Conversation instance

decode()​

static decode(reader, length?): Conversation

Defined in: WAProto/index.d.ts:11250

Decodes a Conversation message from the specified reader or buffer.

Parameters​

reader​

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

length?​

number

Message length if known beforehand

Returns​

Conversation

Conversation

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Conversation

Defined in: WAProto/index.d.ts:11259

Decodes a Conversation message from the specified reader or buffer, length delimited.

Parameters​

reader​

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns​

Conversation

Conversation

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Defined in: WAProto/index.d.ts:11232

Encodes the specified Conversation message. Does not implicitly verify messages.

Parameters​

message​

IConversation

Conversation message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Defined in: WAProto/index.d.ts:11240

Encodes the specified Conversation message, length delimited. Does not implicitly verify messages.

Parameters​

message​

IConversation

Conversation message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Conversation

Defined in: WAProto/index.d.ts:11273

Creates a Conversation message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

Plain object

Returns​

Conversation

Conversation

getTypeUrl()​

static getTypeUrl(typeUrlPrefix?): string

Defined in: WAProto/index.d.ts:11294

Gets the default type url for Conversation

Parameters​

typeUrlPrefix?​

string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns​

string

The default type url

toObject()​

static toObject(message, options?): object

Defined in: WAProto/index.d.ts:11281

Creates a plain object from a Conversation message. Also converts values to other types if specified.

Parameters​

message​

Conversation

Conversation

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object

verify()​

static verify(message): null | string

Defined in: WAProto/index.d.ts:11266

Verifies a Conversation message.

Parameters​

message​

Plain object to verify

Returns​

null | string

null if valid, otherwise the reason why it is not