rename get_message_events to room_messages

master
Devin R 2020-04-12 08:21:23 -04:00
parent 5180f99a0e
commit 0d8702b292
3 changed files with 11 additions and 11 deletions

View File

@ -505,7 +505,7 @@ impl AsyncClient {
/// # Arguments /// # Arguments
/// ///
/// * request - The easiest way to create a `Request` is using the `GetMessageBuilder` /// * request - The easiest way to create a `Request` is using the `GetMessageBuilder`
pub async fn get_message_events<R: Into<get_message_events::Request>>( pub async fn room_messages<R: Into<get_message_events::Request>>(
&mut self, &mut self,
request: R, request: R,
) -> Result<get_message_events::IncomingResponse> { ) -> Result<get_message_events::IncomingResponse> {

View File

@ -51,6 +51,6 @@ pub use async_client::{AsyncClient, AsyncClientConfig, SyncSettings};
pub use base_client::Client; pub use base_client::Client;
pub use event_emitter::EventEmitter; pub use event_emitter::EventEmitter;
pub use models::Room; pub use models::Room;
pub use request_builder::{GetMessageBuilder, RoomBuilder}; pub use request_builder::{RoomBuilder, RoomMessageBuilder};
pub(crate) const VERSION: &str = env!("CARGO_PKG_VERSION"); pub(crate) const VERSION: &str = env!("CARGO_PKG_VERSION");

View File

@ -175,7 +175,7 @@ impl Into<create_room::Request> for RoomBuilder {
/// Create a builder for making get_message_event requests. /// Create a builder for making get_message_event requests.
#[derive(Clone, Default)] #[derive(Clone, Default)]
pub struct GetMessageBuilder { pub struct RoomMessageBuilder {
/// The room to get events from. /// The room to get events from.
room_id: Option<RoomId>, room_id: Option<RoomId>,
/// The token to start returning events from. /// The token to start returning events from.
@ -200,14 +200,14 @@ pub struct GetMessageBuilder {
filter: Option<RoomEventFilter>, filter: Option<RoomEventFilter>,
} }
impl GetMessageBuilder { impl RoomMessageBuilder {
/// Create a `GetMessageBuilder` builder to make a `get_message_events::Request`. /// Create a `RoomMessageBuilder` builder to make a `get_message_events::Request`.
/// ///
/// The `room_id` and `from`` fields **need to be set** to create the request. /// The `room_id` and `from`` fields **need to be set** to create the request.
/// ///
/// # Examples /// # Examples
/// ``` /// ```
/// # use matrix_sdk::{AsyncClient, GetMessageBuilder}; /// # use matrix_sdk::{AsyncClient, RoomMessageBuilder};
/// # use matrix_sdk::api::r0::message::get_message_events::{self, Direction}; /// # use matrix_sdk::api::r0::message::get_message_events::{self, Direction};
/// # use matrix_sdk::identifiers::RoomId; /// # use matrix_sdk::identifiers::RoomId;
/// # use url::Url; /// # use url::Url;
@ -218,12 +218,12 @@ impl GetMessageBuilder {
/// # let last_sync_token = "".to_string();; /// # let last_sync_token = "".to_string();;
/// let mut cli = AsyncClient::new(homeserver, None).unwrap(); /// let mut cli = AsyncClient::new(homeserver, None).unwrap();
/// ///
/// let mut bldr = GetMessageBuilder::new(); /// let mut bldr = RoomMessageBuilder::new();
/// bldr.room_id(room_id) /// bldr.room_id(room_id)
/// .from(last_sync_token) /// .from(last_sync_token)
/// .direction(Direction::Forward); /// .direction(Direction::Forward);
/// ///
/// cli.get_message_events(bldr).await.is_err(); /// cli.room_messages(bldr).await.is_err();
/// # }) /// # })
/// ``` /// ```
pub fn new() -> Self { pub fn new() -> Self {
@ -273,7 +273,7 @@ impl GetMessageBuilder {
} }
} }
impl Into<get_message_events::Request> for GetMessageBuilder { impl Into<get_message_events::Request> for RoomMessageBuilder {
fn into(self) -> get_message_events::Request { fn into(self) -> get_message_events::Request {
get_message_events::Request { get_message_events::Request {
room_id: self.room_id.expect("`room_id` and `from` need to be set"), room_id: self.room_id.expect("`room_id` and `from` need to be set"),
@ -362,7 +362,7 @@ mod test {
device_id: "DEVICEID".to_owned(), device_id: "DEVICEID".to_owned(),
}; };
let mut bldr = GetMessageBuilder::new(); let mut bldr = RoomMessageBuilder::new();
bldr.room_id(RoomId::try_from("!roomid:example.com").unwrap()) bldr.room_id(RoomId::try_from("!roomid:example.com").unwrap())
.from("t47429-4392820_219380_26003_2265".to_string()) .from("t47429-4392820_219380_26003_2265".to_string())
.to("t4357353_219380_26003_2265".to_string()) .to("t4357353_219380_26003_2265".to_string())
@ -372,6 +372,6 @@ mod test {
// .filter(RoomEventFilter::default()); // .filter(RoomEventFilter::default());
let mut cli = AsyncClient::new(homeserver, Some(session)).unwrap(); let mut cli = AsyncClient::new(homeserver, Some(session)).unwrap();
assert!(cli.get_message_events(bldr).await.is_ok()); assert!(cli.room_messages(bldr).await.is_ok());
} }
} }