iter_describe_comments `async` ¶

iter_describe_comments(
    document_id: ResourceIdType,
    version_id: DocumentVersionIdType,
    *,
    config_overrides: Optional[AsyncWorkDocsClientConfig] = None,
    authentication_token: Optional[AuthenticationHeaderType] = None,
    limit: Optional[LimitType] = None,
    marker: Optional[MarkerType] = None,
) -> AsyncIterator[Comment]

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

async def iter_describe_comments(
    self,
    document_id: "capo_workdocs.types.resource_id_type.ResourceIdType",
    version_id: "capo_workdocs.types.document_version_id_type.DocumentVersionIdType",
    *,
    config_overrides: Optional[AsyncWorkDocsClientConfig] = None,
    authentication_token: Optional[
        "capo_workdocs.types.authentication_header_type.AuthenticationHeaderType"
    ] = None,
    limit: Optional["capo_workdocs.types.limit_type.LimitType"] = None,
    marker: Optional["capo_workdocs.types.marker_type.MarkerType"] = None,
) -> "AsyncIterator[capo_workdocs.types.comment.Comment]":
    _token = marker
    while True:
        _response = await self.describe_comments(
            document_id,
            version_id,
            config_overrides=config_overrides,
            authentication_token=authentication_token,
            limit=limit,
            marker=_token,
        )
        _page = _resolve_path(_response, ("comments",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("marker",))
        if not _token:
            break

iter_describe_comments async ¶

iter_describe_comments `async` ¶