Class Conversation

constructor

• new Conversation(properties?): Conversation

• Constructs a new Conversation.

  Parameters

  • Optional properties: IConversation

    Properties to set

  Returns Conversation

archived

commentsCount

contactPrimaryIdentityKey

conversationTimestamp

createdAt

createdBy

description

Optional disappearingMode

displayName

endOfHistoryTransfer

endOfHistoryTransferType

ephemeralExpiration

ephemeralSettingTimestamp

id

isDefaultSubgroup

isParentGroup

lastMsgTimestamp

lidJid

lidOriginType

markedAsUnread

mediaVisibility

messages

muteEndTime

name

newJid

notSpam

oldJid

pHash

parentGroupId

participant

pinned

pnJid

pnhDuplicateLidThread

readOnly

shareOwnPn

support

suspended

tcToken

tcTokenSenderTimestamp

tcTokenTimestamp

terminated

unreadCount

unreadMentionCount

username

Optional wallpaper

toJSON

• toJSON(): {
      [k: string]: any;
  }

• Converts this Conversation to JSON.

  Returns {
      [k: string]: any;
  }

  JSON object

  • [k: string]: any

Static create

• create(properties?): Conversation

• Creates a new Conversation instance using the specified properties.

  Parameters

  • Optional properties: IConversation

    Properties to set

  Returns Conversation

  Conversation instance

Static decode

• decode(reader, length?): Conversation

• Decodes a Conversation message from the specified reader or buffer.

  Parameters

  • reader: Uint8Array | Reader

    Reader or buffer to decode from

  • Optional 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

Static decodeDelimited

• decodeDelimited(reader): Conversation

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

  Parameters

  • reader: Uint8Array | Reader

    Reader or buffer to decode from

  Returns Conversation

  Conversation

  Throws

  If the payload is not a reader or valid buffer

  Throws

  If required fields are missing

Static encode

• encode(message, writer?): Writer

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

  Parameters

  • message: IConversation

    Conversation message or plain object to encode

  • Optional writer: Writer

    Writer to encode to

  Returns Writer

  Writer

Static encodeDelimited

• encodeDelimited(message, writer?): Writer

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

  Parameters

  • message: IConversation

    Conversation message or plain object to encode

  • Optional writer: Writer

    Writer to encode to

  Returns Writer

  Writer

Static fromObject

• fromObject(object): Conversation

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

  Parameters

  • object: {
        [k: string]: any;
    }

    Plain object

    • [k: string]: any

  Returns Conversation

  Conversation

Static toObject

• toObject(message, options?): {
      [k: string]: any;
  }

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

  Parameters

  • message: Conversation

    Conversation

  • Optional options: IConversionOptions

    Conversion options

  Returns {
      [k: string]: any;
  }

  Plain object

  • [k: string]: any

Static verify

• verify(message): null | string

• Verifies a Conversation message.

  Parameters

  • message: {
        [k: string]: any;
    }

    Plain object to verify

    • [k: string]: any

  Returns null | string

  null if valid, otherwise the reason why it is not