DataRetentionApi class

Constructors

DataRetentionApi(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

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

Add channels to a granular data retention policy Adds channels to a granular data retention policy. Minimum server version: 5.35 ##### Permissions Must have the `sysconsole_write_compliance_data_retention` permission. ##### License Requires an E20 license.

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

Add teams to a granular data retention policy Adds teams to a granular data retention policy. Minimum server version: 5.35 ##### Permissions Must have the `sysconsole_write_compliance_data_retention` permission. ##### License Requires an E20 license.

createDataRetentionPolicy({required DataRetentionPolicyCreate dataRetentionPolicyCreate, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<DataRetentionPolicyWithTeamAndChannelCounts>>

Create a new granular data retention policy Creates a new granular data retention policy with the specified display name and post duration. Minimum server version: 5.35 ##### Permissions Must have the `sysconsole_write_compliance_data_retention` permission. ##### License Requires an E20 license.

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

Delete a granular data retention policy Deletes a granular data retention policy. Minimum server version: 5.35 ##### Permissions Must have the `sysconsole_write_compliance_data_retention` permission. ##### License Requires an E20 license.

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

Get the policies which are applied to a user's channels Gets the policies which are applied to the all of the channels to which a user belongs. Minimum server version: 5.35 ##### Permissions Must be logged in as the user or have the `manage_system` permission. ##### License Requires an E20 license.

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

Get the channels for a granular data retention policy Gets the channels to which a granular data retention policy is applied. Minimum server version: 5.35 ##### Permissions Must have the `sysconsole_read_compliance_data_retention` permission. ##### License Requires an E20 license.

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

Get the granular data retention policies Gets details about the granular (i.e. team or channel-specific) data retention policies from the server. Minimum server version: 5.35 ##### Permissions Must have the `sysconsole_read_compliance_data_retention` permission. ##### License Requires an E20 license.

getDataRetentionPoliciesCount({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<InlineResponse20016>>

Get the number of granular data retention policies Gets the number of granular (i.e. team or channel-specific) data retention policies from the server. Minimum server version: 5.35 ##### Permissions Must have the `sysconsole_read_compliance_data_retention` permission. ##### License Requires an E20 license.

getDataRetentionPolicy({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<GlobalDataRetentionPolicy>>

Get the global data retention policy Gets the current global data retention policy details from the server, including what data should be purged and the cutoff times for each data type that should be purged. Minimum server version: 4.3 ##### Permissions Requires an active session but no other permissions. ##### License Requires an E20 license.

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

Get a granular data retention policy Gets details about a granular data retention policies by ID. Minimum server version: 5.35 ##### Permissions Must have the `sysconsole_read_compliance_data_retention` permission. ##### License Requires an E20 license.

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

Get the policies which are applied to a user's teams Gets the policies which are applied to the all of the teams to which a user belongs. Minimum server version: 5.35 ##### Permissions Must be logged in as the user or have the `manage_system` permission. ##### License Requires an E20 license.

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

Get the teams for a granular data retention policy Gets the teams to which a granular data retention policy is applied. Minimum server version: 5.35 ##### Permissions Must have the `sysconsole_read_compliance_data_retention` permission. ##### License Requires an E20 license.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

patchDataRetentionPolicy({required String policyId, required DataRetentionPolicyWithTeamAndChannelIds dataRetentionPolicyWithTeamAndChannelIds, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<DataRetentionPolicyWithTeamAndChannelCounts>>

Patch a granular data retention policy Patches (i.e. replaces the fields of) a granular data retention policy. If any fields are omitted, they will not be changed. Minimum server version: 5.35 ##### Permissions Must have the `sysconsole_write_compliance_data_retention` permission. ##### License Requires an E20 license.

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

Delete channels from a granular data retention policy Delete channels from a granular data retention policy. Minimum server version: 5.35 ##### Permissions Must have the `sysconsole_write_compliance_data_retention` permission. ##### License Requires an E20 license.

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

Delete teams from a granular data retention policy Delete teams from a granular data retention policy. Minimum server version: 5.35 ##### Permissions Must have the `sysconsole_write_compliance_data_retention` permission. ##### License Requires an E20 license.

searchChannelsForRetentionPolicy({required String policyId, required InlineObject95 inlineObject95, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<ChannelWithTeamData>>>

Search for the channels in a granular data retention policy Searches for the channels to which a granular data retention policy is applied. Minimum server version: 5.35 ##### Permissions Must have the `sysconsole_read_compliance_data_retention` permission. ##### License Requires an E20 license.

searchTeamsForRetentionPolicy({required String policyId, required InlineObject94 inlineObject94, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<Team>>>

Search for the teams in a granular data retention policy Searches for the teams to which a granular data retention policy is applied. Minimum server version: 5.35 ##### Permissions Must have the `sysconsole_read_compliance_data_retention` permission. ##### License Requires an E20 license.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited