/
BlobsStorage.yml
86 lines (86 loc) · 2.78 KB
/
BlobsStorage.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
### YamlMime:TSType
name: BlobsStorage
uid: botbuilder-azure-blobs.BlobsStorage
package: botbuilder-azure-blobs
summary: >-
BlobsStorage provides a [Storage](xref:botbuilder-core.Storage) implementation
backed by Azure Blob Storage
fullName: BlobsStorage
remarks: ''
isPreview: false
isDeprecated: false
type: class
constructors:
- name: 'BlobsStorage(string, string, BlobsStorageOptions)'
uid: botbuilder-azure-blobs.BlobsStorage.constructor
package: botbuilder-azure-blobs
summary: Constructs a BlobsStorage instance.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
new BlobsStorage(connectionString: string, containerName: string,
options?: BlobsStorageOptions)
parameters:
- id: connectionString
type: string
description: Azure Blob Storage connection string
- id: containerName
type: string
description: Azure Blob Storage container name
- id: options
type: <xref uid="botbuilder-azure-blobs.BlobsStorageOptions" />
description: |
Other options for BlobsStorage
methods:
- name: 'delete(string[])'
uid: botbuilder-azure-blobs.BlobsStorage.delete
package: botbuilder-azure-blobs
summary: Removes store items from storage.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function delete(keys: string[]): Promise<void>'
parameters:
- id: keys
type: 'string[]'
description: Array of item keys to remove from the store
return:
description: A promise representing the async operation
type: Promise<void>
- name: 'read(string[])'
uid: botbuilder-azure-blobs.BlobsStorage.read
package: botbuilder-azure-blobs
summary: Loads store items from storage.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function read(keys: string[]): Promise<StoreItems>'
parameters:
- id: keys
type: 'string[]'
description: Array of item keys to read
return:
description: 'The fetched [StoreItems](xref:botbuilder-core.StoreItems)'
type: Promise<StoreItems>
- name: write(StoreItems)
uid: botbuilder-azure-blobs.BlobsStorage.write
package: botbuilder-azure-blobs
summary: Saves store items to storage.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function write(changes: StoreItems): Promise<void>'
parameters:
- id: changes
type: StoreItems
description: >-
Map of [StoreItems](xref:botbuilder-core.StoreItems) to write to
storage
return:
description: A promise representing the async operation
type: Promise<void>