Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DocumentMessage

Represents a DocumentMessage.

Hierarchy

  • DocumentMessage

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

contactVcard

contactVcard: boolean

DocumentMessage contactVcard.

Optional contextInfo

contextInfo: IContextInfo

DocumentMessage contextInfo.

directPath

directPath: string

DocumentMessage directPath.

fileEncSha256

fileEncSha256: Uint8Array

DocumentMessage fileEncSha256.

fileLength

fileLength: number | Long

DocumentMessage fileLength.

fileName

fileName: string

DocumentMessage fileName.

fileSha256

fileSha256: Uint8Array

DocumentMessage fileSha256.

jpegThumbnail

jpegThumbnail: Uint8Array

DocumentMessage jpegThumbnail.

mediaKey

mediaKey: Uint8Array

DocumentMessage mediaKey.

mediaKeyTimestamp

mediaKeyTimestamp: number | Long

DocumentMessage mediaKeyTimestamp.

mimetype

mimetype: string

DocumentMessage mimetype.

pageCount

pageCount: number

DocumentMessage pageCount.

thumbnailDirectPath

thumbnailDirectPath: string

DocumentMessage thumbnailDirectPath.

thumbnailEncSha256

thumbnailEncSha256: Uint8Array

DocumentMessage thumbnailEncSha256.

thumbnailHeight

thumbnailHeight: number

DocumentMessage thumbnailHeight.

thumbnailSha256

thumbnailSha256: Uint8Array

DocumentMessage thumbnailSha256.

thumbnailWidth

thumbnailWidth: number

DocumentMessage thumbnailWidth.

title

title: string

DocumentMessage title.

url

url: string

DocumentMessage url.

Methods

toJSON

  • toJSON(): {}

  • Converts this DocumentMessage to JSON.

    Returns {}

    JSON object

    • [k: string]: any

Static create

Static decode

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

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    • Optional length: number

    Returns DocumentMessage

    DocumentMessage

Static decodeDelimited

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

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns DocumentMessage

    DocumentMessage

Static encode

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

    Parameters

    • message: IDocumentMessage

      DocumentMessage message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static encodeDelimited

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

    Parameters

    • message: IDocumentMessage

      DocumentMessage message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static fromObject

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

    Parameters

    • object: {}

      Plain object

      • [k: string]: any

    Returns DocumentMessage

    DocumentMessage

Static toObject

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

    Parameters

    • message: DocumentMessage

      DocumentMessage

    • Optional options: IConversionOptions

    Returns {}

    Plain object

    • [k: string]: any

Static verify

  • verify(message: {}): string

  • Verifies a DocumentMessage message.

    Parameters

    • message: {}

      Plain object to verify

      • [k: string]: any

    Returns string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc