ruwuma/ruma-client-api/src/r0/thirdparty/get_location_for_protocol.rs

51 lines
1.4 KiB
Rust

//! [GET /_matrix/client/r0/thirdparty/location/{protocol}](https://matrix.org/docs/spec/client_server/r0.6.0#get-matrix-client-r0-thirdparty-location-protocol)
use std::collections::BTreeMap;
use ruma_api::ruma_api;
use ruma_common::thirdparty::Location;
ruma_api! {
metadata: {
description: "Fetches third party locations for a protocol.",
method: GET,
name: "get_location_for_protocol",
path: "/_matrix/client/r0/thirdparty/location/:protocol",
rate_limited: false,
authentication: AccessToken,
}
request: {
/// The protocol used to communicate to the third party network.
#[ruma_api(path)]
pub protocol: &'a str,
/// One or more custom fields to help identify the third party location.
// The specification is incorrect for this parameter. See matrix-org/matrix-doc#2352.
#[ruma_api(query_map)]
pub fields: BTreeMap<String, String>,
}
response: {
/// List of matched third party locations.
#[ruma_api(body)]
pub locations: Vec<Location>,
}
error: crate::Error
}
impl<'a> Request<'a> {
/// Creates a new `Request` with the given protocol.
pub fn new(protocol: &'a str) -> Self {
Self { protocol, fields: BTreeMap::new() }
}
}
impl Response {
/// Creates a new `Response` with the given locations.
pub fn new(locations: Vec<Location>) -> Self {
Self { locations }
}
}