Skip to content

iter_describe_activities async

iter_describe_activities(
    *,
    config_overrides: Optional[AsyncWorkDocsClientConfig] = None,
    authentication_token: Optional[AuthenticationHeaderType] = None,
    start_time: Optional[TimestampType] = None,
    end_time: Optional[TimestampType] = None,
    organization_id: Optional[IdType] = None,
    activity_types: Optional[ActivityNamesFilterType] = None,
    resource_id: Optional[IdType] = None,
    user_id: Optional[IdType] = None,
    include_indirect_activities: Optional[BooleanType] = None,
    limit: Optional[LimitType] = None,
    marker: Optional[SearchMarkerType] = None,
) -> AsyncIterator[Activity]
Source code in docs_src/capo_workdocs/_services/async_work_docs.py
async def iter_describe_activities(
    self,
    *,
    config_overrides: Optional[AsyncWorkDocsClientConfig] = None,
    authentication_token: Optional[
        "capo_workdocs.types.authentication_header_type.AuthenticationHeaderType"
    ] = None,
    start_time: Optional["capo_workdocs.types.timestamp_type.TimestampType"] = None,
    end_time: Optional["capo_workdocs.types.timestamp_type.TimestampType"] = None,
    organization_id: Optional["capo_workdocs.types.id_type.IdType"] = None,
    activity_types: Optional[
        "capo_workdocs.types.activity_names_filter_type.ActivityNamesFilterType"
    ] = None,
    resource_id: Optional["capo_workdocs.types.id_type.IdType"] = None,
    user_id: Optional["capo_workdocs.types.id_type.IdType"] = None,
    include_indirect_activities: Optional[
        "capo_workdocs.types.boolean_type.BooleanType"
    ] = None,
    limit: Optional["capo_workdocs.types.limit_type.LimitType"] = None,
    marker: Optional[
        "capo_workdocs.types.search_marker_type.SearchMarkerType"
    ] = None,
) -> "AsyncIterator[capo_workdocs.types.activity.Activity]":
    _token = marker
    while True:
        _response = await self.describe_activities(
            config_overrides=config_overrides,
            authentication_token=authentication_token,
            start_time=start_time,
            end_time=end_time,
            organization_id=organization_id,
            activity_types=activity_types,
            resource_id=resource_id,
            user_id=user_id,
            include_indirect_activities=include_indirect_activities,
            limit=limit,
            marker=_token,
        )
        _page = _resolve_path(_response, ("user_activities",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("marker",))
        if not _token:
            break