Class ProtocolMessage

Represents a ProtocolMessage.

Hierarchy

  • ProtocolMessage

Implements

Constructors

Properties

appStateFatalExceptionNotification?: null | IAppStateFatalExceptionNotification

ProtocolMessage appStateFatalExceptionNotification.

appStateSyncKeyRequest?: null | IAppStateSyncKeyRequest

ProtocolMessage appStateSyncKeyRequest.

appStateSyncKeyShare?: null | IAppStateSyncKeyShare

ProtocolMessage appStateSyncKeyShare.

botFeedbackMessage?: null | IBotFeedbackMessage

ProtocolMessage botFeedbackMessage.

disappearingMode?: null | IDisappearingMode

ProtocolMessage disappearingMode.

editedMessage?: null | IMessage

ProtocolMessage editedMessage.

ephemeralExpiration: number

ProtocolMessage ephemeralExpiration.

ephemeralSettingTimestamp: number | Long

ProtocolMessage ephemeralSettingTimestamp.

historySyncNotification?: null | IHistorySyncNotification

ProtocolMessage historySyncNotification.

initialSecurityNotificationSettingSync?: null | IInitialSecurityNotificationSettingSync

ProtocolMessage initialSecurityNotificationSettingSync.

invokerJid: string

ProtocolMessage invokerJid.

key?: null | proto.IMessageKey

ProtocolMessage key.

mediaNotifyMessage?: null | IMediaNotifyMessage

ProtocolMessage mediaNotifyMessage.

peerDataOperationRequestMessage?: null | IPeerDataOperationRequestMessage

ProtocolMessage peerDataOperationRequestMessage.

peerDataOperationRequestResponseMessage?: null | IPeerDataOperationRequestResponseMessage

ProtocolMessage peerDataOperationRequestResponseMessage.

requestWelcomeMessageMetadata?: null | IRequestWelcomeMessageMetadata

ProtocolMessage requestWelcomeMessageMetadata.

timestampMs: number | Long

ProtocolMessage timestampMs.

ProtocolMessage type.

Methods

  • Converts this ProtocolMessage to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

    • [k: string]: any
  • Decodes a ProtocolMessage 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 ProtocolMessage

    ProtocolMessage

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

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

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns ProtocolMessage

    ProtocolMessage

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

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

    Parameters

    • message: IProtocolMessage

      ProtocolMessage message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

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

    Parameters

    • message: IProtocolMessage

      ProtocolMessage message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

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

    Parameters

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

      Plain object

      • [k: string]: any

    Returns ProtocolMessage

    ProtocolMessage

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

    Parameters

    • message: ProtocolMessage

      ProtocolMessage

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

    • [k: string]: any
  • Verifies a ProtocolMessage 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

Generated using TypeDoc