Module data_retention_api

Enums

AddChannelsToRetentionPolicyError

struct for typed errors of method add_channels_to_retention_policy

AddTeamsToRetentionPolicyError

struct for typed errors of method add_teams_to_retention_policy

CreateDataRetentionPolicyError

struct for typed errors of method create_data_retention_policy

DeleteDataRetentionPolicyError

struct for typed errors of method delete_data_retention_policy

GetChannelPoliciesForUserError

struct for typed errors of method get_channel_policies_for_user

GetChannelsForRetentionPolicyError

struct for typed errors of method get_channels_for_retention_policy

GetDataRetentionPoliciesCountError

struct for typed errors of method get_data_retention_policies_count

GetDataRetentionPoliciesError

struct for typed errors of method get_data_retention_policies

GetDataRetentionPolicyByIdError

struct for typed errors of method get_data_retention_policy_by_id

GetDataRetentionPolicyError

struct for typed errors of method get_data_retention_policy

GetTeamPoliciesForUserError

struct for typed errors of method get_team_policies_for_user

GetTeamsForRetentionPolicyError

struct for typed errors of method get_teams_for_retention_policy

PatchDataRetentionPolicyError

struct for typed errors of method patch_data_retention_policy

RemoveChannelsFromRetentionPolicyError

struct for typed errors of method remove_channels_from_retention_policy

RemoveTeamsFromRetentionPolicyError

struct for typed errors of method remove_teams_from_retention_policy

SearchChannelsForRetentionPolicyError

struct for typed errors of method search_channels_for_retention_policy

SearchTeamsForRetentionPolicyError

struct for typed errors of method search_teams_for_retention_policy

Functions

add_channels_to_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.

add_teams_to_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.

create_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.

delete_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.

get_channel_policies_for_user

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.

get_channels_for_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.

get_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.

get_data_retention_policies_count

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.

get_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.

get_data_retention_policy_by_id

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.

get_team_policies_for_user

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.

get_teams_for_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.

patch_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.

remove_channels_from_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.

remove_teams_from_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.

search_channels_for_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.

search_teams_for_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.