Class LocationMessage

constructor

• new LocationMessage(properties?): LocationMessage

• Constructs a new LocationMessage.

  Parameters

  • Optional properties: ILocationMessage

    Properties to set

  Returns LocationMessage

Optional accuracyInMeters

Optional address

Optional comment

Optional contextInfo

Optional degreesClockwiseFromMagneticNorth

Optional degreesLatitude

Optional degreesLongitude

Optional isLive

Optional jpegThumbnail

Optional name

Optional speedInMps

Optional url

toJSON

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

• Converts this LocationMessage to JSON.

  Returns {
      [k: string]: any;
  }

  JSON object

  • [k: string]: any

Static create

• create(properties?): LocationMessage

• Creates a new LocationMessage instance using the specified properties.

  Parameters

  • Optional properties: ILocationMessage

    Properties to set

  Returns LocationMessage

  LocationMessage instance

Static decode

• decode(reader, length?): LocationMessage

• 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

Static decodeDelimited

• decodeDelimited(reader): LocationMessage

• 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

Static encode

• encode(message, writer?): Writer

• 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

Static encodeDelimited

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

Static fromObject

• fromObject(object): LocationMessage

• 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

Static getTypeUrl

• getTypeUrl(typeUrlPrefix?): string

• Gets the default type url for LocationMessage

  Parameters

  • Optional typeUrlPrefix: string

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

  Returns string

  The default type url

Static toObject

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

• 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

Static verify

• verify(message): null | string

• 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