forked from twilight-rs/twilight
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(model, http): Add support for guild onboarding (twilight-rs#2130)
Implements guild onboarding ref: discord/discord-api-docs#5915 This adds the following structures: Onboarding OnboardingPrompt OnboardingPromptOption OnboardingPromptType As well as supporting the http GET for retrieving guild onboarding information. Closes twilight-rs#2134
- Loading branch information
1 parent
899fefb
commit 36f8377
Showing
12 changed files
with
490 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| use std::future::IntoFuture; | ||
|
|
||
| use twilight_model::{ | ||
| guild::onboarding::Onboarding, | ||
| id::{marker::GuildMarker, Id}, | ||
| }; | ||
|
|
||
| use crate::{ | ||
| request::{Request, TryIntoRequest}, | ||
| response::ResponseFuture, | ||
| routing::Route, | ||
| Client, Error, Response, | ||
| }; | ||
|
|
||
| /// Get the onboarding information for a guild. | ||
| /// | ||
| /// # Examples | ||
| /// | ||
| /// ```no_run | ||
| /// use twilight_http::Client; | ||
| /// use twilight_model::id::Id; | ||
| /// | ||
| /// # #[tokio::main] | ||
| /// async fn main() -> Result<(), Box<dyn std::error::Error>> { | ||
| /// let client = Client::new("token".to_owned()); | ||
| /// | ||
| /// let guild_id = Id::new(101); | ||
| /// let onboarding = client.guild_onboarding(guild_id).await?.model().await?; | ||
| /// | ||
| /// for prompt in onboarding.prompts { | ||
| /// println!("Prompt: {}", prompt.title); | ||
| /// } | ||
| /// # Ok(()) } | ||
| /// ``` | ||
| pub struct GetGuildOnboarding<'a> { | ||
| guild_id: Id<GuildMarker>, | ||
| http: &'a Client, | ||
| } | ||
|
|
||
| impl<'a> GetGuildOnboarding<'a> { | ||
| pub(crate) const fn new(http: &'a Client, guild_id: Id<GuildMarker>) -> Self { | ||
| Self { guild_id, http } | ||
| } | ||
| } | ||
|
|
||
| impl IntoFuture for GetGuildOnboarding<'_> { | ||
| type Output = Result<Response<Onboarding>, Error>; | ||
|
|
||
| type IntoFuture = ResponseFuture<Onboarding>; | ||
|
|
||
| fn into_future(self) -> Self::IntoFuture { | ||
| let http = self.http; | ||
|
|
||
| match self.try_into_request() { | ||
| Ok(request) => http.request(request), | ||
| Err(source) => ResponseFuture::error(source), | ||
| } | ||
| } | ||
| } | ||
|
|
||
| impl TryIntoRequest for GetGuildOnboarding<'_> { | ||
| fn try_into_request(self) -> Result<Request, Error> { | ||
| let request = Request::from_route(&Route::GetGuildOnboarding { | ||
| guild_id: self.guild_id.get(), | ||
| }); | ||
|
|
||
| Ok(request) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| //! Types for guild onboarding. | ||
|
|
||
| mod option; | ||
| mod prompt; | ||
| mod prompt_type; | ||
|
|
||
| use crate::id::{ | ||
| marker::{ChannelMarker, GuildMarker}, | ||
| Id, | ||
| }; | ||
| use serde::{Deserialize, Serialize}; | ||
|
|
||
| pub use self::{ | ||
| option::OnboardingPromptOption, prompt::OnboardingPrompt, prompt_type::OnboardingPromptType, | ||
| }; | ||
|
|
||
| /// The onboarding data for a guild. | ||
| #[derive(Clone, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)] | ||
| pub struct Onboarding { | ||
| /// Channel IDs that new members get opted into automatically | ||
| pub default_channel_ids: Vec<Id<ChannelMarker>>, | ||
| /// Whether the guild has enabled onboarding. | ||
| pub enabled: bool, | ||
| /// ID of the guild this onboarding is a part of. | ||
| pub guild_id: Id<GuildMarker>, | ||
| /// Array of [`OnboardingPrompt`]s for the guild onboarding flow. | ||
| pub prompts: Vec<OnboardingPrompt>, | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod tests { | ||
| use super::Onboarding; | ||
| use crate::id::Id; | ||
| use serde_test::Token; | ||
|
|
||
| #[test] | ||
| fn onboarding() { | ||
| let onboarding = Onboarding { | ||
| default_channel_ids: Vec::new(), | ||
| enabled: true, | ||
| guild_id: Id::new(123_456_789), | ||
| prompts: Vec::new(), | ||
| }; | ||
|
|
||
| serde_test::assert_tokens( | ||
| &onboarding, | ||
| &[ | ||
| Token::Struct { | ||
| name: "Onboarding", | ||
| len: 4, | ||
| }, | ||
| Token::Str("default_channel_ids"), | ||
| Token::Seq { len: Some(0) }, | ||
| Token::SeqEnd, | ||
| Token::Str("enabled"), | ||
| Token::Bool(true), | ||
| Token::Str("guild_id"), | ||
| Token::NewtypeStruct { name: "Id" }, | ||
| Token::Str("123456789"), | ||
| Token::Str("prompts"), | ||
| Token::Seq { len: Some(0) }, | ||
| Token::SeqEnd, | ||
| Token::StructEnd, | ||
| ], | ||
| ) | ||
| } | ||
| } |
Oops, something went wrong.