RetentionPoliciesModule

public class RetentionPoliciesModule

Provides RetentionPolicy management.

  • Retrieves all of the retention policies for the given enterprise.

    Declaration

    Swift

    public func list(
        name: String? = nil,
        type: RetentionPolicyType? = nil,
        createdByUserId: String? = nil,
        marker: String? = nil,
        limit: Int? = nil
    ) -> PaginationIterator<RetentionPolicyEntry>

    Parameters

    name

    A name to filter the retention policies by. A trailing partial match search is performed.

    type

    A policy type to filter the retention policies by.

    createdByUserId

    A user id to filter the retention policies by.

    marker

    The position marker at which to begin the response. See marker-based paging for details.

    limit

    The maximum number of items to return.

    Return Value

    Returns pagination iterator to fetch items. Returns the list of all retention policies for the enterprise. If query parameters are given, only the retention policies that match the query parameters are returned.