Class ImageMessage

constructor

• new ImageMessage(properties?): ImageMessage

• Constructs a new ImageMessage.

  Parameters

  • Optional properties: IImageMessage

    Properties to set

  Returns ImageMessage

annotations

caption

Optional contextInfo

directPath

experimentGroupId

fileEncSha256

fileLength

fileSha256

firstScanLength

firstScanSidecar

height

interactiveAnnotations

jpegThumbnail

mediaKey

mediaKeyTimestamp

midQualityFileEncSha256

midQualityFileSha256

mimetype

scanLengths

scansSidecar

staticUrl

thumbnailDirectPath

thumbnailEncSha256

thumbnailSha256

url

viewOnce

width

toJSON

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

• Converts this ImageMessage to JSON.

  Returns {
      [k: string]: any;
  }

  JSON object

  • [k: string]: any

Static create

• create(properties?): ImageMessage

• Creates a new ImageMessage instance using the specified properties.

  Parameters

  • Optional properties: IImageMessage

    Properties to set

  Returns ImageMessage

  ImageMessage instance

Static decode

• decode(reader, length?): ImageMessage

• 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

Static decodeDelimited

• decodeDelimited(reader): ImageMessage

• 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

Static encode

• encode(message, writer?): Writer

• 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

Static encodeDelimited

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

Static fromObject

• fromObject(object): ImageMessage

• 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

Static toObject

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

• 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

Static verify

• verify(message): null | string

• 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