Class ProtocolMessage

constructor

• new ProtocolMessage(properties?): ProtocolMessage

• Constructs a new ProtocolMessage.

  Parameters

  • Optional properties: IProtocolMessage

    Properties to set

  Returns ProtocolMessage

Optional appStateFatalExceptionNotification

Optional appStateSyncKeyRequest

Optional appStateSyncKeyShare

Optional botFeedbackMessage

Optional disappearingMode

Optional editedMessage

ephemeralExpiration

ephemeralSettingTimestamp

Optional historySyncNotification

Optional initialSecurityNotificationSettingSync

Optional key

Optional peerDataOperationRequestMessage

Optional peerDataOperationRequestResponseMessage

timestampMs

type

toJSON

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

• Converts this ProtocolMessage to JSON.

  Returns {
      [k: string]: any;
  }

  JSON object

  • [k: string]: any

Static create

• create(properties?): ProtocolMessage

• Creates a new ProtocolMessage instance using the specified properties.

  Parameters

  • Optional properties: IProtocolMessage

    Properties to set

  Returns ProtocolMessage

  ProtocolMessage instance

Static decode

• decode(reader, length?): ProtocolMessage

• 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

Static decodeDelimited

• decodeDelimited(reader): ProtocolMessage

• 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

Static encode

• encode(message, writer?): Writer

• 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

Static encodeDelimited

• encodeDelimited(message, 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

Static fromObject

• fromObject(object): ProtocolMessage

• 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

Static toObject

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

• 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

Static verify

• verify(message): null | string

• 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