Class DocumentMessage

constructor

• new DocumentMessage(properties?): DocumentMessage

• Constructs a new DocumentMessage.

  Parameters

  • Optional properties: IDocumentMessage

    Properties to set

  Returns DocumentMessage

Optional accessibilityLabel

Optional caption

Optional contactVcard

Optional contextInfo

Optional directPath

Optional fileEncSha256

Optional fileLength

Optional fileName

Optional fileSha256

Optional jpegThumbnail

Optional mediaKey

Optional mediaKeyTimestamp

Optional mimetype

Optional pageCount

Optional thumbnailDirectPath

Optional thumbnailEncSha256

Optional thumbnailHeight

Optional thumbnailSha256

Optional thumbnailWidth

Optional title

Optional url

toJSON

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

• Converts this DocumentMessage to JSON.

  Returns {
      [k: string]: any;
  }

  JSON object

  • [k: string]: any

Static create

• create(properties?): DocumentMessage

• Creates a new DocumentMessage instance using the specified properties.

  Parameters

  • Optional properties: IDocumentMessage

    Properties to set

  Returns DocumentMessage

  DocumentMessage instance

Static decode

• decode(reader, length?): DocumentMessage

• Decodes a DocumentMessage 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 DocumentMessage

  DocumentMessage

  Throws

  If the payload is not a reader or valid buffer

  Throws

  If required fields are missing

Static decodeDelimited

• decodeDelimited(reader): DocumentMessage

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

  Parameters

  • reader: Uint8Array | Reader

    Reader or buffer to decode from

  Returns DocumentMessage

  DocumentMessage

  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 DocumentMessage message. Does not implicitly verify messages.

  Parameters

  • message: IDocumentMessage

    DocumentMessage 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 DocumentMessage message, length delimited. Does not implicitly verify messages.

  Parameters

  • message: IDocumentMessage

    DocumentMessage message or plain object to encode

  • Optional writer: Writer

    Writer to encode to

  Returns Writer

  Writer

Static fromObject

• fromObject(object): DocumentMessage

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

  Parameters

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

    Plain object

    • [k: string]: any

  Returns DocumentMessage

  DocumentMessage

Static getTypeUrl

• getTypeUrl(typeUrlPrefix?): string

• Gets the default type url for DocumentMessage

  Parameters

  • Optional typeUrlPrefix: string

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

  Returns string

  The default type url

Static toObject

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

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

  Parameters

  • message: DocumentMessage

    DocumentMessage

  • Optional options: IConversionOptions

    Conversion options

  Returns {
      [k: string]: any;
  }

  Plain object

  • [k: string]: any

Static verify

• verify(message): null | string

• Verifies a DocumentMessage 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