pub struct NotesResource<'a> { /* private fields */ }Expand description
client.notes()
Implementations§
Source§impl<'a> NotesResource<'a>
impl<'a> NotesResource<'a>
Sourcepub fn create(
&self,
domain_type: impl Display,
domain_id: impl Display,
body: &NoteCreate,
) -> Result<Note>
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);Sourcepub fn delete(&self, note_id: impl Display) -> Result<()>
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)?;Sourcepub fn delete_for_object(
&self,
domain_type: impl Display,
domain_id: impl Display,
note_id: impl Display,
) -> Result<()>
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)?;Sourcepub fn get(
&self,
domain_type: impl Display,
domain_id: impl Display,
) -> Result<Vec<Note>>
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);
}Sourcepub fn update(
&self,
domain_type: impl Display,
domain_id: impl Display,
note_id: impl Display,
body: &NoteUpdate,
) -> Result<Note>
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);