C# Class Vtex.Workspaces.Client.WorkspacesClient

A client which supports workspace operations.

Inheritance: IWorkspacesClient

Exibir arquivo Open project: vtex/workspaces-client-net

Public Methods

Method	Description
CreateAsync ( string account, string workspace, CancellationToken cancellationToken ) : Task
CreateChangesAsync ( string account, string workspace, string bucket, FileChangesBatch changeSet, CancellationToken cancellationToken ) : Task
DeleteAsync ( string account, string workspace, CancellationToken cancellationToken ) : Task
FromRequest ( HttpRequestMessage requestMessage, WorkspacesEndpoint endpoint, ProductInfoHeaderValue userAgent ) : WorkspacesClient
GetAsync ( string account, string workspace, CancellationToken cancellationToken ) : Task
GetFileAsync ( string account, string workspace, string bucket, string path, CancellationToken cancellationToken ) : Task
ListAsync ( string account, CancellationToken cancellationToken ) : Task>
ListBucketsAsync ( string account, string workspace, CancellationToken cancellationToken ) : Task>
ListFilesAsync ( string account, string workspace, string bucket, ScanOptions scanOptions, CancellationToken cancellationToken ) : Task>
ListFilesAsync ( string account, string workspace, string bucket, ScanOptions scanOptions, bool includeContent, CancellationToken cancellationToken ) : Task>
PromoteAsync ( string account, string workspace, CancellationToken cancellationToken ) : Task
WorkspacesClient ( HttpCachedGalleryConnector connector, bool acceptSnapshot = true ) : System	Construct a new workspace client.
WorkspacesClient ( VtexCredentials credentials, ProductInfoHeaderValue userAgent, bool acceptSnapshot = true ) : System
WorkspacesClient ( WorkspacesEndpoint endpoint, VtexCredentials credentials, ProductInfoHeaderValue userAgent, bool acceptSnapshot = true ) : System

Private Methods

Method	Description
WorkspacesClient ( IGalleryConnector connector, bool acceptSnapshot = true ) : System

Method Details

CreateAsync() public method

public CreateAsync ( string account, string workspace, CancellationToken cancellationToken ) : Task
account	string
workspace	string
cancellationToken	System.Threading.CancellationToken
return	Task

CreateChangesAsync() public method

public CreateChangesAsync ( string account, string workspace, string bucket, FileChangesBatch changeSet, CancellationToken cancellationToken ) : Task
account	string
workspace	string
bucket	string
changeSet	Vtex.Workspaces.Client.Models.Request.FileChangesBatch
cancellationToken	System.Threading.CancellationToken
return	Task

DeleteAsync() public method

public DeleteAsync ( string account, string workspace, CancellationToken cancellationToken ) : Task
account	string
workspace	string
cancellationToken	System.Threading.CancellationToken
return	Task

FromRequest() public static method

public static FromRequest ( HttpRequestMessage requestMessage, WorkspacesEndpoint endpoint, ProductInfoHeaderValue userAgent ) : WorkspacesClient
requestMessage	System.Net.Http.HttpRequestMessage
endpoint	WorkspacesEndpoint
userAgent	System.Net.Http.Headers.ProductInfoHeaderValue
return	WorkspacesClient

GetAsync() public method

public GetAsync ( string account, string workspace, CancellationToken cancellationToken ) : Task
account	string
workspace	string
cancellationToken	System.Threading.CancellationToken
return	Task

GetFileAsync() public method

public GetFileAsync ( string account, string workspace, string bucket, string path, CancellationToken cancellationToken ) : Task
account	string
workspace	string
bucket	string
path	string
cancellationToken	System.Threading.CancellationToken
return	Task

ListAsync() public method

public ListAsync ( string account, CancellationToken cancellationToken ) : Task>
account	string
cancellationToken	System.Threading.CancellationToken
return	Task>

ListBucketsAsync() public method

public ListBucketsAsync ( string account, string workspace, CancellationToken cancellationToken ) : Task>
account	string
workspace	string
cancellationToken	System.Threading.CancellationToken
return	Task>

ListFilesAsync() public method

public ListFilesAsync ( string account, string workspace, string bucket, ScanOptions scanOptions, CancellationToken cancellationToken ) : Task>
account	string
workspace	string
bucket	string
scanOptions	Vtex.Gallery.Core.Models.Request.ScanOptions
cancellationToken	System.Threading.CancellationToken
return	Task>

ListFilesAsync() public method

public ListFilesAsync ( string account, string workspace, string bucket, ScanOptions scanOptions, bool includeContent, CancellationToken cancellationToken ) : Task>
account	string
workspace	string
bucket	string
scanOptions	Vtex.Gallery.Core.Models.Request.ScanOptions
includeContent	bool
cancellationToken	System.Threading.CancellationToken
return	Task>

PromoteAsync() public method

public PromoteAsync ( string account, string workspace, CancellationToken cancellationToken ) : Task
account	string
workspace	string
cancellationToken	System.Threading.CancellationToken
return	Task

WorkspacesClient() public method

Construct a new workspace client.

Thrown if connector is null.

public WorkspacesClient ( HttpCachedGalleryConnector connector, bool acceptSnapshot = true ) : System
connector	HttpCachedGalleryConnector	Workspaces connector.See /// for more information.
acceptSnapshot	bool	If accepts snapshot files. Default is true.
return	System

WorkspacesClient() public method

public WorkspacesClient ( VtexCredentials credentials, ProductInfoHeaderValue userAgent, bool acceptSnapshot = true ) : System
credentials	Vtex.Gallery.Core.VtexCredentials
userAgent	System.Net.Http.Headers.ProductInfoHeaderValue
acceptSnapshot	bool
return	System

WorkspacesClient() public method

public WorkspacesClient ( WorkspacesEndpoint endpoint, VtexCredentials credentials, ProductInfoHeaderValue userAgent, bool acceptSnapshot = true ) : System
endpoint	WorkspacesEndpoint
credentials	Vtex.Gallery.Core.VtexCredentials
userAgent	System.Net.Http.Headers.ProductInfoHeaderValue
acceptSnapshot	bool
return	System