Skip to main content

GroupType

Struct GroupType 

Source
pub struct GroupType {
Show 15 fields pub available_for_new_person: bool, pub color: String, pub description: Option<String>, pub is_leader_necessary: bool, pub name: String, pub name_plural: String, pub permission_depth: i64, pub posts_enabled: bool, pub shorty: String, pub sort_key: i64, pub id: i64, pub meta: GroupTypeMeta, pub name_plural_translated: String, pub name_translated: String, pub extra: Map<String, Value>,
}
Expand description

A configurable type shared by groups, such as small groups or ministry teams. It defines common settings and the set of membership roles available to those groups. A group references its type through information.groupTypeId; a membership role describes a person’s function within a group, such as leader or participant.

Fields§

§available_for_new_person: bool

Whether eligible groups of this type are offered for membership selection when creating a person in the ChurchTools UI. This does not automatically add the person to a group or grant membership permissions.

§color: String

ChurchTools color token used to display this group type; not a hexadecimal color code. Allowed values: accent, amber, basic, blue, constructive, critical, cyan, destructive, emerald, error, fuchsia, gray, green, indigo, info, lime, magic, orange, pink, purple, red, rose, sky, success, teal, violet, warning, yellow.

§description: Option<String>

Optional explanatory text for this group type. Returned as null when no description is stored.

§is_leader_necessary: bool

Whether groups of this type are expected to retain a leader. The ChurchTools UI uses this setting when removing leaders or deactivating leader roles.

§name: String

Stored singular name of the group type. Use nameTranslated from the response for a localized display name.

§name_plural: String

Stored plural name of the group type. Use namePluralTranslated from the response for a localized display name.

§permission_depth: i64

Number of child-group levels to which permissions configured for this group type are inherited. 0 disables inheritance to child groups; 1 includes direct children. This setting does not itself grant permissions.

§posts_enabled: bool

Whether posts are enabled for groups of this type. Access to individual groups and posts still depends on permissions.

§shorty: String

Short label used to identify this group type in compact displays.

§sort_key: i64

Display order of the group type. Lower values come first; this endpoint sorts equal values by the stored name.

§id: i64

ID of the group type in this ChurchTools installation. Use this ID when referencing the type from a group or role.

§meta: GroupTypeMeta

Creation and last modification timestamps and person IDs for this group type.

§name_plural_translated: String

Plural display name translated into the current language, if a translation exists.

§name_translated: String

Singular display name translated into the current language, if a translation exists.

§extra: Map<String, Value>

Fields not described by the spec, e.g. instance-specific DB fields.

Trait Implementations§

Source§

impl Clone for GroupType

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 Debug for GroupType

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for GroupType

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for GroupType

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for GroupType

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for GroupType

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for GroupType

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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