Struct twitch_api::helix::polls::create_poll::CreatePollBody

#[non_exhaustive]
pub struct CreatePollBody<'a> {
    pub broadcaster_id: Cow<'a, UserIdRef>,
    pub title: Cow<'a, str>,
    pub duration: i64,
    pub choices: Cow<'a, [NewPollChoice<'a>]>,
    pub bits_voting_enabled: Option<bool>,
    pub bits_per_vote: Option<i64>,
    pub channel_points_voting_enabled: Option<bool>,
    pub channel_points_per_vote: Option<i64>,
}

Available on crate feature helix only.

Body Parameters for Create Poll

create-poll

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

broadcaster_id: Cow<'a, UserIdRef>

The broadcaster running polls. Provided broadcaster_id must match the user_id in the user OAuth token.

title: Cow<'a, str>

Question displayed for the poll. Maximum: 60 characters.

duration: i64

Total duration for the poll (in seconds). Minimum: 15. Maximum: 1800.

choices: Cow<'a, [NewPollChoice<'a>]>

Array of the poll choices. Minimum: 2 choices. Maximum: 5 choices.

bits_voting_enabled: Option<bool>

👎Deprecated since 0.7.0: bit options for polls has been removed

Indicates if Bits can be used for voting. Default: false

bits_per_vote: Option<i64>

👎Deprecated since 0.7.0: bit options for polls has been removed

Number of Bits required to vote once with Bits. Minimum: 0. Maximum: 10000.

channel_points_voting_enabled: Option<bool>

Indicates if Channel Points can be used for voting. Default: false

channel_points_per_vote: Option<i64>

Number of Channel Points required to vote once with Channel Points. Minimum: 0. Maximum: 1000000.

Implementations

impl<'a> CreatePollBody<'a>

pub fn builder() -> CreatePollBodyBuilder<'a, ((), (), (), (), (), (), (), ())>

Create a builder for building CreatePollBody. On the builder, call .broadcaster_id(...), .title(...), .duration(...), .choices(...)(optional), .bits_voting_enabled(...)(optional), .bits_per_vote(...)(optional), .channel_points_voting_enabled(...)(optional), .channel_points_per_vote(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of CreatePollBody.

impl<'a> CreatePollBody<'a>

pub fn channel_points_voting_enabled(self, enabled: bool) -> Self

Set if Channel Points voting is enabled

pub fn channel_points_per_vote(self, points: i64) -> Self

Channel points per vote

pub fn new(
    broadcaster_id: impl IntoCow<'a, UserIdRef> + 'a,
    title: impl Into<Cow<'a, str>>,
    duration: i64,
    choices: impl Into<Cow<'a, [NewPollChoice<'a>]>>
) -> Self

Poll settings

Trait Implementations

impl<'a> Clone for CreatePollBody<'a>

fn clone(&self) -> CreatePollBody<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for CreatePollBody<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for CreatePollBody<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> PartialEq<CreatePollBody<'a>> for CreatePollBody<'a>

fn eq(&self, other: &CreatePollBody<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Serialize for CreatePollBody<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Eq for CreatePollBody<'a>

impl<'a> StructuralEq for CreatePollBody<'a>

impl<'a> StructuralPartialEq for CreatePollBody<'a>