BoxClient Class

Definition

Namespace:

Azure.Connectors.Sdk.Box

Assembly:

Azure.Connectors.Sdk.dll

Package:

Azure.Connectors.Sdk v0.13.0-preview.1

Typed client for box connector.

public class BoxClient : Azure.Connectors.Sdk.ConnectorClientBase

type BoxClient = class
    inherit ConnectorClientBase

Public Class BoxClient
Inherits ConnectorClientBase

Inheritance

Object

ConnectorClientBase

BoxClient

Constructors

Name	Description
BoxClient()
BoxClient(String)	Creates a new BoxClient with the specified connection runtime URL string. Uses ManagedIdentityCredential by default.
BoxClient(Uri, TokenCredential, ConnectorClientOptions)	Creates a new BoxClient with the specified connection runtime URL and credential.
BoxClient(Uri, TokenCredential)	Creates a new BoxClient with the specified connection runtime URL and credential.
BoxClient(Uri)	Creates a new BoxClient with the specified connection runtime URL. Uses ManagedIdentityCredential by default.

Properties

Name	Description
ConnectorName
Pipeline	Gets the HTTP pipeline for making connector requests. (Inherited from ConnectorClientBase)

Methods

Name	Description
CallConnectorAsync(HttpMethod, String, Object, CancellationToken)	Sends a connector API request with no response body. Uses the Azure.Core HttpPipeline for retry, authentication, and diagnostics. (Inherited from ConnectorClientBase)
CallConnectorAsync<TResponse>(HttpMethod, String, Object, CancellationToken)	Sends a connector API request and deserializes the JSON response. Uses the Azure.Core HttpPipeline for retry, authentication, and diagnostics. (Inherited from ConnectorClientBase)
CopyFileAsync(String, String, Nullable<Boolean>, CancellationToken)	Copy file
CreateFileAsync(Byte[], String, String, CancellationToken)	Create file
DeleteFileAsync(String, CancellationToken)	Delete file
Dispose()	(Inherited from ConnectorClientBase)
Dispose(Boolean)	Disposes the connector client resources. (Inherited from ConnectorClientBase)
ExtractFolderAsync(String, String, Nullable<Boolean>, CancellationToken)	Extract archive to folder
GetFileContentAsync(String, Nullable<Boolean>, CancellationToken)	Get file content using id
GetFileContentByPathAsync(String, Nullable<Boolean>, CancellationToken)	Get file content using path
GetFileMetadataAsync(String, CancellationToken)	Get file metadata using id
GetFileMetadataByPathAsync(String, CancellationToken)	Get file metadata using path
ResolveUrl(String)	Resolves a relative path or validates an absolute URL against the connection runtime URL. When the NextLink host matches the connection URL, it's used as-is. When it doesn't match (codeless connectors like ARM return nextLink pointing to the backend host e.g. management.azure.com), the path+query is extracted and routed through the APIM proxy. This is safe because the request still goes through the connection runtime URL with API Hub auth. (Inherited from ConnectorClientBase)
UpdateFileAsync(String, Byte[], CancellationToken)	Update file