Class ImageMessage

Represents an ImageMessage.

Hierarchy

  • ImageMessage

Implements

Constructors

constructor

Properties

accessibilityLabel? annotations caption? contextInfo? directPath? experimentGroupId? fileEncSha256? fileLength? fileSha256? firstScanLength? firstScanSidecar? height? imageSourceType? interactiveAnnotations jpegThumbnail? mediaKey? mediaKeyTimestamp? midQualityFileEncSha256? midQualityFileSha256? mimetype? scanLengths scansSidecar? staticUrl? thumbnailDirectPath? thumbnailEncSha256? thumbnailSha256? url? viewOnce? width?

Methods

toJSON create decode decodeDelimited encode encodeDelimited fromObject getTypeUrl toObject verify

Constructors

constructor

Properties

Optional accessibilityLabel

accessibilityLabel?: null | string

ImageMessage accessibilityLabel.

annotations

annotations: IInteractiveAnnotation[]

ImageMessage annotations.

Optional caption

caption?: null | string

ImageMessage caption.

Optional contextInfo

contextInfo?: null | IContextInfo

ImageMessage contextInfo.

Optional directPath

directPath?: null | string

ImageMessage directPath.

Optional experimentGroupId

experimentGroupId?: null | number

ImageMessage experimentGroupId.

Optional fileEncSha256

fileEncSha256?: null | Uint8Array

ImageMessage fileEncSha256.

Optional fileLength

fileLength?: null | number | Long

ImageMessage fileLength.

Optional fileSha256

fileSha256?: null | Uint8Array

ImageMessage fileSha256.

Optional firstScanLength

firstScanLength?: null | number

ImageMessage firstScanLength.

Optional firstScanSidecar

firstScanSidecar?: null | Uint8Array

ImageMessage firstScanSidecar.

Optional height

height?: null | number

ImageMessage height.

Optional imageSourceType

imageSourceType?: null | ImageSourceType

ImageMessage imageSourceType.

interactiveAnnotations

interactiveAnnotations: IInteractiveAnnotation[]

ImageMessage interactiveAnnotations.

Optional jpegThumbnail

jpegThumbnail?: null | Uint8Array

ImageMessage jpegThumbnail.

Optional mediaKey

mediaKey?: null | Uint8Array

ImageMessage mediaKey.

Optional mediaKeyTimestamp

mediaKeyTimestamp?: null | number | Long

ImageMessage mediaKeyTimestamp.

Optional midQualityFileEncSha256

midQualityFileEncSha256?: null | Uint8Array

ImageMessage midQualityFileEncSha256.

Optional midQualityFileSha256

midQualityFileSha256?: null | Uint8Array

ImageMessage midQualityFileSha256.

Optional mimetype

mimetype?: null | string

ImageMessage mimetype.

scanLengths

scanLengths: number[]

ImageMessage scanLengths.

Optional scansSidecar

scansSidecar?: null | Uint8Array

ImageMessage scansSidecar.

Optional staticUrl

staticUrl?: null | string

ImageMessage staticUrl.

Optional thumbnailDirectPath

thumbnailDirectPath?: null | string

ImageMessage thumbnailDirectPath.

Optional thumbnailEncSha256

thumbnailEncSha256?: null | Uint8Array

ImageMessage thumbnailEncSha256.

Optional thumbnailSha256

thumbnailSha256?: null | Uint8Array

ImageMessage thumbnailSha256.

Optional url

url?: null | string

ImageMessage url.

Optional viewOnce

viewOnce?: null | boolean

ImageMessage viewOnce.

Optional width

width?: null | number

ImageMessage width.

Methods

toJSON

  • Converts this ImageMessage to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

    • [k: string]: any

Static create

Static decode

  • 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

  • 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

  • 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

  • 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

  • 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 getTypeUrl

  • Gets the default type url for ImageMessage

    Parameters

    • Optional typeUrlPrefix: string

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

    Returns string

    The default type url

Static toObject

  • 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

  • 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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc