pub struct TagsResource<'a> { /* private fields */ }Expand description
client.tags()
Implementations§
Source§impl<'a> TagsResource<'a>
impl<'a> TagsResource<'a>
Sourcepub fn attach(
&self,
domain_type: impl Display,
domain_id: impl Display,
tag_id: impl Display,
) -> Result<TagWithCount>
pub fn attach( &self, domain_type: impl Display, domain_id: impl Display, tag_id: impl Display, ) -> Result<TagWithCount>
Attach an existing tag to an object
PUT /tags/{domainType}/{domainId}/{tagId}
Attaches the tag to the target without a request body. Requires domain-specific assignment rights for the target. An existing assignment is reused. A new assignment requires the tag to exist in the specified domain. The response contains the tag with count normally set to 1, not the tag link.
§Example
let tag = client.tags().attach("person", 35, 42)?;
println!("{}", tag.name);Sourcepub fn attach_new(
&self,
domain_type: impl Display,
domain_id: impl Display,
body: &TagAssignmentCreate,
) -> Result<TagWithCount>
pub fn attach_new( &self, domain_type: impl Display, domain_id: impl Display, body: &TagAssignmentCreate, ) -> Result<TagWithCount>
Find or create a tag and attach it to an object
POST /tags/{domainType}/{domainId}
Finds or creates the named tag and attaches it to the target. Requires domain-specific assignment rights: person-tag visibility and person write or group-internal edit rights, group visibility and applicable group-edit rights, song-category edit rights, or appointment edit rights. Separate tag administration rights are not required. An existing assignment is reused. The response contains the tag with count normally set to 1, not the tag link.
§Example
let body = models::TagAssignmentCreate {
name: "Mission".into(),
..Default::default()
};
let tag = client.tags().attach_new("person", 35, &body)?;
println!("{}", tag.name);Sourcepub fn create(
&self,
domain_type: impl Display,
body: &TagCreate,
) -> Result<TagWithCount>
pub fn create( &self, domain_type: impl Display, body: &TagCreate, ) -> Result<TagWithCount>
Create new tag
POST /tags/{domainType}
Creates an unused tag with count set to 0. Requires “edit masterdata” permission in churchdb, churchgroup, or churchservice, or “admin appointment tags” permission in churchcal, depending on the domain. The scheduled purge may remove unused song tags and, when person settings are disabled, unused person tags not referenced by services. It retains group and appointment tags.
§Example
let body = models::TagCreate {
name: "Mission".into(),
..Default::default()
};
let result = client.tags().create("person", &body)?;
println!("{}", result.name);Sourcepub fn delete(&self, tag_id: impl Display) -> Result<()>
pub fn delete(&self, tag_id: impl Display) -> Result<()>
Delete tag
DELETE /tags/{tagId}
Deletes the tag and all its object assignments through the database cascade. Requires “edit masterdata” permission in churchdb, churchgroup, or churchservice, or “admin appointment tags” permission in churchcal, depending on the domain. No dry-run or delete-conflict workflow is available.
§Example
client.tags().delete(42)?;Sourcepub fn detach(
&self,
domain_type: impl Display,
domain_id: impl Display,
tag_id: impl Display,
) -> Result<()>
pub fn detach( &self, domain_type: impl Display, domain_id: impl Display, tag_id: impl Display, ) -> Result<()>
Remove tag from domain object
DELETE /tags/{domainType}/{domainId}/{tagId}
Removes the matching assignment while retaining the tag itself. Requires the same domain-specific assignment rights as adding a tag. A missing assignment succeeds, including when the tag is missing or belongs to another domain. A missing target may still produce 404, depending on its domain policy.
§Example
client.tags().detach("person", 35, 42)?;Sourcepub fn get(&self, tag_id: impl Display) -> Result<TagWithCount>
pub fn get(&self, tag_id: impl Display) -> Result<TagWithCount>
Get tag
GET /tags/{tagId}
Returns one tag. Requires “edit masterdata” permission in churchdb, churchgroup, or churchservice, or “admin appointment tags” permission in churchcal, depending on the domain. Unlike object-specific reads, this endpoint requires administration rights. The tag’s count is normally 1, not a calculated usage count.
§Example
let tag = client.tags().get(42)?;
println!("{}", tag.name);Sourcepub fn list(&self, domain_type: impl Display) -> Result<Vec<TagWithCount>>
pub fn list(&self, domain_type: impl Display) -> Result<Vec<TagWithCount>>
Get tags for domain type
GET /tags/{domainType}
Lists all tags in the domain, including currently unused tags, sorted by name and without per-object visibility checks. Each tag’s count includes links to objects the caller may not be able to view, while meta.count is the number of returned tags.
§Example
for tag in client.tags().list("person")? {
println!("{}", tag.name);
}Sourcepub fn list_for_object(
&self,
domain_type: impl Display,
domain_id: impl Display,
) -> Result<Vec<TagWithCount>>
pub fn list_for_object( &self, domain_type: impl Display, domain_id: impl Display, ) -> Result<Vec<TagWithCount>>
Get tags for domain object
GET /tags/{domainType}/{domainId}
Lists tags attached to this domain object, sorted by name and without pagination. Requires the domain’s tag-view permission for the target. Each tag’s count is normally 1, not its overall usage count, while meta.count is the number of returned tags.
§Example
for for_object in client.tags().list_for_object("person", 35)? {
println!("{}", for_object.name);
}Sourcepub fn update(
&self,
tag_id: impl Display,
body: &TagUpdate,
) -> Result<TagWithCount>
pub fn update( &self, tag_id: impl Display, body: &TagUpdate, ) -> Result<TagWithCount>
Replace tag properties
PUT /tags/{tagId}
Replaces name, description and color while keeping the domain unchanged. Requires “edit masterdata” permission in churchdb, churchgroup, or churchservice, or “admin appointment tags” permission in churchcal, depending on the domain. The uniqueness check reads id instead of the route’s tagId, so retaining the same name may be rejected as a duplicate.
§Example
let body = models::TagUpdate {
name: "Mission".into(),
..Default::default()
};
let result = client.tags().update(42, &body)?;
println!("{}", result.name);