yang_base/definition/ui/
action.rs1use super::hints::{ActionInteraction, ActionPlacement, AvailabilityState};
4use schemars::JsonSchema;
5use serde::{Deserialize, Serialize};
6
7#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
9pub struct ActionConfirmation {
10 pub title: String,
12 pub message: String,
14}
15
16impl ActionConfirmation {
17 pub fn new(title: impl Into<String>, message: impl Into<String>) -> Self {
19 Self {
20 title: title.into(),
21 message: message.into(),
22 }
23 }
24}
25
26#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
28pub struct AvailabilityHint {
29 pub state: AvailabilityState,
31 pub reason: String,
33}
34
35impl AvailabilityHint {
36 pub fn disabled(reason: impl Into<String>) -> Self {
38 Self {
39 state: AvailabilityState::Disabled,
40 reason: reason.into(),
41 }
42 }
43
44 pub fn hidden(reason: impl Into<String>) -> Self {
46 Self {
47 state: AvailabilityState::Hidden,
48 reason: reason.into(),
49 }
50 }
51}
52
53#[derive(Debug, Clone, PartialEq, Eq)]
58pub struct ActionPresentationSpec {
59 pub placement: ActionPlacement,
61 pub interaction: ActionInteraction,
63 pub confirmation: Option<ActionConfirmation>,
65 pub availability: Option<AvailabilityHint>,
67 pub view_id: Option<String>,
69 pub record_parameter: Option<String>,
71}
72
73impl ActionPresentationSpec {
74 pub fn new(placement: ActionPlacement, interaction: ActionInteraction) -> Self {
76 Self {
77 placement,
78 interaction,
79 confirmation: None,
80 availability: None,
81 view_id: None,
82 record_parameter: None,
83 }
84 }
85
86 #[must_use]
88 pub fn confirmation(mut self, confirmation: ActionConfirmation) -> Self {
89 self.confirmation = Some(confirmation);
90 self
91 }
92
93 #[must_use]
95 pub fn availability(mut self, availability: AvailabilityHint) -> Self {
96 self.availability = Some(availability);
97 self
98 }
99
100 #[must_use]
102 pub fn view_id(mut self, view_id: impl Into<String>) -> Self {
103 self.view_id = Some(view_id.into());
104 self
105 }
106
107 #[must_use]
109 pub fn record_parameter(mut self, parameter: impl Into<String>) -> Self {
110 self.record_parameter = Some(parameter.into());
111 self
112 }
113}
114
115#[derive(Debug, Clone, PartialEq, Eq, Serialize, JsonSchema)]
117pub struct ActionPresentationSchema {
118 pub operation_id: String,
120 pub title: String,
122 pub placement: ActionPlacement,
124 pub interaction: ActionInteraction,
126 pub confirmation: Option<ActionConfirmation>,
128 pub availability: Option<AvailabilityHint>,
130 pub view_id: Option<String>,
132 pub record_parameter: Option<String>,
134}