Skip to main content

NotesResource

Struct NotesResource 

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

client.notes()

Implementations§

Source§

impl<'a> NotesResource<'a>

Source

pub fn create( &self, domain_type: impl Display, domain_id: impl Display, body: &NoteCreate, ) -> Result<Note>

Create a note attached to an object

POST /notes/{domainType}/{domainId}

Creates a note linked to the object in the URL. Group notes require an existing group and group-note editing rights. Arrangement notes require “edit songcategory” permission for the parent song’s category. Person notes require person visibility, permission for the selected comment-viewer category, and person write or applicable group-member field-edit permission. Direct creation for follow_up is rejected; use the follow-up note API.

§Example
let body = models::NoteCreate {
    text: "Please follow up next week.".into(),
    ..Default::default()
};
let result = client.notes().create("group", 35, &body)?;
println!("{}", result.id);
Source

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

Delete a note and all its links

DELETE /notes/{noteId}

Deletes the note from every linked business object. Authors can delete their notes without a fresh object-access check. Non-authors need global churchdb write access, and the first stored link must be a person link; person and comment visibility are not checked. Other domains do not allow non-author deletion. DELETE /notes/{domainType}/{domainId}/{noteId} is an equivalent alias whose domain path fields are ignored.

§Example
client.notes().delete(101)?;
Source

pub fn delete_for_object( &self, domain_type: impl Display, domain_id: impl Display, note_id: impl Display, ) -> Result<()>

Delete a note and all its links

DELETE /notes/{domainType}/{domainId}/{noteId}

Deletes the note and all its links, not only the link named in the URL. The handler ignores domainType and domainId. Authors can delete their notes without a fresh domain-access check. Non-authors need global churchdb write access, and the first stored link must be a person link; person and comment visibility are not checked. Other domains do not allow non-author deletion. DELETE /notes/{noteId} calls the same handler.

§Example
client.notes().delete_for_object("group", "42", 101)?;
Source

pub fn get( &self, domain_type: impl Display, domain_id: impl Display, ) -> Result<Vec<Note>>

List visible notes attached to an object

GET /notes/{domainType}/{domainId}

Lists notes linked to the requested object, newest creation date first, without pagination. Group notes require group visibility and a sufficient security level, person notes require comment-viewer permission, arrangement notes require parent-song visibility, and follow-up notes require access to the follow-up. Authors bypass the group security-level or person comment-category filter after the initial domain check. Person notes do not check the requested person’s visibility or existence. Each note includes all links and uses its first stored link for top-level domain fields.

§Example
for note in client.notes().get("group", 35)? {
    println!("{}", note.id);
}
Source

pub fn update( &self, domain_type: impl Display, domain_id: impl Display, note_id: impl Display, body: &NoteUpdate, ) -> Result<Note>

Replace an authored note’s text and visibility

PUT /notes/{domainType}/{domainId}/{noteId}

Updates a note owned by the current author. Only noteId selects the note; domainId does not verify its association. The shared text changes for every linked context, while visibility changes only on the first link matching domainType. No fresh domain or comment-category permission check is performed.

§Example
let body = models::NoteUpdate {
    text: "Please follow up next week.".into(),
    ..Default::default()
};
let result = client.notes().update("group", 35, 101, &body)?;
println!("{}", result.id);

Trait Implementations§

Source§

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

Auto Trait Implementations§

§

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

§

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

§

impl<'a> Freeze for NotesResource<'a>

§

impl<'a> Send for NotesResource<'a>

§

impl<'a> Sync for NotesResource<'a>

§

impl<'a> Unpin for NotesResource<'a>

§

impl<'a> UnsafeUnpin for NotesResource<'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