Represents an ImageMessage.

Hierarchy

  • ImageMessage

Implements

Constructors

Properties

caption: string

ImageMessage caption.

contextInfo?: null | IContextInfo

ImageMessage contextInfo.

directPath: string

ImageMessage directPath.

experimentGroupId: number

ImageMessage experimentGroupId.

fileEncSha256: Uint8Array

ImageMessage fileEncSha256.

fileLength: number | Long

ImageMessage fileLength.

fileSha256: Uint8Array

ImageMessage fileSha256.

firstScanLength: number

ImageMessage firstScanLength.

firstScanSidecar: Uint8Array

ImageMessage firstScanSidecar.

height: number

ImageMessage height.

interactiveAnnotations: IInteractiveAnnotation[]

ImageMessage interactiveAnnotations.

jpegThumbnail: Uint8Array

ImageMessage jpegThumbnail.

mediaKey: Uint8Array

ImageMessage mediaKey.

mediaKeyTimestamp: number | Long

ImageMessage mediaKeyTimestamp.

midQualityFileEncSha256: Uint8Array

ImageMessage midQualityFileEncSha256.

midQualityFileSha256: Uint8Array

ImageMessage midQualityFileSha256.

mimetype: string

ImageMessage mimetype.

scanLengths: number[]

ImageMessage scanLengths.

scansSidecar: Uint8Array

ImageMessage scansSidecar.

staticUrl: string

ImageMessage staticUrl.

thumbnailDirectPath: string

ImageMessage thumbnailDirectPath.

thumbnailEncSha256: Uint8Array

ImageMessage thumbnailEncSha256.

thumbnailSha256: Uint8Array

ImageMessage thumbnailSha256.

url: string

ImageMessage url.

viewOnce: boolean

ImageMessage viewOnce.

width: number

ImageMessage width.

Methods

  • Converts this ImageMessage to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

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

    ImageMessage

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

  • Decodes an ImageMessage message from the specified reader or buffer, length delimited.

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns ImageMessage

    ImageMessage

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

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

    Parameters

    • message: IImageMessage

      ImageMessage message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns 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

      Writer to encode to

    Returns Writer

    Writer

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

    Parameters

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

      Plain object

      • [k: string]: any

    Returns ImageMessage

    ImageMessage

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

    Parameters

    • message: ImageMessage

      ImageMessage

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

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