Class Fetcher

Inheritance
Object
Fetcher
Namespace: GoogleSheetFetcher.Editor
Assembly: GoogleSheetFetcher.Editor.dll
Syntax
public class Fetcher

Properties

| Improve this Doc View Source

DidInitialize

Declaration
public bool DidInitialize { get; }
Property Value
Type Description
Boolean

Methods

| Improve this Doc View Source

FetchFilesAsync(String, FileType[], Int32, String)

Fetch the metadata of the files in the specified folder.

Declaration
public AsyncControlHandle<FileList> FetchFilesAsync(string folderIdOrName, FileType[] fileTypes, int pageSize = 100, string pageToken = null)
Parameters
Type Name Description
String folderIdOrName

A folder id or a folder name.
FileType[] fileTypes

An array of FileType you needed.
Int32 pageSize

Number of data to be fetched at one time.
String pageToken

A token to fetch the next page.
Returns
Type Description
AsyncControlHandle<FileList>
| Improve this Doc View Source

FetchSheetsAsync(String)

Fetch the information of all the sheets contained in the spread sheet.

Declaration
public AsyncControlHandle<IList<Sheet>> FetchSheetsAsync(string spreadsheetId)
Parameters
Type Name Description
String spreadsheetId

The spreadsheet id.
Returns
Type Description
AsyncControlHandle<IList<Sheet>>

The list of the information of all the sheets.
| Improve this Doc View Source

FetchValuesAsync(String, Sheet)

Fetch all the values contained in the sheet.

Declaration
public AsyncControlHandle<IList<IList<object>>> FetchValuesAsync(string spreadsheetId, Sheet sheet = null)
Parameters
Type Name Description
String spreadsheetId

The spreadsheet id.
Sheet sheet

The Sheet instance obtained as the result of FetchSheetsAsync(String).
Returns
Type Description
AsyncControlHandle<IList<IList<Object>>>

The list of the rows.
| Improve this Doc View Source

FetchValuesAsync(String, String)

Fetch all the values contained in the sheet.

Declaration
public AsyncControlHandle<IList<IList<object>>> FetchValuesAsync(string spreadsheetId, string sheetName = null)
Parameters
Type Name Description
String spreadsheetId

The spreadsheet id.
String sheetName

The sheet name.
Returns
Type Description
AsyncControlHandle<IList<IList<Object>>>

The list of the rows.
| Improve this Doc View Source

InitializeAsync(String, String, String)

Initialize the Fetcher with the following scopes.

* https://www.googleapis.com/auth/drive.readonly

* https://www.googleapis.com/auth/spreadsheets.readonly

Declaration
public AsyncControlHandle InitializeAsync(string clientId, string clientSecret, string applicationId)
Parameters
Type Name Description
String clientId

Google OAuth2 Client ID.
String clientSecret

Google OAuth2 Client Secret.
String applicationId

The identifier to use the for file to store the credentials.
Returns
Type Description
AsyncControlHandle
| Improve this Doc View Source

InitializeAsync(String, String, String, List<String>)

Initialize the Fetcher.

Declaration
public AsyncControlHandle InitializeAsync(string clientId, string clientSecret, string applicationId, List<string> scopes)
Parameters
Type Name Description
String clientId

Google OAuth2 Client ID.
String clientSecret

Google OAuth2 Client Secret.
String applicationId

The identifier to use the for file to store the credentials.
List<String> scopes

The scopes you want to use.
Returns
Type Description
AsyncControlHandle