/
BlobStorage.yml
85 lines (83 loc) · 2.73 KB
/
BlobStorage.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
### YamlMime:TSType
name: BlobStorage
uid: botbuilder-azure.BlobStorage
package: botbuilder-azure
summary: Middleware that implements a BlobStorage based storage provider for a bot.
fullName: BlobStorage
remarks: >-
The BlobStorage implements its storage using a single Azure Storage Blob
Container. Each entity
is serialized into a JSON string and stored in an individual text blob. Each
blob
is named after the key which is encoded and ensure it conforms a valid blob
name.
isPreview: false
isDeprecated: true
customDeprecatedMessage: >-
This class is deprecated in favor of
[BlobsStorage](xref:botbuilder-azure-blobs.BlobsStorage)
type: class
constructors:
- name: BlobStorage(BlobStorageSettings)
uid: botbuilder-azure.BlobStorage.constructor
package: botbuilder-azure
summary: Creates a new BlobStorage instance.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'new BlobStorage(settings: BlobStorageSettings)'
parameters:
- id: settings
type: <xref uid="botbuilder-azure.BlobStorageSettings" />
description: |
Settings for configuring an instance of BlobStorage.
methods:
- name: 'delete(string[])'
uid: botbuilder-azure.BlobStorage.delete
package: botbuilder-azure
summary: Delete entity blobs from the configured container.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function delete(keys: string[]): Promise<void>'
parameters:
- id: keys
type: 'string[]'
description: An array of entity keys.
return:
description: A promise representing the asynchronous operation.
type: Promise<void>
- name: 'read(string[])'
uid: botbuilder-azure.BlobStorage.read
package: botbuilder-azure
summary: Retrieve entities from the configured blob container.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function read(keys: string[]): Promise<StoreItems>'
parameters:
- id: keys
type: 'string[]'
description: An array of entity keys.
return:
description: The read items.
type: Promise<StoreItems>
- name: write(StoreItems)
uid: botbuilder-azure.BlobStorage.write
package: botbuilder-azure
summary: Store a new entity in the configured blob container.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function write(changes: StoreItems): Promise<void>'
parameters:
- id: changes
type: StoreItems
description: The changes to write to storage.
return:
description: A promise representing the asynchronous operation.
type: Promise<void>