Class ShareDirectoryClient

Package version

Hierarchy

StorageClient
- ShareDirectoryClient

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ShareDirectoryClient(url: string, credential: Credential, options: StoragePipelineOptions): ShareDirectoryClient
new ShareDirectoryClient(url: string, pipeline: Pipeline): ShareDirectoryClient

Overrides StorageClient.constructor
- Defined in ShareDirectoryClient.ts:397
Parameters
- url: string
- Optional credential: Credential
- Optional options: StoragePipelineOptions
Returns ShareDirectoryClient
Overrides StorageClient.constructor
- Defined in ShareDirectoryClient.ts:415
Parameters
- url: string
- pipeline: Pipeline
Returns ShareDirectoryClient

Properties

accountName

accountName: string

Protected storageClientContext

storageClientContext: StorageClientContext

url

url: string

Accessors

name

name:

path

path:

shareName

shareName:

Methods

create

create(options?: DirectoryCreateOptions): Promise<DirectoryCreateResponse>

- Defined in ShareDirectoryClient.ts:470
Parameters
- Default value options: DirectoryCreateOptions = {}
Returns Promise<DirectoryCreateResponse>

Response data for the Directory operation.

createFile

createFile(fileName: string, size: number, options?: FileCreateOptions): Promise<object>

- Defined in ShareDirectoryClient.ts:653
Parameters
- fileName: string
- size: number
- Default value options: FileCreateOptions = {}
Returns Promise<object>

} File creation response data and the corresponding file client.

createSubdirectory

createSubdirectory(directoryName: string, options?: DirectoryCreateOptions): Promise<object>

- Defined in ShareDirectoryClient.ts:576
Parameters
- directoryName: string
- Default value options: DirectoryCreateOptions = {}
Returns Promise<object>

} Directory create response data and the corresponding DirectoryClient instance.

delete

delete(options?: DirectoryDeleteOptions): Promise<DirectoryDeleteResponse>

- Defined in ShareDirectoryClient.ts:797
Parameters
- Default value options: DirectoryDeleteOptions = {}
Returns Promise<DirectoryDeleteResponse>

Response data for the Directory Delete operation.

deleteFile

deleteFile(fileName: string, options?: FileDeleteOptions): Promise<FileDeleteResponse>

- Defined in ShareDirectoryClient.ts:702
Parameters
- fileName: string
- Default value options: FileDeleteOptions = {}
Returns Promise<FileDeleteResponse>

File deletion response data.

deleteSubdirectory

deleteSubdirectory(directoryName: string, options?: DirectoryDeleteOptions): Promise<DirectoryDeleteResponse>

- Defined in ShareDirectoryClient.ts:618
Parameters
- directoryName: string
- Default value options: DirectoryDeleteOptions = {}
Returns Promise<DirectoryDeleteResponse>

Directory deletion response data.

forceCloseAllHandles

forceCloseAllHandles(options?: DirectoryForceCloseHandlesSegmentOptions): Promise<CloseHandlesInfo>

- Defined in ShareDirectoryClient.ts:1331
Parameters
- Default value options: DirectoryForceCloseHandlesSegmentOptions = {}
Returns Promise<CloseHandlesInfo>

forceCloseHandle

forceCloseHandle(handleId: string, options?: DirectoryForceCloseHandlesOptions): Promise<DirectoryForceCloseHandlesResponse>

- Defined in ShareDirectoryClient.ts:1375
Parameters
- handleId: string
- Default value options: DirectoryForceCloseHandlesOptions = {}
Returns Promise<DirectoryForceCloseHandlesResponse>

getDirectoryClient

getDirectoryClient(subDirectoryName: string): ShareDirectoryClient

- Defined in ShareDirectoryClient.ts:560
Parameters
- subDirectoryName: string
Returns ShareDirectoryClient

The ShareDirectoryClient object for the given subdirectory name.

getFileClient

getFileClient(fileName: string): ShareFileClient

- Defined in ShareDirectoryClient.ts:748
Parameters
- fileName: string
Returns ShareFileClient

A new ShareFileClient object for the given file name.

getProperties

getProperties(options?: DirectoryGetPropertiesOptions): Promise<DirectoryGetPropertiesResponse>

- Defined in ShareDirectoryClient.ts:765
Parameters
- Default value options: DirectoryGetPropertiesOptions = {}
Returns Promise<DirectoryGetPropertiesResponse>

Response data for the Directory Get Properties operation.

listFilesAndDirectories

listFilesAndDirectories(options?: DirectoryListFilesAndDirectoriesOptions): PagedAsyncIterableIterator<object & FileItem | object & DirectoryItem, DirectoryListFilesAndDirectoriesSegmentResponse>

- Defined in ShareDirectoryClient.ts:1003
Parameters
- Default value options: DirectoryListFilesAndDirectoriesOptions = {}
Returns PagedAsyncIterableIterator<object & FileItem | object & DirectoryItem, DirectoryListFilesAndDirectoriesSegmentResponse>

& FileItem | { kind: "directory" } , DirectoryListFilesAndDirectoriesSegmentResponse>} An asyncIterableIterator that supports paging.

listHandles

listHandles(options?: DirectoryListHandlesOptions): PagedAsyncIterableIterator<HandleItem, DirectoryListHandlesResponse>

- Defined in ShareDirectoryClient.ts:1205
Parameters
- Default value options: DirectoryListHandlesOptions = {}
Returns PagedAsyncIterableIterator<HandleItem, DirectoryListHandlesResponse>

An asyncIterableIterator that supports paging.

setMetadata

setMetadata(metadata: Metadata, options?: DirectorySetMetadataOptions): Promise<DirectorySetMetadataResponse>

- Defined in ShareDirectoryClient.ts:824
Parameters
- Optional metadata: Metadata
- Default value options: DirectorySetMetadataOptions = {}
Returns Promise<DirectorySetMetadataResponse>

Response data for the Directory Set Metadata operation.

setProperties

setProperties(properties?: DirectoryProperties): Promise<DirectorySetPropertiesResponse>

- Defined in ShareDirectoryClient.ts:513
Parameters
- Default value properties: DirectoryProperties = {}
Returns Promise<DirectorySetPropertiesResponse>

Generated using TypeDoc