Skip to main content

openlark_workflow/v2/task/
list.rs

1//! 获取任务列表
2//!
3//! docPath: https://open.feishu.cn/document/server-docs/docs/task-v2/task/list
4
5use crate::common::{api_endpoints::TaskApiV2, api_utils::*};
6use crate::v2::task::models::ListTasksResponse;
7use openlark_core::{
8    api::{ApiRequest, ApiResponseTrait, ResponseFormat},
9    config::Config,
10    SDKResult,
11};
12use std::sync::Arc;
13
14/// 获取任务列表请求
15#[derive(Debug, Clone)]
16pub struct ListTasksRequest {
17    /// 配置信息
18    config: Arc<Config>,
19    /// 任务清单 GUID
20    tasklist_guid: Option<String>,
21    /// 分组 GUID
22    section_guid: Option<String>,
23    /// 分页大小
24    page_size: Option<i32>,
25    /// 分页标记
26    page_token: Option<String>,
27    /// 筛选条件(公式字符串)
28    filter: Option<String>,
29    /// 排序条件(JSON 数组)
30    sort: Option<serde_json::Value>,
31    /// 用户类型
32    user_type: Option<String>,
33}
34
35impl ListTasksRequest {
36    pub fn new(config: Arc<Config>) -> Self {
37        Self {
38            config,
39            tasklist_guid: None,
40            section_guid: None,
41            page_size: None,
42            page_token: None,
43            filter: None,
44            sort: None,
45            user_type: None,
46        }
47    }
48
49    /// 设置任务清单 GUID
50    pub fn tasklist_guid(mut self, tasklist_guid: impl Into<String>) -> Self {
51        self.tasklist_guid = Some(tasklist_guid.into());
52        self
53    }
54
55    /// 设置分组 GUID
56    pub fn section_guid(mut self, section_guid: impl Into<String>) -> Self {
57        self.section_guid = Some(section_guid.into());
58        self
59    }
60
61    /// 设置分页大小
62    pub fn page_size(mut self, page_size: i32) -> Self {
63        self.page_size = Some(page_size);
64        self
65    }
66
67    /// 设置分页标记
68    pub fn page_token(mut self, page_token: impl Into<String>) -> Self {
69        self.page_token = Some(page_token.into());
70        self
71    }
72
73    /// 设置筛选条件(公式字符串)
74    pub fn filter(mut self, filter: impl Into<String>) -> Self {
75        self.filter = Some(filter.into());
76        self
77    }
78
79    /// 设置排序条件(JSON 数组)
80    pub fn sort(mut self, sort: serde_json::Value) -> Self {
81        self.sort = Some(sort);
82        self
83    }
84
85    /// 设置用户类型
86    pub fn user_type(mut self, user_type: impl Into<String>) -> Self {
87        self.user_type = Some(user_type.into());
88        self
89    }
90
91    /// 执行请求
92    pub async fn execute(self) -> SDKResult<ListTasksResponse> {
93        self.execute_with_options(openlark_core::req_option::RequestOption::default())
94            .await
95    }
96
97    /// 执行请求(带选项)
98    pub async fn execute_with_options(
99        self,
100        option: openlark_core::req_option::RequestOption,
101    ) -> SDKResult<ListTasksResponse> {
102        let api_endpoint = TaskApiV2::TaskList;
103        let mut request = ApiRequest::<ListTasksResponse>::get(api_endpoint.to_url());
104
105        // 构建查询参数
106        if let Some(tasklist_guid) = &self.tasklist_guid {
107            request = request.query("tasklist_guid", tasklist_guid);
108        }
109        if let Some(section_guid) = &self.section_guid {
110            request = request.query("section_guid", section_guid);
111        }
112        if let Some(page_size) = self.page_size {
113            request = request.query("page_size", page_size.to_string());
114        }
115        if let Some(page_token) = &self.page_token {
116            request = request.query("page_token", page_token);
117        }
118        if let Some(filter) = &self.filter {
119            request = request.query("filter", filter);
120        }
121        if let Some(user_type) = &self.user_type {
122            request = request.query("user_type", user_type);
123        }
124        if let Some(sort) = &self.sort {
125            request = request.query("sort", sort.to_string());
126        }
127
128        let response =
129            openlark_core::http::Transport::request(request, &self.config, Some(option)).await?;
130        extract_response_data(response, "获取任务列表")
131    }
132}
133
134impl ApiResponseTrait for ListTasksResponse {
135    fn data_format() -> ResponseFormat {
136        ResponseFormat::Data
137    }
138}
139
140#[cfg(test)]
141#[allow(unused_imports)]
142mod tests {
143    use std::sync::Arc;
144
145    use super::*;
146
147    #[test]
148    fn test_list_tasks_request() {
149        let config = openlark_core::config::Config::builder()
150            .app_id("test")
151            .app_secret("test")
152            .build();
153
154        let request = ListTasksRequest::new(Arc::new(config))
155            .tasklist_guid("tasklist_123")
156            .page_size(20);
157
158        assert_eq!(request.tasklist_guid, Some("tasklist_123".to_string()));
159        assert_eq!(request.page_size, Some(20));
160    }
161}