Skip to main content

CalendarsResource

Struct CalendarsResource 

Source
pub struct CalendarsResource<'a> { /* private fields */ }
Expand description

client.calendars()

Implementations§

Source§

impl<'a> CalendarsResource<'a>

Source

pub fn appointments(&self) -> CalendarsAppointmentsResource<'a>

Source

pub fn meeting_request(&self) -> CalendarsMeetingRequestResource<'a>

Source

pub fn create(&self, body: &CalendarCreate) -> Result<Calendar>

Create a calendar

POST /calendars

Creates a calendar of the chosen type. church requires permission to administer church calendars; group and personal require permission to create or administer their respective category. The creator receives permission to edit appointments in the new calendar. Optional iCalSourceUrl starts an immediate external-feed import.

§Example
let body = models::CalendarCreate {
    name: "Community events".into(),
    sort_key: 10,
    r#type: "church".into(),
    ..Default::default()
};
let result = client.calendars().create(&body)?;
println!("{}", result.name);
Source

pub fn delete(&self, calendar_id: impl Display) -> Result<()>

Delete a calendar and its contents

DELETE /calendars/{calendarId}

Deletes the calendar and its appointment contents, and removes permissions attached to that calendar. Requires edit-category permission for the calendar or ownership as its creator. Deletion can be blocked by references, including agenda templates belonging to the calendar; 409 returns the blocking references.

§Example
client.calendars().delete(42)?;
Source

pub fn get(&self, calendar_id: impl Display) -> Result<Calendar>

Get calendar settings

GET /calendars/{calendarId}

Returns one calendar’s settings. Reading is allowed with view-category or edit-category permission for the calendar, or for its creator. This creator check is additional to the permission filter used by GET /calendars. Use /calendars/{calendarId}/appointments to retrieve occurrences.

§Example
let calendar = client.calendars().get(42)?;
println!("{}", calendar.name);
Source

pub fn list(&self) -> Result<Vec<Calendar>>

List calendars accessible through calendar permissions

GET /calendars

Returns calendars for which the current user has view-category or edit-category permission, ordered by sortKey ascending.

§Example
for calendar in client.calendars().list()? {
    println!("{}", calendar.name);
}
Source

pub fn list_meeting_request_persons( &self, calendar_id: impl Display, ) -> Result<Vec<MeetingRequestCandidate>>

👎Deprecated:

GET /calendars/{calendarId}/meetingrequestpersons is deprecated in the ChurchTools API.

Get candidates for a meeting request (deprecated)

GET /calendars/{calendarId}/meetingrequestpersons

Deprecated alias for /calendars/{calendarId}/meetingrequest/candidates. Returns the same visible candidates.

Use Self::list_meeting_request_persons_with to pass query parameters.

§Example
for meeting_request_person in client.calendars().list_meeting_request_persons(42)? {
    println!("{:?}", meeting_request_person.group_name);
}
Source

pub fn list_meeting_request_persons_with( &self, calendar_id: impl Display, query: &GetCalendarsCalendarIdMeetingrequestpersonsQuery, ) -> Result<Vec<MeetingRequestCandidate>>

👎Deprecated:

GET /calendars/{calendarId}/meetingrequestpersons is deprecated in the ChurchTools API.

Get candidates for a meeting request (deprecated)

Like Self::list_meeting_request_persons, with query parameters.

GET /calendars/{calendarId}/meetingrequestpersons

Deprecated alias for /calendars/{calendarId}/meetingrequest/candidates. Returns the same visible candidates.

Source

pub fn update( &self, calendar_id: impl Display, body: &CalendarUpdate, ) -> Result<Calendar>

Update calendar settings

PUT /calendars/{calendarId}

Replaces editable calendar settings while preserving the calendar type. Requires administration permission for the calendar’s type or ownership as its creator; permission to edit appointments alone is not sufficient. iCalSourceUrl triggers an external calendar import.

§Example
let body = models::CalendarUpdate {
    name: "Community events".into(),
    sort_key: 10,
    ..Default::default()
};
let result = client.calendars().update(42, &body)?;
println!("{}", result.name);

Trait Implementations§

Source§

impl<'a> Clone for CalendarsResource<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for CalendarsResource<'a>

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for CalendarsResource<'a>

§

impl<'a> !UnwindSafe for CalendarsResource<'a>

§

impl<'a> Freeze for CalendarsResource<'a>

§

impl<'a> Send for CalendarsResource<'a>

§

impl<'a> Sync for CalendarsResource<'a>

§

impl<'a> Unpin for CalendarsResource<'a>

§

impl<'a> UnsafeUnpin for CalendarsResource<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more