Skip to main content

GroupRole

Struct GroupRole 

Source
pub struct GroupRole {
Show 20 fields pub group_type_id: i64, pub grow_path_id: Option<i64>, pub is_default: bool, pub is_hidden: bool, pub is_leader: Option<bool>, pub name: String, pub shorty: String, pub sort_key: i64, pub type: String, pub id: i64, pub name_translated: String, pub can_read_chat: bool, pub can_write_chat: bool, pub counts_towards_seats: bool, pub force_two_factor_auth: bool, pub group_type_role_id: i64, pub html_template_ids: Option<Vec<i64>>, pub is_active: bool, pub receive_qr_code: bool, pub extra: Map<String, Value>,
}
Expand description

A shared group-type role combined with its settings for one concrete group. id identifies this group’s role settings; groupTypeRoleId identifies the shared definition. growPathId is also group-specific. The inherited name, type and default/hidden flags describe the shared definition.

Fields§

§group_type_id: i64

ID of the group type this role belongs to. Discover group types with GET /group/grouptypes.

§grow_path_id: Option<i64>

Growth-path association for this role in this group, or null when none is set. This is the group-specific value, not the value of the shared role definition.

§is_default: bool

Whether this is the default role for its group type. Setting this to true clears the default flag on the other roles of that type.

§is_hidden: bool

Whether this role is marked as hidden for displays that exclude hidden roles, such as leader listings. Hidden roles are still returned by this endpoint; this flag is not an access permission.

§is_leader: Option<bool>
👎Deprecated:

Use type instead; this field is not used to create or update a role.

Legacy response field indicating whether type is leader. Use type instead; this field is not used to create or update a role.

§name: String

Stored name of the role. Use nameTranslated from the response for a localized display name.

§shorty: String

Abbreviated label for the role, used in compact displays.

§sort_key: i64

Display order among roles. Lower values come first.

§type: String

Functional classification of the role. Multiple roles with different names can share the same classification. Allowed values: leader, participant.

§id: i64

ID of the role settings record for this group. Use this ID in PATCH /groups/{groupId}/roles/{roleId}.

§name_translated: String

Localized display name, translated from the stored name when a translation exists.

§can_read_chat: bool

Whether members in this role are allowed to read the group chat.

§can_write_chat: bool

Whether members in this role are allowed to write in the group chat.

§counts_towards_seats: bool

Whether memberships in this role count towards the group’s participant capacity.

§force_two_factor_auth: bool

Whether members in this role are required to use two-factor authentication.

§group_type_role_id: i64

ID of the shared role definition from GET /group/roles. This differs from id, which identifies the settings for this group.

§html_template_ids: Option<Vec<i64>>

IDs of HTML templates available for membership documents in this role; null when no template list is stored.

§is_active: bool

Whether this role is enabled for use in this group. This is a role setting, separate from an individual person’s membership status.

§receive_qr_code: bool

Whether members in this role receive a QR code for group check-in.

§extra: Map<String, Value>

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

Trait Implementations§

Source§

impl Clone for GroupRole

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 GroupRole

Source§

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

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

impl Default for GroupRole

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for GroupRole

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 GroupRole

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 GroupRole

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 GroupRole

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