pub struct GroupsResource<'a> { /* private fields */ }Expand description
client.groups()
Implementations§
Source§impl<'a> GroupsResource<'a>
impl<'a> GroupsResource<'a>
pub fn checkin(&self) -> GroupsCheckinResource<'a>
pub fn documents(&self) -> GroupsDocumentsResource<'a>
pub fn followups(&self) -> GroupsFollowupsResource<'a>
pub fn meetings(&self) -> GroupsMeetingsResource<'a>
pub fn member_fields(&self) -> GroupsMemberFieldsResource<'a>
pub fn members(&self) -> GroupsMembersResource<'a>
pub fn news_letter_integrations( &self, ) -> GroupsNewsLetterIntegrationsResource<'a>
pub fn parents(&self) -> GroupsParentsResource<'a>
pub fn qrcode_checkin(&self) -> GroupsQrcodeCheckinResource<'a>
pub fn roles(&self) -> GroupsRolesResource<'a>
pub fn wiki(&self) -> GroupsWikiResource<'a>
Sourcepub fn chat(&self, group_id: impl Display, body: &StartStopChat) -> Result<()>
pub fn chat(&self, group_id: impl Display, body: &StartStopChat) -> Result<()>
Start or stop an event chat
POST /groups/{groupId}/chat
§Example
let body = models::StartStopChat {
enabled: true,
..Default::default()
};
client.groups().chat(42, &body)?;Sourcepub fn create(&self, body: &PostGroupsBody) -> Result<Group>
pub fn create(&self, body: &PostGroupsBody) -> Result<Group>
Create Group
POST /groups
Create new group
§Example
let body = models::PostGroupsBody {
group_status_id: 1,
group_type_id: 42,
name: "Hauskreis Nord".into(),
..Default::default()
};
let result = client.groups().create(&body)?;
println!("{}", result.name);Sourcepub fn delete(&self, group_id: impl Display) -> Result<()>
pub fn delete(&self, group_id: impl Display) -> Result<()>
Delete a group
DELETE /groups/{groupId}
Delete a group. This will remove all people from this group.
Use Self::delete_with to pass query parameters.
§Example
client.groups().delete(42)?;Sourcepub fn delete_with(
&self,
group_id: impl Display,
query: &DeleteGroupsGroupIdQuery,
) -> Result<()>
pub fn delete_with( &self, group_id: impl Display, query: &DeleteGroupsGroupIdQuery, ) -> Result<()>
Delete a group
Like Self::delete, with query parameters.
DELETE /groups/{groupId}
Delete a group. This will remove all people from this group.
Sourcepub fn delete_group_homepage(&self, group_id: impl Display) -> Result<()>
pub fn delete_group_homepage(&self, group_id: impl Display) -> Result<()>
Delete a group’s homepage configuration
DELETE /groups/{groupId}/grouphomepage
Permanently removes the homepage configuration attached to this parent group, including its public URL hash. The group, child groups and their memberships are retained. Requires permission to edit the parent group’s basic settings. If that group has no homepage configuration, the request still returns 204. There is no delete-preview workflow; use PUT with isEnabled=false to keep the configuration while disabling the public page.
§Example
client.groups().delete_group_homepage(42)?;Sourcepub fn duplicate(
&self,
group_id: impl Display,
body: &GroupDuplicateCreate,
) -> Result<Group>
pub fn duplicate( &self, group_id: impl Display, body: &GroupDuplicateCreate, ) -> Result<Group>
Duplicate a group with selected related data
POST /groups/{groupId}/duplicate
Creates a pending group with a new ID, GUID and name. Requires permission to create a group with the source group’s type, campus and parent groups. The copy includes both parent and child hierarchy links, tags, membership field definitions, role settings, addresses and the group image. Memberships, role permissions and membership routines are copied only when their flags are enabled. Meetings and the appointment link are cleared. An existing group homepage is cloned with a new URL hash. Supply newName and optional flags in the query or JSON body; query values take precedence. The returned group is not enriched with all copied related data.
Use Self::duplicate_with to pass query parameters.
§Example
let body = models::GroupDuplicateCreate {
copy_members: Some(true),
..Default::default()
};
let group = client.groups().duplicate(42, &body)?;
println!("{}", group.name);Sourcepub fn duplicate_with(
&self,
group_id: impl Display,
query: &PostGroupsIdDuplicateQuery,
body: &GroupDuplicateCreate,
) -> Result<Group>
pub fn duplicate_with( &self, group_id: impl Display, query: &PostGroupsIdDuplicateQuery, body: &GroupDuplicateCreate, ) -> Result<Group>
Duplicate a group with selected related data
Like Self::duplicate, with query parameters.
POST /groups/{groupId}/duplicate
Creates a pending group with a new ID, GUID and name. Requires permission to create a group with the source group’s type, campus and parent groups. The copy includes both parent and child hierarchy links, tags, membership field definitions, role settings, addresses and the group image. Memberships, role permissions and membership routines are copied only when their flags are enabled. Meetings and the appointment link are cleared. An existing group homepage is cloned with a new URL hash. Supply newName and optional flags in the query or JSON body; query values take precedence. The returned group is not enriched with all copied related data.
Sourcepub fn export(&self, body: &GroupExportCreate) -> Result<Vec<u8>>
pub fn export(&self, body: &GroupExportCreate) -> Result<Vec<u8>>
Export groups
POST /groups/export
Downloads selected visible groups as a spreadsheet, sorted by group name. Unknown or invisible IDs are omitted; an empty ids array produces a header-only export. Columns include standard and custom group fields, registration availability, tags, membership statistics, places and direct parent/child groups. Field labels and formatted values use the current language. Group field values pass through field security checks; related groups that are not visible may still appear as bare IDs. CSV uses semicolon-separated UTF-8 text; XLSX returns a workbook. This read-only POST does not create a stored file and does not paginate.
Use Self::export_with to pass query parameters.
§Example
let body = models::GroupExportCreate {
ids: vec![12, 34],
..Default::default()
};
let data = client.groups().export(&body)?;
std::fs::write("ergebnis.xlsx", &data)?;Sourcepub fn export_with(
&self,
query: &PostGroupsExportQuery,
body: &GroupExportCreate,
) -> Result<Vec<u8>>
pub fn export_with( &self, query: &PostGroupsExportQuery, body: &GroupExportCreate, ) -> Result<Vec<u8>>
Export groups
Like Self::export, with query parameters.
POST /groups/export
Downloads selected visible groups as a spreadsheet, sorted by group name. Unknown or invisible IDs are omitted; an empty ids array produces a header-only export. Columns include standard and custom group fields, registration availability, tags, membership statistics, places and direct parent/child groups. Field labels and formatted values use the current language. Group field values pass through field security checks; related groups that are not visible may still appear as bare IDs. CSV uses semicolon-separated UTF-8 text; XLSX returns a workbook. This read-only POST does not create a stored file and does not paginate.
Sourcepub fn get(&self, group_id: impl Display) -> Result<Group>
pub fn get(&self, group_id: impl Display) -> Result<Group>
Get a group
GET /groups/{groupId}
Use Self::get_with to pass query parameters.
§Example
let group = client.groups().get(42)?;
println!("{}", group.name);Sourcepub fn get_with(
&self,
group_id: impl Display,
query: &GetGroupsGroupIdQuery,
) -> Result<Group>
pub fn get_with( &self, group_id: impl Display, query: &GetGroupsGroupIdQuery, ) -> Result<Group>
Sourcepub fn get_group_homepage(
&self,
group_id: impl Display,
) -> Result<GroupHomepage>
pub fn get_group_homepage( &self, group_id: impl Display, ) -> Result<GroupHomepage>
Get a group’s homepage configuration
GET /groups/{groupId}/grouphomepage
Returns the homepage configuration attached to this parent group, including disabled homepages. Requires permission to edit the parent group’s basic settings; ordinary group visibility is insufficient. A group without a homepage returns 404. This settings lookup does not populate the child groups or filter option catalogs: groups is empty and filter entries omit options. For the public page with its child groups and catalogs, use GET /grouphomepages/{hash}. showMap is combined with the global OpenStreetMap setting, so it can be false even when the stored page flag is true.
§Example
let group_homepage = client.groups().get_group_homepage(42)?;
println!("{}", group_homepage.name);Sourcepub fn get_grouped(
&self,
query: &GetGroupsGroupedQuery,
) -> Result<GroupedGroups>
pub fn get_grouped( &self, query: &GetGroupsGroupedQuery, ) -> Result<GroupedGroups>
Get grouped groups
GET /groups/grouped
Returns visible groups grouped by the requested group attribute. Each group contains a preview list limited by limit and the total number of matching groups in all.
§Example
let query = GetGroupsGroupedQuery {
group_by: Some("ageGroup".into()),
..Default::default()
};
let grouped = client.groups().get_grouped(&query)?;
println!("{}", grouped.grouped_by);Sourcepub fn get_optins(&self, group_id: impl Display) -> Result<NewsletterOptInData>
pub fn get_optins(&self, group_id: impl Display) -> Result<NewsletterOptInData>
Get stored newsletter consent and synchronization states
GET /groups/{groupId}/optins
Returns active newsletter mappings and local newsletter-person records for the group, keyed by provider:listId and person ID. Requires permission to view the group and its members. The current backend calls the global administer groups check but does not enforce its result. Disabled/unknown providers are absent from newsletter; person records can remain with empty newsletter maps. The data is unpaginated, has no meta envelope and is not a live provider status lookup. Empty maps serialize as [].
§Example
let optin = client.groups().get_optins(42)?;
println!("{:?}", optin);Sourcepub fn get_post_statistics(
&self,
group_id: impl Display,
) -> Result<GroupPostStatistics>
pub fn get_post_statistics( &self, group_id: impl Display, ) -> Result<GroupPostStatistics>
Count published group posts by visibility
GET /groups/{groupId}/poststatistics
Returns one object containing counts for group_intern and group_visible. Only already published, unexpired and non-banned posts are counted, and posts must be enabled for both the group and its group type. Drafts/scheduled posts are excluded. Empty groups and groups with posts disabled return both counters as zero. The current handler requires authentication but ignores the result of its group-edit permission check and does not filter counts by the caller’s post visibility. The response has no pagination or meta.
§Example
let post_statistic = client.groups().get_post_statistics(42)?;
println!("{}", post_statistic.group_intern);Sourcepub fn get_statistics(&self, group_id: impl Display) -> Result<GroupStatistics>
pub fn get_statistics(&self, group_id: impl Display) -> Result<GroupStatistics>
Get group capacity and visible membership counts
GET /groups/{groupId}/statistics
Returns one statistics object for the group. Requires group visibility. members is a role/status histogram restricted to members and persons visible to the caller; unfiltered contains group-wide capacity counts regardless of individual visibility. Consequently, summing members need not match any unfiltered counter. Roles, workflow status, archive state and seat-counting settings affect the counters differently. A group without visible memberships returns members=[]; capacity counters are still present. The response is not paginated and has no meta envelope.
§Example
let statistic = client.groups().get_statistics(42)?;
println!("{:?}", statistic);Sourcepub fn group_type(
&self,
group_id: impl Display,
body: &GroupTypeChangeUpdate,
) -> Result<()>
pub fn group_type( &self, group_id: impl Display, body: &GroupTypeChangeUpdate, ) -> Result<()>
Change a group’s type and migrate its roles
POST /groups/{groupId}/grouptype
Changes the group type and applies the supplied role mapping within a database transaction. Requires permission to edit the groupTypeId field of this group. Membership roles, group-role settings and their permissions, the registration override role, membership routines, dynamic-group rules and website role references can be affected. New target-type roles receive default group settings; obsolete role settings and their permissions are removed. Provide a complete mapping from old to new group-type role IDs. Use a different target type with valid target roles; incomplete or inconsistent mappings can fail during migration or leave membership roles inconsistent. Success returns 204 without a response body.
§Example
let body = models::GroupTypeChangeUpdate {
group_type_id: 3,
role_mapping: Default::default(),
..Default::default()
};
client.groups().group_type(42, &body)?;Sourcepub fn list(&self) -> Result<Vec<Group>>
pub fn list(&self) -> Result<Vec<Group>>
Get all groups
GET /groups
This endpoint returns an array with all groups the user can see. This includes groups the user
is a member of as well as subordinate groups the user is allowed to see.
In addition to the documented query parameters, groups can be filtered by all group fields (=fieldValue) as query parameters. For group fields with options (e.g. select fields), the format would be []=optionId and can be repeated for serveral ids.
Use Self::list_with to pass query parameters.
§Example
for group in client.groups().list()? {
println!("{}", group.name);
}Sourcepub fn list_with(&self, query: &GetGroupsQuery) -> Result<Vec<Group>>
pub fn list_with(&self, query: &GetGroupsQuery) -> Result<Vec<Group>>
Get all groups
Like Self::list, with query parameters.
GET /groups
This endpoint returns an array with all groups the user can see. This includes groups the user
is a member of as well as subordinate groups the user is allowed to see.
In addition to the documented query parameters, groups can be filtered by all group fields (=fieldValue) as query parameters. For group fields with options (e.g. select fields), the format would be []=optionId and can be repeated for serveral ids.
Sourcepub fn list_iter(&self, query: &GetGroupsQuery) -> Items<Group> ⓘ
pub fn list_iter(&self, query: &GetGroupsQuery) -> Items<Group> ⓘ
Get all groups
Like Self::list_with, but lazy: each page is fetched only when the iteration reaches it.
Breaking off early saves the remaining requests.
Sourcepub fn list_absences(&self, group_id: impl Display) -> Result<Vec<Absence>>
pub fn list_absences(&self, group_id: impl Display) -> Result<Vec<Absence>>
Fetch all absences for persons in a group
GET /groups/{groupId}/absences
Returns absences for active, visible group members. Requires access to the group; member results are additionally restricted by manage absent or the internal group permission to view absences. Returns absences whose start is at or before to and whose end is at or after from. Absences ending exactly at midnight on the from date are also included, even if from specifies a later time that day. Dates use the application time zone; UTC timestamps are converted into it. Without filters the window starts at midnight two weeks ago and ends at midnight two weeks from today. The list is unpaginated and sorted by start; meta.count is the number returned.
Use Self::list_absences_with to pass query parameters.
§Example
for absence in client.groups().list_absences(42)? {
println!("{}", absence.id);
}Sourcepub fn list_absences_with(
&self,
group_id: impl Display,
query: &GetGroupsAbsencesQuery,
) -> Result<Vec<Absence>>
pub fn list_absences_with( &self, group_id: impl Display, query: &GetGroupsAbsencesQuery, ) -> Result<Vec<Absence>>
Fetch all absences for persons in a group
Like Self::list_absences, with query parameters.
GET /groups/{groupId}/absences
Returns absences for active, visible group members. Requires access to the group; member results are additionally restricted by manage absent or the internal group permission to view absences. Returns absences whose start is at or before to and whose end is at or after from. Absences ending exactly at midnight on the from date are also included, even if from specifies a later time that day. Dates use the application time zone; UTC timestamps are converted into it. Without filters the window starts at midnight two weeks ago and ends at midnight two weeks from today. The list is unpaginated and sorted by start; meta.count is the number returned.
Sourcepub fn list_children(
&self,
group_id: impl Display,
) -> Result<Vec<DomainObjectGroup>>
pub fn list_children( &self, group_id: impl Display, ) -> Result<Vec<DomainObjectGroup>>
Get child groups
GET /groups/{groupId}/children
Use Self::list_children_with to pass query parameters.
§Example
for children in client.groups().list_children(42)? {
println!("{}", children.title);
}Sourcepub fn list_children_with(
&self,
group_id: impl Display,
query: &GetGroupsGroupIdChildrenQuery,
) -> Result<Vec<DomainObjectGroup>>
pub fn list_children_with( &self, group_id: impl Display, query: &GetGroupsGroupIdChildrenQuery, ) -> Result<Vec<DomainObjectGroup>>
Sourcepub fn list_children_iter(
&self,
group_id: impl Display,
query: &GetGroupsGroupIdChildrenQuery,
) -> Items<DomainObjectGroup> ⓘ
pub fn list_children_iter( &self, group_id: impl Display, query: &GetGroupsGroupIdChildrenQuery, ) -> Items<DomainObjectGroup> ⓘ
Get child groups
Like Self::list_children_with, but lazy: each page is fetched only when the iteration reaches it.
Breaking off early saves the remaining requests.
Sourcepub fn list_document_templates(
&self,
group_id: impl Display,
) -> Result<Vec<HtmlTemplateInfo>>
pub fn list_document_templates( &self, group_id: impl Display, ) -> Result<Vec<HtmlTemplateInfo>>
List membership document templates for the current user
GET /groups/{groupId}/documenttemplates
Lists the document templates assigned to the current user’s role in this group. The current user must have an active membership and that role must be configured in the group; administrative rights do not replace that membership. The result follows the role’s configured template order and is not paginated. An empty list means the role has no assigned templates. This endpoint returns template names only and does not generate PDFs. Unlike document generation, it does not check whether the group itself is active, so a listed template may still be unavailable for download.
§Example
for document_template in client.groups().list_document_templates(42)? {
println!("{}", document_template.name);
}Sourcepub fn list_hierarchies(&self) -> Result<Vec<GroupHierarchy>>
pub fn list_hierarchies(&self) -> Result<Vec<GroupHierarchy>>
Get all group hierarchies
GET /groups/hierarchies
Returns all group hierarchies. The groups not visible for the user only show ids. Note: You have to pass at least 2 group IDs for the filter to work. If you only want to see the children of a specific group use GET /groups/{groupId}/children.
Use Self::list_hierarchies_with to pass query parameters.
§Example
for hierarchy in client.groups().list_hierarchies()? {
println!("{}", hierarchy.group_id);
}Sourcepub fn list_hierarchies_with(
&self,
query: &GetGroupsHierarchiesQuery,
) -> Result<Vec<GroupHierarchy>>
pub fn list_hierarchies_with( &self, query: &GetGroupsHierarchiesQuery, ) -> Result<Vec<GroupHierarchy>>
Get all group hierarchies
Like Self::list_hierarchies, with query parameters.
GET /groups/hierarchies
Returns all group hierarchies. The groups not visible for the user only show ids. Note: You have to pass at least 2 group IDs for the filter to work. If you only want to see the children of a specific group use GET /groups/{groupId}/children.
Sourcepub fn list_hierarchies_iter(
&self,
query: &GetGroupsHierarchiesQuery,
) -> Items<GroupHierarchy> ⓘ
pub fn list_hierarchies_iter( &self, query: &GetGroupsHierarchiesQuery, ) -> Items<GroupHierarchy> ⓘ
Get all group hierarchies
Like Self::list_hierarchies_with, but lazy: each page is fetched only when the iteration reaches it.
Breaking off early saves the remaining requests.
Sourcepub fn list_ids(&self) -> Result<Vec<i64>>
pub fn list_ids(&self) -> Result<Vec<i64>>
Get all group ids
GET /groups/ids
Returns all group ids the user can see. This includes groups the user is a member of as well as subordinate groups the user is allowed to see. Same as GET /groups but only returns ids.
Use Self::list_ids_with to pass query parameters.
§Example
for id in client.groups().list_ids()? {
println!("{:?}", id);
}Sourcepub fn list_ids_with(&self, query: &GetGroupsIdsQuery) -> Result<Vec<i64>>
pub fn list_ids_with(&self, query: &GetGroupsIdsQuery) -> Result<Vec<i64>>
Get all group ids
Like Self::list_ids, with query parameters.
GET /groups/ids
Returns all group ids the user can see. This includes groups the user is a member of as well as subordinate groups the user is allowed to see. Same as GET /groups but only returns ids.
Sourcepub fn list_ids_iter(&self, query: &GetGroupsIdsQuery) -> Items<i64> ⓘ
pub fn list_ids_iter(&self, query: &GetGroupsIdsQuery) -> Items<i64> ⓘ
Get all group ids
Like Self::list_ids_with, but lazy: each page is fetched only when the iteration reaches it.
Breaking off early saves the remaining requests.
Sourcepub fn list_member_ids(&self, group_id: impl Display) -> Result<Vec<i64>>
pub fn list_member_ids(&self, group_id: impl Display) -> Result<Vec<i64>>
Get person IDs of group members
GET /groups/{groupId}/memberids
Returns the person IDs of all visible memberships matching the filters. These IDs can be used as personId in /groups/{groupId}/members/{personId}; they are not membership record IDs. Results are not paginated, and meta.count is the number of returned IDs. Filters are combined, and visibility restrictions still apply. Additional filters can use a group member field’s reference name or display name (=fieldValue), or a person-field key (person_=fieldValue).
Use Self::list_member_ids_with to pass query parameters.
§Example
for member_id in client.groups().list_member_ids(42)? {
println!("{:?}", member_id);
}Sourcepub fn list_member_ids_with(
&self,
group_id: impl Display,
query: &GetGroupsGroupIdMemberidsQuery,
) -> Result<Vec<i64>>
pub fn list_member_ids_with( &self, group_id: impl Display, query: &GetGroupsGroupIdMemberidsQuery, ) -> Result<Vec<i64>>
Get person IDs of group members
Like Self::list_member_ids, with query parameters.
GET /groups/{groupId}/memberids
Returns the person IDs of all visible memberships matching the filters. These IDs can be used as personId in /groups/{groupId}/members/{personId}; they are not membership record IDs. Results are not paginated, and meta.count is the number of returned IDs. Filters are combined, and visibility restrictions still apply. Additional filters can use a group member field’s reference name or display name (=fieldValue), or a person-field key (person_=fieldValue).
Sourcepub fn list_member_preview(
&self,
group_id: impl Display,
) -> Result<Vec<MemberPreview>>
pub fn list_member_preview( &self, group_id: impl Display, ) -> Result<Vec<MemberPreview>>
Preview active group members by role
GET /groups/{groupId}/memberpreview
Returns each role of the group’s group type with a limited selection of active, visible members. Roles are ordered by type and sort key, including roles with no matching members. Within each role, persons with an avatar come first, followed by last name and first name. members_per_role limits each role separately; meta.count counts role entries, not members. Use GET /groups/{groupId}/members for the paginated membership list and additional fields.
Use Self::list_member_preview_with to pass query parameters.
§Example
for member_preview in client.groups().list_member_preview(42)? {
println!("{:?}", member_preview);
}Sourcepub fn list_member_preview_with(
&self,
group_id: impl Display,
query: &GetGroupsGroupIdMemberpreviewQuery,
) -> Result<Vec<MemberPreview>>
pub fn list_member_preview_with( &self, group_id: impl Display, query: &GetGroupsGroupIdMemberpreviewQuery, ) -> Result<Vec<MemberPreview>>
Preview active group members by role
Like Self::list_member_preview, with query parameters.
GET /groups/{groupId}/memberpreview
Returns each role of the group’s group type with a limited selection of active, visible members. Roles are ordered by type and sort key, including roles with no matching members. Within each role, persons with an avatar come first, followed by last name and first name. members_per_role limits each role separately; meta.count counts role entries, not members. Use GET /groups/{groupId}/members for the paginated membership list and additional fields.
Sourcepub fn list_members(&self) -> Result<Vec<GroupMemberShort>>
pub fn list_members(&self) -> Result<Vec<GroupMemberShort>>
Get all group members
GET /groups/members
Returns all group members. Only accessible for users with right “administer persons”.
Use Self::list_members_with to pass query parameters.
§Example
for member in client.groups().list_members()? {
println!("{}", member.deleted);
}Sourcepub fn list_members_with(
&self,
query: &GetGroupsMembersQuery,
) -> Result<Vec<GroupMemberShort>>
pub fn list_members_with( &self, query: &GetGroupsMembersQuery, ) -> Result<Vec<GroupMemberShort>>
Get all group members
Like Self::list_members, with query parameters.
GET /groups/members
Returns all group members. Only accessible for users with right “administer persons”.
Sourcepub fn list_posts(&self, group_id: impl Display) -> Result<Vec<Post>>
pub fn list_posts(&self, group_id: impl Display) -> Result<Vec<Post>>
Get visible posts of a group
GET /groups/{groupId}/posts
Returns published, unexpired and unbanned local posts visible to the current user in this group. Anonymous access is supported and limited by public group and post visibility. Posts must be enabled for both the group and its group type. Group-internal posts require membership; other posts follow group visibility. A missing or inaccessible group returns an empty list. Explicitly selecting a group includes it even when the user has hidden the group from their feed; hidden posts and hidden authors remain excluded. External instances are not queried. Results are ordered by publishedDate and GUID descending. For the next batch, pass the last post’s publishedDate as before and its guid as last_post_identifier. page is ignored; pagination.current stays 1, and total/lastPage describe the remaining cursor-filtered results rather than the complete feed.
Use Self::list_posts_with to pass query parameters.
§Example
for post in client.groups().list_posts(42)? {
println!("{}", post.title);
}Sourcepub fn list_posts_with(
&self,
group_id: impl Display,
query: &GetGroupsGroupIdPostsQuery,
) -> Result<Vec<Post>>
pub fn list_posts_with( &self, group_id: impl Display, query: &GetGroupsGroupIdPostsQuery, ) -> Result<Vec<Post>>
Get visible posts of a group
Like Self::list_posts, with query parameters.
GET /groups/{groupId}/posts
Returns published, unexpired and unbanned local posts visible to the current user in this group. Anonymous access is supported and limited by public group and post visibility. Posts must be enabled for both the group and its group type. Group-internal posts require membership; other posts follow group visibility. A missing or inaccessible group returns an empty list. Explicitly selecting a group includes it even when the user has hidden the group from their feed; hidden posts and hidden authors remain excluded. External instances are not queried. Results are ordered by publishedDate and GUID descending. For the next batch, pass the last post’s publishedDate as before and its guid as last_post_identifier. page is ignored; pagination.current stays 1, and total/lastPage describe the remaining cursor-filtered results rather than the complete feed.
Sourcepub fn list_posts_iter(
&self,
group_id: impl Display,
query: &GetGroupsGroupIdPostsQuery,
) -> Items<Post> ⓘ
pub fn list_posts_iter( &self, group_id: impl Display, query: &GetGroupsGroupIdPostsQuery, ) -> Items<Post> ⓘ
Get visible posts of a group
Like Self::list_posts_with, but lazy: each page is fetched only when the iteration reaches it.
Breaking off early saves the remaining requests.
Sourcepub fn notification(
&self,
group_id: impl Display,
body: &GroupSignUpNotificationRequest,
) -> Result<GroupSignUpNotificationResult>
pub fn notification( &self, group_id: impl Display, body: &GroupSignUpNotificationRequest, ) -> Result<GroupSignUpNotificationResult>
Send a group sign-up push notification
POST /groups/{groupId}/notification
Announces a group to potential new members through push notifications. Requires permission to edit the group’s basic settings. Recipients have registered push devices, are not already linked to the group, and have not disabled these notifications. Group age, target-group and category values are compared with notification preferences, not with a person’s age or memberships. Use dry_run to preview the selection count without sending or marking the group as notified. A normal request marks the group as notified even when the count is zero; later requests, including dry runs, return 403. sentToCount measures recipient selection, not successful delivery. The response is returned directly without a data wrapper.
Use Self::notification_with to pass query parameters.
§Example
let body = models::GroupSignUpNotificationRequest {
dry_run: Some(true),
..Default::default()
};
let group = client.groups().notification(42, &body)?;
println!("{}", group.sent_to_count);Sourcepub fn notification_with(
&self,
group_id: impl Display,
query: &PostGroupsGroupIdNotificationQuery,
body: &GroupSignUpNotificationRequest,
) -> Result<GroupSignUpNotificationResult>
pub fn notification_with( &self, group_id: impl Display, query: &PostGroupsGroupIdNotificationQuery, body: &GroupSignUpNotificationRequest, ) -> Result<GroupSignUpNotificationResult>
Send a group sign-up push notification
Like Self::notification, with query parameters.
POST /groups/{groupId}/notification
Announces a group to potential new members through push notifications. Requires permission to edit the group’s basic settings. Recipients have registered push devices, are not already linked to the group, and have not disabled these notifications. Group age, target-group and category values are compared with notification preferences, not with a person’s age or memberships. Use dry_run to preview the selection count without sending or marking the group as notified. A normal request marks the group as notified even when the count is zero; later requests, including dry runs, return 403. sentToCount measures recipient selection, not successful delivery. The response is returned directly without a data wrapper.
Sourcepub fn patch(
&self,
group_id: impl Display,
body: &PatchGroupsIdBody,
) -> Result<Group>
pub fn patch( &self, group_id: impl Display, body: &PatchGroupsIdBody, ) -> Result<Group>
Update Group
PATCH /groups/{groupId}
Update a group by id. All group fields can be updated here. Use the fields api to get all fields that can be updated here. To link an existing group to an existing appointment (e.g. a sign-up group), set appointmentId (and optionally startDate to identify a specific occurrence of a repeating appointment). Set appointmentId to null to remove the link. The current user must have permission to edit both the group and the referenced appointment.
Use Self::patch_with to pass query parameters.
§Example
let body = models::PatchGroupsIdBody {
appointment_id: Some(Some(42)),
..Default::default()
};
let result = client.groups().patch(42, &body)?;
println!("{}", result.name);Sourcepub fn patch_with(
&self,
group_id: impl Display,
query: &PatchGroupsIdQuery,
body: &PatchGroupsIdBody,
) -> Result<Group>
pub fn patch_with( &self, group_id: impl Display, query: &PatchGroupsIdQuery, body: &PatchGroupsIdBody, ) -> Result<Group>
Update Group
Like Self::patch, with query parameters.
PATCH /groups/{groupId}
Update a group by id. All group fields can be updated here. Use the fields api to get all fields that can be updated here. To link an existing group to an existing appointment (e.g. a sign-up group), set appointmentId (and optionally startDate to identify a specific occurrence of a repeating appointment). Set appointmentId to null to remove the link. The current user must have permission to edit both the group and the referenced appointment.
Sourcepub fn update_group_homepage(
&self,
group_id: impl Display,
body: &GroupHomepageUpdate,
) -> Result<BTreeMap<String, Value>>
pub fn update_group_homepage( &self, group_id: impl Display, body: &GroupHomepageUpdate, ) -> Result<BTreeMap<String, Value>>
Create or update a group’s homepage configuration
PUT /groups/{groupId}/grouphomepage
Creates the homepage configuration if none exists, otherwise updates it. Requires permission to edit the parent group’s basic settings. Existing URL hashes are preserved; newly created pages receive a random hash. Supply all five enabled/display flags. Omitted header modes and custom text preserve existing values; omitted layout, ordering, collapse and depth settings reset to defaults, and omitted filters disables all filters. Returns 200 with an empty JSON object for both create and update. Read GET /groups/{groupId}/grouphomepage afterwards to obtain the saved configuration and URL hash.
§Example
let body = models::GroupHomepageUpdate {
is_enabled: true,
show_filters: true,
show_group_images: true,
show_leaders: true,
show_map: true,
..Default::default()
};
let result = client.groups().update_group_homepage(42, &body)?;
println!("{:?}", result);