Struct PollSession 

pub struct PollSession {
    pub id: u64,
    pub poll_id: Option<u64>,
    pub course_id: Option<u64>,
    pub course_section_id: Option<u64>,
    pub is_published: Option<bool>,
    pub has_public_results: Option<bool>,
    pub results: Option<Value>,
    /* private fields */
}

A session of a Canvas poll (tied to a specific course/section).

Fields

id: u64

poll_id: Option<u64>

course_id: Option<u64>

course_section_id: Option<u64>

is_published: Option<bool>

has_public_results: Option<bool>

results: Option<Value>

Implementations

impl PollSession

pub async fn update(&self, params: PollSessionParams) -> Result<PollSession>

Update this poll session.

Canvas API

PUT /api/v1/polls/:poll_id/poll_sessions/:id

pub async fn delete(&self) -> Result<()>

Delete this poll session.

Canvas API

DELETE /api/v1/polls/:poll_id/poll_sessions/:id

pub async fn open(&self) -> Result<PollSession>

Open this poll session for responses.

Canvas API

GET /api/v1/polls/:poll_id/poll_sessions/:id/open

pub async fn close(&self) -> Result<PollSession>

Close this poll session to responses.

Canvas API

GET /api/v1/polls/:poll_id/poll_sessions/:id/close

pub async fn get_submission(&self, submission_id: u64) -> Result<PollSubmission>

Fetch a single poll submission.

Canvas API

GET /api/v1/polls/:poll_id/poll_sessions/:poll_session_id/poll_submissions/:id

pub async fn create_submission( &self, params: PollSubmissionParams, ) -> Result<PollSubmission>

Create a poll submission for this session.

Canvas API

POST /api/v1/polls/:poll_id/poll_sessions/:poll_session_id/poll_submissions

Trait Implementations

impl Clone for PollSession

fn clone(&self) -> PollSession

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PollSession

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PollSession

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PollSession

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

where __S: Serializer,

Serialize this value into the given Serde serializer.