iter_describe_folder_contents ¶

iter_describe_folder_contents(
    folder_id: ResourceIdType,
    *,
    config_overrides: Optional[WorkDocsClientConfig] = None,
    authentication_token: Optional[AuthenticationHeaderType] = None,
    sort: Optional[ResourceSortType] = None,
    order: Optional[OrderType] = None,
    limit: Optional[LimitType] = None,
    marker: Optional[PageMarkerType] = None,
    type: Optional[FolderContentType] = None,
    include: Optional[FieldNamesType] = None,
) -> Iterator[DescribeFolderContentsResponse]

Source code in docs_src/capo_workdocs/_services/work_docs.py

def iter_describe_folder_contents(
    self,
    folder_id: "capo_workdocs.types.resource_id_type.ResourceIdType",
    *,
    config_overrides: Optional[WorkDocsClientConfig] = None,
    authentication_token: Optional[
        "capo_workdocs.types.authentication_header_type.AuthenticationHeaderType"
    ] = None,
    sort: Optional[
        "capo_workdocs.types.resource_sort_type.ResourceSortType"
    ] = None,
    order: Optional["capo_workdocs.types.order_type.OrderType"] = None,
    limit: Optional["capo_workdocs.types.limit_type.LimitType"] = None,
    marker: Optional["capo_workdocs.types.page_marker_type.PageMarkerType"] = None,
    type: Optional[
        "capo_workdocs.types.folder_content_type.FolderContentType"
    ] = None,
    include: Optional["capo_workdocs.types.field_names_type.FieldNamesType"] = None,
) -> "Iterator[capo_workdocs.types.describe_folder_contents_response.DescribeFolderContentsResponse]":
    _token = marker
    while True:
        _response = self.describe_folder_contents(
            folder_id,
            config_overrides=config_overrides,
            authentication_token=authentication_token,
            sort=sort,
            order=order,
            limit=limit,
            marker=_token,
            type=type,
            include=include,
        )
        yield _response
        _token = _resolve_path(_response, ("marker",))
        if not _token:
            break