Class LiveLocationMessage

Represents a LiveLocationMessage.

Hierarchy

  • LiveLocationMessage

Implements

Constructors

Properties

accuracyInMeters: number

LiveLocationMessage accuracyInMeters.

caption: string

LiveLocationMessage caption.

contextInfo?: null | IContextInfo

LiveLocationMessage contextInfo.

degreesClockwiseFromMagneticNorth: number

LiveLocationMessage degreesClockwiseFromMagneticNorth.

degreesLatitude: number

LiveLocationMessage degreesLatitude.

degreesLongitude: number

LiveLocationMessage degreesLongitude.

jpegThumbnail: Uint8Array

LiveLocationMessage jpegThumbnail.

sequenceNumber: number | Long

LiveLocationMessage sequenceNumber.

speedInMps: number

LiveLocationMessage speedInMps.

timeOffset: number

LiveLocationMessage timeOffset.

Methods

  • Converts this LiveLocationMessage to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

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

    LiveLocationMessage

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

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

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns LiveLocationMessage

    LiveLocationMessage

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

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

    Parameters

    • message: ILiveLocationMessage

      LiveLocationMessage message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

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

    Parameters

    • message: ILiveLocationMessage

      LiveLocationMessage message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

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

    Parameters

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

      Plain object

      • [k: string]: any

    Returns LiveLocationMessage

    LiveLocationMessage

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

    Parameters

    • message: LiveLocationMessage

      LiveLocationMessage

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

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