Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ImageMessage

Represents an ImageMessage.

Hierarchy

  • ImageMessage

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

caption

caption: string

ImageMessage caption.

Optional contextInfo

contextInfo: IContextInfo

ImageMessage contextInfo.

directPath

directPath: string

ImageMessage directPath.

experimentGroupId

experimentGroupId: number

ImageMessage experimentGroupId.

fileEncSha256

fileEncSha256: Uint8Array

ImageMessage fileEncSha256.

fileLength

fileLength: number | Long

ImageMessage fileLength.

fileSha256

fileSha256: Uint8Array

ImageMessage fileSha256.

firstScanLength

firstScanLength: number

ImageMessage firstScanLength.

firstScanSidecar

firstScanSidecar: Uint8Array

ImageMessage firstScanSidecar.

height

height: number

ImageMessage height.

interactiveAnnotations

interactiveAnnotations: IInteractiveAnnotation[]

ImageMessage interactiveAnnotations.

jpegThumbnail

jpegThumbnail: Uint8Array

ImageMessage jpegThumbnail.

mediaKey

mediaKey: Uint8Array

ImageMessage mediaKey.

mediaKeyTimestamp

mediaKeyTimestamp: number | Long

ImageMessage mediaKeyTimestamp.

midQualityFileEncSha256

midQualityFileEncSha256: Uint8Array

ImageMessage midQualityFileEncSha256.

midQualityFileSha256

midQualityFileSha256: Uint8Array

ImageMessage midQualityFileSha256.

mimetype

mimetype: string

ImageMessage mimetype.

scanLengths

scanLengths: number[]

ImageMessage scanLengths.

scansSidecar

scansSidecar: Uint8Array

ImageMessage scansSidecar.

staticUrl

staticUrl: string

ImageMessage staticUrl.

thumbnailDirectPath

thumbnailDirectPath: string

ImageMessage thumbnailDirectPath.

thumbnailEncSha256

thumbnailEncSha256: Uint8Array

ImageMessage thumbnailEncSha256.

thumbnailSha256

thumbnailSha256: Uint8Array

ImageMessage thumbnailSha256.

url

url: string

ImageMessage url.

viewOnce

viewOnce: boolean

ImageMessage viewOnce.

width

width: number

ImageMessage width.

Methods

toJSON

  • toJSON(): {}

Static create

Static decode

  • decode(reader: Uint8Array | Reader, length?: number): ImageMessage

  • Decodes an ImageMessage 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 ImageMessage

    ImageMessage

Static decodeDelimited

  • decodeDelimited(reader: Uint8Array | Reader): ImageMessage

  • Decodes an ImageMessage 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 ImageMessage

    ImageMessage

Static encode

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

    Parameters

    • message: IImageMessage

      ImageMessage message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static encodeDelimited

  • encodeDelimited(message: IImageMessage, writer?: Writer): Writer

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

    Parameters

    • message: IImageMessage

      ImageMessage message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static fromObject

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

    Parameters

    • object: {}

      Plain object

      • [k: string]: any

    Returns ImageMessage

    ImageMessage

Static toObject

  • toObject(message: ImageMessage, options?: IConversionOptions): {}

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

    Parameters

    • message: ImageMessage

      ImageMessage

    • Optional options: IConversionOptions

    Returns {}

    Plain object

    • [k: string]: any

Static verify

  • verify(message: {}): string

  • Verifies an ImageMessage 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