ApiBaseAddAuthorizationHeader Method

Adds authorization headers to an HTTP request.

Definition

Namespace: GenerativeAI.Core
Assembly: GenerativeAI (in GenerativeAI.dll) Version: 2.0.2+aa51399cad6d90cc71158d589a6268608b3c1893
C#
protected virtual Task AddAuthorizationHeader(
	HttpRequestMessage request,
	bool requireAccessToken = false,
	CancellationToken cancellationToken = default
)

Parameters

request  HttpRequestMessage
The HTTP request where headers will be added.
requireAccessToken  Boolean  (Optional)

[Missing <param name="requireAccessToken"/> documentation for "M:GenerativeAI.Core.ApiBase.AddAuthorizationHeader(System.Net.Http.HttpRequestMessage,System.Boolean,System.Threading.CancellationToken)"]

cancellationToken  CancellationToken  (Optional)

[Missing <param name="cancellationToken"/> documentation for "M:GenerativeAI.Core.ApiBase.AddAuthorizationHeader(System.Net.Http.HttpRequestMessage,System.Boolean,System.Threading.CancellationToken)"]

Return Value

Task

[Missing <returns> documentation for "M:GenerativeAI.Core.ApiBase.AddAuthorizationHeader(System.Net.Http.HttpRequestMessage,System.Boolean,System.Threading.CancellationToken)"]

Remarks

Override this method in derived classes to dynamically add authorization headers. By default, this implementation does nothing.

See Also