class Hamilton::Types::Location

Hamilton::Types::Location
Reference
Object

Overview

This object represents a point on the map.

Included Modules

Hamilton::Types::Common
JSON::Serializable

Defined in:

types/location.cr

Constructors

.new(pull : JSON::PullParser)
.new(params)
.new(*, __pull_for_json_serializable pull : JSON::PullParser)
.new(**params)

Instance Method Summary

#heading : Int32 | Nil
The direction in which user is moving, in degrees; 1-360.
#heading=(heading : Int32 | Nil)
The direction in which user is moving, in degrees; 1-360.
#horizontal_accuracy : Float32 | Nil
The radius of uncertainty for the location, measured in meters; 0-1500.
#horizontal_accuracy=(horizontal_accuracy : Float32 | Nil)
The radius of uncertainty for the location, measured in meters; 0-1500.
#latitude : Float32
Latitude as defined by the sender.
#latitude=(latitude : Float32)
Latitude as defined by the sender.
#live_period : Int32 | Nil
Time relative to the message sending date, during which the location can be updated; in seconds.
#live_period=(live_period : Int32 | Nil)
Time relative to the message sending date, during which the location can be updated; in seconds.
#longitude : Float32
Longitude as defined by the sender.
#longitude=(longitude : Float32)
Longitude as defined by the sender.
#non_nil_fields : Array(String)
List of available non-nil fields.
#non_nil_fields=(non_nil_fields : Array(String))
List of available non-nil fields.
#proximity_alert_radius : Int32 | Nil
The maximum distance for proximity alerts about approaching another chat member, in meters.
#proximity_alert_radius=(proximity_alert_radius : Int32 | Nil)
The maximum distance for proximity alerts about approaching another chat member, in meters.

Instance methods inherited from class `Reference`

Instance methods inherited from class `Object`

Constructor Detail

def self.new(pull : JSON::PullParser) #

def self.new(params) #

def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

def self.new(**params) #

Instance Method Detail

def heading : Int32 | Nil #

The direction in which user is moving, in degrees; 1-360. For active live locations only.

def heading=(heading : Int32 | Nil) #

The direction in which user is moving, in degrees; 1-360. For active live locations only.

def horizontal_accuracy : Float32 | Nil #

The radius of uncertainty for the location, measured in meters; 0-1500.

def horizontal_accuracy=(horizontal_accuracy : Float32 | Nil) #

The radius of uncertainty for the location, measured in meters; 0-1500.

def latitude : Float32 #

Latitude as defined by the sender.

def latitude=(latitude : Float32) #

Latitude as defined by the sender.

def live_period : Int32 | Nil #

Time relative to the message sending date, during which the location can be updated; in seconds. For active live locations only.

def live_period=(live_period : Int32 | Nil) #

Time relative to the message sending date, during which the location can be updated; in seconds. For active live locations only.

def longitude : Float32 #

Longitude as defined by the sender.

def longitude=(longitude : Float32) #

Longitude as defined by the sender.

def non_nil_fields : Array(String) #

List of available non-nil fields.

def non_nil_fields=(non_nil_fields : Array(String)) #

List of available non-nil fields.

def proximity_alert_radius : Int32 | Nil #

The maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only.

def proximity_alert_radius=(proximity_alert_radius : Int32 | Nil) #