Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DirectoryListHandlesOptionalParams

Package version

Optional Parameters.

Hierarchy

Indexable

[key: string]: any

Optional Parameters.

Index

Properties

Optional abortSignal

abortSignal: AbortSignalLike

The signal which can be used to abort requests.

Optional customHeaders

customHeaders: undefined | object
property

{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.

Optional marker

marker: undefined | string

A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client.

Optional maxResults

maxResults: undefined | number

Specifies the maximum number of entries to return. If the request does not specify maxresults, or specifies a value greater than 5,000, the server will return up to 5,000 items.

Optional onDownloadProgress

onDownloadProgress: undefined | function

Callback which fires upon download progress.

Optional onUploadProgress

onUploadProgress: undefined | function

Callback which fires upon upload progress.

Optional recursive

recursive: undefined | false | true

Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files.

Optional shareSnapshot

shareSnapshot: undefined | string

The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query.

Optional spanOptions

spanOptions: SpanOptions

Options used to create a span when tracing is enabled.

Optional timeout

timeout: undefined | number

The number of milliseconds a request can take before automatically being terminated.

Optional timeoutInSeconds

timeoutInSeconds: undefined | number

The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.

Generated using TypeDoc