#[non_exhaustive]pub struct ScheduleBuilder { /* private fields */ }Expand description
A builder for Schedule.
Implementations§
Source§impl ScheduleBuilder
impl ScheduleBuilder
Sourcepub fn end_time(self, input: impl Into<String>) -> Self
pub fn end_time(self, input: impl Into<String>) -> Self
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
Sourcepub fn set_end_time(self, input: Option<String>) -> Self
pub fn set_end_time(self, input: Option<String>) -> Self
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
Sourcepub fn get_end_time(&self) -> &Option<String>
pub fn get_end_time(&self) -> &Option<String>
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
Sourcepub fn event_filter(self, input: CampaignEventFilter) -> Self
pub fn event_filter(self, input: CampaignEventFilter) -> Self
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Sourcepub fn set_event_filter(self, input: Option<CampaignEventFilter>) -> Self
pub fn set_event_filter(self, input: Option<CampaignEventFilter>) -> Self
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Sourcepub fn get_event_filter(&self) -> &Option<CampaignEventFilter>
pub fn get_event_filter(&self) -> &Option<CampaignEventFilter>
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Sourcepub fn frequency(self, input: Frequency) -> Self
pub fn frequency(self, input: Frequency) -> Self
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
Sourcepub fn set_frequency(self, input: Option<Frequency>) -> Self
pub fn set_frequency(self, input: Option<Frequency>) -> Self
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
Sourcepub fn get_frequency(&self) -> &Option<Frequency>
pub fn get_frequency(&self) -> &Option<Frequency>
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
Sourcepub fn is_local_time(self, input: bool) -> Self
pub fn is_local_time(self, input: bool) -> Self
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
Sourcepub fn set_is_local_time(self, input: Option<bool>) -> Self
pub fn set_is_local_time(self, input: Option<bool>) -> Self
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
Sourcepub fn get_is_local_time(&self) -> &Option<bool>
pub fn get_is_local_time(&self) -> &Option<bool>
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
Sourcepub fn quiet_time(self, input: QuietTime) -> Self
pub fn quiet_time(self, input: QuietTime) -> Self
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
-
The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
-
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
-
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
Sourcepub fn set_quiet_time(self, input: Option<QuietTime>) -> Self
pub fn set_quiet_time(self, input: Option<QuietTime>) -> Self
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
-
The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
-
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
-
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
Sourcepub fn get_quiet_time(&self) -> &Option<QuietTime>
pub fn get_quiet_time(&self) -> &Option<QuietTime>
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
-
The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
-
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
-
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
Sourcepub fn start_time(self, input: impl Into<String>) -> Self
pub fn start_time(self, input: impl Into<String>) -> Self
The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
This field is required.Sourcepub fn set_start_time(self, input: Option<String>) -> Self
pub fn set_start_time(self, input: Option<String>) -> Self
The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
Sourcepub fn get_start_time(&self) -> &Option<String>
pub fn get_start_time(&self) -> &Option<String>
The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
Sourcepub fn timezone(self, input: impl Into<String>) -> Self
pub fn timezone(self, input: impl Into<String>) -> Self
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
Sourcepub fn set_timezone(self, input: Option<String>) -> Self
pub fn set_timezone(self, input: Option<String>) -> Self
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
Sourcepub fn get_timezone(&self) -> &Option<String>
pub fn get_timezone(&self) -> &Option<String>
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
Trait Implementations§
Source§impl Clone for ScheduleBuilder
impl Clone for ScheduleBuilder
Source§fn clone(&self) -> ScheduleBuilder
fn clone(&self) -> ScheduleBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ScheduleBuilder
impl Debug for ScheduleBuilder
Source§impl Default for ScheduleBuilder
impl Default for ScheduleBuilder
Source§fn default() -> ScheduleBuilder
fn default() -> ScheduleBuilder
Source§impl PartialEq for ScheduleBuilder
impl PartialEq for ScheduleBuilder
impl StructuralPartialEq for ScheduleBuilder
Auto Trait Implementations§
impl Freeze for ScheduleBuilder
impl RefUnwindSafe for ScheduleBuilder
impl Send for ScheduleBuilder
impl Sync for ScheduleBuilder
impl Unpin for ScheduleBuilder
impl UnwindSafe for ScheduleBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);