iter_describe_root_folders ¶

iter_describe_root_folders(
    authentication_token: AuthenticationHeaderType,
    *,
    config_overrides: Optional[WorkDocsClientConfig] = None,
    limit: Optional[LimitType] = None,
    marker: Optional[PageMarkerType] = None,
) -> Iterator[FolderMetadata]

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

def iter_describe_root_folders(
    self,
    authentication_token: "capo_workdocs.types.authentication_header_type.AuthenticationHeaderType",
    *,
    config_overrides: Optional[WorkDocsClientConfig] = None,
    limit: Optional["capo_workdocs.types.limit_type.LimitType"] = None,
    marker: Optional["capo_workdocs.types.page_marker_type.PageMarkerType"] = None,
) -> "Iterator[capo_workdocs.types.folder_metadata.FolderMetadata]":
    _token = marker
    while True:
        _response = self.describe_root_folders(
            authentication_token,
            config_overrides=config_overrides,
            limit=limit,
            marker=_token,
        )
        _page = _resolve_path(_response, ("folders",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("marker",))
        if not _token:
            break