GroupsApi class

Constructors

GroupsApi(Dio _dio, Serializers _serializers)

const

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

getGroup({required String groupId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Group>>

Get a group Get group from the provided group id string ##### Permissions Must have `manage_system` permission. Minimum server version: 5.11

getGroups({required String notAssociatedToTeam, required String notAssociatedToChannel, int? page = 0, int? perPage = 60, String? q, bool? includeMemberCount, int? since, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<Group>>>

Get groups Retrieve a list of all groups not associated to a particular channel or team. `not_associated_to_team` OR `not_associated_to_channel` is required. If you use `not_associated_to_team`, you must be a team admin for that particular team (permission to manage that team). If you use `not_associated_to_channel`, you must be a channel admin for that particular channel (permission to manage that channel). Minimum server version: 5.11

getGroupsAssociatedToChannelsByTeam({required String teamId, int? page = 0, int? perPage = 60, bool? filterAllowReference = false, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<BuiltMap<String, BuiltList<GroupWithSchemeAdmin>>>>>

Get team groups by channels Retrieve the set of groups associated with the channels in the given team grouped by channel. ##### Permissions Must have `manage_system` permission or can access only for current user Minimum server version: 5.11

getGroupsByChannel({required String channelId, int? page = 0, int? perPage = 60, bool? filterAllowReference = false, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<Group>>>

Get channel groups Retrieve the list of groups associated with a given channel. ##### Permissions Must have `manage_system` permission. Minimum server version: 5.11

getGroupsByTeam({required String teamId, int? page = 0, int? perPage = 60, bool? filterAllowReference = false, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<Group>>>

Get team groups Retrieve the list of groups associated with a given team. Minimum server version: 5.11

getGroupsByUserId({required String userId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<Group>>>

Get groups for a userId Retrieve the list of groups associated to the user Minimum server version: 5.24

getGroupStats({required String groupId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<InlineResponse20014>>

Get group stats Retrieve the stats of a given group. ##### Permissions Must have `manage_system` permission. Minimum server version: 5.26

getGroupSyncableForChannelId({required String groupId, required String channelId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<GroupSyncableChannel>>

Get GroupSyncable from channel ID Get the GroupSyncable object with group_id and channel_id from params ##### Permissions Must have `manage_system` permission. Minimum server version: 5.11

getGroupSyncableForTeamId({required String groupId, required String teamId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<GroupSyncableTeam>>

Get GroupSyncable from Team ID Get the GroupSyncable object with group_id and team_id from params ##### Permissions Must have `manage_system` permission. Minimum server version: 5.11

getGroupSyncablesChannels({required String groupId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<GroupSyncableChannels>>>

Get group channels Retrieve the list of channels associated to the group ##### Permissions Must have `manage_system` permission. Minimum server version: 5.11

getGroupSyncablesTeams({required String groupId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<GroupSyncableTeams>>>

Get group teams Retrieve the list of teams associated to the group ##### Permissions Must have `manage_system` permission. Minimum server version: 5.11

getGroupUsers({required String groupId, int? page = 0, int? perPage = 60, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<InlineResponse20013>>

Get group users Retrieve the list of users associated with a given group. ##### Permissions Must have `manage_system` permission. Minimum server version: 5.11

linkGroupSyncableForChannel({required String groupId, required String channelId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<GroupSyncableChannel>>

Link a channel to a group Link a channel to a group ##### Permissions If the channel is private, you must have `manage_private_channel_members` permission. Otherwise, you must have the `manage_public_channel_members` permission. Minimum server version: 5.11

linkGroupSyncableForTeam({required String groupId, required String teamId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<GroupSyncableTeam>>

Link a team to a group Link a team to a group ##### Permissions Must have `manage_team` permission. Minimum server version: 5.11

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

patchGroup({required String groupId, required InlineObject85 inlineObject85, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Group>>

Patch a group Partially update a group by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored. ##### Permissions Must have `manage_system` permission. Minimum server version: 5.11

patchGroupSyncableForChannel({required String groupId, required String channelId, required InlineObject87 inlineObject87, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<GroupSyncableChannel>>

Patch a GroupSyncable associated to Channel Partially update a GroupSyncable by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored. ##### Permissions Must have `manage_system` permission. Minimum server version: 5.11

patchGroupSyncableForTeam({required String groupId, required String teamId, required InlineObject86 inlineObject86, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<GroupSyncableTeam>>

Patch a GroupSyncable associated to Team Partially update a GroupSyncable by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored. ##### Permissions Must have `manage_system` permission. Minimum server version: 5.11

toString() → String

A string representation of this object.

inherited

unlinkGroupSyncableForChannel({required String groupId, required String channelId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<StatusOK>>

Delete a link from a channel to a group Delete a link from a channel to a group ##### Permissions If the channel is private, you must have `manage_private_channel_members` permission. Otherwise, you must have the `manage_public_channel_members` permission. Minimum server version: 5.11

unlinkGroupSyncableForTeam({required String groupId, required String teamId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<StatusOK>>

Delete a link from a team to a group Delete a link from a team to a group ##### Permissions Must have `manage_team` permission. Minimum server version: 5.11

unlinkLdapGroup({required String remoteId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<StatusOK>>

Delete a link for LDAP group

Operators

operator ==(Object other) → bool

The equality operator.

inherited