activitypub-models/src/models/place/Place.types.ts

61 wiersze
1.7 KiB
TypeScript

import {APObjectFields} from "../apObject/APObject.types";
import {
AccuracyValue,
AltitudeValue,
LatitudeValue,
LongitudeValue,
RadiusValue,
UnitsValue
} from "../../common/types";
export interface PlaceFields extends APObjectFields {
/**
* Indicates the accuracy of position coordinates on a Place objects.
* Expressed in properties of percentage. e.g. "94.0" means "94.0% accurate".
*
* {@link https://www.w3.org/ns/activitystreams#accuracy Docs}
*/
accuracy?: AccuracyValue;
/**
* Indicates the altitude of a place. The measurement units is indicated using the "units" property.
* If units is not specified, the default is assumed to be "m" indicating "meters".
*
* {@link https://www.w3.org/ns/activitystreams#altitude Docs}
*/
altitude?: AltitudeValue;
/**
* The latitude of a place
*
* {@link https://www.w3.org/ns/activitystreams#latitude Docs}
*/
latitude?: LatitudeValue;
/**
* The longitude of a place
*
* {@link https://www.w3.org/ns/activitystreams#longitude Docs}
*/
longitude?: LongitudeValue;
/**
* The radius from the given latitude and longitude for a Place.
* The units are expressed by the "units" property. If units is not specified,
* the default is assumed to be "m" indicating "meters".
*
* {@link https://www.w3.org/ns/activitystreams#radius Docs}
*/
radius?: RadiusValue;
/**
* Specifies the measurement units for the radius and altitude properties
* on a Place object. If not specified, the default is assumed to be "m" for "meters".
*
* {@link https://www.w3.org/ns/activitystreams#units Docs}
*/
units?: UnitsValue;
}