Class LocationMessage

Represents a LocationMessage.

Hierarchy

  • LocationMessage

Implements

Constructors

Properties

accuracyInMeters: number

LocationMessage accuracyInMeters.

address: string

LocationMessage address.

comment: string

LocationMessage comment.

contextInfo?: null | IContextInfo

LocationMessage contextInfo.

degreesClockwiseFromMagneticNorth: number

LocationMessage degreesClockwiseFromMagneticNorth.

degreesLatitude: number

LocationMessage degreesLatitude.

degreesLongitude: number

LocationMessage degreesLongitude.

isLive: boolean

LocationMessage isLive.

jpegThumbnail: Uint8Array

LocationMessage jpegThumbnail.

name: string

LocationMessage name.

speedInMps: number

LocationMessage speedInMps.

url: string

LocationMessage url.

Methods

  • Converts this LocationMessage to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

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

    LocationMessage

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

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

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns LocationMessage

    LocationMessage

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

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

    Parameters

    • message: ILocationMessage

      LocationMessage message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

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

    Parameters

    • message: ILocationMessage

      LocationMessage message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

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

    Parameters

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

      Plain object

      • [k: string]: any

    Returns LocationMessage

    LocationMessage

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

    Parameters

    • message: LocationMessage

      LocationMessage

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

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