Class PostEventReportRequest

Hierarchy (View Summary)

SearchRequest<PostEventSession>
- PostEventReportRequest

Index

Properties

current done options summary total

Methods

[asyncIterator] exec getSummary nextPage

Properties

current

current: number

done

done: boolean

options

options: Required<Rev.SearchOptions<PostEventSession>>

summary

summary: PostEventSummary

total

total: undefined | number

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncGenerator<PostEventSession, void>
Supports iterating through results using for await...

Returns AsyncGenerator<PostEventSession, void>
See
MDN Docs
Inherited from SearchRequest.[asyncIterator]
- Defined in src/utils/paged-request.ts:174

exec

exec(): Promise<PostEventSession[]>
Go through all pages of results and return as an array. TIP: Use the {maxResults} option to limit the maximum number of results

Returns Promise<PostEventSession[]>
Inherited from SearchRequest.exec
- Defined in src/utils/paged-request.ts:162

getSummary

getSummary(): Promise<PostEventSummary>
get the aggregate statistics only, instead of actual session data.

Returns Promise<PostEventSummary>
- Defined in src/api/webcast-report-request.ts:120

nextPage

nextPage(): Promise<SearchPage<PostEventSession>>
Get the next page of results from API

Returns Promise<SearchPage<PostEventSession>>
Inherited from SearchRequest.nextPage
- Defined in src/utils/paged-request.ts:53