-
Notifications
You must be signed in to change notification settings - Fork 1
/
EzDatabase.xml
261 lines (261 loc) · 12.4 KB
/
EzDatabase.xml
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
<?xml version="1.0"?>
<doc>
<assembly>
<name>EzDatabase</name>
</assembly>
<members>
<member name="T:EzDatabase.AsyncExtension.AsyncExtensions">
<summary>
Extensions for creating and reading files asynchronously
</summary>
</member>
<member name="M:EzDatabase.AsyncExtension.AsyncExtensions.SaveJsonAsync(EzDatabase.DatabaseCategory,System.String,System.Object)">
<summary>
Asynchronously saves or overwrites a json file in this category
</summary>
<param name="category">The base category</param>
<param name="name">The name of the file to create</param>
<param name="data">The object to serialize and store</param>
</member>
<member name="M:EzDatabase.AsyncExtension.AsyncExtensions.GetJsonsync``1(EzDatabase.DatabaseCategory,System.String)">
<summary>
Asynchronously gets a json file in this category
</summary>
<typeparam name="T">The type of the json file</typeparam>
<param name="category">The base category</param>
<param name="name">The name of the json file</param>
<returns>The deserialized object from the json file</returns>
</member>
<member name="M:EzDatabase.AsyncExtension.AsyncExtensions.GetAllJsonAsync``1(EzDatabase.DatabaseCategory)">
<summary>
Asynchronously gets a list of deseralized json files in this category
</summary>
<typeparam name="T">The type of the json files</typeparam>
<param name="category">The base category</param>
<returns>A list of deserialized objects</returns>
</member>
<member name="M:EzDatabase.AsyncExtension.AsyncExtensions.SaveFileAsync(EzDatabase.DatabaseCategory,System.String,System.String,System.String)">
<summary>
Saves a file in this category with the specified name, extension and data
</summary>
<param name="category">The base category</param>
<param name="name">The name of the file</param>
<param name="extension">The extension of the file with a period (for example: ".jpg")</param>
<param name="data">The data to be stored in the file</param>
</member>
<member name="M:EzDatabase.AsyncExtension.AsyncExtensions.SaveFileAsync(EzDatabase.DatabaseCategory,System.String,System.String,System.Byte[])">
<summary>
Saves a file in this category with the specified name, extension and data
</summary>
<param name="category">The base category</param>
<param name="name">The name of the file</param>
<param name="extension">The extension of the file with a period (for example: ".jpg")</param>
<param name="data">The data to be stored in the file</param>
</member>
<member name="M:EzDatabase.AsyncExtension.AsyncExtensions.SaveFile(EzDatabase.DatabaseCategory,System.String,System.String,System.IO.Stream)">
<summary>
Saves a file in this category with the specified name, extension and data
</summary>
<param name="category">The base category</param>
<param name="name">The name of the file</param>
<param name="extension">The extension of the file with a period (for example: ".jpg")</param>
<param name="data">The data to be stored in the file</param>
</member>
<member name="T:EzDatabase.Database">
<summary>
Represents a database object
</summary>
</member>
<member name="P:EzDatabase.Database.Name">
<summary>
Gets the name of the database
</summary>
</member>
<member name="P:EzDatabase.Database.Categories">
<summary>
A list of the categories of the database
</summary>
</member>
<member name="M:EzDatabase.Database.#ctor(System.String)">
<summary>
Creates a new database
</summary>
<param name="name">The name of the database to create</param>
</member>
<member name="M:EzDatabase.Database.CreateCategory(System.String)">
<summary>
Gets or creates a category in the database
</summary>
<param name="name">The name of the category to create</param>
<returns>The category created</returns>
</member>
<member name="M:EzDatabase.Database.GetCategory(System.String)">
<summary>
Gets or creates a category in the database
</summary>
<param name="name">The name of the category to get</param>
<returns>The category requested</returns>
</member>
<member name="M:EzDatabase.Database.GetCategories">
<summary>
Gets a list of all the categories in the database
</summary>
<returns>A list of all the categories</returns>
</member>
<member name="M:EzDatabase.Database.DeleteCategory(System.String)">
<summary>
Deletes a category in the database
<para>WARNING: This irreversibly deletes the category and all the data inside of it</para>
</summary>
<param name="name">The name of the category to delete</param>
</member>
<member name="T:EzDatabase.DatabaseCategory">
<summary>
Represents a database category
</summary>
</member>
<member name="P:EzDatabase.DatabaseCategory.Name">
<summary>
Gets the name of the category
</summary>
</member>
<member name="P:EzDatabase.DatabaseCategory.BaseDatabase">
<summary>
Gets the base database this category is in
</summary>
</member>
<member name="P:EzDatabase.DatabaseCategory.Path">
<summary>
Gets the path of this category
</summary>
</member>
<member name="P:EzDatabase.DatabaseCategory.ParentCategory">
<summary>
If a subcategory, gets the parent category, otherwise returns null
</summary>
</member>
<member name="P:EzDatabase.DatabaseCategory.SubCategories">
<summary>
A list of all the subcategories in this category
</summary>
</member>
<member name="M:EzDatabase.DatabaseCategory.CreateSubCategory(System.String)">
<summary>
Creates a subcategory in this category
</summary>
<param name="name">Get name of the category to create</param>
<returns>The category created</returns>
</member>
<member name="M:EzDatabase.DatabaseCategory.GetSubCategory(System.String)">
<summary>
Gets or creates a subcategory in this category
</summary>
<param name="name">The name of the category to get or create</param>
<returns>The category created or retrieved</returns>
</member>
<member name="M:EzDatabase.DatabaseCategory.GetSubCategories">
<summary>
Gets a list of all the subcategories in this category
</summary>
<returns>A list of subcategories</returns>
</member>
<member name="M:EzDatabase.DatabaseCategory.DeleteSubCategory(System.String)">
<summary>
Deletes a subcategory in this category
</summary>
<param name="name">The name of the subcategory to delete</param>
</member>
<member name="M:EzDatabase.DatabaseCategory.SaveJson(System.String,System.Object)">
<summary>
Saves or overwrites a json file in this category
</summary>
<param name="name">The name of the file to create</param>
<param name="data">The object to serialize and store</param>
</member>
<member name="M:EzDatabase.DatabaseCategory.GetJson``1(System.String)">
<summary>
Gets a json file in this category
</summary>
<typeparam name="T">The type of the json file</typeparam>
<param name="name">The name of the json file</param>
<returns>The deserialized object from the json file</returns>
</member>
<member name="M:EzDatabase.DatabaseCategory.GetJson(System.String)">
<summary>
Gets a json file in this category
</summary>
<param name="name">The name of the json file</param>
<returns>A FileInfo object corresponding to the json file</returns>
</member>
<member name="M:EzDatabase.DatabaseCategory.GetAllJson">
<summary>
Gets a list of names of all json files in this category
</summary>
<returns>A list of the names of json files in this category</returns>
</member>
<member name="M:EzDatabase.DatabaseCategory.GetAllJson``1">
<summary>
Gets a list of deseralized json files in this category
</summary>
<typeparam name="T">The type of the json files</typeparam>
<returns>A list of deserialized objects</returns>
</member>
<member name="M:EzDatabase.DatabaseCategory.DeleteJson(System.String)">
<summary>
Deletes a json file in this category
</summary>
<param name="name"></param>
</member>
<member name="M:EzDatabase.DatabaseCategory.SaveFile(System.String,System.String,System.String)">
<summary>
Saves a file in this category with the specified name, extension and data
</summary>
<param name="name">The name of the file</param>
<param name="extension">The extension of the file with a period (for example: ".jpg")</param>
<param name="data">The data to be stored in the file</param>
</member>
<member name="M:EzDatabase.DatabaseCategory.SaveFile(System.String,System.String,System.Byte[])">
<summary>
Saves a file in this category with the specified name, extension and data
</summary>
<param name="name">The name of the file</param>
<param name="extension">The extension of the file with a period (for example: ".jpg")</param>
<param name="data">The data to be stored in the file</param>
</member>
<member name="M:EzDatabase.DatabaseCategory.SaveFile(System.String,System.String,System.IO.Stream)">
<summary>
Saves a file in this category with the specified name, extension and data
</summary>
<param name="name">The name of the file</param>
<param name="extension">The extension of the file with a period (for example: ".jpg")</param>
<param name="data">The data to be stored in the file</param>
</member>
<member name="M:EzDatabase.DatabaseCategory.GetFile(System.String,System.String)">
<summary>
Gets a file in this category with the specified name and extension
</summary>
<param name="name">The name of the file</param>
<param name="extension">The extension of the file with a period (for example: ".jpg")</param>
</member>
<member name="M:EzDatabase.DatabaseCategory.GetAllFiles">
<summary>
Gets a list of all the files in this category
</summary>
<returns>A list of files in this category</returns>
</member>
<member name="M:EzDatabase.DatabaseCategory.GetAllFiles(System.String)">
<summary>
Gets a list of all the files with the specified extension in this category
</summary>
<param name="extension"></param>
<returns>A list of files with the specified extension</returns>
</member>
<member name="M:EzDatabase.DatabaseCategory.DeleteFile(System.String,System.String)">
<summary>
Deleted the specified file in the category
</summary>
<param name="name">The name of the file to delete</param>
<param name="extension">The extension of the file to delete with a period (for example: ".jpg")</param>
</member>
</members>
</doc>