Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 613 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

GoogleWorkspaceSession

Edit on GitHub
Namespace OfficeIMO.GoogleWorkspace
Assembly OfficeIMO.GoogleWorkspace
Source revision a039964de4cc with working tree changes
Source GoogleWorkspaceSession.cs:6
Modifiers sealed

Represents a configured Google Workspace session used by exporter packages.

Inheritance

  • Object
  • GoogleWorkspaceSession

Guides & Samples

Authored walkthroughs and practical samples linked to this API.

  • Google Workspace Guide

    Choose and configure the OfficeIMO libraries for Google Docs, Sheets, Slides, Drive, and synchronization. Includes examples and package links.

  • Shared drives Guide

    Validate shared-drive and folder identity, target translators, and track per-drive changes. Includes examples and package links.

Usage

Explore 2 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters 2

Constructors

public GoogleWorkspaceSession(IGoogleWorkspaceCredentialSource credentialSource, GoogleWorkspaceSessionOptions? options = null) #
GoogleWorkspaceSession.cs:6

Creates a session from a credential source and optional transport and policy settings.

Parameters

credentialSource OfficeIMO.GoogleWorkspace.IGoogleWorkspaceCredentialSource requiredposition: 0
Source used to acquire scoped Google OAuth tokens.
options OfficeIMO.GoogleWorkspace.GoogleWorkspaceSessionOptions? = null optionalposition: 1
Session settings, or null to use defaults.

Methods

public async Task<GoogleWorkspaceAccessToken> AcquireAccessTokenAsync(IEnumerable<String> scopes, CancellationToken cancellationToken = default) #
Returns: Task<GoogleWorkspaceAccessToken>

Acquires and validates a token for every requested scope and the configured expected account.

Parameters

scopes System.Collections.Generic.IEnumerable<System.String> requiredposition: 0
OAuth scopes required by the operation. Blank and duplicate entries are removed.
cancellationToken System.Threading.CancellationToken = default optionalposition: 1
Token used to cancel acquisition.

Returns

A nonexpired token whose bound scopes cover the normalized request.

Exceptions

  • InvalidOperationException – The credential source returns no token, an expired token, insufficient scopes, or identity evidence that does not match the session policy.
public GoogleDriveFileLocation ResolveLocationDefaults(GoogleDriveFileLocation? location) #
GoogleWorkspaceSession.cs:27
Returns: GoogleDriveFileLocation

Combines an operation-specific Drive location with the session defaults.

Parameters

location OfficeIMO.GoogleWorkspace.GoogleDriveFileLocation? requiredposition: 0
Location supplied by the operation, or null to use all defaults.

Returns

A new location instance; the supplied instance is not modified.

Properties

public IGoogleWorkspaceCredentialSource CredentialSource { get; } #
GoogleWorkspaceSession.cs:19

Gets the credential source used by this session.

public GoogleWorkspaceSessionOptions Options { get; } #
GoogleWorkspaceSession.cs:21

Gets the transport, retry, identity, and operation-policy settings.