Skip to main content

SubscriptionsResource

Struct SubscriptionsResource 

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

client.subscriptions()

Implementations§

Source§

impl<'a> SubscriptionsResource<'a>

Source

pub fn delete( &self, person_id: impl Display, subject: impl Display, subject_identifier: impl Display, ) -> Result<()>

Delete an explicit subscription override

DELETE /subscriptions/{personId}/{subject}/{subjectIdentifier}

Subscriptions control notifications for a subject (for example a group, post or resource). Explicit settings override implicit defaults for the same person, subject and identifier. Only the current person may access their own subscriptions. Removes the stored override, not the implicit default. If no explicit row exists, returns 404 even when GET returns an implicit subscription. Removing an inactive override can enable notifications again through the default; use PUT with isActive=false to opt out. Legacy subjects meetingrequests and servicerequests are normalized to meetingrequest and servicerequest; identifier 0 is normalized to root for both. List responses additionally include a legacy alias for each canonical root result. These aliases are compatibility copies, not separate subscriptions.

§Example
client.subscriptions().delete(42, "group", "root")?;
Source

pub fn get( &self, person_id: impl Display, subject: impl Display, subject_identifier: impl Display, ) -> Result<Value>

Get one effective subscription

GET /subscriptions/{personId}/{subject}/{subjectIdentifier}

Subscriptions control notifications for a subject (for example a group, post or resource). Explicit settings override implicit defaults for the same person, subject and identifier. Only the current person may access their own subscriptions. Read results include active and inactive subscriptions, after subject-specific eligibility filtering: meeting/service requests require a registered push-capable device, email summaries require an eligible recipient, and resources require administration or booking-administration rights. A stored override can therefore be absent from a read response. Legacy subjects meetingrequests and servicerequests are normalized to meetingrequest and servicerequest; identifier 0 is normalized to root for both. List responses additionally include a legacy alias for each canonical root result. These aliases are compatibility copies, not separate subscriptions. This endpoint returns one object using the canonical subject and identifier, without a compatibility copy. It returns 404 when no eligible effective subscription exists and 422 if more than one result remains.

§Example
let result = client.subscriptions().get(42, "group", "root")?;
println!("{:?}", result);
Source

pub fn list(&self, person_id: impl Display) -> Result<Vec<Value>>

List the current person’s effective subscriptions

GET /subscriptions/{personId}

Subscriptions control notifications for a subject (for example a group, post or resource). Explicit settings override implicit defaults for the same person, subject and identifier. Only the current person may access their own subscriptions. Read results include active and inactive subscriptions, after subject-specific eligibility filtering: meeting/service requests require a registered push-capable device, email summaries require an eligible recipient, and resources require administration or booking-administration rights. A stored override can therefore be absent from a read response. Results are not paginated; meta.count includes compatibility aliases. Legacy subjects meetingrequests and servicerequests are normalized to meetingrequest and servicerequest; identifier 0 is normalized to root for both. List responses additionally include a legacy alias for each canonical root result. These aliases are compatibility copies, not separate subscriptions.

§Example
for subscription in client.subscriptions().list(42)? {
    println!("{:?}", subscription);
}
Source

pub fn list_for_subject( &self, person_id: impl Display, subject: impl Display, ) -> Result<Vec<Value>>

List effective subscriptions for one subject

GET /subscriptions/{personId}/{subject}

Subscriptions control notifications for a subject (for example a group, post or resource). Explicit settings override implicit defaults for the same person, subject and identifier. Only the current person may access their own subscriptions. Read results include active and inactive subscriptions, after subject-specific eligibility filtering: meeting/service requests require a registered push-capable device, email summaries require an eligible recipient, and resources require administration or booking-administration rights. A stored override can therefore be absent from a read response. Results are not paginated; meta.count includes compatibility aliases. Legacy subjects meetingrequests and servicerequests are normalized to meetingrequest and servicerequest; identifier 0 is normalized to root for both. List responses additionally include a legacy alias for each canonical root result. These aliases are compatibility copies, not separate subscriptions.

§Example
for for_subject in client.subscriptions().list_for_subject(42, "group")? {
    println!("{:?}", for_subject);
}
Source

pub fn update( &self, person_id: impl Display, subject: impl Display, subject_identifier: impl Display, body: &SubscriptionUpdate, ) -> Result<Value>

Create or replace an explicit subscription override

PUT /subscriptions/{personId}/{subject}/{subjectIdentifier}

Subscriptions control notifications for a subject (for example a group, post or resource). Explicit settings override implicit defaults for the same person, subject and identifier. Only the current person may access their own subscriptions. Creates or updates a stored override and returns that single object before read-side eligibility filtering. Omitted isActive becomes true and omitted options clears existing options to null. For post_summary, options.filter and 1–7 distinct options.weekdays are required, and the current person needs a receiving email address. Use identifier 0 for post_summary. Legacy subjects meetingrequests and servicerequests are normalized to meetingrequest and servicerequest; identifier 0 is normalized to root for both. List responses additionally include a legacy alias for each canonical root result. These aliases are compatibility copies, not separate subscriptions.

§Example
let body = models::SubscriptionUpdate {
    is_active: Some(true),
    ..Default::default()
};
let result = client.subscriptions().update(42, "group", "root", &body)?;
println!("{:?}", result);

Trait Implementations§

Source§

impl<'a> Clone for SubscriptionsResource<'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 SubscriptionsResource<'a>

Auto Trait Implementations§

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