ReadYouTube Class
Outputs metadata for information from YouTube.
Namespace
Statiq.YouTube
Interfaces
Base Types
graph BT Type-->Base0["ParallelSyncModule"] click Base0 "/api/Statiq.Common/ParallelSyncModule" Base0-->Base1["Module"] click Base1 "/api/Statiq.Common/Module" Base1-->Base2["object"] Type-.->Interface0["IModule"] click Interface0 "/api/Statiq.Common/IModule" Type-.->Interface1["IParallelModule"] click Interface1 "/api/Statiq.Common/IParallelModule" Type-.->Interface2["IDisposable"] Type["ReadYouTube"] class Type type-node

Syntax

public class ReadYouTube : ParallelSyncModule, IModule, IParallelModule, IDisposable

Remarks

This modules uses the Google.Apis.YouTube.v3 library and associated types to submit requests to GitHub. Because of the large number of different kinds of requests, this module does not attempt to provide a fully abstract wrapper around the Google.Apis.YouTube.v3 library. Instead, it simplifies the housekeeping involved in setting up an Google.Apis.YouTube.v3 client and requires you to provide functions that fetch whatever data you need. Each request will be sent for each input document.

Constructors

Name Summary
ReadYouTube(string) Creates a connection to the YouTube API with authenticated access.

Properties

Name Property Type Summary
Parallel bool
Indicates whether documents will be processed by this module in parallel.
Inherited from ParallelSyncModule

Methods

Name Return Value Summary
AfterExecution(IExecutionContext, ExecutionOutputs) void
Called after each module execution.
Inherited from Module
AfterExecutionAsync(IExecutionContext, ExecutionOutputs) Task
Called after each module execution.
Inherited from Module
BeforeExecution(IExecutionContext) void
Called before each module execution.
Inherited from Module
BeforeExecutionAsync(IExecutionContext) Task
Called before each module execution.
Inherited from Module
Dispose() void
ExecuteAsync(IExecutionContext) Task<IEnumerable<IDocument>>
This should not be called directly, instead call IExecutionContext.Execute() if you need to execute a module from within another module.
Inherited from Module
ExecuteContextAsync(IExecutionContext) Task<IEnumerable<IDocument>>
Executes the module once for all input documents.
Inherited from ParallelSyncModule
ExecuteInput(IDocument, IExecutionContext) IEnumerable<IDocument>
ExecuteInputAsync(IDocument, IExecutionContext) Task<IEnumerable<IDocument>>
Executes the module.
Inherited from ParallelSyncModule
Finally(IExecutionContext) void
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
FinallyAsync(IExecutionContext) Task
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
WithRequest(string, Func<IDocument, IExecutionContext, YouTubeService, object>) ReadYouTube
Submits a request to the YouTube client. This allows you to incorporate data from the execution context and current document in your request.
WithRequest(string, Func<IExecutionContext, YouTubeService, object>) ReadYouTube
Submits a request to the YouTube client. This allows you to incorporate data from the execution context in your request.

Extension Methods