Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 622 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

GoogleWorkspaceHttpTransport

Edit on GitHub
Namespace OfficeIMO.GoogleWorkspace
Assembly OfficeIMO.GoogleWorkspace
Source revision 33d062b583cb with working tree changes
Source GoogleWorkspaceHttpTransport.cs:60
Implements
IDisposable
Modifiers sealed

Dependency-light HTTP transport shared by Google Workspace domain packages.

Inheritance

  • Object
  • GoogleWorkspaceHttpTransport

Constructors

GoogleWorkspaceHttpTransport 2 overloads
public GoogleWorkspaceHttpTransport(GoogleWorkspaceSessionOptions options) #
GoogleWorkspaceHttpTransport.cs:60

Creates a transport for safe read operations from standalone session options.

Parameters

options OfficeIMO.GoogleWorkspace.GoogleWorkspaceSessionOptions requiredposition: 0
HTTP, retry, quota, and diagnostic settings.
public GoogleWorkspaceHttpTransport(GoogleWorkspaceSession session) #
GoogleWorkspaceHttpTransport.cs:64

Creates a transport whose mutations are bound to credentials acquired by the supplied session.

Parameters

session OfficeIMO.GoogleWorkspace.GoogleWorkspaceSession requiredposition: 0

Methods

public Void Dispose() #
GoogleWorkspaceHttpTransport.cs:770
Returns: Void

Disposes the internally created HTTP client; a caller-supplied client remains caller-owned.

SendAsync``1 2 overloads
public Task<TResponse?> SendAsync<TResponse>(String accessToken, HttpMethod method, String uri, Func<HttpContent?>? contentFactory, GoogleWorkspaceRequestSafety requestSafety, String serviceName, TranslationReport report, CancellationToken cancellationToken = default, Int64? maxResponseBytes = null, GoogleWorkspaceMutationKind mutationKind = Unspecified, GoogleWorkspaceRevisionPrecondition? revisionPrecondition = null, IReadOnlyCollection<String>? requiredScopes = null, Boolean potentialDataLoss = false) #
GoogleWorkspaceHttpTransport.cs:208
Returns: Task<TResponse?>

Sends content produced for each attempt and deserializes a successful JSON response.

Type Parameters

TResponse

Parameters

accessToken System.String requiredposition: 0
method System.Net.Http.HttpMethod requiredposition: 1
uri System.String requiredposition: 2
contentFactory System.Func<System.Net.Http.HttpContent?>? requiredposition: 3
requestSafety OfficeIMO.GoogleWorkspace.GoogleWorkspaceRequestSafety requiredposition: 4
serviceName System.String requiredposition: 5
report OfficeIMO.GoogleWorkspace.TranslationReport requiredposition: 6
cancellationToken System.Threading.CancellationToken = default optionalposition: 7
maxResponseBytes System.Int64? = null optionalposition: 8
mutationKind OfficeIMO.GoogleWorkspace.GoogleWorkspaceMutationKind = Unspecified optionalposition: 9
revisionPrecondition OfficeIMO.GoogleWorkspace.GoogleWorkspaceRevisionPrecondition? = null optionalposition: 10
requiredScopes System.Collections.Generic.IReadOnlyCollection<System.String>? = null optionalposition: 11
potentialDataLoss System.Boolean = false optionalposition: 12
public Task<TResponse?> SendAsync<TResponse>(String accessToken, HttpMethod method, String uri, Func<HttpContent?>? contentFactory, GoogleWorkspaceRequestSafety requestSafety, String serviceName, TranslationReport report, JsonTypeInfo<TResponse?> responseTypeInfo, CancellationToken cancellationToken = default, Int64? maxResponseBytes = null, GoogleWorkspaceMutationKind mutationKind = Unspecified, GoogleWorkspaceRevisionPrecondition? revisionPrecondition = null, IReadOnlyCollection<String>? requiredScopes = null, Boolean potentialDataLoss = false) #
GoogleWorkspaceHttpTransport.cs:243
Returns: Task<TResponse?>

Sends a request and deserializes the response with source-generated metadata.

Type Parameters

TResponse

Parameters

accessToken System.String requiredposition: 0
method System.Net.Http.HttpMethod requiredposition: 1
uri System.String requiredposition: 2
contentFactory System.Func<System.Net.Http.HttpContent?>? requiredposition: 3
requestSafety OfficeIMO.GoogleWorkspace.GoogleWorkspaceRequestSafety requiredposition: 4
serviceName System.String requiredposition: 5
report OfficeIMO.GoogleWorkspace.TranslationReport requiredposition: 6
responseTypeInfo System.Text.Json.Serialization.Metadata.JsonTypeInfo<TResponse?> requiredposition: 7
cancellationToken System.Threading.CancellationToken = default optionalposition: 8
maxResponseBytes System.Int64? = null optionalposition: 9
mutationKind OfficeIMO.GoogleWorkspace.GoogleWorkspaceMutationKind = Unspecified optionalposition: 10
revisionPrecondition OfficeIMO.GoogleWorkspace.GoogleWorkspaceRevisionPrecondition? = null optionalposition: 11
requiredScopes System.Collections.Generic.IReadOnlyCollection<System.String>? = null optionalposition: 12
potentialDataLoss System.Boolean = false optionalposition: 13
public async Task<Byte[]> SendBytesAsync(String accessToken, HttpMethod method, String uri, GoogleWorkspaceRequestSafety requestSafety, String serviceName, TranslationReport report, CancellationToken cancellationToken = default, Boolean preserveRequestUri = false, Boolean includeAuthorization = true, Int64? maxResponseBytes = null, Action<HttpRequestMessage>? configureRequest = null, GoogleWorkspaceMutationKind mutationKind = Unspecified, GoogleWorkspaceRevisionPrecondition? revisionPrecondition = null, Action<HttpResponseMessage>? validateResponse = null, IReadOnlyCollection<String>? requiredScopes = null, Boolean potentialDataLoss = false) #
Returns: Task<Byte[]>

Sends a request and returns the successful response body as bytes.

Parameters

accessToken System.String requiredposition: 0
method System.Net.Http.HttpMethod requiredposition: 1
uri System.String requiredposition: 2
requestSafety OfficeIMO.GoogleWorkspace.GoogleWorkspaceRequestSafety requiredposition: 3
serviceName System.String requiredposition: 4
report OfficeIMO.GoogleWorkspace.TranslationReport requiredposition: 5
cancellationToken System.Threading.CancellationToken = default optionalposition: 6
preserveRequestUri System.Boolean = false optionalposition: 7
includeAuthorization System.Boolean = true optionalposition: 8
maxResponseBytes System.Int64? = null optionalposition: 9
configureRequest System.Action<System.Net.Http.HttpRequestMessage>? = null optionalposition: 10
mutationKind OfficeIMO.GoogleWorkspace.GoogleWorkspaceMutationKind = Unspecified optionalposition: 11
revisionPrecondition OfficeIMO.GoogleWorkspace.GoogleWorkspaceRevisionPrecondition? = null optionalposition: 12
validateResponse System.Action<System.Net.Http.HttpResponseMessage>? = null optionalposition: 13
requiredScopes System.Collections.Generic.IReadOnlyCollection<System.String>? = null optionalposition: 14
potentialDataLoss System.Boolean = false optionalposition: 15
SendJsonAsync``1 2 overloads
public Task<TResponse?> SendJsonAsync<TResponse>(String accessToken, HttpMethod method, String uri, Object? payload, GoogleWorkspaceRequestSafety requestSafety, String serviceName, TranslationReport report, CancellationToken cancellationToken = default, Int64? maxResponseBytes = null, GoogleWorkspaceMutationKind mutationKind = Unspecified, GoogleWorkspaceRevisionPrecondition? revisionPrecondition = null, IReadOnlyCollection<String>? requiredScopes = null, Boolean potentialDataLoss = false) #
GoogleWorkspaceHttpTransport.cs:96
Returns: Task<TResponse?>

Serializes an optional payload as JSON, sends the request, and deserializes a successful JSON response.

Type Parameters

TResponse

Parameters

accessToken System.String requiredposition: 0
method System.Net.Http.HttpMethod requiredposition: 1
uri System.String requiredposition: 2
payload System.Object? requiredposition: 3
requestSafety OfficeIMO.GoogleWorkspace.GoogleWorkspaceRequestSafety requiredposition: 4
serviceName System.String requiredposition: 5
report OfficeIMO.GoogleWorkspace.TranslationReport requiredposition: 6
cancellationToken System.Threading.CancellationToken = default optionalposition: 7
maxResponseBytes System.Int64? = null optionalposition: 8
mutationKind OfficeIMO.GoogleWorkspace.GoogleWorkspaceMutationKind = Unspecified optionalposition: 9
revisionPrecondition OfficeIMO.GoogleWorkspace.GoogleWorkspaceRevisionPrecondition? = null optionalposition: 10
requiredScopes System.Collections.Generic.IReadOnlyCollection<System.String>? = null optionalposition: 11
potentialDataLoss System.Boolean = false optionalposition: 12
public Task<TResponse?> SendJsonAsync<TResponse>(String accessToken, HttpMethod method, String uri, JsonNode? payload, GoogleWorkspaceRequestSafety requestSafety, String serviceName, TranslationReport report, JsonTypeInfo<TResponse?> responseTypeInfo, CancellationToken cancellationToken = default, Int64? maxResponseBytes = null, GoogleWorkspaceMutationKind mutationKind = Unspecified, GoogleWorkspaceRevisionPrecondition? revisionPrecondition = null, IReadOnlyCollection<String>? requiredScopes = null, Boolean potentialDataLoss = false) #
GoogleWorkspaceHttpTransport.cs:170
Returns: Task<TResponse?>

Sends an optional JSON node and deserializes the response with source-generated metadata.

Type Parameters

TResponse

Parameters

accessToken System.String requiredposition: 0
method System.Net.Http.HttpMethod requiredposition: 1
uri System.String requiredposition: 2
payload System.Text.Json.Nodes.JsonNode? requiredposition: 3
requestSafety OfficeIMO.GoogleWorkspace.GoogleWorkspaceRequestSafety requiredposition: 4
serviceName System.String requiredposition: 5
report OfficeIMO.GoogleWorkspace.TranslationReport requiredposition: 6
responseTypeInfo System.Text.Json.Serialization.Metadata.JsonTypeInfo<TResponse?> requiredposition: 7
cancellationToken System.Threading.CancellationToken = default optionalposition: 8
maxResponseBytes System.Int64? = null optionalposition: 9
mutationKind OfficeIMO.GoogleWorkspace.GoogleWorkspaceMutationKind = Unspecified optionalposition: 10
revisionPrecondition OfficeIMO.GoogleWorkspace.GoogleWorkspaceRevisionPrecondition? = null optionalposition: 11
requiredScopes System.Collections.Generic.IReadOnlyCollection<System.String>? = null optionalposition: 12
potentialDataLoss System.Boolean = false optionalposition: 13
public Task<TResponse?> SendJsonAsync<TRequest, TResponse>(String accessToken, HttpMethod method, String uri, TRequest? payload, GoogleWorkspaceRequestSafety requestSafety, String serviceName, TranslationReport report, JsonTypeInfo<TRequest?> requestTypeInfo, JsonTypeInfo<TResponse?> responseTypeInfo, CancellationToken cancellationToken = default, Int64? maxResponseBytes = null, GoogleWorkspaceMutationKind mutationKind = Unspecified, GoogleWorkspaceRevisionPrecondition? revisionPrecondition = null, IReadOnlyCollection<String>? requiredScopes = null, Boolean potentialDataLoss = false) #
GoogleWorkspaceHttpTransport.cs:133
Returns: Task<TResponse?>

Sends a typed JSON payload and deserializes the response with source-generated metadata.

Type Parameters

TRequest
TResponse

Parameters

accessToken System.String requiredposition: 0
method System.Net.Http.HttpMethod requiredposition: 1
uri System.String requiredposition: 2
payload TRequest? requiredposition: 3
requestSafety OfficeIMO.GoogleWorkspace.GoogleWorkspaceRequestSafety requiredposition: 4
serviceName System.String requiredposition: 5
report OfficeIMO.GoogleWorkspace.TranslationReport requiredposition: 6
requestTypeInfo System.Text.Json.Serialization.Metadata.JsonTypeInfo<TRequest?> requiredposition: 7
responseTypeInfo System.Text.Json.Serialization.Metadata.JsonTypeInfo<TResponse?> requiredposition: 8
cancellationToken System.Threading.CancellationToken = default optionalposition: 9
maxResponseBytes System.Int64? = null optionalposition: 10
mutationKind OfficeIMO.GoogleWorkspace.GoogleWorkspaceMutationKind = Unspecified optionalposition: 11
revisionPrecondition OfficeIMO.GoogleWorkspace.GoogleWorkspaceRevisionPrecondition? = null optionalposition: 12
requiredScopes System.Collections.Generic.IReadOnlyCollection<System.String>? = null optionalposition: 13
potentialDataLoss System.Boolean = false optionalposition: 14
public Task<GoogleWorkspaceHttpResponse> SendRawAsync(String accessToken, HttpMethod method, String uri, Func<HttpContent?>? contentFactory, GoogleWorkspaceRequestSafety requestSafety, String serviceName, TranslationReport report, CancellationToken cancellationToken = default, Action<HttpRequestMessage>? configureRequest = null, IReadOnlyCollection<HttpStatusCode>? additionalSuccessStatusCodes = null, Boolean preserveRequestUri = false, String? diagnosticTarget = null, GoogleWorkspaceMutationKind mutationKind = Unspecified, GoogleWorkspaceRevisionPrecondition? revisionPrecondition = null, IReadOnlyCollection<String>? requiredScopes = null, Boolean potentialDataLoss = false) #
GoogleWorkspaceHttpTransport.cs:651
Returns: Task<GoogleWorkspaceHttpResponse>

Sends a request and returns status, headers, media type, and body without JSON conversion.

Parameters

accessToken System.String requiredposition: 0
method System.Net.Http.HttpMethod requiredposition: 1
uri System.String requiredposition: 2
contentFactory System.Func<System.Net.Http.HttpContent?>? requiredposition: 3
requestSafety OfficeIMO.GoogleWorkspace.GoogleWorkspaceRequestSafety requiredposition: 4
serviceName System.String requiredposition: 5
report OfficeIMO.GoogleWorkspace.TranslationReport requiredposition: 6
cancellationToken System.Threading.CancellationToken = default optionalposition: 7
configureRequest System.Action<System.Net.Http.HttpRequestMessage>? = null optionalposition: 8
additionalSuccessStatusCodes System.Collections.Generic.IReadOnlyCollection<System.Net.HttpStatusCode>? = null optionalposition: 9
preserveRequestUri System.Boolean = false optionalposition: 10
diagnosticTarget System.String? = null optionalposition: 11
mutationKind OfficeIMO.GoogleWorkspace.GoogleWorkspaceMutationKind = Unspecified optionalposition: 12
revisionPrecondition OfficeIMO.GoogleWorkspace.GoogleWorkspaceRevisionPrecondition? = null optionalposition: 13
requiredScopes System.Collections.Generic.IReadOnlyCollection<System.String>? = null optionalposition: 14
potentialDataLoss System.Boolean = false optionalposition: 15