-
Notifications
You must be signed in to change notification settings - Fork 180
/
DirectoryListFilesAndDirectoriesOptions.yml
134 lines (132 loc) · 4.24 KB
/
DirectoryListFilesAndDirectoriesOptions.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
### YamlMime:TSType
name: DirectoryListFilesAndDirectoriesOptions
uid: '@azure/storage-file-share.DirectoryListFilesAndDirectoriesOptions'
package: '@azure/storage-file-share'
summary: >-
Options to configure
[listFilesAndDirectories](xref:@azure/storage-file-share.ShareDirectoryClient.listFilesAndDirectories)
operation.
fullName: DirectoryListFilesAndDirectoriesOptions
remarks: ''
isDeprecated: false
type: interface
properties:
- name: abortSignal
uid: >-
@azure/storage-file-share.DirectoryListFilesAndDirectoriesOptions.abortSignal
package: '@azure/storage-file-share'
summary: >-
An implementation of the `AbortSignalLike` interface to signal the request
to cancel the operation.
For example, use the @azure/abort-controller to create an
`AbortSignal`.
fullName: abortSignal
remarks: ''
isDeprecated: false
syntax:
content: 'abortSignal?: AbortSignalLike'
return:
description: ''
type: <xref uid="@azure/abort-controller.AbortSignalLike" />
- name: includeAttributes
uid: >-
@azure/storage-file-share.DirectoryListFilesAndDirectoriesOptions.includeAttributes
package: '@azure/storage-file-share'
summary: ''
fullName: includeAttributes
remarks: ''
isDeprecated: false
syntax:
content: 'includeAttributes?: boolean'
return:
description: ''
type: boolean
- name: includeEtag
uid: >-
@azure/storage-file-share.DirectoryListFilesAndDirectoriesOptions.includeEtag
package: '@azure/storage-file-share'
summary: ''
fullName: includeEtag
remarks: ''
isDeprecated: false
syntax:
content: 'includeEtag?: boolean'
return:
description: ''
type: boolean
- name: includeExtendedInfo
uid: >-
@azure/storage-file-share.DirectoryListFilesAndDirectoriesOptions.includeExtendedInfo
package: '@azure/storage-file-share'
summary: >-
Optional. Specified that extended info should be included in the returned
[FileItem](xref:@azure/storage-file-share.FileItem) or
[DirectoryItem](xref:@azure/storage-file-share.DirectoryItem).
If true, the Content-Length property will be up-to-date, FileId will be
returned in response.
fullName: includeExtendedInfo
remarks: ''
isDeprecated: false
syntax:
content: 'includeExtendedInfo?: boolean'
return:
description: ''
type: boolean
- name: includePermissionKey
uid: >-
@azure/storage-file-share.DirectoryListFilesAndDirectoriesOptions.includePermissionKey
package: '@azure/storage-file-share'
summary: ''
fullName: includePermissionKey
remarks: ''
isDeprecated: false
syntax:
content: 'includePermissionKey?: boolean'
return:
description: ''
type: boolean
- name: includeTimestamps
uid: >-
@azure/storage-file-share.DirectoryListFilesAndDirectoriesOptions.includeTimestamps
package: '@azure/storage-file-share'
summary: ''
fullName: includeTimestamps
remarks: ''
isDeprecated: false
syntax:
content: 'includeTimestamps?: boolean'
return:
description: ''
type: boolean
- name: prefix
uid: '@azure/storage-file-share.DirectoryListFilesAndDirectoriesOptions.prefix'
package: '@azure/storage-file-share'
summary: |-
Filters the results to return only entries whose
name begins with the specified prefix.
fullName: prefix
remarks: ''
isDeprecated: false
syntax:
content: 'prefix?: string'
return:
description: ''
type: string
inheritedProperties:
- name: tracingOptions
uid: >-
@azure/storage-file-share.DirectoryListFilesAndDirectoriesOptions.tracingOptions
package: '@azure/storage-file-share'
summary: ''
fullName: tracingOptions
remarks: ''
isDeprecated: false
syntax:
content: 'tracingOptions?: OperationTracingOptions'
return:
description: ''
type: <xref uid="@azure/core-tracing.OperationTracingOptions" />
inheritanceDescription: >-
<b>Inherited From</b>
[CommonOptions.tracingOptions](xref:@azure/storage-file-share.CommonOptions.tracingOptions)
extends: <xref uid="@azure/storage-file-share.CommonOptions" />