Skip to main content

TagsResource

Struct TagsResource 

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

client.tags()

Implementations§

Source§

impl<'a> TagsResource<'a>

Source

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);
Source

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);
Source

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);
Source

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)?;
Source

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)?;
Source

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);
Source

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);
}
Source

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);
}
Source

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);

Trait Implementations§

Source§

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

Auto Trait Implementations§

§

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

§

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

§

impl<'a> Freeze for TagsResource<'a>

§

impl<'a> Send for TagsResource<'a>

§

impl<'a> Sync for TagsResource<'a>

§

impl<'a> Unpin for TagsResource<'a>

§

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