Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LocationMessage

Represents a LocationMessage.

Hierarchy

  • LocationMessage

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

accuracyInMeters

accuracyInMeters: number

LocationMessage accuracyInMeters.

address

address: string

LocationMessage address.

comment

comment: string

LocationMessage comment.

Optional contextInfo

contextInfo?: IContextInfo

LocationMessage contextInfo.

degreesClockwiseFromMagneticNorth

degreesClockwiseFromMagneticNorth: number

LocationMessage degreesClockwiseFromMagneticNorth.

degreesLatitude

degreesLatitude: number

LocationMessage degreesLatitude.

degreesLongitude

degreesLongitude: number

LocationMessage degreesLongitude.

isLive

isLive: boolean

LocationMessage isLive.

jpegThumbnail

jpegThumbnail: Uint8Array

LocationMessage jpegThumbnail.

name

name: string

LocationMessage name.

speedInMps

speedInMps: number

LocationMessage speedInMps.

url

url: string

LocationMessage url.

Methods

toJSON

  • toJSON(): {}

Static create

Static decode

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

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    • Optional length: number

    Returns LocationMessage

    LocationMessage

Static decodeDelimited

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

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns LocationMessage

    LocationMessage

Static encode

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

    Parameters

    • message: ILocationMessage

      LocationMessage message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static encodeDelimited

  • 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

    Returns Writer

    Writer

Static fromObject

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

    Parameters

    • object: {}

      Plain object

      • [k: string]: any

    Returns LocationMessage

    LocationMessage

Static toObject

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

    Parameters

    • message: LocationMessage

      LocationMessage

    • Optional options: IConversionOptions

    Returns {}

    Plain object

    • [k: string]: any

Static verify

  • verify(message: {}): string

  • Verifies a LocationMessage message.

    Parameters

    • message: {}

      Plain object to verify

      • [k: string]: any

    Returns string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc