Class Conversation

Represents a Conversation.

Hierarchy

  • Conversation

Implements

Constructors

constructor

Properties

accountLid? archived? capiCreatedGroup? commentsCount? contactPrimaryIdentityKey? conversationTimestamp? createdAt? createdBy? description? disappearingMode? displayName? endOfHistoryTransfer? endOfHistoryTransferType? ephemeralExpiration? ephemeralSettingTimestamp? id isDefaultSubgroup? isParentGroup? lastMsgTimestamp? lidJid? lidOriginType? limitSharing? locked? markedAsUnread? mediaVisibility? messages muteEndTime? name? newJid? notSpam? oldJid? pHash? parentGroupId? participant pinned? pnJid? pnhDuplicateLidThread? readOnly? shareOwnPn? support? suspended? systemMessageToInsert? tcToken? tcTokenSenderTimestamp? tcTokenTimestamp? terminated? unreadCount? unreadMentionCount? username? wallpaper?

Methods

toJSON create decode decodeDelimited encode encodeDelimited fromObject getTypeUrl toObject verify

Constructors

constructor

Properties

Optional accountLid

accountLid?: null | string

Conversation accountLid.

Optional archived

archived?: null | boolean

Conversation archived.

Optional capiCreatedGroup

capiCreatedGroup?: null | boolean

Conversation capiCreatedGroup.

Optional commentsCount

commentsCount?: null | number

Conversation commentsCount.

Optional contactPrimaryIdentityKey

contactPrimaryIdentityKey?: null | Uint8Array

Conversation contactPrimaryIdentityKey.

Optional conversationTimestamp

conversationTimestamp?: null | number | Long

Conversation conversationTimestamp.

Optional createdAt

createdAt?: null | number | Long

Conversation createdAt.

Optional createdBy

createdBy?: null | string

Conversation createdBy.

Optional description

description?: null | string

Conversation description.

Optional disappearingMode

disappearingMode?: null | IDisappearingMode

Conversation disappearingMode.

Optional displayName

displayName?: null | string

Conversation displayName.

Optional endOfHistoryTransfer

endOfHistoryTransfer?: null | boolean

Conversation endOfHistoryTransfer.

Optional endOfHistoryTransferType

endOfHistoryTransferType?: null | EndOfHistoryTransferType

Conversation endOfHistoryTransferType.

Optional ephemeralExpiration

ephemeralExpiration?: null | number

Conversation ephemeralExpiration.

Optional ephemeralSettingTimestamp

ephemeralSettingTimestamp?: null | number | Long

Conversation ephemeralSettingTimestamp.

id

id: string

Conversation id.

Optional isDefaultSubgroup

isDefaultSubgroup?: null | boolean

Conversation isDefaultSubgroup.

Optional isParentGroup

isParentGroup?: null | boolean

Conversation isParentGroup.

Optional lastMsgTimestamp

lastMsgTimestamp?: null | number | Long

Conversation lastMsgTimestamp.

Optional lidJid

lidJid?: null | string

Conversation lidJid.

Optional lidOriginType

lidOriginType?: null | string

Conversation lidOriginType.

Optional limitSharing

limitSharing?: null | boolean

Conversation limitSharing.

Optional locked

locked?: null | boolean

Conversation locked.

Optional markedAsUnread

markedAsUnread?: null | boolean

Conversation markedAsUnread.

Optional mediaVisibility

mediaVisibility?: null | MediaVisibility

Conversation mediaVisibility.

messages

messages: IHistorySyncMsg[]

Conversation messages.

Optional muteEndTime

muteEndTime?: null | number | Long

Conversation muteEndTime.

Optional name

name?: null | string

Conversation name.

Optional newJid

newJid?: null | string

Conversation newJid.

Optional notSpam

notSpam?: null | boolean

Conversation notSpam.

Optional oldJid

oldJid?: null | string

Conversation oldJid.

Optional pHash

pHash?: null | string

Conversation pHash.

Optional parentGroupId

parentGroupId?: null | string

Conversation parentGroupId.

participant

participant: IGroupParticipant[]

Conversation participant.

Optional pinned

pinned?: null | number

Conversation pinned.

Optional pnJid

pnJid?: null | string

Conversation pnJid.

Optional pnhDuplicateLidThread

pnhDuplicateLidThread?: null | boolean

Conversation pnhDuplicateLidThread.

Optional readOnly

readOnly?: null | boolean

Conversation readOnly.

Optional shareOwnPn

shareOwnPn?: null | boolean

Conversation shareOwnPn.

Optional support

support?: null | boolean

Conversation support.

Optional suspended

suspended?: null | boolean

Conversation suspended.

Optional systemMessageToInsert

systemMessageToInsert?: null | PrivacySystemMessage

Conversation systemMessageToInsert.

Optional tcToken

tcToken?: null | Uint8Array

Conversation tcToken.

Optional tcTokenSenderTimestamp

tcTokenSenderTimestamp?: null | number | Long

Conversation tcTokenSenderTimestamp.

Optional tcTokenTimestamp

tcTokenTimestamp?: null | number | Long

Conversation tcTokenTimestamp.

Optional terminated

terminated?: null | boolean

Conversation terminated.

Optional unreadCount

unreadCount?: null | number

Conversation unreadCount.

Optional unreadMentionCount

unreadMentionCount?: null | number

Conversation unreadMentionCount.

Optional username

username?: null | string

Conversation username.

Optional wallpaper

wallpaper?: null | IWallpaperSettings

Conversation wallpaper.

Methods

toJSON

  • Converts this Conversation to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

    • [k: string]: any

Static create

Static decode

  • 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

  • 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

  • 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

  • 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

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

  • Gets the default type url for Conversation

    Parameters

    • Optional typeUrlPrefix: string

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

    Returns string

    The default type url

Static toObject

  • 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

  • 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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc