Location Class
extends BaseRepresents a point on the map
Properties
client: Client
heading: number
horizontalAccuracy: number
latitude: number
livePeriod: number
longtitude: number
proximityAlertRadius: number
Methods
{ "id": 1455, "name": "Location", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Represents a point on the map" } ] }, "children": [ { "id": 1456, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/tgkit/src/structures/Location.ts", "line": 30, "character": 1 } ], "signatures": [ { "id": 1457, "name": "new Location", "variant": "signature", "kind": 16384, "flags": {}, "sources": [ { "fileName": "packages/tgkit/src/structures/Location.ts", "line": 30, "character": 1 } ], "parameters": [ { "id": 1458, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1, "name": "Client", "package": "tgkit", "qualifiedName": "default" } }, { "id": 1459, "name": "data", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "reference", "target": 1455, "name": "Location", "package": "tgkit", "qualifiedName": "default" }, "overwrites": { "type": "reference", "target": -1, "name": "Base.constructor" } } ], "overwrites": { "type": "reference", "target": -1, "name": "Base.constructor" } }, { "id": 1466, "name": "client", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/tgkit/src/structures/Base.ts", "line": 4, "character": 1 } ], "type": { "type": "reference", "target": 1, "name": "Client", "package": "tgkit", "qualifiedName": "default" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "Base.client" } }, { "id": 1464, "name": "heading", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The direction in which user is moving, in degrees; 1-360. For active live locations only." } ] }, "sources": [ { "fileName": "packages/tgkit/src/structures/Location.ts", "line": 22, "character": 1 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1462, "name": "horizontalAccuracy", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The radius of uncertainty for the location, measured in meters; 0-1500" } ] }, "sources": [ { "fileName": "packages/tgkit/src/structures/Location.ts", "line": 13, "character": 1 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1461, "name": "latitude", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Latitude as defined by sender" } ] }, "sources": [ { "fileName": "packages/tgkit/src/structures/Location.ts", "line": 10, "character": 1 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1463, "name": "livePeriod", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Time relative to the message sending date, during which the location can be updated; in seconds.\nFor active live locations only." } ] }, "sources": [ { "fileName": "packages/tgkit/src/structures/Location.ts", "line": 19, "character": 1 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1460, "name": "longtitude", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Longitude as defined by sender" } ] }, "sources": [ { "fileName": "packages/tgkit/src/structures/Location.ts", "line": 7, "character": 1 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1465, "name": "proximityAlertRadius", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Maximum distance for proximity alerts about approaching another chat member, in meters.\nFor sent live locations only." } ] }, "sources": [ { "fileName": "packages/tgkit/src/structures/Location.ts", "line": 28, "character": 1 } ], "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Constructors", "children": [ 1456 ] }, { "title": "Properties", "children": [ 1466, 1464, 1462, 1461, 1463, 1460, 1465 ] } ], "sources": [ { "fileName": "packages/tgkit/src/structures/Location.ts", "line": 5, "character": 21 } ], "extendedTypes": [ { "type": "reference", "target": { "sourceFileName": "packages/tgkit/src/structures/Base.ts", "qualifiedName": "default" }, "name": "default", "package": "tgkit" } ] }