From b9472deb44ef629b60932ae3162e375b40b14358 Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Thu, 20 May 2021 22:07:17 +0200 Subject: [PATCH 01/45] Exclude test projects for Dependabot --- .github/dependabot.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index a082a01..cd8c92d 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -6,7 +6,7 @@ version: 2 updates: - package-ecosystem: "nuget" - directory: "/" + directory: "/src" schedule: interval: "weekly" labels: From 6c31f4ece7ea2087e70f71fbe074af1b3c753140 Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Thu, 20 May 2021 22:12:36 +0200 Subject: [PATCH 02/45] Set theme jekyll-theme-minimal --- docs/_config.yml | 1 + docs/index.md | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+) create mode 100644 docs/_config.yml create mode 100644 docs/index.md diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 0000000..2f7efbe --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1 @@ +theme: jekyll-theme-minimal \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..5756e84 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,37 @@ +## Welcome to GitHub Pages + +You can use the [editor on GitHub](https://github.com/asiffermann/proffer/edit/topics/docs/docs/index.md) to maintain and preview the content for your website in Markdown files. + +Whenever you commit to this repository, GitHub Pages will run [Jekyll](https://jekyllrb.com/) to rebuild the pages in your site, from the content in your Markdown files. + +### Markdown + +Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for + +```markdown +Syntax highlighted code block + +# Header 1 +## Header 2 +### Header 3 + +- Bulleted +- List + +1. Numbered +2. List + +**Bold** and _Italic_ and `Code` text + +[Link](url) and ![Image](src) +``` + +For more details see [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/). + +### Jekyll Themes + +Your Pages site will use the layout and styles from the Jekyll theme you have selected in your [repository settings](https://github.com/asiffermann/proffer/settings/pages). The name of this theme is saved in the Jekyll `_config.yml` configuration file. + +### Support or Contact + +Having trouble with Pages? Check out our [documentation](https://docs.github.com/categories/github-pages-basics/) or [contact support](https://support.github.com/contact) and we’ll help you sort it out. From 4c77d339ca77aac5cd64b0dc36ca1a78dd5ed31a Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Thu, 20 May 2021 22:12:54 +0200 Subject: [PATCH 03/45] Create index.md From 151f04b99e908c06f859ebc7863ee3fb79ce3359 Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Thu, 20 May 2021 22:22:52 +0200 Subject: [PATCH 04/45] Create CNAME --- docs/CNAME | 1 + 1 file changed, 1 insertion(+) create mode 100644 docs/CNAME diff --git a/docs/CNAME b/docs/CNAME new file mode 100644 index 0000000..f152691 --- /dev/null +++ b/docs/CNAME @@ -0,0 +1 @@ +getproffer.net \ No newline at end of file From 44b51e07ba48bef3ecfcac84f8b1605cd84baaa8 Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Thu, 20 May 2021 22:43:08 +0200 Subject: [PATCH 05/45] Add 404 page #87 --- docs/404.html | 135 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 135 insertions(+) create mode 100644 docs/404.html diff --git a/docs/404.html b/docs/404.html new file mode 100644 index 0000000..9656eab --- /dev/null +++ b/docs/404.html @@ -0,0 +1,135 @@ + + + + + 404 + + + + + + From d03e3088b6f8936f8783911275f704c33439de72 Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Thu, 20 May 2021 23:00:05 +0200 Subject: [PATCH 06/45] Test code block --- docs/index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/index.md b/docs/index.md index 5756e84..9edbc8c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -26,6 +26,8 @@ Syntax highlighted code block [Link](url) and ![Image](src) ``` +https://github.com/asiffermann/proffer/blob/df566cf979c23afc71632136e04144fa30e1a0b4/tests/Proffer.Storage.Tests/StorageConfigurationTests.cs#L20-L33 + For more details see [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/). ### Jekyll Themes From 23d9a7d5bf6c2481dd599834c21409415c6bc6a9 Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Fri, 21 May 2021 14:07:48 +0200 Subject: [PATCH 07/45] Pages layout #97 --- Proffer.sln | 4 +-- docs/_config.yml | 4 ++- docs/_layouts/default.html | 50 +++++++++++++++++++++++++++++++++++++ docs/assets/css/style.scss | 8 ++++++ docs/assets/img/banner.png | Bin 0 -> 15019 bytes 5 files changed, 63 insertions(+), 3 deletions(-) create mode 100644 docs/_layouts/default.html create mode 100644 docs/assets/css/style.scss create mode 100644 docs/assets/img/banner.png diff --git a/Proffer.sln b/Proffer.sln index 1a36860..088eb93 100644 --- a/Proffer.sln +++ b/Proffer.sln @@ -81,9 +81,9 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Proffer.Templating.Mustache EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Proffer.Email.Tests", "tests\Proffer.Email.Tests\Proffer.Email.Tests.csproj", "{912A7766-6FA4-49E2-8256-BAF3181BA1CA}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Proffer.Email.InMemory.Tests", "tests\Proffer.Email.InMemory.Tests\Proffer.Email.InMemory.Tests.csproj", "{0A6C1CB3-809F-4930-AE97-AAC77CEF957A}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Proffer.Email.InMemory.Tests", "tests\Proffer.Email.InMemory.Tests\Proffer.Email.InMemory.Tests.csproj", "{0A6C1CB3-809F-4930-AE97-AAC77CEF957A}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Proffer.Email.Smtp.Tests", "tests\Proffer.Email.Smtp.Tests\Proffer.Email.Smtp.Tests.csproj", "{4677285D-19A7-4B38-B056-1D946A51E47C}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Proffer.Email.Smtp.Tests", "tests\Proffer.Email.Smtp.Tests\Proffer.Email.Smtp.Tests.csproj", "{4677285D-19A7-4B38-B056-1D946A51E47C}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution diff --git a/docs/_config.yml b/docs/_config.yml index 2f7efbe..b184b64 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1 +1,3 @@ -theme: jekyll-theme-minimal \ No newline at end of file +theme: jekyll-theme-minimal +show_downloads: true +logo: /assets/img/banner.png \ No newline at end of file diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html new file mode 100644 index 0000000..5598874 --- /dev/null +++ b/docs/_layouts/default.html @@ -0,0 +1,50 @@ + + + + + + + + + {% seo %} + + + + +
+
+

{{ site.title | default: site.github.repository_name }}

+ + {% if site.logo %} + Logo + {% endif %} + +

{{ site.description | default: site.github.project_tagline }}

+ + {% if site.show_downloads %} + + {% endif %} +
+
+ + {{ content }} + +
+ +
+ + + + diff --git a/docs/assets/css/style.scss b/docs/assets/css/style.scss new file mode 100644 index 0000000..0bd40d1 --- /dev/null +++ b/docs/assets/css/style.scss @@ -0,0 +1,8 @@ +--- +--- + +@import "{{ site.theme }}"; + +a:hover, a:focus { + font-weight: normal; +} diff --git a/docs/assets/img/banner.png b/docs/assets/img/banner.png new file mode 100644 index 0000000000000000000000000000000000000000..1f517337227816eb2761c97c5c7b0c415c8accc4 GIT binary patch literal 15019 zcmeIZbx_+~*CPN*mz z9=@}+mY%bos*12V9L8z-rw^wa%mFtV4^LFW&B4^%7V6Ak2DP-d7kjx=*Z7jb8Y1>m z7pTgm>L3lZvR3eLf@*rGX_NW00#R**uQ!soHd~T1C9T(H$uzZ0SeH7BH%7g=C}p1VEkt= zj(Pw6M1MNsun|^wvc|27shtem+yw@;cUF`Udx`sp6JiY!<`*>M5fTuBa0r?4m~jX} z_;@)?1$nqREV#I!KyIKAl$Q_k51jvMyr86vAh$HPw3H-|G&i@bl#qZVmz<;&mjF;u zke7#7@Sm}Y_6TQFdvoYNb6ex){`Xj^|8}gfv=h|S8SbP7hui(L4c=M7o#6;8xB~+Z z4<{eP8(nLA2poxE`LjlUlPm*uvUY_+2$WBV&z#@l<-f;6{=YI0fI|xKXQ%v6JLjKQxb67o@jnCs_v1fA z32Kj%A19okWS!<#;^Fc4D9T7`xlL})5V}1bnLpXv%-+sEQ4(f~e!Ge}A$|Gj(>PJk zxTo|c`TOD^5GIHuhValH z|JCqrKgXRhxb_d2Ki~fc)W3N4|H!L<`1Iei{U0#@E!+S92F3N1I`K#OG=>)AYc%bh z>=&Ms78M+5V2$qINRsJIiVl)PbFzJ3JZu=g3~^cmuPiP<Tk&n>~nub$vm;vkF*o_5G;s=$w6I8nb7tRhY zM_OqUX|Cwoe?3Z7_Yz(>Pg%&AdTd)jrKgI=Kt|UbsrWYjLb+gN_VDM!7c8NB7yhL7 zdID*-R~x@PFN{%+bABe9ssn|u{~)Fm-qh4R_N!6tEmiA}`zb}|2pkXSe5GZc?TGOt z1MlLM&aqf!P;=K!Z2>|`EBViB!ZHe4v{BnrP1;*_fZFQ7v?pvtI4L61H!+o z)IANdy>0>CtnFkKJ}m^`MUcdO4SiEzw}Zd)^CZL&YCWTk0!8S9jNb!l-QKI+Eg;5Q zy;bGzdd#mpo06&3HHHqENpK!XBUiDo4JXxH?l04Xr&lP=&g~+!a-IoZj!B)enjA0)e4hnLJzsv-te6chyPL+>`+m z4cp_#t?H@MK4=ulJp{^jp?QP7C=c#sv%Ee(&8kB)`9fD>Wc=>T1#$4^!)*@lya11_ zy6_@(!Dx6>%q_9smCTvJRmp2fU)~+|Y+Mv+G6I>oq*EZ~^5GK}*$)`0Ti57@|bmM`?8$Tx}e>T>SOy3?1s`Z}MW0@i{g z7x2xGdwq>JqE{Mo0JdBF375J%ATX`EMdzR;IR%HecZoy;@BOcBT70Q;A)c$Jy zHa%Rr9^`>(P&`bBW>sit7WeeMd3N5A5Esnk)4hj{QrlMgOi4*GJ2N(6tPRqNauUDU z{L5K~a*|pAH4=$rc3FQU1AU8U7=69)GD+KKC4A+$2ooQp$1XkNEPT~D!_pi$;^)d% zAAXXtql!Fo$ozvskW}8P@K@i~W)hdlzSOA~hf3B0Z|P>_?{d1s@+Uh}yFTDm@}+nZ zx)IhYu-DJep{Kp>E^gX$dLt&mfP;59Hc&9-rwvmJ6=0{aazj;pixGj?WYbJ=(a>5& zqTF0#g*FL!7EpKAnZ2l270|8lMoGvx6Fu}jG#y$ml}zUiuT8jr&jw{B2Wn#FL|pPZ_qX^1(u(HcyG3%Nle(PNhApbIcP z{B@N!+jlyXM(^>+_8_jWF8j@5R%Ny*v)dTwIXlA%D0KJ)0Cd*rPm{ z8bJqEKvdYYR8)j*)4%qz_b&Ir##VEHlk+(3zv??^7y0C~5S=TtCp*7bSwYcWV_#&k z60ILZu>$B>PRodfh~gU>6D{s5&pCgtB2pT9Mo3D0LO$fzN19+)ugy1X{GI2PWW z@~@z8AC0xOdUDw^9Z0A|`TJX5p7nx2$0%BmWi$O--EIPw*FSvFU?7_ff5?pgm9&P? zL;+13k^?P=L?;CI^N_OE?Fk(EAcxQ`@O2g2-#f|mn}lJXBQ^Fr)Q^k3Z~Ux&U!{P? zhF#h4Z;yYg_Q*rS(6YfJBUY@+w$_}!2v<$))ux}kc*^E#Z%fu`@g9-q_(U*xU8H_t zzEaz9>t8Ha(!##=_X~czBnu=tQlYV6#{|kW)LQr`sH-R5{&*{+4G^TIJL+9_`PQ?5 z_?}5HkDJmnmNr)9jYJpd{hpEnL(?j7T(G=qT<*nm!+YX$O1r^X{+>?--ncgFknjIf_)l|`17-|mmPb1C-Hz(~1P@pujoh@=PzUr}vPrIBx4`j=*&dvwU2A89LWAK?Dv$NaB z_O||UX{Y@qiYxn*f2d6gfR`9{q+ZiCsBMdf6@hG!^vs?yurj*OHs_2*w8k_>qS_j> zZ%za8sX4z-0F~F*%;w5Wm#lG2W~pi;rWul58m||3)GGe1cp`HElJ{I7pNGIWeBwC7 zimGu8x>HhkDK+g8{ve$0@#BG+v8DkC;4?@t(cOlu?56Uaq|=ga-_Ffa%fbO2HJ`JT z083z5dHYT9<(N+l$*At5C zr-!F^#lQw)$ab--UoX5*iZBsApM{j;#$-~^7J)0TP(Qygk|I()Af&k~WVuBOzvE^t!TMETA|u_Xx!R}f9(_+B51KFXBE zSXCXjG!5vKhuBHa$7|y_PW=UydvS1+!0T)foiLnJTE6X@WmrLiGjCe*3;K)PPOIj< z@&FLeX~Qct#pXk7SHnp4&FRd4)u zWM&&q`6YP0xZT2*9ly(wfyyn)MeY0*DqqD^nnF1>86IZK7x_9qDCmB6&7Yo?iUeDX;m zLRZIVYkTRH0S|lE$|r4}f5H90jqp4TtnI$cN<4255QeF0w=8MaI0gy#-b zyi@YB$Ihk51iPOL59#2P5&V+M_i7DjWEn*s+D6cmON=)?_f?}o!GLjsnf(4#dXPlW zsMcs4g;w0NF@77DP%6+akjVP}U5(r0ErEChxJ8q4LxR&7bk~-UUMTwwl-m8h&h;v; zgwISGK{cMj1OJ+2RlLOau(===>+bO6$!&w|kIstHW)lU!=4C5>)6rdZ$onCWPKcb4 z2Tr9GS33?%2CC+Nt0?v!oo!F_nJcrbZK#&=B9Xb89pXOM>DwS5PCD^kI*=NvjmVri z%=`+w4%8nRv!$x2#nG+r=wkg|`#ne&0b%WZ8IL5a$r8Bn7?S>)-DHt7C5t zy1*__2H9f1?VwQK`eim8Eq(`ysWhR)ax8${WF-l0aix(VC7P;K{I^ zzI8)^Yn)z+kRemdP+QK9^|>GzdZEXYqEl=;9K2j0t?c=Oehbs0y19R3dvcTPAb4YN zL&f{zbU85K!ey7s-B3tyDy*Kx=EthqBjYRb2lyf395POQx8|BHuYDN-Y2Cu*9M}B- z#pYD|kS-+U{K<3{=FX;=gG#g# zEII(E$-L)oYF=sg4BR&Iw3upKVE-))xtLqE7r02jZed0uxu#R7=7@{UtKQD>E*uXY zf$79*#oO#|yb?|{g>Jk3eaju@-#ncdx>?iaO^a`+Z6kZEoUm;0&fuN58S;T=TwBy& zLX@CY)-CrtdGy9YVvAH`r4UAE+huW4ho7hR{FP2B;T(rj_Vt$I)zoIAC>Q5G8~dyB zTMIjzoQFCoMj=40WE5d|TX%LyeCqWM)H7(XXZu_Ed^B|Vg z{_HFx8Arm7v-71_R=+~Az4ZLWPYm-Y*9AE2&X5Ag^+&I!1oCONc2JJ{s(r+KQ50Mw zJ~oATm537e?G2$83mHY0Lf2BFo$aY+@-_A~IazI%aHv7U2Q_<*AnoYUpPKZxhD(EF z**GyzDp5UGyYCG>@)8P1k4qb3^+}Re8?`beEk)-p5Cp0b8 z&K`_f4ORNyKhbR2A;2jZ>cxrVqiA>CLAD@U!(HQJ)~VTymzmLp=vN;&z-|JHWAB6Z z7w`S1%fOdc-?45U)ho9f4?Q8)Oavp#u)AtxDACWv{O;$RKB&#zPB9fwRQi+JnNv5E zrgxq7i6*|p-I*-)-;pP;>)iNu_bTo0xf_RO=P!0`o5RprbrUsi z`Ipi&ULTF5h0pzvd+>>@ZjkTGZBNTz%w#)|3}8$hh+fFSSql-z%2uS-5FbSaW}x{_ zRL05{w0=F!m5ibBk~X@Mo_^_hN5**%;fS;wEl#O)cx$1tw-=h{gnX-tNu%QVK&ZCq ze6s)D^|r=0dw0Zdv-uxNfFb)!j>0r+*>N-DdH!i^x${3uYP;cFFz5_ zQ}7AL^~dDW>V-AyxCcC(02vAa~jKMgSK=ige{`53qbqpVuLw_@PagjYQ)kivn;9BJurCSy{x*<_2sc6 zzwz09Lxr;QhERi<&sU!b`8&YlNeDCvBky)!&vHnF4fleteBbt?8408LsdA}1v&XIR zi@bN45`a#XzPM$QCfGeq^5pdLkRhUA??s;QS5pi)pkanrQbf&3EPZ*vSNHN%!M<;V&Q7ZSi}*&{&8FBkPamZI<@HUotT&? z;MBkB|9;4xvcFJvzf`HJP~35MrIjK?!}(0%uidlu?H|=swL~bFG6J>4+OMcC|4WLH z`RJ#Hr$4H-=T*6jH%O2q7@vfY#pbFVZ2$Cw;aKZmWjv9`(KWRGv2g~qo$KSX%8iAh zI`IZfj`uM|Yr~bqb5AH1DpuFtKZX|z*W_-yIUb52VX?(0)`M5W5x2Zr@bN8Yry_$- z&k~l3*)OwdGTxKM_d7O4waj3$Kudz23@KivZqlz^ab~NK_}Dm*vVvhfUr0+EbaB;n z6^K%`QLDTfEwq#oA>FNkuDw}X+SuURxb}uz#H|<#y*0^@YlLY}7mYlFdpPxv>vKPb zixOR>ilouSIW1o-htZ;k*4cI6^ytBaf*ER#m~cNMI9GY_<&@xR?Me>&Tu!aAs|`~) z{Ou&p-o7c~a4=(_Y2vs6`UJL>xjo!m^V70#=ZymYIHUEX@XR_iP;FBUblC;@JhqfP zGmNYkJ-_m-aw1^C#~qYc#cI)l?TcBw3G`wOnEYIA<~z-!bv|vK)8&Jn;A9A!>797$ zZCWoo^Pn#Q4+WyGhD~nSS;7zc2{k=PNvtR4n^{_LDr&`MbA_{fMlexe_l(Zsf#6KgU(HkKwpgPECCsnRqlhOBKk5HbB}8+u4aXseG7KfwYSnrct+~e0v9XW=wi4TqiK* z+#J}vQ}ftMLQ;Ddhf%pg)%ZU9pV*6^j3DHaDGT`umXGR2B~ErG{z?aFboF_fjOW29 z_YXZM(Kuy#0lvzSwV3Ct$VPuYQ!+%+X0JqaPsF1oMOsE#Et#588ZXI4;>vO*y-its zw>Og_r`V1ZRvR6qVIzLzc%*^7JS~Ar{7S0NMY0W@0C3(oBnS1Bt=sBRu-Nfld1KBF z_I|hc?r1B&hu#|BPvkNzvbNE~d#DoLOI0VHo^su%_FmJtasE4p3%MM&;F&0o)O;w$ zcM9+v=zXK5t#xyZPu;Ej%DC%*#F-xDiDY~3Lga22A8q<0igVFxf1K1@g{pe4MRU)R zM>hD3(DOKr&LZz3&-8XRc3dHS3bIUXgma4~l945;d%xxkaW~)ks94qh++6BZ1Vpvq zyp=%7JUgho>I$~p6VG4_P}v$>4r8ICrHQK-mz_86kAi4(zz0bytCTh z;2>;44A--X5*A|)Ckdb)UU+?a(it3402-ety;Vu9wwf?q<~9A1IY6k6+BW+U65jFG zlOpj!j7DC>e)M#|HH`hkm2hqS;Zf)}UigjTSnkbP3nS0i?%~{`IdzEm{cNec_}Y@R z=*XC*3VN{`)m}Et%E{v8by=q8+u7?PUrTv|Cc$hh=Nw1O>jD6HYGRssFp25JsVyA~ z2%^}SWNsap>1{s7T`CT74Sy}ySFAbfhE=YRW+zEQht*uw(TPlsprFy}(cLtk^zDYn z1d5~^%TocQZ;S&kB&uw}0>gt__b)2j?~61h1Bb1s8okXMiNV7-89E|-a@vig-vl0u z^xtf(Aj6-nDBGO9=k?TUx>p-Y{ArVl!C>>W!LLk&C)7Bh2b^qU_jJv4YGQ&obzjD4506>vG&;Tu=z5x^+mS{Qeny8c&0!}2gy7jyQT4d{BAgKMWsr!@f)}l` zgXEgGo5dE-YHerU7OnED8Pg0-nw+AFy&WMk<%dHpgH@kN>V#k>d7RZ~0 zt^?H7f9}fStO{cf*NDM;1z7G0>+3miROwJqrd<=Gg{*$lSEDN}-2lI*h~HI2F`@u+9TCb$Sj`h>3t9|gm9>io{_2CF8*31m6V|I#-LF7=56qVdU2M2m6Q6Wl6VbU z*3S4n#Oyu|&DOF6{~^vnw0L7vF%(lAdqAx#Rwa$tYO**ft`qc<8&l&RtItQ6NY|H0 zEy3UTYs_tWL&Zgy$p~XI(1DFnNpX_`KYJv`XNr9T!yA*d*=AJ~Reu_u?Yf%R54>^m z%Ci={^2{a%FOts>OEz0+Qg-^YFbAvD@!~w(jvYe;;ZNK#GOGngbkCet<6f~n{}`3y zt;f62m$m5gj=lgIIyd9XV)iUTLa+9$VXPfoq3HwJSOS2ip}Rqtvmx|rqa#YiyKrpX zdqc~QbC}1yP)hSp9R+r?=2BV7Ut70p>_|lxzSDmGc8h&=vI_r}-5c-rz#tH+h_zU( zQGMGmNS|f?pyiyldC*W^>73HFB98Me`V?K`z55KaL z3+p}Rh<7wQpSkk$=$gn*_31T-+bAYkQ9B=1P~l=J<&sa8(v{QMI0`#e-b^-}heUt> zTF||L^)?yWO)w5r4Sx`F_%3hDZ?RXAW9DMR-+bx`$7Xeu7x&551%H=BQBN9YO6*!J zVg)omw(94-@?-K2LXTy|6$%`--J+GDtK4}w2fd5G#{KRx_1s^Rav#hTxvv!jj;O=2 zRqp<83Gai+hOWWdi4!ubiFxWqLC52_wUeD{n+#@09d-)3%c@j-HA4|B#+l6D`{lz| zx07BjJdwlMka@|8j`Ye_KYXbd7Dz3l7j?(RE-8QLnB6LTcw0}Qe|dE4M}XVh!g`*L z5a|Bz{C(kWk=10uh|{$vBC3NYS3^sh?)zTv10D7XySmwd>-`S~*IZQBKHp8rkj>^f z*!XRF7yo|P!$#>ZZlib9hbbVR$V8SFzm+1&2Zs47kFJJ4-D20fS=-Amt(ENyv)leC zE?HD1CbAym2lgu}iQb3G0)<$zq~6_6sT2XzQ9pcrbeY??dQS+yS|5IuIvKS;GesDT zfYRPYf6LT4)tjA@8_UI>ZVeop=I~i4;6@JCtaNlli zek~>1T(_9CtmN=*<#@Gi5_{8{|Q>~tMjk!xy>ya0C zCDYtkAkE1ci&923rs5 zzKb{H?7NHkG&`&DT1Z_q$yR*h4M)Q}rSB#7vvz&xvF~Z&s}vf>`nouK0X0Jf^g#PH z-LJo$GIj35Dvw7LcIoPV_6^(>oG6z0DXO3acaZ{-dFNC;9pUgN*KAo13eR>n)MZWH ziUkHJBsj@9Tr0He7H`gR4R}zgE{xKfrzISM8a$H#dCd!~c<)k? z=xsQkim^WGAluSnbZ2gXhKkD7vAKW1wF! ziI`%-%bdin0GvHneR$P5mUw-YpDbpuKWZnPa(p-&oj%ms5w1M9%3x@doV-2axS3pc!2?HKwNsNj8`S6k@c^CjlhT2Z9vEjwGwt!+l@3_wru zGTw_XAgoq|abjWw>iFGxf-xn@h=tfAg&3m*W~Qus)?b_-Y+2h*oJB;a`91OPl*lLT z++stMkGEHWKGY*q+qlu7>_L+1@ak(1PP&)u%fUHX=7LwmfCq3@Q7TjL%nDwd-fm3(Xmo?W0Wp}$hZ;=T%ne~-A*g3xyE(oQvq9pHi` z#lnY!YnVLvbdB0n|2|Pj#bAKB^O430o%NwR<9SFdpO}`uX@y#jCH-4l!Q9p~b?Xc< zlYV@AW{B{RXr&nUn%(RtedCPtyJrM-qhmI_kAvn(p)}LZc`=POO8YH#Lp$q8NWr5V z|GoQ8TfD4BN}YqZQ-6G<2|1w%eE+$3l$0egu{Fmi z^p<&Zv8s3+^HNOCk9*;UX_R|g)EA+HVU?rG67go{%+|z(-8oJZ`~6BD-chUCRxue9 zs`l{W$2+msz|cbMD9*F5RHO3I_0bQMbrX&Fm`L}KK+0^|>%Ei(#{-TBOFVH}ocD@k728xR!1RaPGGU64ZGp(bnbQ zG&tt0=nQ;=y!QoVk3Gw=18q&y`RGWla;c11Jbo22y`?ui*MEhEx`=pbMB?#h{_2*c zye~VLW4J2Bu66nfPA*G&Pf|E-CDIdsfZ(oPZz6n#0&=Y*8k?p;)7~ zF>mi`F0ADKqNFtBy#a}H&}+Fa+FK8QjAe`oz|QAeajrlC+q|Et*F9A1Lkz4+Hn`YL zY!4|~R~xjl&BR0Rn-n-fBDcE9O7|m6Ry4~B4`+pde2UOuS}r;w_xJ3smQGz~UI)c1 z#q_kmO%8{0LnzZc%aVmp%U+#FkZxZ2*PtWY2u;2L9tti~oE}0k>f`k5mn|+`V)}fn z=)(;`iJ$$qobX^w6s7T!6WO~0+BSJ8z%9nY472}ukMhJ0hQ=4J8`QZ|a?9&%ut=G? zw5QA-i*aFKO#ehe8W8EDIJi9g{+N)qNV+R3vSNg!CXP+75zV{@3s&>Kv}U_K&L!?) zXQ5e!hH>DpxET^gBc@EbfJm z8s|I!V-(V3)6{I(>7q2!wGOFXiRI25Sx%3Qm21=T@k%*Q z7qR6$y@=FD6F8fq)TA*w<$6}kjU~?kiNSdMqUnJpsF}8B%h#t(gB*kcAfBxQ{R4X1 zE`CC3*N-R49;2qGi`%`k*_(I5lcto*LmrX`jxv2$BguWApJEAI@scWxQh*J|W#Db$%~0QFkF&dm%U>G_D5(F6aWU-Wx1gtx#`{PA5Fad1=Dp zXH*4Wm~{I}ZW<%3m$!WV#kY@wg>pBSCB)rEG(A-`I#bO>WL!xea=4zqbMlUfb+OT7 zK7QpIdY^)Wf>)47aFUTX?DOP3lML5SN2>Rk5ybnT2;U5288Yk(%{t*2x%L{0xIaT`U*o)HlKKm%Wx%#9!Kb3s2`lI;ks{gt*}j-W_uO=c zfoJ23MxNej>!&e_qMSC!jEL1oih|++BhlE3^|KUuv17wB;U>C9g&b!Ln7ql$37R)!qBZr#pV>iq)+f6JZ?5njR7%b-B^HjN97D9N zUrjZ}d05ZkqG@;KJ>xSYA7srhuMl*o+_Tp$2*BeHK?L$NcwT&HZ5AaWX*oXvcN`A( z-k1@{P9Oey>u$5Oxm9vHqR4M{l5;nQl$nX9%TkO=ad5A>^&pa013pTwiyv!dm(|jNf-jkfb#SM_<~h84U!zBo3AeOL`;iE9}mX^-OKZZToXM zX@7|zMYYZ5zH-4|_=@?`hR*ICm4h#@tFz!LNZaC}$4`C`%yg+QD?E??+0`>OFxwQc z{PC9dGXbxgIiIy9d9_fV<&6Y7T4GcL$<6|1v(EkTkieeT@iL10eLT${_Q^52M03CJ z1)tgb96mQ!&4QZeB-d7tiBQ97`S|n2il5#dk6;b5bumb>;*QBk2`0=)YxxmYs4QN+ z_3>~&CBt`C4-tHe-itge{~(R_u=yDx%gDX5mItZ7mD9H!aeDaDfJGwD>0o_fu)D50 zkKPkLY77r~dY(s67=ZRY8lS4gRGh`SpOD1y2n9kj=q(gnMo3(MRF)!N&|SE!oHl7F zX@+@ov)9$&HR&TzdP=6aMX_sXz=9$8Nu+>DcE@C zwp4i;C+--w&9!Cc$aQsncHabN?az0!SLcR8xF>N5MgR~$bauXL z-1~DNKNBPs-tM44OL$70GMUx48&`$Fq~e=v7kBK?2;Wf?#)wJhj3|Re+1m@oKJ|;Yyp($BjdnZq$K$6G2G=^H`6X=-IM#JFitq9Me6Gj?>CvqJS`wlSATGvSP+`tn-!D z{cn$sDpe$<1m|=CT6+Y30;@CB^(?Wm#V@$f!u+EW zxx=pba>z&GBmk>2ji5o!l@-gFXBOJAi#j9P*1#j(ZO($^EgBk_*d>j(?~K=NV|-~b zDd96*{y_icoe~vXPFmK}4T**Ybv9DO2~j(PvnkfYVMdd_&wippTtGc1Ub30FSz+YK zAaX%IM_)DD=}e(%rP$8!vg;`|^#%ny=PM+n3U5wYxsr~|lu{3rm^l$!e>)lHjtyS^ z_?<_v=(BN~rL%d+ z_(PbO8!ngpZ8bQT5*5Ak*>Fo~wor7#_2jeurSmLi!HTZspVBwecdqe#hH7>|E@&pR7{%^H@zj&f}`81EuM6?TFLLQXYvx)orgFtGS1gzCH%ZWH+=+kvEPKG*9XVz z+DAUXc@;;!TushCy3{*D0!jg~7_OZh=|*rl&kUu3H0HP}O-{jhpGpQ|7{_56}F8Zb}P;29;21VzuN?97|uzn~LdD?7TtWVy%b7YNMu9=*l z%Qo%m;_^F?5#mg1J5P+|sN&a0`?>jJh=ljyMFQC&CCVI57^9No;o+^h+2EHpE1?mo z-@?jeNHP+dCh`4Z^|-rARCut_w@~xN8r6|J5`4bYl94r0u~oKr-=sxZGz#f#IR8~K zC9xtpuvinZa(`Qd-)!^>|FPPV7sd;2pMUC-IUwMghH?A4fdxs@xk#ThZw3MBX~Jd_ zeg&1;;UY|co%ZVnVf%J(??AQHY}ZnOStQWL#WL&_{B&N%!ia?f%da-zYAJ!)x!|sH zO)34FW{Cj3geT&|<zL%-B)G%3_fkwxt&ND$oX4y4J1n{NQqfeKr&BVY7^MUyGbgFa55W zKhp*<*LfyzudbX4t;r1V95_?5RRZ=GsD7=r>RY0(%H!MQGx0hU+a5G@;XYU`~LOH zIi(B7knV^&n3V+6htRg(S&Os21N`R2r1O)|y3w`{koV-4ypGzI7|-Q-@XqzwB?>gt z9b}v4hp%I$-uEfBp+VCA@7$>(x-eV<98Pi@15|8q=}$H;i3BiNeVC#oR8dm$3LbO|9F>U$lC* zTd|A8t+>O4tT?hTVdyu+hTfZ}5_&N&U;u)anwJ zI+VDSI|^Ku*0xBnfKJR<=dSUXhl$i!ZWIr(Z|Yxpw{Y3NuU5h#4XziHn~)5NWDNs{ zqrXTW@N^Zhwf5l!ImM?v$7R2DM@DJXUXFr8gm1p~qr^&&_O);FDh&`e;itN3(>;fu zaK$i&G%xPr9I{JM%vF}Jo>DHHz>Qqyg#nLXM&zDXZ3SH$uEn3tfww-`6=rxd4?HOC zRO6gD==KkaG$5mA)+MV*pG8QZULADDxf%nm3;52~pjYj(pd&DlBosc25eHzB$?xE@ z5}B0i^xm}Yo@MCEPQ-W^N0rs#ZqZt3V}5q&T-8nTH7*-KI0eLa0Z8lG+xoqZOHK*j zz1~c~4$Twk1MnD_3Ff)P8chTUQi0i&K&wW#*DjLOhhpXW4>YvHGbj`Q_UzGX$Z&AAPpX!+YcgHFb@9&bT z|GBK{pZcEvRGsyItI+y~vj0?_^}h<#hpcndZDKt2V_V62?Ep#~VR(wNYBEJqCLjMV Dg+or- literal 0 HcmV?d00001 From ee1fe159e2fe24bd9e6b5b2ea06cc2075fbe12d3 Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Fri, 21 May 2021 14:12:46 +0200 Subject: [PATCH 08/45] Static theme import --- docs/assets/css/style.scss | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/assets/css/style.scss b/docs/assets/css/style.scss index 0bd40d1..6c8741e 100644 --- a/docs/assets/css/style.scss +++ b/docs/assets/css/style.scss @@ -1,7 +1,7 @@ --- --- -@import "{{ site.theme }}"; +@import "jekyll-theme-minimal"; a:hover, a:focus { font-weight: normal; From 84989cb19a16905cbd76fed43bfb83aab40613e6 Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Fri, 21 May 2021 14:33:10 +0200 Subject: [PATCH 09/45] Add theme scss --- docs/_sass/jekyll-theme-minimal.scss | 286 +++++++++++++++++++++++++++ docs/assets/css/style.scss | 2 +- 2 files changed, 287 insertions(+), 1 deletion(-) create mode 100644 docs/_sass/jekyll-theme-minimal.scss diff --git a/docs/_sass/jekyll-theme-minimal.scss b/docs/_sass/jekyll-theme-minimal.scss new file mode 100644 index 0000000..fecbca3 --- /dev/null +++ b/docs/_sass/jekyll-theme-minimal.scss @@ -0,0 +1,286 @@ +@import "fonts"; +@import "rouge-github"; + +body { + background-color: #fff; + padding:50px; + font: 14px/1.5 "Noto Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; + color:#727272; + font-weight:400; +} + +h1, h2, h3, h4, h5, h6 { + color:#222; + margin:0 0 20px; +} + +p, ul, ol, table, pre, dl { + margin:0 0 20px; +} + +h1, h2, h3 { + line-height:1.1; +} + +h1 { + font-size:28px; +} + +h2 { + color:#393939; +} + +h3, h4, h5, h6 { + color:#494949; +} + +a { + color:#267CB9; + text-decoration:none; +} + +a:hover, a:focus { + color:#069; + font-weight: bold; +} + +a small { + font-size:11px; + color:#777; + margin-top:-0.3em; + display:block; +} + +a:hover small { + color:#777; +} + +.wrapper { + width:860px; + margin:0 auto; +} + +blockquote { + border-left:1px solid #e5e5e5; + margin:0; + padding:0 0 0 20px; + font-style:italic; +} + +code, pre { + font-family:Monaco, Bitstream Vera Sans Mono, Lucida Console, Terminal, Consolas, Liberation Mono, DejaVu Sans Mono, Courier New, monospace; + color:#333; +} + +pre { + padding:8px 15px; + background: #f8f8f8; + border-radius:5px; + border:1px solid #e5e5e5; + overflow-x: auto; +} + +table { + width:100%; + border-collapse:collapse; +} + +th, td { + text-align:left; + padding:5px 10px; + border-bottom:1px solid #e5e5e5; +} + +dt { + color:#444; + font-weight:700; +} + +th { + color:#444; +} + +img { + max-width:100%; +} + +kbd { + background-color: #fafbfc; + border: 1px solid #c6cbd1; + border-bottom-color: #959da5; + border-radius: 3px; + box-shadow: inset 0 -1px 0 #959da5; + color: #444d56; + display: inline-block; + font-size: 11px; + line-height: 10px; + padding: 3px 5px; + vertical-align: middle; +} + +header { + width:270px; + float:left; + position:fixed; + -webkit-font-smoothing:subpixel-antialiased; +} + +ul.downloads { + list-style:none; + height:40px; + padding:0; + background: #f4f4f4; + border-radius:5px; + border:1px solid #e0e0e0; + width:270px; +} + +.downloads li { + width:89px; + float:left; + border-right:1px solid #e0e0e0; + height:40px; +} + +.downloads li:first-child a { + border-radius:5px 0 0 5px; +} + +.downloads li:last-child a { + border-radius:0 5px 5px 0; +} + +.downloads a { + line-height:1; + font-size:11px; + color:#676767; + display:block; + text-align:center; + padding-top:6px; + height:34px; +} + +.downloads a:hover, .downloads a:focus { + color:#675C5C; + font-weight:bold; +} + +.downloads ul a:active { + background-color:#f0f0f0; +} + +strong { + color:#222; + font-weight:700; +} + +.downloads li + li + li { + border-right:none; + width:89px; +} + +.downloads a strong { + font-size:14px; + display:block; + color:#222; +} + +section { + width:500px; + float:right; + padding-bottom:50px; +} + +small { + font-size:11px; +} + +hr { + border:0; + background:#e5e5e5; + height:1px; + margin:0 0 20px; +} + +footer { + width:270px; + float:left; + position:fixed; + bottom:50px; + -webkit-font-smoothing:subpixel-antialiased; +} + +@media print, screen and (max-width: 960px) { + + div.wrapper { + width:auto; + margin:0; + } + + header, section, footer { + float:none; + position:static; + width:auto; + } + + header { + padding-right:320px; + } + + section { + border:1px solid #e5e5e5; + border-width:1px 0; + padding:20px 0; + margin:0 0 20px; + } + + header a small { + display:inline; + } + + header ul { + position:absolute; + right:50px; + top:52px; + } +} + +@media print, screen and (max-width: 720px) { + body { + word-wrap:break-word; + } + + header { + padding:0; + } + + header ul, header p.view { + position:static; + } + + pre, code { + word-wrap:normal; + } +} + +@media print, screen and (max-width: 480px) { + body { + padding:15px; + } + + .downloads { + width:99%; + } + + .downloads li, .downloads li + li + li { + width:33%; + } +} + +@media print { + body { + padding:0.4in; + font-size:12pt; + color:#444; + } +} diff --git a/docs/assets/css/style.scss b/docs/assets/css/style.scss index 6c8741e..0bd40d1 100644 --- a/docs/assets/css/style.scss +++ b/docs/assets/css/style.scss @@ -1,7 +1,7 @@ --- --- -@import "jekyll-theme-minimal"; +@import "{{ site.theme }}"; a:hover, a:focus { font-weight: normal; From b67d244e0d4b14fba89fd2e313d05fdb7fd8f518 Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Fri, 21 May 2021 14:39:51 +0200 Subject: [PATCH 10/45] Scss cleanup --- docs/_layouts/default.html | 81 ++++---- docs/_sass/custom.scss | 3 + docs/_sass/jekyll-theme-minimal.scss | 286 --------------------------- docs/assets/css/style.scss | 5 +- 4 files changed, 43 insertions(+), 332 deletions(-) create mode 100644 docs/_sass/custom.scss delete mode 100644 docs/_sass/jekyll-theme-minimal.scss diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 5598874..2c5b4c2 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -1,50 +1,47 @@ - - - - - - - - {% seo %} - - - -
-
-

{{ site.title | default: site.github.repository_name }}

- - {% if site.logo %} - Logo - {% endif %} - -

{{ site.description | default: site.github.project_tagline }}

- - {% if site.show_downloads %} - - {% endif %} -
-
+ +
+
+

{{ site.title | default: site.github.repository_name }}

+ + {% if site.logo %} + Logo + {% endif %} + +

{{ site.description | default: site.github.project_tagline }}

+ + {% if site.show_downloads %} + + {% endif %} +
+
{{ content }} -
- -
- - - +
+ +
+ + diff --git a/docs/_sass/custom.scss b/docs/_sass/custom.scss new file mode 100644 index 0000000..d0cd169 --- /dev/null +++ b/docs/_sass/custom.scss @@ -0,0 +1,3 @@ +a:hover, a:focus { + font-weight: normal; +} diff --git a/docs/_sass/jekyll-theme-minimal.scss b/docs/_sass/jekyll-theme-minimal.scss deleted file mode 100644 index fecbca3..0000000 --- a/docs/_sass/jekyll-theme-minimal.scss +++ /dev/null @@ -1,286 +0,0 @@ -@import "fonts"; -@import "rouge-github"; - -body { - background-color: #fff; - padding:50px; - font: 14px/1.5 "Noto Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; - color:#727272; - font-weight:400; -} - -h1, h2, h3, h4, h5, h6 { - color:#222; - margin:0 0 20px; -} - -p, ul, ol, table, pre, dl { - margin:0 0 20px; -} - -h1, h2, h3 { - line-height:1.1; -} - -h1 { - font-size:28px; -} - -h2 { - color:#393939; -} - -h3, h4, h5, h6 { - color:#494949; -} - -a { - color:#267CB9; - text-decoration:none; -} - -a:hover, a:focus { - color:#069; - font-weight: bold; -} - -a small { - font-size:11px; - color:#777; - margin-top:-0.3em; - display:block; -} - -a:hover small { - color:#777; -} - -.wrapper { - width:860px; - margin:0 auto; -} - -blockquote { - border-left:1px solid #e5e5e5; - margin:0; - padding:0 0 0 20px; - font-style:italic; -} - -code, pre { - font-family:Monaco, Bitstream Vera Sans Mono, Lucida Console, Terminal, Consolas, Liberation Mono, DejaVu Sans Mono, Courier New, monospace; - color:#333; -} - -pre { - padding:8px 15px; - background: #f8f8f8; - border-radius:5px; - border:1px solid #e5e5e5; - overflow-x: auto; -} - -table { - width:100%; - border-collapse:collapse; -} - -th, td { - text-align:left; - padding:5px 10px; - border-bottom:1px solid #e5e5e5; -} - -dt { - color:#444; - font-weight:700; -} - -th { - color:#444; -} - -img { - max-width:100%; -} - -kbd { - background-color: #fafbfc; - border: 1px solid #c6cbd1; - border-bottom-color: #959da5; - border-radius: 3px; - box-shadow: inset 0 -1px 0 #959da5; - color: #444d56; - display: inline-block; - font-size: 11px; - line-height: 10px; - padding: 3px 5px; - vertical-align: middle; -} - -header { - width:270px; - float:left; - position:fixed; - -webkit-font-smoothing:subpixel-antialiased; -} - -ul.downloads { - list-style:none; - height:40px; - padding:0; - background: #f4f4f4; - border-radius:5px; - border:1px solid #e0e0e0; - width:270px; -} - -.downloads li { - width:89px; - float:left; - border-right:1px solid #e0e0e0; - height:40px; -} - -.downloads li:first-child a { - border-radius:5px 0 0 5px; -} - -.downloads li:last-child a { - border-radius:0 5px 5px 0; -} - -.downloads a { - line-height:1; - font-size:11px; - color:#676767; - display:block; - text-align:center; - padding-top:6px; - height:34px; -} - -.downloads a:hover, .downloads a:focus { - color:#675C5C; - font-weight:bold; -} - -.downloads ul a:active { - background-color:#f0f0f0; -} - -strong { - color:#222; - font-weight:700; -} - -.downloads li + li + li { - border-right:none; - width:89px; -} - -.downloads a strong { - font-size:14px; - display:block; - color:#222; -} - -section { - width:500px; - float:right; - padding-bottom:50px; -} - -small { - font-size:11px; -} - -hr { - border:0; - background:#e5e5e5; - height:1px; - margin:0 0 20px; -} - -footer { - width:270px; - float:left; - position:fixed; - bottom:50px; - -webkit-font-smoothing:subpixel-antialiased; -} - -@media print, screen and (max-width: 960px) { - - div.wrapper { - width:auto; - margin:0; - } - - header, section, footer { - float:none; - position:static; - width:auto; - } - - header { - padding-right:320px; - } - - section { - border:1px solid #e5e5e5; - border-width:1px 0; - padding:20px 0; - margin:0 0 20px; - } - - header a small { - display:inline; - } - - header ul { - position:absolute; - right:50px; - top:52px; - } -} - -@media print, screen and (max-width: 720px) { - body { - word-wrap:break-word; - } - - header { - padding:0; - } - - header ul, header p.view { - position:static; - } - - pre, code { - word-wrap:normal; - } -} - -@media print, screen and (max-width: 480px) { - body { - padding:15px; - } - - .downloads { - width:99%; - } - - .downloads li, .downloads li + li + li { - width:33%; - } -} - -@media print { - body { - padding:0.4in; - font-size:12pt; - color:#444; - } -} diff --git a/docs/assets/css/style.scss b/docs/assets/css/style.scss index 0bd40d1..72d9eb0 100644 --- a/docs/assets/css/style.scss +++ b/docs/assets/css/style.scss @@ -2,7 +2,4 @@ --- @import "{{ site.theme }}"; - -a:hover, a:focus { - font-weight: normal; -} +@import "custom.scss"; From 01986e7237a69dedbc8d1c5b93bb4bd3ef85adc6 Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Fri, 21 May 2021 15:24:29 +0200 Subject: [PATCH 11/45] Favicon --- docs/_config.yml | 5 +++- docs/_layouts/default.html | 19 +++++++++++++-- docs/android-chrome-192x192.png | Bin 0 -> 3428 bytes docs/android-chrome-384x384.png | Bin 0 -> 6542 bytes docs/apple-touch-icon.png | Bin 0 -> 2931 bytes docs/browserconfig.xml | 9 +++++++ docs/favicon-16x16.png | Bin 0 -> 848 bytes docs/favicon-32x32.png | Bin 0 -> 1324 bytes docs/favicon.ico | Bin 0 -> 15086 bytes docs/mstile-150x150.png | Bin 0 -> 3271 bytes docs/safari-pinned-tab.svg | 41 ++++++++++++++++++++++++++++++++ docs/site.webmanifest | 20 ++++++++++++++++ 12 files changed, 91 insertions(+), 3 deletions(-) create mode 100644 docs/android-chrome-192x192.png create mode 100644 docs/android-chrome-384x384.png create mode 100644 docs/apple-touch-icon.png create mode 100644 docs/browserconfig.xml create mode 100644 docs/favicon-16x16.png create mode 100644 docs/favicon-32x32.png create mode 100644 docs/favicon.ico create mode 100644 docs/mstile-150x150.png create mode 100644 docs/safari-pinned-tab.svg create mode 100644 docs/site.webmanifest diff --git a/docs/_config.yml b/docs/_config.yml index b184b64..9e0d9f9 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,3 +1,6 @@ theme: jekyll-theme-minimal +title: Proffer +logo: /assets/img/banner.png +main_color: #5c2d91 show_downloads: true -logo: /assets/img/banner.png \ No newline at end of file +show_title: false \ No newline at end of file diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 2c5b4c2..841363d 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -5,6 +5,16 @@ + + + + + + + + + + {% seo %} + + {% seo %} -
-
- - {% if site.show_title %} -

{{ site.title | default: site.github.repository_name }}

+
+
+ +

{{ site.title | default: site.github.repository_name }}

+ +

{{ site.description | default: site.github.project_tagline }}

+ {% if site.github.is_project_page %} + View project on GitHub {% endif %} - - {% if site.banner %} - - Banner - + {% if site.github.is_user_page %} + Follow me on GitHub {% endif %} +
+
-

{{ site.description | default: site.github.project_tagline }}

+
+
+
+ {{ content }} +
- {% if site.show_downloads %} - - {% endif %} +
-
+ {% if site.github.is_project_page %} +

{{ site.github.repository_name }} is maintained by {{ site.github.owner_name }}.

+ {% endif %} - {{ content }} + -
- +

This page was generated by GitHub Pages.

+ +
- From 63d9a28695eba6bf6aa4d24d53a16259430f827c Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Fri, 21 May 2021 21:45:11 +0200 Subject: [PATCH 23/45] Fix index and link --- docs/_layouts/default.html | 2 +- docs/code/index.md | 10 ++++++++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 05a8336..d72a481 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -63,7 +63,7 @@

{{ site.description | default: site.github.project_tagline }}

{% endif %}

This page was generated by GitHub Pages.

diff --git a/docs/code/index.md b/docs/code/index.md index 8d9cbd0..7ebd314 100644 --- a/docs/code/index.md +++ b/docs/code/index.md @@ -3,25 +3,35 @@ ## Core libraries [Proffer](./Core) + [Proffer.Azure](./Core/Azure) ## Storage [Proffer.Storage](./Storage) + [Proffer.Storage.Azure.Blobs](./Storage/AzureBlobs) + [Proffer.Storage.FileSystem](./Storage/FileSystem) + [Proffer.Storage.FileSystem.Properties.Json](./Storage/Properties/Json) + [Proffer.Storage.FileSystem.Server](./Storage/FileSystem/Server) ## Templating [Proffer.Templating](./Templating) + [Proffer.Templating.Handlebars](./Templating/Handlebars) + [Proffer.Templating.Mustache](./Templating/Mustache) ## Email [Proffer.Email](./Email) + [Proffer.Email.Smtp](./Email/Smtp) + [Proffer.Email.SendGrid](./Email/SendGrid) + [Proffer.Email.InMemory](./Email/InMemory) From fae9c59cb9e4216bef7d90b23c9a55e4e31476c8 Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Sat, 22 May 2021 00:17:53 +0200 Subject: [PATCH 24/45] Move api documentation folders --- .config/dotnet-tools.json | 2 +- docs/code/Core/Azure/index.md | 5 - ...zure.configuration.iazurestorageoptions.md | 35 -- docs/code/Core/index.md | 17 - ...ffer.configuration.inamedelementoptions.md | 23 - .../proffer.configuration.ioptionerror.md | 35 -- .../proffer.configuration.iprovideroptions.md | 25 - .../Core/proffer.configuration.optionerror.md | 48 -- .../proffer.configuration.provideroptions.md | 48 -- .../Core/proffer.equalitycomparerbase-1.md | 78 ---- docs/code/Email/InMemory/index.md | 17 - ...email.inmemory.iinmemoryemailrepository.md | 38 -- .../proffer.email.inmemory.inmemoryemail.md | 131 ------ ...er.email.inmemory.inmemoryemailprovider.md | 137 ------ ...mail.inmemory.inmemoryemailprovidertype.md | 62 --- ....email.inmemory.inmemoryemailrepository.md | 51 --- docs/code/Email/SendGrid/index.md | 11 - ...er.email.sendgrid.sendgridemailprovider.md | 148 ------ ...mail.sendgrid.sendgridemailprovidertype.md | 57 --- ...offer.email.servicecollectionextensions.md | 31 -- docs/code/Email/Smtp/index.md | 11 - .../proffer.email.smtp.smtpemailprovider.md | 144 ------ ...roffer.email.smtp.smtpemailprovidertype.md | 62 --- docs/code/Email/index.md | 41 -- docs/code/Email/proffer.email.emailoptions.md | 81 ---- .../proffer.email.emailprovideroptions.md | 48 -- .../Email/proffer.email.emailtemplatetype.md | 20 - .../code/Email/proffer.email.iemailaddress.md | 35 -- .../Email/proffer.email.iemailattachment.md | 71 --- .../Email/proffer.email.iemailprovider.md | 119 ----- .../proffer.email.iemailprovideroptions.md | 35 -- .../Email/proffer.email.iemailprovidertype.md | 43 -- docs/code/Email/proffer.email.iemailsender.md | 428 ------------------ .../proffer.email.internal.emailaddress.md | 64 --- ...l.internal.emailaddressequalitycomparer.md | 43 -- ...rnal.emailaddressstrictequalitycomparer.md | 43 -- .../proffer.email.internal.emailattachment.md | 125 ----- ...nternal.emailattachmentequalitycomparer.md | 43 -- .../proffer.email.mockupexceptionsoptions.md | 47 -- .../code/Email/proffer.email.mockupoptions.md | 59 --- docs/code/Storage/AzureBlobs/index.md | 31 -- ...e.azure.blobs.azureblobsstorageprovider.md | 75 --- ...fer.storage.azure.blobs.azureblobsstore.md | 325 ------------- ...s.configuration.azureblobsparsedoptions.md | 123 ----- ...configuration.azureblobsprovideroptions.md | 72 --- ...figuration.azureblobsscopedstoreoptions.md | 120 ----- ...bs.configuration.azureblobsstoreoptions.md | 133 ------ ...blobs.internal.azureblobsfileproperties.md | 146 ------ ....blobs.internal.azureblobsfilereference.md | 221 --------- ...internal.azureblobslistdirectorywrapper.md | 138 ------ ...lobs.internal.azureblobslistfilewrapper.md | 67 --- ...blobsstorageservicecollectionextensions.md | 31 -- .../FileSystem/Properties/Json/index.md | 13 - ...es.json.filesystempropertiesjsonoptions.md | 35 -- docs/code/Storage/FileSystem/Server/index.md | 15 - ...erver.filesystemstorageservermiddleware.md | 54 --- ...m.server.filesystemstorageserveroptions.md | 59 --- ...ystem.server.internal.publicurlprovider.md | 51 --- ...fer.storage.servicecollectionextensions.md | 52 --- docs/code/Storage/FileSystem/index.md | 35 -- ...m.configuration.filesystemparsedoptions.md | 127 ------ ...configuration.filesystemprovideroptions.md | 60 --- ...figuration.filesystemscopedstoreoptions.md | 120 ----- ...em.configuration.filesystemstoreoptions.md | 133 ------ ...ffer.storage.filesystem.filesystemstore.md | 331 -------------- ....filesystem.iextendedpropertiesprovider.md | 56 --- ...esystem.internal.fileextendedproperties.md | 83 ---- ...ystem.internal.filesystemfileproperties.md | 116 ----- ...system.internal.filesystemfilereference.md | 234 ---------- ...r.storage.filesystem.ipublicurlprovider.md | 32 -- ...filesystem.noextendedpropertiesprovider.md | 69 --- docs/code/Storage/index.md | 75 --- ...offer.storage.configuration.accesslevel.md | 28 -- ...e.configuration.configurationextensions.md | 225 --------- ....storage.configuration.iparsedoptions-3.md | 125 ----- ...orage.configuration.iscopedstoreoptions.md | 33 -- ...fer.storage.configuration.istoreoptions.md | 93 ---- ...torage.configuration.scopedstoreoptions.md | 104 ----- ...er.storage.configuration.storageoptions.md | 169 ------- ...ffer.storage.configuration.storeoptions.md | 133 ------ ...age.exceptions.badproviderconfiguration.md | 136 ------ ....exceptions.badscopedstoreconfiguration.md | 139 ------ ...torage.exceptions.badstoreconfiguration.md | 164 ------- ...e.exceptions.filealreadyexistsexception.md | 136 ------ ...ge.exceptions.providernotfoundexception.md | 133 ------ ...orage.exceptions.storenotfoundexception.md | 133 ------ .../proffer.storage.ifileproperties.md | 103 ----- .../Storage/proffer.storage.ifilereference.md | 179 -------- ...age.internal.configureprovideroptions-4.md | 70 --- ...er.storage.internal.genericstoreproxy-1.md | 351 -------------- ...r.storage.internal.privatefilereference.md | 49 -- ...proffer.storage.internal.storagefactory.md | 200 -------- ....storage.internal.storageproviderbase-4.md | 160 ------- .../proffer.storage.iprivatefilereference.md | 31 -- .../proffer.storage.isharedaccesspolicy.md | 55 --- .../proffer.storage.istoragefactory.md | 179 -------- .../proffer.storage.istorageprovider.md | 106 ----- docs/code/Storage/proffer.storage.istore-1.md | 24 - docs/code/Storage/proffer.storage.istore.md | 309 ------------- .../proffer.storage.istoreextensions.md | 269 ----------- .../proffer.storage.overwritepolicy.md | 28 -- ...proffer.storage.sharedaccesspermissions.md | 32 -- .../proffer.storage.sharedaccesspolicy.md | 68 --- ...rage.storageservicecollectionextensions.md | 85 ---- .../code/Storage/proffer.storage.storebase.md | 51 --- docs/code/Templating/Handlebars/index.md | 11 - ...g.handlebars.handlebarstemplateprovider.md | 82 ---- docs/code/Templating/Mustache/index.md | 11 - ...er.templating.mustache.mustachetemplate.md | 78 ---- ...ating.mustache.mustachetemplateprovider.md | 103 ----- docs/code/Templating/index.md | 33 -- ...ng.exceptions.providernotfoundexception.md | 131 ------ ...ng.exceptions.templatenotfoundexception.md | 125 ----- ...ffer.templating.invalidcontextexception.md | 125 ----- .../proffer.templating.itemplate.md | 59 --- .../proffer.templating.itemplateloader.md | 29 -- ...offer.templating.itemplateloaderfactory.md | 50 -- .../proffer.templating.itemplateprovider.md | 50 -- ...offer.templating.itemplateproviderscope.md | 49 -- ...fer.templating.templatecollectionbase-1.md | 48 -- ...offer.templating.templatecollectionbase.md | 94 ---- docs/code/index.md | 28 +- src/Directory.Build.props | 1 + src/Directory.Build.targets | 4 +- src/Proffer.Azure/Proffer.Azure.csproj | 4 +- .../Proffer.Email.InMemory.csproj | 4 +- .../Proffer.Email.SendGrid.csproj | 4 +- .../Proffer.Email.Smtp.csproj | 4 +- src/Proffer.Email/Proffer.Email.csproj | 2 +- .../Proffer.Storage.Azure.Blobs.csproj | 4 +- ....Storage.FileSystem.Properties.Json.csproj | 4 +- .../Proffer.Storage.FileSystem.Server.csproj | 4 +- .../Proffer.Storage.FileSystem.csproj | 4 +- src/Proffer.Storage/Proffer.Storage.csproj | 4 +- .../Proffer.Templating.Handlebars.csproj | 4 +- .../Proffer.Templating.Mustache.csproj | 4 +- .../Proffer.Templating.csproj | 4 +- src/Proffer/Proffer.csproj | 4 +- 138 files changed, 32 insertions(+), 11026 deletions(-) delete mode 100644 docs/code/Core/Azure/index.md delete mode 100644 docs/code/Core/Azure/proffer.azure.configuration.iazurestorageoptions.md delete mode 100644 docs/code/Core/index.md delete mode 100644 docs/code/Core/proffer.configuration.inamedelementoptions.md delete mode 100644 docs/code/Core/proffer.configuration.ioptionerror.md delete mode 100644 docs/code/Core/proffer.configuration.iprovideroptions.md delete mode 100644 docs/code/Core/proffer.configuration.optionerror.md delete mode 100644 docs/code/Core/proffer.configuration.provideroptions.md delete mode 100644 docs/code/Core/proffer.equalitycomparerbase-1.md delete mode 100644 docs/code/Email/InMemory/index.md delete mode 100644 docs/code/Email/InMemory/proffer.email.inmemory.iinmemoryemailrepository.md delete mode 100644 docs/code/Email/InMemory/proffer.email.inmemory.inmemoryemail.md delete mode 100644 docs/code/Email/InMemory/proffer.email.inmemory.inmemoryemailprovider.md delete mode 100644 docs/code/Email/InMemory/proffer.email.inmemory.inmemoryemailprovidertype.md delete mode 100644 docs/code/Email/InMemory/proffer.email.inmemory.inmemoryemailrepository.md delete mode 100644 docs/code/Email/SendGrid/index.md delete mode 100644 docs/code/Email/SendGrid/proffer.email.sendgrid.sendgridemailprovider.md delete mode 100644 docs/code/Email/SendGrid/proffer.email.sendgrid.sendgridemailprovidertype.md delete mode 100644 docs/code/Email/SendGrid/proffer.email.servicecollectionextensions.md delete mode 100644 docs/code/Email/Smtp/index.md delete mode 100644 docs/code/Email/Smtp/proffer.email.smtp.smtpemailprovider.md delete mode 100644 docs/code/Email/Smtp/proffer.email.smtp.smtpemailprovidertype.md delete mode 100644 docs/code/Email/index.md delete mode 100644 docs/code/Email/proffer.email.emailoptions.md delete mode 100644 docs/code/Email/proffer.email.emailprovideroptions.md delete mode 100644 docs/code/Email/proffer.email.emailtemplatetype.md delete mode 100644 docs/code/Email/proffer.email.iemailaddress.md delete mode 100644 docs/code/Email/proffer.email.iemailattachment.md delete mode 100644 docs/code/Email/proffer.email.iemailprovider.md delete mode 100644 docs/code/Email/proffer.email.iemailprovideroptions.md delete mode 100644 docs/code/Email/proffer.email.iemailprovidertype.md delete mode 100644 docs/code/Email/proffer.email.iemailsender.md delete mode 100644 docs/code/Email/proffer.email.internal.emailaddress.md delete mode 100644 docs/code/Email/proffer.email.internal.emailaddressequalitycomparer.md delete mode 100644 docs/code/Email/proffer.email.internal.emailaddressstrictequalitycomparer.md delete mode 100644 docs/code/Email/proffer.email.internal.emailattachment.md delete mode 100644 docs/code/Email/proffer.email.internal.emailattachmentequalitycomparer.md delete mode 100644 docs/code/Email/proffer.email.mockupexceptionsoptions.md delete mode 100644 docs/code/Email/proffer.email.mockupoptions.md delete mode 100644 docs/code/Storage/AzureBlobs/index.md delete mode 100644 docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.azureblobsstorageprovider.md delete mode 100644 docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.azureblobsstore.md delete mode 100644 docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md delete mode 100644 docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md delete mode 100644 docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md delete mode 100644 docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md delete mode 100644 docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md delete mode 100644 docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.internal.azureblobsfilereference.md delete mode 100644 docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md delete mode 100644 docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md delete mode 100644 docs/code/Storage/AzureBlobs/proffer.storage.azureblobsstorageservicecollectionextensions.md delete mode 100644 docs/code/Storage/FileSystem/Properties/Json/index.md delete mode 100644 docs/code/Storage/FileSystem/Properties/Json/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md delete mode 100644 docs/code/Storage/FileSystem/Server/index.md delete mode 100644 docs/code/Storage/FileSystem/Server/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md delete mode 100644 docs/code/Storage/FileSystem/Server/proffer.storage.filesystem.server.filesystemstorageserveroptions.md delete mode 100644 docs/code/Storage/FileSystem/Server/proffer.storage.filesystem.server.internal.publicurlprovider.md delete mode 100644 docs/code/Storage/FileSystem/Server/proffer.storage.servicecollectionextensions.md delete mode 100644 docs/code/Storage/FileSystem/index.md delete mode 100644 docs/code/Storage/FileSystem/proffer.storage.filesystem.configuration.filesystemparsedoptions.md delete mode 100644 docs/code/Storage/FileSystem/proffer.storage.filesystem.configuration.filesystemprovideroptions.md delete mode 100644 docs/code/Storage/FileSystem/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md delete mode 100644 docs/code/Storage/FileSystem/proffer.storage.filesystem.configuration.filesystemstoreoptions.md delete mode 100644 docs/code/Storage/FileSystem/proffer.storage.filesystem.filesystemstore.md delete mode 100644 docs/code/Storage/FileSystem/proffer.storage.filesystem.iextendedpropertiesprovider.md delete mode 100644 docs/code/Storage/FileSystem/proffer.storage.filesystem.internal.fileextendedproperties.md delete mode 100644 docs/code/Storage/FileSystem/proffer.storage.filesystem.internal.filesystemfileproperties.md delete mode 100644 docs/code/Storage/FileSystem/proffer.storage.filesystem.internal.filesystemfilereference.md delete mode 100644 docs/code/Storage/FileSystem/proffer.storage.filesystem.ipublicurlprovider.md delete mode 100644 docs/code/Storage/FileSystem/proffer.storage.filesystem.noextendedpropertiesprovider.md delete mode 100644 docs/code/Storage/index.md delete mode 100644 docs/code/Storage/proffer.storage.configuration.accesslevel.md delete mode 100644 docs/code/Storage/proffer.storage.configuration.configurationextensions.md delete mode 100644 docs/code/Storage/proffer.storage.configuration.iparsedoptions-3.md delete mode 100644 docs/code/Storage/proffer.storage.configuration.iscopedstoreoptions.md delete mode 100644 docs/code/Storage/proffer.storage.configuration.istoreoptions.md delete mode 100644 docs/code/Storage/proffer.storage.configuration.scopedstoreoptions.md delete mode 100644 docs/code/Storage/proffer.storage.configuration.storageoptions.md delete mode 100644 docs/code/Storage/proffer.storage.configuration.storeoptions.md delete mode 100644 docs/code/Storage/proffer.storage.exceptions.badproviderconfiguration.md delete mode 100644 docs/code/Storage/proffer.storage.exceptions.badscopedstoreconfiguration.md delete mode 100644 docs/code/Storage/proffer.storage.exceptions.badstoreconfiguration.md delete mode 100644 docs/code/Storage/proffer.storage.exceptions.filealreadyexistsexception.md delete mode 100644 docs/code/Storage/proffer.storage.exceptions.providernotfoundexception.md delete mode 100644 docs/code/Storage/proffer.storage.exceptions.storenotfoundexception.md delete mode 100644 docs/code/Storage/proffer.storage.ifileproperties.md delete mode 100644 docs/code/Storage/proffer.storage.ifilereference.md delete mode 100644 docs/code/Storage/proffer.storage.internal.configureprovideroptions-4.md delete mode 100644 docs/code/Storage/proffer.storage.internal.genericstoreproxy-1.md delete mode 100644 docs/code/Storage/proffer.storage.internal.privatefilereference.md delete mode 100644 docs/code/Storage/proffer.storage.internal.storagefactory.md delete mode 100644 docs/code/Storage/proffer.storage.internal.storageproviderbase-4.md delete mode 100644 docs/code/Storage/proffer.storage.iprivatefilereference.md delete mode 100644 docs/code/Storage/proffer.storage.isharedaccesspolicy.md delete mode 100644 docs/code/Storage/proffer.storage.istoragefactory.md delete mode 100644 docs/code/Storage/proffer.storage.istorageprovider.md delete mode 100644 docs/code/Storage/proffer.storage.istore-1.md delete mode 100644 docs/code/Storage/proffer.storage.istore.md delete mode 100644 docs/code/Storage/proffer.storage.istoreextensions.md delete mode 100644 docs/code/Storage/proffer.storage.overwritepolicy.md delete mode 100644 docs/code/Storage/proffer.storage.sharedaccesspermissions.md delete mode 100644 docs/code/Storage/proffer.storage.sharedaccesspolicy.md delete mode 100644 docs/code/Storage/proffer.storage.storageservicecollectionextensions.md delete mode 100644 docs/code/Storage/proffer.storage.storebase.md delete mode 100644 docs/code/Templating/Handlebars/index.md delete mode 100644 docs/code/Templating/Handlebars/proffer.templating.handlebars.handlebarstemplateprovider.md delete mode 100644 docs/code/Templating/Mustache/index.md delete mode 100644 docs/code/Templating/Mustache/proffer.templating.mustache.mustachetemplate.md delete mode 100644 docs/code/Templating/Mustache/proffer.templating.mustache.mustachetemplateprovider.md delete mode 100644 docs/code/Templating/index.md delete mode 100644 docs/code/Templating/proffer.templating.exceptions.providernotfoundexception.md delete mode 100644 docs/code/Templating/proffer.templating.exceptions.templatenotfoundexception.md delete mode 100644 docs/code/Templating/proffer.templating.invalidcontextexception.md delete mode 100644 docs/code/Templating/proffer.templating.itemplate.md delete mode 100644 docs/code/Templating/proffer.templating.itemplateloader.md delete mode 100644 docs/code/Templating/proffer.templating.itemplateloaderfactory.md delete mode 100644 docs/code/Templating/proffer.templating.itemplateprovider.md delete mode 100644 docs/code/Templating/proffer.templating.itemplateproviderscope.md delete mode 100644 docs/code/Templating/proffer.templating.templatecollectionbase-1.md delete mode 100644 docs/code/Templating/proffer.templating.templatecollectionbase.md diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 5034824..9a21928 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -3,7 +3,7 @@ "isRoot": true, "tools": { "xmldoc2markdown": { - "version": "2.1.0", + "version": "2.1.1", "commands": [ "xmldoc2md" ] diff --git a/docs/code/Core/Azure/index.md b/docs/code/Core/Azure/index.md deleted file mode 100644 index 7d21032..0000000 --- a/docs/code/Core/Azure/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# Proffer.Azure - -## Proffer.Azure.Configuration - -[IAzureStorageOptions](./proffer.azure.configuration.iazurestorageoptions) diff --git a/docs/code/Core/Azure/proffer.azure.configuration.iazurestorageoptions.md b/docs/code/Core/Azure/proffer.azure.configuration.iazurestorageoptions.md deleted file mode 100644 index 8095c24..0000000 --- a/docs/code/Core/Azure/proffer.azure.configuration.iazurestorageoptions.md +++ /dev/null @@ -1,35 +0,0 @@ -# IAzureStorageOptions - -Namespace: Proffer.Azure.Configuration - -Proffer options pointing to an Azure Storage account. - -```csharp -public interface IAzureStorageOptions -``` - -## Properties - -### **ConnectionString** - -Gets or sets the connection string. - -```csharp -public abstract string ConnectionString { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ConnectionStringName** - -Gets or sets the name of the connection string to reference. - -```csharp -public abstract string ConnectionStringName { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
diff --git a/docs/code/Core/index.md b/docs/code/Core/index.md deleted file mode 100644 index d464005..0000000 --- a/docs/code/Core/index.md +++ /dev/null @@ -1,17 +0,0 @@ -# Proffer - -## Proffer - -[EqualityComparerBase<T>](./proffer.equalitycomparerbase-1) - -## Proffer.Configuration - -[INamedElementOptions](./proffer.configuration.inamedelementoptions) - -[IOptionError](./proffer.configuration.ioptionerror) - -[IProviderOptions](./proffer.configuration.iprovideroptions) - -[OptionError](./proffer.configuration.optionerror) - -[ProviderOptions](./proffer.configuration.provideroptions) diff --git a/docs/code/Core/proffer.configuration.inamedelementoptions.md b/docs/code/Core/proffer.configuration.inamedelementoptions.md deleted file mode 100644 index 9e83b8d..0000000 --- a/docs/code/Core/proffer.configuration.inamedelementoptions.md +++ /dev/null @@ -1,23 +0,0 @@ -# INamedElementOptions - -Namespace: Proffer.Configuration - -A named element from the options (provider or scope). - -```csharp -public interface INamedElementOptions -``` - -## Properties - -### **Name** - -Gets or sets the name. - -```csharp -public abstract string Name { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
diff --git a/docs/code/Core/proffer.configuration.ioptionerror.md b/docs/code/Core/proffer.configuration.ioptionerror.md deleted file mode 100644 index f946538..0000000 --- a/docs/code/Core/proffer.configuration.ioptionerror.md +++ /dev/null @@ -1,35 +0,0 @@ -# IOptionError - -Namespace: Proffer.Configuration - -An error reported from the options validation. - -```csharp -public interface IOptionError -``` - -## Properties - -### **PropertyName** - -Gets the name of the faulted property. - -```csharp -public abstract string PropertyName { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ErrorMessage** - -Gets the error message. - -```csharp -public abstract string ErrorMessage { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
diff --git a/docs/code/Core/proffer.configuration.iprovideroptions.md b/docs/code/Core/proffer.configuration.iprovideroptions.md deleted file mode 100644 index 0d80f25..0000000 --- a/docs/code/Core/proffer.configuration.iprovideroptions.md +++ /dev/null @@ -1,25 +0,0 @@ -# IProviderOptions - -Namespace: Proffer.Configuration - -Options of a provider. - -```csharp -public interface IProviderOptions : INamedElementOptions -``` - -Implements [INamedElementOptions](./proffer.configuration.inamedelementoptions) - -## Properties - -### **Type** - -Gets the type. - -```csharp -public abstract string Type { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
diff --git a/docs/code/Core/proffer.configuration.optionerror.md b/docs/code/Core/proffer.configuration.optionerror.md deleted file mode 100644 index 1422375..0000000 --- a/docs/code/Core/proffer.configuration.optionerror.md +++ /dev/null @@ -1,48 +0,0 @@ -# OptionError - -Namespace: Proffer.Configuration - -A generic error reported from the options validation. - -```csharp -public class OptionError : IOptionError -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [OptionError](./proffer.configuration.optionerror)
-Implements [IOptionError](./proffer.configuration.ioptionerror) - -## Properties - -### **PropertyName** - -Gets the name of the faulted property. - -```csharp -public string PropertyName { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ErrorMessage** - -Gets the error message. - -```csharp -public string ErrorMessage { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Constructors - -### **OptionError()** - - - -```csharp -public OptionError() -``` diff --git a/docs/code/Core/proffer.configuration.provideroptions.md b/docs/code/Core/proffer.configuration.provideroptions.md deleted file mode 100644 index 157af47..0000000 --- a/docs/code/Core/proffer.configuration.provideroptions.md +++ /dev/null @@ -1,48 +0,0 @@ -# ProviderOptions - -Namespace: Proffer.Configuration - -Standard options for a provider. - -```csharp -public class ProviderOptions : IProviderOptions, INamedElementOptions -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ProviderOptions](./proffer.configuration.provideroptions)
-Implements [IProviderOptions](./proffer.configuration.iprovideroptions), [INamedElementOptions](./proffer.configuration.inamedelementoptions) - -## Properties - -### **Name** - -Gets or sets the name. - -```csharp -public string Name { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Type** - -Gets the type. - -```csharp -public string Type { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Constructors - -### **ProviderOptions()** - - - -```csharp -public ProviderOptions() -``` diff --git a/docs/code/Core/proffer.equalitycomparerbase-1.md b/docs/code/Core/proffer.equalitycomparerbase-1.md deleted file mode 100644 index a495316..0000000 --- a/docs/code/Core/proffer.equalitycomparerbase-1.md +++ /dev/null @@ -1,78 +0,0 @@ -# EqualityComparerBase<T> - -Namespace: Proffer - -Implements [IEqualityComparer<T>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.iequalitycomparer-1) by comparing individual equality components from child class. - -```csharp -public abstract class EqualityComparerBase : , System.Collections.IEqualityComparer, -``` - -#### Type Parameters - -`T`
-The type of objects to compare. - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → EqualityComparer<T> → [EqualityComparerBase<T>](./proffer.equalitycomparerbase-1)
-Implements [IEqualityComparer](https://docs.microsoft.com/en-us/dotnet/api/system.collections.iequalitycomparer), IEqualityComparer<T> - -## Methods - -### **Equals(T, T)** - -When overridden in a derived class, determines whether two objects of type T are equal. - -```csharp -public bool Equals(T x, T y) -``` - -#### Parameters - -`x` T
-The first object to compare. - -`y` T
-The second object to compare. - -#### Returns - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- - true if the specified objects are equal; otherwise, false. - -### **GetHashCode(T)** - -Returns a hash code for this instance. - -```csharp -public int GetHashCode(T obj) -``` - -#### Parameters - -`obj` T
-The object. - -#### Returns - -[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
- - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - -### **GetEqualityComponents(T)** - -Gets the object's components that participate in equality comparisons. - -```csharp -protected abstract IEnumerable GetEqualityComponents(T obj) -``` - -#### Parameters - -`obj` T
-The object. - -#### Returns - -[IEnumerable<Object>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-An enumerable containing the properties values. diff --git a/docs/code/Email/InMemory/index.md b/docs/code/Email/InMemory/index.md deleted file mode 100644 index 934357b..0000000 --- a/docs/code/Email/InMemory/index.md +++ /dev/null @@ -1,17 +0,0 @@ -# Proffer.Email.InMemory - -## Proffer.Email - -[InMemoryEmailServiceCollectionExtensions](./proffer.email.inmemoryemailservicecollectionextensions) - -## Proffer.Email.InMemory - -[IInMemoryEmailRepository](./proffer.email.inmemory.iinmemoryemailrepository) - -[InMemoryEmail](./proffer.email.inmemory.inmemoryemail) - -[InMemoryEmailProvider](./proffer.email.inmemory.inmemoryemailprovider) - -[InMemoryEmailProviderType](./proffer.email.inmemory.inmemoryemailprovidertype) - -[InMemoryEmailRepository](./proffer.email.inmemory.inmemoryemailrepository) diff --git a/docs/code/Email/InMemory/proffer.email.inmemory.iinmemoryemailrepository.md b/docs/code/Email/InMemory/proffer.email.inmemory.iinmemoryemailrepository.md deleted file mode 100644 index 35c7731..0000000 --- a/docs/code/Email/InMemory/proffer.email.inmemory.iinmemoryemailrepository.md +++ /dev/null @@ -1,38 +0,0 @@ -# IInMemoryEmailRepository - -Namespace: Proffer.Email.InMemory - -A repository in memory to hold sent emails through the provider. - -```csharp -public interface IInMemoryEmailRepository -``` - -## Properties - -### **Store** - -Gets the emails store. - -```csharp -public abstract IReadOnlyCollection Store { get; } -``` - -#### Property Value - -[IReadOnlyCollection<InMemoryEmail>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlycollection-1)
- -## Methods - -### **Save(InMemoryEmail)** - -Saves the specified email in the store. - -```csharp -void Save(InMemoryEmail email) -``` - -#### Parameters - -`email` [InMemoryEmail](./proffer.email.inmemory.inmemoryemail)
-The email. diff --git a/docs/code/Email/InMemory/proffer.email.inmemory.inmemoryemail.md b/docs/code/Email/InMemory/proffer.email.inmemory.inmemoryemail.md deleted file mode 100644 index 439e66b..0000000 --- a/docs/code/Email/InMemory/proffer.email.inmemory.inmemoryemail.md +++ /dev/null @@ -1,131 +0,0 @@ -# InMemoryEmail - -Namespace: Proffer.Email.InMemory - -An object to retain the values of the email that would have been sent. - -```csharp -public class InMemoryEmail -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [InMemoryEmail](./proffer.email.inmemory.inmemoryemail) - -## Properties - -### **Subject** - -Gets or sets the subject. - -```csharp -public string Subject { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **MessageText** - -Gets or sets the message as plain-text. - -```csharp -public string MessageText { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **MessageHtml** - -Gets or sets the message as HTML. - -```csharp -public string MessageHtml { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **To** - -Gets or sets the email recipients. - -```csharp -public IEmailAddress[] To { get; set; } -``` - -#### Property Value - -IEmailAddress[]
- -### **Cc** - -Gets or sets the email recipients. - -```csharp -public IEmailAddress[] Cc { get; set; } -``` - -#### Property Value - -IEmailAddress[]
- -### **Bcc** - -Gets or sets the BCC email recipients. - -```csharp -public IEmailAddress[] Bcc { get; set; } -``` - -#### Property Value - -IEmailAddress[]
- -### **From** - -Gets or sets the sender email address. - -```csharp -public IEmailAddress From { get; set; } -``` - -#### Property Value - -IEmailAddress
- -### **ReplyTo** - -Gets or sets the reply-to email address. - -```csharp -public IEmailAddress ReplyTo { get; set; } -``` - -#### Property Value - -IEmailAddress
- -### **Attachments** - -Gets or sets the attachments files. - -```csharp -public IEnumerable Attachments { get; set; } -``` - -#### Property Value - -[IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
- -## Constructors - -### **InMemoryEmail()** - - - -```csharp -public InMemoryEmail() -``` diff --git a/docs/code/Email/InMemory/proffer.email.inmemory.inmemoryemailprovider.md b/docs/code/Email/InMemory/proffer.email.inmemory.inmemoryemailprovider.md deleted file mode 100644 index 39b8ecd..0000000 --- a/docs/code/Email/InMemory/proffer.email.inmemory.inmemoryemailprovider.md +++ /dev/null @@ -1,137 +0,0 @@ -# InMemoryEmailProvider - -Namespace: Proffer.Email.InMemory - -A provider which does not send any email but holds it in a collection in memory. - -```csharp -public class InMemoryEmailProvider : Proffer.Email.IEmailProvider -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [InMemoryEmailProvider](./proffer.email.inmemory.inmemoryemailprovider)
-Implements IEmailProvider - -## Constructors - -### **InMemoryEmailProvider(IInMemoryEmailRepository)** - -Initializes a new instance of the [InMemoryEmailProvider](./proffer.email.inmemory.inmemoryemailprovider) class. - -```csharp -public InMemoryEmailProvider(IInMemoryEmailRepository inMemoryEmailRepository) -``` - -#### Parameters - -`inMemoryEmailRepository` [IInMemoryEmailRepository](./proffer.email.inmemory.iinmemoryemailrepository)
-The in-memory email repository. - -## Methods - -### **SendEmailAsync(IEmailAddress, IEnumerable<IEmailAddress>, String, String, String)** - -Sends an email. - -```csharp -public Task SendEmailAsync(IEmailAddress from, IEnumerable recipients, string subject, string bodyText, string bodyHtml) -``` - -#### Parameters - -`from` IEmailAddress
-The sender email address. - -`recipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The email recipients. - -`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The subject. - -`bodyText` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as plain text. - -`bodyHtml` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as HTML. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **SendEmailAsync(IEmailAddress, IEnumerable<IEmailAddress>, String, String, String, IEnumerable<IEmailAttachment>)** - -Sends an email. - -```csharp -public Task SendEmailAsync(IEmailAddress from, IEnumerable recipients, string subject, string bodyText, string bodyHtml, IEnumerable attachments) -``` - -#### Parameters - -`from` IEmailAddress
-The sender email address. - -`recipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The email recipients. - -`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The subject. - -`bodyText` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as plain text. - -`bodyHtml` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as HTML. - -`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The file attachments. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **SendEmailAsync(IEmailAddress, IEnumerable<IEmailAddress>, IEnumerable<IEmailAddress>, IEnumerable<IEmailAddress>, String, String, String, IEnumerable<IEmailAttachment>, IEmailAddress)** - -Sends an email. - -```csharp -public Task SendEmailAsync(IEmailAddress from, IEnumerable recipients, IEnumerable ccRecipients, IEnumerable bccRecipients, string subject, string bodyText, string bodyHtml, IEnumerable attachments, IEmailAddress replyTo) -``` - -#### Parameters - -`from` IEmailAddress
-The sender email address. - -`recipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The email recipients. - -`ccRecipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The CC email recipients. - -`bccRecipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The BCC email recipients. - -`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The subject. - -`bodyText` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as plain text. - -`bodyHtml` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as HTML. - -`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The file attachments. - -`replyTo` IEmailAddress
-The reply-to email address. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. diff --git a/docs/code/Email/InMemory/proffer.email.inmemory.inmemoryemailprovidertype.md b/docs/code/Email/InMemory/proffer.email.inmemory.inmemoryemailprovidertype.md deleted file mode 100644 index be7d3aa..0000000 --- a/docs/code/Email/InMemory/proffer.email.inmemory.inmemoryemailprovidertype.md +++ /dev/null @@ -1,62 +0,0 @@ -# InMemoryEmailProviderType - -Namespace: Proffer.Email.InMemory - -Builds [InMemoryEmailProvider](./proffer.email.inmemory.inmemoryemailprovider). - -```csharp -public class InMemoryEmailProviderType : Proffer.Email.IEmailProviderType -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [InMemoryEmailProviderType](./proffer.email.inmemory.inmemoryemailprovidertype)
-Implements IEmailProviderType - -## Properties - -### **Name** - -Gets the name. - -```csharp -public string Name { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Constructors - -### **InMemoryEmailProviderType(IInMemoryEmailRepository)** - -Initializes a new instance of the [InMemoryEmailProviderType](./proffer.email.inmemory.inmemoryemailprovidertype) class. - -```csharp -public InMemoryEmailProviderType(IInMemoryEmailRepository inMemoryEmailRepository) -``` - -#### Parameters - -`inMemoryEmailRepository` [IInMemoryEmailRepository](./proffer.email.inmemory.iinmemoryemailrepository)
-The in-memory email repository. - -## Methods - -### **BuildProvider(IEmailProviderOptions)** - -Builds the provider. - -```csharp -public IEmailProvider BuildProvider(IEmailProviderOptions providerOptions) -``` - -#### Parameters - -`providerOptions` IEmailProviderOptions
-The provider options. - -#### Returns - -IEmailProvider
- - A new . diff --git a/docs/code/Email/InMemory/proffer.email.inmemory.inmemoryemailrepository.md b/docs/code/Email/InMemory/proffer.email.inmemory.inmemoryemailrepository.md deleted file mode 100644 index 8c964d6..0000000 --- a/docs/code/Email/InMemory/proffer.email.inmemory.inmemoryemailrepository.md +++ /dev/null @@ -1,51 +0,0 @@ -# InMemoryEmailRepository - -Namespace: Proffer.Email.InMemory - -A repository in memory to hold sent emails through the provider. - -```csharp -public class InMemoryEmailRepository : IInMemoryEmailRepository -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [InMemoryEmailRepository](./proffer.email.inmemory.inmemoryemailrepository)
-Implements [IInMemoryEmailRepository](./proffer.email.inmemory.iinmemoryemailrepository) - -## Properties - -### **Store** - -Gets the emails store. - -```csharp -public IReadOnlyCollection Store { get; } -``` - -#### Property Value - -[IReadOnlyCollection<InMemoryEmail>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlycollection-1)
- -## Constructors - -### **InMemoryEmailRepository()** - - - -```csharp -public InMemoryEmailRepository() -``` - -## Methods - -### **Save(InMemoryEmail)** - -Saves the specified email in the store. - -```csharp -public void Save(InMemoryEmail email) -``` - -#### Parameters - -`email` [InMemoryEmail](./proffer.email.inmemory.inmemoryemail)
-The email. diff --git a/docs/code/Email/SendGrid/index.md b/docs/code/Email/SendGrid/index.md deleted file mode 100644 index 7e688ee..0000000 --- a/docs/code/Email/SendGrid/index.md +++ /dev/null @@ -1,11 +0,0 @@ -# Proffer.Email.SendGrid - -## Proffer.Email - -[ServiceCollectionExtensions](./proffer.email.servicecollectionextensions) - -## Proffer.Email.SendGrid - -[SendGridEmailProvider](./proffer.email.sendgrid.sendgridemailprovider) - -[SendGridEmailProviderType](./proffer.email.sendgrid.sendgridemailprovidertype) diff --git a/docs/code/Email/SendGrid/proffer.email.sendgrid.sendgridemailprovider.md b/docs/code/Email/SendGrid/proffer.email.sendgrid.sendgridemailprovider.md deleted file mode 100644 index c653a4f..0000000 --- a/docs/code/Email/SendGrid/proffer.email.sendgrid.sendgridemailprovider.md +++ /dev/null @@ -1,148 +0,0 @@ -# SendGridEmailProvider - -Namespace: Proffer.Email.SendGrid - -A provider that sends email using N:SendGrid API. - -```csharp -public class SendGridEmailProvider : Proffer.Email.IEmailProvider -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [SendGridEmailProvider](./proffer.email.sendgrid.sendgridemailprovider)
-Implements IEmailProvider - -## Constructors - -### **SendGridEmailProvider(IEmailProviderOptions)** - -Initializes a new instance of the [SendGridEmailProvider](./proffer.email.sendgrid.sendgridemailprovider) class. - -```csharp -public SendGridEmailProvider(IEmailProviderOptions options) -``` - -#### Parameters - -`options` IEmailProviderOptions
-The options. - -#### Exceptions - -[ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/system.argumentnullexception)
-apiKey - -## Methods - -### **SendEmailAsync(IEmailAddress, IEnumerable<IEmailAddress>, String, String, String)** - -Sends an email. - -```csharp -public Task SendEmailAsync(IEmailAddress from, IEnumerable recipients, string subject, string bodyText, string bodyHtml) -``` - -#### Parameters - -`from` IEmailAddress
-The sender email address. - -`recipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The email recipients. - -`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The subject. - -`bodyText` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as plain text. - -`bodyHtml` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as HTML. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **SendEmailAsync(IEmailAddress, IEnumerable<IEmailAddress>, String, String, String, IEnumerable<IEmailAttachment>)** - -Sends an email. - -```csharp -public Task SendEmailAsync(IEmailAddress from, IEnumerable recipients, string subject, string bodyText, string bodyHtml, IEnumerable attachments) -``` - -#### Parameters - -`from` IEmailAddress
-The sender email address. - -`recipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The email recipients. - -`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The subject. - -`bodyText` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as plain text. - -`bodyHtml` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as HTML. - -`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The file attachments. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **SendEmailAsync(IEmailAddress, IEnumerable<IEmailAddress>, IEnumerable<IEmailAddress>, IEnumerable<IEmailAddress>, String, String, String, IEnumerable<IEmailAttachment>, IEmailAddress)** - -Sends an email. - -```csharp -public Task SendEmailAsync(IEmailAddress from, IEnumerable recipients, IEnumerable ccRecipients, IEnumerable bccRecipients, string subject, string bodyText, string bodyHtml, IEnumerable attachments, IEmailAddress replyTo) -``` - -#### Parameters - -`from` IEmailAddress
-The sender email address. - -`recipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The email recipients. - -`ccRecipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The CC email recipients. - -`bccRecipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The BCC email recipients. - -`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The subject. - -`bodyText` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as plain text. - -`bodyHtml` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as HTML. - -`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The file attachments. - -`replyTo` IEmailAddress
-The reply-to email address. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- -#### Exceptions - -[ArgumentException](https://docs.microsoft.com/en-us/dotnet/api/system.argumentexception)
-Each email address should be unique between to, cc, and bcc recipients. We found duplicates. - -[Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception)
-Cannot Send Email: {response.StatusCode} diff --git a/docs/code/Email/SendGrid/proffer.email.sendgrid.sendgridemailprovidertype.md b/docs/code/Email/SendGrid/proffer.email.sendgrid.sendgridemailprovidertype.md deleted file mode 100644 index 1f9a9d8..0000000 --- a/docs/code/Email/SendGrid/proffer.email.sendgrid.sendgridemailprovidertype.md +++ /dev/null @@ -1,57 +0,0 @@ -# SendGridEmailProviderType - -Namespace: Proffer.Email.SendGrid - -Builds [SendGridEmailProvider](./proffer.email.sendgrid.sendgridemailprovider). - -```csharp -public class SendGridEmailProviderType : Proffer.Email.IEmailProviderType -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [SendGridEmailProviderType](./proffer.email.sendgrid.sendgridemailprovidertype)
-Implements IEmailProviderType - -## Properties - -### **Name** - -Gets the name. - -```csharp -public string Name { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Constructors - -### **SendGridEmailProviderType()** - - - -```csharp -public SendGridEmailProviderType() -``` - -## Methods - -### **BuildProvider(IEmailProviderOptions)** - -Builds the provider. - -```csharp -public IEmailProvider BuildProvider(IEmailProviderOptions providerOptions) -``` - -#### Parameters - -`providerOptions` IEmailProviderOptions
-The provider options. - -#### Returns - -IEmailProvider
- - A new . diff --git a/docs/code/Email/SendGrid/proffer.email.servicecollectionextensions.md b/docs/code/Email/SendGrid/proffer.email.servicecollectionextensions.md deleted file mode 100644 index 8870099..0000000 --- a/docs/code/Email/SendGrid/proffer.email.servicecollectionextensions.md +++ /dev/null @@ -1,31 +0,0 @@ -# ServiceCollectionExtensions - -Namespace: Proffer.Email - -Microsoft.Extensions.DependencyInjection.IServiceCollection extension methods. - -```csharp -public static class ServiceCollectionExtensions -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ServiceCollectionExtensions](./proffer.email.servicecollectionextensions) - -## Methods - -### **AddSendGridEmail(IServiceCollection)** - -Registers the Proffer.Email services to the N:SendGrid API. - -```csharp -public static IServiceCollection AddSendGridEmail(IServiceCollection services) -``` - -#### Parameters - -`services` IServiceCollection
-The service collection. - -#### Returns - -IServiceCollection
-The service collection. diff --git a/docs/code/Email/Smtp/index.md b/docs/code/Email/Smtp/index.md deleted file mode 100644 index 04c87e6..0000000 --- a/docs/code/Email/Smtp/index.md +++ /dev/null @@ -1,11 +0,0 @@ -# Proffer.Email.Smtp - -## Proffer.Email - -[SmtpEmailServiceCollectionExtensions](./proffer.email.smtpemailservicecollectionextensions) - -## Proffer.Email.Smtp - -[SmtpEmailProvider](./proffer.email.smtp.smtpemailprovider) - -[SmtpEmailProviderType](./proffer.email.smtp.smtpemailprovidertype) diff --git a/docs/code/Email/Smtp/proffer.email.smtp.smtpemailprovider.md b/docs/code/Email/Smtp/proffer.email.smtp.smtpemailprovider.md deleted file mode 100644 index f5c4bb9..0000000 --- a/docs/code/Email/Smtp/proffer.email.smtp.smtpemailprovider.md +++ /dev/null @@ -1,144 +0,0 @@ -# SmtpEmailProvider - -Namespace: Proffer.Email.Smtp - -A provider that sends email to a SMTP server with N:MailKit. - -```csharp -public class SmtpEmailProvider : Proffer.Email.IEmailProvider -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [SmtpEmailProvider](./proffer.email.smtp.smtpemailprovider)
-Implements IEmailProvider - -## Constructors - -### **SmtpEmailProvider(IServiceProvider, IEmailProviderOptions)** - -Initializes a new instance of the [SmtpEmailProvider](./proffer.email.smtp.smtpemailprovider) class. - -```csharp -public SmtpEmailProvider(IServiceProvider serviceProvider, IEmailProviderOptions options) -``` - -#### Parameters - -`serviceProvider` IServiceProvider
-The service provider. - -`options` IEmailProviderOptions
-The options. - -#### Exceptions - -[ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/system.argumentnullexception)
- -[ArgumentException](https://docs.microsoft.com/en-us/dotnet/api/system.argumentexception)
- -## Methods - -### **SendEmailAsync(IEmailAddress, IEnumerable<IEmailAddress>, String, String, String)** - -Sends an email. - -```csharp -public Task SendEmailAsync(IEmailAddress from, IEnumerable recipients, string subject, string bodyText, string bodyHtml) -``` - -#### Parameters - -`from` IEmailAddress
-The sender email address. - -`recipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The email recipients. - -`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The subject. - -`bodyText` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as plain text. - -`bodyHtml` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as HTML. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **SendEmailAsync(IEmailAddress, IEnumerable<IEmailAddress>, String, String, String, IEnumerable<IEmailAttachment>)** - -Sends an email. - -```csharp -public Task SendEmailAsync(IEmailAddress from, IEnumerable recipients, string subject, string bodyText, string bodyHtml, IEnumerable attachments) -``` - -#### Parameters - -`from` IEmailAddress
-The sender email address. - -`recipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The email recipients. - -`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The subject. - -`bodyText` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as plain text. - -`bodyHtml` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as HTML. - -`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The file attachments. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **SendEmailAsync(IEmailAddress, IEnumerable<IEmailAddress>, IEnumerable<IEmailAddress>, IEnumerable<IEmailAddress>, String, String, String, IEnumerable<IEmailAttachment>, IEmailAddress)** - -Sends an email. - -```csharp -public Task SendEmailAsync(IEmailAddress from, IEnumerable recipients, IEnumerable ccRecipients, IEnumerable bccRecipients, string subject, string bodyText, string bodyHtml, IEnumerable attachments, IEmailAddress replyTo) -``` - -#### Parameters - -`from` IEmailAddress
-The sender email address. - -`recipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The email recipients. - -`ccRecipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The CC email recipients. - -`bccRecipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The BCC email recipients. - -`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The subject. - -`bodyText` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as plain text. - -`bodyHtml` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as HTML. - -`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The file attachments. - -`replyTo` IEmailAddress
-The reply-to email address. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
diff --git a/docs/code/Email/Smtp/proffer.email.smtp.smtpemailprovidertype.md b/docs/code/Email/Smtp/proffer.email.smtp.smtpemailprovidertype.md deleted file mode 100644 index 2de00b0..0000000 --- a/docs/code/Email/Smtp/proffer.email.smtp.smtpemailprovidertype.md +++ /dev/null @@ -1,62 +0,0 @@ -# SmtpEmailProviderType - -Namespace: Proffer.Email.Smtp - -Builds [SmtpEmailProvider](./proffer.email.smtp.smtpemailprovider). - -```csharp -public class SmtpEmailProviderType : Proffer.Email.IEmailProviderType -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [SmtpEmailProviderType](./proffer.email.smtp.smtpemailprovidertype)
-Implements IEmailProviderType - -## Properties - -### **Name** - -Gets the name. - -```csharp -public string Name { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Constructors - -### **SmtpEmailProviderType(IServiceProvider)** - -Initializes a new instance of the [SmtpEmailProviderType](./proffer.email.smtp.smtpemailprovidertype) class. - -```csharp -public SmtpEmailProviderType(IServiceProvider serviceProvider) -``` - -#### Parameters - -`serviceProvider` IServiceProvider
-The service provider. - -## Methods - -### **BuildProvider(IEmailProviderOptions)** - -Builds the provider. - -```csharp -public IEmailProvider BuildProvider(IEmailProviderOptions providerOptions) -``` - -#### Parameters - -`providerOptions` IEmailProviderOptions
-The provider options. - -#### Returns - -IEmailProvider
- - A new . diff --git a/docs/code/Email/index.md b/docs/code/Email/index.md deleted file mode 100644 index 15001e0..0000000 --- a/docs/code/Email/index.md +++ /dev/null @@ -1,41 +0,0 @@ -# Proffer.Email - -## Proffer.Email - -[EmailOptions](./proffer.email.emailoptions) - -[EmailProviderOptions](./proffer.email.emailprovideroptions) - -[EmailServiceCollectionExtensions](./proffer.email.emailservicecollectionextensions) - -[EmailTemplateType](./proffer.email.emailtemplatetype) - -[IEmailAddress](./proffer.email.iemailaddress) - -[IEmailAttachment](./proffer.email.iemailattachment) - -[IEmailProvider](./proffer.email.iemailprovider) - -[IEmailProviderOptions](./proffer.email.iemailprovideroptions) - -[IEmailProviderType](./proffer.email.iemailprovidertype) - -[IEmailSender](./proffer.email.iemailsender) - -[MockupExceptionsOptions](./proffer.email.mockupexceptionsoptions) - -[MockupOptions](./proffer.email.mockupoptions) - -## Proffer.Email.Internal - -[EmailAddress](./proffer.email.internal.emailaddress) - -[EmailAddressEqualityComparer](./proffer.email.internal.emailaddressequalitycomparer) - -[EmailAddressStrictEqualityComparer](./proffer.email.internal.emailaddressstrictequalitycomparer) - -[EmailAttachment](./proffer.email.internal.emailattachment) - -[EmailAttachmentEqualityComparer](./proffer.email.internal.emailattachmentequalitycomparer) - -[EmailSender](./proffer.email.internal.emailsender) diff --git a/docs/code/Email/proffer.email.emailoptions.md b/docs/code/Email/proffer.email.emailoptions.md deleted file mode 100644 index 10e3326..0000000 --- a/docs/code/Email/proffer.email.emailoptions.md +++ /dev/null @@ -1,81 +0,0 @@ -# EmailOptions - -Namespace: Proffer.Email - -The Proffer.Email options with providers. - -```csharp -public class EmailOptions -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EmailOptions](./proffer.email.emailoptions) - -## Fields - -### **DefaultConfigurationSectionName** - -The default configuration section name. - -```csharp -public static string DefaultConfigurationSectionName; -``` - -## Properties - -### **Provider** - -Gets or sets the provider options. - -```csharp -public EmailProviderOptions Provider { get; set; } -``` - -#### Property Value - -[EmailProviderOptions](./proffer.email.emailprovideroptions)
- -### **DefaultSender** - -Gets or sets the default sender email address. - -```csharp -public EmailAddress DefaultSender { get; set; } -``` - -#### Property Value - -[EmailAddress](./proffer.email.internal.emailaddress)
- -### **TemplateStorage** - -Gets or sets the template storage key to load templates from. - -```csharp -public string TemplateStorage { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Mockup** - -Gets or sets the mockup options. - -```csharp -public MockupOptions Mockup { get; set; } -``` - -#### Property Value - -[MockupOptions](./proffer.email.mockupoptions)
- -## Constructors - -### **EmailOptions()** - - - -```csharp -public EmailOptions() -``` diff --git a/docs/code/Email/proffer.email.emailprovideroptions.md b/docs/code/Email/proffer.email.emailprovideroptions.md deleted file mode 100644 index e42ad67..0000000 --- a/docs/code/Email/proffer.email.emailprovideroptions.md +++ /dev/null @@ -1,48 +0,0 @@ -# EmailProviderOptions - -Namespace: Proffer.Email - -Generic options for a [IEmailProvider](./proffer.email.iemailprovider). - -```csharp -public class EmailProviderOptions : IEmailProviderOptions -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EmailProviderOptions](./proffer.email.emailprovideroptions)
-Implements [IEmailProviderOptions](./proffer.email.iemailprovideroptions) - -## Properties - -### **Type** - -Gets or sets the type of the provider. - -```csharp -public string Type { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Parameters** - -Gets or sets the provider parameters. - -```csharp -public Dictionary Parameters { get; set; } -``` - -#### Property Value - -[Dictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.dictionary-2)
- -## Constructors - -### **EmailProviderOptions()** - - - -```csharp -public EmailProviderOptions() -``` diff --git a/docs/code/Email/proffer.email.emailtemplatetype.md b/docs/code/Email/proffer.email.emailtemplatetype.md deleted file mode 100644 index b1235ed..0000000 --- a/docs/code/Email/proffer.email.emailtemplatetype.md +++ /dev/null @@ -1,20 +0,0 @@ -# EmailTemplateType - -Namespace: Proffer.Email - -Type of template for a templated email. - -```csharp -public enum EmailTemplateType -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ValueType](https://docs.microsoft.com/en-us/dotnet/api/system.valuetype) → [Enum](https://docs.microsoft.com/en-us/dotnet/api/system.enum) → [EmailTemplateType](./proffer.email.emailtemplatetype)
-Implements [IComparable](https://docs.microsoft.com/en-us/dotnet/api/system.icomparable), [IFormattable](https://docs.microsoft.com/en-us/dotnet/api/system.iformattable), [IConvertible](https://docs.microsoft.com/en-us/dotnet/api/system.iconvertible) - -## Fields - -| Name | Value | Description | -| --- | --: | --- | -| Subject | 0 | The templated subject. | -| BodyHtml | 1 | The templated body as HTML. | -| BodyText | 2 | The templated body as plain-text. | diff --git a/docs/code/Email/proffer.email.iemailaddress.md b/docs/code/Email/proffer.email.iemailaddress.md deleted file mode 100644 index 8f50d89..0000000 --- a/docs/code/Email/proffer.email.iemailaddress.md +++ /dev/null @@ -1,35 +0,0 @@ -# IEmailAddress - -Namespace: Proffer.Email - -An email address with its optional display name. - -```csharp -public interface IEmailAddress -``` - -## Properties - -### **Email** - -Gets the email. - -```csharp -public abstract string Email { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **DisplayName** - -Gets the display name. - -```csharp -public abstract string DisplayName { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
diff --git a/docs/code/Email/proffer.email.iemailattachment.md b/docs/code/Email/proffer.email.iemailattachment.md deleted file mode 100644 index 20dab08..0000000 --- a/docs/code/Email/proffer.email.iemailattachment.md +++ /dev/null @@ -1,71 +0,0 @@ -# IEmailAttachment - -Namespace: Proffer.Email - -An email attachment file. - -```csharp -public interface IEmailAttachment -``` - -## Properties - -### **FileName** - -Gets or sets the file name. - -```csharp -public abstract string FileName { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Data** - -Gets or sets the file content. - -```csharp -public abstract Byte[] Data { get; set; } -``` - -#### Property Value - -[Byte[]](https://docs.microsoft.com/en-us/dotnet/api/system.byte)
- -### **MediaType** - -Gets or sets the media type. - -```csharp -public abstract string MediaType { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **MediaSubtype** - -Gets or sets the media subtype. - -```csharp -public abstract string MediaSubtype { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ContentType** - -Gets the content-type. - -```csharp -public abstract string ContentType { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
diff --git a/docs/code/Email/proffer.email.iemailprovider.md b/docs/code/Email/proffer.email.iemailprovider.md deleted file mode 100644 index 68e363c..0000000 --- a/docs/code/Email/proffer.email.iemailprovider.md +++ /dev/null @@ -1,119 +0,0 @@ -# IEmailProvider - -Namespace: Proffer.Email - -A provider sends email using a particular messaging protocol or API. - -```csharp -public interface IEmailProvider -``` - -## Methods - -### **SendEmailAsync(IEmailAddress, IEnumerable<IEmailAddress>, String, String, String)** - -Sends an email. - -```csharp -Task SendEmailAsync(IEmailAddress from, IEnumerable recipients, string subject, string bodyText, string bodyHtml) -``` - -#### Parameters - -`from` [IEmailAddress](./proffer.email.iemailaddress)
-The sender email address. - -`recipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The email recipients. - -`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The subject. - -`bodyText` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as plain text. - -`bodyHtml` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as HTML. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **SendEmailAsync(IEmailAddress, IEnumerable<IEmailAddress>, String, String, String, IEnumerable<IEmailAttachment>)** - -Sends an email. - -```csharp -Task SendEmailAsync(IEmailAddress from, IEnumerable recipients, string subject, string bodyText, string bodyHtml, IEnumerable attachments) -``` - -#### Parameters - -`from` [IEmailAddress](./proffer.email.iemailaddress)
-The sender email address. - -`recipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The email recipients. - -`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The subject. - -`bodyText` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as plain text. - -`bodyHtml` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as HTML. - -`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The file attachments. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **SendEmailAsync(IEmailAddress, IEnumerable<IEmailAddress>, IEnumerable<IEmailAddress>, IEnumerable<IEmailAddress>, String, String, String, IEnumerable<IEmailAttachment>, IEmailAddress)** - -Sends an email. - -```csharp -Task SendEmailAsync(IEmailAddress from, IEnumerable recipients, IEnumerable ccRecipients, IEnumerable bccRecipients, string subject, string bodyText, string bodyHtml, IEnumerable attachments, IEmailAddress replyTo) -``` - -#### Parameters - -`from` [IEmailAddress](./proffer.email.iemailaddress)
-The sender email address. - -`recipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The email recipients. - -`ccRecipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The CC email recipients. - -`bccRecipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The BCC email recipients. - -`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The subject. - -`bodyText` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as plain text. - -`bodyHtml` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as HTML. - -`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The file attachments. - -`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
-The reply-to email address. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. diff --git a/docs/code/Email/proffer.email.iemailprovideroptions.md b/docs/code/Email/proffer.email.iemailprovideroptions.md deleted file mode 100644 index 7f2b1be..0000000 --- a/docs/code/Email/proffer.email.iemailprovideroptions.md +++ /dev/null @@ -1,35 +0,0 @@ -# IEmailProviderOptions - -Namespace: Proffer.Email - -Options for a [IEmailProvider](./proffer.email.iemailprovider). - -```csharp -public interface IEmailProviderOptions -``` - -## Properties - -### **Type** - -Gets or sets the type of the provider. - -```csharp -public abstract string Type { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Parameters** - -Gets or sets the provider parameters. - -```csharp -public abstract Dictionary Parameters { get; set; } -``` - -#### Property Value - -[Dictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.dictionary-2)
diff --git a/docs/code/Email/proffer.email.iemailprovidertype.md b/docs/code/Email/proffer.email.iemailprovidertype.md deleted file mode 100644 index 6aacc8d..0000000 --- a/docs/code/Email/proffer.email.iemailprovidertype.md +++ /dev/null @@ -1,43 +0,0 @@ -# IEmailProviderType - -Namespace: Proffer.Email - -Builds providers using a particular messaging protocol or API. - -```csharp -public interface IEmailProviderType -``` - -## Properties - -### **Name** - -Gets the name. - -```csharp -public abstract string Name { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Methods - -### **BuildProvider(IEmailProviderOptions)** - -Builds the provider. - -```csharp -IEmailProvider BuildProvider(IEmailProviderOptions providerOptions) -``` - -#### Parameters - -`providerOptions` [IEmailProviderOptions](./proffer.email.iemailprovideroptions)
-The provider options. - -#### Returns - -[IEmailProvider](./proffer.email.iemailprovider)
-A new . diff --git a/docs/code/Email/proffer.email.iemailsender.md b/docs/code/Email/proffer.email.iemailsender.md deleted file mode 100644 index 8e62c52..0000000 --- a/docs/code/Email/proffer.email.iemailsender.md +++ /dev/null @@ -1,428 +0,0 @@ -# IEmailSender - -Namespace: Proffer.Email - -Sends templated or raw emails using configured providers. - -```csharp -public interface IEmailSender -``` - -## Methods - -### **SendEmailAsync(String, String, IEmailAddress[])** - -Sends an email. - -```csharp -Task SendEmailAsync(string subject, string message, IEmailAddress[] to) -``` - -#### Parameters - -`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The subject. - -`message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as plain text. - -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
-The email recipients. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **SendEmailAsync(IEmailAddress, String, String, IEmailAddress[])** - -Sends an email. - -```csharp -Task SendEmailAsync(IEmailAddress from, string subject, string message, IEmailAddress[] to) -``` - -#### Parameters - -`from` [IEmailAddress](./proffer.email.iemailaddress)
-The sender email address. - -`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The subject. - -`message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as plain text. - -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
-The email recipients. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **SendEmailAsync(IEmailAddress, IEmailAddress, String, String, Boolean, IEmailAddress[])** - -Sends an email. - -```csharp -Task SendEmailAsync(IEmailAddress from, IEmailAddress replyTo, string subject, string message, bool plainTextOnly, IEmailAddress[] to) -``` - -#### Parameters - -`from` [IEmailAddress](./proffer.email.iemailaddress)
-The sender email address. - -`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
-The reply-to email address. - -`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The subject. - -`message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as plain text. - -`plainTextOnly` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true the body shoud be sent as plain text only. - -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
-The email recipients. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **SendEmailAsync(IEmailAddress, String, String, IEnumerable<IEmailAttachment>, IEmailAddress[])** - -Sends an email. - -```csharp -Task SendEmailAsync(IEmailAddress from, string subject, string message, IEnumerable attachments, IEmailAddress[] to) -``` - -#### Parameters - -`from` [IEmailAddress](./proffer.email.iemailaddress)
-The sender email address. - -`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The subject. - -`message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as plain text. - -`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The file attachments. - -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
-The email recipients. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **SendEmailAsync(IEmailAddress, IEmailAddress, String, String, Boolean, IEnumerable<IEmailAttachment>, IEmailAddress[])** - -Sends an email. - -```csharp -Task SendEmailAsync(IEmailAddress from, IEmailAddress replyTo, string subject, string message, bool plainTextOnly, IEnumerable attachments, IEmailAddress[] to) -``` - -#### Parameters - -`from` [IEmailAddress](./proffer.email.iemailaddress)
-The sender email address. - -`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
-The reply-to email address. - -`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The subject. - -`message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as plain text. - -`plainTextOnly` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true the body shoud be sent as plain text only. - -`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The file attachments. - -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
-The email recipients. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **SendEmailAsync(IEmailAddress, String, String, IEnumerable<IEmailAttachment>, IEmailAddress[], IEmailAddress[], IEmailAddress[], IEmailAddress, Boolean)** - -Sends an email. - -```csharp -Task SendEmailAsync(IEmailAddress from, string subject, string message, IEnumerable attachments, IEmailAddress[] to, IEmailAddress[] cc, IEmailAddress[] bcc, IEmailAddress replyTo, bool plainTextOnly) -``` - -#### Parameters - -`from` [IEmailAddress](./proffer.email.iemailaddress)
-The sender email address. - -`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The subject. - -`message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The body as plain text. - -`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The file attachments. - -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
-The email recipients. - -`cc` [IEmailAddress[]](./proffer.email.iemailaddress)
-The CC email recipients. - -`bcc` [IEmailAddress[]](./proffer.email.iemailaddress)
-The BCC email recipients. - -`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
-The reply-to email address. - -`plainTextOnly` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true the body shoud be sent as plain text only. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **SendTemplatedEmailAsync<T>(String, T, IEmailAddress[])** - -Sends a templated email from the configured default sender email address. - -```csharp -Task SendTemplatedEmailAsync(string templateKey, T context, IEmailAddress[] to) -``` - -#### Type Parameters - -`T`
-The type of context to apply on the template. - -#### Parameters - -`templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The template key. - -`context` T
-The context to apply on the template. - -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
-The email recipients. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **SendTemplatedEmailAsync<T>(IEmailAddress, String, T, IEmailAddress[])** - -Sends a templated email. - -```csharp -Task SendTemplatedEmailAsync(IEmailAddress from, string templateKey, T context, IEmailAddress[] to) -``` - -#### Type Parameters - -`T`
-The type of context to apply on the template. - -#### Parameters - -`from` [IEmailAddress](./proffer.email.iemailaddress)
-The sender email address. - -`templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The template key. - -`context` T
-The context to apply on the template. - -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
-The email recipients. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **SendTemplatedEmailAsync<T>(IEmailAddress, IEmailAddress, String, T, IEmailAddress[])** - -Sends a templated email. - -```csharp -Task SendTemplatedEmailAsync(IEmailAddress from, IEmailAddress replyTo, string templateKey, T context, IEmailAddress[] to) -``` - -#### Type Parameters - -`T`
-The type of context to apply on the template. - -#### Parameters - -`from` [IEmailAddress](./proffer.email.iemailaddress)
-The sender email address. - -`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
-The reply-to email address. - -`templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The template key. - -`context` T
-The context to apply on the template. - -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
-The email recipients. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **SendTemplatedEmailAsync<T>(IEmailAddress, String, T, IEnumerable<IEmailAttachment>, IEmailAddress[])** - -Sends a templated email. - -```csharp -Task SendTemplatedEmailAsync(IEmailAddress from, string templateKey, T context, IEnumerable attachments, IEmailAddress[] to) -``` - -#### Type Parameters - -`T`
-The type of context to apply on the template. - -#### Parameters - -`from` [IEmailAddress](./proffer.email.iemailaddress)
-The sender email address. - -`templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The template key. - -`context` T
-The context to apply on the template. - -`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The file attachments. - -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
-The email recipients. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **SendTemplatedEmailAsync<T>(IEmailAddress, IEmailAddress, String, T, IEnumerable<IEmailAttachment>, IEmailAddress[])** - -Sends a templated email. - -```csharp -Task SendTemplatedEmailAsync(IEmailAddress from, IEmailAddress replyTo, string templateKey, T context, IEnumerable attachments, IEmailAddress[] to) -``` - -#### Type Parameters - -`T`
-The type of context to apply on the template. - -#### Parameters - -`from` [IEmailAddress](./proffer.email.iemailaddress)
-The sender email address. - -`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
-The reply-to email address. - -`templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The template key. - -`context` T
-The context to apply on the template. - -`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The file attachments. - -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
-The email recipients. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **SendTemplatedEmailAsync<T>(IEmailAddress, String, T, IEnumerable<IEmailAttachment>, IEmailAddress[], IEmailAddress[], IEmailAddress[], IEmailAddress)** - -Sends a templated email. - -```csharp -Task SendTemplatedEmailAsync(IEmailAddress from, string templateKey, T context, IEnumerable attachments, IEmailAddress[] to, IEmailAddress[] cc, IEmailAddress[] bcc, IEmailAddress replyTo) -``` - -#### Type Parameters - -`T`
-The type of context to apply on the template. - -#### Parameters - -`from` [IEmailAddress](./proffer.email.iemailaddress)
-The sender email address. - -`templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The template key. - -`context` T
-The context to apply on the template. - -`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The file attachments. - -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
-The email recipients. - -`cc` [IEmailAddress[]](./proffer.email.iemailaddress)
-The CC email recipients. - -`bcc` [IEmailAddress[]](./proffer.email.iemailaddress)
-The BCC email recipients. - -`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
-The reply-to email address. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. diff --git a/docs/code/Email/proffer.email.internal.emailaddress.md b/docs/code/Email/proffer.email.internal.emailaddress.md deleted file mode 100644 index c0d24d5..0000000 --- a/docs/code/Email/proffer.email.internal.emailaddress.md +++ /dev/null @@ -1,64 +0,0 @@ -# EmailAddress - -Namespace: Proffer.Email.Internal - -A simple email address with its optional display name. - -```csharp -public class EmailAddress : Proffer.Email.IEmailAddress -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EmailAddress](./proffer.email.internal.emailaddress)
-Implements [IEmailAddress](./proffer.email.iemailaddress) - -## Properties - -### **Email** - -Gets or sets the email. - -```csharp -public string Email { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **DisplayName** - -Gets or sets the display name. - -```csharp -public string DisplayName { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Constructors - -### **EmailAddress()** - -Initializes a new instance of the [EmailAddress](./proffer.email.internal.emailaddress) class. - -```csharp -public EmailAddress() -``` - -### **EmailAddress(String, String)** - -Initializes a new instance of the [EmailAddress](./proffer.email.internal.emailaddress) class. - -```csharp -public EmailAddress(string email, string displayName) -``` - -#### Parameters - -`email` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The email. - -`displayName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The display name. diff --git a/docs/code/Email/proffer.email.internal.emailaddressequalitycomparer.md b/docs/code/Email/proffer.email.internal.emailaddressequalitycomparer.md deleted file mode 100644 index 4e2f2eb..0000000 --- a/docs/code/Email/proffer.email.internal.emailaddressequalitycomparer.md +++ /dev/null @@ -1,43 +0,0 @@ -# EmailAddressEqualityComparer - -Namespace: Proffer.Email.Internal - -Supports the comparison of [IEmailAddress](./proffer.email.iemailaddress) for equality when the email address only should match. - -```csharp -public class EmailAddressEqualityComparer : Proffer.EqualityComparerBase`1[[Proffer.Email.IEmailAddress, Proffer.Email, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Collections.IEqualityComparer, System.Collections.Generic.IEqualityComparer`1[[Proffer.Email.IEmailAddress, Proffer.Email, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EqualityComparer<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.equalitycomparer-1) → EqualityComparerBase<IEmailAddress> → [EmailAddressEqualityComparer](./proffer.email.internal.emailaddressequalitycomparer)
-Implements [IEqualityComparer](https://docs.microsoft.com/en-us/dotnet/api/system.collections.iequalitycomparer), [IEqualityComparer<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.iequalitycomparer-1) - -## Constructors - -### **EmailAddressEqualityComparer()** - - - -```csharp -public EmailAddressEqualityComparer() -``` - -## Methods - -### **GetEqualityComponents(IEmailAddress)** - -Gets the object's components that participate in equality comparisons. - -```csharp -protected IEnumerable GetEqualityComponents(IEmailAddress obj) -``` - -#### Parameters - -`obj` [IEmailAddress](./proffer.email.iemailaddress)
-The object. - -#### Returns - -[IEnumerable<Object>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
- - An enumerable containing the properties values. diff --git a/docs/code/Email/proffer.email.internal.emailaddressstrictequalitycomparer.md b/docs/code/Email/proffer.email.internal.emailaddressstrictequalitycomparer.md deleted file mode 100644 index fae43be..0000000 --- a/docs/code/Email/proffer.email.internal.emailaddressstrictequalitycomparer.md +++ /dev/null @@ -1,43 +0,0 @@ -# EmailAddressStrictEqualityComparer - -Namespace: Proffer.Email.Internal - -Supports the comparison of [IEmailAddress](./proffer.email.iemailaddress) for equality when both the email address and the display name should match. - -```csharp -public class EmailAddressStrictEqualityComparer : Proffer.EqualityComparerBase`1[[Proffer.Email.IEmailAddress, Proffer.Email, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Collections.IEqualityComparer, System.Collections.Generic.IEqualityComparer`1[[Proffer.Email.IEmailAddress, Proffer.Email, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EqualityComparer<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.equalitycomparer-1) → EqualityComparerBase<IEmailAddress> → [EmailAddressStrictEqualityComparer](./proffer.email.internal.emailaddressstrictequalitycomparer)
-Implements [IEqualityComparer](https://docs.microsoft.com/en-us/dotnet/api/system.collections.iequalitycomparer), [IEqualityComparer<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.iequalitycomparer-1) - -## Constructors - -### **EmailAddressStrictEqualityComparer()** - - - -```csharp -public EmailAddressStrictEqualityComparer() -``` - -## Methods - -### **GetEqualityComponents(IEmailAddress)** - -Gets the object's components that participate in equality comparisons. - -```csharp -protected IEnumerable GetEqualityComponents(IEmailAddress obj) -``` - -#### Parameters - -`obj` [IEmailAddress](./proffer.email.iemailaddress)
-The object. - -#### Returns - -[IEnumerable<Object>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
- - An enumerable containing the properties values. diff --git a/docs/code/Email/proffer.email.internal.emailattachment.md b/docs/code/Email/proffer.email.internal.emailattachment.md deleted file mode 100644 index 9d76156..0000000 --- a/docs/code/Email/proffer.email.internal.emailattachment.md +++ /dev/null @@ -1,125 +0,0 @@ -# EmailAttachment - -Namespace: Proffer.Email.Internal - -A simpl email attachment file. - -```csharp -public class EmailAttachment : Proffer.Email.IEmailAttachment -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EmailAttachment](./proffer.email.internal.emailattachment)
-Implements [IEmailAttachment](./proffer.email.iemailattachment) - -## Properties - -### **FileName** - -Gets or sets the file name. - -```csharp -public string FileName { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Data** - -Gets or sets the file content. - -```csharp -public Byte[] Data { get; set; } -``` - -#### Property Value - -[Byte[]](https://docs.microsoft.com/en-us/dotnet/api/system.byte)
- -### **MediaType** - -Gets or sets the media type. - -```csharp -public string MediaType { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **MediaSubtype** - -Gets or sets the media subtype. - -```csharp -public string MediaSubtype { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ContentType** - -Gets the content-type. - -```csharp -public string ContentType { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Constructors - -### **EmailAttachment()** - -Initializes a new instance of the [EmailAttachment](./proffer.email.internal.emailattachment) class. - -```csharp -public EmailAttachment() -``` - -### **EmailAttachment(String, Byte[], String)** - -Initializes a new instance of the [EmailAttachment](./proffer.email.internal.emailattachment) class. - -```csharp -public EmailAttachment(string fileName, Byte[] data, string contentType) -``` - -#### Parameters - -`fileName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The file name. - -`data` [Byte[]](https://docs.microsoft.com/en-us/dotnet/api/system.byte)
-The file content. - -`contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The content-type. - -### **EmailAttachment(String, Byte[], String, String)** - -Initializes a new instance of the [EmailAttachment](./proffer.email.internal.emailattachment) class. - -```csharp -public EmailAttachment(string fileName, Byte[] data, string mediaType, string mediaSubtype) -``` - -#### Parameters - -`fileName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The file name. - -`data` [Byte[]](https://docs.microsoft.com/en-us/dotnet/api/system.byte)
-The file content. - -`mediaType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The media type. - -`mediaSubtype` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The media subtype. diff --git a/docs/code/Email/proffer.email.internal.emailattachmentequalitycomparer.md b/docs/code/Email/proffer.email.internal.emailattachmentequalitycomparer.md deleted file mode 100644 index 09e9af6..0000000 --- a/docs/code/Email/proffer.email.internal.emailattachmentequalitycomparer.md +++ /dev/null @@ -1,43 +0,0 @@ -# EmailAttachmentEqualityComparer - -Namespace: Proffer.Email.Internal - -Supports the comparison of [IEmailAttachment](./proffer.email.iemailattachment) for equality. - -```csharp -public class EmailAttachmentEqualityComparer : Proffer.EqualityComparerBase`1[[Proffer.Email.IEmailAttachment, Proffer.Email, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Collections.IEqualityComparer, System.Collections.Generic.IEqualityComparer`1[[Proffer.Email.IEmailAttachment, Proffer.Email, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EqualityComparer<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.equalitycomparer-1) → EqualityComparerBase<IEmailAttachment> → [EmailAttachmentEqualityComparer](./proffer.email.internal.emailattachmentequalitycomparer)
-Implements [IEqualityComparer](https://docs.microsoft.com/en-us/dotnet/api/system.collections.iequalitycomparer), [IEqualityComparer<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.iequalitycomparer-1) - -## Constructors - -### **EmailAttachmentEqualityComparer()** - - - -```csharp -public EmailAttachmentEqualityComparer() -``` - -## Methods - -### **GetEqualityComponents(IEmailAttachment)** - -Gets the object's components that participate in equality comparisons. - -```csharp -protected IEnumerable GetEqualityComponents(IEmailAttachment obj) -``` - -#### Parameters - -`obj` [IEmailAttachment](./proffer.email.iemailattachment)
-The object. - -#### Returns - -[IEnumerable<Object>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
- - An enumerable containing the properties values. diff --git a/docs/code/Email/proffer.email.mockupexceptionsoptions.md b/docs/code/Email/proffer.email.mockupexceptionsoptions.md deleted file mode 100644 index 9f6dff4..0000000 --- a/docs/code/Email/proffer.email.mockupexceptionsoptions.md +++ /dev/null @@ -1,47 +0,0 @@ -# MockupExceptionsOptions - -Namespace: Proffer.Email - -Options to exclude some emails or domains from a mockup configuration. - -```csharp -public class MockupExceptionsOptions -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [MockupExceptionsOptions](./proffer.email.mockupexceptionsoptions) - -## Properties - -### **Emails** - -Gets or sets the emails exclusions. - -```csharp -public List Emails { get; set; } -``` - -#### Property Value - -[List<String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1)
- -### **Domains** - -Gets or sets the domains exclusions. - -```csharp -public List Domains { get; set; } -``` - -#### Property Value - -[List<String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1)
- -## Constructors - -### **MockupExceptionsOptions()** - - - -```csharp -public MockupExceptionsOptions() -``` diff --git a/docs/code/Email/proffer.email.mockupoptions.md b/docs/code/Email/proffer.email.mockupoptions.md deleted file mode 100644 index 6105759..0000000 --- a/docs/code/Email/proffer.email.mockupoptions.md +++ /dev/null @@ -1,59 +0,0 @@ -# MockupOptions - -Namespace: Proffer.Email - -Options to mockup the email sender (all recipients would be redirect to the mockup recipients). - -```csharp -public class MockupOptions -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [MockupOptions](./proffer.email.mockupoptions) - -## Properties - -### **Recipients** - -Gets or sets the mockup recipients. - -```csharp -public List Recipients { get; set; } -``` - -#### Property Value - -[List<String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1)
- -### **Exceptions** - -Gets or sets the exceptions options. - -```csharp -public MockupExceptionsOptions Exceptions { get; set; } -``` - -#### Property Value - -[MockupExceptionsOptions](./proffer.email.mockupexceptionsoptions)
- -### **Disclaimer** - -Gets or sets the disclaimer to add at the end of a mocked up email. - -```csharp -public string Disclaimer { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Constructors - -### **MockupOptions()** - - - -```csharp -public MockupOptions() -``` diff --git a/docs/code/Storage/AzureBlobs/index.md b/docs/code/Storage/AzureBlobs/index.md deleted file mode 100644 index 8795969..0000000 --- a/docs/code/Storage/AzureBlobs/index.md +++ /dev/null @@ -1,31 +0,0 @@ -# Proffer.Storage.Azure.Blobs - -## Proffer.Storage - -[AzureBlobsStorageServiceCollectionExtensions](./proffer.storage.azureblobsstorageservicecollectionextensions) - -## Proffer.Storage.Azure.Blobs - -[AzureBlobsStorageProvider](./proffer.storage.azure.blobs.azureblobsstorageprovider) - -[AzureBlobsStore](./proffer.storage.azure.blobs.azureblobsstore) - -## Proffer.Storage.Azure.Blobs.Configuration - -[AzureBlobsParsedOptions](./proffer.storage.azure.blobs.configuration.azureblobsparsedoptions) - -[AzureBlobsProviderOptions](./proffer.storage.azure.blobs.configuration.azureblobsprovideroptions) - -[AzureBlobsScopedStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions) - -[AzureBlobsStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsstoreoptions) - -## Proffer.Storage.Azure.Blobs.Internal - -[AzureBlobsFileProperties](./proffer.storage.azure.blobs.internal.azureblobsfileproperties) - -[AzureBlobsFileReference](./proffer.storage.azure.blobs.internal.azureblobsfilereference) - -[AzureBlobsListDirectoryWrapper](./proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper) - -[AzureBlobsListFileWrapper](./proffer.storage.azure.blobs.internal.azureblobslistfilewrapper) diff --git a/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.azureblobsstorageprovider.md b/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.azureblobsstorageprovider.md deleted file mode 100644 index ce17d81..0000000 --- a/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.azureblobsstorageprovider.md +++ /dev/null @@ -1,75 +0,0 @@ -# AzureBlobsStorageProvider - -Namespace: Proffer.Storage.Azure.Blobs - -A provider to handle and build file stores pointing on an Azure Storage account. - -```csharp -public class AzureBlobsStorageProvider : Proffer.Storage.Internal.StorageProviderBase`4[[Proffer.Storage.Azure.Blobs.Configuration.AzureBlobsParsedOptions, Proffer.Storage.Azure.Blobs, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[Proffer.Storage.Azure.Blobs.Configuration.AzureBlobsProviderOptions, Proffer.Storage.Azure.Blobs, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[Proffer.Storage.Azure.Blobs.Configuration.AzureBlobsStoreOptions, Proffer.Storage.Azure.Blobs, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[Proffer.Storage.Azure.Blobs.Configuration.AzureBlobsScopedStoreOptions, Proffer.Storage.Azure.Blobs, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Proffer.Storage.IStorageProvider -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → StorageProviderBase<AzureBlobsParsedOptions, AzureBlobsProviderOptions, AzureBlobsStoreOptions, AzureBlobsScopedStoreOptions> → [AzureBlobsStorageProvider](./proffer.storage.azure.blobs.azureblobsstorageprovider)
-Implements IStorageProvider - -## Fields - -### **ProviderName** - -The [AzureBlobsStorageProvider](./proffer.storage.azure.blobs.azureblobsstorageprovider) name. - -```csharp -public static string ProviderName; -``` - -## Properties - -### **Name** - -Gets the name of this provider. - -```csharp -public string Name { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Constructors - -### **AzureBlobsStorageProvider(IOptions<AzureBlobsParsedOptions>)** - -Initializes a new instance of the [AzureBlobsStorageProvider](./proffer.storage.azure.blobs.azureblobsstorageprovider) class. - -```csharp -public AzureBlobsStorageProvider(IOptions options) -``` - -#### Parameters - -`options` IOptions<AzureBlobsParsedOptions>
-The options. - -## Methods - -### **BuildStoreInternal(String, AzureBlobsStoreOptions)** - -Provider-specific build of a store with specific options. - -```csharp -protected IStore BuildStoreInternal(string storeName, AzureBlobsStoreOptions storeOptions) -``` - -#### Parameters - -`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the store. - -`storeOptions` [AzureBlobsStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsstoreoptions)
-The store options. - -#### Returns - -IStore
- - A configured . diff --git a/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.azureblobsstore.md b/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.azureblobsstore.md deleted file mode 100644 index bfb0608..0000000 --- a/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.azureblobsstore.md +++ /dev/null @@ -1,325 +0,0 @@ -# AzureBlobsStore - -Namespace: Proffer.Storage.Azure.Blobs - -An Azure store allows to save, list or read files on a container in its configured [AzureBlobsStorageProvider](./proffer.storage.azure.blobs.azureblobsstorageprovider). - -```csharp -public class AzureBlobsStore : Proffer.Storage.IStore -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [AzureBlobsStore](./proffer.storage.azure.blobs.azureblobsstore)
-Implements IStore - -## Properties - -### **Name** - -Gets the name of the store. - -```csharp -public string Name { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Constructors - -### **AzureBlobsStore(AzureBlobsStoreOptions)** - -Initializes a new instance of the [AzureBlobsStore](./proffer.storage.azure.blobs.azureblobsstore) class. - -```csharp -public AzureBlobsStore(AzureBlobsStoreOptions storeOptions) -``` - -#### Parameters - -`storeOptions` [AzureBlobsStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsstoreoptions)
-The store options. - -## Methods - -### **InitAsync(CancellationToken)** - -Initializes the store by creating a container in its Proffer.Storage.IStorageProvider. - -```csharp -public Task InitAsync(CancellationToken cancellationToken) -``` - -#### Parameters - -`cancellationToken` [CancellationToken](https://docs.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken)
- -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **ListAsync(String, Boolean, Boolean)** - -Lists the files under . - -```csharp -public ValueTask ListAsync(string path, bool recursive, bool withMetadata) -``` - -#### Parameters - -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The path. - -`recursive` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, recurse the listing across folders. - -`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, fetch metadata for each file. - -#### Returns - -ValueTask<IFileReference[]>
- - The list under . - -### **ListAsync(String, String, Boolean, Boolean)** - -Lists the files under matching the . - -```csharp -public ValueTask ListAsync(string path, string searchPattern, bool recursive, bool withMetadata) -``` - -#### Parameters - -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The path. - -`searchPattern` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The search pattern. - -`recursive` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, recurse the listing across folders. - -`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, fetch metadata for each file. - -#### Returns - -ValueTask<IFileReference[]>
- - The list under matching the . - -### **GetAsync(IPrivateFileReference, Boolean)** - -Gets the file reference from path. - -```csharp -public ValueTask GetAsync(IPrivateFileReference file, bool withMetadata) -``` - -#### Parameters - -`file` IPrivateFileReference
-The reference holding the file path. - -`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, fetch metadata for the file. - -#### Returns - -ValueTask<IFileReference>
- - The at path. - -### **GetAsync(Uri, Boolean)** - -Gets the file reference from URI. - -```csharp -public ValueTask GetAsync(Uri uri, bool withMetadata) -``` - -#### Parameters - -`uri` Uri
-The file uniform resource identifier (URI). - -`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, fetch metadata for the file. - -#### Returns - -ValueTask<IFileReference>
- - The at path. - -#### Exceptions - -[InvalidOperationException](https://docs.microsoft.com/en-us/dotnet/api/system.invalidoperationexception)
- -### **DeleteAsync(IPrivateFileReference)** - -Deletes the file. - -```csharp -public Task DeleteAsync(IPrivateFileReference file) -``` - -#### Parameters - -`file` IPrivateFileReference
-The reference holding the file path. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- -### **ReadAsync(IPrivateFileReference)** - -Reads the file content. - -```csharp -public ValueTask ReadAsync(IPrivateFileReference file) -``` - -#### Parameters - -`file` IPrivateFileReference
-The reference holding the file path. - -#### Returns - -ValueTask<Stream>
- - A containing the file content. - -### **ReadAllBytesAsync(IPrivateFileReference)** - -Reads the file content. - -```csharp -public ValueTask ReadAllBytesAsync(IPrivateFileReference file) -``` - -#### Parameters - -`file` IPrivateFileReference
-The reference holding the file path. - -#### Returns - -ValueTask<Byte[]>
- - A containing the file content. - -### **ReadAllTextAsync(IPrivateFileReference)** - -Reads the file content. - -```csharp -public ValueTask ReadAllTextAsync(IPrivateFileReference file) -``` - -#### Parameters - -`file` IPrivateFileReference
-The reference holding the file path. - -#### Returns - -ValueTask<String>
- - A containing the file content. - -### **SaveAsync(Byte[], IPrivateFileReference, String, OverwritePolicy, IDictionary<String, String>)** - -Saves the file. - -```csharp -public ValueTask SaveAsync(Byte[] data, IPrivateFileReference file, string contentType, OverwritePolicy overwritePolicy, IDictionary metadata) -``` - -#### Parameters - -`data` [Byte[]](https://docs.microsoft.com/en-us/dotnet/api/system.byte)
-The file content. - -`file` IPrivateFileReference
-The reference holding the file path. - -`contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The content-type of the file. - -`overwritePolicy` OverwritePolicy
-The overwrite policy. - -`metadata` [IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
-The metadata. - -#### Returns - -ValueTask<IFileReference>
- - The saved . - -#### Exceptions - -Proffer.Storage.Exceptions.FileAlreadyExistsException
- -### **SaveAsync(Stream, IPrivateFileReference, String, OverwritePolicy, IDictionary<String, String>)** - -Saves the file. - -```csharp -public ValueTask SaveAsync(Stream data, IPrivateFileReference file, string contentType, OverwritePolicy overwritePolicy, IDictionary metadata) -``` - -#### Parameters - -`data` [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream)
-The file content. - -`file` IPrivateFileReference
-The reference holding the file path. - -`contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The content-type of the file. - -`overwritePolicy` OverwritePolicy
-The overwrite policy. - -`metadata` [IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
-The metadata. - -#### Returns - -ValueTask<IFileReference>
- - The saved . - -#### Exceptions - -Proffer.Storage.Exceptions.FileAlreadyExistsException
- -### **GetSharedAccessSignatureAsync(ISharedAccessPolicy)** - -Gets a shared access signature. - -```csharp -public ValueTask GetSharedAccessSignatureAsync(ISharedAccessPolicy policy) -``` - -#### Parameters - -`policy` ISharedAccessPolicy
-The policy. - -#### Returns - -ValueTask<String>
- - A shared access signature to read or list the store files. diff --git a/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md b/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md deleted file mode 100644 index 96966de..0000000 --- a/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md +++ /dev/null @@ -1,123 +0,0 @@ -# AzureBlobsParsedOptions - -Namespace: Proffer.Storage.Azure.Blobs.Configuration - -Typed Azure Blobs options parsed from the dynamic configuration. - -```csharp -public class AzureBlobsParsedOptions : Proffer.Storage.Configuration.IParsedOptions`3[[Proffer.Storage.Azure.Blobs.Configuration.AzureBlobsProviderOptions, Proffer.Storage.Azure.Blobs, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[Proffer.Storage.Azure.Blobs.Configuration.AzureBlobsStoreOptions, Proffer.Storage.Azure.Blobs, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[Proffer.Storage.Azure.Blobs.Configuration.AzureBlobsScopedStoreOptions, Proffer.Storage.Azure.Blobs, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [AzureBlobsParsedOptions](./proffer.storage.azure.blobs.configuration.azureblobsparsedoptions)
-Implements IParsedOptions<AzureBlobsProviderOptions, AzureBlobsStoreOptions, AzureBlobsScopedStoreOptions> - -## Properties - -### **Name** - -Gets the name. - -```csharp -public string Name { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ConnectionStrings** - -Gets or sets the connection strings. - -```csharp -public IReadOnlyDictionary ConnectionStrings { get; set; } -``` - -#### Property Value - -[IReadOnlyDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
- -### **ParsedProviders** - -Gets or sets the parsed provider instances options. - -```csharp -public IReadOnlyDictionary ParsedProviders { get; set; } -``` - -#### Property Value - -[IReadOnlyDictionary<String, AzureBlobsProviderOptions>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
- -### **ParsedStores** - -Gets or sets the parsed stores options. - -```csharp -public IReadOnlyDictionary ParsedStores { get; set; } -``` - -#### Property Value - -[IReadOnlyDictionary<String, AzureBlobsStoreOptions>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
- -### **ParsedScopedStores** - -Gets or sets the parsed scoped stores options. - -```csharp -public IReadOnlyDictionary ParsedScopedStores { get; set; } -``` - -#### Property Value - -[IReadOnlyDictionary<String, AzureBlobsScopedStoreOptions>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
- -## Constructors - -### **AzureBlobsParsedOptions()** - - - -```csharp -public AzureBlobsParsedOptions() -``` - -## Methods - -### **BindProviderOptions(AzureBlobsProviderOptions)** - -Binds the provider instance options. - -```csharp -public void BindProviderOptions(AzureBlobsProviderOptions providerInstanceOptions) -``` - -#### Parameters - -`providerInstanceOptions` [AzureBlobsProviderOptions](./proffer.storage.azure.blobs.configuration.azureblobsprovideroptions)
-The provider instance options. - -#### Exceptions - -Proffer.Storage.Exceptions.BadProviderConfiguration
- -### **BindStoreOptions(AzureBlobsStoreOptions, AzureBlobsProviderOptions)** - -Binds the store options. - -```csharp -public void BindStoreOptions(AzureBlobsStoreOptions storeOptions, AzureBlobsProviderOptions providerInstanceOptions) -``` - -#### Parameters - -`storeOptions` [AzureBlobsStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsstoreoptions)
-The store options. - -`providerInstanceOptions` [AzureBlobsProviderOptions](./proffer.storage.azure.blobs.configuration.azureblobsprovideroptions)
-The provider instance options. - -#### Exceptions - -Proffer.Storage.Exceptions.BadStoreConfiguration
diff --git a/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md b/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md deleted file mode 100644 index cbc0fe8..0000000 --- a/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md +++ /dev/null @@ -1,72 +0,0 @@ -# AzureBlobsProviderOptions - -Namespace: Proffer.Storage.Azure.Blobs.Configuration - -Options for an [AzureBlobsStorageProvider](./proffer.storage.azure.blobs.azureblobsstorageprovider). - -```csharp -public class AzureBlobsProviderOptions : Proffer.Configuration.ProviderOptions, Proffer.Configuration.IProviderOptions, Proffer.Configuration.INamedElementOptions, Proffer.Azure.Configuration.IAzureStorageOptions -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → ProviderOptions → [AzureBlobsProviderOptions](./proffer.storage.azure.blobs.configuration.azureblobsprovideroptions)
-Implements IProviderOptions, INamedElementOptions, IAzureStorageOptions - -## Properties - -### **ConnectionString** - -Gets or sets the connection string. - -```csharp -public string ConnectionString { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ConnectionStringName** - -Gets or sets the name of the connection string to reference. - -```csharp -public string ConnectionStringName { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Name** - - - -```csharp -public string Name { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Type** - - - -```csharp -public string Type { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Constructors - -### **AzureBlobsProviderOptions()** - - - -```csharp -public AzureBlobsProviderOptions() -``` diff --git a/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md b/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md deleted file mode 100644 index 541da5e..0000000 --- a/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md +++ /dev/null @@ -1,120 +0,0 @@ -# AzureBlobsScopedStoreOptions - -Namespace: Proffer.Storage.Azure.Blobs.Configuration - -Options for a scoped [AzureBlobsStore](./proffer.storage.azure.blobs.azureblobsstore). - -```csharp -public class AzureBlobsScopedStoreOptions : AzureBlobsStoreOptions, Proffer.Storage.Configuration.IStoreOptions, Proffer.Configuration.INamedElementOptions, Proffer.Azure.Configuration.IAzureStorageOptions, Proffer.Storage.Configuration.IScopedStoreOptions -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → StoreOptions → [AzureBlobsStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsstoreoptions) → [AzureBlobsScopedStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions)
-Implements IStoreOptions, INamedElementOptions, IAzureStorageOptions, IScopedStoreOptions - -## Properties - -### **FolderNameFormat** - -Gets the folder name format. - -```csharp -public string FolderNameFormat { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ConnectionString** - -Gets or sets the connection string. - -```csharp -public string ConnectionString { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ConnectionStringName** - -Gets or sets the name of the connection string to reference. - -```csharp -public string ConnectionStringName { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Name** - - - -```csharp -public string Name { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ProviderName** - - - -```csharp -public string ProviderName { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ProviderType** - - - -```csharp -public string ProviderType { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **AccessLevel** - - - -```csharp -public AccessLevel AccessLevel { get; set; } -``` - -#### Property Value - -AccessLevel
- -### **FolderName** - - - -```csharp -public string FolderName { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Constructors - -### **AzureBlobsScopedStoreOptions()** - - - -```csharp -public AzureBlobsScopedStoreOptions() -``` diff --git a/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md b/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md deleted file mode 100644 index 3231659..0000000 --- a/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md +++ /dev/null @@ -1,133 +0,0 @@ -# AzureBlobsStoreOptions - -Namespace: Proffer.Storage.Azure.Blobs.Configuration - -Options for an [AzureBlobsStore](./proffer.storage.azure.blobs.azureblobsstore). - -```csharp -public class AzureBlobsStoreOptions : Proffer.Storage.Configuration.StoreOptions, Proffer.Storage.Configuration.IStoreOptions, Proffer.Configuration.INamedElementOptions, Proffer.Azure.Configuration.IAzureStorageOptions -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → StoreOptions → [AzureBlobsStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsstoreoptions)
-Implements IStoreOptions, INamedElementOptions, IAzureStorageOptions - -## Properties - -### **ConnectionString** - -Gets or sets the connection string. - -```csharp -public string ConnectionString { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ConnectionStringName** - -Gets or sets the name of the connection string to reference. - -```csharp -public string ConnectionStringName { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Name** - - - -```csharp -public string Name { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ProviderName** - - - -```csharp -public string ProviderName { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ProviderType** - - - -```csharp -public string ProviderType { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **AccessLevel** - - - -```csharp -public AccessLevel AccessLevel { get; set; } -``` - -#### Property Value - -AccessLevel
- -### **FolderName** - - - -```csharp -public string FolderName { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Constructors - -### **AzureBlobsStoreOptions()** - - - -```csharp -public AzureBlobsStoreOptions() -``` - -## Methods - -### **Validate(Boolean)** - -Validates the options. - -```csharp -public IEnumerable Validate(bool throwOnError) -``` - -#### Parameters - -`throwOnError` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, throws an exception when the validation fails with any . - -#### Returns - -[IEnumerable<IOptionError>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
- - The returned by the validation, if any. - -#### Exceptions - -Proffer.Storage.Exceptions.BadStoreConfiguration
diff --git a/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md b/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md deleted file mode 100644 index c1062e7..0000000 --- a/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md +++ /dev/null @@ -1,146 +0,0 @@ -# AzureBlobsFileProperties - -Namespace: Proffer.Storage.Azure.Blobs.Internal - -File common properties with metadata stored on Azure Blobs. - -```csharp -public class AzureBlobsFileProperties : Proffer.Storage.IFileProperties -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [AzureBlobsFileProperties](./proffer.storage.azure.blobs.internal.azureblobsfileproperties)
-Implements IFileProperties - -## Properties - -### **LastModified** - -Gets the last modified time. - -```csharp -public Nullable LastModified { get; private set; } -``` - -#### Property Value - -[Nullable<DateTimeOffset>](https://docs.microsoft.com/en-us/dotnet/api/system.nullable-1)
- -### **Length** - -Gets the length of the content. - -```csharp -public long Length { get; private set; } -``` - -#### Property Value - -[Int64](https://docs.microsoft.com/en-us/dotnet/api/system.int64)
- -### **ContentType** - -Gets or sets the content-type. - -```csharp -public string ContentType { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ETag** - -Gets the etag. - -```csharp -public string ETag { get; private set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **CacheControl** - -Gets or sets the cache control. - -```csharp -public string CacheControl { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ContentMD5** - -Gets the MD5 digest of the content. - -```csharp -public string ContentMD5 { get; private set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Metadata** - -Gets the metadata. - -```csharp -public IDictionary Metadata { get; } -``` - -#### Property Value - -[IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
- -## Constructors - -### **AzureBlobsFileProperties(BlobClient, BlobProperties)** - -Initializes a new instance of the [AzureBlobsFileProperties](./proffer.storage.azure.blobs.internal.azureblobsfileproperties) class. - -```csharp -public AzureBlobsFileProperties(BlobClient blobClient, BlobProperties blobProperties) -``` - -#### Parameters - -`blobClient` BlobClient
-The Azure Blobs client. - -`blobProperties` BlobProperties
-The blob properties. - -### **AzureBlobsFileProperties(BlobClient, BlobItem)** - -Initializes a new instance of the [AzureBlobsFileProperties](./proffer.storage.azure.blobs.internal.azureblobsfileproperties) class. - -```csharp -public AzureBlobsFileProperties(BlobClient blobClient, BlobItem blobItem) -``` - -#### Parameters - -`blobClient` BlobClient
-The Azure Blobs client. - -`blobItem` BlobItem
-The blob item from listing. - -## Methods - -### **SaveAsync()** - - - -```csharp -internal Task SaveAsync() -``` - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
diff --git a/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.internal.azureblobsfilereference.md b/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.internal.azureblobsfilereference.md deleted file mode 100644 index 49155ce..0000000 --- a/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.internal.azureblobsfilereference.md +++ /dev/null @@ -1,221 +0,0 @@ -# AzureBlobsFileReference - -Namespace: Proffer.Storage.Azure.Blobs.Internal - -A reference of a stored file at a given path on Azure Blobs. - -```csharp -public class AzureBlobsFileReference : Proffer.Storage.IFileReference, Proffer.Storage.IPrivateFileReference -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [AzureBlobsFileReference](./proffer.storage.azure.blobs.internal.azureblobsfilereference)
-Implements IFileReference, IPrivateFileReference - -## Properties - -### **Path** - -Gets the file path. - -```csharp -public string Path { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Properties** - -Gets the properties. - -```csharp -public IFileProperties Properties { get; } -``` - -#### Property Value - -IFileProperties
- -### **PublicUrl** - -Gets the public URL. - -```csharp -public string PublicUrl { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Constructors - -### **AzureBlobsFileReference(BlobClient, AzureBlobsFileProperties)** - -Initializes a new instance of the [AzureBlobsFileReference](./proffer.storage.azure.blobs.internal.azureblobsfilereference) class. - -```csharp -public AzureBlobsFileReference(BlobClient blobClient, AzureBlobsFileProperties properties) -``` - -#### Parameters - -`blobClient` BlobClient
-The Azure Blobs client. - -`properties` [AzureBlobsFileProperties](./proffer.storage.azure.blobs.internal.azureblobsfileproperties)
-The properties, if fetched. - -## Methods - -### **DeleteAsync()** - -Deletes the file. - -```csharp -public Task DeleteAsync() -``` - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **ReadAsync()** - -Reads the file content. - -```csharp -public ValueTask ReadAsync() -``` - -#### Returns - -ValueTask<Stream>
- - A containing the file content. - -### **ReadInMemoryAsync()** - -Reads the file content in memory. - -```csharp -public ValueTask ReadInMemoryAsync() -``` - -#### Returns - -ValueTask<MemoryStream>
-A new containing the file content. - -### **UpdateAsync(Stream)** - -Updates the file content with the given [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream). - -```csharp -public Task UpdateAsync(Stream stream) -``` - -#### Parameters - -`stream` [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream)
-The new file content. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **ReadToStreamAsync(Stream)** - -Reads the file content into the given stream. - -```csharp -public Task ReadToStreamAsync(Stream targetStream) -``` - -#### Parameters - -`targetStream` [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream)
-The target stream. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- -### **ReadAllTextAsync()** - -Reads the file content. - -```csharp -public ValueTask ReadAllTextAsync() -``` - -#### Returns - -ValueTask<String>
- - A containing the file content. - -### **ReadAllBytesAsync()** - -Reads the file content. - -```csharp -public ValueTask ReadAllBytesAsync() -``` - -#### Returns - -ValueTask<Byte[]>
- - A containing the file content. - -### **SavePropertiesAsync()** - -Saves the file properties. - -```csharp -public Task SavePropertiesAsync() -``` - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **GetSharedAccessSignature(ISharedAccessPolicy)** - -Gets a shared access signature. - -```csharp -public ValueTask GetSharedAccessSignature(ISharedAccessPolicy policy) -``` - -#### Parameters - -`policy` ISharedAccessPolicy
-The policy. - -#### Returns - -ValueTask<String>
- - A shared access signature to read file. - -### **FetchProperties()** - -Fetches the file properties. - -```csharp -public Task FetchProperties() -``` - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
-A task that represents the asynchronous operation. diff --git a/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md b/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md deleted file mode 100644 index 3a6aebc..0000000 --- a/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md +++ /dev/null @@ -1,138 +0,0 @@ -# AzureBlobsListDirectoryWrapper - -Namespace: Proffer.Storage.Azure.Blobs.Internal - -Represents a directory in a being-listed [AzureBlobsStore](./proffer.storage.azure.blobs.azureblobsstore). - -```csharp -public class AzureBlobsListDirectoryWrapper : Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → FileSystemInfoBase → DirectoryInfoBase → [AzureBlobsListDirectoryWrapper](./proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper) - -## Properties - -### **FullName** - -A string containing the full path of the directory. - -```csharp -public string FullName { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Name** - -A string containing the name of the directory. - -```csharp -public string Name { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ParentDirectory** - -The parent directory for the current directory. - -```csharp -public DirectoryInfoBase ParentDirectory { get; } -``` - -#### Property Value - -DirectoryInfoBase
- -## Constructors - -### **AzureBlobsListDirectoryWrapper(FileSystemInfoBase)** - -Initializes a new instance of the [AzureBlobsListDirectoryWrapper](./proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper) class. - -```csharp -public AzureBlobsListDirectoryWrapper(FileSystemInfoBase childrens) -``` - -#### Parameters - -`childrens` FileSystemInfoBase
-The childrens. - -### **AzureBlobsListDirectoryWrapper(String, Dictionary<String, AzureBlobsFileReference>)** - -Initializes a new instance of the [AzureBlobsListDirectoryWrapper](./proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper) class. - -```csharp -public AzureBlobsListDirectoryWrapper(string path, Dictionary files) -``` - -#### Parameters - -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The directory path. - -`files` [Dictionary<String, AzureBlobsFileReference>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.dictionary-2)
-The files. - -## Methods - -### **EnumerateFileSystemInfos()** - -Enumerates all files and directories in the directory. - -```csharp -public IEnumerable EnumerateFileSystemInfos() -``` - -#### Returns - -[IEnumerable<FileSystemInfoBase>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
- - Collection of files and directories - -### **GetDirectory(String)** - -Returns an instance of Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase that represents a subdirectory. - -```csharp -public DirectoryInfoBase GetDirectory(string path) -``` - -#### Parameters - -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The directory name - -#### Returns - -DirectoryInfoBase
- - Instance of even if directory does not exist - -#### Exceptions - -[NotImplementedException](https://docs.microsoft.com/en-us/dotnet/api/system.notimplementedexception)
- -### **GetFile(String)** - -Returns an instance of Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoBase that represents a file in the directory. - -```csharp -public FileInfoBase GetFile(string path) -``` - -#### Parameters - -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The file name - -#### Returns - -FileInfoBase
- - Instance of even if file does not exist diff --git a/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md b/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md deleted file mode 100644 index cb8da1a..0000000 --- a/docs/code/Storage/AzureBlobs/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md +++ /dev/null @@ -1,67 +0,0 @@ -# AzureBlobsListFileWrapper - -Namespace: Proffer.Storage.Azure.Blobs.Internal - -Represents a file in a being-listed [AzureBlobsStore](./proffer.storage.azure.blobs.azureblobsstore). - -```csharp -public class AzureBlobsListFileWrapper : Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoBase -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → FileSystemInfoBase → FileInfoBase → [AzureBlobsListFileWrapper](./proffer.storage.azure.blobs.internal.azureblobslistfilewrapper) - -## Properties - -### **FullName** - -A string containing the full path of the file. - -```csharp -public string FullName { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Name** - -A string containing the name of the file. - -```csharp -public string Name { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ParentDirectory** - -The parent directory for the current file. - -```csharp -public DirectoryInfoBase ParentDirectory { get; } -``` - -#### Property Value - -DirectoryInfoBase
- -## Constructors - -### **AzureBlobsListFileWrapper(AzureBlobsFileReference, AzureBlobsListDirectoryWrapper)** - -Initializes a new instance of the [AzureBlobsListFileWrapper](./proffer.storage.azure.blobs.internal.azureblobslistfilewrapper) class. - -```csharp -public AzureBlobsListFileWrapper(AzureBlobsFileReference file, AzureBlobsListDirectoryWrapper parent) -``` - -#### Parameters - -`file` [AzureBlobsFileReference](./proffer.storage.azure.blobs.internal.azureblobsfilereference)
-The file reference. - -`parent` [AzureBlobsListDirectoryWrapper](./proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper)
-The parent directory. diff --git a/docs/code/Storage/AzureBlobs/proffer.storage.azureblobsstorageservicecollectionextensions.md b/docs/code/Storage/AzureBlobs/proffer.storage.azureblobsstorageservicecollectionextensions.md deleted file mode 100644 index 987bd9b..0000000 --- a/docs/code/Storage/AzureBlobs/proffer.storage.azureblobsstorageservicecollectionextensions.md +++ /dev/null @@ -1,31 +0,0 @@ -# AzureBlobsStorageServiceCollectionExtensions - -Namespace: Proffer.Storage - -Microsoft.Extensions.DependencyInjection.IServiceCollection extension methods. - -```csharp -public static class AzureBlobsStorageServiceCollectionExtensions -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [AzureBlobsStorageServiceCollectionExtensions](./proffer.storage.azureblobsstorageservicecollectionextensions) - -## Methods - -### **AddAzureStorage(IServiceCollection)** - -Registers the Proffer.Storage services to Azure Blobs. - -```csharp -public static IServiceCollection AddAzureStorage(IServiceCollection services) -``` - -#### Parameters - -`services` IServiceCollection
-The service collection. - -#### Returns - -IServiceCollection
-The service collection. diff --git a/docs/code/Storage/FileSystem/Properties/Json/index.md b/docs/code/Storage/FileSystem/Properties/Json/index.md deleted file mode 100644 index 740780c..0000000 --- a/docs/code/Storage/FileSystem/Properties/Json/index.md +++ /dev/null @@ -1,13 +0,0 @@ -# Proffer.Storage.FileSystem.Properties.Json - -## Proffer.Storage - -[FileSystemPropertiesJsonServiceCollectionExtensions](./proffer.storage.filesystempropertiesjsonservicecollectionextensions) - -## Proffer.Storage.FileSystem.Properties.Json - -[FileSystemPropertiesJsonOptions](./proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions) - -## Proffer.Storage.FileSystem.Properties.Json.Internal - -[ExtendedPropertiesProvider](./proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider) diff --git a/docs/code/Storage/FileSystem/Properties/Json/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md b/docs/code/Storage/FileSystem/Properties/Json/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md deleted file mode 100644 index b0c4fb4..0000000 --- a/docs/code/Storage/FileSystem/Properties/Json/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md +++ /dev/null @@ -1,35 +0,0 @@ -# FileSystemPropertiesJsonOptions - -Namespace: Proffer.Storage.FileSystem.Properties.Json - -Options for an [ExtendedPropertiesProvider](./proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider). - -```csharp -public class FileSystemPropertiesJsonOptions -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemPropertiesJsonOptions](./proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions) - -## Properties - -### **FolderNameFormat** - -Gets or sets the folder name format. - -```csharp -public string FolderNameFormat { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Constructors - -### **FileSystemPropertiesJsonOptions()** - - - -```csharp -public FileSystemPropertiesJsonOptions() -``` diff --git a/docs/code/Storage/FileSystem/Server/index.md b/docs/code/Storage/FileSystem/Server/index.md deleted file mode 100644 index e005d4b..0000000 --- a/docs/code/Storage/FileSystem/Server/index.md +++ /dev/null @@ -1,15 +0,0 @@ -# Proffer.Storage.FileSystem.Server - -## Proffer.Storage - -[ServiceCollectionExtensions](./proffer.storage.servicecollectionextensions) - -## Proffer.Storage.FileSystem.Server - -[FileSystemStorageServerMiddleware](./proffer.storage.filesystem.server.filesystemstorageservermiddleware) - -[FileSystemStorageServerOptions](./proffer.storage.filesystem.server.filesystemstorageserveroptions) - -## Proffer.Storage.FileSystem.Server.Internal - -[PublicUrlProvider](./proffer.storage.filesystem.server.internal.publicurlprovider) diff --git a/docs/code/Storage/FileSystem/Server/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md b/docs/code/Storage/FileSystem/Server/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md deleted file mode 100644 index e093922..0000000 --- a/docs/code/Storage/FileSystem/Server/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md +++ /dev/null @@ -1,54 +0,0 @@ -# FileSystemStorageServerMiddleware - -Namespace: Proffer.Storage.FileSystem.Server - -ASP.NET Core middleware to serve over HTTP files stored in a Storage store. - -```csharp -public class FileSystemStorageServerMiddleware -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemStorageServerMiddleware](./proffer.storage.filesystem.server.filesystemstorageservermiddleware) - -## Constructors - -### **FileSystemStorageServerMiddleware(RequestDelegate, IOptions<FileSystemStorageServerOptions>, ILogger<FileSystemStorageServerMiddleware>, IOptions<FileSystemParsedOptions>)** - -Initializes a new instance of the [FileSystemStorageServerMiddleware](./proffer.storage.filesystem.server.filesystemstorageservermiddleware) class. - -```csharp -public FileSystemStorageServerMiddleware(RequestDelegate next, IOptions serverOptions, ILogger logger, IOptions fileSystemParsedOptions) -``` - -#### Parameters - -`next` RequestDelegate
-The next function. - -`serverOptions` IOptions<FileSystemStorageServerOptions>
-The server options. - -`logger` ILogger<FileSystemStorageServerMiddleware>
-The logger. - -`fileSystemParsedOptions` IOptions<FileSystemParsedOptions>
-The file system parsed options. - -## Methods - -### **Invoke(HttpContext)** - -Invokes the middleware. - -```csharp -public Task Invoke(HttpContext context) -``` - -#### Parameters - -`context` HttpContext
-The context. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
diff --git a/docs/code/Storage/FileSystem/Server/proffer.storage.filesystem.server.filesystemstorageserveroptions.md b/docs/code/Storage/FileSystem/Server/proffer.storage.filesystem.server.filesystemstorageserveroptions.md deleted file mode 100644 index f899ee7..0000000 --- a/docs/code/Storage/FileSystem/Server/proffer.storage.filesystem.server.filesystemstorageserveroptions.md +++ /dev/null @@ -1,59 +0,0 @@ -# FileSystemStorageServerOptions - -Namespace: Proffer.Storage.FileSystem.Server - -Options for a [FileSystemStorageServerMiddleware](./proffer.storage.filesystem.server.filesystemstorageservermiddleware). - -```csharp -public class FileSystemStorageServerOptions -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemStorageServerOptions](./proffer.storage.filesystem.server.filesystemstorageserveroptions) - -## Properties - -### **BaseUri** - -Gets or sets the base URI. - -```csharp -public Uri BaseUri { get; set; } -``` - -#### Property Value - -Uri
- -### **EndpointPath** - -Gets or sets the endpoint path. - -```csharp -public PathString EndpointPath { get; set; } -``` - -#### Property Value - -PathString
- -### **SigningKey** - -Gets or sets the signing key. - -```csharp -public Byte[] SigningKey { get; set; } -``` - -#### Property Value - -[Byte[]](https://docs.microsoft.com/en-us/dotnet/api/system.byte)
- -## Constructors - -### **FileSystemStorageServerOptions()** - - - -```csharp -public FileSystemStorageServerOptions() -``` diff --git a/docs/code/Storage/FileSystem/Server/proffer.storage.filesystem.server.internal.publicurlprovider.md b/docs/code/Storage/FileSystem/Server/proffer.storage.filesystem.server.internal.publicurlprovider.md deleted file mode 100644 index 377e013..0000000 --- a/docs/code/Storage/FileSystem/Server/proffer.storage.filesystem.server.internal.publicurlprovider.md +++ /dev/null @@ -1,51 +0,0 @@ -# PublicUrlProvider - -Namespace: Proffer.Storage.FileSystem.Server.Internal - -Provides a way to serve files from an HTTP URL on a File System using an ASP.NET middleware. - -```csharp -public class PublicUrlProvider : Proffer.Storage.FileSystem.IPublicUrlProvider -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [PublicUrlProvider](./proffer.storage.filesystem.server.internal.publicurlprovider)
-Implements IPublicUrlProvider - -## Constructors - -### **PublicUrlProvider(IOptions<FileSystemStorageServerOptions>)** - -Initializes a new instance of the [PublicUrlProvider](./proffer.storage.filesystem.server.internal.publicurlprovider) class. - -```csharp -public PublicUrlProvider(IOptions options) -``` - -#### Parameters - -`options` IOptions<FileSystemStorageServerOptions>
-The options. - -## Methods - -### **GetPublicUrl(String, FileSystemFileReference)** - -Gets the public URL of a file reference. - -```csharp -public string GetPublicUrl(string storeName, FileSystemFileReference file) -``` - -#### Parameters - -`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the store. - -`file` FileSystemFileReference
-The reference holding the file path. - -#### Returns - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- - The public URL. diff --git a/docs/code/Storage/FileSystem/Server/proffer.storage.servicecollectionextensions.md b/docs/code/Storage/FileSystem/Server/proffer.storage.servicecollectionextensions.md deleted file mode 100644 index 8809932..0000000 --- a/docs/code/Storage/FileSystem/Server/proffer.storage.servicecollectionextensions.md +++ /dev/null @@ -1,52 +0,0 @@ -# ServiceCollectionExtensions - -Namespace: Proffer.Storage - -Microsoft.Extensions.DependencyInjection.IServiceCollection extension methods. - -```csharp -public static class ServiceCollectionExtensions -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ServiceCollectionExtensions](./proffer.storage.servicecollectionextensions) - -## Methods - -### **AddFileSystemStorageServer(IServiceCollection, Action<FileSystemStorageServerOptions>)** - -Adds a File System provider Storage Server, serving files over HTTP. - -```csharp -public static IServiceCollection AddFileSystemStorageServer(IServiceCollection services, Action configure) -``` - -#### Parameters - -`services` IServiceCollection
-The service collection. - -`configure` [Action<FileSystemStorageServerOptions>](https://docs.microsoft.com/en-us/dotnet/api/system.action-1)
-The action to configure options. - -#### Returns - -IServiceCollection
-The service collection. - -### **UseFileSystemStorageServer(IApplicationBuilder)** - -Adds a [FileSystemStorageServerMiddleware](./proffer.storage.filesystem.server.filesystemstorageservermiddleware) to the application's request pipeline. - -```csharp -public static IApplicationBuilder UseFileSystemStorageServer(IApplicationBuilder app) -``` - -#### Parameters - -`app` IApplicationBuilder
-The application builder. - -#### Returns - -IApplicationBuilder
-The application builder. diff --git a/docs/code/Storage/FileSystem/index.md b/docs/code/Storage/FileSystem/index.md deleted file mode 100644 index 343ef6e..0000000 --- a/docs/code/Storage/FileSystem/index.md +++ /dev/null @@ -1,35 +0,0 @@ -# Proffer.Storage.FileSystem - -## Proffer.Storage - -[FileSystemStorageServiceCollectionExtensions](./proffer.storage.filesystemstorageservicecollectionextensions) - -## Proffer.Storage.FileSystem - -[FileSystemStorageProvider](./proffer.storage.filesystem.filesystemstorageprovider) - -[FileSystemStore](./proffer.storage.filesystem.filesystemstore) - -[IExtendedPropertiesProvider](./proffer.storage.filesystem.iextendedpropertiesprovider) - -[IPublicUrlProvider](./proffer.storage.filesystem.ipublicurlprovider) - -[NoExtendedPropertiesProvider](./proffer.storage.filesystem.noextendedpropertiesprovider) - -## Proffer.Storage.FileSystem.Configuration - -[FileSystemParsedOptions](./proffer.storage.filesystem.configuration.filesystemparsedoptions) - -[FileSystemProviderOptions](./proffer.storage.filesystem.configuration.filesystemprovideroptions) - -[FileSystemScopedStoreOptions](./proffer.storage.filesystem.configuration.filesystemscopedstoreoptions) - -[FileSystemStoreOptions](./proffer.storage.filesystem.configuration.filesystemstoreoptions) - -## Proffer.Storage.FileSystem.Internal - -[FileExtendedProperties](./proffer.storage.filesystem.internal.fileextendedproperties) - -[FileSystemFileProperties](./proffer.storage.filesystem.internal.filesystemfileproperties) - -[FileSystemFileReference](./proffer.storage.filesystem.internal.filesystemfilereference) diff --git a/docs/code/Storage/FileSystem/proffer.storage.filesystem.configuration.filesystemparsedoptions.md b/docs/code/Storage/FileSystem/proffer.storage.filesystem.configuration.filesystemparsedoptions.md deleted file mode 100644 index 0ad05b8..0000000 --- a/docs/code/Storage/FileSystem/proffer.storage.filesystem.configuration.filesystemparsedoptions.md +++ /dev/null @@ -1,127 +0,0 @@ -# FileSystemParsedOptions - -Namespace: Proffer.Storage.FileSystem.Configuration - -Typed File System options parsed from the dynamic configuration. - -```csharp -public class FileSystemParsedOptions : Proffer.Storage.Configuration.IParsedOptions`3[[Proffer.Storage.FileSystem.Configuration.FileSystemProviderOptions, Proffer.Storage.FileSystem, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[Proffer.Storage.FileSystem.Configuration.FileSystemStoreOptions, Proffer.Storage.FileSystem, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[Proffer.Storage.FileSystem.Configuration.FileSystemScopedStoreOptions, Proffer.Storage.FileSystem, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemParsedOptions](./proffer.storage.filesystem.configuration.filesystemparsedoptions)
-Implements IParsedOptions<FileSystemProviderOptions, FileSystemStoreOptions, FileSystemScopedStoreOptions> - -## Properties - -### **Name** - -Gets the name. - -```csharp -public string Name { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ConnectionStrings** - -Gets or sets the connection strings. - -```csharp -public IReadOnlyDictionary ConnectionStrings { get; set; } -``` - -#### Property Value - -[IReadOnlyDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
- -### **ParsedProviders** - -Gets or sets the parsed provider instances options. - -```csharp -public IReadOnlyDictionary ParsedProviders { get; set; } -``` - -#### Property Value - -[IReadOnlyDictionary<String, FileSystemProviderOptions>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
- -### **ParsedStores** - -Gets or sets the parsed stores options. - -```csharp -public IReadOnlyDictionary ParsedStores { get; set; } -``` - -#### Property Value - -[IReadOnlyDictionary<String, FileSystemStoreOptions>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
- -### **ParsedScopedStores** - -Gets or sets the parsed scoped stores options. - -```csharp -public IReadOnlyDictionary ParsedScopedStores { get; set; } -``` - -#### Property Value - -[IReadOnlyDictionary<String, FileSystemScopedStoreOptions>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
- -### **RootPath** - -Gets or sets the root path. - -```csharp -public string RootPath { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Constructors - -### **FileSystemParsedOptions()** - - - -```csharp -public FileSystemParsedOptions() -``` - -## Methods - -### **BindProviderOptions(FileSystemProviderOptions)** - -Binds the provider instance options. - -```csharp -public void BindProviderOptions(FileSystemProviderOptions providerInstanceOptions) -``` - -#### Parameters - -`providerInstanceOptions` [FileSystemProviderOptions](./proffer.storage.filesystem.configuration.filesystemprovideroptions)
-The provider instance options. - -### **BindStoreOptions(FileSystemStoreOptions, FileSystemProviderOptions)** - -Binds the store options. - -```csharp -public void BindStoreOptions(FileSystemStoreOptions storeOptions, FileSystemProviderOptions providerInstanceOptions) -``` - -#### Parameters - -`storeOptions` [FileSystemStoreOptions](./proffer.storage.filesystem.configuration.filesystemstoreoptions)
-The store options. - -`providerInstanceOptions` [FileSystemProviderOptions](./proffer.storage.filesystem.configuration.filesystemprovideroptions)
-The provider instance options. diff --git a/docs/code/Storage/FileSystem/proffer.storage.filesystem.configuration.filesystemprovideroptions.md b/docs/code/Storage/FileSystem/proffer.storage.filesystem.configuration.filesystemprovideroptions.md deleted file mode 100644 index afefdcd..0000000 --- a/docs/code/Storage/FileSystem/proffer.storage.filesystem.configuration.filesystemprovideroptions.md +++ /dev/null @@ -1,60 +0,0 @@ -# FileSystemProviderOptions - -Namespace: Proffer.Storage.FileSystem.Configuration - -Options for a [FileSystemStorageProvider](./proffer.storage.filesystem.filesystemstorageprovider). - -```csharp -public class FileSystemProviderOptions : Proffer.Configuration.ProviderOptions, Proffer.Configuration.IProviderOptions, Proffer.Configuration.INamedElementOptions -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → ProviderOptions → [FileSystemProviderOptions](./proffer.storage.filesystem.configuration.filesystemprovideroptions)
-Implements IProviderOptions, INamedElementOptions - -## Properties - -### **RootPath** - -Gets or sets the root path. - -```csharp -public string RootPath { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Name** - - - -```csharp -public string Name { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Type** - - - -```csharp -public string Type { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Constructors - -### **FileSystemProviderOptions()** - - - -```csharp -public FileSystemProviderOptions() -``` diff --git a/docs/code/Storage/FileSystem/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md b/docs/code/Storage/FileSystem/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md deleted file mode 100644 index cbbc749..0000000 --- a/docs/code/Storage/FileSystem/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md +++ /dev/null @@ -1,120 +0,0 @@ -# FileSystemScopedStoreOptions - -Namespace: Proffer.Storage.FileSystem.Configuration - -Options for a scoped [FileSystemStore](./proffer.storage.filesystem.filesystemstore). - -```csharp -public class FileSystemScopedStoreOptions : FileSystemStoreOptions, Proffer.Storage.Configuration.IStoreOptions, Proffer.Configuration.INamedElementOptions, Proffer.Storage.Configuration.IScopedStoreOptions -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → StoreOptions → [FileSystemStoreOptions](./proffer.storage.filesystem.configuration.filesystemstoreoptions) → [FileSystemScopedStoreOptions](./proffer.storage.filesystem.configuration.filesystemscopedstoreoptions)
-Implements IStoreOptions, INamedElementOptions, IScopedStoreOptions - -## Properties - -### **FolderNameFormat** - -Gets the folder name format. - -```csharp -public string FolderNameFormat { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **RootPath** - -Gets or sets the root path. - -```csharp -public string RootPath { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **AbsolutePath** - -Gets the absolute path. - -```csharp -public string AbsolutePath { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Name** - - - -```csharp -public string Name { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ProviderName** - - - -```csharp -public string ProviderName { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ProviderType** - - - -```csharp -public string ProviderType { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **AccessLevel** - - - -```csharp -public AccessLevel AccessLevel { get; set; } -``` - -#### Property Value - -AccessLevel
- -### **FolderName** - - - -```csharp -public string FolderName { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Constructors - -### **FileSystemScopedStoreOptions()** - - - -```csharp -public FileSystemScopedStoreOptions() -``` diff --git a/docs/code/Storage/FileSystem/proffer.storage.filesystem.configuration.filesystemstoreoptions.md b/docs/code/Storage/FileSystem/proffer.storage.filesystem.configuration.filesystemstoreoptions.md deleted file mode 100644 index 5d71d1b..0000000 --- a/docs/code/Storage/FileSystem/proffer.storage.filesystem.configuration.filesystemstoreoptions.md +++ /dev/null @@ -1,133 +0,0 @@ -# FileSystemStoreOptions - -Namespace: Proffer.Storage.FileSystem.Configuration - -Options for an [FileSystemStore](./proffer.storage.filesystem.filesystemstore). - -```csharp -public class FileSystemStoreOptions : Proffer.Storage.Configuration.StoreOptions, Proffer.Storage.Configuration.IStoreOptions, Proffer.Configuration.INamedElementOptions -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → StoreOptions → [FileSystemStoreOptions](./proffer.storage.filesystem.configuration.filesystemstoreoptions)
-Implements IStoreOptions, INamedElementOptions - -## Properties - -### **RootPath** - -Gets or sets the root path. - -```csharp -public string RootPath { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **AbsolutePath** - -Gets the absolute path. - -```csharp -public string AbsolutePath { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Name** - - - -```csharp -public string Name { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ProviderName** - - - -```csharp -public string ProviderName { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ProviderType** - - - -```csharp -public string ProviderType { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **AccessLevel** - - - -```csharp -public AccessLevel AccessLevel { get; set; } -``` - -#### Property Value - -AccessLevel
- -### **FolderName** - - - -```csharp -public string FolderName { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Constructors - -### **FileSystemStoreOptions()** - - - -```csharp -public FileSystemStoreOptions() -``` - -## Methods - -### **Validate(Boolean)** - -Validates the options. - -```csharp -public IEnumerable Validate(bool throwOnError) -``` - -#### Parameters - -`throwOnError` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, throws an exception when the validation fails with any . - -#### Returns - -[IEnumerable<IOptionError>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
- - The returned by the validation, if any. - -#### Exceptions - -Proffer.Storage.Exceptions.BadStoreConfiguration
diff --git a/docs/code/Storage/FileSystem/proffer.storage.filesystem.filesystemstore.md b/docs/code/Storage/FileSystem/proffer.storage.filesystem.filesystemstore.md deleted file mode 100644 index d961209..0000000 --- a/docs/code/Storage/FileSystem/proffer.storage.filesystem.filesystemstore.md +++ /dev/null @@ -1,331 +0,0 @@ -# FileSystemStore - -Namespace: Proffer.Storage.FileSystem - -A File System store allows to save, list or read files on a container in its configured [FileSystemStorageProvider](./proffer.storage.filesystem.filesystemstorageprovider). - -```csharp -public class FileSystemStore : Proffer.Storage.IStore -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemStore](./proffer.storage.filesystem.filesystemstore)
-Implements IStore - -## Properties - -### **Name** - -Gets the name of the store. - -```csharp -public string Name { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Constructors - -### **FileSystemStore(FileSystemStoreOptions, IPublicUrlProvider, IExtendedPropertiesProvider)** - -Initializes a new instance of the [FileSystemStore](./proffer.storage.filesystem.filesystemstore) class. - -```csharp -public FileSystemStore(FileSystemStoreOptions storeOptions, IPublicUrlProvider publicUrlProvider, IExtendedPropertiesProvider extendedPropertiesProvider) -``` - -#### Parameters - -`storeOptions` [FileSystemStoreOptions](./proffer.storage.filesystem.configuration.filesystemstoreoptions)
-The store options. - -`publicUrlProvider` [IPublicUrlProvider](./proffer.storage.filesystem.ipublicurlprovider)
-The public URL provider. - -`extendedPropertiesProvider` [IExtendedPropertiesProvider](./proffer.storage.filesystem.iextendedpropertiesprovider)
-The extended properties provider. - -## Methods - -### **InitAsync(CancellationToken)** - -Initializes the store by creating a container in its Proffer.Storage.IStorageProvider. - -```csharp -public Task InitAsync(CancellationToken cancellationToken) -``` - -#### Parameters - -`cancellationToken` [CancellationToken](https://docs.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken)
- -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **ListAsync(String, Boolean, Boolean)** - -Lists the files under . - -```csharp -public ValueTask ListAsync(string path, bool recursive, bool withMetadata) -``` - -#### Parameters - -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The path. - -`recursive` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, recurse the listing across folders. - -`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, fetch metadata for each file. - -#### Returns - -[ValueTask<IFileReference[]>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.valuetask-1)
- - The list under . - -### **ListAsync(String, String, Boolean, Boolean)** - -Lists the files under matching the . - -```csharp -public ValueTask ListAsync(string path, string searchPattern, bool recursive, bool withMetadata) -``` - -#### Parameters - -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The path. - -`searchPattern` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The search pattern. - -`recursive` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, recurse the listing across folders. - -`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, fetch metadata for each file. - -#### Returns - -[ValueTask<IFileReference[]>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.valuetask-1)
- - The list under matching the . - -### **GetAsync(IPrivateFileReference, Boolean)** - -Gets the file reference from path. - -```csharp -public ValueTask GetAsync(IPrivateFileReference file, bool withMetadata) -``` - -#### Parameters - -`file` IPrivateFileReference
-The reference holding the file path. - -`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, fetch metadata for the file. - -#### Returns - -[ValueTask<IFileReference>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.valuetask-1)
- - The at path. - -### **GetAsync(Uri, Boolean)** - -Gets the file reference from URI. - -```csharp -public ValueTask GetAsync(Uri uri, bool withMetadata) -``` - -#### Parameters - -`uri` Uri
-The file uniform resource identifier (URI). - -`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, fetch metadata for the file. - -#### Returns - -[ValueTask<IFileReference>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.valuetask-1)
- - The at path. - -#### Exceptions - -[InvalidOperationException](https://docs.microsoft.com/en-us/dotnet/api/system.invalidoperationexception)
- -### **DeleteAsync(IPrivateFileReference)** - -Deletes the file. - -```csharp -public Task DeleteAsync(IPrivateFileReference file) -``` - -#### Parameters - -`file` IPrivateFileReference
-The reference holding the file path. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- -### **ReadAsync(IPrivateFileReference)** - -Reads the file content. - -```csharp -public ValueTask ReadAsync(IPrivateFileReference file) -``` - -#### Parameters - -`file` IPrivateFileReference
-The reference holding the file path. - -#### Returns - -[ValueTask<Stream>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.valuetask-1)
- - A containing the file content. - -### **ReadAllBytesAsync(IPrivateFileReference)** - -Reads the file content. - -```csharp -public ValueTask ReadAllBytesAsync(IPrivateFileReference file) -``` - -#### Parameters - -`file` IPrivateFileReference
-The reference holding the file path. - -#### Returns - -[ValueTask<Byte[]>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.valuetask-1)
- - A containing the file content. - -### **ReadAllTextAsync(IPrivateFileReference)** - -Reads the file content. - -```csharp -public ValueTask ReadAllTextAsync(IPrivateFileReference file) -``` - -#### Parameters - -`file` IPrivateFileReference
-The reference holding the file path. - -#### Returns - -[ValueTask<String>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.valuetask-1)
- - A containing the file content. - -### **SaveAsync(Byte[], IPrivateFileReference, String, OverwritePolicy, IDictionary<String, String>)** - -Saves the file. - -```csharp -public ValueTask SaveAsync(Byte[] data, IPrivateFileReference file, string contentType, OverwritePolicy overwritePolicy, IDictionary metadata) -``` - -#### Parameters - -`data` [Byte[]](https://docs.microsoft.com/en-us/dotnet/api/system.byte)
-The file content. - -`file` IPrivateFileReference
-The reference holding the file path. - -`contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The content-type of the file. - -`overwritePolicy` OverwritePolicy
-The overwrite policy. - -`metadata` [IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
-The metadata. - -#### Returns - -[ValueTask<IFileReference>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.valuetask-1)
- - The saved . - -### **SaveAsync(Stream, IPrivateFileReference, String, OverwritePolicy, IDictionary<String, String>)** - -Saves the file. - -```csharp -public ValueTask SaveAsync(Stream data, IPrivateFileReference file, string contentType, OverwritePolicy overwritePolicy, IDictionary metadata) -``` - -#### Parameters - -`data` [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream)
-The file content. - -`file` IPrivateFileReference
-The reference holding the file path. - -`contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The content-type of the file. - -`overwritePolicy` OverwritePolicy
-The overwrite policy. - -`metadata` [IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
-The metadata. - -#### Returns - -[ValueTask<IFileReference>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.valuetask-1)
- - The saved . - -#### Exceptions - -Proffer.Storage.Exceptions.FileAlreadyExistsException
- -### **GetSharedAccessSignatureAsync(ISharedAccessPolicy)** - -Gets a shared access signature. - -```csharp -public ValueTask GetSharedAccessSignatureAsync(ISharedAccessPolicy policy) -``` - -#### Parameters - -`policy` ISharedAccessPolicy
-The policy. - -#### Returns - -[ValueTask<String>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.valuetask-1)
- - A shared access signature to read or list the store files. - -#### Exceptions - -[NotSupportedException](https://docs.microsoft.com/en-us/dotnet/api/system.notsupportedexception)
diff --git a/docs/code/Storage/FileSystem/proffer.storage.filesystem.iextendedpropertiesprovider.md b/docs/code/Storage/FileSystem/proffer.storage.filesystem.iextendedpropertiesprovider.md deleted file mode 100644 index d25c128..0000000 --- a/docs/code/Storage/FileSystem/proffer.storage.filesystem.iextendedpropertiesprovider.md +++ /dev/null @@ -1,56 +0,0 @@ -# IExtendedPropertiesProvider - -Namespace: Proffer.Storage.FileSystem - -Provides a way to store and retrieve extended file properties to match the requirements of Proffer.Storage.IFileProperties on a File System. - -```csharp -public interface IExtendedPropertiesProvider -``` - -## Methods - -### **GetExtendedPropertiesAsync(String, IPrivateFileReference)** - -Gets the extended properties of a file reference. - -```csharp -ValueTask GetExtendedPropertiesAsync(string storeAbsolutePath, IPrivateFileReference file) -``` - -#### Parameters - -`storeAbsolutePath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The store absolute path. - -`file` IPrivateFileReference
-The reference holding the file path. - -#### Returns - -[ValueTask<FileExtendedProperties>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.valuetask-1)
-A loaded instance or a default one if not found. - -### **SaveExtendedPropertiesAsync(String, IPrivateFileReference, FileExtendedProperties)** - -Saves the extended properties for a file reference. - -```csharp -Task SaveExtendedPropertiesAsync(string storeAbsolutePath, IPrivateFileReference file, FileExtendedProperties extendedProperties) -``` - -#### Parameters - -`storeAbsolutePath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The store absolute path. - -`file` IPrivateFileReference
-The reference holding the file path. - -`extendedProperties` [FileExtendedProperties](./proffer.storage.filesystem.internal.fileextendedproperties)
-The extended properties. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
-A task that represents the asynchronous operation. diff --git a/docs/code/Storage/FileSystem/proffer.storage.filesystem.internal.fileextendedproperties.md b/docs/code/Storage/FileSystem/proffer.storage.filesystem.internal.fileextendedproperties.md deleted file mode 100644 index 375879f..0000000 --- a/docs/code/Storage/FileSystem/proffer.storage.filesystem.internal.fileextendedproperties.md +++ /dev/null @@ -1,83 +0,0 @@ -# FileExtendedProperties - -Namespace: Proffer.Storage.FileSystem.Internal - -Extends standard file properties to match the requirements of Proffer.Storage.IFileProperties. - -```csharp -public class FileExtendedProperties -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileExtendedProperties](./proffer.storage.filesystem.internal.fileextendedproperties) - -## Properties - -### **ContentType** - -Gets or sets the content-type. - -```csharp -public string ContentType { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ETag** - -Gets or sets the etag. - -```csharp -public string ETag { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **CacheControl** - -Gets or sets the cache control. - -```csharp -public string CacheControl { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ContentMD5** - -Gets or sets the MD5 digest of the content. - -```csharp -public string ContentMD5 { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Metadata** - -Gets or sets the metadata. - -```csharp -public IDictionary Metadata { get; set; } -``` - -#### Property Value - -[IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
- -## Constructors - -### **FileExtendedProperties()** - -Initializes a new instance of the [FileExtendedProperties](./proffer.storage.filesystem.internal.fileextendedproperties) class. - -```csharp -public FileExtendedProperties() -``` diff --git a/docs/code/Storage/FileSystem/proffer.storage.filesystem.internal.filesystemfileproperties.md b/docs/code/Storage/FileSystem/proffer.storage.filesystem.internal.filesystemfileproperties.md deleted file mode 100644 index 536b229..0000000 --- a/docs/code/Storage/FileSystem/proffer.storage.filesystem.internal.filesystemfileproperties.md +++ /dev/null @@ -1,116 +0,0 @@ -# FileSystemFileProperties - -Namespace: Proffer.Storage.FileSystem.Internal - -File common properties with metadata stored on a File System. - -```csharp -public class FileSystemFileProperties : Proffer.Storage.IFileProperties -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemFileProperties](./proffer.storage.filesystem.internal.filesystemfileproperties)
-Implements IFileProperties - -## Properties - -### **LastModified** - -Gets the last modified time. - -```csharp -public Nullable LastModified { get; } -``` - -#### Property Value - -[Nullable<DateTimeOffset>](https://docs.microsoft.com/en-us/dotnet/api/system.nullable-1)
- -### **Length** - -Gets the length of the content. - -```csharp -public long Length { get; } -``` - -#### Property Value - -[Int64](https://docs.microsoft.com/en-us/dotnet/api/system.int64)
- -### **ContentType** - -Gets or sets the content-type. - -```csharp -public string ContentType { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ETag** - -Gets the etag. - -```csharp -public string ETag { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **CacheControl** - -Gets or sets the cache control. - -```csharp -public string CacheControl { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ContentMD5** - -Gets the MD5 digest of the content. - -```csharp -public string ContentMD5 { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Metadata** - -Gets the metadata. - -```csharp -public IDictionary Metadata { get; } -``` - -#### Property Value - -[IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
- -## Constructors - -### **FileSystemFileProperties(String, FileExtendedProperties)** - -Initializes a new instance of the [FileSystemFileProperties](./proffer.storage.filesystem.internal.filesystemfileproperties) class. - -```csharp -public FileSystemFileProperties(string fileSystemPath, FileExtendedProperties extendedProperties) -``` - -#### Parameters - -`fileSystemPath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The file system path. - -`extendedProperties` [FileExtendedProperties](./proffer.storage.filesystem.internal.fileextendedproperties)
-The extended properties. diff --git a/docs/code/Storage/FileSystem/proffer.storage.filesystem.internal.filesystemfilereference.md b/docs/code/Storage/FileSystem/proffer.storage.filesystem.internal.filesystemfilereference.md deleted file mode 100644 index 45e9af1..0000000 --- a/docs/code/Storage/FileSystem/proffer.storage.filesystem.internal.filesystemfilereference.md +++ /dev/null @@ -1,234 +0,0 @@ -# FileSystemFileReference - -Namespace: Proffer.Storage.FileSystem.Internal - -A reference of a stored file at a given path on a File System. - -```csharp -public class FileSystemFileReference : Proffer.Storage.IFileReference, Proffer.Storage.IPrivateFileReference -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemFileReference](./proffer.storage.filesystem.internal.filesystemfilereference)
-Implements IFileReference, IPrivateFileReference - -## Properties - -### **FileSystemPath** - -Gets the file system path. - -```csharp -public string FileSystemPath { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Path** - -Gets the file path. - -```csharp -public string Path { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **PublicUrl** - -Gets the public URL. - -```csharp -public string PublicUrl { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Properties** - -Gets the properties. - -```csharp -public IFileProperties Properties { get; } -``` - -#### Property Value - -IFileProperties
- -## Constructors - -### **FileSystemFileReference(String, String, FileSystemStore, Boolean, FileExtendedProperties, IPublicUrlProvider, IExtendedPropertiesProvider)** - -Initializes a new instance of the [FileSystemFileReference](./proffer.storage.filesystem.internal.filesystemfilereference) class. - -```csharp -public FileSystemFileReference(string filePath, string path, FileSystemStore store, bool withMetadata, FileExtendedProperties extendedProperties, IPublicUrlProvider publicUrlProvider, IExtendedPropertiesProvider extendedPropertiesProvider) -``` - -#### Parameters - -`filePath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The file system path. - -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The path. - -`store` [FileSystemStore](./proffer.storage.filesystem.filesystemstore)
-The store. - -`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, the metadata for the file have been fetched. - -`extendedProperties` [FileExtendedProperties](./proffer.storage.filesystem.internal.fileextendedproperties)
-The extended properties. - -`publicUrlProvider` [IPublicUrlProvider](./proffer.storage.filesystem.ipublicurlprovider)
-The public URL provider. - -`extendedPropertiesProvider` [IExtendedPropertiesProvider](./proffer.storage.filesystem.iextendedpropertiesprovider)
-The extended properties provider. - -## Methods - -### **DeleteAsync()** - -Deletes the file. - -```csharp -public Task DeleteAsync() -``` - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **ReadAllBytesAsync()** - -Reads the file content. - -```csharp -public ValueTask ReadAllBytesAsync() -``` - -#### Returns - -[ValueTask<Byte[]>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.valuetask-1)
- - A containing the file content. - -### **ReadAllTextAsync()** - -Reads the file content. - -```csharp -public ValueTask ReadAllTextAsync() -``` - -#### Returns - -[ValueTask<String>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.valuetask-1)
- - A containing the file content. - -### **ReadAsync()** - -Reads the file content. - -```csharp -public ValueTask ReadAsync() -``` - -#### Returns - -[ValueTask<Stream>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.valuetask-1)
- - A containing the file content. - -### **ReadToStreamAsync(Stream)** - -Reads the file content into the given stream. - -```csharp -public Task ReadToStreamAsync(Stream targetStream) -``` - -#### Parameters - -`targetStream` [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream)
-The target stream. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- -### **UpdateAsync(Stream)** - -Updates the file content with the given [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream). - -```csharp -public Task UpdateAsync(Stream stream) -``` - -#### Parameters - -`stream` [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream)
-The new file content. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **SavePropertiesAsync()** - -Saves the file properties. - -```csharp -public Task SavePropertiesAsync() -``` - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **GetSharedAccessSignature(ISharedAccessPolicy)** - -Gets a shared access signature. - -```csharp -public ValueTask GetSharedAccessSignature(ISharedAccessPolicy policy) -``` - -#### Parameters - -`policy` ISharedAccessPolicy
-The policy. - -#### Returns - -[ValueTask<String>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.valuetask-1)
-A shared access signature to read file. - -### **FetchProperties()** - -Fetches the file properties. - -```csharp -public Task FetchProperties() -``` - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
-A task that represents the asynchronous operation. diff --git a/docs/code/Storage/FileSystem/proffer.storage.filesystem.ipublicurlprovider.md b/docs/code/Storage/FileSystem/proffer.storage.filesystem.ipublicurlprovider.md deleted file mode 100644 index 5bb5cec..0000000 --- a/docs/code/Storage/FileSystem/proffer.storage.filesystem.ipublicurlprovider.md +++ /dev/null @@ -1,32 +0,0 @@ -# IPublicUrlProvider - -Namespace: Proffer.Storage.FileSystem - -Provides a way to serve files from an HTTP URL on a File System. - -```csharp -public interface IPublicUrlProvider -``` - -## Methods - -### **GetPublicUrl(String, FileSystemFileReference)** - -Gets the public URL of a file reference. - -```csharp -string GetPublicUrl(string storeName, FileSystemFileReference file) -``` - -#### Parameters - -`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the store. - -`file` [FileSystemFileReference](./proffer.storage.filesystem.internal.filesystemfilereference)
-The reference holding the file path. - -#### Returns - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The public URL. diff --git a/docs/code/Storage/FileSystem/proffer.storage.filesystem.noextendedpropertiesprovider.md b/docs/code/Storage/FileSystem/proffer.storage.filesystem.noextendedpropertiesprovider.md deleted file mode 100644 index 60d0b3e..0000000 --- a/docs/code/Storage/FileSystem/proffer.storage.filesystem.noextendedpropertiesprovider.md +++ /dev/null @@ -1,69 +0,0 @@ -# NoExtendedPropertiesProvider - -Namespace: Proffer.Storage.FileSystem - -Default [IExtendedPropertiesProvider](./proffer.storage.filesystem.iextendedpropertiesprovider) without property storage capacity. - -```csharp -public class NoExtendedPropertiesProvider : IExtendedPropertiesProvider -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [NoExtendedPropertiesProvider](./proffer.storage.filesystem.noextendedpropertiesprovider)
-Implements [IExtendedPropertiesProvider](./proffer.storage.filesystem.iextendedpropertiesprovider) - -## Constructors - -### **NoExtendedPropertiesProvider()** - - - -```csharp -public NoExtendedPropertiesProvider() -``` - -## Methods - -### **GetExtendedPropertiesAsync(String, IPrivateFileReference)** - -Gets the extended properties of a file reference. - -```csharp -public ValueTask GetExtendedPropertiesAsync(string storeAbsolutePath, IPrivateFileReference file) -``` - -#### Parameters - -`storeAbsolutePath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The store absolute path. - -`file` IPrivateFileReference
-The reference holding the file path. - -#### Returns - -[ValueTask<FileExtendedProperties>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.valuetask-1)
-A loaded instance or a default one if not found. - -### **SaveExtendedPropertiesAsync(String, IPrivateFileReference, FileExtendedProperties)** - -Saves the extended properties for a file reference. - -```csharp -public Task SaveExtendedPropertiesAsync(string storeAbsolutePath, IPrivateFileReference file, FileExtendedProperties extendedProperties) -``` - -#### Parameters - -`storeAbsolutePath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The store absolute path. - -`file` IPrivateFileReference
-The reference holding the file path. - -`extendedProperties` [FileExtendedProperties](./proffer.storage.filesystem.internal.fileextendedproperties)
-The extended properties. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
-A task that represents the asynchronous operation. diff --git a/docs/code/Storage/index.md b/docs/code/Storage/index.md deleted file mode 100644 index a94ec68..0000000 --- a/docs/code/Storage/index.md +++ /dev/null @@ -1,75 +0,0 @@ -# Proffer.Storage - -## Proffer.Storage - -[IFileProperties](./proffer.storage.ifileproperties) - -[IFileReference](./proffer.storage.ifilereference) - -[IPrivateFileReference](./proffer.storage.iprivatefilereference) - -[ISharedAccessPolicy](./proffer.storage.isharedaccesspolicy) - -[IStorageFactory](./proffer.storage.istoragefactory) - -[IStorageProvider](./proffer.storage.istorageprovider) - -[IStore](./proffer.storage.istore) - -[IStore<TOptions>](./proffer.storage.istore-1) - -[IStoreExtensions](./proffer.storage.istoreextensions) - -[OverwritePolicy](./proffer.storage.overwritepolicy) - -[SharedAccessPermissions](./proffer.storage.sharedaccesspermissions) - -[SharedAccessPolicy](./proffer.storage.sharedaccesspolicy) - -[StorageServiceCollectionExtensions](./proffer.storage.storageservicecollectionextensions) - -[StoreBase](./proffer.storage.storebase) - -## Proffer.Storage.Configuration - -[AccessLevel](./proffer.storage.configuration.accesslevel) - -[ConfigurationExtensions](./proffer.storage.configuration.configurationextensions) - -[IParsedOptions<TProviderOptions, TStoreOptions, TScopedStoreOptions>](./proffer.storage.configuration.iparsedoptions-3) - -[IScopedStoreOptions](./proffer.storage.configuration.iscopedstoreoptions) - -[IStoreOptions](./proffer.storage.configuration.istoreoptions) - -[ScopedStoreOptions](./proffer.storage.configuration.scopedstoreoptions) - -[StorageOptions](./proffer.storage.configuration.storageoptions) - -[StoreOptions](./proffer.storage.configuration.storeoptions) - -## Proffer.Storage.Exceptions - -[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration) - -[BadScopedStoreConfiguration](./proffer.storage.exceptions.badscopedstoreconfiguration) - -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration) - -[FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception) - -[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception) - -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception) - -## Proffer.Storage.Internal - -[ConfigureProviderOptions<TParsedOptions, TProviderOptions, TStoreOptions, TScopedStoreOptions>](./proffer.storage.internal.configureprovideroptions-4) - -[GenericStoreProxy<TOptions>](./proffer.storage.internal.genericstoreproxy-1) - -[PrivateFileReference](./proffer.storage.internal.privatefilereference) - -[StorageFactory](./proffer.storage.internal.storagefactory) - -[StorageProviderBase<TParsedOptions, TInstanceOptions, TStoreOptions, TScopedStoreOptions>](./proffer.storage.internal.storageproviderbase-4) diff --git a/docs/code/Storage/proffer.storage.configuration.accesslevel.md b/docs/code/Storage/proffer.storage.configuration.accesslevel.md deleted file mode 100644 index cdede81..0000000 --- a/docs/code/Storage/proffer.storage.configuration.accesslevel.md +++ /dev/null @@ -1,28 +0,0 @@ -[`< Back`](./) - ---- - -# AccessLevel - -Namespace: Proffer.Storage.Configuration - -Defines a store access level. - -```csharp -public enum AccessLevel -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ValueType](https://docs.microsoft.com/en-us/dotnet/api/system.valuetype) → [Enum](https://docs.microsoft.com/en-us/dotnet/api/system.enum) → [AccessLevel](./proffer.storage.configuration.accesslevel)
-Implements [IComparable](https://docs.microsoft.com/en-us/dotnet/api/system.icomparable), [IFormattable](https://docs.microsoft.com/en-us/dotnet/api/system.iformattable), [IConvertible](https://docs.microsoft.com/en-us/dotnet/api/system.iconvertible) - -## Fields - -| Name | Value | Description | -| --- | --: | --- | -| Private | 0 | No public access. | -| Confidential | 1 | Public files without listing. | -| Public | 2 | Public access. | - ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.configuration.configurationextensions.md b/docs/code/Storage/proffer.storage.configuration.configurationextensions.md deleted file mode 100644 index 306dff3..0000000 --- a/docs/code/Storage/proffer.storage.configuration.configurationextensions.md +++ /dev/null @@ -1,225 +0,0 @@ -[`< Back`](./) - ---- - -# ConfigurationExtensions - -Namespace: Proffer.Storage.Configuration - -Extensions methods to parse and bind options. - -```csharp -public static class ConfigurationExtensions -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ConfigurationExtensions](./proffer.storage.configuration.configurationextensions) - -## Methods - -### **Parse<TOptions>(IReadOnlyDictionary<String, IConfigurationSection>)** - -Parses the specified unparsed configuration. - -```csharp -public static IReadOnlyDictionary Parse(IReadOnlyDictionary unparsedConfiguration) -``` - -#### Type Parameters - -`TOptions`
-The type of the options. - -#### Parameters - -`unparsedConfiguration` [IReadOnlyDictionary<String, IConfigurationSection>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
-The unparsed configuration. - -#### Returns - -IReadOnlyDictionary<String, TOptions>
-A typed dictionary with options binding from the given unparsed configuration. - -### **GetStoreConfiguration<TInstanceOptions, TStoreOptions, TScopedStoreOptions>(IParsedOptions<TInstanceOptions, TStoreOptions, TScopedStoreOptions>, String, Boolean)** - -Gets the store configuration. - -```csharp -public static TStoreOptions GetStoreConfiguration(IParsedOptions parsedOptions, string storeName, bool throwIfNotFound) -``` - -#### Type Parameters - -`TInstanceOptions`
-The type of the provider instance options. - -`TStoreOptions`
-The type of the store options. - -`TScopedStoreOptions`
-The type of the scoped store options. - -#### Parameters - -`parsedOptions` IParsedOptions<TInstanceOptions, TStoreOptions, TScopedStoreOptions>
-The parsed options. - -`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the store. - -`throwIfNotFound` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, throws an exception if the store configuration is not found. - -#### Returns - -TStoreOptions
-The typed store configuration. - -#### Exceptions - -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
- -### **GetScopedStoreConfiguration<TInstanceOptions, TStoreOptions, TScopedStoreOptions>(IParsedOptions<TInstanceOptions, TStoreOptions, TScopedStoreOptions>, String, Boolean)** - -Gets the scoped store configuration. - -```csharp -public static TScopedStoreOptions GetScopedStoreConfiguration(IParsedOptions parsedOptions, string storeName, bool throwIfNotFound) -``` - -#### Type Parameters - -`TInstanceOptions`
-The type of the provider instance options. - -`TStoreOptions`
-The type of the store options. - -`TScopedStoreOptions`
-The type of the scoped store options. - -#### Parameters - -`parsedOptions` IParsedOptions<TInstanceOptions, TStoreOptions, TScopedStoreOptions>
-The parsed options. - -`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the store. - -`throwIfNotFound` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, throws an exception if the store configuration is not found. - -#### Returns - -TScopedStoreOptions
-The typed scoped store configuration. - -#### Exceptions - -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
- -### **Compute<TParsedOptions, TProviderOptions, TStoreOptions, TScopedStoreOptions>(TProviderOptions, TParsedOptions)** - -Computes the specified options. - -```csharp -public static void Compute(TProviderOptions providerOptions, TParsedOptions options) -``` - -#### Type Parameters - -`TParsedOptions`
-The type of the parsed options. - -`TProviderOptions`
-The type of the provider instance options. - -`TStoreOptions`
-The type of the store options. - -`TScopedStoreOptions`
-The type of the scoped store options. - -#### Parameters - -`providerOptions` TProviderOptions
-The provider options. - -`options` TParsedOptions
-The options. - -#### Exceptions - -[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
- -### **Compute<TParsedOptions, TInstanceOptions, TStoreOptions, TScopedStoreOptions>(TStoreOptions, TParsedOptions)** - -Computes the specified options. - -```csharp -public static void Compute(TStoreOptions parsedStore, TParsedOptions options) -``` - -#### Type Parameters - -`TParsedOptions`
-The type of the parsed options. - -`TInstanceOptions`
-The type of the provider instance options. - -`TStoreOptions`
-The type of the store options. - -`TScopedStoreOptions`
-The type of the scoped store options. - -#### Parameters - -`parsedStore` TStoreOptions
-The parsed store options. - -`options` TParsedOptions
-The options. - -#### Exceptions - -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
- -### **ParseStoreOptions<TParsedOptions, TInstanceOptions, TStoreOptions, TScopedStoreOptions>(IStoreOptions, TParsedOptions)** - -Parses the store options. - -```csharp -public static TStoreOptions ParseStoreOptions(IStoreOptions storeOptions, TParsedOptions options) -``` - -#### Type Parameters - -`TParsedOptions`
-The type of the parsed options. - -`TInstanceOptions`
-The type of the provider instance options. - -`TStoreOptions`
-The type of the store options. - -`TScopedStoreOptions`
-The type of the scoped store options. - -#### Parameters - -`storeOptions` [IStoreOptions](./proffer.storage.configuration.istoreoptions)
-The store options. - -`options` TParsedOptions
-The options. - -#### Returns - -TStoreOptions
-The parsed store options. - ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.configuration.iparsedoptions-3.md b/docs/code/Storage/proffer.storage.configuration.iparsedoptions-3.md deleted file mode 100644 index 921c61b..0000000 --- a/docs/code/Storage/proffer.storage.configuration.iparsedoptions-3.md +++ /dev/null @@ -1,125 +0,0 @@ -[`< Back`](./) - ---- - -# IParsedOptions<TProviderOptions, TStoreOptions, TScopedStoreOptions> - -Namespace: Proffer.Storage.Configuration - -Typed options parsed from the dynamic configuration. - -```csharp -public interface IParsedOptions -``` - -#### Type Parameters - -`TProviderOptions`
-The type of the provider instance options. - -`TStoreOptions`
-The type of the store options. - -`TScopedStoreOptions`
-The type of the scoped store options. - -## Properties - -### **Name** - -Gets the name. - -```csharp -public abstract string Name { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ConnectionStrings** - -Gets or sets the connection strings. - -```csharp -public abstract IReadOnlyDictionary ConnectionStrings { get; set; } -``` - -#### Property Value - -[IReadOnlyDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
- -### **ParsedProviders** - -Gets or sets the parsed provider options. - -```csharp -public abstract IReadOnlyDictionary ParsedProviders { get; set; } -``` - -#### Property Value - -IReadOnlyDictionary<String, TProviderOptions>
- -### **ParsedStores** - -Gets or sets the parsed stores options. - -```csharp -public abstract IReadOnlyDictionary ParsedStores { get; set; } -``` - -#### Property Value - -IReadOnlyDictionary<String, TStoreOptions>
- -### **ParsedScopedStores** - -Gets or sets the parsed scoped stores options. - -```csharp -public abstract IReadOnlyDictionary ParsedScopedStores { get; set; } -``` - -#### Property Value - -IReadOnlyDictionary<String, TScopedStoreOptions>
- -## Methods - -### **BindProviderOptions(TProviderOptions)** - -Binds the provider options. - -```csharp -void BindProviderOptions(TProviderOptions providerOptions) -``` - -#### Parameters - -`providerOptions` TProviderOptions
-The provider options. - -### **BindStoreOptions(TStoreOptions, TProviderOptions)** - -Binds the store options. - -```csharp -void BindStoreOptions(TStoreOptions storeOptions, TProviderOptions providerInstanceOptions) -``` - -#### Parameters - -`storeOptions` TStoreOptions
-The store options. - -`providerInstanceOptions` TProviderOptions
-The provider instance options. - -#### Exceptions - -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
- ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.configuration.iscopedstoreoptions.md b/docs/code/Storage/proffer.storage.configuration.iscopedstoreoptions.md deleted file mode 100644 index 3f71b5f..0000000 --- a/docs/code/Storage/proffer.storage.configuration.iscopedstoreoptions.md +++ /dev/null @@ -1,33 +0,0 @@ -[`< Back`](./) - ---- - -# IScopedStoreOptions - -Namespace: Proffer.Storage.Configuration - -Options for a scoped [IStore](./proffer.storage.istore). - -```csharp -public interface IScopedStoreOptions : IStoreOptions, Proffer.Configuration.INamedElementOptions -``` - -Implements [IStoreOptions](./proffer.storage.configuration.istoreoptions), INamedElementOptions - -## Properties - -### **FolderNameFormat** - -Gets the folder name format. - -```csharp -public abstract string FolderNameFormat { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.configuration.istoreoptions.md b/docs/code/Storage/proffer.storage.configuration.istoreoptions.md deleted file mode 100644 index 637e268..0000000 --- a/docs/code/Storage/proffer.storage.configuration.istoreoptions.md +++ /dev/null @@ -1,93 +0,0 @@ -[`< Back`](./) - ---- - -# IStoreOptions - -Namespace: Proffer.Storage.Configuration - -Options for an [IStore](./proffer.storage.istore). - -```csharp -public interface IStoreOptions : Proffer.Configuration.INamedElementOptions -``` - -Implements INamedElementOptions - -## Properties - -### **ProviderName** - -Gets or sets the name of the provider. - -```csharp -public abstract string ProviderName { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ProviderType** - -Gets or sets the type of the provider. - -```csharp -public abstract string ProviderType { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **AccessLevel** - -Gets or sets the access level. - -```csharp -public abstract AccessLevel AccessLevel { get; set; } -``` - -#### Property Value - -[AccessLevel](./proffer.storage.configuration.accesslevel)
- -### **FolderName** - -Gets or sets the name of the folder. - -```csharp -public abstract string FolderName { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Methods - -### **Validate(Boolean)** - -Validates the options. - -```csharp -IEnumerable Validate(bool throwOnError) -``` - -#### Parameters - -`throwOnError` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, throws an exception when the validation fails with any . - -#### Returns - -[IEnumerable<IOptionError>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The returned by the validation, if any. - -#### Exceptions - -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
- ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.configuration.scopedstoreoptions.md b/docs/code/Storage/proffer.storage.configuration.scopedstoreoptions.md deleted file mode 100644 index ca4ac60..0000000 --- a/docs/code/Storage/proffer.storage.configuration.scopedstoreoptions.md +++ /dev/null @@ -1,104 +0,0 @@ -[`< Back`](./) - ---- - -# ScopedStoreOptions - -Namespace: Proffer.Storage.Configuration - -Generic options for a scoped [IStore](./proffer.storage.istore). - -```csharp -public class ScopedStoreOptions : StoreOptions, IStoreOptions, Proffer.Configuration.INamedElementOptions, IScopedStoreOptions -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [StoreOptions](./proffer.storage.configuration.storeoptions) → [ScopedStoreOptions](./proffer.storage.configuration.scopedstoreoptions)
-Implements [IStoreOptions](./proffer.storage.configuration.istoreoptions), INamedElementOptions, [IScopedStoreOptions](./proffer.storage.configuration.iscopedstoreoptions) - -## Properties - -### **FolderNameFormat** - -Gets the folder name format. - -```csharp -public string FolderNameFormat { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Name** - -Gets or sets the name. - -```csharp -public string Name { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ProviderName** - -Gets or sets the name of the provider. - -```csharp -public string ProviderName { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ProviderType** - -Gets or sets the type of the provider. - -```csharp -public string ProviderType { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **AccessLevel** - -Gets or sets the access level. - -```csharp -public AccessLevel AccessLevel { get; set; } -``` - -#### Property Value - -[AccessLevel](./proffer.storage.configuration.accesslevel)
- -### **FolderName** - -Gets or sets the name of the folder. - -```csharp -public string FolderName { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Constructors - -### **ScopedStoreOptions()** - - - -```csharp -public ScopedStoreOptions() -``` - ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.configuration.storageoptions.md b/docs/code/Storage/proffer.storage.configuration.storageoptions.md deleted file mode 100644 index 70a8114..0000000 --- a/docs/code/Storage/proffer.storage.configuration.storageoptions.md +++ /dev/null @@ -1,169 +0,0 @@ -[`< Back`](./) - ---- - -# StorageOptions - -Namespace: Proffer.Storage.Configuration - -The Proffer.Storage options with providers and stores. - -```csharp -public class StorageOptions : IParsedOptions`3 -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [StorageOptions](./proffer.storage.configuration.storageoptions)
-Implements [IParsedOptions<ProviderOptions, StoreOptions, ScopedStoreOptions>](./proffer.storage.configuration.iparsedoptions-3) - -## Fields - -### **DefaultConfigurationSectionName** - -The default configuration section name. - -```csharp -public static string DefaultConfigurationSectionName; -``` - -## Properties - -### **Name** - -Gets the name. - -```csharp -public string Name { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Providers** - -Gets or sets the providers unparsed options. - -```csharp -public IReadOnlyDictionary Providers { get; set; } -``` - -#### Property Value - -[IReadOnlyDictionary<String, IConfigurationSection>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
- -### **Stores** - -Gets or sets the stores unparsed options. - -```csharp -public IReadOnlyDictionary Stores { get; set; } -``` - -#### Property Value - -[IReadOnlyDictionary<String, IConfigurationSection>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
- -### **ScopedStores** - -Gets or sets the scoped stores unparsed options. - -```csharp -public IReadOnlyDictionary ScopedStores { get; set; } -``` - -#### Property Value - -[IReadOnlyDictionary<String, IConfigurationSection>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
- -### **ConnectionStrings** - -Gets or sets the connection strings. - -```csharp -public IReadOnlyDictionary ConnectionStrings { get; set; } -``` - -#### Property Value - -[IReadOnlyDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
- -### **ParsedProviders** - -Gets or sets the parsed provider instances options. - -```csharp -public IReadOnlyDictionary ParsedProviders { get; set; } -``` - -#### Property Value - -[IReadOnlyDictionary<String, ProviderOptions>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
- -### **ParsedStores** - -Gets or sets the parsed stores options. - -```csharp -public IReadOnlyDictionary ParsedStores { get; set; } -``` - -#### Property Value - -[IReadOnlyDictionary<String, StoreOptions>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
- -### **ParsedScopedStores** - -Gets or sets the parsed scoped stores options. - -```csharp -public IReadOnlyDictionary ParsedScopedStores { get; set; } -``` - -#### Property Value - -[IReadOnlyDictionary<String, ScopedStoreOptions>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
- -## Constructors - -### **StorageOptions()** - -Initializes a new instance of the [StorageOptions](./proffer.storage.configuration.storageoptions) class. - -```csharp -public StorageOptions() -``` - -## Methods - -### **BindProviderOptions(ProviderOptions)** - -Binds the provider instance options. - -```csharp -public void BindProviderOptions(ProviderOptions providerInstanceOptions) -``` - -#### Parameters - -`providerInstanceOptions` ProviderOptions
-The provider instance options. - -### **BindStoreOptions(StoreOptions, ProviderOptions)** - -Binds the store options. - -```csharp -public void BindStoreOptions(StoreOptions storeOptions, ProviderOptions providerInstanceOptions) -``` - -#### Parameters - -`storeOptions` [StoreOptions](./proffer.storage.configuration.storeoptions)
-The store options. - -`providerInstanceOptions` ProviderOptions
-The provider instance options. - ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.configuration.storeoptions.md b/docs/code/Storage/proffer.storage.configuration.storeoptions.md deleted file mode 100644 index c3eb8eb..0000000 --- a/docs/code/Storage/proffer.storage.configuration.storeoptions.md +++ /dev/null @@ -1,133 +0,0 @@ -[`< Back`](./) - ---- - -# StoreOptions - -Namespace: Proffer.Storage.Configuration - -Generic options for an [IStore](./proffer.storage.istore). - -```csharp -public class StoreOptions : IStoreOptions, Proffer.Configuration.INamedElementOptions -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [StoreOptions](./proffer.storage.configuration.storeoptions)
-Implements [IStoreOptions](./proffer.storage.configuration.istoreoptions), INamedElementOptions - -## Properties - -### **Name** - -Gets or sets the name. - -```csharp -public string Name { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ProviderName** - -Gets or sets the name of the provider. - -```csharp -public string ProviderName { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ProviderType** - -Gets or sets the type of the provider. - -```csharp -public string ProviderType { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **AccessLevel** - -Gets or sets the access level. - -```csharp -public AccessLevel AccessLevel { get; set; } -``` - -#### Property Value - -[AccessLevel](./proffer.storage.configuration.accesslevel)
- -### **FolderName** - -Gets or sets the name of the folder. - -```csharp -public string FolderName { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Constructors - -### **StoreOptions()** - - - -```csharp -public StoreOptions() -``` - -## Methods - -### **Validate(Boolean)** - -Validates the options. - -```csharp -public IEnumerable Validate(bool throwOnError) -``` - -#### Parameters - -`throwOnError` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, throws an exception when the validation fails with any . - -#### Returns - -[IEnumerable<IOptionError>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
- - The returned by the validation, if any. - -#### Exceptions - -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
- -### **PushMissingPropertyError(List<OptionError>, String)** - -Pushes a missing property Proffer.Configuration.IOptionError to the list or errors. - -```csharp -protected void PushMissingPropertyError(List optionErrors, string propertyName) -``` - -#### Parameters - -`optionErrors` [List<OptionError>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1)
-The option errors. - -`propertyName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the missing property. - ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.exceptions.badproviderconfiguration.md b/docs/code/Storage/proffer.storage.exceptions.badproviderconfiguration.md deleted file mode 100644 index a75bb3e..0000000 --- a/docs/code/Storage/proffer.storage.exceptions.badproviderconfiguration.md +++ /dev/null @@ -1,136 +0,0 @@ -[`< Back`](./) - ---- - -# BadProviderConfiguration - -Namespace: Proffer.Storage.Exceptions - -Thrown when a provider was not properly configured. - -```csharp -public class BadProviderConfiguration : System.Exception, System.Runtime.Serialization.ISerializable -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
-Implements [ISerializable](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.serialization.iserializable) - -## Properties - -### **TargetSite** - - - -```csharp -public MethodBase TargetSite { get; } -``` - -#### Property Value - -[MethodBase](https://docs.microsoft.com/en-us/dotnet/api/system.reflection.methodbase)
- -### **StackTrace** - - - -```csharp -public string StackTrace { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Message** - - - -```csharp -public string Message { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Data** - - - -```csharp -public IDictionary Data { get; } -``` - -#### Property Value - -[IDictionary](https://docs.microsoft.com/en-us/dotnet/api/system.collections.idictionary)
- -### **InnerException** - - - -```csharp -public Exception InnerException { get; } -``` - -#### Property Value - -[Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception)
- -### **HelpLink** - - - -```csharp -public string HelpLink { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Source** - - - -```csharp -public string Source { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **HResult** - - - -```csharp -public int HResult { get; set; } -``` - -#### Property Value - -[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
- -## Constructors - -### **BadProviderConfiguration(String, String)** - -Initializes a new instance of the [BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration) class. - -```csharp -public BadProviderConfiguration(string providerName, string details) -``` - -#### Parameters - -`providerName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the provider. - -`details` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The details. - ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.exceptions.badscopedstoreconfiguration.md b/docs/code/Storage/proffer.storage.exceptions.badscopedstoreconfiguration.md deleted file mode 100644 index 28cc33d..0000000 --- a/docs/code/Storage/proffer.storage.exceptions.badscopedstoreconfiguration.md +++ /dev/null @@ -1,139 +0,0 @@ -[`< Back`](./) - ---- - -# BadScopedStoreConfiguration - -Namespace: Proffer.Storage.Exceptions - -Thrown when a scoped store was not properly configured. - -```csharp -public class BadScopedStoreConfiguration : System.Exception, System.Runtime.Serialization.ISerializable -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [BadScopedStoreConfiguration](./proffer.storage.exceptions.badscopedstoreconfiguration)
-Implements [ISerializable](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.serialization.iserializable) - -## Properties - -### **TargetSite** - - - -```csharp -public MethodBase TargetSite { get; } -``` - -#### Property Value - -[MethodBase](https://docs.microsoft.com/en-us/dotnet/api/system.reflection.methodbase)
- -### **StackTrace** - - - -```csharp -public string StackTrace { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Message** - - - -```csharp -public string Message { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Data** - - - -```csharp -public IDictionary Data { get; } -``` - -#### Property Value - -[IDictionary](https://docs.microsoft.com/en-us/dotnet/api/system.collections.idictionary)
- -### **InnerException** - - - -```csharp -public Exception InnerException { get; } -``` - -#### Property Value - -[Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception)
- -### **HelpLink** - - - -```csharp -public string HelpLink { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Source** - - - -```csharp -public string Source { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **HResult** - - - -```csharp -public int HResult { get; set; } -``` - -#### Property Value - -[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
- -## Constructors - -### **BadScopedStoreConfiguration(String, String, Exception)** - -Initializes a new instance of the [BadScopedStoreConfiguration](./proffer.storage.exceptions.badscopedstoreconfiguration) class. - -```csharp -public BadScopedStoreConfiguration(string storeName, string details, Exception innerException) -``` - -#### Parameters - -`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the store. - -`details` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The details. - -`innerException` [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception)
-The inner exception. - ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.exceptions.badstoreconfiguration.md b/docs/code/Storage/proffer.storage.exceptions.badstoreconfiguration.md deleted file mode 100644 index 665c5cd..0000000 --- a/docs/code/Storage/proffer.storage.exceptions.badstoreconfiguration.md +++ /dev/null @@ -1,164 +0,0 @@ -[`< Back`](./) - ---- - -# BadStoreConfiguration - -Namespace: Proffer.Storage.Exceptions - -Thrown when a store was not properly configured. - -```csharp -public class BadStoreConfiguration : System.Exception, System.Runtime.Serialization.ISerializable -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
-Implements [ISerializable](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.serialization.iserializable) - -## Properties - -### **Errors** - -Gets the validation errors. - -```csharp -public IEnumerable Errors { get; } -``` - -#### Property Value - -[IEnumerable<IOptionError>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
- -### **TargetSite** - - - -```csharp -public MethodBase TargetSite { get; } -``` - -#### Property Value - -[MethodBase](https://docs.microsoft.com/en-us/dotnet/api/system.reflection.methodbase)
- -### **StackTrace** - - - -```csharp -public string StackTrace { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Message** - - - -```csharp -public string Message { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Data** - - - -```csharp -public IDictionary Data { get; } -``` - -#### Property Value - -[IDictionary](https://docs.microsoft.com/en-us/dotnet/api/system.collections.idictionary)
- -### **InnerException** - - - -```csharp -public Exception InnerException { get; } -``` - -#### Property Value - -[Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception)
- -### **HelpLink** - - - -```csharp -public string HelpLink { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Source** - - - -```csharp -public string Source { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **HResult** - - - -```csharp -public int HResult { get; set; } -``` - -#### Property Value - -[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
- -## Constructors - -### **BadStoreConfiguration(String, String)** - -Initializes a new instance of the [BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration) class. - -```csharp -public BadStoreConfiguration(string storeName, string details) -``` - -#### Parameters - -`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the store. - -`details` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The details. - -### **BadStoreConfiguration(String, IEnumerable<IOptionError>)** - -Initializes a new instance of the [BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration) class. - -```csharp -public BadStoreConfiguration(string storeName, IEnumerable errors) -``` - -#### Parameters - -`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the store. - -`errors` [IEnumerable<IOptionError>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The errors. - ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.exceptions.filealreadyexistsexception.md b/docs/code/Storage/proffer.storage.exceptions.filealreadyexistsexception.md deleted file mode 100644 index 9af1cbb..0000000 --- a/docs/code/Storage/proffer.storage.exceptions.filealreadyexistsexception.md +++ /dev/null @@ -1,136 +0,0 @@ -[`< Back`](./) - ---- - -# FileAlreadyExistsException - -Namespace: Proffer.Storage.Exceptions - -Thrown when trying to create a file that already exists in a store. - -```csharp -public class FileAlreadyExistsException : System.Exception, System.Runtime.Serialization.ISerializable -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception)
-Implements [ISerializable](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.serialization.iserializable) - -## Properties - -### **TargetSite** - - - -```csharp -public MethodBase TargetSite { get; } -``` - -#### Property Value - -[MethodBase](https://docs.microsoft.com/en-us/dotnet/api/system.reflection.methodbase)
- -### **StackTrace** - - - -```csharp -public string StackTrace { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Message** - - - -```csharp -public string Message { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Data** - - - -```csharp -public IDictionary Data { get; } -``` - -#### Property Value - -[IDictionary](https://docs.microsoft.com/en-us/dotnet/api/system.collections.idictionary)
- -### **InnerException** - - - -```csharp -public Exception InnerException { get; } -``` - -#### Property Value - -[Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception)
- -### **HelpLink** - - - -```csharp -public string HelpLink { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Source** - - - -```csharp -public string Source { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **HResult** - - - -```csharp -public int HResult { get; set; } -``` - -#### Property Value - -[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
- -## Constructors - -### **FileAlreadyExistsException(String, String)** - -Initializes a new instance of the [FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception) class. - -```csharp -public FileAlreadyExistsException(string storeName, string filePath) -``` - -#### Parameters - -`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the store. - -`filePath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The file path. - ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.exceptions.providernotfoundexception.md b/docs/code/Storage/proffer.storage.exceptions.providernotfoundexception.md deleted file mode 100644 index 16471ba..0000000 --- a/docs/code/Storage/proffer.storage.exceptions.providernotfoundexception.md +++ /dev/null @@ -1,133 +0,0 @@ -[`< Back`](./) - ---- - -# ProviderNotFoundException - -Namespace: Proffer.Storage.Exceptions - -Thrown when a configured provider cannot be resolved through dependency injection. - -```csharp -public class ProviderNotFoundException : System.Exception, System.Runtime.Serialization.ISerializable -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
-Implements [ISerializable](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.serialization.iserializable) - -## Properties - -### **TargetSite** - - - -```csharp -public MethodBase TargetSite { get; } -``` - -#### Property Value - -[MethodBase](https://docs.microsoft.com/en-us/dotnet/api/system.reflection.methodbase)
- -### **StackTrace** - - - -```csharp -public string StackTrace { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Message** - - - -```csharp -public string Message { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Data** - - - -```csharp -public IDictionary Data { get; } -``` - -#### Property Value - -[IDictionary](https://docs.microsoft.com/en-us/dotnet/api/system.collections.idictionary)
- -### **InnerException** - - - -```csharp -public Exception InnerException { get; } -``` - -#### Property Value - -[Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception)
- -### **HelpLink** - - - -```csharp -public string HelpLink { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Source** - - - -```csharp -public string Source { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **HResult** - - - -```csharp -public int HResult { get; set; } -``` - -#### Property Value - -[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
- -## Constructors - -### **ProviderNotFoundException(String)** - -Initializes a new instance of the [ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception) class. - -```csharp -public ProviderNotFoundException(string providerName) -``` - -#### Parameters - -`providerName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the provider. - ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.exceptions.storenotfoundexception.md b/docs/code/Storage/proffer.storage.exceptions.storenotfoundexception.md deleted file mode 100644 index 7962009..0000000 --- a/docs/code/Storage/proffer.storage.exceptions.storenotfoundexception.md +++ /dev/null @@ -1,133 +0,0 @@ -[`< Back`](./) - ---- - -# StoreNotFoundException - -Namespace: Proffer.Storage.Exceptions - -Thrown when a store was not found in the configuration. - -```csharp -public class StoreNotFoundException : System.Exception, System.Runtime.Serialization.ISerializable -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
-Implements [ISerializable](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.serialization.iserializable) - -## Properties - -### **TargetSite** - - - -```csharp -public MethodBase TargetSite { get; } -``` - -#### Property Value - -[MethodBase](https://docs.microsoft.com/en-us/dotnet/api/system.reflection.methodbase)
- -### **StackTrace** - - - -```csharp -public string StackTrace { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Message** - - - -```csharp -public string Message { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Data** - - - -```csharp -public IDictionary Data { get; } -``` - -#### Property Value - -[IDictionary](https://docs.microsoft.com/en-us/dotnet/api/system.collections.idictionary)
- -### **InnerException** - - - -```csharp -public Exception InnerException { get; } -``` - -#### Property Value - -[Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception)
- -### **HelpLink** - - - -```csharp -public string HelpLink { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Source** - - - -```csharp -public string Source { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **HResult** - - - -```csharp -public int HResult { get; set; } -``` - -#### Property Value - -[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
- -## Constructors - -### **StoreNotFoundException(String)** - -Initializes a new instance of the [StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception) class. - -```csharp -public StoreNotFoundException(string storeName) -``` - -#### Parameters - -`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the store. - ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.ifileproperties.md b/docs/code/Storage/proffer.storage.ifileproperties.md deleted file mode 100644 index adfd6ef..0000000 --- a/docs/code/Storage/proffer.storage.ifileproperties.md +++ /dev/null @@ -1,103 +0,0 @@ -[`< Back`](./) - ---- - -# IFileProperties - -Namespace: Proffer.Storage - -File common properties with metadata. - -```csharp -public interface IFileProperties -``` - -## Properties - -### **LastModified** - -Gets the last modified time. - -```csharp -public abstract Nullable LastModified { get; } -``` - -#### Property Value - -[Nullable<DateTimeOffset>](https://docs.microsoft.com/en-us/dotnet/api/system.nullable-1)
- -### **Length** - -Gets the length of the content. - -```csharp -public abstract long Length { get; } -``` - -#### Property Value - -[Int64](https://docs.microsoft.com/en-us/dotnet/api/system.int64)
- -### **ContentType** - -Gets or sets the content-type. - -```csharp -public abstract string ContentType { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ETag** - -Gets the etag. - -```csharp -public abstract string ETag { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **CacheControl** - -Gets or sets the cache control. - -```csharp -public abstract string CacheControl { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ContentMD5** - -Gets the MD5 digest of the content. - -```csharp -public abstract string ContentMD5 { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Metadata** - -Gets the metadata. - -```csharp -public abstract IDictionary Metadata { get; } -``` - -#### Property Value - -[IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
- ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.ifilereference.md b/docs/code/Storage/proffer.storage.ifilereference.md deleted file mode 100644 index 9c5cf3a..0000000 --- a/docs/code/Storage/proffer.storage.ifilereference.md +++ /dev/null @@ -1,179 +0,0 @@ -[`< Back`](./) - ---- - -# IFileReference - -Namespace: Proffer.Storage - -A reference of a stored file at a given path. - -```csharp -public interface IFileReference : IPrivateFileReference -``` - -Implements [IPrivateFileReference](./proffer.storage.iprivatefilereference) - -## Properties - -### **PublicUrl** - -Gets the public URL. - -```csharp -public abstract string PublicUrl { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Properties** - -Gets the properties. - -```csharp -public abstract IFileProperties Properties { get; } -``` - -#### Property Value - -[IFileProperties](./proffer.storage.ifileproperties)
- -## Methods - -### **ReadToStreamAsync(Stream)** - -Reads the file content into the given stream. - -```csharp -Task ReadToStreamAsync(Stream targetStream) -``` - -#### Parameters - -`targetStream` [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream)
-The target stream. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
-A task that represents the asynchronous operation. - -### **ReadAsync()** - -Reads the file content. - -```csharp -ValueTask ReadAsync() -``` - -#### Returns - -ValueTask<Stream>
-A containing the file content. - -### **ReadAllTextAsync()** - -Reads the file content. - -```csharp -ValueTask ReadAllTextAsync() -``` - -#### Returns - -ValueTask<String>
-A containing the file content. - -### **ReadAllBytesAsync()** - -Reads the file content. - -```csharp -ValueTask ReadAllBytesAsync() -``` - -#### Returns - -ValueTask<Byte[]>
-A containing the file content. - -### **DeleteAsync()** - -Deletes the file. - -```csharp -Task DeleteAsync() -``` - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
-A task that represents the asynchronous operation. - -### **UpdateAsync(Stream)** - -Updates the file content with the given [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream). - -```csharp -Task UpdateAsync(Stream stream) -``` - -#### Parameters - -`stream` [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream)
-The new file content. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
-A task that represents the asynchronous operation. - -### **SavePropertiesAsync()** - -Saves the file properties. - -```csharp -Task SavePropertiesAsync() -``` - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
-A task that represents the asynchronous operation. - -### **GetSharedAccessSignature(ISharedAccessPolicy)** - -Gets a shared access signature. - -```csharp -ValueTask GetSharedAccessSignature(ISharedAccessPolicy policy) -``` - -#### Parameters - -`policy` [ISharedAccessPolicy](./proffer.storage.isharedaccesspolicy)
-The policy. - -#### Returns - -ValueTask<String>
-A shared access signature to read file. - -### **FetchProperties()** - -Fetches the file properties. - -```csharp -Task FetchProperties() -``` - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
-A task that represents the asynchronous operation. - ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.internal.configureprovideroptions-4.md b/docs/code/Storage/proffer.storage.internal.configureprovideroptions-4.md deleted file mode 100644 index ef23cf5..0000000 --- a/docs/code/Storage/proffer.storage.internal.configureprovideroptions-4.md +++ /dev/null @@ -1,70 +0,0 @@ -[`< Back`](./) - ---- - -# ConfigureProviderOptions<TParsedOptions, TProviderOptions, TStoreOptions, TScopedStoreOptions> - -Namespace: Proffer.Storage.Internal - -Configures a provider from generic [StorageOptions](./proffer.storage.configuration.storageoptions). - -```csharp -public class ConfigureProviderOptions : -``` - -#### Type Parameters - -`TParsedOptions`
-The type of the parsed options. - -`TProviderOptions`
-The type of the provider instance options. - -`TStoreOptions`
-The type of the store options. - -`TScopedStoreOptions`
-The type of the scoped store options. - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ConfigureProviderOptions<TParsedOptions, TProviderOptions, TStoreOptions, TScopedStoreOptions>](./proffer.storage.internal.configureprovideroptions-4)
-Implements IConfigureOptions<TParsedOptions> - -## Constructors - -### **ConfigureProviderOptions(IOptions<StorageOptions>)** - -Initializes a new instance of the [ConfigureProviderOptions<TParsedOptions, TProviderOptions, TStoreOptions, TScopedStoreOptions>](./proffer.storage.internal.configureprovideroptions-4) class. - -```csharp -public ConfigureProviderOptions(IOptions storageOptions) -``` - -#### Parameters - -`storageOptions` IOptions<StorageOptions>
-The storage options. - -## Methods - -### **Configure(TParsedOptions)** - -Invoked to configure a instance. - -```csharp -public void Configure(TParsedOptions options) -``` - -#### Parameters - -`options` TParsedOptions
-The options instance to configure. - -#### Exceptions - -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
- -[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
- ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.internal.genericstoreproxy-1.md b/docs/code/Storage/proffer.storage.internal.genericstoreproxy-1.md deleted file mode 100644 index 8550d04..0000000 --- a/docs/code/Storage/proffer.storage.internal.genericstoreproxy-1.md +++ /dev/null @@ -1,351 +0,0 @@ -[`< Back`](./) - ---- - -# GenericStoreProxy<TOptions> - -Namespace: Proffer.Storage.Internal - -Generic [IStore](./proffer.storage.istore) proxy to allow direct dependency injection of a [IStore<TOptions>](./proffer.storage.istore-1). - -```csharp -public class GenericStoreProxy : Proffer.Storage.IStore, -``` - -#### Type Parameters - -`TOptions`
-The type of the store options. - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [GenericStoreProxy<TOptions>](./proffer.storage.internal.genericstoreproxy-1)
-Implements [IStore](./proffer.storage.istore), IStore<TOptions> - -## Properties - -### **Name** - -Gets the name of the store. - -```csharp -public string Name { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Constructors - -### **GenericStoreProxy(IStorageFactory, IOptions<TOptions>)** - -Initializes a new instance of the [GenericStoreProxy<TOptions>](./proffer.storage.internal.genericstoreproxy-1) class. - -```csharp -public GenericStoreProxy(IStorageFactory factory, IOptions options) -``` - -#### Parameters - -`factory` [IStorageFactory](./proffer.storage.istoragefactory)
-The storage factory. - -`options` IOptions<TOptions>
-The options. - -#### Exceptions - -[ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/system.argumentnullexception)
- -## Methods - -### **InitAsync(CancellationToken)** - -Initializes the store by creating a container in its [IStorageProvider](./proffer.storage.istorageprovider). - -```csharp -public Task InitAsync(CancellationToken cancellationToken) -``` - -#### Parameters - -`cancellationToken` [CancellationToken](https://docs.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken)
- -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **DeleteAsync(IPrivateFileReference)** - -Deletes the file. - -```csharp -public Task DeleteAsync(IPrivateFileReference file) -``` - -#### Parameters - -`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
-The reference holding the file path. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **GetAsync(Uri, Boolean)** - -Gets the file reference from URI. - -```csharp -public ValueTask GetAsync(Uri file, bool withMetadata) -``` - -#### Parameters - -`file` Uri
-The file uniform resource identifier (URI). - -`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, fetch metadata for the file. - -#### Returns - -ValueTask<IFileReference>
- - The at path. - -#### Exceptions - -[InvalidOperationException](https://docs.microsoft.com/en-us/dotnet/api/system.invalidoperationexception)
- -### **GetAsync(IPrivateFileReference, Boolean)** - -Gets the file reference from path. - -```csharp -public ValueTask GetAsync(IPrivateFileReference file, bool withMetadata) -``` - -#### Parameters - -`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
-The reference holding the file path. - -`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, fetch metadata for the file. - -#### Returns - -ValueTask<IFileReference>
- - The at path. - -### **ListAsync(String, Boolean, Boolean)** - -Lists the files under . - -```csharp -public ValueTask ListAsync(string path, bool recursive, bool withMetadata) -``` - -#### Parameters - -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The path. - -`recursive` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, recurse the listing across folders. - -`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, fetch metadata for each file. - -#### Returns - -ValueTask<IFileReference[]>
- - The list under . - -### **ListAsync(String, String, Boolean, Boolean)** - -Lists the files under matching the . - -```csharp -public ValueTask ListAsync(string path, string searchPattern, bool recursive, bool withMetadata) -``` - -#### Parameters - -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The path. - -`searchPattern` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The search pattern. - -`recursive` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, recurse the listing across folders. - -`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, fetch metadata for each file. - -#### Returns - -ValueTask<IFileReference[]>
- - The list under matching the . - -### **ReadAllBytesAsync(IPrivateFileReference)** - -Reads the file content. - -```csharp -public ValueTask ReadAllBytesAsync(IPrivateFileReference file) -``` - -#### Parameters - -`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
-The reference holding the file path. - -#### Returns - -ValueTask<Byte[]>
- - A containing the file content. - -### **ReadAllTextAsync(IPrivateFileReference)** - -Reads the file content. - -```csharp -public ValueTask ReadAllTextAsync(IPrivateFileReference file) -``` - -#### Parameters - -`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
-The reference holding the file path. - -#### Returns - -ValueTask<String>
- - A containing the file content. - -### **ReadAsync(IPrivateFileReference)** - -Reads the file content. - -```csharp -public ValueTask ReadAsync(IPrivateFileReference file) -``` - -#### Parameters - -`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
-The reference holding the file path. - -#### Returns - -ValueTask<Stream>
- - A containing the file content. - -### **SaveAsync(Stream, IPrivateFileReference, String, OverwritePolicy, IDictionary<String, String>)** - -Saves the file. - -```csharp -public ValueTask SaveAsync(Stream data, IPrivateFileReference file, string contentType, OverwritePolicy overwritePolicy, IDictionary metadata) -``` - -#### Parameters - -`data` [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream)
-The file content. - -`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
-The reference holding the file path. - -`contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The content-type of the file. - -`overwritePolicy` [OverwritePolicy](./proffer.storage.overwritepolicy)
-The overwrite policy. - -`metadata` [IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
-The metadata. - -#### Returns - -ValueTask<IFileReference>
- - The saved . - -#### Exceptions - -[FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception)
- -### **SaveAsync(Byte[], IPrivateFileReference, String, OverwritePolicy, IDictionary<String, String>)** - -Saves the file. - -```csharp -public ValueTask SaveAsync(Byte[] data, IPrivateFileReference file, string contentType, OverwritePolicy overwritePolicy, IDictionary metadata) -``` - -#### Parameters - -`data` [Byte[]](https://docs.microsoft.com/en-us/dotnet/api/system.byte)
-The file content. - -`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
-The reference holding the file path. - -`contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The content-type of the file. - -`overwritePolicy` [OverwritePolicy](./proffer.storage.overwritepolicy)
-The overwrite policy. - -`metadata` [IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
-The metadata. - -#### Returns - -ValueTask<IFileReference>
- - The saved . - -#### Exceptions - -[FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception)
- -### **GetSharedAccessSignatureAsync(ISharedAccessPolicy)** - -Gets a shared access signature. - -```csharp -public ValueTask GetSharedAccessSignatureAsync(ISharedAccessPolicy policy) -``` - -#### Parameters - -`policy` [ISharedAccessPolicy](./proffer.storage.isharedaccesspolicy)
-The policy. - -#### Returns - -ValueTask<String>
- - A shared access signature to read or list the store files. - -#### Exceptions - -[NotSupportedException](https://docs.microsoft.com/en-us/dotnet/api/system.notsupportedexception)
- ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.internal.privatefilereference.md b/docs/code/Storage/proffer.storage.internal.privatefilereference.md deleted file mode 100644 index 1945c54..0000000 --- a/docs/code/Storage/proffer.storage.internal.privatefilereference.md +++ /dev/null @@ -1,49 +0,0 @@ -[`< Back`](./) - ---- - -# PrivateFileReference - -Namespace: Proffer.Storage.Internal - -A simple reference of a stored file at a given path. - -```csharp -public class PrivateFileReference : Proffer.Storage.IPrivateFileReference -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [PrivateFileReference](./proffer.storage.internal.privatefilereference)
-Implements [IPrivateFileReference](./proffer.storage.iprivatefilereference) - -## Properties - -### **Path** - -Gets the file path. - -```csharp -public string Path { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Constructors - -### **PrivateFileReference(String)** - -Initializes a new instance of the [PrivateFileReference](./proffer.storage.internal.privatefilereference) class. - -```csharp -public PrivateFileReference(string path) -``` - -#### Parameters - -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The file path. - ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.internal.storagefactory.md b/docs/code/Storage/proffer.storage.internal.storagefactory.md deleted file mode 100644 index c2b42f4..0000000 --- a/docs/code/Storage/proffer.storage.internal.storagefactory.md +++ /dev/null @@ -1,200 +0,0 @@ -[`< Back`](./) - ---- - -# StorageFactory - -Namespace: Proffer.Storage.Internal - -Default storage factory to build [IStore](./proffer.storage.istore) from configured [IStorageProvider](./proffer.storage.istorageprovider). - -```csharp -public class StorageFactory : Proffer.Storage.IStorageFactory -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [StorageFactory](./proffer.storage.internal.storagefactory)
-Implements [IStorageFactory](./proffer.storage.istoragefactory) - -## Constructors - -### **StorageFactory(IEnumerable<IStorageProvider>, IOptions<StorageOptions>)** - -Initializes a new instance of the [StorageFactory](./proffer.storage.internal.storagefactory) class. - -```csharp -public StorageFactory(IEnumerable storageProviders, IOptions options) -``` - -#### Parameters - -`storageProviders` [IEnumerable<IStorageProvider>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
-The storage providers. - -`options` IOptions<StorageOptions>
-The options. - -## Methods - -### **GetStore(String, IStoreOptions)** - -Gets a store with specific options. - -```csharp -public IStore GetStore(string storeName, IStoreOptions configuration) -``` - -#### Parameters - -`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the store. - -`configuration` [IStoreOptions](./proffer.storage.configuration.istoreoptions)
-The store options. - -#### Returns - -[IStore](./proffer.storage.istore)
- - A configured . - -#### Exceptions - -[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
- -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
- -[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
- -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
- -### **GetStore(String)** - -Gets a store from configured options. - -```csharp -public IStore GetStore(string storeName) -``` - -#### Parameters - -`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the store. - -#### Returns - -[IStore](./proffer.storage.istore)
- - A configured . - -#### Exceptions - -[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
- -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
- -[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
- -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
- -### **GetScopedStore(String, Object[])** - -Gets a scoped store from configured options. - -```csharp -public IStore GetScopedStore(string storeName, Object[] args) -``` - -#### Parameters - -`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the scoped store. - -`args` [Object[]](https://docs.microsoft.com/en-us/dotnet/api/system.object)
-The arguments to apply to the scoped store name format. - -#### Returns - -[IStore](./proffer.storage.istore)
- - A configured . - -#### Exceptions - -[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
- -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
- -[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
- -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
- -[BadScopedStoreConfiguration](./proffer.storage.exceptions.badscopedstoreconfiguration)
- -### **TryGetStore(String, IStore&)** - -Gets a store from configured options. - -```csharp -public bool TryGetStore(string storeName, IStore& store) -``` - -#### Parameters - -`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the store. - -`store` [IStore&](./proffer.storage.istore&)
-When this method returns, contains the store associated with the specified name, if it is found in the ; otherwise, null. This parameter is passed uninitialized. - -#### Returns - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-true if the store was configured and built from its provider; otherwise, false. - -#### Exceptions - -[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
- -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
- -[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
- -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
- -### **TryGetStore(String, IStore&, String)** - -Gets a store from configured options. - -```csharp -public bool TryGetStore(string storeName, IStore& store, string providerName) -``` - -#### Parameters - -`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the store. - -`store` [IStore&](./proffer.storage.istore&)
-When this method returns, contains the store associated with the specified name, if it is found in the ; otherwise, null. This parameter is passed uninitialized. - -`providerName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The explicit provider name from which the store should be built. - -#### Returns - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-true if the store was configured and built from its provider; otherwise, false. - -#### Exceptions - -[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
- -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
- -[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
- -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
- ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.internal.storageproviderbase-4.md b/docs/code/Storage/proffer.storage.internal.storageproviderbase-4.md deleted file mode 100644 index 2af134c..0000000 --- a/docs/code/Storage/proffer.storage.internal.storageproviderbase-4.md +++ /dev/null @@ -1,160 +0,0 @@ -[`< Back`](./) - ---- - -# StorageProviderBase<TParsedOptions, TInstanceOptions, TStoreOptions, TScopedStoreOptions> - -Namespace: Proffer.Storage.Internal - -A base provider to handle and build file stores pointing on a particular storage system location. - -```csharp -public abstract class StorageProviderBase : Proffer.Storage.IStorageProvider -``` - -#### Type Parameters - -`TParsedOptions`
-The type of the parsed options. - -`TInstanceOptions`
-The type of the provider instance options. - -`TStoreOptions`
-The type of the store options. - -`TScopedStoreOptions`
-The type of the scoped store options. - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [StorageProviderBase<TParsedOptions, TInstanceOptions, TStoreOptions, TScopedStoreOptions>](./proffer.storage.internal.storageproviderbase-4)
-Implements [IStorageProvider](./proffer.storage.istorageprovider) - -## Properties - -### **Name** - -Gets the name of this provider. - -```csharp -public abstract string Name { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Constructors - -### **StorageProviderBase(IOptions<TParsedOptions>)** - -Initializes a new instance of the [StorageProviderBase<TParsedOptions, TInstanceOptions, TStoreOptions, TScopedStoreOptions>](./proffer.storage.internal.storageproviderbase-4) class. - -```csharp -public StorageProviderBase(IOptions options) -``` - -#### Parameters - -`options` IOptions<TParsedOptions>
-The options. - -## Methods - -### **BuildStore(String)** - -Builds a store from configured options. - -```csharp -public IStore BuildStore(string storeName) -``` - -#### Parameters - -`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the store. - -#### Returns - -[IStore](./proffer.storage.istore)
- - A configured . - -#### Exceptions - -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
- -### **BuildStore(String, IStoreOptions)** - -Builds a store with specific options. - -```csharp -public IStore BuildStore(string storeName, IStoreOptions storeOptions) -``` - -#### Parameters - -`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the store. - -`storeOptions` [IStoreOptions](./proffer.storage.configuration.istoreoptions)
-The store options. - -#### Returns - -[IStore](./proffer.storage.istore)
- - A configured . - -### **BuildScopedStore(String, Object[])** - -Builds a scoped store from configured options. - -```csharp -public IStore BuildScopedStore(string storeName, Object[] args) -``` - -#### Parameters - -`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the store. - -`args` [Object[]](https://docs.microsoft.com/en-us/dotnet/api/system.object)
-The arguments to apply to the scoped store name format. - -#### Returns - -[IStore](./proffer.storage.istore)
- - A configured . - -#### Exceptions - -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
- -[BadScopedStoreConfiguration](./proffer.storage.exceptions.badscopedstoreconfiguration)
- -### **BuildStoreInternal(String, TStoreOptions)** - -Provider-specific build of a store with specific options. - -```csharp -protected abstract IStore BuildStoreInternal(string storeName, TStoreOptions storeOptions) -``` - -#### Parameters - -`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the store. - -`storeOptions` TStoreOptions
-The store options. - -#### Returns - -[IStore](./proffer.storage.istore)
- - A configured . - ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.iprivatefilereference.md b/docs/code/Storage/proffer.storage.iprivatefilereference.md deleted file mode 100644 index 9883f79..0000000 --- a/docs/code/Storage/proffer.storage.iprivatefilereference.md +++ /dev/null @@ -1,31 +0,0 @@ -[`< Back`](./) - ---- - -# IPrivateFileReference - -Namespace: Proffer.Storage - -A reference of a stored file at a given path. - -```csharp -public interface IPrivateFileReference -``` - -## Properties - -### **Path** - -Gets the file path. - -```csharp -public abstract string Path { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.isharedaccesspolicy.md b/docs/code/Storage/proffer.storage.isharedaccesspolicy.md deleted file mode 100644 index 9a86d83..0000000 --- a/docs/code/Storage/proffer.storage.isharedaccesspolicy.md +++ /dev/null @@ -1,55 +0,0 @@ -[`< Back`](./) - ---- - -# ISharedAccessPolicy - -Namespace: Proffer.Storage - -Represents a shared access policy, which specifies the start time, expiry time, and permissions for a shared access signature. - -```csharp -public interface ISharedAccessPolicy -``` - -## Properties - -### **StartTime** - -Gets the start time. - -```csharp -public abstract Nullable StartTime { get; } -``` - -#### Property Value - -[Nullable<DateTimeOffset>](https://docs.microsoft.com/en-us/dotnet/api/system.nullable-1)
- -### **ExpiryTime** - -Gets the expiry time. - -```csharp -public abstract Nullable ExpiryTime { get; } -``` - -#### Property Value - -[Nullable<DateTimeOffset>](https://docs.microsoft.com/en-us/dotnet/api/system.nullable-1)
- -### **Permissions** - -Gets the permissions. - -```csharp -public abstract SharedAccessPermissions Permissions { get; } -``` - -#### Property Value - -[SharedAccessPermissions](./proffer.storage.sharedaccesspermissions)
- ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.istoragefactory.md b/docs/code/Storage/proffer.storage.istoragefactory.md deleted file mode 100644 index 7c7fb2b..0000000 --- a/docs/code/Storage/proffer.storage.istoragefactory.md +++ /dev/null @@ -1,179 +0,0 @@ -[`< Back`](./) - ---- - -# IStorageFactory - -Namespace: Proffer.Storage - -Builds [IStore](./proffer.storage.istore) from configured [IStorageProvider](./proffer.storage.istorageprovider). - -```csharp -public interface IStorageFactory -``` - -## Methods - -### **GetStore(String, IStoreOptions)** - -Gets a store with specific options. - -```csharp -IStore GetStore(string storeName, IStoreOptions configuration) -``` - -#### Parameters - -`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the store. - -`configuration` [IStoreOptions](./proffer.storage.configuration.istoreoptions)
-The store options. - -#### Returns - -[IStore](./proffer.storage.istore)
- - A configured . - -#### Exceptions - -[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
- -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
- -[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
- -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
- -### **GetStore(String)** - -Gets a store from configured options. - -```csharp -IStore GetStore(string storeName) -``` - -#### Parameters - -`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the store. - -#### Returns - -[IStore](./proffer.storage.istore)
- - A configured . - -#### Exceptions - -[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
- -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
- -[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
- -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
- -### **GetScopedStore(String, Object[])** - -Gets a scoped store from configured options. - -```csharp -IStore GetScopedStore(string storeName, Object[] args) -``` - -#### Parameters - -`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the scoped store. - -`args` [Object[]](https://docs.microsoft.com/en-us/dotnet/api/system.object)
-The arguments to apply to the scoped store name format. - -#### Returns - -[IStore](./proffer.storage.istore)
- - A configured . - -#### Exceptions - -[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
- -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
- -[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
- -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
- -[BadScopedStoreConfiguration](./proffer.storage.exceptions.badscopedstoreconfiguration)
- -### **TryGetStore(String, IStore&)** - -Gets a store from configured options. - -```csharp -bool TryGetStore(string storeName, IStore& store) -``` - -#### Parameters - -`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the store. - -`store` [IStore&](./proffer.storage.istore&)
-When this method returns, contains the store associated with the specified name, if it is found in the ; otherwise, null. This parameter is passed uninitialized. - -#### Returns - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-true if the store was configured and built from its provider; otherwise, false. - -#### Exceptions - -[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
- -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
- -[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
- -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
- -### **TryGetStore(String, IStore&, String)** - -Gets a store from configured options. - -```csharp -bool TryGetStore(string storeName, IStore& store, string providerName) -``` - -#### Parameters - -`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the store. - -`store` [IStore&](./proffer.storage.istore&)
-When this method returns, contains the store associated with the specified name, if it is found in the ; otherwise, null. This parameter is passed uninitialized. - -`providerName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The explicit provider name from which the store should be built. - -#### Returns - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-true if the store was configured and built from its provider; otherwise, false. - -#### Exceptions - -[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
- -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
- -[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
- -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
- ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.istorageprovider.md b/docs/code/Storage/proffer.storage.istorageprovider.md deleted file mode 100644 index cf986f3..0000000 --- a/docs/code/Storage/proffer.storage.istorageprovider.md +++ /dev/null @@ -1,106 +0,0 @@ -[`< Back`](./) - ---- - -# IStorageProvider - -Namespace: Proffer.Storage - -A provider handles and builds file stores pointing on a particular storage system location. - -```csharp -public interface IStorageProvider -``` - -## Properties - -### **Name** - -Gets the name of this provider. - -```csharp -public abstract string Name { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Methods - -### **BuildStore(String)** - -Builds a store from configured options. - -```csharp -IStore BuildStore(string storeName) -``` - -#### Parameters - -`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the store. - -#### Returns - -[IStore](./proffer.storage.istore)
- - A configured . - -#### Exceptions - -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
- -### **BuildStore(String, IStoreOptions)** - -Builds a store with specific options. - -```csharp -IStore BuildStore(string storeName, IStoreOptions storeOptions) -``` - -#### Parameters - -`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the store. - -`storeOptions` [IStoreOptions](./proffer.storage.configuration.istoreoptions)
-The store options. - -#### Returns - -[IStore](./proffer.storage.istore)
- - A configured . - -### **BuildScopedStore(String, Object[])** - -Builds a scoped store from configured options. - -```csharp -IStore BuildScopedStore(string storeName, Object[] args) -``` - -#### Parameters - -`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the store. - -`args` [Object[]](https://docs.microsoft.com/en-us/dotnet/api/system.object)
-The arguments to apply to the scoped store name format. - -#### Returns - -[IStore](./proffer.storage.istore)
- - A configured . - -#### Exceptions - -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
- -[BadScopedStoreConfiguration](./proffer.storage.exceptions.badscopedstoreconfiguration)
- ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.istore-1.md b/docs/code/Storage/proffer.storage.istore-1.md deleted file mode 100644 index ad1f606..0000000 --- a/docs/code/Storage/proffer.storage.istore-1.md +++ /dev/null @@ -1,24 +0,0 @@ -[`< Back`](./) - ---- - -# IStore<TOptions> - -Namespace: Proffer.Storage - -Injectable typed store, which allows to save, list or read files on a container in its configured [IStorageProvider](./proffer.storage.istorageprovider). - -```csharp -public interface IStore : IStore -``` - -#### Type Parameters - -`TOptions`
-The type of the store options. - -Implements [IStore](./proffer.storage.istore) - ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.istore.md b/docs/code/Storage/proffer.storage.istore.md deleted file mode 100644 index 37e7d34..0000000 --- a/docs/code/Storage/proffer.storage.istore.md +++ /dev/null @@ -1,309 +0,0 @@ -[`< Back`](./) - ---- - -# IStore - -Namespace: Proffer.Storage - -A store allows to save, list or read files on a container in its configured [IStorageProvider](./proffer.storage.istorageprovider). - -```csharp -public interface IStore -``` - -## Properties - -### **Name** - -Gets the name of the store. - -```csharp -public abstract string Name { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Methods - -### **InitAsync(CancellationToken)** - -Initializes the store by creating a container in its [IStorageProvider](./proffer.storage.istorageprovider). - -```csharp -Task InitAsync(CancellationToken cancellationToken) -``` - -#### Parameters - -`cancellationToken` [CancellationToken](https://docs.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken)
- -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
-A task that represents the asynchronous operation. - -### **ListAsync(String, Boolean, Boolean)** - -Lists the files under . - -```csharp -ValueTask ListAsync(string path, bool recursive, bool withMetadata) -``` - -#### Parameters - -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The path. - -`recursive` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, recurse the listing across folders. - -`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, fetch metadata for each file. - -#### Returns - -ValueTask<IFileReference[]>
-The list under . - -### **ListAsync(String, String, Boolean, Boolean)** - -Lists the files under matching the . - -```csharp -ValueTask ListAsync(string path, string searchPattern, bool recursive, bool withMetadata) -``` - -#### Parameters - -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The path. - -`searchPattern` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The search pattern. - -`recursive` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, recurse the listing across folders. - -`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, fetch metadata for each file. - -#### Returns - -ValueTask<IFileReference[]>
-The list under matching the . - -### **GetAsync(IPrivateFileReference, Boolean)** - -Gets the file reference from path. - -```csharp -ValueTask GetAsync(IPrivateFileReference file, bool withMetadata) -``` - -#### Parameters - -`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
-The reference holding the file path. - -`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, fetch metadata for the file. - -#### Returns - -ValueTask<IFileReference>
-The at path. - -### **GetAsync(Uri, Boolean)** - -Gets the file reference from URI. - -```csharp -ValueTask GetAsync(Uri uri, bool withMetadata) -``` - -#### Parameters - -`uri` Uri
-The file uniform resource identifier (URI). - -`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, fetch metadata for the file. - -#### Returns - -ValueTask<IFileReference>
-The at path. - -#### Exceptions - -[InvalidOperationException](https://docs.microsoft.com/en-us/dotnet/api/system.invalidoperationexception)
- -### **DeleteAsync(IPrivateFileReference)** - -Deletes the file. - -```csharp -Task DeleteAsync(IPrivateFileReference file) -``` - -#### Parameters - -`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
-The reference holding the file path. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
-A task that represents the asynchronous operation. - -### **ReadAsync(IPrivateFileReference)** - -Reads the file content. - -```csharp -ValueTask ReadAsync(IPrivateFileReference file) -``` - -#### Parameters - -`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
-The reference holding the file path. - -#### Returns - -ValueTask<Stream>
-A containing the file content. - -### **ReadAllBytesAsync(IPrivateFileReference)** - -Reads the file content. - -```csharp -ValueTask ReadAllBytesAsync(IPrivateFileReference file) -``` - -#### Parameters - -`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
-The reference holding the file path. - -#### Returns - -ValueTask<Byte[]>
-A containing the file content. - -### **ReadAllTextAsync(IPrivateFileReference)** - -Reads the file content. - -```csharp -ValueTask ReadAllTextAsync(IPrivateFileReference file) -``` - -#### Parameters - -`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
-The reference holding the file path. - -#### Returns - -ValueTask<String>
-A containing the file content. - -### **SaveAsync(Byte[], IPrivateFileReference, String, OverwritePolicy, IDictionary<String, String>)** - -Saves the file. - -```csharp -ValueTask SaveAsync(Byte[] data, IPrivateFileReference file, string contentType, OverwritePolicy overwritePolicy, IDictionary metadata) -``` - -#### Parameters - -`data` [Byte[]](https://docs.microsoft.com/en-us/dotnet/api/system.byte)
-The file content. - -`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
-The reference holding the file path. - -`contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The content-type of the file. - -`overwritePolicy` [OverwritePolicy](./proffer.storage.overwritepolicy)
-The overwrite policy. - -`metadata` [IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
-The metadata. - -#### Returns - -ValueTask<IFileReference>
-The saved . - -#### Exceptions - -[FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception)
- -### **SaveAsync(Stream, IPrivateFileReference, String, OverwritePolicy, IDictionary<String, String>)** - -Saves the file. - -```csharp -ValueTask SaveAsync(Stream data, IPrivateFileReference file, string contentType, OverwritePolicy overwritePolicy, IDictionary metadata) -``` - -#### Parameters - -`data` [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream)
-The file content. - -`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
-The reference holding the file path. - -`contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The content-type of the file. - -`overwritePolicy` [OverwritePolicy](./proffer.storage.overwritepolicy)
-The overwrite policy. - -`metadata` [IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
-The metadata. - -#### Returns - -ValueTask<IFileReference>
-The saved . - -#### Exceptions - -[FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception)
- -### **GetSharedAccessSignatureAsync(ISharedAccessPolicy)** - -Gets a shared access signature. - -```csharp -ValueTask GetSharedAccessSignatureAsync(ISharedAccessPolicy policy) -``` - -#### Parameters - -`policy` [ISharedAccessPolicy](./proffer.storage.isharedaccesspolicy)
-The policy. - -#### Returns - -ValueTask<String>
-A shared access signature to read or list the store files. - -#### Exceptions - -[NotSupportedException](https://docs.microsoft.com/en-us/dotnet/api/system.notsupportedexception)
- ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.istoreextensions.md b/docs/code/Storage/proffer.storage.istoreextensions.md deleted file mode 100644 index fc3395c..0000000 --- a/docs/code/Storage/proffer.storage.istoreextensions.md +++ /dev/null @@ -1,269 +0,0 @@ -[`< Back`](./) - ---- - -# IStoreExtensions - -Namespace: Proffer.Storage - -[IStore](./proffer.storage.istore) extension methods. - -```csharp -public static class IStoreExtensions -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [IStoreExtensions](./proffer.storage.istoreextensions) - -## Methods - -### **ListAsync(IStore, String, Boolean, Boolean)** - -Lists the files under . - -```csharp -public static ValueTask ListAsync(IStore store, string path, bool recursive, bool withMetadata) -``` - -#### Parameters - -`store` [IStore](./proffer.storage.istore)
-The store. - -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The path. - -`recursive` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, recurse the listing across folders. - -`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, fetch metadata for each file. - -#### Returns - -ValueTask<IFileReference[]>
- - The list under . - -### **ListAsync(IStore, String, String, Boolean, Boolean)** - -Lists the files under matching the . - -```csharp -public static ValueTask ListAsync(IStore store, string path, string searchPattern, bool recursive, bool withMetadata) -``` - -#### Parameters - -`store` [IStore](./proffer.storage.istore)
-The store. - -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The path. - -`searchPattern` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The search pattern. - -`recursive` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, recurse the listing across folders. - -`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, fetch metadata for each file. - -#### Returns - -ValueTask<IFileReference[]>
- - The list under matching the . - -### **DeleteAsync(IStore, String)** - -Deletes the file. - -```csharp -public static Task DeleteAsync(IStore store, string path) -``` - -#### Parameters - -`store` [IStore](./proffer.storage.istore)
-The store. - -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The file path. - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- - A task that represents the asynchronous operation. - -### **GetAsync(IStore, String, Boolean)** - -Gets the file reference from path. - -```csharp -public static ValueTask GetAsync(IStore store, string path, bool withMetadata) -``` - -#### Parameters - -`store` [IStore](./proffer.storage.istore)
-The store. - -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The file path. - -`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-If set to true, fetch metadata for the file. - -#### Returns - -ValueTask<IFileReference>
- - The at path. - -### **ReadAsync(IStore, String)** - -Reads the file content. - -```csharp -public static ValueTask ReadAsync(IStore store, string path) -``` - -#### Parameters - -`store` [IStore](./proffer.storage.istore)
-The store. - -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The file path. - -#### Returns - -ValueTask<Stream>
- - A containing the file content. - -### **ReadAllBytesAsync(IStore, String)** - -Reads the file content. - -```csharp -public static ValueTask ReadAllBytesAsync(IStore store, string path) -``` - -#### Parameters - -`store` [IStore](./proffer.storage.istore)
-The store. - -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The file path. - -#### Returns - -ValueTask<Byte[]>
- - A containing the file content. - -### **ReadAllTextAsync(IStore, String)** - -Reads the file content. - -```csharp -public static ValueTask ReadAllTextAsync(IStore store, string path) -``` - -#### Parameters - -`store` [IStore](./proffer.storage.istore)
-The store. - -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The file path. - -#### Returns - -ValueTask<String>
- - A containing the file content. - -### **SaveAsync(IStore, Byte[], String, String, OverwritePolicy, IDictionary<String, String>)** - -Saves the file. - -```csharp -public static ValueTask SaveAsync(IStore store, Byte[] data, string path, string contentType, OverwritePolicy overwritePolicy, IDictionary metadata) -``` - -#### Parameters - -`store` [IStore](./proffer.storage.istore)
-The store. - -`data` [Byte[]](https://docs.microsoft.com/en-us/dotnet/api/system.byte)
-The file content. - -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The file path. - -`contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The content-type of the file. - -`overwritePolicy` [OverwritePolicy](./proffer.storage.overwritepolicy)
-The overwrite policy. - -`metadata` [IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
-The metadata. - -#### Returns - -ValueTask<IFileReference>
- - The saved . - -#### Exceptions - -[FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception)
- -### **SaveAsync(IStore, Stream, String, String, OverwritePolicy, IDictionary<String, String>)** - -Saves the file. - -```csharp -public static ValueTask SaveAsync(IStore store, Stream data, string path, string contentType, OverwritePolicy overwritePolicy, IDictionary metadata) -``` - -#### Parameters - -`store` [IStore](./proffer.storage.istore)
-The store. - -`data` [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream)
-The file content. - -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The file path. - -`contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The content-type of the file. - -`overwritePolicy` [OverwritePolicy](./proffer.storage.overwritepolicy)
-The overwrite policy. - -`metadata` [IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
-The metadata. - -#### Returns - -ValueTask<IFileReference>
- - The saved . - -#### Exceptions - -[FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception)
- ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.overwritepolicy.md b/docs/code/Storage/proffer.storage.overwritepolicy.md deleted file mode 100644 index 43ec4a1..0000000 --- a/docs/code/Storage/proffer.storage.overwritepolicy.md +++ /dev/null @@ -1,28 +0,0 @@ -[`< Back`](./) - ---- - -# OverwritePolicy - -Namespace: Proffer.Storage - -Defines an overwrite policy when saving a file to a store. - -```csharp -public enum OverwritePolicy -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ValueType](https://docs.microsoft.com/en-us/dotnet/api/system.valuetype) → [Enum](https://docs.microsoft.com/en-us/dotnet/api/system.enum) → [OverwritePolicy](./proffer.storage.overwritepolicy)
-Implements [IComparable](https://docs.microsoft.com/en-us/dotnet/api/system.icomparable), [IFormattable](https://docs.microsoft.com/en-us/dotnet/api/system.iformattable), [IConvertible](https://docs.microsoft.com/en-us/dotnet/api/system.iconvertible) - -## Fields - -| Name | Value | Description | -| --- | --: | --- | -| Always | 0 | Always overwrite. | -| IfContentModified | 1 | Overwrite only if the file content is modified. | -| Never | 2 | Never overwrite. | - ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.sharedaccesspermissions.md b/docs/code/Storage/proffer.storage.sharedaccesspermissions.md deleted file mode 100644 index 4ec4d6f..0000000 --- a/docs/code/Storage/proffer.storage.sharedaccesspermissions.md +++ /dev/null @@ -1,32 +0,0 @@ -[`< Back`](./) - ---- - -# SharedAccessPermissions - -Namespace: Proffer.Storage - -Specifies the set of possible permissions for a shared access policy. - -```csharp -public enum SharedAccessPermissions -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ValueType](https://docs.microsoft.com/en-us/dotnet/api/system.valuetype) → [Enum](https://docs.microsoft.com/en-us/dotnet/api/system.enum) → [SharedAccessPermissions](./proffer.storage.sharedaccesspermissions)
-Implements [IComparable](https://docs.microsoft.com/en-us/dotnet/api/system.icomparable), [IFormattable](https://docs.microsoft.com/en-us/dotnet/api/system.iformattable), [IConvertible](https://docs.microsoft.com/en-us/dotnet/api/system.iconvertible) - -## Fields - -| Name | Value | Description | -| --- | --: | --- | -| None | 0 | No shared access granted. | -| Read | 1 | Read access granted. | -| Write | 2 | Write access granted. | -| Delete | 4 | Delete access granted. | -| List | 8 | List access granted. | -| Add | 16 | Add access granted. | -| Create | 32 | Create access granted. | - ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.sharedaccesspolicy.md b/docs/code/Storage/proffer.storage.sharedaccesspolicy.md deleted file mode 100644 index 002a6c6..0000000 --- a/docs/code/Storage/proffer.storage.sharedaccesspolicy.md +++ /dev/null @@ -1,68 +0,0 @@ -[`< Back`](./) - ---- - -# SharedAccessPolicy - -Namespace: Proffer.Storage - -Represents a simple shared access policy, which specifies the start time, expiry time, and permissions for a shared access signature. - -```csharp -public class SharedAccessPolicy : ISharedAccessPolicy -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [SharedAccessPolicy](./proffer.storage.sharedaccesspolicy)
-Implements [ISharedAccessPolicy](./proffer.storage.isharedaccesspolicy) - -## Properties - -### **StartTime** - -Gets or sets the start time. - -```csharp -public Nullable StartTime { get; set; } -``` - -#### Property Value - -[Nullable<DateTimeOffset>](https://docs.microsoft.com/en-us/dotnet/api/system.nullable-1)
- -### **ExpiryTime** - -Gets or sets the expiry time. - -```csharp -public Nullable ExpiryTime { get; set; } -``` - -#### Property Value - -[Nullable<DateTimeOffset>](https://docs.microsoft.com/en-us/dotnet/api/system.nullable-1)
- -### **Permissions** - -Gets or sets the permissions. - -```csharp -public SharedAccessPermissions Permissions { get; set; } -``` - -#### Property Value - -[SharedAccessPermissions](./proffer.storage.sharedaccesspermissions)
- -## Constructors - -### **SharedAccessPolicy()** - - - -```csharp -public SharedAccessPolicy() -``` - ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.storageservicecollectionextensions.md b/docs/code/Storage/proffer.storage.storageservicecollectionextensions.md deleted file mode 100644 index 4870d29..0000000 --- a/docs/code/Storage/proffer.storage.storageservicecollectionextensions.md +++ /dev/null @@ -1,85 +0,0 @@ -[`< Back`](./) - ---- - -# StorageServiceCollectionExtensions - -Namespace: Proffer.Storage - -Microsoft.Extensions.DependencyInjection.IServiceCollection extension methods. - -```csharp -public static class StorageServiceCollectionExtensions -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [StorageServiceCollectionExtensions](./proffer.storage.storageservicecollectionextensions) - -## Methods - -### **AddStorage(IServiceCollection)** - -Registers Proffer.Storage services. - -```csharp -public static IServiceCollection AddStorage(IServiceCollection services) -``` - -#### Parameters - -`services` IServiceCollection
-The service collection. - -#### Returns - -IServiceCollection
-The service collection. - -### **AddStorage(IServiceCollection, IConfigurationSection)** - -Registers Proffer.Storage services and configures it with the given section. - -```csharp -public static IServiceCollection AddStorage(IServiceCollection services, IConfigurationSection configurationSection) -``` - -#### Parameters - -`services` IServiceCollection
-The service collection. - -`configurationSection` IConfigurationSection
-The configuration section. - -#### Returns - -IServiceCollection
-The service collection. - -### **AddStorage(IServiceCollection, IConfigurationRoot, String)** - -Registers Proffer.Storage services and configures it from the given at section . - -```csharp -public static IServiceCollection AddStorage(IServiceCollection services, IConfigurationRoot configurationRoot, string sectionName) -``` - -#### Parameters - -`services` IServiceCollection
-The service collection. - -`configurationRoot` IConfigurationRoot
-The configuration root. - -`sectionName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the section. - -#### Returns - -IServiceCollection
- - The service collection. - ---- - -[`< Back`](./) diff --git a/docs/code/Storage/proffer.storage.storebase.md b/docs/code/Storage/proffer.storage.storebase.md deleted file mode 100644 index 4de59f1..0000000 --- a/docs/code/Storage/proffer.storage.storebase.md +++ /dev/null @@ -1,51 +0,0 @@ -[`< Back`](./) - ---- - -# StoreBase - -Namespace: Proffer.Storage - -Abstract base typed store. - -```csharp -public abstract class StoreBase -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [StoreBase](./proffer.storage.storebase) - -## Properties - -### **Store** - -Gets the store. - -```csharp -public IStore Store { get; } -``` - -#### Property Value - -[IStore](./proffer.storage.istore)
- -## Constructors - -### **StoreBase(String, IStorageFactory)** - -Initializes a new instance of the [StoreBase](./proffer.storage.storebase) class. - -```csharp -public StoreBase(string storeName, IStorageFactory storageFactory) -``` - -#### Parameters - -`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the store. - -`storageFactory` [IStorageFactory](./proffer.storage.istoragefactory)
-The storage factory. - ---- - -[`< Back`](./) diff --git a/docs/code/Templating/Handlebars/index.md b/docs/code/Templating/Handlebars/index.md deleted file mode 100644 index 88b5fa0..0000000 --- a/docs/code/Templating/Handlebars/index.md +++ /dev/null @@ -1,11 +0,0 @@ -# Proffer.Templating.Handlebars - -## Proffer.Templating - -[HandlebarsServiceCollectionExtensions](./proffer.templating.handlebarsservicecollectionextensions) - -## Proffer.Templating.Handlebars - -[HandlebarsTemplate](./proffer.templating.handlebars.handlebarstemplate) - -[HandlebarsTemplateProvider](./proffer.templating.handlebars.handlebarstemplateprovider) diff --git a/docs/code/Templating/Handlebars/proffer.templating.handlebars.handlebarstemplateprovider.md b/docs/code/Templating/Handlebars/proffer.templating.handlebars.handlebarstemplateprovider.md deleted file mode 100644 index 8447132..0000000 --- a/docs/code/Templating/Handlebars/proffer.templating.handlebars.handlebarstemplateprovider.md +++ /dev/null @@ -1,82 +0,0 @@ -# HandlebarsTemplateProvider - -Namespace: Proffer.Templating.Handlebars - -A provider handles and compiles templates using N:HandlebarsDotNet. - -```csharp -public class HandlebarsTemplateProvider : Proffer.Templating.ITemplateProvider -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [HandlebarsTemplateProvider](./proffer.templating.handlebars.handlebarstemplateprovider)
-Implements ITemplateProvider - -## Properties - -### **MimeTypes** - -Gets the MIME types. - -```csharp -public ISet MimeTypes { get; } -``` - -#### Property Value - -[ISet<String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.iset-1)
- -### **Extensions** - -Gets the extensions. - -```csharp -public ISet Extensions { get; } -``` - -#### Property Value - -[ISet<String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.iset-1)
- -## Constructors - -### **HandlebarsTemplateProvider()** - -Initializes a new instance of the [HandlebarsTemplateProvider](./proffer.templating.handlebars.handlebarstemplateprovider) class. - -```csharp -public HandlebarsTemplateProvider() -``` - -## Methods - -### **Compile(String)** - -Compiles the specified template content. - -```csharp -public ITemplate Compile(string templateContent) -``` - -#### Parameters - -`templateContent` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-Content of the template. - -#### Returns - -ITemplate
-A compiled . - -### **CreateScope()** - -Creates a template provider scope. - -```csharp -public ITemplateProviderScope CreateScope() -``` - -#### Returns - -ITemplateProviderScope
- - A new templating provider scope. diff --git a/docs/code/Templating/Mustache/index.md b/docs/code/Templating/Mustache/index.md deleted file mode 100644 index deac3e4..0000000 --- a/docs/code/Templating/Mustache/index.md +++ /dev/null @@ -1,11 +0,0 @@ -# Proffer.Templating.Mustache - -## Proffer.Templating - -[MustacheServiceCollectionExtensions](./proffer.templating.mustacheservicecollectionextensions) - -## Proffer.Templating.Mustache - -[MustacheTemplate](./proffer.templating.mustache.mustachetemplate) - -[MustacheTemplateProvider](./proffer.templating.mustache.mustachetemplateprovider) diff --git a/docs/code/Templating/Mustache/proffer.templating.mustache.mustachetemplate.md b/docs/code/Templating/Mustache/proffer.templating.mustache.mustachetemplate.md deleted file mode 100644 index dfab2b8..0000000 --- a/docs/code/Templating/Mustache/proffer.templating.mustache.mustachetemplate.md +++ /dev/null @@ -1,78 +0,0 @@ -# MustacheTemplate - -Namespace: Proffer.Templating.Mustache - -A template reference can be executed on a specific context using N:Mustache. - -```csharp -public class MustacheTemplate : Proffer.Templating.ITemplate -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [MustacheTemplate](./proffer.templating.mustache.mustachetemplate)
-Implements ITemplate - -## Constructors - -### **MustacheTemplate(String)** - -Initializes a new instance of the [MustacheTemplate](./proffer.templating.mustache.mustachetemplate) class. - -```csharp -public MustacheTemplate(string templateContent) -``` - -#### Parameters - -`templateContent` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-Content of the template. - -## Methods - -### **Apply(Object)** - -Applies the specified context on the template. - -```csharp -public string Apply(object context) -``` - -#### Parameters - -`context` [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)
-The context. - -#### Returns - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- - The templated result. - -#### Exceptions - -Proffer.Templating.InvalidContextException
- -### **Apply(Object, IFormatProvider)** - -Applies the specified context on the template with format provider. - -```csharp -public string Apply(object context, IFormatProvider formatProvider) -``` - -#### Parameters - -`context` [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)
-The context. - -`formatProvider` [IFormatProvider](https://docs.microsoft.com/en-us/dotnet/api/system.iformatprovider)
-The format provider. - -#### Returns - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- - The templated result. - -#### Exceptions - -Proffer.Templating.InvalidContextException
diff --git a/docs/code/Templating/Mustache/proffer.templating.mustache.mustachetemplateprovider.md b/docs/code/Templating/Mustache/proffer.templating.mustache.mustachetemplateprovider.md deleted file mode 100644 index dc24e61..0000000 --- a/docs/code/Templating/Mustache/proffer.templating.mustache.mustachetemplateprovider.md +++ /dev/null @@ -1,103 +0,0 @@ -# MustacheTemplateProvider - -Namespace: Proffer.Templating.Mustache - -A provider handles and compiles templates using N:Mustache. - -```csharp -public class MustacheTemplateProvider : Proffer.Templating.ITemplateProvider, Proffer.Templating.ITemplateProviderScope -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [MustacheTemplateProvider](./proffer.templating.mustache.mustachetemplateprovider)
-Implements ITemplateProvider, ITemplateProviderScope - -## Properties - -### **MimeTypes** - -Gets the MIME types. - -```csharp -public ISet MimeTypes { get; } -``` - -#### Property Value - -[ISet<String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.iset-1)
- -### **Extensions** - -Gets the extensions. - -```csharp -public ISet Extensions { get; } -``` - -#### Property Value - -[ISet<String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.iset-1)
- -## Constructors - -### **MustacheTemplateProvider()** - -Initializes a new instance of the [MustacheTemplateProvider](./proffer.templating.mustache.mustachetemplateprovider) class. - -```csharp -public MustacheTemplateProvider() -``` - -## Methods - -### **Compile(String)** - -Compiles the specified template content. - -```csharp -public ITemplate Compile(string templateContent) -``` - -#### Parameters - -`templateContent` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-Content of the template. - -#### Returns - -ITemplate
- - A new compiled from the content. - -### **CreateScope()** - -Creates a template provider scope. - -```csharp -public ITemplateProviderScope CreateScope() -``` - -#### Returns - -ITemplateProviderScope
- - A new templating provider scope. - -### **RegisterPartial(String, String)** - -Registers a partial template with a name. - -```csharp -public void RegisterPartial(string name, string template) -``` - -#### Parameters - -`name` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name. - -`template` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The template. - -#### Exceptions - -[NotSupportedException](https://docs.microsoft.com/en-us/dotnet/api/system.notsupportedexception)
diff --git a/docs/code/Templating/index.md b/docs/code/Templating/index.md deleted file mode 100644 index 028a4b4..0000000 --- a/docs/code/Templating/index.md +++ /dev/null @@ -1,33 +0,0 @@ -# Proffer.Templating - -## Proffer.Templating - -[InvalidContextException](./proffer.templating.invalidcontextexception) - -[ITemplate](./proffer.templating.itemplate) - -[ITemplateLoader](./proffer.templating.itemplateloader) - -[ITemplateLoaderFactory](./proffer.templating.itemplateloaderfactory) - -[ITemplateProvider](./proffer.templating.itemplateprovider) - -[ITemplateProviderScope](./proffer.templating.itemplateproviderscope) - -[TemplateCollectionBase](./proffer.templating.templatecollectionbase) - -[TemplateCollectionBase<TStore>](./proffer.templating.templatecollectionbase-1) - -[TemplatingServiceCollectionExtensions](./proffer.templating.templatingservicecollectionextensions) - -## Proffer.Templating.Exceptions - -[ProviderNotFoundException](./proffer.templating.exceptions.providernotfoundexception) - -[TemplateNotFoundException](./proffer.templating.exceptions.templatenotfoundexception) - -## Proffer.Templating.Internal - -[TemplateLoader](./proffer.templating.internal.templateloader) - -[TemplateLoaderFactory](./proffer.templating.internal.templateloaderfactory) diff --git a/docs/code/Templating/proffer.templating.exceptions.providernotfoundexception.md b/docs/code/Templating/proffer.templating.exceptions.providernotfoundexception.md deleted file mode 100644 index 11ba9e3..0000000 --- a/docs/code/Templating/proffer.templating.exceptions.providernotfoundexception.md +++ /dev/null @@ -1,131 +0,0 @@ -# ProviderNotFoundException - -Namespace: Proffer.Templating.Exceptions - -Thrown when a matching provider was not found for a given template. - -```csharp -public class ProviderNotFoundException : System.Exception, System.Runtime.Serialization.ISerializable -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [ProviderNotFoundException](./proffer.templating.exceptions.providernotfoundexception)
-Implements [ISerializable](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.serialization.iserializable) - -## Properties - -### **TargetSite** - - - -```csharp -public MethodBase TargetSite { get; } -``` - -#### Property Value - -[MethodBase](https://docs.microsoft.com/en-us/dotnet/api/system.reflection.methodbase)
- -### **StackTrace** - - - -```csharp -public string StackTrace { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Message** - - - -```csharp -public string Message { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Data** - - - -```csharp -public IDictionary Data { get; } -``` - -#### Property Value - -[IDictionary](https://docs.microsoft.com/en-us/dotnet/api/system.collections.idictionary)
- -### **InnerException** - - - -```csharp -public Exception InnerException { get; } -``` - -#### Property Value - -[Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception)
- -### **HelpLink** - - - -```csharp -public string HelpLink { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Source** - - - -```csharp -public string Source { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **HResult** - - - -```csharp -public int HResult { get; set; } -``` - -#### Property Value - -[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
- -## Constructors - -### **ProviderNotFoundException(String, String, String)** - -Initializes a new instance of the [ProviderNotFoundException](./proffer.templating.exceptions.providernotfoundexception) class. - -```csharp -public ProviderNotFoundException(string templateName, string extension, string contentType) -``` - -#### Parameters - -`templateName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the unmatched template. - -`extension` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The extension of the unmatched template. - -`contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The MIME type of the unmatched template. diff --git a/docs/code/Templating/proffer.templating.exceptions.templatenotfoundexception.md b/docs/code/Templating/proffer.templating.exceptions.templatenotfoundexception.md deleted file mode 100644 index 4ffffe5..0000000 --- a/docs/code/Templating/proffer.templating.exceptions.templatenotfoundexception.md +++ /dev/null @@ -1,125 +0,0 @@ -# TemplateNotFoundException - -Namespace: Proffer.Templating.Exceptions - -Thrown when a template was not found in the store. - -```csharp -public class TemplateNotFoundException : System.Exception, System.Runtime.Serialization.ISerializable -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [TemplateNotFoundException](./proffer.templating.exceptions.templatenotfoundexception)
-Implements [ISerializable](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.serialization.iserializable) - -## Properties - -### **TargetSite** - - - -```csharp -public MethodBase TargetSite { get; } -``` - -#### Property Value - -[MethodBase](https://docs.microsoft.com/en-us/dotnet/api/system.reflection.methodbase)
- -### **StackTrace** - - - -```csharp -public string StackTrace { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Message** - - - -```csharp -public string Message { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Data** - - - -```csharp -public IDictionary Data { get; } -``` - -#### Property Value - -[IDictionary](https://docs.microsoft.com/en-us/dotnet/api/system.collections.idictionary)
- -### **InnerException** - - - -```csharp -public Exception InnerException { get; } -``` - -#### Property Value - -[Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception)
- -### **HelpLink** - - - -```csharp -public string HelpLink { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Source** - - - -```csharp -public string Source { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **HResult** - - - -```csharp -public int HResult { get; set; } -``` - -#### Property Value - -[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
- -## Constructors - -### **TemplateNotFoundException(String)** - -Initializes a new instance of the [TemplateNotFoundException](./proffer.templating.exceptions.templatenotfoundexception) class. - -```csharp -public TemplateNotFoundException(string templateName) -``` - -#### Parameters - -`templateName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the missing template. diff --git a/docs/code/Templating/proffer.templating.invalidcontextexception.md b/docs/code/Templating/proffer.templating.invalidcontextexception.md deleted file mode 100644 index c272aec..0000000 --- a/docs/code/Templating/proffer.templating.invalidcontextexception.md +++ /dev/null @@ -1,125 +0,0 @@ -# InvalidContextException - -Namespace: Proffer.Templating - -Thrown when the generation context is invalid for a template. - -```csharp -public class InvalidContextException : System.Exception, System.Runtime.Serialization.ISerializable -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [InvalidContextException](./proffer.templating.invalidcontextexception)
-Implements [ISerializable](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.serialization.iserializable) - -## Properties - -### **TargetSite** - - - -```csharp -public MethodBase TargetSite { get; } -``` - -#### Property Value - -[MethodBase](https://docs.microsoft.com/en-us/dotnet/api/system.reflection.methodbase)
- -### **StackTrace** - - - -```csharp -public string StackTrace { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Message** - - - -```csharp -public string Message { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Data** - - - -```csharp -public IDictionary Data { get; } -``` - -#### Property Value - -[IDictionary](https://docs.microsoft.com/en-us/dotnet/api/system.collections.idictionary)
- -### **InnerException** - - - -```csharp -public Exception InnerException { get; } -``` - -#### Property Value - -[Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception)
- -### **HelpLink** - - - -```csharp -public string HelpLink { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Source** - - - -```csharp -public string Source { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **HResult** - - - -```csharp -public int HResult { get; set; } -``` - -#### Property Value - -[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
- -## Constructors - -### **InvalidContextException(Exception)** - -Initializes a new instance of the [InvalidContextException](./proffer.templating.invalidcontextexception) class. - -```csharp -public InvalidContextException(Exception innerException) -``` - -#### Parameters - -`innerException` [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception)
-The inner exception. diff --git a/docs/code/Templating/proffer.templating.itemplate.md b/docs/code/Templating/proffer.templating.itemplate.md deleted file mode 100644 index 52e80c2..0000000 --- a/docs/code/Templating/proffer.templating.itemplate.md +++ /dev/null @@ -1,59 +0,0 @@ -# ITemplate - -Namespace: Proffer.Templating - -A template reference can be executed on a specific context using an Apply method. - -```csharp -public interface ITemplate -``` - -## Methods - -### **Apply(Object)** - -Applies the specified context on the template. - -```csharp -string Apply(object context) -``` - -#### Parameters - -`context` [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)
-The context. - -#### Returns - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The templated result. - -#### Exceptions - -[InvalidContextException](./proffer.templating.invalidcontextexception)
- -### **Apply(Object, IFormatProvider)** - -Applies the specified context on the template with format provider. - -```csharp -string Apply(object context, IFormatProvider formatProvider) -``` - -#### Parameters - -`context` [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)
-The context. - -`formatProvider` [IFormatProvider](https://docs.microsoft.com/en-us/dotnet/api/system.iformatprovider)
-The format provider. - -#### Returns - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- - The templated result. - -#### Exceptions - -[InvalidContextException](./proffer.templating.invalidcontextexception)
diff --git a/docs/code/Templating/proffer.templating.itemplateloader.md b/docs/code/Templating/proffer.templating.itemplateloader.md deleted file mode 100644 index 34671a4..0000000 --- a/docs/code/Templating/proffer.templating.itemplateloader.md +++ /dev/null @@ -1,29 +0,0 @@ -# ITemplateLoader - -Namespace: Proffer.Templating - -Loads template references. - -```csharp -public interface ITemplateLoader -``` - -## Methods - -### **GetTemplate(String)** - -Gets a template by name. - -```csharp -Task GetTemplate(string name) -``` - -#### Parameters - -`name` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The template name. - -#### Returns - -[Task<ITemplate>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)
-The matching . diff --git a/docs/code/Templating/proffer.templating.itemplateloaderfactory.md b/docs/code/Templating/proffer.templating.itemplateloaderfactory.md deleted file mode 100644 index 8a50631..0000000 --- a/docs/code/Templating/proffer.templating.itemplateloaderfactory.md +++ /dev/null @@ -1,50 +0,0 @@ -# ITemplateLoaderFactory - -Namespace: Proffer.Templating - -Creates [ITemplateLoader](./proffer.templating.itemplateloader) from Proffer.Storage.IStore. - -```csharp -public interface ITemplateLoaderFactory -``` - -## Methods - -### **Create(IStore)** - -Creates a template loader from the specified store. - -```csharp -ITemplateLoader Create(IStore store) -``` - -#### Parameters - -`store` IStore
-The store. - -#### Returns - -[ITemplateLoader](./proffer.templating.itemplateloader)
-A that loads templates from the given . - -### **Create(IStore, String)** - -Creates a template loader from the specified store with the specified cache scope. - -```csharp -ITemplateLoader Create(IStore store, string scope) -``` - -#### Parameters - -`store` IStore
-The store. - -`scope` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The cache scope. - -#### Returns - -[ITemplateLoader](./proffer.templating.itemplateloader)
-A that loads templates from the given . diff --git a/docs/code/Templating/proffer.templating.itemplateprovider.md b/docs/code/Templating/proffer.templating.itemplateprovider.md deleted file mode 100644 index 2bb75c1..0000000 --- a/docs/code/Templating/proffer.templating.itemplateprovider.md +++ /dev/null @@ -1,50 +0,0 @@ -# ITemplateProvider - -Namespace: Proffer.Templating - -A provider handles and compiles templates using a particular templating library. - -```csharp -public interface ITemplateProvider -``` - -## Properties - -### **MimeTypes** - -Gets the MIME types. - -```csharp -public abstract ISet MimeTypes { get; } -``` - -#### Property Value - -[ISet<String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.iset-1)
- -### **Extensions** - -Gets the extensions. - -```csharp -public abstract ISet Extensions { get; } -``` - -#### Property Value - -[ISet<String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.iset-1)
- -## Methods - -### **CreateScope()** - -Creates a template provider scope. - -```csharp -ITemplateProviderScope CreateScope() -``` - -#### Returns - -[ITemplateProviderScope](./proffer.templating.itemplateproviderscope)
-A new templating provider scope. diff --git a/docs/code/Templating/proffer.templating.itemplateproviderscope.md b/docs/code/Templating/proffer.templating.itemplateproviderscope.md deleted file mode 100644 index 306c2d1..0000000 --- a/docs/code/Templating/proffer.templating.itemplateproviderscope.md +++ /dev/null @@ -1,49 +0,0 @@ -# ITemplateProviderScope - -Namespace: Proffer.Templating - -Templating scope for a configured provider. - -```csharp -public interface ITemplateProviderScope -``` - -## Methods - -### **Compile(String)** - -Compiles the specified template content. - -```csharp -ITemplate Compile(string templateContent) -``` - -#### Parameters - -`templateContent` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-Content of the template. - -#### Returns - -[ITemplate](./proffer.templating.itemplate)
-A new compiled from the content. - -### **RegisterPartial(String, String)** - -Registers a partial template with a name. - -```csharp -void RegisterPartial(string name, string template) -``` - -#### Parameters - -`name` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name. - -`template` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The template. - -#### Exceptions - -[NotSupportedException](https://docs.microsoft.com/en-us/dotnet/api/system.notsupportedexception)
diff --git a/docs/code/Templating/proffer.templating.templatecollectionbase-1.md b/docs/code/Templating/proffer.templating.templatecollectionbase-1.md deleted file mode 100644 index d8b0d0b..0000000 --- a/docs/code/Templating/proffer.templating.templatecollectionbase-1.md +++ /dev/null @@ -1,48 +0,0 @@ -# TemplateCollectionBase<TStore> - -Namespace: Proffer.Templating - -Abstract base class to load and apply templates from a typed . - -```csharp -public abstract class TemplateCollectionBase : TemplateCollectionBase -``` - -#### Type Parameters - -`TStore`
-The type of the store. - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [TemplateCollectionBase](./proffer.templating.templatecollectionbase) → [TemplateCollectionBase<TStore>](./proffer.templating.templatecollectionbase-1) - -## Properties - -### **Loader** - -Gets the templates loader. - -```csharp -public ITemplateLoader Loader { get; } -``` - -#### Property Value - -[ITemplateLoader](./proffer.templating.itemplateloader)
- -## Constructors - -### **TemplateCollectionBase(TStore, ITemplateLoaderFactory)** - -Initializes a new instance of the [TemplateCollectionBase<TStore>](./proffer.templating.templatecollectionbase-1) class. - -```csharp -public TemplateCollectionBase(TStore store, ITemplateLoaderFactory templateLoaderFactory) -``` - -#### Parameters - -`store` TStore
-The typed store. - -`templateLoaderFactory` [ITemplateLoaderFactory](./proffer.templating.itemplateloaderfactory)
-The template loader factory. diff --git a/docs/code/Templating/proffer.templating.templatecollectionbase.md b/docs/code/Templating/proffer.templating.templatecollectionbase.md deleted file mode 100644 index 8dd1cc1..0000000 --- a/docs/code/Templating/proffer.templating.templatecollectionbase.md +++ /dev/null @@ -1,94 +0,0 @@ -# TemplateCollectionBase - -Namespace: Proffer.Templating - -Abstract base class to load and apply templates from a named Proffer.Storage.IStore. - -```csharp -public abstract class TemplateCollectionBase -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [TemplateCollectionBase](./proffer.templating.templatecollectionbase) - -## Properties - -### **Loader** - -Gets the templates loader. - -```csharp -public ITemplateLoader Loader { get; } -``` - -#### Property Value - -[ITemplateLoader](./proffer.templating.itemplateloader)
- -## Constructors - -### **TemplateCollectionBase(String, IStorageFactory, ITemplateLoaderFactory)** - -Initializes a new instance of the [TemplateCollectionBase](./proffer.templating.templatecollectionbase) class. - -```csharp -public TemplateCollectionBase(string storeName, IStorageFactory storageFactory, ITemplateLoaderFactory templateLoaderFactory) -``` - -#### Parameters - -`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The name of the store. - -`storageFactory` IStorageFactory
-The storage factory. - -`templateLoaderFactory` [ITemplateLoaderFactory](./proffer.templating.itemplateloaderfactory)
-The template loader factory. - -## Methods - -### **LoadAndApplyTemplate(String, Object)** - -Loads the template and applies context. - -```csharp -protected Task LoadAndApplyTemplate(string templatePath, object context) -``` - -#### Parameters - -`templatePath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The template path. - -`context` [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)
-The context. - -#### Returns - -[Task<String>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)
-The templated result. - -### **LoadAndApplyTemplate(String, Object, IFormatProvider)** - -Loads the template and applies context. - -```csharp -protected Task LoadAndApplyTemplate(string templatePath, object context, IFormatProvider formatProvider) -``` - -#### Parameters - -`templatePath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The template path. - -`context` [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)
-The context. - -`formatProvider` [IFormatProvider](https://docs.microsoft.com/en-us/dotnet/api/system.iformatprovider)
-The format provider. - -#### Returns - -[Task<String>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)
- - The templated result. diff --git a/docs/code/index.md b/docs/code/index.md index 7ebd314..75703c7 100644 --- a/docs/code/index.md +++ b/docs/code/index.md @@ -2,36 +2,36 @@ ## Core libraries -[Proffer](./Core) +[Proffer](./core) -[Proffer.Azure](./Core/Azure) +[Proffer.Azure](./core/azure) ## Storage -[Proffer.Storage](./Storage) +[Proffer.Storage](./storage) -[Proffer.Storage.Azure.Blobs](./Storage/AzureBlobs) +[Proffer.Storage.Azure.Blobs](./storage/azure/blobs) -[Proffer.Storage.FileSystem](./Storage/FileSystem) +[Proffer.Storage.FileSystem](./storage/filesystem) -[Proffer.Storage.FileSystem.Properties.Json](./Storage/Properties/Json) +[Proffer.Storage.FileSystem.Properties.Json](./storage/filesystem/properties/json) -[Proffer.Storage.FileSystem.Server](./Storage/FileSystem/Server) +[Proffer.Storage.FileSystem.Server](./storage/filesystem/server) ## Templating -[Proffer.Templating](./Templating) +[Proffer.Templating](./templating) -[Proffer.Templating.Handlebars](./Templating/Handlebars) +[Proffer.Templating.Handlebars](./templating/handlebars) -[Proffer.Templating.Mustache](./Templating/Mustache) +[Proffer.Templating.Mustache](./templating/mustache) ## Email -[Proffer.Email](./Email) +[Proffer.Email](./email) -[Proffer.Email.Smtp](./Email/Smtp) +[Proffer.Email.Smtp](./email/smtp) -[Proffer.Email.SendGrid](./Email/SendGrid) +[Proffer.Email.SendGrid](./email/sendgrid) -[Proffer.Email.InMemory](./Email/InMemory) +[Proffer.Email.InMemory](./email/in-memory) diff --git a/src/Directory.Build.props b/src/Directory.Build.props index e037e93..f59ca68 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -10,6 +10,7 @@ latest true en-US + true \ No newline at end of file diff --git a/src/Directory.Build.targets b/src/Directory.Build.targets index 64d18d7..da70410 100644 --- a/src/Directory.Build.targets +++ b/src/Directory.Build.targets @@ -1,6 +1,6 @@ - + - + \ No newline at end of file diff --git a/src/Proffer.Azure/Proffer.Azure.csproj b/src/Proffer.Azure/Proffer.Azure.csproj index 3741be4..ea50d79 100644 --- a/src/Proffer.Azure/Proffer.Azure.csproj +++ b/src/Proffer.Azure/Proffer.Azure.csproj @@ -1,10 +1,8 @@ - Proffer.Azure - Proffer.Azure Proffer Azure common abstractions. - Core/Azure + core/azure diff --git a/src/Proffer.Email.InMemory/Proffer.Email.InMemory.csproj b/src/Proffer.Email.InMemory/Proffer.Email.InMemory.csproj index 24493f1..d6b1ba5 100644 --- a/src/Proffer.Email.InMemory/Proffer.Email.InMemory.csproj +++ b/src/Proffer.Email.InMemory/Proffer.Email.InMemory.csproj @@ -1,10 +1,8 @@ - Proffer.Email.InMemory - Proffer.Email.InMemory In-memory provider for Proffer.Email abstractions. - Email/InMemory + email/in-memory diff --git a/src/Proffer.Email.SendGrid/Proffer.Email.SendGrid.csproj b/src/Proffer.Email.SendGrid/Proffer.Email.SendGrid.csproj index be602e0..60b3de1 100644 --- a/src/Proffer.Email.SendGrid/Proffer.Email.SendGrid.csproj +++ b/src/Proffer.Email.SendGrid/Proffer.Email.SendGrid.csproj @@ -1,10 +1,8 @@ - Proffer.Email.SendGrid - Proffer.Email.SendGrid SendGrid provider for Proffer.Email abstractions. - Email/SendGrid + email/sendgrid diff --git a/src/Proffer.Email.Smtp/Proffer.Email.Smtp.csproj b/src/Proffer.Email.Smtp/Proffer.Email.Smtp.csproj index d08efa5..beb864b 100644 --- a/src/Proffer.Email.Smtp/Proffer.Email.Smtp.csproj +++ b/src/Proffer.Email.Smtp/Proffer.Email.Smtp.csproj @@ -1,10 +1,8 @@ - Proffer.Email.Smtp - Proffer.Email.Smtp SMTP provider for Proffer.Email abstractions. - Email/Smtp + email/smtp diff --git a/src/Proffer.Email/Proffer.Email.csproj b/src/Proffer.Email/Proffer.Email.csproj index 98311f8..fe68a2f 100644 --- a/src/Proffer.Email/Proffer.Email.csproj +++ b/src/Proffer.Email/Proffer.Email.csproj @@ -4,7 +4,7 @@ Proffer.Email Proffer.Email Templated email sending abstractions with providers. - Email + email diff --git a/src/Proffer.Storage.Azure.Blobs/Proffer.Storage.Azure.Blobs.csproj b/src/Proffer.Storage.Azure.Blobs/Proffer.Storage.Azure.Blobs.csproj index f21e86a..0529c92 100644 --- a/src/Proffer.Storage.Azure.Blobs/Proffer.Storage.Azure.Blobs.csproj +++ b/src/Proffer.Storage.Azure.Blobs/Proffer.Storage.Azure.Blobs.csproj @@ -1,10 +1,8 @@ - Proffer.Storage.Azure.Blobs - Proffer.Storage.Azure.Blobs Azure Blobs provider for Proffer.Storage abstractions. - Storage/AzureBlobs + storage/azure/blobs diff --git a/src/Proffer.Storage.FileSystem.Properties.Json/Proffer.Storage.FileSystem.Properties.Json.csproj b/src/Proffer.Storage.FileSystem.Properties.Json/Proffer.Storage.FileSystem.Properties.Json.csproj index 64b6ca2..8e54f85 100644 --- a/src/Proffer.Storage.FileSystem.Properties.Json/Proffer.Storage.FileSystem.Properties.Json.csproj +++ b/src/Proffer.Storage.FileSystem.Properties.Json/Proffer.Storage.FileSystem.Properties.Json.csproj @@ -1,10 +1,8 @@ - Proffer.Storage.FileSystem.Properties.Json - Proffer.Storage.FileSystem.Properties.Json File System based extended properties storage provider for the FileSystem provider. - Storage/FileSystem/Properties/Json + storage/filesystem/properties/json diff --git a/src/Proffer.Storage.FileSystem.Server/Proffer.Storage.FileSystem.Server.csproj b/src/Proffer.Storage.FileSystem.Server/Proffer.Storage.FileSystem.Server.csproj index 8b943ea..25a96d6 100644 --- a/src/Proffer.Storage.FileSystem.Server/Proffer.Storage.FileSystem.Server.csproj +++ b/src/Proffer.Storage.FileSystem.Server/Proffer.Storage.FileSystem.Server.csproj @@ -1,10 +1,8 @@ - Proffer.Storage.FileSystem.Server - Proffer.Storage.FileSystem.Server File Server based on the Proffer.Storage.FileSystem provider. - Storage/FileSystem/Server + storage/filesystem/server diff --git a/src/Proffer.Storage.FileSystem/Proffer.Storage.FileSystem.csproj b/src/Proffer.Storage.FileSystem/Proffer.Storage.FileSystem.csproj index 7571efb..c76af50 100644 --- a/src/Proffer.Storage.FileSystem/Proffer.Storage.FileSystem.csproj +++ b/src/Proffer.Storage.FileSystem/Proffer.Storage.FileSystem.csproj @@ -1,10 +1,8 @@ - Proffer.Storage.FileSystem - Proffer.Storage.FileSystem FileSystem provider for Proffer.Storage abstractions. - Storage/FileSystem + storage/filesystem diff --git a/src/Proffer.Storage/Proffer.Storage.csproj b/src/Proffer.Storage/Proffer.Storage.csproj index ea8d196..269c19f 100644 --- a/src/Proffer.Storage/Proffer.Storage.csproj +++ b/src/Proffer.Storage/Proffer.Storage.csproj @@ -1,10 +1,8 @@ - Proffer.Storage - Proffer.Storage File Storage abstractions with providers. - Storage + storage diff --git a/src/Proffer.Templating.Handlebars/Proffer.Templating.Handlebars.csproj b/src/Proffer.Templating.Handlebars/Proffer.Templating.Handlebars.csproj index f2b8a6b..a57c967 100644 --- a/src/Proffer.Templating.Handlebars/Proffer.Templating.Handlebars.csproj +++ b/src/Proffer.Templating.Handlebars/Proffer.Templating.Handlebars.csproj @@ -1,10 +1,8 @@ - Proffer.Templating.Handlebars - Proffer.Templating.Handlebars Handlebars provider for Proffer.Templating abstractions. - Templating/Handlebars + templating/handlebars diff --git a/src/Proffer.Templating.Mustache/Proffer.Templating.Mustache.csproj b/src/Proffer.Templating.Mustache/Proffer.Templating.Mustache.csproj index 782b767..07b8f6b 100644 --- a/src/Proffer.Templating.Mustache/Proffer.Templating.Mustache.csproj +++ b/src/Proffer.Templating.Mustache/Proffer.Templating.Mustache.csproj @@ -1,10 +1,8 @@ - Proffer.Templating.Mustache - Proffer.Templating.Mustache Mustache.js provider for Proffer.Templating abstractions. - Templating/Mustache + templating/mustache diff --git a/src/Proffer.Templating/Proffer.Templating.csproj b/src/Proffer.Templating/Proffer.Templating.csproj index 344d33a..3a81700 100644 --- a/src/Proffer.Templating/Proffer.Templating.csproj +++ b/src/Proffer.Templating/Proffer.Templating.csproj @@ -1,10 +1,8 @@ - Proffer.Templating - Proffer.Templating Templating abstractions with providers. - Templating + templating diff --git a/src/Proffer/Proffer.csproj b/src/Proffer/Proffer.csproj index 49f61c8..864ea93 100644 --- a/src/Proffer/Proffer.csproj +++ b/src/Proffer/Proffer.csproj @@ -1,10 +1,8 @@ - Proffer - Proffer .NET Core basic abstractions to configuration-driven providers. - Core + core From ba115641656b37ab3a48f75612c29212dea80978 Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Sat, 22 May 2021 00:24:45 +0200 Subject: [PATCH 25/45] New folder hierarchy --- docs/core/api.md | 17 + docs/core/azure/api.md | 5 + ...zure.configuration.iazurestorageoptions.md | 35 ++ ...ffer.configuration.inamedelementoptions.md | 23 + .../proffer.configuration.ioptionerror.md | 35 ++ .../proffer.configuration.iprovideroptions.md | 25 + .../core/proffer.configuration.optionerror.md | 48 ++ .../proffer.configuration.provideroptions.md | 48 ++ docs/core/proffer.equalitycomparerbase-1.md | 78 +++ docs/email/api.md | 41 ++ docs/email/in-memory/api.md | 17 + ...email.inmemory.iinmemoryemailrepository.md | 38 ++ .../proffer.email.inmemory.inmemoryemail.md | 131 +++++ ...er.email.inmemory.inmemoryemailprovider.md | 137 +++++ ...mail.inmemory.inmemoryemailprovidertype.md | 62 +++ ....email.inmemory.inmemoryemailrepository.md | 51 ++ ...nmemoryemailservicecollectionextensions.md | 31 ++ docs/email/proffer.email.emailoptions.md | 81 +++ .../proffer.email.emailprovideroptions.md | 48 ++ ....email.emailservicecollectionextensions.md | 59 +++ docs/email/proffer.email.emailtemplatetype.md | 20 + docs/email/proffer.email.iemailaddress.md | 35 ++ docs/email/proffer.email.iemailattachment.md | 71 +++ docs/email/proffer.email.iemailprovider.md | 119 +++++ .../proffer.email.iemailprovideroptions.md | 35 ++ .../email/proffer.email.iemailprovidertype.md | 43 ++ docs/email/proffer.email.iemailsender.md | 428 ++++++++++++++++ .../proffer.email.internal.emailaddress.md | 64 +++ ...l.internal.emailaddressequalitycomparer.md | 43 ++ ...rnal.emailaddressstrictequalitycomparer.md | 43 ++ .../proffer.email.internal.emailattachment.md | 125 +++++ ...nternal.emailattachmentequalitycomparer.md | 43 ++ .../proffer.email.internal.emailsender.md | 477 ++++++++++++++++++ .../proffer.email.mockupexceptionsoptions.md | 47 ++ docs/email/proffer.email.mockupoptions.md | 59 +++ docs/email/sendgrid/api.md | 11 + ...er.email.sendgrid.sendgridemailprovider.md | 148 ++++++ ...mail.sendgrid.sendgridemailprovidertype.md | 57 +++ ...offer.email.servicecollectionextensions.md | 31 ++ docs/email/smtp/api.md | 11 + .../proffer.email.smtp.smtpemailprovider.md | 144 ++++++ ...roffer.email.smtp.smtpemailprovidertype.md | 62 +++ ...il.smtpemailservicecollectionextensions.md | 31 ++ docs/storage/api.md | 75 +++ docs/storage/azure/blobs/api.md | 31 ++ ...e.azure.blobs.azureblobsstorageprovider.md | 75 +++ ...fer.storage.azure.blobs.azureblobsstore.md | 325 ++++++++++++ ...s.configuration.azureblobsparsedoptions.md | 123 +++++ ...configuration.azureblobsprovideroptions.md | 72 +++ ...figuration.azureblobsscopedstoreoptions.md | 120 +++++ ...bs.configuration.azureblobsstoreoptions.md | 133 +++++ ...blobs.internal.azureblobsfileproperties.md | 146 ++++++ ....blobs.internal.azureblobsfilereference.md | 221 ++++++++ ...internal.azureblobslistdirectorywrapper.md | 138 +++++ ...lobs.internal.azureblobslistfilewrapper.md | 67 +++ ...blobsstorageservicecollectionextensions.md | 31 ++ docs/storage/filesystem/api.md | 35 ++ ...m.configuration.filesystemparsedoptions.md | 127 +++++ ...configuration.filesystemprovideroptions.md | 60 +++ ...figuration.filesystemscopedstoreoptions.md | 120 +++++ ...em.configuration.filesystemstoreoptions.md | 133 +++++ ...ge.filesystem.filesystemstorageprovider.md | 81 +++ ...ffer.storage.filesystem.filesystemstore.md | 331 ++++++++++++ ....filesystem.iextendedpropertiesprovider.md | 56 ++ ...esystem.internal.fileextendedproperties.md | 83 +++ ...ystem.internal.filesystemfileproperties.md | 116 +++++ ...system.internal.filesystemfilereference.md | 234 +++++++++ ...r.storage.filesystem.ipublicurlprovider.md | 32 ++ ...filesystem.noextendedpropertiesprovider.md | 69 +++ ...ystemstorageservicecollectionextensions.md | 52 ++ .../storage/filesystem/properties/json/api.md | 13 + ...es.json.filesystempropertiesjsonoptions.md | 35 ++ ...son.internal.extendedpropertiesprovider.md | 76 +++ ...opertiesjsonservicecollectionextensions.md | 35 ++ docs/storage/filesystem/server/api.md | 15 + ...erver.filesystemstorageservermiddleware.md | 54 ++ ...m.server.filesystemstorageserveroptions.md | 59 +++ ...ystem.server.internal.publicurlprovider.md | 51 ++ ...fer.storage.servicecollectionextensions.md | 52 ++ ...offer.storage.configuration.accesslevel.md | 20 + ...e.configuration.configurationextensions.md | 217 ++++++++ ....storage.configuration.iparsedoptions-3.md | 117 +++++ ...orage.configuration.iscopedstoreoptions.md | 25 + ...fer.storage.configuration.istoreoptions.md | 85 ++++ ...torage.configuration.scopedstoreoptions.md | 96 ++++ ...er.storage.configuration.storageoptions.md | 161 ++++++ ...ffer.storage.configuration.storeoptions.md | 125 +++++ ...age.exceptions.badproviderconfiguration.md | 128 +++++ ....exceptions.badscopedstoreconfiguration.md | 131 +++++ ...torage.exceptions.badstoreconfiguration.md | 156 ++++++ ...e.exceptions.filealreadyexistsexception.md | 128 +++++ ...ge.exceptions.providernotfoundexception.md | 125 +++++ ...orage.exceptions.storenotfoundexception.md | 125 +++++ .../proffer.storage.ifileproperties.md | 95 ++++ .../storage/proffer.storage.ifilereference.md | 171 +++++++ ...age.internal.configureprovideroptions-4.md | 62 +++ ...er.storage.internal.genericstoreproxy-1.md | 343 +++++++++++++ ...r.storage.internal.privatefilereference.md | 41 ++ ...proffer.storage.internal.storagefactory.md | 192 +++++++ ....storage.internal.storageproviderbase-4.md | 152 ++++++ .../proffer.storage.iprivatefilereference.md | 23 + .../proffer.storage.isharedaccesspolicy.md | 47 ++ .../proffer.storage.istoragefactory.md | 171 +++++++ .../proffer.storage.istorageprovider.md | 98 ++++ docs/storage/proffer.storage.istore-1.md | 16 + docs/storage/proffer.storage.istore.md | 301 +++++++++++ .../proffer.storage.istoreextensions.md | 261 ++++++++++ .../proffer.storage.overwritepolicy.md | 20 + ...proffer.storage.sharedaccesspermissions.md | 24 + .../proffer.storage.sharedaccesspolicy.md | 60 +++ ...rage.storageservicecollectionextensions.md | 77 +++ docs/storage/proffer.storage.storebase.md | 43 ++ docs/templating/api.md | 33 ++ docs/templating/handlebars/api.md | 11 + ...emplating.handlebars.handlebarstemplate.md | 86 ++++ ...g.handlebars.handlebarstemplateprovider.md | 82 +++ ...g.handlebarsservicecollectionextensions.md | 31 ++ docs/templating/mustache/api.md | 11 + ...er.templating.mustache.mustachetemplate.md | 78 +++ ...ating.mustache.mustachetemplateprovider.md | 103 ++++ ...ing.mustacheservicecollectionextensions.md | 31 ++ ...ng.exceptions.providernotfoundexception.md | 131 +++++ ...ng.exceptions.templatenotfoundexception.md | 125 +++++ ...ffer.templating.internal.templateloader.md | 54 ++ ...mplating.internal.templateloaderfactory.md | 73 +++ ...ffer.templating.invalidcontextexception.md | 125 +++++ .../proffer.templating.itemplate.md | 59 +++ .../proffer.templating.itemplateloader.md | 29 ++ ...offer.templating.itemplateloaderfactory.md | 50 ++ .../proffer.templating.itemplateprovider.md | 50 ++ ...offer.templating.itemplateproviderscope.md | 49 ++ ...fer.templating.templatecollectionbase-1.md | 48 ++ ...offer.templating.templatecollectionbase.md | 94 ++++ ...g.templatingservicecollectionextensions.md | 31 ++ src/Directory.Build.targets | 2 +- 135 files changed, 11854 insertions(+), 1 deletion(-) create mode 100644 docs/core/api.md create mode 100644 docs/core/azure/api.md create mode 100644 docs/core/azure/proffer.azure.configuration.iazurestorageoptions.md create mode 100644 docs/core/proffer.configuration.inamedelementoptions.md create mode 100644 docs/core/proffer.configuration.ioptionerror.md create mode 100644 docs/core/proffer.configuration.iprovideroptions.md create mode 100644 docs/core/proffer.configuration.optionerror.md create mode 100644 docs/core/proffer.configuration.provideroptions.md create mode 100644 docs/core/proffer.equalitycomparerbase-1.md create mode 100644 docs/email/api.md create mode 100644 docs/email/in-memory/api.md create mode 100644 docs/email/in-memory/proffer.email.inmemory.iinmemoryemailrepository.md create mode 100644 docs/email/in-memory/proffer.email.inmemory.inmemoryemail.md create mode 100644 docs/email/in-memory/proffer.email.inmemory.inmemoryemailprovider.md create mode 100644 docs/email/in-memory/proffer.email.inmemory.inmemoryemailprovidertype.md create mode 100644 docs/email/in-memory/proffer.email.inmemory.inmemoryemailrepository.md create mode 100644 docs/email/in-memory/proffer.email.inmemoryemailservicecollectionextensions.md create mode 100644 docs/email/proffer.email.emailoptions.md create mode 100644 docs/email/proffer.email.emailprovideroptions.md create mode 100644 docs/email/proffer.email.emailservicecollectionextensions.md create mode 100644 docs/email/proffer.email.emailtemplatetype.md create mode 100644 docs/email/proffer.email.iemailaddress.md create mode 100644 docs/email/proffer.email.iemailattachment.md create mode 100644 docs/email/proffer.email.iemailprovider.md create mode 100644 docs/email/proffer.email.iemailprovideroptions.md create mode 100644 docs/email/proffer.email.iemailprovidertype.md create mode 100644 docs/email/proffer.email.iemailsender.md create mode 100644 docs/email/proffer.email.internal.emailaddress.md create mode 100644 docs/email/proffer.email.internal.emailaddressequalitycomparer.md create mode 100644 docs/email/proffer.email.internal.emailaddressstrictequalitycomparer.md create mode 100644 docs/email/proffer.email.internal.emailattachment.md create mode 100644 docs/email/proffer.email.internal.emailattachmentequalitycomparer.md create mode 100644 docs/email/proffer.email.internal.emailsender.md create mode 100644 docs/email/proffer.email.mockupexceptionsoptions.md create mode 100644 docs/email/proffer.email.mockupoptions.md create mode 100644 docs/email/sendgrid/api.md create mode 100644 docs/email/sendgrid/proffer.email.sendgrid.sendgridemailprovider.md create mode 100644 docs/email/sendgrid/proffer.email.sendgrid.sendgridemailprovidertype.md create mode 100644 docs/email/sendgrid/proffer.email.servicecollectionextensions.md create mode 100644 docs/email/smtp/api.md create mode 100644 docs/email/smtp/proffer.email.smtp.smtpemailprovider.md create mode 100644 docs/email/smtp/proffer.email.smtp.smtpemailprovidertype.md create mode 100644 docs/email/smtp/proffer.email.smtpemailservicecollectionextensions.md create mode 100644 docs/storage/api.md create mode 100644 docs/storage/azure/blobs/api.md create mode 100644 docs/storage/azure/blobs/proffer.storage.azure.blobs.azureblobsstorageprovider.md create mode 100644 docs/storage/azure/blobs/proffer.storage.azure.blobs.azureblobsstore.md create mode 100644 docs/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md create mode 100644 docs/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md create mode 100644 docs/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md create mode 100644 docs/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md create mode 100644 docs/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md create mode 100644 docs/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobsfilereference.md create mode 100644 docs/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md create mode 100644 docs/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md create mode 100644 docs/storage/azure/blobs/proffer.storage.azureblobsstorageservicecollectionextensions.md create mode 100644 docs/storage/filesystem/api.md create mode 100644 docs/storage/filesystem/proffer.storage.filesystem.configuration.filesystemparsedoptions.md create mode 100644 docs/storage/filesystem/proffer.storage.filesystem.configuration.filesystemprovideroptions.md create mode 100644 docs/storage/filesystem/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md create mode 100644 docs/storage/filesystem/proffer.storage.filesystem.configuration.filesystemstoreoptions.md create mode 100644 docs/storage/filesystem/proffer.storage.filesystem.filesystemstorageprovider.md create mode 100644 docs/storage/filesystem/proffer.storage.filesystem.filesystemstore.md create mode 100644 docs/storage/filesystem/proffer.storage.filesystem.iextendedpropertiesprovider.md create mode 100644 docs/storage/filesystem/proffer.storage.filesystem.internal.fileextendedproperties.md create mode 100644 docs/storage/filesystem/proffer.storage.filesystem.internal.filesystemfileproperties.md create mode 100644 docs/storage/filesystem/proffer.storage.filesystem.internal.filesystemfilereference.md create mode 100644 docs/storage/filesystem/proffer.storage.filesystem.ipublicurlprovider.md create mode 100644 docs/storage/filesystem/proffer.storage.filesystem.noextendedpropertiesprovider.md create mode 100644 docs/storage/filesystem/proffer.storage.filesystemstorageservicecollectionextensions.md create mode 100644 docs/storage/filesystem/properties/json/api.md create mode 100644 docs/storage/filesystem/properties/json/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md create mode 100644 docs/storage/filesystem/properties/json/proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md create mode 100644 docs/storage/filesystem/properties/json/proffer.storage.filesystempropertiesjsonservicecollectionextensions.md create mode 100644 docs/storage/filesystem/server/api.md create mode 100644 docs/storage/filesystem/server/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md create mode 100644 docs/storage/filesystem/server/proffer.storage.filesystem.server.filesystemstorageserveroptions.md create mode 100644 docs/storage/filesystem/server/proffer.storage.filesystem.server.internal.publicurlprovider.md create mode 100644 docs/storage/filesystem/server/proffer.storage.servicecollectionextensions.md create mode 100644 docs/storage/proffer.storage.configuration.accesslevel.md create mode 100644 docs/storage/proffer.storage.configuration.configurationextensions.md create mode 100644 docs/storage/proffer.storage.configuration.iparsedoptions-3.md create mode 100644 docs/storage/proffer.storage.configuration.iscopedstoreoptions.md create mode 100644 docs/storage/proffer.storage.configuration.istoreoptions.md create mode 100644 docs/storage/proffer.storage.configuration.scopedstoreoptions.md create mode 100644 docs/storage/proffer.storage.configuration.storageoptions.md create mode 100644 docs/storage/proffer.storage.configuration.storeoptions.md create mode 100644 docs/storage/proffer.storage.exceptions.badproviderconfiguration.md create mode 100644 docs/storage/proffer.storage.exceptions.badscopedstoreconfiguration.md create mode 100644 docs/storage/proffer.storage.exceptions.badstoreconfiguration.md create mode 100644 docs/storage/proffer.storage.exceptions.filealreadyexistsexception.md create mode 100644 docs/storage/proffer.storage.exceptions.providernotfoundexception.md create mode 100644 docs/storage/proffer.storage.exceptions.storenotfoundexception.md create mode 100644 docs/storage/proffer.storage.ifileproperties.md create mode 100644 docs/storage/proffer.storage.ifilereference.md create mode 100644 docs/storage/proffer.storage.internal.configureprovideroptions-4.md create mode 100644 docs/storage/proffer.storage.internal.genericstoreproxy-1.md create mode 100644 docs/storage/proffer.storage.internal.privatefilereference.md create mode 100644 docs/storage/proffer.storage.internal.storagefactory.md create mode 100644 docs/storage/proffer.storage.internal.storageproviderbase-4.md create mode 100644 docs/storage/proffer.storage.iprivatefilereference.md create mode 100644 docs/storage/proffer.storage.isharedaccesspolicy.md create mode 100644 docs/storage/proffer.storage.istoragefactory.md create mode 100644 docs/storage/proffer.storage.istorageprovider.md create mode 100644 docs/storage/proffer.storage.istore-1.md create mode 100644 docs/storage/proffer.storage.istore.md create mode 100644 docs/storage/proffer.storage.istoreextensions.md create mode 100644 docs/storage/proffer.storage.overwritepolicy.md create mode 100644 docs/storage/proffer.storage.sharedaccesspermissions.md create mode 100644 docs/storage/proffer.storage.sharedaccesspolicy.md create mode 100644 docs/storage/proffer.storage.storageservicecollectionextensions.md create mode 100644 docs/storage/proffer.storage.storebase.md create mode 100644 docs/templating/api.md create mode 100644 docs/templating/handlebars/api.md create mode 100644 docs/templating/handlebars/proffer.templating.handlebars.handlebarstemplate.md create mode 100644 docs/templating/handlebars/proffer.templating.handlebars.handlebarstemplateprovider.md create mode 100644 docs/templating/handlebars/proffer.templating.handlebarsservicecollectionextensions.md create mode 100644 docs/templating/mustache/api.md create mode 100644 docs/templating/mustache/proffer.templating.mustache.mustachetemplate.md create mode 100644 docs/templating/mustache/proffer.templating.mustache.mustachetemplateprovider.md create mode 100644 docs/templating/mustache/proffer.templating.mustacheservicecollectionextensions.md create mode 100644 docs/templating/proffer.templating.exceptions.providernotfoundexception.md create mode 100644 docs/templating/proffer.templating.exceptions.templatenotfoundexception.md create mode 100644 docs/templating/proffer.templating.internal.templateloader.md create mode 100644 docs/templating/proffer.templating.internal.templateloaderfactory.md create mode 100644 docs/templating/proffer.templating.invalidcontextexception.md create mode 100644 docs/templating/proffer.templating.itemplate.md create mode 100644 docs/templating/proffer.templating.itemplateloader.md create mode 100644 docs/templating/proffer.templating.itemplateloaderfactory.md create mode 100644 docs/templating/proffer.templating.itemplateprovider.md create mode 100644 docs/templating/proffer.templating.itemplateproviderscope.md create mode 100644 docs/templating/proffer.templating.templatecollectionbase-1.md create mode 100644 docs/templating/proffer.templating.templatecollectionbase.md create mode 100644 docs/templating/proffer.templating.templatingservicecollectionextensions.md diff --git a/docs/core/api.md b/docs/core/api.md new file mode 100644 index 0000000..d464005 --- /dev/null +++ b/docs/core/api.md @@ -0,0 +1,17 @@ +# Proffer + +## Proffer + +[EqualityComparerBase<T>](./proffer.equalitycomparerbase-1) + +## Proffer.Configuration + +[INamedElementOptions](./proffer.configuration.inamedelementoptions) + +[IOptionError](./proffer.configuration.ioptionerror) + +[IProviderOptions](./proffer.configuration.iprovideroptions) + +[OptionError](./proffer.configuration.optionerror) + +[ProviderOptions](./proffer.configuration.provideroptions) diff --git a/docs/core/azure/api.md b/docs/core/azure/api.md new file mode 100644 index 0000000..7d21032 --- /dev/null +++ b/docs/core/azure/api.md @@ -0,0 +1,5 @@ +# Proffer.Azure + +## Proffer.Azure.Configuration + +[IAzureStorageOptions](./proffer.azure.configuration.iazurestorageoptions) diff --git a/docs/core/azure/proffer.azure.configuration.iazurestorageoptions.md b/docs/core/azure/proffer.azure.configuration.iazurestorageoptions.md new file mode 100644 index 0000000..8095c24 --- /dev/null +++ b/docs/core/azure/proffer.azure.configuration.iazurestorageoptions.md @@ -0,0 +1,35 @@ +# IAzureStorageOptions + +Namespace: Proffer.Azure.Configuration + +Proffer options pointing to an Azure Storage account. + +```csharp +public interface IAzureStorageOptions +``` + +## Properties + +### **ConnectionString** + +Gets or sets the connection string. + +```csharp +public abstract string ConnectionString { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ConnectionStringName** + +Gets or sets the name of the connection string to reference. + +```csharp +public abstract string ConnectionStringName { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
diff --git a/docs/core/proffer.configuration.inamedelementoptions.md b/docs/core/proffer.configuration.inamedelementoptions.md new file mode 100644 index 0000000..9e83b8d --- /dev/null +++ b/docs/core/proffer.configuration.inamedelementoptions.md @@ -0,0 +1,23 @@ +# INamedElementOptions + +Namespace: Proffer.Configuration + +A named element from the options (provider or scope). + +```csharp +public interface INamedElementOptions +``` + +## Properties + +### **Name** + +Gets or sets the name. + +```csharp +public abstract string Name { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
diff --git a/docs/core/proffer.configuration.ioptionerror.md b/docs/core/proffer.configuration.ioptionerror.md new file mode 100644 index 0000000..f946538 --- /dev/null +++ b/docs/core/proffer.configuration.ioptionerror.md @@ -0,0 +1,35 @@ +# IOptionError + +Namespace: Proffer.Configuration + +An error reported from the options validation. + +```csharp +public interface IOptionError +``` + +## Properties + +### **PropertyName** + +Gets the name of the faulted property. + +```csharp +public abstract string PropertyName { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ErrorMessage** + +Gets the error message. + +```csharp +public abstract string ErrorMessage { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
diff --git a/docs/core/proffer.configuration.iprovideroptions.md b/docs/core/proffer.configuration.iprovideroptions.md new file mode 100644 index 0000000..0d80f25 --- /dev/null +++ b/docs/core/proffer.configuration.iprovideroptions.md @@ -0,0 +1,25 @@ +# IProviderOptions + +Namespace: Proffer.Configuration + +Options of a provider. + +```csharp +public interface IProviderOptions : INamedElementOptions +``` + +Implements [INamedElementOptions](./proffer.configuration.inamedelementoptions) + +## Properties + +### **Type** + +Gets the type. + +```csharp +public abstract string Type { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
diff --git a/docs/core/proffer.configuration.optionerror.md b/docs/core/proffer.configuration.optionerror.md new file mode 100644 index 0000000..1422375 --- /dev/null +++ b/docs/core/proffer.configuration.optionerror.md @@ -0,0 +1,48 @@ +# OptionError + +Namespace: Proffer.Configuration + +A generic error reported from the options validation. + +```csharp +public class OptionError : IOptionError +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [OptionError](./proffer.configuration.optionerror)
+Implements [IOptionError](./proffer.configuration.ioptionerror) + +## Properties + +### **PropertyName** + +Gets the name of the faulted property. + +```csharp +public string PropertyName { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ErrorMessage** + +Gets the error message. + +```csharp +public string ErrorMessage { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Constructors + +### **OptionError()** + + + +```csharp +public OptionError() +``` diff --git a/docs/core/proffer.configuration.provideroptions.md b/docs/core/proffer.configuration.provideroptions.md new file mode 100644 index 0000000..157af47 --- /dev/null +++ b/docs/core/proffer.configuration.provideroptions.md @@ -0,0 +1,48 @@ +# ProviderOptions + +Namespace: Proffer.Configuration + +Standard options for a provider. + +```csharp +public class ProviderOptions : IProviderOptions, INamedElementOptions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ProviderOptions](./proffer.configuration.provideroptions)
+Implements [IProviderOptions](./proffer.configuration.iprovideroptions), [INamedElementOptions](./proffer.configuration.inamedelementoptions) + +## Properties + +### **Name** + +Gets or sets the name. + +```csharp +public string Name { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Type** + +Gets the type. + +```csharp +public string Type { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Constructors + +### **ProviderOptions()** + + + +```csharp +public ProviderOptions() +``` diff --git a/docs/core/proffer.equalitycomparerbase-1.md b/docs/core/proffer.equalitycomparerbase-1.md new file mode 100644 index 0000000..a495316 --- /dev/null +++ b/docs/core/proffer.equalitycomparerbase-1.md @@ -0,0 +1,78 @@ +# EqualityComparerBase<T> + +Namespace: Proffer + +Implements [IEqualityComparer<T>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.iequalitycomparer-1) by comparing individual equality components from child class. + +```csharp +public abstract class EqualityComparerBase : , System.Collections.IEqualityComparer, +``` + +#### Type Parameters + +`T`
+The type of objects to compare. + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → EqualityComparer<T> → [EqualityComparerBase<T>](./proffer.equalitycomparerbase-1)
+Implements [IEqualityComparer](https://docs.microsoft.com/en-us/dotnet/api/system.collections.iequalitycomparer), IEqualityComparer<T> + +## Methods + +### **Equals(T, T)** + +When overridden in a derived class, determines whether two objects of type T are equal. + +```csharp +public bool Equals(T x, T y) +``` + +#### Parameters + +`x` T
+The first object to compare. + +`y` T
+The second object to compare. + +#### Returns + +[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+ + true if the specified objects are equal; otherwise, false. + +### **GetHashCode(T)** + +Returns a hash code for this instance. + +```csharp +public int GetHashCode(T obj) +``` + +#### Parameters + +`obj` T
+The object. + +#### Returns + +[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
+ + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + +### **GetEqualityComponents(T)** + +Gets the object's components that participate in equality comparisons. + +```csharp +protected abstract IEnumerable GetEqualityComponents(T obj) +``` + +#### Parameters + +`obj` T
+The object. + +#### Returns + +[IEnumerable<Object>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+An enumerable containing the properties values. diff --git a/docs/email/api.md b/docs/email/api.md new file mode 100644 index 0000000..15001e0 --- /dev/null +++ b/docs/email/api.md @@ -0,0 +1,41 @@ +# Proffer.Email + +## Proffer.Email + +[EmailOptions](./proffer.email.emailoptions) + +[EmailProviderOptions](./proffer.email.emailprovideroptions) + +[EmailServiceCollectionExtensions](./proffer.email.emailservicecollectionextensions) + +[EmailTemplateType](./proffer.email.emailtemplatetype) + +[IEmailAddress](./proffer.email.iemailaddress) + +[IEmailAttachment](./proffer.email.iemailattachment) + +[IEmailProvider](./proffer.email.iemailprovider) + +[IEmailProviderOptions](./proffer.email.iemailprovideroptions) + +[IEmailProviderType](./proffer.email.iemailprovidertype) + +[IEmailSender](./proffer.email.iemailsender) + +[MockupExceptionsOptions](./proffer.email.mockupexceptionsoptions) + +[MockupOptions](./proffer.email.mockupoptions) + +## Proffer.Email.Internal + +[EmailAddress](./proffer.email.internal.emailaddress) + +[EmailAddressEqualityComparer](./proffer.email.internal.emailaddressequalitycomparer) + +[EmailAddressStrictEqualityComparer](./proffer.email.internal.emailaddressstrictequalitycomparer) + +[EmailAttachment](./proffer.email.internal.emailattachment) + +[EmailAttachmentEqualityComparer](./proffer.email.internal.emailattachmentequalitycomparer) + +[EmailSender](./proffer.email.internal.emailsender) diff --git a/docs/email/in-memory/api.md b/docs/email/in-memory/api.md new file mode 100644 index 0000000..934357b --- /dev/null +++ b/docs/email/in-memory/api.md @@ -0,0 +1,17 @@ +# Proffer.Email.InMemory + +## Proffer.Email + +[InMemoryEmailServiceCollectionExtensions](./proffer.email.inmemoryemailservicecollectionextensions) + +## Proffer.Email.InMemory + +[IInMemoryEmailRepository](./proffer.email.inmemory.iinmemoryemailrepository) + +[InMemoryEmail](./proffer.email.inmemory.inmemoryemail) + +[InMemoryEmailProvider](./proffer.email.inmemory.inmemoryemailprovider) + +[InMemoryEmailProviderType](./proffer.email.inmemory.inmemoryemailprovidertype) + +[InMemoryEmailRepository](./proffer.email.inmemory.inmemoryemailrepository) diff --git a/docs/email/in-memory/proffer.email.inmemory.iinmemoryemailrepository.md b/docs/email/in-memory/proffer.email.inmemory.iinmemoryemailrepository.md new file mode 100644 index 0000000..35c7731 --- /dev/null +++ b/docs/email/in-memory/proffer.email.inmemory.iinmemoryemailrepository.md @@ -0,0 +1,38 @@ +# IInMemoryEmailRepository + +Namespace: Proffer.Email.InMemory + +A repository in memory to hold sent emails through the provider. + +```csharp +public interface IInMemoryEmailRepository +``` + +## Properties + +### **Store** + +Gets the emails store. + +```csharp +public abstract IReadOnlyCollection Store { get; } +``` + +#### Property Value + +[IReadOnlyCollection<InMemoryEmail>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlycollection-1)
+ +## Methods + +### **Save(InMemoryEmail)** + +Saves the specified email in the store. + +```csharp +void Save(InMemoryEmail email) +``` + +#### Parameters + +`email` [InMemoryEmail](./proffer.email.inmemory.inmemoryemail)
+The email. diff --git a/docs/email/in-memory/proffer.email.inmemory.inmemoryemail.md b/docs/email/in-memory/proffer.email.inmemory.inmemoryemail.md new file mode 100644 index 0000000..439e66b --- /dev/null +++ b/docs/email/in-memory/proffer.email.inmemory.inmemoryemail.md @@ -0,0 +1,131 @@ +# InMemoryEmail + +Namespace: Proffer.Email.InMemory + +An object to retain the values of the email that would have been sent. + +```csharp +public class InMemoryEmail +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [InMemoryEmail](./proffer.email.inmemory.inmemoryemail) + +## Properties + +### **Subject** + +Gets or sets the subject. + +```csharp +public string Subject { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **MessageText** + +Gets or sets the message as plain-text. + +```csharp +public string MessageText { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **MessageHtml** + +Gets or sets the message as HTML. + +```csharp +public string MessageHtml { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **To** + +Gets or sets the email recipients. + +```csharp +public IEmailAddress[] To { get; set; } +``` + +#### Property Value + +IEmailAddress[]
+ +### **Cc** + +Gets or sets the email recipients. + +```csharp +public IEmailAddress[] Cc { get; set; } +``` + +#### Property Value + +IEmailAddress[]
+ +### **Bcc** + +Gets or sets the BCC email recipients. + +```csharp +public IEmailAddress[] Bcc { get; set; } +``` + +#### Property Value + +IEmailAddress[]
+ +### **From** + +Gets or sets the sender email address. + +```csharp +public IEmailAddress From { get; set; } +``` + +#### Property Value + +IEmailAddress
+ +### **ReplyTo** + +Gets or sets the reply-to email address. + +```csharp +public IEmailAddress ReplyTo { get; set; } +``` + +#### Property Value + +IEmailAddress
+ +### **Attachments** + +Gets or sets the attachments files. + +```csharp +public IEnumerable Attachments { get; set; } +``` + +#### Property Value + +[IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+ +## Constructors + +### **InMemoryEmail()** + + + +```csharp +public InMemoryEmail() +``` diff --git a/docs/email/in-memory/proffer.email.inmemory.inmemoryemailprovider.md b/docs/email/in-memory/proffer.email.inmemory.inmemoryemailprovider.md new file mode 100644 index 0000000..39b8ecd --- /dev/null +++ b/docs/email/in-memory/proffer.email.inmemory.inmemoryemailprovider.md @@ -0,0 +1,137 @@ +# InMemoryEmailProvider + +Namespace: Proffer.Email.InMemory + +A provider which does not send any email but holds it in a collection in memory. + +```csharp +public class InMemoryEmailProvider : Proffer.Email.IEmailProvider +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [InMemoryEmailProvider](./proffer.email.inmemory.inmemoryemailprovider)
+Implements IEmailProvider + +## Constructors + +### **InMemoryEmailProvider(IInMemoryEmailRepository)** + +Initializes a new instance of the [InMemoryEmailProvider](./proffer.email.inmemory.inmemoryemailprovider) class. + +```csharp +public InMemoryEmailProvider(IInMemoryEmailRepository inMemoryEmailRepository) +``` + +#### Parameters + +`inMemoryEmailRepository` [IInMemoryEmailRepository](./proffer.email.inmemory.iinmemoryemailrepository)
+The in-memory email repository. + +## Methods + +### **SendEmailAsync(IEmailAddress, IEnumerable<IEmailAddress>, String, String, String)** + +Sends an email. + +```csharp +public Task SendEmailAsync(IEmailAddress from, IEnumerable recipients, string subject, string bodyText, string bodyHtml) +``` + +#### Parameters + +`from` IEmailAddress
+The sender email address. + +`recipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The email recipients. + +`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The subject. + +`bodyText` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as plain text. + +`bodyHtml` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as HTML. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendEmailAsync(IEmailAddress, IEnumerable<IEmailAddress>, String, String, String, IEnumerable<IEmailAttachment>)** + +Sends an email. + +```csharp +public Task SendEmailAsync(IEmailAddress from, IEnumerable recipients, string subject, string bodyText, string bodyHtml, IEnumerable attachments) +``` + +#### Parameters + +`from` IEmailAddress
+The sender email address. + +`recipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The email recipients. + +`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The subject. + +`bodyText` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as plain text. + +`bodyHtml` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as HTML. + +`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The file attachments. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendEmailAsync(IEmailAddress, IEnumerable<IEmailAddress>, IEnumerable<IEmailAddress>, IEnumerable<IEmailAddress>, String, String, String, IEnumerable<IEmailAttachment>, IEmailAddress)** + +Sends an email. + +```csharp +public Task SendEmailAsync(IEmailAddress from, IEnumerable recipients, IEnumerable ccRecipients, IEnumerable bccRecipients, string subject, string bodyText, string bodyHtml, IEnumerable attachments, IEmailAddress replyTo) +``` + +#### Parameters + +`from` IEmailAddress
+The sender email address. + +`recipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The email recipients. + +`ccRecipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The CC email recipients. + +`bccRecipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The BCC email recipients. + +`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The subject. + +`bodyText` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as plain text. + +`bodyHtml` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as HTML. + +`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The file attachments. + +`replyTo` IEmailAddress
+The reply-to email address. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. diff --git a/docs/email/in-memory/proffer.email.inmemory.inmemoryemailprovidertype.md b/docs/email/in-memory/proffer.email.inmemory.inmemoryemailprovidertype.md new file mode 100644 index 0000000..be7d3aa --- /dev/null +++ b/docs/email/in-memory/proffer.email.inmemory.inmemoryemailprovidertype.md @@ -0,0 +1,62 @@ +# InMemoryEmailProviderType + +Namespace: Proffer.Email.InMemory + +Builds [InMemoryEmailProvider](./proffer.email.inmemory.inmemoryemailprovider). + +```csharp +public class InMemoryEmailProviderType : Proffer.Email.IEmailProviderType +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [InMemoryEmailProviderType](./proffer.email.inmemory.inmemoryemailprovidertype)
+Implements IEmailProviderType + +## Properties + +### **Name** + +Gets the name. + +```csharp +public string Name { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Constructors + +### **InMemoryEmailProviderType(IInMemoryEmailRepository)** + +Initializes a new instance of the [InMemoryEmailProviderType](./proffer.email.inmemory.inmemoryemailprovidertype) class. + +```csharp +public InMemoryEmailProviderType(IInMemoryEmailRepository inMemoryEmailRepository) +``` + +#### Parameters + +`inMemoryEmailRepository` [IInMemoryEmailRepository](./proffer.email.inmemory.iinmemoryemailrepository)
+The in-memory email repository. + +## Methods + +### **BuildProvider(IEmailProviderOptions)** + +Builds the provider. + +```csharp +public IEmailProvider BuildProvider(IEmailProviderOptions providerOptions) +``` + +#### Parameters + +`providerOptions` IEmailProviderOptions
+The provider options. + +#### Returns + +IEmailProvider
+ + A new . diff --git a/docs/email/in-memory/proffer.email.inmemory.inmemoryemailrepository.md b/docs/email/in-memory/proffer.email.inmemory.inmemoryemailrepository.md new file mode 100644 index 0000000..8c964d6 --- /dev/null +++ b/docs/email/in-memory/proffer.email.inmemory.inmemoryemailrepository.md @@ -0,0 +1,51 @@ +# InMemoryEmailRepository + +Namespace: Proffer.Email.InMemory + +A repository in memory to hold sent emails through the provider. + +```csharp +public class InMemoryEmailRepository : IInMemoryEmailRepository +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [InMemoryEmailRepository](./proffer.email.inmemory.inmemoryemailrepository)
+Implements [IInMemoryEmailRepository](./proffer.email.inmemory.iinmemoryemailrepository) + +## Properties + +### **Store** + +Gets the emails store. + +```csharp +public IReadOnlyCollection Store { get; } +``` + +#### Property Value + +[IReadOnlyCollection<InMemoryEmail>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlycollection-1)
+ +## Constructors + +### **InMemoryEmailRepository()** + + + +```csharp +public InMemoryEmailRepository() +``` + +## Methods + +### **Save(InMemoryEmail)** + +Saves the specified email in the store. + +```csharp +public void Save(InMemoryEmail email) +``` + +#### Parameters + +`email` [InMemoryEmail](./proffer.email.inmemory.inmemoryemail)
+The email. diff --git a/docs/email/in-memory/proffer.email.inmemoryemailservicecollectionextensions.md b/docs/email/in-memory/proffer.email.inmemoryemailservicecollectionextensions.md new file mode 100644 index 0000000..855016c --- /dev/null +++ b/docs/email/in-memory/proffer.email.inmemoryemailservicecollectionextensions.md @@ -0,0 +1,31 @@ +# InMemoryEmailServiceCollectionExtensions + +Namespace: Proffer.Email + +Microsoft.Extensions.DependencyInjection.IServiceCollection extension methods. + +```csharp +public static class InMemoryEmailServiceCollectionExtensions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [InMemoryEmailServiceCollectionExtensions](./proffer.email.inmemoryemailservicecollectionextensions) + +## Methods + +### **AddInMemoryEmail(IServiceCollection)** + +Registers the Proffer.Email services to an in-memory collection. + +```csharp +public static IServiceCollection AddInMemoryEmail(IServiceCollection services) +``` + +#### Parameters + +`services` IServiceCollection
+The service collection. + +#### Returns + +IServiceCollection
+The service collection. diff --git a/docs/email/proffer.email.emailoptions.md b/docs/email/proffer.email.emailoptions.md new file mode 100644 index 0000000..10e3326 --- /dev/null +++ b/docs/email/proffer.email.emailoptions.md @@ -0,0 +1,81 @@ +# EmailOptions + +Namespace: Proffer.Email + +The Proffer.Email options with providers. + +```csharp +public class EmailOptions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EmailOptions](./proffer.email.emailoptions) + +## Fields + +### **DefaultConfigurationSectionName** + +The default configuration section name. + +```csharp +public static string DefaultConfigurationSectionName; +``` + +## Properties + +### **Provider** + +Gets or sets the provider options. + +```csharp +public EmailProviderOptions Provider { get; set; } +``` + +#### Property Value + +[EmailProviderOptions](./proffer.email.emailprovideroptions)
+ +### **DefaultSender** + +Gets or sets the default sender email address. + +```csharp +public EmailAddress DefaultSender { get; set; } +``` + +#### Property Value + +[EmailAddress](./proffer.email.internal.emailaddress)
+ +### **TemplateStorage** + +Gets or sets the template storage key to load templates from. + +```csharp +public string TemplateStorage { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Mockup** + +Gets or sets the mockup options. + +```csharp +public MockupOptions Mockup { get; set; } +``` + +#### Property Value + +[MockupOptions](./proffer.email.mockupoptions)
+ +## Constructors + +### **EmailOptions()** + + + +```csharp +public EmailOptions() +``` diff --git a/docs/email/proffer.email.emailprovideroptions.md b/docs/email/proffer.email.emailprovideroptions.md new file mode 100644 index 0000000..e42ad67 --- /dev/null +++ b/docs/email/proffer.email.emailprovideroptions.md @@ -0,0 +1,48 @@ +# EmailProviderOptions + +Namespace: Proffer.Email + +Generic options for a [IEmailProvider](./proffer.email.iemailprovider). + +```csharp +public class EmailProviderOptions : IEmailProviderOptions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EmailProviderOptions](./proffer.email.emailprovideroptions)
+Implements [IEmailProviderOptions](./proffer.email.iemailprovideroptions) + +## Properties + +### **Type** + +Gets or sets the type of the provider. + +```csharp +public string Type { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Parameters** + +Gets or sets the provider parameters. + +```csharp +public Dictionary Parameters { get; set; } +``` + +#### Property Value + +[Dictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.dictionary-2)
+ +## Constructors + +### **EmailProviderOptions()** + + + +```csharp +public EmailProviderOptions() +``` diff --git a/docs/email/proffer.email.emailservicecollectionextensions.md b/docs/email/proffer.email.emailservicecollectionextensions.md new file mode 100644 index 0000000..55256bc --- /dev/null +++ b/docs/email/proffer.email.emailservicecollectionextensions.md @@ -0,0 +1,59 @@ +# EmailServiceCollectionExtensions + +Namespace: Proffer.Email + +Microsoft.Extensions.DependencyInjection.IServiceCollection extension methods. + +```csharp +public static class EmailServiceCollectionExtensions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EmailServiceCollectionExtensions](./proffer.email.emailservicecollectionextensions) + +## Methods + +### **AddEmail(IServiceCollection, IConfigurationRoot, String)** + +Registers Proffer.Email services and configures it from the given at section . + +```csharp +public static IServiceCollection AddEmail(IServiceCollection services, IConfigurationRoot configurationRoot, string sectionName) +``` + +#### Parameters + +`services` IServiceCollection
+The service collection. + +`configurationRoot` IConfigurationRoot
+The configuration root. + +`sectionName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the section. + +#### Returns + +IServiceCollection
+ + The service collection. + +### **AddEmail(IServiceCollection, IConfigurationSection)** + +Registers Proffer.Email services and configures it with the given section. + +```csharp +public static IServiceCollection AddEmail(IServiceCollection services, IConfigurationSection configurationSection) +``` + +#### Parameters + +`services` IServiceCollection
+The service collection. + +`configurationSection` IConfigurationSection
+The configuration section. + +#### Returns + +IServiceCollection
+The service collection. diff --git a/docs/email/proffer.email.emailtemplatetype.md b/docs/email/proffer.email.emailtemplatetype.md new file mode 100644 index 0000000..b1235ed --- /dev/null +++ b/docs/email/proffer.email.emailtemplatetype.md @@ -0,0 +1,20 @@ +# EmailTemplateType + +Namespace: Proffer.Email + +Type of template for a templated email. + +```csharp +public enum EmailTemplateType +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ValueType](https://docs.microsoft.com/en-us/dotnet/api/system.valuetype) → [Enum](https://docs.microsoft.com/en-us/dotnet/api/system.enum) → [EmailTemplateType](./proffer.email.emailtemplatetype)
+Implements [IComparable](https://docs.microsoft.com/en-us/dotnet/api/system.icomparable), [IFormattable](https://docs.microsoft.com/en-us/dotnet/api/system.iformattable), [IConvertible](https://docs.microsoft.com/en-us/dotnet/api/system.iconvertible) + +## Fields + +| Name | Value | Description | +| --- | --: | --- | +| Subject | 0 | The templated subject. | +| BodyHtml | 1 | The templated body as HTML. | +| BodyText | 2 | The templated body as plain-text. | diff --git a/docs/email/proffer.email.iemailaddress.md b/docs/email/proffer.email.iemailaddress.md new file mode 100644 index 0000000..8f50d89 --- /dev/null +++ b/docs/email/proffer.email.iemailaddress.md @@ -0,0 +1,35 @@ +# IEmailAddress + +Namespace: Proffer.Email + +An email address with its optional display name. + +```csharp +public interface IEmailAddress +``` + +## Properties + +### **Email** + +Gets the email. + +```csharp +public abstract string Email { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **DisplayName** + +Gets the display name. + +```csharp +public abstract string DisplayName { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
diff --git a/docs/email/proffer.email.iemailattachment.md b/docs/email/proffer.email.iemailattachment.md new file mode 100644 index 0000000..20dab08 --- /dev/null +++ b/docs/email/proffer.email.iemailattachment.md @@ -0,0 +1,71 @@ +# IEmailAttachment + +Namespace: Proffer.Email + +An email attachment file. + +```csharp +public interface IEmailAttachment +``` + +## Properties + +### **FileName** + +Gets or sets the file name. + +```csharp +public abstract string FileName { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Data** + +Gets or sets the file content. + +```csharp +public abstract Byte[] Data { get; set; } +``` + +#### Property Value + +[Byte[]](https://docs.microsoft.com/en-us/dotnet/api/system.byte)
+ +### **MediaType** + +Gets or sets the media type. + +```csharp +public abstract string MediaType { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **MediaSubtype** + +Gets or sets the media subtype. + +```csharp +public abstract string MediaSubtype { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ContentType** + +Gets the content-type. + +```csharp +public abstract string ContentType { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
diff --git a/docs/email/proffer.email.iemailprovider.md b/docs/email/proffer.email.iemailprovider.md new file mode 100644 index 0000000..68e363c --- /dev/null +++ b/docs/email/proffer.email.iemailprovider.md @@ -0,0 +1,119 @@ +# IEmailProvider + +Namespace: Proffer.Email + +A provider sends email using a particular messaging protocol or API. + +```csharp +public interface IEmailProvider +``` + +## Methods + +### **SendEmailAsync(IEmailAddress, IEnumerable<IEmailAddress>, String, String, String)** + +Sends an email. + +```csharp +Task SendEmailAsync(IEmailAddress from, IEnumerable recipients, string subject, string bodyText, string bodyHtml) +``` + +#### Parameters + +`from` [IEmailAddress](./proffer.email.iemailaddress)
+The sender email address. + +`recipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The email recipients. + +`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The subject. + +`bodyText` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as plain text. + +`bodyHtml` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as HTML. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendEmailAsync(IEmailAddress, IEnumerable<IEmailAddress>, String, String, String, IEnumerable<IEmailAttachment>)** + +Sends an email. + +```csharp +Task SendEmailAsync(IEmailAddress from, IEnumerable recipients, string subject, string bodyText, string bodyHtml, IEnumerable attachments) +``` + +#### Parameters + +`from` [IEmailAddress](./proffer.email.iemailaddress)
+The sender email address. + +`recipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The email recipients. + +`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The subject. + +`bodyText` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as plain text. + +`bodyHtml` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as HTML. + +`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The file attachments. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendEmailAsync(IEmailAddress, IEnumerable<IEmailAddress>, IEnumerable<IEmailAddress>, IEnumerable<IEmailAddress>, String, String, String, IEnumerable<IEmailAttachment>, IEmailAddress)** + +Sends an email. + +```csharp +Task SendEmailAsync(IEmailAddress from, IEnumerable recipients, IEnumerable ccRecipients, IEnumerable bccRecipients, string subject, string bodyText, string bodyHtml, IEnumerable attachments, IEmailAddress replyTo) +``` + +#### Parameters + +`from` [IEmailAddress](./proffer.email.iemailaddress)
+The sender email address. + +`recipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The email recipients. + +`ccRecipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The CC email recipients. + +`bccRecipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The BCC email recipients. + +`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The subject. + +`bodyText` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as plain text. + +`bodyHtml` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as HTML. + +`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The file attachments. + +`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
+The reply-to email address. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. diff --git a/docs/email/proffer.email.iemailprovideroptions.md b/docs/email/proffer.email.iemailprovideroptions.md new file mode 100644 index 0000000..7f2b1be --- /dev/null +++ b/docs/email/proffer.email.iemailprovideroptions.md @@ -0,0 +1,35 @@ +# IEmailProviderOptions + +Namespace: Proffer.Email + +Options for a [IEmailProvider](./proffer.email.iemailprovider). + +```csharp +public interface IEmailProviderOptions +``` + +## Properties + +### **Type** + +Gets or sets the type of the provider. + +```csharp +public abstract string Type { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Parameters** + +Gets or sets the provider parameters. + +```csharp +public abstract Dictionary Parameters { get; set; } +``` + +#### Property Value + +[Dictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.dictionary-2)
diff --git a/docs/email/proffer.email.iemailprovidertype.md b/docs/email/proffer.email.iemailprovidertype.md new file mode 100644 index 0000000..6aacc8d --- /dev/null +++ b/docs/email/proffer.email.iemailprovidertype.md @@ -0,0 +1,43 @@ +# IEmailProviderType + +Namespace: Proffer.Email + +Builds providers using a particular messaging protocol or API. + +```csharp +public interface IEmailProviderType +``` + +## Properties + +### **Name** + +Gets the name. + +```csharp +public abstract string Name { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Methods + +### **BuildProvider(IEmailProviderOptions)** + +Builds the provider. + +```csharp +IEmailProvider BuildProvider(IEmailProviderOptions providerOptions) +``` + +#### Parameters + +`providerOptions` [IEmailProviderOptions](./proffer.email.iemailprovideroptions)
+The provider options. + +#### Returns + +[IEmailProvider](./proffer.email.iemailprovider)
+A new . diff --git a/docs/email/proffer.email.iemailsender.md b/docs/email/proffer.email.iemailsender.md new file mode 100644 index 0000000..8e62c52 --- /dev/null +++ b/docs/email/proffer.email.iemailsender.md @@ -0,0 +1,428 @@ +# IEmailSender + +Namespace: Proffer.Email + +Sends templated or raw emails using configured providers. + +```csharp +public interface IEmailSender +``` + +## Methods + +### **SendEmailAsync(String, String, IEmailAddress[])** + +Sends an email. + +```csharp +Task SendEmailAsync(string subject, string message, IEmailAddress[] to) +``` + +#### Parameters + +`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The subject. + +`message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as plain text. + +`to` [IEmailAddress[]](./proffer.email.iemailaddress)
+The email recipients. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendEmailAsync(IEmailAddress, String, String, IEmailAddress[])** + +Sends an email. + +```csharp +Task SendEmailAsync(IEmailAddress from, string subject, string message, IEmailAddress[] to) +``` + +#### Parameters + +`from` [IEmailAddress](./proffer.email.iemailaddress)
+The sender email address. + +`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The subject. + +`message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as plain text. + +`to` [IEmailAddress[]](./proffer.email.iemailaddress)
+The email recipients. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendEmailAsync(IEmailAddress, IEmailAddress, String, String, Boolean, IEmailAddress[])** + +Sends an email. + +```csharp +Task SendEmailAsync(IEmailAddress from, IEmailAddress replyTo, string subject, string message, bool plainTextOnly, IEmailAddress[] to) +``` + +#### Parameters + +`from` [IEmailAddress](./proffer.email.iemailaddress)
+The sender email address. + +`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
+The reply-to email address. + +`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The subject. + +`message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as plain text. + +`plainTextOnly` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true the body shoud be sent as plain text only. + +`to` [IEmailAddress[]](./proffer.email.iemailaddress)
+The email recipients. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendEmailAsync(IEmailAddress, String, String, IEnumerable<IEmailAttachment>, IEmailAddress[])** + +Sends an email. + +```csharp +Task SendEmailAsync(IEmailAddress from, string subject, string message, IEnumerable attachments, IEmailAddress[] to) +``` + +#### Parameters + +`from` [IEmailAddress](./proffer.email.iemailaddress)
+The sender email address. + +`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The subject. + +`message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as plain text. + +`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The file attachments. + +`to` [IEmailAddress[]](./proffer.email.iemailaddress)
+The email recipients. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendEmailAsync(IEmailAddress, IEmailAddress, String, String, Boolean, IEnumerable<IEmailAttachment>, IEmailAddress[])** + +Sends an email. + +```csharp +Task SendEmailAsync(IEmailAddress from, IEmailAddress replyTo, string subject, string message, bool plainTextOnly, IEnumerable attachments, IEmailAddress[] to) +``` + +#### Parameters + +`from` [IEmailAddress](./proffer.email.iemailaddress)
+The sender email address. + +`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
+The reply-to email address. + +`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The subject. + +`message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as plain text. + +`plainTextOnly` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true the body shoud be sent as plain text only. + +`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The file attachments. + +`to` [IEmailAddress[]](./proffer.email.iemailaddress)
+The email recipients. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendEmailAsync(IEmailAddress, String, String, IEnumerable<IEmailAttachment>, IEmailAddress[], IEmailAddress[], IEmailAddress[], IEmailAddress, Boolean)** + +Sends an email. + +```csharp +Task SendEmailAsync(IEmailAddress from, string subject, string message, IEnumerable attachments, IEmailAddress[] to, IEmailAddress[] cc, IEmailAddress[] bcc, IEmailAddress replyTo, bool plainTextOnly) +``` + +#### Parameters + +`from` [IEmailAddress](./proffer.email.iemailaddress)
+The sender email address. + +`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The subject. + +`message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as plain text. + +`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The file attachments. + +`to` [IEmailAddress[]](./proffer.email.iemailaddress)
+The email recipients. + +`cc` [IEmailAddress[]](./proffer.email.iemailaddress)
+The CC email recipients. + +`bcc` [IEmailAddress[]](./proffer.email.iemailaddress)
+The BCC email recipients. + +`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
+The reply-to email address. + +`plainTextOnly` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true the body shoud be sent as plain text only. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendTemplatedEmailAsync<T>(String, T, IEmailAddress[])** + +Sends a templated email from the configured default sender email address. + +```csharp +Task SendTemplatedEmailAsync(string templateKey, T context, IEmailAddress[] to) +``` + +#### Type Parameters + +`T`
+The type of context to apply on the template. + +#### Parameters + +`templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The template key. + +`context` T
+The context to apply on the template. + +`to` [IEmailAddress[]](./proffer.email.iemailaddress)
+The email recipients. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendTemplatedEmailAsync<T>(IEmailAddress, String, T, IEmailAddress[])** + +Sends a templated email. + +```csharp +Task SendTemplatedEmailAsync(IEmailAddress from, string templateKey, T context, IEmailAddress[] to) +``` + +#### Type Parameters + +`T`
+The type of context to apply on the template. + +#### Parameters + +`from` [IEmailAddress](./proffer.email.iemailaddress)
+The sender email address. + +`templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The template key. + +`context` T
+The context to apply on the template. + +`to` [IEmailAddress[]](./proffer.email.iemailaddress)
+The email recipients. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendTemplatedEmailAsync<T>(IEmailAddress, IEmailAddress, String, T, IEmailAddress[])** + +Sends a templated email. + +```csharp +Task SendTemplatedEmailAsync(IEmailAddress from, IEmailAddress replyTo, string templateKey, T context, IEmailAddress[] to) +``` + +#### Type Parameters + +`T`
+The type of context to apply on the template. + +#### Parameters + +`from` [IEmailAddress](./proffer.email.iemailaddress)
+The sender email address. + +`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
+The reply-to email address. + +`templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The template key. + +`context` T
+The context to apply on the template. + +`to` [IEmailAddress[]](./proffer.email.iemailaddress)
+The email recipients. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendTemplatedEmailAsync<T>(IEmailAddress, String, T, IEnumerable<IEmailAttachment>, IEmailAddress[])** + +Sends a templated email. + +```csharp +Task SendTemplatedEmailAsync(IEmailAddress from, string templateKey, T context, IEnumerable attachments, IEmailAddress[] to) +``` + +#### Type Parameters + +`T`
+The type of context to apply on the template. + +#### Parameters + +`from` [IEmailAddress](./proffer.email.iemailaddress)
+The sender email address. + +`templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The template key. + +`context` T
+The context to apply on the template. + +`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The file attachments. + +`to` [IEmailAddress[]](./proffer.email.iemailaddress)
+The email recipients. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendTemplatedEmailAsync<T>(IEmailAddress, IEmailAddress, String, T, IEnumerable<IEmailAttachment>, IEmailAddress[])** + +Sends a templated email. + +```csharp +Task SendTemplatedEmailAsync(IEmailAddress from, IEmailAddress replyTo, string templateKey, T context, IEnumerable attachments, IEmailAddress[] to) +``` + +#### Type Parameters + +`T`
+The type of context to apply on the template. + +#### Parameters + +`from` [IEmailAddress](./proffer.email.iemailaddress)
+The sender email address. + +`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
+The reply-to email address. + +`templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The template key. + +`context` T
+The context to apply on the template. + +`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The file attachments. + +`to` [IEmailAddress[]](./proffer.email.iemailaddress)
+The email recipients. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendTemplatedEmailAsync<T>(IEmailAddress, String, T, IEnumerable<IEmailAttachment>, IEmailAddress[], IEmailAddress[], IEmailAddress[], IEmailAddress)** + +Sends a templated email. + +```csharp +Task SendTemplatedEmailAsync(IEmailAddress from, string templateKey, T context, IEnumerable attachments, IEmailAddress[] to, IEmailAddress[] cc, IEmailAddress[] bcc, IEmailAddress replyTo) +``` + +#### Type Parameters + +`T`
+The type of context to apply on the template. + +#### Parameters + +`from` [IEmailAddress](./proffer.email.iemailaddress)
+The sender email address. + +`templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The template key. + +`context` T
+The context to apply on the template. + +`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The file attachments. + +`to` [IEmailAddress[]](./proffer.email.iemailaddress)
+The email recipients. + +`cc` [IEmailAddress[]](./proffer.email.iemailaddress)
+The CC email recipients. + +`bcc` [IEmailAddress[]](./proffer.email.iemailaddress)
+The BCC email recipients. + +`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
+The reply-to email address. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. diff --git a/docs/email/proffer.email.internal.emailaddress.md b/docs/email/proffer.email.internal.emailaddress.md new file mode 100644 index 0000000..c0d24d5 --- /dev/null +++ b/docs/email/proffer.email.internal.emailaddress.md @@ -0,0 +1,64 @@ +# EmailAddress + +Namespace: Proffer.Email.Internal + +A simple email address with its optional display name. + +```csharp +public class EmailAddress : Proffer.Email.IEmailAddress +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EmailAddress](./proffer.email.internal.emailaddress)
+Implements [IEmailAddress](./proffer.email.iemailaddress) + +## Properties + +### **Email** + +Gets or sets the email. + +```csharp +public string Email { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **DisplayName** + +Gets or sets the display name. + +```csharp +public string DisplayName { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Constructors + +### **EmailAddress()** + +Initializes a new instance of the [EmailAddress](./proffer.email.internal.emailaddress) class. + +```csharp +public EmailAddress() +``` + +### **EmailAddress(String, String)** + +Initializes a new instance of the [EmailAddress](./proffer.email.internal.emailaddress) class. + +```csharp +public EmailAddress(string email, string displayName) +``` + +#### Parameters + +`email` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The email. + +`displayName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The display name. diff --git a/docs/email/proffer.email.internal.emailaddressequalitycomparer.md b/docs/email/proffer.email.internal.emailaddressequalitycomparer.md new file mode 100644 index 0000000..4e2f2eb --- /dev/null +++ b/docs/email/proffer.email.internal.emailaddressequalitycomparer.md @@ -0,0 +1,43 @@ +# EmailAddressEqualityComparer + +Namespace: Proffer.Email.Internal + +Supports the comparison of [IEmailAddress](./proffer.email.iemailaddress) for equality when the email address only should match. + +```csharp +public class EmailAddressEqualityComparer : Proffer.EqualityComparerBase`1[[Proffer.Email.IEmailAddress, Proffer.Email, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Collections.IEqualityComparer, System.Collections.Generic.IEqualityComparer`1[[Proffer.Email.IEmailAddress, Proffer.Email, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EqualityComparer<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.equalitycomparer-1) → EqualityComparerBase<IEmailAddress> → [EmailAddressEqualityComparer](./proffer.email.internal.emailaddressequalitycomparer)
+Implements [IEqualityComparer](https://docs.microsoft.com/en-us/dotnet/api/system.collections.iequalitycomparer), [IEqualityComparer<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.iequalitycomparer-1) + +## Constructors + +### **EmailAddressEqualityComparer()** + + + +```csharp +public EmailAddressEqualityComparer() +``` + +## Methods + +### **GetEqualityComponents(IEmailAddress)** + +Gets the object's components that participate in equality comparisons. + +```csharp +protected IEnumerable GetEqualityComponents(IEmailAddress obj) +``` + +#### Parameters + +`obj` [IEmailAddress](./proffer.email.iemailaddress)
+The object. + +#### Returns + +[IEnumerable<Object>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+ + An enumerable containing the properties values. diff --git a/docs/email/proffer.email.internal.emailaddressstrictequalitycomparer.md b/docs/email/proffer.email.internal.emailaddressstrictequalitycomparer.md new file mode 100644 index 0000000..fae43be --- /dev/null +++ b/docs/email/proffer.email.internal.emailaddressstrictequalitycomparer.md @@ -0,0 +1,43 @@ +# EmailAddressStrictEqualityComparer + +Namespace: Proffer.Email.Internal + +Supports the comparison of [IEmailAddress](./proffer.email.iemailaddress) for equality when both the email address and the display name should match. + +```csharp +public class EmailAddressStrictEqualityComparer : Proffer.EqualityComparerBase`1[[Proffer.Email.IEmailAddress, Proffer.Email, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Collections.IEqualityComparer, System.Collections.Generic.IEqualityComparer`1[[Proffer.Email.IEmailAddress, Proffer.Email, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EqualityComparer<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.equalitycomparer-1) → EqualityComparerBase<IEmailAddress> → [EmailAddressStrictEqualityComparer](./proffer.email.internal.emailaddressstrictequalitycomparer)
+Implements [IEqualityComparer](https://docs.microsoft.com/en-us/dotnet/api/system.collections.iequalitycomparer), [IEqualityComparer<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.iequalitycomparer-1) + +## Constructors + +### **EmailAddressStrictEqualityComparer()** + + + +```csharp +public EmailAddressStrictEqualityComparer() +``` + +## Methods + +### **GetEqualityComponents(IEmailAddress)** + +Gets the object's components that participate in equality comparisons. + +```csharp +protected IEnumerable GetEqualityComponents(IEmailAddress obj) +``` + +#### Parameters + +`obj` [IEmailAddress](./proffer.email.iemailaddress)
+The object. + +#### Returns + +[IEnumerable<Object>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+ + An enumerable containing the properties values. diff --git a/docs/email/proffer.email.internal.emailattachment.md b/docs/email/proffer.email.internal.emailattachment.md new file mode 100644 index 0000000..9d76156 --- /dev/null +++ b/docs/email/proffer.email.internal.emailattachment.md @@ -0,0 +1,125 @@ +# EmailAttachment + +Namespace: Proffer.Email.Internal + +A simpl email attachment file. + +```csharp +public class EmailAttachment : Proffer.Email.IEmailAttachment +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EmailAttachment](./proffer.email.internal.emailattachment)
+Implements [IEmailAttachment](./proffer.email.iemailattachment) + +## Properties + +### **FileName** + +Gets or sets the file name. + +```csharp +public string FileName { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Data** + +Gets or sets the file content. + +```csharp +public Byte[] Data { get; set; } +``` + +#### Property Value + +[Byte[]](https://docs.microsoft.com/en-us/dotnet/api/system.byte)
+ +### **MediaType** + +Gets or sets the media type. + +```csharp +public string MediaType { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **MediaSubtype** + +Gets or sets the media subtype. + +```csharp +public string MediaSubtype { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ContentType** + +Gets the content-type. + +```csharp +public string ContentType { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Constructors + +### **EmailAttachment()** + +Initializes a new instance of the [EmailAttachment](./proffer.email.internal.emailattachment) class. + +```csharp +public EmailAttachment() +``` + +### **EmailAttachment(String, Byte[], String)** + +Initializes a new instance of the [EmailAttachment](./proffer.email.internal.emailattachment) class. + +```csharp +public EmailAttachment(string fileName, Byte[] data, string contentType) +``` + +#### Parameters + +`fileName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The file name. + +`data` [Byte[]](https://docs.microsoft.com/en-us/dotnet/api/system.byte)
+The file content. + +`contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The content-type. + +### **EmailAttachment(String, Byte[], String, String)** + +Initializes a new instance of the [EmailAttachment](./proffer.email.internal.emailattachment) class. + +```csharp +public EmailAttachment(string fileName, Byte[] data, string mediaType, string mediaSubtype) +``` + +#### Parameters + +`fileName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The file name. + +`data` [Byte[]](https://docs.microsoft.com/en-us/dotnet/api/system.byte)
+The file content. + +`mediaType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The media type. + +`mediaSubtype` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The media subtype. diff --git a/docs/email/proffer.email.internal.emailattachmentequalitycomparer.md b/docs/email/proffer.email.internal.emailattachmentequalitycomparer.md new file mode 100644 index 0000000..09e9af6 --- /dev/null +++ b/docs/email/proffer.email.internal.emailattachmentequalitycomparer.md @@ -0,0 +1,43 @@ +# EmailAttachmentEqualityComparer + +Namespace: Proffer.Email.Internal + +Supports the comparison of [IEmailAttachment](./proffer.email.iemailattachment) for equality. + +```csharp +public class EmailAttachmentEqualityComparer : Proffer.EqualityComparerBase`1[[Proffer.Email.IEmailAttachment, Proffer.Email, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Collections.IEqualityComparer, System.Collections.Generic.IEqualityComparer`1[[Proffer.Email.IEmailAttachment, Proffer.Email, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EqualityComparer<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.equalitycomparer-1) → EqualityComparerBase<IEmailAttachment> → [EmailAttachmentEqualityComparer](./proffer.email.internal.emailattachmentequalitycomparer)
+Implements [IEqualityComparer](https://docs.microsoft.com/en-us/dotnet/api/system.collections.iequalitycomparer), [IEqualityComparer<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.iequalitycomparer-1) + +## Constructors + +### **EmailAttachmentEqualityComparer()** + + + +```csharp +public EmailAttachmentEqualityComparer() +``` + +## Methods + +### **GetEqualityComponents(IEmailAttachment)** + +Gets the object's components that participate in equality comparisons. + +```csharp +protected IEnumerable GetEqualityComponents(IEmailAttachment obj) +``` + +#### Parameters + +`obj` [IEmailAttachment](./proffer.email.iemailattachment)
+The object. + +#### Returns + +[IEnumerable<Object>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+ + An enumerable containing the properties values. diff --git a/docs/email/proffer.email.internal.emailsender.md b/docs/email/proffer.email.internal.emailsender.md new file mode 100644 index 0000000..2b68cdd --- /dev/null +++ b/docs/email/proffer.email.internal.emailsender.md @@ -0,0 +1,477 @@ +# EmailSender + +Namespace: Proffer.Email.Internal + +Sends templated or raw emails using configured providers. + +```csharp +public class EmailSender : Proffer.Email.IEmailSender +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EmailSender](./proffer.email.internal.emailsender)
+Implements [IEmailSender](./proffer.email.iemailsender) + +## Constructors + +### **EmailSender(IEnumerable<IEmailProviderType>, IOptions<EmailOptions>, IStorageFactory, ITemplateLoaderFactory)** + +Initializes a new instance of the [EmailSender](./proffer.email.internal.emailsender) class. + +```csharp +public EmailSender(IEnumerable emailProviderTypes, IOptions options, IStorageFactory storageFactory, ITemplateLoaderFactory templateLoaderFactory) +``` + +#### Parameters + +`emailProviderTypes` [IEnumerable<IEmailProviderType>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The email provider types. + +`options` IOptions<EmailOptions>
+The Proffer.Email options. + +`storageFactory` IStorageFactory
+The storage factory. + +`templateLoaderFactory` ITemplateLoaderFactory
+The template loader factory. + +#### Exceptions + +[ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/system.argumentnullexception)
+ +## Methods + +### **SendEmailAsync(String, String, IEmailAddress[])** + +Sends an email. + +```csharp +public Task SendEmailAsync(string subject, string message, IEmailAddress[] to) +``` + +#### Parameters + +`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The subject. + +`message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as plain text. + +`to` [IEmailAddress[]](./proffer.email.iemailaddress)
+The email recipients. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendEmailAsync(IEmailAddress, String, String, IEmailAddress[])** + +Sends an email. + +```csharp +public Task SendEmailAsync(IEmailAddress from, string subject, string message, IEmailAddress[] to) +``` + +#### Parameters + +`from` [IEmailAddress](./proffer.email.iemailaddress)
+The sender email address. + +`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The subject. + +`message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as plain text. + +`to` [IEmailAddress[]](./proffer.email.iemailaddress)
+The email recipients. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendEmailAsync(IEmailAddress, IEmailAddress, String, String, Boolean, IEmailAddress[])** + +Sends an email. + +```csharp +public Task SendEmailAsync(IEmailAddress from, IEmailAddress replyTo, string subject, string message, bool plainTextOnly, IEmailAddress[] to) +``` + +#### Parameters + +`from` [IEmailAddress](./proffer.email.iemailaddress)
+The sender email address. + +`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
+The reply-to email address. + +`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The subject. + +`message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as plain text. + +`plainTextOnly` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true the body shoud be sent as plain text only. + +`to` [IEmailAddress[]](./proffer.email.iemailaddress)
+The email recipients. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendEmailAsync(IEmailAddress, String, String, IEnumerable<IEmailAttachment>, IEmailAddress[])** + +Sends an email. + +```csharp +public Task SendEmailAsync(IEmailAddress from, string subject, string message, IEnumerable attachments, IEmailAddress[] to) +``` + +#### Parameters + +`from` [IEmailAddress](./proffer.email.iemailaddress)
+The sender email address. + +`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The subject. + +`message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as plain text. + +`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The file attachments. + +`to` [IEmailAddress[]](./proffer.email.iemailaddress)
+The email recipients. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendEmailAsync(IEmailAddress, IEmailAddress, String, String, Boolean, IEnumerable<IEmailAttachment>, IEmailAddress[])** + +Sends an email. + +```csharp +public Task SendEmailAsync(IEmailAddress from, IEmailAddress replyTo, string subject, string message, bool plainTextOnly, IEnumerable attachments, IEmailAddress[] to) +``` + +#### Parameters + +`from` [IEmailAddress](./proffer.email.iemailaddress)
+The sender email address. + +`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
+The reply-to email address. + +`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The subject. + +`message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as plain text. + +`plainTextOnly` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true the body shoud be sent as plain text only. + +`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The file attachments. + +`to` [IEmailAddress[]](./proffer.email.iemailaddress)
+The email recipients. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendEmailAsync(IEmailAddress, String, String, IEnumerable<IEmailAttachment>, IEmailAddress[], IEmailAddress[], IEmailAddress[], IEmailAddress, Boolean)** + +Sends an email. + +```csharp +public Task SendEmailAsync(IEmailAddress from, string subject, string message, IEnumerable attachments, IEmailAddress[] to, IEmailAddress[] cc, IEmailAddress[] bcc, IEmailAddress replyTo, bool plainTextOnly) +``` + +#### Parameters + +`from` [IEmailAddress](./proffer.email.iemailaddress)
+The sender email address. + +`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The subject. + +`message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as plain text. + +`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The file attachments. + +`to` [IEmailAddress[]](./proffer.email.iemailaddress)
+The email recipients. + +`cc` [IEmailAddress[]](./proffer.email.iemailaddress)
+The CC email recipients. + +`bcc` [IEmailAddress[]](./proffer.email.iemailaddress)
+The BCC email recipients. + +`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
+The reply-to email address. + +`plainTextOnly` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true the body shoud be sent as plain text only. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendTemplatedEmailAsync<T>(String, T, IEmailAddress[])** + +Sends a templated email from the configured default sender email address. + +```csharp +public Task SendTemplatedEmailAsync(string templateKey, T context, IEmailAddress[] to) +``` + +#### Type Parameters + +`T`
+The type of context to apply on the template. + +#### Parameters + +`templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The template key. + +`context` T
+The context to apply on the template. + +`to` [IEmailAddress[]](./proffer.email.iemailaddress)
+The email recipients. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendTemplatedEmailAsync<T>(IEmailAddress, String, T, IEmailAddress[])** + +Sends a templated email. + +```csharp +public Task SendTemplatedEmailAsync(IEmailAddress from, string templateKey, T context, IEmailAddress[] to) +``` + +#### Type Parameters + +`T`
+The type of context to apply on the template. + +#### Parameters + +`from` [IEmailAddress](./proffer.email.iemailaddress)
+The sender email address. + +`templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The template key. + +`context` T
+The context to apply on the template. + +`to` [IEmailAddress[]](./proffer.email.iemailaddress)
+The email recipients. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendTemplatedEmailAsync<T>(IEmailAddress, IEmailAddress, String, T, IEmailAddress[])** + +Sends a templated email. + +```csharp +public Task SendTemplatedEmailAsync(IEmailAddress from, IEmailAddress replyTo, string templateKey, T context, IEmailAddress[] to) +``` + +#### Type Parameters + +`T`
+The type of context to apply on the template. + +#### Parameters + +`from` [IEmailAddress](./proffer.email.iemailaddress)
+The sender email address. + +`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
+The reply-to email address. + +`templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The template key. + +`context` T
+The context to apply on the template. + +`to` [IEmailAddress[]](./proffer.email.iemailaddress)
+The email recipients. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendTemplatedEmailAsync<T>(IEmailAddress, String, T, IEnumerable<IEmailAttachment>, IEmailAddress[])** + +Sends a templated email. + +```csharp +public Task SendTemplatedEmailAsync(IEmailAddress from, string templateKey, T context, IEnumerable attachments, IEmailAddress[] to) +``` + +#### Type Parameters + +`T`
+The type of context to apply on the template. + +#### Parameters + +`from` [IEmailAddress](./proffer.email.iemailaddress)
+The sender email address. + +`templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The template key. + +`context` T
+The context to apply on the template. + +`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The file attachments. + +`to` [IEmailAddress[]](./proffer.email.iemailaddress)
+The email recipients. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendTemplatedEmailAsync<T>(IEmailAddress, IEmailAddress, String, T, IEnumerable<IEmailAttachment>, IEmailAddress[])** + +Sends a templated email. + +```csharp +public Task SendTemplatedEmailAsync(IEmailAddress from, IEmailAddress replyTo, string templateKey, T context, IEnumerable attachments, IEmailAddress[] to) +``` + +#### Type Parameters + +`T`
+The type of context to apply on the template. + +#### Parameters + +`from` [IEmailAddress](./proffer.email.iemailaddress)
+The sender email address. + +`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
+The reply-to email address. + +`templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The template key. + +`context` T
+The context to apply on the template. + +`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The file attachments. + +`to` [IEmailAddress[]](./proffer.email.iemailaddress)
+The email recipients. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendTemplatedEmailAsync<T>(IEmailAddress, String, T, IEnumerable<IEmailAttachment>, IEmailAddress[], IEmailAddress[], IEmailAddress[], IEmailAddress)** + +Sends a templated email. + +```csharp +public Task SendTemplatedEmailAsync(IEmailAddress from, string templateKey, T context, IEnumerable attachments, IEmailAddress[] to, IEmailAddress[] cc, IEmailAddress[] bcc, IEmailAddress replyTo) +``` + +#### Type Parameters + +`T`
+The type of context to apply on the template. + +#### Parameters + +`from` [IEmailAddress](./proffer.email.iemailaddress)
+The sender email address. + +`templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The template key. + +`context` T
+The context to apply on the template. + +`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The file attachments. + +`to` [IEmailAddress[]](./proffer.email.iemailaddress)
+The email recipients. + +`cc` [IEmailAddress[]](./proffer.email.iemailaddress)
+The CC email recipients. + +`bcc` [IEmailAddress[]](./proffer.email.iemailaddress)
+The BCC email recipients. + +`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
+The reply-to email address. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ +### **GetTemplateAsync(String, EmailTemplateType)** + +Gets the template asynchronous. + +```csharp +protected Task GetTemplateAsync(string templateKey, EmailTemplateType templateType) +``` + +#### Parameters + +`templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The template key. + +`templateType` [EmailTemplateType](./proffer.email.emailtemplatetype)
+Type of the template. + +#### Returns + +[Task<ITemplate>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)
diff --git a/docs/email/proffer.email.mockupexceptionsoptions.md b/docs/email/proffer.email.mockupexceptionsoptions.md new file mode 100644 index 0000000..9f6dff4 --- /dev/null +++ b/docs/email/proffer.email.mockupexceptionsoptions.md @@ -0,0 +1,47 @@ +# MockupExceptionsOptions + +Namespace: Proffer.Email + +Options to exclude some emails or domains from a mockup configuration. + +```csharp +public class MockupExceptionsOptions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [MockupExceptionsOptions](./proffer.email.mockupexceptionsoptions) + +## Properties + +### **Emails** + +Gets or sets the emails exclusions. + +```csharp +public List Emails { get; set; } +``` + +#### Property Value + +[List<String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1)
+ +### **Domains** + +Gets or sets the domains exclusions. + +```csharp +public List Domains { get; set; } +``` + +#### Property Value + +[List<String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1)
+ +## Constructors + +### **MockupExceptionsOptions()** + + + +```csharp +public MockupExceptionsOptions() +``` diff --git a/docs/email/proffer.email.mockupoptions.md b/docs/email/proffer.email.mockupoptions.md new file mode 100644 index 0000000..6105759 --- /dev/null +++ b/docs/email/proffer.email.mockupoptions.md @@ -0,0 +1,59 @@ +# MockupOptions + +Namespace: Proffer.Email + +Options to mockup the email sender (all recipients would be redirect to the mockup recipients). + +```csharp +public class MockupOptions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [MockupOptions](./proffer.email.mockupoptions) + +## Properties + +### **Recipients** + +Gets or sets the mockup recipients. + +```csharp +public List Recipients { get; set; } +``` + +#### Property Value + +[List<String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1)
+ +### **Exceptions** + +Gets or sets the exceptions options. + +```csharp +public MockupExceptionsOptions Exceptions { get; set; } +``` + +#### Property Value + +[MockupExceptionsOptions](./proffer.email.mockupexceptionsoptions)
+ +### **Disclaimer** + +Gets or sets the disclaimer to add at the end of a mocked up email. + +```csharp +public string Disclaimer { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Constructors + +### **MockupOptions()** + + + +```csharp +public MockupOptions() +``` diff --git a/docs/email/sendgrid/api.md b/docs/email/sendgrid/api.md new file mode 100644 index 0000000..7e688ee --- /dev/null +++ b/docs/email/sendgrid/api.md @@ -0,0 +1,11 @@ +# Proffer.Email.SendGrid + +## Proffer.Email + +[ServiceCollectionExtensions](./proffer.email.servicecollectionextensions) + +## Proffer.Email.SendGrid + +[SendGridEmailProvider](./proffer.email.sendgrid.sendgridemailprovider) + +[SendGridEmailProviderType](./proffer.email.sendgrid.sendgridemailprovidertype) diff --git a/docs/email/sendgrid/proffer.email.sendgrid.sendgridemailprovider.md b/docs/email/sendgrid/proffer.email.sendgrid.sendgridemailprovider.md new file mode 100644 index 0000000..c653a4f --- /dev/null +++ b/docs/email/sendgrid/proffer.email.sendgrid.sendgridemailprovider.md @@ -0,0 +1,148 @@ +# SendGridEmailProvider + +Namespace: Proffer.Email.SendGrid + +A provider that sends email using N:SendGrid API. + +```csharp +public class SendGridEmailProvider : Proffer.Email.IEmailProvider +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [SendGridEmailProvider](./proffer.email.sendgrid.sendgridemailprovider)
+Implements IEmailProvider + +## Constructors + +### **SendGridEmailProvider(IEmailProviderOptions)** + +Initializes a new instance of the [SendGridEmailProvider](./proffer.email.sendgrid.sendgridemailprovider) class. + +```csharp +public SendGridEmailProvider(IEmailProviderOptions options) +``` + +#### Parameters + +`options` IEmailProviderOptions
+The options. + +#### Exceptions + +[ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/system.argumentnullexception)
+apiKey + +## Methods + +### **SendEmailAsync(IEmailAddress, IEnumerable<IEmailAddress>, String, String, String)** + +Sends an email. + +```csharp +public Task SendEmailAsync(IEmailAddress from, IEnumerable recipients, string subject, string bodyText, string bodyHtml) +``` + +#### Parameters + +`from` IEmailAddress
+The sender email address. + +`recipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The email recipients. + +`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The subject. + +`bodyText` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as plain text. + +`bodyHtml` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as HTML. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendEmailAsync(IEmailAddress, IEnumerable<IEmailAddress>, String, String, String, IEnumerable<IEmailAttachment>)** + +Sends an email. + +```csharp +public Task SendEmailAsync(IEmailAddress from, IEnumerable recipients, string subject, string bodyText, string bodyHtml, IEnumerable attachments) +``` + +#### Parameters + +`from` IEmailAddress
+The sender email address. + +`recipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The email recipients. + +`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The subject. + +`bodyText` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as plain text. + +`bodyHtml` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as HTML. + +`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The file attachments. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendEmailAsync(IEmailAddress, IEnumerable<IEmailAddress>, IEnumerable<IEmailAddress>, IEnumerable<IEmailAddress>, String, String, String, IEnumerable<IEmailAttachment>, IEmailAddress)** + +Sends an email. + +```csharp +public Task SendEmailAsync(IEmailAddress from, IEnumerable recipients, IEnumerable ccRecipients, IEnumerable bccRecipients, string subject, string bodyText, string bodyHtml, IEnumerable attachments, IEmailAddress replyTo) +``` + +#### Parameters + +`from` IEmailAddress
+The sender email address. + +`recipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The email recipients. + +`ccRecipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The CC email recipients. + +`bccRecipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The BCC email recipients. + +`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The subject. + +`bodyText` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as plain text. + +`bodyHtml` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as HTML. + +`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The file attachments. + +`replyTo` IEmailAddress
+The reply-to email address. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ +#### Exceptions + +[ArgumentException](https://docs.microsoft.com/en-us/dotnet/api/system.argumentexception)
+Each email address should be unique between to, cc, and bcc recipients. We found duplicates. + +[Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception)
+Cannot Send Email: {response.StatusCode} diff --git a/docs/email/sendgrid/proffer.email.sendgrid.sendgridemailprovidertype.md b/docs/email/sendgrid/proffer.email.sendgrid.sendgridemailprovidertype.md new file mode 100644 index 0000000..1f9a9d8 --- /dev/null +++ b/docs/email/sendgrid/proffer.email.sendgrid.sendgridemailprovidertype.md @@ -0,0 +1,57 @@ +# SendGridEmailProviderType + +Namespace: Proffer.Email.SendGrid + +Builds [SendGridEmailProvider](./proffer.email.sendgrid.sendgridemailprovider). + +```csharp +public class SendGridEmailProviderType : Proffer.Email.IEmailProviderType +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [SendGridEmailProviderType](./proffer.email.sendgrid.sendgridemailprovidertype)
+Implements IEmailProviderType + +## Properties + +### **Name** + +Gets the name. + +```csharp +public string Name { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Constructors + +### **SendGridEmailProviderType()** + + + +```csharp +public SendGridEmailProviderType() +``` + +## Methods + +### **BuildProvider(IEmailProviderOptions)** + +Builds the provider. + +```csharp +public IEmailProvider BuildProvider(IEmailProviderOptions providerOptions) +``` + +#### Parameters + +`providerOptions` IEmailProviderOptions
+The provider options. + +#### Returns + +IEmailProvider
+ + A new . diff --git a/docs/email/sendgrid/proffer.email.servicecollectionextensions.md b/docs/email/sendgrid/proffer.email.servicecollectionextensions.md new file mode 100644 index 0000000..8870099 --- /dev/null +++ b/docs/email/sendgrid/proffer.email.servicecollectionextensions.md @@ -0,0 +1,31 @@ +# ServiceCollectionExtensions + +Namespace: Proffer.Email + +Microsoft.Extensions.DependencyInjection.IServiceCollection extension methods. + +```csharp +public static class ServiceCollectionExtensions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ServiceCollectionExtensions](./proffer.email.servicecollectionextensions) + +## Methods + +### **AddSendGridEmail(IServiceCollection)** + +Registers the Proffer.Email services to the N:SendGrid API. + +```csharp +public static IServiceCollection AddSendGridEmail(IServiceCollection services) +``` + +#### Parameters + +`services` IServiceCollection
+The service collection. + +#### Returns + +IServiceCollection
+The service collection. diff --git a/docs/email/smtp/api.md b/docs/email/smtp/api.md new file mode 100644 index 0000000..04c87e6 --- /dev/null +++ b/docs/email/smtp/api.md @@ -0,0 +1,11 @@ +# Proffer.Email.Smtp + +## Proffer.Email + +[SmtpEmailServiceCollectionExtensions](./proffer.email.smtpemailservicecollectionextensions) + +## Proffer.Email.Smtp + +[SmtpEmailProvider](./proffer.email.smtp.smtpemailprovider) + +[SmtpEmailProviderType](./proffer.email.smtp.smtpemailprovidertype) diff --git a/docs/email/smtp/proffer.email.smtp.smtpemailprovider.md b/docs/email/smtp/proffer.email.smtp.smtpemailprovider.md new file mode 100644 index 0000000..f5c4bb9 --- /dev/null +++ b/docs/email/smtp/proffer.email.smtp.smtpemailprovider.md @@ -0,0 +1,144 @@ +# SmtpEmailProvider + +Namespace: Proffer.Email.Smtp + +A provider that sends email to a SMTP server with N:MailKit. + +```csharp +public class SmtpEmailProvider : Proffer.Email.IEmailProvider +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [SmtpEmailProvider](./proffer.email.smtp.smtpemailprovider)
+Implements IEmailProvider + +## Constructors + +### **SmtpEmailProvider(IServiceProvider, IEmailProviderOptions)** + +Initializes a new instance of the [SmtpEmailProvider](./proffer.email.smtp.smtpemailprovider) class. + +```csharp +public SmtpEmailProvider(IServiceProvider serviceProvider, IEmailProviderOptions options) +``` + +#### Parameters + +`serviceProvider` IServiceProvider
+The service provider. + +`options` IEmailProviderOptions
+The options. + +#### Exceptions + +[ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/system.argumentnullexception)
+ +[ArgumentException](https://docs.microsoft.com/en-us/dotnet/api/system.argumentexception)
+ +## Methods + +### **SendEmailAsync(IEmailAddress, IEnumerable<IEmailAddress>, String, String, String)** + +Sends an email. + +```csharp +public Task SendEmailAsync(IEmailAddress from, IEnumerable recipients, string subject, string bodyText, string bodyHtml) +``` + +#### Parameters + +`from` IEmailAddress
+The sender email address. + +`recipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The email recipients. + +`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The subject. + +`bodyText` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as plain text. + +`bodyHtml` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as HTML. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendEmailAsync(IEmailAddress, IEnumerable<IEmailAddress>, String, String, String, IEnumerable<IEmailAttachment>)** + +Sends an email. + +```csharp +public Task SendEmailAsync(IEmailAddress from, IEnumerable recipients, string subject, string bodyText, string bodyHtml, IEnumerable attachments) +``` + +#### Parameters + +`from` IEmailAddress
+The sender email address. + +`recipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The email recipients. + +`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The subject. + +`bodyText` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as plain text. + +`bodyHtml` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as HTML. + +`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The file attachments. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SendEmailAsync(IEmailAddress, IEnumerable<IEmailAddress>, IEnumerable<IEmailAddress>, IEnumerable<IEmailAddress>, String, String, String, IEnumerable<IEmailAttachment>, IEmailAddress)** + +Sends an email. + +```csharp +public Task SendEmailAsync(IEmailAddress from, IEnumerable recipients, IEnumerable ccRecipients, IEnumerable bccRecipients, string subject, string bodyText, string bodyHtml, IEnumerable attachments, IEmailAddress replyTo) +``` + +#### Parameters + +`from` IEmailAddress
+The sender email address. + +`recipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The email recipients. + +`ccRecipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The CC email recipients. + +`bccRecipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The BCC email recipients. + +`subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The subject. + +`bodyText` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as plain text. + +`bodyHtml` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The body as HTML. + +`attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The file attachments. + +`replyTo` IEmailAddress
+The reply-to email address. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
diff --git a/docs/email/smtp/proffer.email.smtp.smtpemailprovidertype.md b/docs/email/smtp/proffer.email.smtp.smtpemailprovidertype.md new file mode 100644 index 0000000..2de00b0 --- /dev/null +++ b/docs/email/smtp/proffer.email.smtp.smtpemailprovidertype.md @@ -0,0 +1,62 @@ +# SmtpEmailProviderType + +Namespace: Proffer.Email.Smtp + +Builds [SmtpEmailProvider](./proffer.email.smtp.smtpemailprovider). + +```csharp +public class SmtpEmailProviderType : Proffer.Email.IEmailProviderType +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [SmtpEmailProviderType](./proffer.email.smtp.smtpemailprovidertype)
+Implements IEmailProviderType + +## Properties + +### **Name** + +Gets the name. + +```csharp +public string Name { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Constructors + +### **SmtpEmailProviderType(IServiceProvider)** + +Initializes a new instance of the [SmtpEmailProviderType](./proffer.email.smtp.smtpemailprovidertype) class. + +```csharp +public SmtpEmailProviderType(IServiceProvider serviceProvider) +``` + +#### Parameters + +`serviceProvider` IServiceProvider
+The service provider. + +## Methods + +### **BuildProvider(IEmailProviderOptions)** + +Builds the provider. + +```csharp +public IEmailProvider BuildProvider(IEmailProviderOptions providerOptions) +``` + +#### Parameters + +`providerOptions` IEmailProviderOptions
+The provider options. + +#### Returns + +IEmailProvider
+ + A new . diff --git a/docs/email/smtp/proffer.email.smtpemailservicecollectionextensions.md b/docs/email/smtp/proffer.email.smtpemailservicecollectionextensions.md new file mode 100644 index 0000000..30af29e --- /dev/null +++ b/docs/email/smtp/proffer.email.smtpemailservicecollectionextensions.md @@ -0,0 +1,31 @@ +# SmtpEmailServiceCollectionExtensions + +Namespace: Proffer.Email + +Microsoft.Extensions.DependencyInjection.IServiceCollection extension methods. + +```csharp +public static class SmtpEmailServiceCollectionExtensions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [SmtpEmailServiceCollectionExtensions](./proffer.email.smtpemailservicecollectionextensions) + +## Methods + +### **AddSmtpEmail(IServiceCollection)** + +Registers the Proffer.Email services to a SMTP server with N:MailKit. + +```csharp +public static IServiceCollection AddSmtpEmail(IServiceCollection services) +``` + +#### Parameters + +`services` IServiceCollection
+The service collection. + +#### Returns + +IServiceCollection
+The service collection. diff --git a/docs/storage/api.md b/docs/storage/api.md new file mode 100644 index 0000000..a94ec68 --- /dev/null +++ b/docs/storage/api.md @@ -0,0 +1,75 @@ +# Proffer.Storage + +## Proffer.Storage + +[IFileProperties](./proffer.storage.ifileproperties) + +[IFileReference](./proffer.storage.ifilereference) + +[IPrivateFileReference](./proffer.storage.iprivatefilereference) + +[ISharedAccessPolicy](./proffer.storage.isharedaccesspolicy) + +[IStorageFactory](./proffer.storage.istoragefactory) + +[IStorageProvider](./proffer.storage.istorageprovider) + +[IStore](./proffer.storage.istore) + +[IStore<TOptions>](./proffer.storage.istore-1) + +[IStoreExtensions](./proffer.storage.istoreextensions) + +[OverwritePolicy](./proffer.storage.overwritepolicy) + +[SharedAccessPermissions](./proffer.storage.sharedaccesspermissions) + +[SharedAccessPolicy](./proffer.storage.sharedaccesspolicy) + +[StorageServiceCollectionExtensions](./proffer.storage.storageservicecollectionextensions) + +[StoreBase](./proffer.storage.storebase) + +## Proffer.Storage.Configuration + +[AccessLevel](./proffer.storage.configuration.accesslevel) + +[ConfigurationExtensions](./proffer.storage.configuration.configurationextensions) + +[IParsedOptions<TProviderOptions, TStoreOptions, TScopedStoreOptions>](./proffer.storage.configuration.iparsedoptions-3) + +[IScopedStoreOptions](./proffer.storage.configuration.iscopedstoreoptions) + +[IStoreOptions](./proffer.storage.configuration.istoreoptions) + +[ScopedStoreOptions](./proffer.storage.configuration.scopedstoreoptions) + +[StorageOptions](./proffer.storage.configuration.storageoptions) + +[StoreOptions](./proffer.storage.configuration.storeoptions) + +## Proffer.Storage.Exceptions + +[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration) + +[BadScopedStoreConfiguration](./proffer.storage.exceptions.badscopedstoreconfiguration) + +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration) + +[FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception) + +[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception) + +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception) + +## Proffer.Storage.Internal + +[ConfigureProviderOptions<TParsedOptions, TProviderOptions, TStoreOptions, TScopedStoreOptions>](./proffer.storage.internal.configureprovideroptions-4) + +[GenericStoreProxy<TOptions>](./proffer.storage.internal.genericstoreproxy-1) + +[PrivateFileReference](./proffer.storage.internal.privatefilereference) + +[StorageFactory](./proffer.storage.internal.storagefactory) + +[StorageProviderBase<TParsedOptions, TInstanceOptions, TStoreOptions, TScopedStoreOptions>](./proffer.storage.internal.storageproviderbase-4) diff --git a/docs/storage/azure/blobs/api.md b/docs/storage/azure/blobs/api.md new file mode 100644 index 0000000..8795969 --- /dev/null +++ b/docs/storage/azure/blobs/api.md @@ -0,0 +1,31 @@ +# Proffer.Storage.Azure.Blobs + +## Proffer.Storage + +[AzureBlobsStorageServiceCollectionExtensions](./proffer.storage.azureblobsstorageservicecollectionextensions) + +## Proffer.Storage.Azure.Blobs + +[AzureBlobsStorageProvider](./proffer.storage.azure.blobs.azureblobsstorageprovider) + +[AzureBlobsStore](./proffer.storage.azure.blobs.azureblobsstore) + +## Proffer.Storage.Azure.Blobs.Configuration + +[AzureBlobsParsedOptions](./proffer.storage.azure.blobs.configuration.azureblobsparsedoptions) + +[AzureBlobsProviderOptions](./proffer.storage.azure.blobs.configuration.azureblobsprovideroptions) + +[AzureBlobsScopedStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions) + +[AzureBlobsStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsstoreoptions) + +## Proffer.Storage.Azure.Blobs.Internal + +[AzureBlobsFileProperties](./proffer.storage.azure.blobs.internal.azureblobsfileproperties) + +[AzureBlobsFileReference](./proffer.storage.azure.blobs.internal.azureblobsfilereference) + +[AzureBlobsListDirectoryWrapper](./proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper) + +[AzureBlobsListFileWrapper](./proffer.storage.azure.blobs.internal.azureblobslistfilewrapper) diff --git a/docs/storage/azure/blobs/proffer.storage.azure.blobs.azureblobsstorageprovider.md b/docs/storage/azure/blobs/proffer.storage.azure.blobs.azureblobsstorageprovider.md new file mode 100644 index 0000000..ce17d81 --- /dev/null +++ b/docs/storage/azure/blobs/proffer.storage.azure.blobs.azureblobsstorageprovider.md @@ -0,0 +1,75 @@ +# AzureBlobsStorageProvider + +Namespace: Proffer.Storage.Azure.Blobs + +A provider to handle and build file stores pointing on an Azure Storage account. + +```csharp +public class AzureBlobsStorageProvider : Proffer.Storage.Internal.StorageProviderBase`4[[Proffer.Storage.Azure.Blobs.Configuration.AzureBlobsParsedOptions, Proffer.Storage.Azure.Blobs, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[Proffer.Storage.Azure.Blobs.Configuration.AzureBlobsProviderOptions, Proffer.Storage.Azure.Blobs, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[Proffer.Storage.Azure.Blobs.Configuration.AzureBlobsStoreOptions, Proffer.Storage.Azure.Blobs, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[Proffer.Storage.Azure.Blobs.Configuration.AzureBlobsScopedStoreOptions, Proffer.Storage.Azure.Blobs, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Proffer.Storage.IStorageProvider +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → StorageProviderBase<AzureBlobsParsedOptions, AzureBlobsProviderOptions, AzureBlobsStoreOptions, AzureBlobsScopedStoreOptions> → [AzureBlobsStorageProvider](./proffer.storage.azure.blobs.azureblobsstorageprovider)
+Implements IStorageProvider + +## Fields + +### **ProviderName** + +The [AzureBlobsStorageProvider](./proffer.storage.azure.blobs.azureblobsstorageprovider) name. + +```csharp +public static string ProviderName; +``` + +## Properties + +### **Name** + +Gets the name of this provider. + +```csharp +public string Name { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Constructors + +### **AzureBlobsStorageProvider(IOptions<AzureBlobsParsedOptions>)** + +Initializes a new instance of the [AzureBlobsStorageProvider](./proffer.storage.azure.blobs.azureblobsstorageprovider) class. + +```csharp +public AzureBlobsStorageProvider(IOptions options) +``` + +#### Parameters + +`options` IOptions<AzureBlobsParsedOptions>
+The options. + +## Methods + +### **BuildStoreInternal(String, AzureBlobsStoreOptions)** + +Provider-specific build of a store with specific options. + +```csharp +protected IStore BuildStoreInternal(string storeName, AzureBlobsStoreOptions storeOptions) +``` + +#### Parameters + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the store. + +`storeOptions` [AzureBlobsStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsstoreoptions)
+The store options. + +#### Returns + +IStore
+ + A configured . diff --git a/docs/storage/azure/blobs/proffer.storage.azure.blobs.azureblobsstore.md b/docs/storage/azure/blobs/proffer.storage.azure.blobs.azureblobsstore.md new file mode 100644 index 0000000..bfb0608 --- /dev/null +++ b/docs/storage/azure/blobs/proffer.storage.azure.blobs.azureblobsstore.md @@ -0,0 +1,325 @@ +# AzureBlobsStore + +Namespace: Proffer.Storage.Azure.Blobs + +An Azure store allows to save, list or read files on a container in its configured [AzureBlobsStorageProvider](./proffer.storage.azure.blobs.azureblobsstorageprovider). + +```csharp +public class AzureBlobsStore : Proffer.Storage.IStore +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [AzureBlobsStore](./proffer.storage.azure.blobs.azureblobsstore)
+Implements IStore + +## Properties + +### **Name** + +Gets the name of the store. + +```csharp +public string Name { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Constructors + +### **AzureBlobsStore(AzureBlobsStoreOptions)** + +Initializes a new instance of the [AzureBlobsStore](./proffer.storage.azure.blobs.azureblobsstore) class. + +```csharp +public AzureBlobsStore(AzureBlobsStoreOptions storeOptions) +``` + +#### Parameters + +`storeOptions` [AzureBlobsStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsstoreoptions)
+The store options. + +## Methods + +### **InitAsync(CancellationToken)** + +Initializes the store by creating a container in its Proffer.Storage.IStorageProvider. + +```csharp +public Task InitAsync(CancellationToken cancellationToken) +``` + +#### Parameters + +`cancellationToken` [CancellationToken](https://docs.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken)
+ +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **ListAsync(String, Boolean, Boolean)** + +Lists the files under . + +```csharp +public ValueTask ListAsync(string path, bool recursive, bool withMetadata) +``` + +#### Parameters + +`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The path. + +`recursive` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, recurse the listing across folders. + +`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, fetch metadata for each file. + +#### Returns + +ValueTask<IFileReference[]>
+ + The list under . + +### **ListAsync(String, String, Boolean, Boolean)** + +Lists the files under matching the . + +```csharp +public ValueTask ListAsync(string path, string searchPattern, bool recursive, bool withMetadata) +``` + +#### Parameters + +`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The path. + +`searchPattern` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The search pattern. + +`recursive` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, recurse the listing across folders. + +`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, fetch metadata for each file. + +#### Returns + +ValueTask<IFileReference[]>
+ + The list under matching the . + +### **GetAsync(IPrivateFileReference, Boolean)** + +Gets the file reference from path. + +```csharp +public ValueTask GetAsync(IPrivateFileReference file, bool withMetadata) +``` + +#### Parameters + +`file` IPrivateFileReference
+The reference holding the file path. + +`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, fetch metadata for the file. + +#### Returns + +ValueTask<IFileReference>
+ + The at path. + +### **GetAsync(Uri, Boolean)** + +Gets the file reference from URI. + +```csharp +public ValueTask GetAsync(Uri uri, bool withMetadata) +``` + +#### Parameters + +`uri` Uri
+The file uniform resource identifier (URI). + +`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, fetch metadata for the file. + +#### Returns + +ValueTask<IFileReference>
+ + The at path. + +#### Exceptions + +[InvalidOperationException](https://docs.microsoft.com/en-us/dotnet/api/system.invalidoperationexception)
+ +### **DeleteAsync(IPrivateFileReference)** + +Deletes the file. + +```csharp +public Task DeleteAsync(IPrivateFileReference file) +``` + +#### Parameters + +`file` IPrivateFileReference
+The reference holding the file path. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ +### **ReadAsync(IPrivateFileReference)** + +Reads the file content. + +```csharp +public ValueTask ReadAsync(IPrivateFileReference file) +``` + +#### Parameters + +`file` IPrivateFileReference
+The reference holding the file path. + +#### Returns + +ValueTask<Stream>
+ + A containing the file content. + +### **ReadAllBytesAsync(IPrivateFileReference)** + +Reads the file content. + +```csharp +public ValueTask ReadAllBytesAsync(IPrivateFileReference file) +``` + +#### Parameters + +`file` IPrivateFileReference
+The reference holding the file path. + +#### Returns + +ValueTask<Byte[]>
+ + A containing the file content. + +### **ReadAllTextAsync(IPrivateFileReference)** + +Reads the file content. + +```csharp +public ValueTask ReadAllTextAsync(IPrivateFileReference file) +``` + +#### Parameters + +`file` IPrivateFileReference
+The reference holding the file path. + +#### Returns + +ValueTask<String>
+ + A containing the file content. + +### **SaveAsync(Byte[], IPrivateFileReference, String, OverwritePolicy, IDictionary<String, String>)** + +Saves the file. + +```csharp +public ValueTask SaveAsync(Byte[] data, IPrivateFileReference file, string contentType, OverwritePolicy overwritePolicy, IDictionary metadata) +``` + +#### Parameters + +`data` [Byte[]](https://docs.microsoft.com/en-us/dotnet/api/system.byte)
+The file content. + +`file` IPrivateFileReference
+The reference holding the file path. + +`contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The content-type of the file. + +`overwritePolicy` OverwritePolicy
+The overwrite policy. + +`metadata` [IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
+The metadata. + +#### Returns + +ValueTask<IFileReference>
+ + The saved . + +#### Exceptions + +Proffer.Storage.Exceptions.FileAlreadyExistsException
+ +### **SaveAsync(Stream, IPrivateFileReference, String, OverwritePolicy, IDictionary<String, String>)** + +Saves the file. + +```csharp +public ValueTask SaveAsync(Stream data, IPrivateFileReference file, string contentType, OverwritePolicy overwritePolicy, IDictionary metadata) +``` + +#### Parameters + +`data` [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream)
+The file content. + +`file` IPrivateFileReference
+The reference holding the file path. + +`contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The content-type of the file. + +`overwritePolicy` OverwritePolicy
+The overwrite policy. + +`metadata` [IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
+The metadata. + +#### Returns + +ValueTask<IFileReference>
+ + The saved . + +#### Exceptions + +Proffer.Storage.Exceptions.FileAlreadyExistsException
+ +### **GetSharedAccessSignatureAsync(ISharedAccessPolicy)** + +Gets a shared access signature. + +```csharp +public ValueTask GetSharedAccessSignatureAsync(ISharedAccessPolicy policy) +``` + +#### Parameters + +`policy` ISharedAccessPolicy
+The policy. + +#### Returns + +ValueTask<String>
+ + A shared access signature to read or list the store files. diff --git a/docs/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md b/docs/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md new file mode 100644 index 0000000..96966de --- /dev/null +++ b/docs/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md @@ -0,0 +1,123 @@ +# AzureBlobsParsedOptions + +Namespace: Proffer.Storage.Azure.Blobs.Configuration + +Typed Azure Blobs options parsed from the dynamic configuration. + +```csharp +public class AzureBlobsParsedOptions : Proffer.Storage.Configuration.IParsedOptions`3[[Proffer.Storage.Azure.Blobs.Configuration.AzureBlobsProviderOptions, Proffer.Storage.Azure.Blobs, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[Proffer.Storage.Azure.Blobs.Configuration.AzureBlobsStoreOptions, Proffer.Storage.Azure.Blobs, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[Proffer.Storage.Azure.Blobs.Configuration.AzureBlobsScopedStoreOptions, Proffer.Storage.Azure.Blobs, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [AzureBlobsParsedOptions](./proffer.storage.azure.blobs.configuration.azureblobsparsedoptions)
+Implements IParsedOptions<AzureBlobsProviderOptions, AzureBlobsStoreOptions, AzureBlobsScopedStoreOptions> + +## Properties + +### **Name** + +Gets the name. + +```csharp +public string Name { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ConnectionStrings** + +Gets or sets the connection strings. + +```csharp +public IReadOnlyDictionary ConnectionStrings { get; set; } +``` + +#### Property Value + +[IReadOnlyDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
+ +### **ParsedProviders** + +Gets or sets the parsed provider instances options. + +```csharp +public IReadOnlyDictionary ParsedProviders { get; set; } +``` + +#### Property Value + +[IReadOnlyDictionary<String, AzureBlobsProviderOptions>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
+ +### **ParsedStores** + +Gets or sets the parsed stores options. + +```csharp +public IReadOnlyDictionary ParsedStores { get; set; } +``` + +#### Property Value + +[IReadOnlyDictionary<String, AzureBlobsStoreOptions>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
+ +### **ParsedScopedStores** + +Gets or sets the parsed scoped stores options. + +```csharp +public IReadOnlyDictionary ParsedScopedStores { get; set; } +``` + +#### Property Value + +[IReadOnlyDictionary<String, AzureBlobsScopedStoreOptions>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
+ +## Constructors + +### **AzureBlobsParsedOptions()** + + + +```csharp +public AzureBlobsParsedOptions() +``` + +## Methods + +### **BindProviderOptions(AzureBlobsProviderOptions)** + +Binds the provider instance options. + +```csharp +public void BindProviderOptions(AzureBlobsProviderOptions providerInstanceOptions) +``` + +#### Parameters + +`providerInstanceOptions` [AzureBlobsProviderOptions](./proffer.storage.azure.blobs.configuration.azureblobsprovideroptions)
+The provider instance options. + +#### Exceptions + +Proffer.Storage.Exceptions.BadProviderConfiguration
+ +### **BindStoreOptions(AzureBlobsStoreOptions, AzureBlobsProviderOptions)** + +Binds the store options. + +```csharp +public void BindStoreOptions(AzureBlobsStoreOptions storeOptions, AzureBlobsProviderOptions providerInstanceOptions) +``` + +#### Parameters + +`storeOptions` [AzureBlobsStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsstoreoptions)
+The store options. + +`providerInstanceOptions` [AzureBlobsProviderOptions](./proffer.storage.azure.blobs.configuration.azureblobsprovideroptions)
+The provider instance options. + +#### Exceptions + +Proffer.Storage.Exceptions.BadStoreConfiguration
diff --git a/docs/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md b/docs/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md new file mode 100644 index 0000000..cbc0fe8 --- /dev/null +++ b/docs/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md @@ -0,0 +1,72 @@ +# AzureBlobsProviderOptions + +Namespace: Proffer.Storage.Azure.Blobs.Configuration + +Options for an [AzureBlobsStorageProvider](./proffer.storage.azure.blobs.azureblobsstorageprovider). + +```csharp +public class AzureBlobsProviderOptions : Proffer.Configuration.ProviderOptions, Proffer.Configuration.IProviderOptions, Proffer.Configuration.INamedElementOptions, Proffer.Azure.Configuration.IAzureStorageOptions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → ProviderOptions → [AzureBlobsProviderOptions](./proffer.storage.azure.blobs.configuration.azureblobsprovideroptions)
+Implements IProviderOptions, INamedElementOptions, IAzureStorageOptions + +## Properties + +### **ConnectionString** + +Gets or sets the connection string. + +```csharp +public string ConnectionString { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ConnectionStringName** + +Gets or sets the name of the connection string to reference. + +```csharp +public string ConnectionStringName { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Name** + + + +```csharp +public string Name { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Type** + + + +```csharp +public string Type { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Constructors + +### **AzureBlobsProviderOptions()** + + + +```csharp +public AzureBlobsProviderOptions() +``` diff --git a/docs/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md b/docs/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md new file mode 100644 index 0000000..541da5e --- /dev/null +++ b/docs/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md @@ -0,0 +1,120 @@ +# AzureBlobsScopedStoreOptions + +Namespace: Proffer.Storage.Azure.Blobs.Configuration + +Options for a scoped [AzureBlobsStore](./proffer.storage.azure.blobs.azureblobsstore). + +```csharp +public class AzureBlobsScopedStoreOptions : AzureBlobsStoreOptions, Proffer.Storage.Configuration.IStoreOptions, Proffer.Configuration.INamedElementOptions, Proffer.Azure.Configuration.IAzureStorageOptions, Proffer.Storage.Configuration.IScopedStoreOptions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → StoreOptions → [AzureBlobsStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsstoreoptions) → [AzureBlobsScopedStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions)
+Implements IStoreOptions, INamedElementOptions, IAzureStorageOptions, IScopedStoreOptions + +## Properties + +### **FolderNameFormat** + +Gets the folder name format. + +```csharp +public string FolderNameFormat { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ConnectionString** + +Gets or sets the connection string. + +```csharp +public string ConnectionString { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ConnectionStringName** + +Gets or sets the name of the connection string to reference. + +```csharp +public string ConnectionStringName { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Name** + + + +```csharp +public string Name { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ProviderName** + + + +```csharp +public string ProviderName { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ProviderType** + + + +```csharp +public string ProviderType { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **AccessLevel** + + + +```csharp +public AccessLevel AccessLevel { get; set; } +``` + +#### Property Value + +AccessLevel
+ +### **FolderName** + + + +```csharp +public string FolderName { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Constructors + +### **AzureBlobsScopedStoreOptions()** + + + +```csharp +public AzureBlobsScopedStoreOptions() +``` diff --git a/docs/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md b/docs/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md new file mode 100644 index 0000000..3231659 --- /dev/null +++ b/docs/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md @@ -0,0 +1,133 @@ +# AzureBlobsStoreOptions + +Namespace: Proffer.Storage.Azure.Blobs.Configuration + +Options for an [AzureBlobsStore](./proffer.storage.azure.blobs.azureblobsstore). + +```csharp +public class AzureBlobsStoreOptions : Proffer.Storage.Configuration.StoreOptions, Proffer.Storage.Configuration.IStoreOptions, Proffer.Configuration.INamedElementOptions, Proffer.Azure.Configuration.IAzureStorageOptions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → StoreOptions → [AzureBlobsStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsstoreoptions)
+Implements IStoreOptions, INamedElementOptions, IAzureStorageOptions + +## Properties + +### **ConnectionString** + +Gets or sets the connection string. + +```csharp +public string ConnectionString { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ConnectionStringName** + +Gets or sets the name of the connection string to reference. + +```csharp +public string ConnectionStringName { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Name** + + + +```csharp +public string Name { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ProviderName** + + + +```csharp +public string ProviderName { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ProviderType** + + + +```csharp +public string ProviderType { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **AccessLevel** + + + +```csharp +public AccessLevel AccessLevel { get; set; } +``` + +#### Property Value + +AccessLevel
+ +### **FolderName** + + + +```csharp +public string FolderName { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Constructors + +### **AzureBlobsStoreOptions()** + + + +```csharp +public AzureBlobsStoreOptions() +``` + +## Methods + +### **Validate(Boolean)** + +Validates the options. + +```csharp +public IEnumerable Validate(bool throwOnError) +``` + +#### Parameters + +`throwOnError` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, throws an exception when the validation fails with any . + +#### Returns + +[IEnumerable<IOptionError>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+ + The returned by the validation, if any. + +#### Exceptions + +Proffer.Storage.Exceptions.BadStoreConfiguration
diff --git a/docs/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md b/docs/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md new file mode 100644 index 0000000..c1062e7 --- /dev/null +++ b/docs/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md @@ -0,0 +1,146 @@ +# AzureBlobsFileProperties + +Namespace: Proffer.Storage.Azure.Blobs.Internal + +File common properties with metadata stored on Azure Blobs. + +```csharp +public class AzureBlobsFileProperties : Proffer.Storage.IFileProperties +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [AzureBlobsFileProperties](./proffer.storage.azure.blobs.internal.azureblobsfileproperties)
+Implements IFileProperties + +## Properties + +### **LastModified** + +Gets the last modified time. + +```csharp +public Nullable LastModified { get; private set; } +``` + +#### Property Value + +[Nullable<DateTimeOffset>](https://docs.microsoft.com/en-us/dotnet/api/system.nullable-1)
+ +### **Length** + +Gets the length of the content. + +```csharp +public long Length { get; private set; } +``` + +#### Property Value + +[Int64](https://docs.microsoft.com/en-us/dotnet/api/system.int64)
+ +### **ContentType** + +Gets or sets the content-type. + +```csharp +public string ContentType { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ETag** + +Gets the etag. + +```csharp +public string ETag { get; private set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **CacheControl** + +Gets or sets the cache control. + +```csharp +public string CacheControl { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ContentMD5** + +Gets the MD5 digest of the content. + +```csharp +public string ContentMD5 { get; private set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Metadata** + +Gets the metadata. + +```csharp +public IDictionary Metadata { get; } +``` + +#### Property Value + +[IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
+ +## Constructors + +### **AzureBlobsFileProperties(BlobClient, BlobProperties)** + +Initializes a new instance of the [AzureBlobsFileProperties](./proffer.storage.azure.blobs.internal.azureblobsfileproperties) class. + +```csharp +public AzureBlobsFileProperties(BlobClient blobClient, BlobProperties blobProperties) +``` + +#### Parameters + +`blobClient` BlobClient
+The Azure Blobs client. + +`blobProperties` BlobProperties
+The blob properties. + +### **AzureBlobsFileProperties(BlobClient, BlobItem)** + +Initializes a new instance of the [AzureBlobsFileProperties](./proffer.storage.azure.blobs.internal.azureblobsfileproperties) class. + +```csharp +public AzureBlobsFileProperties(BlobClient blobClient, BlobItem blobItem) +``` + +#### Parameters + +`blobClient` BlobClient
+The Azure Blobs client. + +`blobItem` BlobItem
+The blob item from listing. + +## Methods + +### **SaveAsync()** + + + +```csharp +internal Task SaveAsync() +``` + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
diff --git a/docs/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobsfilereference.md b/docs/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobsfilereference.md new file mode 100644 index 0000000..49155ce --- /dev/null +++ b/docs/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobsfilereference.md @@ -0,0 +1,221 @@ +# AzureBlobsFileReference + +Namespace: Proffer.Storage.Azure.Blobs.Internal + +A reference of a stored file at a given path on Azure Blobs. + +```csharp +public class AzureBlobsFileReference : Proffer.Storage.IFileReference, Proffer.Storage.IPrivateFileReference +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [AzureBlobsFileReference](./proffer.storage.azure.blobs.internal.azureblobsfilereference)
+Implements IFileReference, IPrivateFileReference + +## Properties + +### **Path** + +Gets the file path. + +```csharp +public string Path { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Properties** + +Gets the properties. + +```csharp +public IFileProperties Properties { get; } +``` + +#### Property Value + +IFileProperties
+ +### **PublicUrl** + +Gets the public URL. + +```csharp +public string PublicUrl { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Constructors + +### **AzureBlobsFileReference(BlobClient, AzureBlobsFileProperties)** + +Initializes a new instance of the [AzureBlobsFileReference](./proffer.storage.azure.blobs.internal.azureblobsfilereference) class. + +```csharp +public AzureBlobsFileReference(BlobClient blobClient, AzureBlobsFileProperties properties) +``` + +#### Parameters + +`blobClient` BlobClient
+The Azure Blobs client. + +`properties` [AzureBlobsFileProperties](./proffer.storage.azure.blobs.internal.azureblobsfileproperties)
+The properties, if fetched. + +## Methods + +### **DeleteAsync()** + +Deletes the file. + +```csharp +public Task DeleteAsync() +``` + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **ReadAsync()** + +Reads the file content. + +```csharp +public ValueTask ReadAsync() +``` + +#### Returns + +ValueTask<Stream>
+ + A containing the file content. + +### **ReadInMemoryAsync()** + +Reads the file content in memory. + +```csharp +public ValueTask ReadInMemoryAsync() +``` + +#### Returns + +ValueTask<MemoryStream>
+A new containing the file content. + +### **UpdateAsync(Stream)** + +Updates the file content with the given [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream). + +```csharp +public Task UpdateAsync(Stream stream) +``` + +#### Parameters + +`stream` [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream)
+The new file content. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **ReadToStreamAsync(Stream)** + +Reads the file content into the given stream. + +```csharp +public Task ReadToStreamAsync(Stream targetStream) +``` + +#### Parameters + +`targetStream` [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream)
+The target stream. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ +### **ReadAllTextAsync()** + +Reads the file content. + +```csharp +public ValueTask ReadAllTextAsync() +``` + +#### Returns + +ValueTask<String>
+ + A containing the file content. + +### **ReadAllBytesAsync()** + +Reads the file content. + +```csharp +public ValueTask ReadAllBytesAsync() +``` + +#### Returns + +ValueTask<Byte[]>
+ + A containing the file content. + +### **SavePropertiesAsync()** + +Saves the file properties. + +```csharp +public Task SavePropertiesAsync() +``` + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **GetSharedAccessSignature(ISharedAccessPolicy)** + +Gets a shared access signature. + +```csharp +public ValueTask GetSharedAccessSignature(ISharedAccessPolicy policy) +``` + +#### Parameters + +`policy` ISharedAccessPolicy
+The policy. + +#### Returns + +ValueTask<String>
+ + A shared access signature to read file. + +### **FetchProperties()** + +Fetches the file properties. + +```csharp +public Task FetchProperties() +``` + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+A task that represents the asynchronous operation. diff --git a/docs/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md b/docs/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md new file mode 100644 index 0000000..3a6aebc --- /dev/null +++ b/docs/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md @@ -0,0 +1,138 @@ +# AzureBlobsListDirectoryWrapper + +Namespace: Proffer.Storage.Azure.Blobs.Internal + +Represents a directory in a being-listed [AzureBlobsStore](./proffer.storage.azure.blobs.azureblobsstore). + +```csharp +public class AzureBlobsListDirectoryWrapper : Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → FileSystemInfoBase → DirectoryInfoBase → [AzureBlobsListDirectoryWrapper](./proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper) + +## Properties + +### **FullName** + +A string containing the full path of the directory. + +```csharp +public string FullName { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Name** + +A string containing the name of the directory. + +```csharp +public string Name { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ParentDirectory** + +The parent directory for the current directory. + +```csharp +public DirectoryInfoBase ParentDirectory { get; } +``` + +#### Property Value + +DirectoryInfoBase
+ +## Constructors + +### **AzureBlobsListDirectoryWrapper(FileSystemInfoBase)** + +Initializes a new instance of the [AzureBlobsListDirectoryWrapper](./proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper) class. + +```csharp +public AzureBlobsListDirectoryWrapper(FileSystemInfoBase childrens) +``` + +#### Parameters + +`childrens` FileSystemInfoBase
+The childrens. + +### **AzureBlobsListDirectoryWrapper(String, Dictionary<String, AzureBlobsFileReference>)** + +Initializes a new instance of the [AzureBlobsListDirectoryWrapper](./proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper) class. + +```csharp +public AzureBlobsListDirectoryWrapper(string path, Dictionary files) +``` + +#### Parameters + +`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The directory path. + +`files` [Dictionary<String, AzureBlobsFileReference>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.dictionary-2)
+The files. + +## Methods + +### **EnumerateFileSystemInfos()** + +Enumerates all files and directories in the directory. + +```csharp +public IEnumerable EnumerateFileSystemInfos() +``` + +#### Returns + +[IEnumerable<FileSystemInfoBase>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+ + Collection of files and directories + +### **GetDirectory(String)** + +Returns an instance of Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase that represents a subdirectory. + +```csharp +public DirectoryInfoBase GetDirectory(string path) +``` + +#### Parameters + +`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The directory name + +#### Returns + +DirectoryInfoBase
+ + Instance of even if directory does not exist + +#### Exceptions + +[NotImplementedException](https://docs.microsoft.com/en-us/dotnet/api/system.notimplementedexception)
+ +### **GetFile(String)** + +Returns an instance of Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoBase that represents a file in the directory. + +```csharp +public FileInfoBase GetFile(string path) +``` + +#### Parameters + +`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The file name + +#### Returns + +FileInfoBase
+ + Instance of even if file does not exist diff --git a/docs/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md b/docs/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md new file mode 100644 index 0000000..cb8da1a --- /dev/null +++ b/docs/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md @@ -0,0 +1,67 @@ +# AzureBlobsListFileWrapper + +Namespace: Proffer.Storage.Azure.Blobs.Internal + +Represents a file in a being-listed [AzureBlobsStore](./proffer.storage.azure.blobs.azureblobsstore). + +```csharp +public class AzureBlobsListFileWrapper : Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoBase +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → FileSystemInfoBase → FileInfoBase → [AzureBlobsListFileWrapper](./proffer.storage.azure.blobs.internal.azureblobslistfilewrapper) + +## Properties + +### **FullName** + +A string containing the full path of the file. + +```csharp +public string FullName { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Name** + +A string containing the name of the file. + +```csharp +public string Name { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ParentDirectory** + +The parent directory for the current file. + +```csharp +public DirectoryInfoBase ParentDirectory { get; } +``` + +#### Property Value + +DirectoryInfoBase
+ +## Constructors + +### **AzureBlobsListFileWrapper(AzureBlobsFileReference, AzureBlobsListDirectoryWrapper)** + +Initializes a new instance of the [AzureBlobsListFileWrapper](./proffer.storage.azure.blobs.internal.azureblobslistfilewrapper) class. + +```csharp +public AzureBlobsListFileWrapper(AzureBlobsFileReference file, AzureBlobsListDirectoryWrapper parent) +``` + +#### Parameters + +`file` [AzureBlobsFileReference](./proffer.storage.azure.blobs.internal.azureblobsfilereference)
+The file reference. + +`parent` [AzureBlobsListDirectoryWrapper](./proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper)
+The parent directory. diff --git a/docs/storage/azure/blobs/proffer.storage.azureblobsstorageservicecollectionextensions.md b/docs/storage/azure/blobs/proffer.storage.azureblobsstorageservicecollectionextensions.md new file mode 100644 index 0000000..987bd9b --- /dev/null +++ b/docs/storage/azure/blobs/proffer.storage.azureblobsstorageservicecollectionextensions.md @@ -0,0 +1,31 @@ +# AzureBlobsStorageServiceCollectionExtensions + +Namespace: Proffer.Storage + +Microsoft.Extensions.DependencyInjection.IServiceCollection extension methods. + +```csharp +public static class AzureBlobsStorageServiceCollectionExtensions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [AzureBlobsStorageServiceCollectionExtensions](./proffer.storage.azureblobsstorageservicecollectionextensions) + +## Methods + +### **AddAzureStorage(IServiceCollection)** + +Registers the Proffer.Storage services to Azure Blobs. + +```csharp +public static IServiceCollection AddAzureStorage(IServiceCollection services) +``` + +#### Parameters + +`services` IServiceCollection
+The service collection. + +#### Returns + +IServiceCollection
+The service collection. diff --git a/docs/storage/filesystem/api.md b/docs/storage/filesystem/api.md new file mode 100644 index 0000000..343ef6e --- /dev/null +++ b/docs/storage/filesystem/api.md @@ -0,0 +1,35 @@ +# Proffer.Storage.FileSystem + +## Proffer.Storage + +[FileSystemStorageServiceCollectionExtensions](./proffer.storage.filesystemstorageservicecollectionextensions) + +## Proffer.Storage.FileSystem + +[FileSystemStorageProvider](./proffer.storage.filesystem.filesystemstorageprovider) + +[FileSystemStore](./proffer.storage.filesystem.filesystemstore) + +[IExtendedPropertiesProvider](./proffer.storage.filesystem.iextendedpropertiesprovider) + +[IPublicUrlProvider](./proffer.storage.filesystem.ipublicurlprovider) + +[NoExtendedPropertiesProvider](./proffer.storage.filesystem.noextendedpropertiesprovider) + +## Proffer.Storage.FileSystem.Configuration + +[FileSystemParsedOptions](./proffer.storage.filesystem.configuration.filesystemparsedoptions) + +[FileSystemProviderOptions](./proffer.storage.filesystem.configuration.filesystemprovideroptions) + +[FileSystemScopedStoreOptions](./proffer.storage.filesystem.configuration.filesystemscopedstoreoptions) + +[FileSystemStoreOptions](./proffer.storage.filesystem.configuration.filesystemstoreoptions) + +## Proffer.Storage.FileSystem.Internal + +[FileExtendedProperties](./proffer.storage.filesystem.internal.fileextendedproperties) + +[FileSystemFileProperties](./proffer.storage.filesystem.internal.filesystemfileproperties) + +[FileSystemFileReference](./proffer.storage.filesystem.internal.filesystemfilereference) diff --git a/docs/storage/filesystem/proffer.storage.filesystem.configuration.filesystemparsedoptions.md b/docs/storage/filesystem/proffer.storage.filesystem.configuration.filesystemparsedoptions.md new file mode 100644 index 0000000..0ad05b8 --- /dev/null +++ b/docs/storage/filesystem/proffer.storage.filesystem.configuration.filesystemparsedoptions.md @@ -0,0 +1,127 @@ +# FileSystemParsedOptions + +Namespace: Proffer.Storage.FileSystem.Configuration + +Typed File System options parsed from the dynamic configuration. + +```csharp +public class FileSystemParsedOptions : Proffer.Storage.Configuration.IParsedOptions`3[[Proffer.Storage.FileSystem.Configuration.FileSystemProviderOptions, Proffer.Storage.FileSystem, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[Proffer.Storage.FileSystem.Configuration.FileSystemStoreOptions, Proffer.Storage.FileSystem, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[Proffer.Storage.FileSystem.Configuration.FileSystemScopedStoreOptions, Proffer.Storage.FileSystem, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemParsedOptions](./proffer.storage.filesystem.configuration.filesystemparsedoptions)
+Implements IParsedOptions<FileSystemProviderOptions, FileSystemStoreOptions, FileSystemScopedStoreOptions> + +## Properties + +### **Name** + +Gets the name. + +```csharp +public string Name { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ConnectionStrings** + +Gets or sets the connection strings. + +```csharp +public IReadOnlyDictionary ConnectionStrings { get; set; } +``` + +#### Property Value + +[IReadOnlyDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
+ +### **ParsedProviders** + +Gets or sets the parsed provider instances options. + +```csharp +public IReadOnlyDictionary ParsedProviders { get; set; } +``` + +#### Property Value + +[IReadOnlyDictionary<String, FileSystemProviderOptions>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
+ +### **ParsedStores** + +Gets or sets the parsed stores options. + +```csharp +public IReadOnlyDictionary ParsedStores { get; set; } +``` + +#### Property Value + +[IReadOnlyDictionary<String, FileSystemStoreOptions>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
+ +### **ParsedScopedStores** + +Gets or sets the parsed scoped stores options. + +```csharp +public IReadOnlyDictionary ParsedScopedStores { get; set; } +``` + +#### Property Value + +[IReadOnlyDictionary<String, FileSystemScopedStoreOptions>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
+ +### **RootPath** + +Gets or sets the root path. + +```csharp +public string RootPath { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Constructors + +### **FileSystemParsedOptions()** + + + +```csharp +public FileSystemParsedOptions() +``` + +## Methods + +### **BindProviderOptions(FileSystemProviderOptions)** + +Binds the provider instance options. + +```csharp +public void BindProviderOptions(FileSystemProviderOptions providerInstanceOptions) +``` + +#### Parameters + +`providerInstanceOptions` [FileSystemProviderOptions](./proffer.storage.filesystem.configuration.filesystemprovideroptions)
+The provider instance options. + +### **BindStoreOptions(FileSystemStoreOptions, FileSystemProviderOptions)** + +Binds the store options. + +```csharp +public void BindStoreOptions(FileSystemStoreOptions storeOptions, FileSystemProviderOptions providerInstanceOptions) +``` + +#### Parameters + +`storeOptions` [FileSystemStoreOptions](./proffer.storage.filesystem.configuration.filesystemstoreoptions)
+The store options. + +`providerInstanceOptions` [FileSystemProviderOptions](./proffer.storage.filesystem.configuration.filesystemprovideroptions)
+The provider instance options. diff --git a/docs/storage/filesystem/proffer.storage.filesystem.configuration.filesystemprovideroptions.md b/docs/storage/filesystem/proffer.storage.filesystem.configuration.filesystemprovideroptions.md new file mode 100644 index 0000000..afefdcd --- /dev/null +++ b/docs/storage/filesystem/proffer.storage.filesystem.configuration.filesystemprovideroptions.md @@ -0,0 +1,60 @@ +# FileSystemProviderOptions + +Namespace: Proffer.Storage.FileSystem.Configuration + +Options for a [FileSystemStorageProvider](./proffer.storage.filesystem.filesystemstorageprovider). + +```csharp +public class FileSystemProviderOptions : Proffer.Configuration.ProviderOptions, Proffer.Configuration.IProviderOptions, Proffer.Configuration.INamedElementOptions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → ProviderOptions → [FileSystemProviderOptions](./proffer.storage.filesystem.configuration.filesystemprovideroptions)
+Implements IProviderOptions, INamedElementOptions + +## Properties + +### **RootPath** + +Gets or sets the root path. + +```csharp +public string RootPath { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Name** + + + +```csharp +public string Name { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Type** + + + +```csharp +public string Type { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Constructors + +### **FileSystemProviderOptions()** + + + +```csharp +public FileSystemProviderOptions() +``` diff --git a/docs/storage/filesystem/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md b/docs/storage/filesystem/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md new file mode 100644 index 0000000..cbbc749 --- /dev/null +++ b/docs/storage/filesystem/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md @@ -0,0 +1,120 @@ +# FileSystemScopedStoreOptions + +Namespace: Proffer.Storage.FileSystem.Configuration + +Options for a scoped [FileSystemStore](./proffer.storage.filesystem.filesystemstore). + +```csharp +public class FileSystemScopedStoreOptions : FileSystemStoreOptions, Proffer.Storage.Configuration.IStoreOptions, Proffer.Configuration.INamedElementOptions, Proffer.Storage.Configuration.IScopedStoreOptions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → StoreOptions → [FileSystemStoreOptions](./proffer.storage.filesystem.configuration.filesystemstoreoptions) → [FileSystemScopedStoreOptions](./proffer.storage.filesystem.configuration.filesystemscopedstoreoptions)
+Implements IStoreOptions, INamedElementOptions, IScopedStoreOptions + +## Properties + +### **FolderNameFormat** + +Gets the folder name format. + +```csharp +public string FolderNameFormat { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **RootPath** + +Gets or sets the root path. + +```csharp +public string RootPath { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **AbsolutePath** + +Gets the absolute path. + +```csharp +public string AbsolutePath { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Name** + + + +```csharp +public string Name { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ProviderName** + + + +```csharp +public string ProviderName { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ProviderType** + + + +```csharp +public string ProviderType { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **AccessLevel** + + + +```csharp +public AccessLevel AccessLevel { get; set; } +``` + +#### Property Value + +AccessLevel
+ +### **FolderName** + + + +```csharp +public string FolderName { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Constructors + +### **FileSystemScopedStoreOptions()** + + + +```csharp +public FileSystemScopedStoreOptions() +``` diff --git a/docs/storage/filesystem/proffer.storage.filesystem.configuration.filesystemstoreoptions.md b/docs/storage/filesystem/proffer.storage.filesystem.configuration.filesystemstoreoptions.md new file mode 100644 index 0000000..5d71d1b --- /dev/null +++ b/docs/storage/filesystem/proffer.storage.filesystem.configuration.filesystemstoreoptions.md @@ -0,0 +1,133 @@ +# FileSystemStoreOptions + +Namespace: Proffer.Storage.FileSystem.Configuration + +Options for an [FileSystemStore](./proffer.storage.filesystem.filesystemstore). + +```csharp +public class FileSystemStoreOptions : Proffer.Storage.Configuration.StoreOptions, Proffer.Storage.Configuration.IStoreOptions, Proffer.Configuration.INamedElementOptions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → StoreOptions → [FileSystemStoreOptions](./proffer.storage.filesystem.configuration.filesystemstoreoptions)
+Implements IStoreOptions, INamedElementOptions + +## Properties + +### **RootPath** + +Gets or sets the root path. + +```csharp +public string RootPath { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **AbsolutePath** + +Gets the absolute path. + +```csharp +public string AbsolutePath { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Name** + + + +```csharp +public string Name { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ProviderName** + + + +```csharp +public string ProviderName { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ProviderType** + + + +```csharp +public string ProviderType { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **AccessLevel** + + + +```csharp +public AccessLevel AccessLevel { get; set; } +``` + +#### Property Value + +AccessLevel
+ +### **FolderName** + + + +```csharp +public string FolderName { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Constructors + +### **FileSystemStoreOptions()** + + + +```csharp +public FileSystemStoreOptions() +``` + +## Methods + +### **Validate(Boolean)** + +Validates the options. + +```csharp +public IEnumerable Validate(bool throwOnError) +``` + +#### Parameters + +`throwOnError` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, throws an exception when the validation fails with any . + +#### Returns + +[IEnumerable<IOptionError>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+ + The returned by the validation, if any. + +#### Exceptions + +Proffer.Storage.Exceptions.BadStoreConfiguration
diff --git a/docs/storage/filesystem/proffer.storage.filesystem.filesystemstorageprovider.md b/docs/storage/filesystem/proffer.storage.filesystem.filesystemstorageprovider.md new file mode 100644 index 0000000..075f588 --- /dev/null +++ b/docs/storage/filesystem/proffer.storage.filesystem.filesystemstorageprovider.md @@ -0,0 +1,81 @@ +# FileSystemStorageProvider + +Namespace: Proffer.Storage.FileSystem + +A provider to handle and build file stores pointing on a File System directory. + +```csharp +public class FileSystemStorageProvider : Proffer.Storage.Internal.StorageProviderBase`4[[Proffer.Storage.FileSystem.Configuration.FileSystemParsedOptions, Proffer.Storage.FileSystem, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[Proffer.Storage.FileSystem.Configuration.FileSystemProviderOptions, Proffer.Storage.FileSystem, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[Proffer.Storage.FileSystem.Configuration.FileSystemStoreOptions, Proffer.Storage.FileSystem, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[Proffer.Storage.FileSystem.Configuration.FileSystemScopedStoreOptions, Proffer.Storage.FileSystem, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Proffer.Storage.IStorageProvider +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → StorageProviderBase<FileSystemParsedOptions, FileSystemProviderOptions, FileSystemStoreOptions, FileSystemScopedStoreOptions> → [FileSystemStorageProvider](./proffer.storage.filesystem.filesystemstorageprovider)
+Implements IStorageProvider + +## Fields + +### **ProviderName** + +The [FileSystemStorageProvider](./proffer.storage.filesystem.filesystemstorageprovider) name. + +```csharp +public static string ProviderName; +``` + +## Properties + +### **Name** + +Gets the name of this provider. + +```csharp +public string Name { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Constructors + +### **FileSystemStorageProvider(IOptions<FileSystemParsedOptions>, IPublicUrlProvider, IExtendedPropertiesProvider)** + +Initializes a new instance of the [FileSystemStorageProvider](./proffer.storage.filesystem.filesystemstorageprovider) class. + +```csharp +public FileSystemStorageProvider(IOptions options, IPublicUrlProvider publicUrlProvider, IExtendedPropertiesProvider extendedPropertiesProvider) +``` + +#### Parameters + +`options` IOptions<FileSystemParsedOptions>
+The options. + +`publicUrlProvider` [IPublicUrlProvider](./proffer.storage.filesystem.ipublicurlprovider)
+The public URL provider. + +`extendedPropertiesProvider` [IExtendedPropertiesProvider](./proffer.storage.filesystem.iextendedpropertiesprovider)
+The extended properties provider. + +## Methods + +### **BuildStoreInternal(String, FileSystemStoreOptions)** + +Provider-specific build of a store with specific options. + +```csharp +protected IStore BuildStoreInternal(string storeName, FileSystemStoreOptions storeOptions) +``` + +#### Parameters + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the store. + +`storeOptions` [FileSystemStoreOptions](./proffer.storage.filesystem.configuration.filesystemstoreoptions)
+The store options. + +#### Returns + +IStore
+ + A configured . diff --git a/docs/storage/filesystem/proffer.storage.filesystem.filesystemstore.md b/docs/storage/filesystem/proffer.storage.filesystem.filesystemstore.md new file mode 100644 index 0000000..b745773 --- /dev/null +++ b/docs/storage/filesystem/proffer.storage.filesystem.filesystemstore.md @@ -0,0 +1,331 @@ +# FileSystemStore + +Namespace: Proffer.Storage.FileSystem + +A File System store allows to save, list or read files on a container in its configured [FileSystemStorageProvider](./proffer.storage.filesystem.filesystemstorageprovider). + +```csharp +public class FileSystemStore : Proffer.Storage.IStore +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemStore](./proffer.storage.filesystem.filesystemstore)
+Implements IStore + +## Properties + +### **Name** + +Gets the name of the store. + +```csharp +public string Name { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Constructors + +### **FileSystemStore(FileSystemStoreOptions, IPublicUrlProvider, IExtendedPropertiesProvider)** + +Initializes a new instance of the [FileSystemStore](./proffer.storage.filesystem.filesystemstore) class. + +```csharp +public FileSystemStore(FileSystemStoreOptions storeOptions, IPublicUrlProvider publicUrlProvider, IExtendedPropertiesProvider extendedPropertiesProvider) +``` + +#### Parameters + +`storeOptions` [FileSystemStoreOptions](./proffer.storage.filesystem.configuration.filesystemstoreoptions)
+The store options. + +`publicUrlProvider` [IPublicUrlProvider](./proffer.storage.filesystem.ipublicurlprovider)
+The public URL provider. + +`extendedPropertiesProvider` [IExtendedPropertiesProvider](./proffer.storage.filesystem.iextendedpropertiesprovider)
+The extended properties provider. + +## Methods + +### **InitAsync(CancellationToken)** + +Initializes the store by creating a container in its Proffer.Storage.IStorageProvider. + +```csharp +public Task InitAsync(CancellationToken cancellationToken) +``` + +#### Parameters + +`cancellationToken` [CancellationToken](https://docs.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken)
+ +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **ListAsync(String, Boolean, Boolean)** + +Lists the files under . + +```csharp +public ValueTask ListAsync(string path, bool recursive, bool withMetadata) +``` + +#### Parameters + +`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The path. + +`recursive` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, recurse the listing across folders. + +`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, fetch metadata for each file. + +#### Returns + +ValueTask<IFileReference[]>
+ + The list under . + +### **ListAsync(String, String, Boolean, Boolean)** + +Lists the files under matching the . + +```csharp +public ValueTask ListAsync(string path, string searchPattern, bool recursive, bool withMetadata) +``` + +#### Parameters + +`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The path. + +`searchPattern` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The search pattern. + +`recursive` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, recurse the listing across folders. + +`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, fetch metadata for each file. + +#### Returns + +ValueTask<IFileReference[]>
+ + The list under matching the . + +### **GetAsync(IPrivateFileReference, Boolean)** + +Gets the file reference from path. + +```csharp +public ValueTask GetAsync(IPrivateFileReference file, bool withMetadata) +``` + +#### Parameters + +`file` IPrivateFileReference
+The reference holding the file path. + +`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, fetch metadata for the file. + +#### Returns + +ValueTask<IFileReference>
+ + The at path. + +### **GetAsync(Uri, Boolean)** + +Gets the file reference from URI. + +```csharp +public ValueTask GetAsync(Uri uri, bool withMetadata) +``` + +#### Parameters + +`uri` Uri
+The file uniform resource identifier (URI). + +`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, fetch metadata for the file. + +#### Returns + +ValueTask<IFileReference>
+ + The at path. + +#### Exceptions + +[InvalidOperationException](https://docs.microsoft.com/en-us/dotnet/api/system.invalidoperationexception)
+ +### **DeleteAsync(IPrivateFileReference)** + +Deletes the file. + +```csharp +public Task DeleteAsync(IPrivateFileReference file) +``` + +#### Parameters + +`file` IPrivateFileReference
+The reference holding the file path. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ +### **ReadAsync(IPrivateFileReference)** + +Reads the file content. + +```csharp +public ValueTask ReadAsync(IPrivateFileReference file) +``` + +#### Parameters + +`file` IPrivateFileReference
+The reference holding the file path. + +#### Returns + +ValueTask<Stream>
+ + A containing the file content. + +### **ReadAllBytesAsync(IPrivateFileReference)** + +Reads the file content. + +```csharp +public ValueTask ReadAllBytesAsync(IPrivateFileReference file) +``` + +#### Parameters + +`file` IPrivateFileReference
+The reference holding the file path. + +#### Returns + +ValueTask<Byte[]>
+ + A containing the file content. + +### **ReadAllTextAsync(IPrivateFileReference)** + +Reads the file content. + +```csharp +public ValueTask ReadAllTextAsync(IPrivateFileReference file) +``` + +#### Parameters + +`file` IPrivateFileReference
+The reference holding the file path. + +#### Returns + +ValueTask<String>
+ + A containing the file content. + +### **SaveAsync(Byte[], IPrivateFileReference, String, OverwritePolicy, IDictionary<String, String>)** + +Saves the file. + +```csharp +public ValueTask SaveAsync(Byte[] data, IPrivateFileReference file, string contentType, OverwritePolicy overwritePolicy, IDictionary metadata) +``` + +#### Parameters + +`data` [Byte[]](https://docs.microsoft.com/en-us/dotnet/api/system.byte)
+The file content. + +`file` IPrivateFileReference
+The reference holding the file path. + +`contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The content-type of the file. + +`overwritePolicy` OverwritePolicy
+The overwrite policy. + +`metadata` [IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
+The metadata. + +#### Returns + +ValueTask<IFileReference>
+ + The saved . + +### **SaveAsync(Stream, IPrivateFileReference, String, OverwritePolicy, IDictionary<String, String>)** + +Saves the file. + +```csharp +public ValueTask SaveAsync(Stream data, IPrivateFileReference file, string contentType, OverwritePolicy overwritePolicy, IDictionary metadata) +``` + +#### Parameters + +`data` [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream)
+The file content. + +`file` IPrivateFileReference
+The reference holding the file path. + +`contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The content-type of the file. + +`overwritePolicy` OverwritePolicy
+The overwrite policy. + +`metadata` [IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
+The metadata. + +#### Returns + +ValueTask<IFileReference>
+ + The saved . + +#### Exceptions + +Proffer.Storage.Exceptions.FileAlreadyExistsException
+ +### **GetSharedAccessSignatureAsync(ISharedAccessPolicy)** + +Gets a shared access signature. + +```csharp +public ValueTask GetSharedAccessSignatureAsync(ISharedAccessPolicy policy) +``` + +#### Parameters + +`policy` ISharedAccessPolicy
+The policy. + +#### Returns + +ValueTask<String>
+ + A shared access signature to read or list the store files. + +#### Exceptions + +[NotSupportedException](https://docs.microsoft.com/en-us/dotnet/api/system.notsupportedexception)
diff --git a/docs/storage/filesystem/proffer.storage.filesystem.iextendedpropertiesprovider.md b/docs/storage/filesystem/proffer.storage.filesystem.iextendedpropertiesprovider.md new file mode 100644 index 0000000..8401cb9 --- /dev/null +++ b/docs/storage/filesystem/proffer.storage.filesystem.iextendedpropertiesprovider.md @@ -0,0 +1,56 @@ +# IExtendedPropertiesProvider + +Namespace: Proffer.Storage.FileSystem + +Provides a way to store and retrieve extended file properties to match the requirements of Proffer.Storage.IFileProperties on a File System. + +```csharp +public interface IExtendedPropertiesProvider +``` + +## Methods + +### **GetExtendedPropertiesAsync(String, IPrivateFileReference)** + +Gets the extended properties of a file reference. + +```csharp +ValueTask GetExtendedPropertiesAsync(string storeAbsolutePath, IPrivateFileReference file) +``` + +#### Parameters + +`storeAbsolutePath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The store absolute path. + +`file` IPrivateFileReference
+The reference holding the file path. + +#### Returns + +ValueTask<FileExtendedProperties>
+A loaded instance or a default one if not found. + +### **SaveExtendedPropertiesAsync(String, IPrivateFileReference, FileExtendedProperties)** + +Saves the extended properties for a file reference. + +```csharp +Task SaveExtendedPropertiesAsync(string storeAbsolutePath, IPrivateFileReference file, FileExtendedProperties extendedProperties) +``` + +#### Parameters + +`storeAbsolutePath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The store absolute path. + +`file` IPrivateFileReference
+The reference holding the file path. + +`extendedProperties` [FileExtendedProperties](./proffer.storage.filesystem.internal.fileextendedproperties)
+The extended properties. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+A task that represents the asynchronous operation. diff --git a/docs/storage/filesystem/proffer.storage.filesystem.internal.fileextendedproperties.md b/docs/storage/filesystem/proffer.storage.filesystem.internal.fileextendedproperties.md new file mode 100644 index 0000000..375879f --- /dev/null +++ b/docs/storage/filesystem/proffer.storage.filesystem.internal.fileextendedproperties.md @@ -0,0 +1,83 @@ +# FileExtendedProperties + +Namespace: Proffer.Storage.FileSystem.Internal + +Extends standard file properties to match the requirements of Proffer.Storage.IFileProperties. + +```csharp +public class FileExtendedProperties +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileExtendedProperties](./proffer.storage.filesystem.internal.fileextendedproperties) + +## Properties + +### **ContentType** + +Gets or sets the content-type. + +```csharp +public string ContentType { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ETag** + +Gets or sets the etag. + +```csharp +public string ETag { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **CacheControl** + +Gets or sets the cache control. + +```csharp +public string CacheControl { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ContentMD5** + +Gets or sets the MD5 digest of the content. + +```csharp +public string ContentMD5 { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Metadata** + +Gets or sets the metadata. + +```csharp +public IDictionary Metadata { get; set; } +``` + +#### Property Value + +[IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
+ +## Constructors + +### **FileExtendedProperties()** + +Initializes a new instance of the [FileExtendedProperties](./proffer.storage.filesystem.internal.fileextendedproperties) class. + +```csharp +public FileExtendedProperties() +``` diff --git a/docs/storage/filesystem/proffer.storage.filesystem.internal.filesystemfileproperties.md b/docs/storage/filesystem/proffer.storage.filesystem.internal.filesystemfileproperties.md new file mode 100644 index 0000000..536b229 --- /dev/null +++ b/docs/storage/filesystem/proffer.storage.filesystem.internal.filesystemfileproperties.md @@ -0,0 +1,116 @@ +# FileSystemFileProperties + +Namespace: Proffer.Storage.FileSystem.Internal + +File common properties with metadata stored on a File System. + +```csharp +public class FileSystemFileProperties : Proffer.Storage.IFileProperties +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemFileProperties](./proffer.storage.filesystem.internal.filesystemfileproperties)
+Implements IFileProperties + +## Properties + +### **LastModified** + +Gets the last modified time. + +```csharp +public Nullable LastModified { get; } +``` + +#### Property Value + +[Nullable<DateTimeOffset>](https://docs.microsoft.com/en-us/dotnet/api/system.nullable-1)
+ +### **Length** + +Gets the length of the content. + +```csharp +public long Length { get; } +``` + +#### Property Value + +[Int64](https://docs.microsoft.com/en-us/dotnet/api/system.int64)
+ +### **ContentType** + +Gets or sets the content-type. + +```csharp +public string ContentType { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ETag** + +Gets the etag. + +```csharp +public string ETag { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **CacheControl** + +Gets or sets the cache control. + +```csharp +public string CacheControl { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ContentMD5** + +Gets the MD5 digest of the content. + +```csharp +public string ContentMD5 { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Metadata** + +Gets the metadata. + +```csharp +public IDictionary Metadata { get; } +``` + +#### Property Value + +[IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
+ +## Constructors + +### **FileSystemFileProperties(String, FileExtendedProperties)** + +Initializes a new instance of the [FileSystemFileProperties](./proffer.storage.filesystem.internal.filesystemfileproperties) class. + +```csharp +public FileSystemFileProperties(string fileSystemPath, FileExtendedProperties extendedProperties) +``` + +#### Parameters + +`fileSystemPath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The file system path. + +`extendedProperties` [FileExtendedProperties](./proffer.storage.filesystem.internal.fileextendedproperties)
+The extended properties. diff --git a/docs/storage/filesystem/proffer.storage.filesystem.internal.filesystemfilereference.md b/docs/storage/filesystem/proffer.storage.filesystem.internal.filesystemfilereference.md new file mode 100644 index 0000000..ade0371 --- /dev/null +++ b/docs/storage/filesystem/proffer.storage.filesystem.internal.filesystemfilereference.md @@ -0,0 +1,234 @@ +# FileSystemFileReference + +Namespace: Proffer.Storage.FileSystem.Internal + +A reference of a stored file at a given path on a File System. + +```csharp +public class FileSystemFileReference : Proffer.Storage.IFileReference, Proffer.Storage.IPrivateFileReference +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemFileReference](./proffer.storage.filesystem.internal.filesystemfilereference)
+Implements IFileReference, IPrivateFileReference + +## Properties + +### **FileSystemPath** + +Gets the file system path. + +```csharp +public string FileSystemPath { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Path** + +Gets the file path. + +```csharp +public string Path { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **PublicUrl** + +Gets the public URL. + +```csharp +public string PublicUrl { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Properties** + +Gets the properties. + +```csharp +public IFileProperties Properties { get; } +``` + +#### Property Value + +IFileProperties
+ +## Constructors + +### **FileSystemFileReference(String, String, FileSystemStore, Boolean, FileExtendedProperties, IPublicUrlProvider, IExtendedPropertiesProvider)** + +Initializes a new instance of the [FileSystemFileReference](./proffer.storage.filesystem.internal.filesystemfilereference) class. + +```csharp +public FileSystemFileReference(string filePath, string path, FileSystemStore store, bool withMetadata, FileExtendedProperties extendedProperties, IPublicUrlProvider publicUrlProvider, IExtendedPropertiesProvider extendedPropertiesProvider) +``` + +#### Parameters + +`filePath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The file system path. + +`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The path. + +`store` [FileSystemStore](./proffer.storage.filesystem.filesystemstore)
+The store. + +`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, the metadata for the file have been fetched. + +`extendedProperties` [FileExtendedProperties](./proffer.storage.filesystem.internal.fileextendedproperties)
+The extended properties. + +`publicUrlProvider` [IPublicUrlProvider](./proffer.storage.filesystem.ipublicurlprovider)
+The public URL provider. + +`extendedPropertiesProvider` [IExtendedPropertiesProvider](./proffer.storage.filesystem.iextendedpropertiesprovider)
+The extended properties provider. + +## Methods + +### **DeleteAsync()** + +Deletes the file. + +```csharp +public Task DeleteAsync() +``` + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **ReadAllBytesAsync()** + +Reads the file content. + +```csharp +public ValueTask ReadAllBytesAsync() +``` + +#### Returns + +ValueTask<Byte[]>
+ + A containing the file content. + +### **ReadAllTextAsync()** + +Reads the file content. + +```csharp +public ValueTask ReadAllTextAsync() +``` + +#### Returns + +ValueTask<String>
+ + A containing the file content. + +### **ReadAsync()** + +Reads the file content. + +```csharp +public ValueTask ReadAsync() +``` + +#### Returns + +ValueTask<Stream>
+ + A containing the file content. + +### **ReadToStreamAsync(Stream)** + +Reads the file content into the given stream. + +```csharp +public Task ReadToStreamAsync(Stream targetStream) +``` + +#### Parameters + +`targetStream` [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream)
+The target stream. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ +### **UpdateAsync(Stream)** + +Updates the file content with the given [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream). + +```csharp +public Task UpdateAsync(Stream stream) +``` + +#### Parameters + +`stream` [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream)
+The new file content. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **SavePropertiesAsync()** + +Saves the file properties. + +```csharp +public Task SavePropertiesAsync() +``` + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **GetSharedAccessSignature(ISharedAccessPolicy)** + +Gets a shared access signature. + +```csharp +public ValueTask GetSharedAccessSignature(ISharedAccessPolicy policy) +``` + +#### Parameters + +`policy` ISharedAccessPolicy
+The policy. + +#### Returns + +ValueTask<String>
+A shared access signature to read file. + +### **FetchProperties()** + +Fetches the file properties. + +```csharp +public Task FetchProperties() +``` + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+A task that represents the asynchronous operation. diff --git a/docs/storage/filesystem/proffer.storage.filesystem.ipublicurlprovider.md b/docs/storage/filesystem/proffer.storage.filesystem.ipublicurlprovider.md new file mode 100644 index 0000000..5bb5cec --- /dev/null +++ b/docs/storage/filesystem/proffer.storage.filesystem.ipublicurlprovider.md @@ -0,0 +1,32 @@ +# IPublicUrlProvider + +Namespace: Proffer.Storage.FileSystem + +Provides a way to serve files from an HTTP URL on a File System. + +```csharp +public interface IPublicUrlProvider +``` + +## Methods + +### **GetPublicUrl(String, FileSystemFileReference)** + +Gets the public URL of a file reference. + +```csharp +string GetPublicUrl(string storeName, FileSystemFileReference file) +``` + +#### Parameters + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the store. + +`file` [FileSystemFileReference](./proffer.storage.filesystem.internal.filesystemfilereference)
+The reference holding the file path. + +#### Returns + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The public URL. diff --git a/docs/storage/filesystem/proffer.storage.filesystem.noextendedpropertiesprovider.md b/docs/storage/filesystem/proffer.storage.filesystem.noextendedpropertiesprovider.md new file mode 100644 index 0000000..948091b --- /dev/null +++ b/docs/storage/filesystem/proffer.storage.filesystem.noextendedpropertiesprovider.md @@ -0,0 +1,69 @@ +# NoExtendedPropertiesProvider + +Namespace: Proffer.Storage.FileSystem + +Default [IExtendedPropertiesProvider](./proffer.storage.filesystem.iextendedpropertiesprovider) without property storage capacity. + +```csharp +public class NoExtendedPropertiesProvider : IExtendedPropertiesProvider +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [NoExtendedPropertiesProvider](./proffer.storage.filesystem.noextendedpropertiesprovider)
+Implements [IExtendedPropertiesProvider](./proffer.storage.filesystem.iextendedpropertiesprovider) + +## Constructors + +### **NoExtendedPropertiesProvider()** + + + +```csharp +public NoExtendedPropertiesProvider() +``` + +## Methods + +### **GetExtendedPropertiesAsync(String, IPrivateFileReference)** + +Gets the extended properties of a file reference. + +```csharp +public ValueTask GetExtendedPropertiesAsync(string storeAbsolutePath, IPrivateFileReference file) +``` + +#### Parameters + +`storeAbsolutePath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The store absolute path. + +`file` IPrivateFileReference
+The reference holding the file path. + +#### Returns + +ValueTask<FileExtendedProperties>
+A loaded instance or a default one if not found. + +### **SaveExtendedPropertiesAsync(String, IPrivateFileReference, FileExtendedProperties)** + +Saves the extended properties for a file reference. + +```csharp +public Task SaveExtendedPropertiesAsync(string storeAbsolutePath, IPrivateFileReference file, FileExtendedProperties extendedProperties) +``` + +#### Parameters + +`storeAbsolutePath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The store absolute path. + +`file` IPrivateFileReference
+The reference holding the file path. + +`extendedProperties` [FileExtendedProperties](./proffer.storage.filesystem.internal.fileextendedproperties)
+The extended properties. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+A task that represents the asynchronous operation. diff --git a/docs/storage/filesystem/proffer.storage.filesystemstorageservicecollectionextensions.md b/docs/storage/filesystem/proffer.storage.filesystemstorageservicecollectionextensions.md new file mode 100644 index 0000000..2281204 --- /dev/null +++ b/docs/storage/filesystem/proffer.storage.filesystemstorageservicecollectionextensions.md @@ -0,0 +1,52 @@ +# FileSystemStorageServiceCollectionExtensions + +Namespace: Proffer.Storage + +Microsoft.Extensions.DependencyInjection.IServiceCollection extension methods. + +```csharp +public static class FileSystemStorageServiceCollectionExtensions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemStorageServiceCollectionExtensions](./proffer.storage.filesystemstorageservicecollectionextensions) + +## Methods + +### **AddFileSystemStorage(IServiceCollection, String)** + +Registers the Proffer.Storage services to the File System on the given root path. + +```csharp +public static IServiceCollection AddFileSystemStorage(IServiceCollection services, string rootPath) +``` + +#### Parameters + +`services` IServiceCollection
+The service collection. + +`rootPath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The root path. + +#### Returns + +IServiceCollection
+The service collection. + +### **AddFileSystemStorage(IServiceCollection)** + +Registers the Proffer.Storage services to the File System on the root path System.IO.Directory.GetCurrentDirectory. + +```csharp +public static IServiceCollection AddFileSystemStorage(IServiceCollection services) +``` + +#### Parameters + +`services` IServiceCollection
+The service collection. + +#### Returns + +IServiceCollection
+The service collection. diff --git a/docs/storage/filesystem/properties/json/api.md b/docs/storage/filesystem/properties/json/api.md new file mode 100644 index 0000000..740780c --- /dev/null +++ b/docs/storage/filesystem/properties/json/api.md @@ -0,0 +1,13 @@ +# Proffer.Storage.FileSystem.Properties.Json + +## Proffer.Storage + +[FileSystemPropertiesJsonServiceCollectionExtensions](./proffer.storage.filesystempropertiesjsonservicecollectionextensions) + +## Proffer.Storage.FileSystem.Properties.Json + +[FileSystemPropertiesJsonOptions](./proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions) + +## Proffer.Storage.FileSystem.Properties.Json.Internal + +[ExtendedPropertiesProvider](./proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider) diff --git a/docs/storage/filesystem/properties/json/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md b/docs/storage/filesystem/properties/json/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md new file mode 100644 index 0000000..b0c4fb4 --- /dev/null +++ b/docs/storage/filesystem/properties/json/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md @@ -0,0 +1,35 @@ +# FileSystemPropertiesJsonOptions + +Namespace: Proffer.Storage.FileSystem.Properties.Json + +Options for an [ExtendedPropertiesProvider](./proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider). + +```csharp +public class FileSystemPropertiesJsonOptions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemPropertiesJsonOptions](./proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions) + +## Properties + +### **FolderNameFormat** + +Gets or sets the folder name format. + +```csharp +public string FolderNameFormat { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Constructors + +### **FileSystemPropertiesJsonOptions()** + + + +```csharp +public FileSystemPropertiesJsonOptions() +``` diff --git a/docs/storage/filesystem/properties/json/proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md b/docs/storage/filesystem/properties/json/proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md new file mode 100644 index 0000000..e5530fd --- /dev/null +++ b/docs/storage/filesystem/properties/json/proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md @@ -0,0 +1,76 @@ +# ExtendedPropertiesProvider + +Namespace: Proffer.Storage.FileSystem.Properties.Json.Internal + +Provides a way to store and retrieve extended file properties to match the requirements of Proffer.Storage.IFileProperties on a File System using JSON files. + +```csharp +public class ExtendedPropertiesProvider : Proffer.Storage.FileSystem.IExtendedPropertiesProvider +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ExtendedPropertiesProvider](./proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider)
+Implements IExtendedPropertiesProvider + +## Constructors + +### **ExtendedPropertiesProvider(IOptions<FileSystemPropertiesJsonOptions>)** + +Initializes a new instance of the [ExtendedPropertiesProvider](./proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider) class. + +```csharp +public ExtendedPropertiesProvider(IOptions options) +``` + +#### Parameters + +`options` IOptions<FileSystemPropertiesJsonOptions>
+The options. + +## Methods + +### **GetExtendedPropertiesAsync(String, IPrivateFileReference)** + +Gets the extended properties of a file reference. + +```csharp +public ValueTask GetExtendedPropertiesAsync(string storeAbsolutePath, IPrivateFileReference file) +``` + +#### Parameters + +`storeAbsolutePath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The store absolute path. + +`file` IPrivateFileReference
+The reference holding the file path. + +#### Returns + +ValueTask<FileExtendedProperties>
+ + A loaded instance or a default one if not found. + +### **SaveExtendedPropertiesAsync(String, IPrivateFileReference, FileExtendedProperties)** + +Saves the extended properties for a file reference. + +```csharp +public Task SaveExtendedPropertiesAsync(string storeAbsolutePath, IPrivateFileReference file, FileExtendedProperties extendedProperties) +``` + +#### Parameters + +`storeAbsolutePath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The store absolute path. + +`file` IPrivateFileReference
+The reference holding the file path. + +`extendedProperties` FileExtendedProperties
+The extended properties. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. diff --git a/docs/storage/filesystem/properties/json/proffer.storage.filesystempropertiesjsonservicecollectionextensions.md b/docs/storage/filesystem/properties/json/proffer.storage.filesystempropertiesjsonservicecollectionextensions.md new file mode 100644 index 0000000..d93ec18 --- /dev/null +++ b/docs/storage/filesystem/properties/json/proffer.storage.filesystempropertiesjsonservicecollectionextensions.md @@ -0,0 +1,35 @@ +# FileSystemPropertiesJsonServiceCollectionExtensions + +Namespace: Proffer.Storage + +Microsoft.Extensions.DependencyInjection.IServiceCollection extension methods. + +```csharp +public static class FileSystemPropertiesJsonServiceCollectionExtensions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemPropertiesJsonServiceCollectionExtensions](./proffer.storage.filesystempropertiesjsonservicecollectionextensions) + +## Methods + +### **AddFileSystemExtendedProperties(IServiceCollection, Action<FileSystemPropertiesJsonOptions>)** + +Registers a File System extended properties provider that stores it in JSON files. + +```csharp +public static IServiceCollection AddFileSystemExtendedProperties(IServiceCollection services, Action configure) +``` + +#### Parameters + +`services` IServiceCollection
+The service collection. + +`configure` [Action<FileSystemPropertiesJsonOptions>](https://docs.microsoft.com/en-us/dotnet/api/system.action-1)
+The action to configure options. + +#### Returns + +IServiceCollection
+ + The service collection. diff --git a/docs/storage/filesystem/server/api.md b/docs/storage/filesystem/server/api.md new file mode 100644 index 0000000..e005d4b --- /dev/null +++ b/docs/storage/filesystem/server/api.md @@ -0,0 +1,15 @@ +# Proffer.Storage.FileSystem.Server + +## Proffer.Storage + +[ServiceCollectionExtensions](./proffer.storage.servicecollectionextensions) + +## Proffer.Storage.FileSystem.Server + +[FileSystemStorageServerMiddleware](./proffer.storage.filesystem.server.filesystemstorageservermiddleware) + +[FileSystemStorageServerOptions](./proffer.storage.filesystem.server.filesystemstorageserveroptions) + +## Proffer.Storage.FileSystem.Server.Internal + +[PublicUrlProvider](./proffer.storage.filesystem.server.internal.publicurlprovider) diff --git a/docs/storage/filesystem/server/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md b/docs/storage/filesystem/server/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md new file mode 100644 index 0000000..e093922 --- /dev/null +++ b/docs/storage/filesystem/server/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md @@ -0,0 +1,54 @@ +# FileSystemStorageServerMiddleware + +Namespace: Proffer.Storage.FileSystem.Server + +ASP.NET Core middleware to serve over HTTP files stored in a Storage store. + +```csharp +public class FileSystemStorageServerMiddleware +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemStorageServerMiddleware](./proffer.storage.filesystem.server.filesystemstorageservermiddleware) + +## Constructors + +### **FileSystemStorageServerMiddleware(RequestDelegate, IOptions<FileSystemStorageServerOptions>, ILogger<FileSystemStorageServerMiddleware>, IOptions<FileSystemParsedOptions>)** + +Initializes a new instance of the [FileSystemStorageServerMiddleware](./proffer.storage.filesystem.server.filesystemstorageservermiddleware) class. + +```csharp +public FileSystemStorageServerMiddleware(RequestDelegate next, IOptions serverOptions, ILogger logger, IOptions fileSystemParsedOptions) +``` + +#### Parameters + +`next` RequestDelegate
+The next function. + +`serverOptions` IOptions<FileSystemStorageServerOptions>
+The server options. + +`logger` ILogger<FileSystemStorageServerMiddleware>
+The logger. + +`fileSystemParsedOptions` IOptions<FileSystemParsedOptions>
+The file system parsed options. + +## Methods + +### **Invoke(HttpContext)** + +Invokes the middleware. + +```csharp +public Task Invoke(HttpContext context) +``` + +#### Parameters + +`context` HttpContext
+The context. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
diff --git a/docs/storage/filesystem/server/proffer.storage.filesystem.server.filesystemstorageserveroptions.md b/docs/storage/filesystem/server/proffer.storage.filesystem.server.filesystemstorageserveroptions.md new file mode 100644 index 0000000..f899ee7 --- /dev/null +++ b/docs/storage/filesystem/server/proffer.storage.filesystem.server.filesystemstorageserveroptions.md @@ -0,0 +1,59 @@ +# FileSystemStorageServerOptions + +Namespace: Proffer.Storage.FileSystem.Server + +Options for a [FileSystemStorageServerMiddleware](./proffer.storage.filesystem.server.filesystemstorageservermiddleware). + +```csharp +public class FileSystemStorageServerOptions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemStorageServerOptions](./proffer.storage.filesystem.server.filesystemstorageserveroptions) + +## Properties + +### **BaseUri** + +Gets or sets the base URI. + +```csharp +public Uri BaseUri { get; set; } +``` + +#### Property Value + +Uri
+ +### **EndpointPath** + +Gets or sets the endpoint path. + +```csharp +public PathString EndpointPath { get; set; } +``` + +#### Property Value + +PathString
+ +### **SigningKey** + +Gets or sets the signing key. + +```csharp +public Byte[] SigningKey { get; set; } +``` + +#### Property Value + +[Byte[]](https://docs.microsoft.com/en-us/dotnet/api/system.byte)
+ +## Constructors + +### **FileSystemStorageServerOptions()** + + + +```csharp +public FileSystemStorageServerOptions() +``` diff --git a/docs/storage/filesystem/server/proffer.storage.filesystem.server.internal.publicurlprovider.md b/docs/storage/filesystem/server/proffer.storage.filesystem.server.internal.publicurlprovider.md new file mode 100644 index 0000000..377e013 --- /dev/null +++ b/docs/storage/filesystem/server/proffer.storage.filesystem.server.internal.publicurlprovider.md @@ -0,0 +1,51 @@ +# PublicUrlProvider + +Namespace: Proffer.Storage.FileSystem.Server.Internal + +Provides a way to serve files from an HTTP URL on a File System using an ASP.NET middleware. + +```csharp +public class PublicUrlProvider : Proffer.Storage.FileSystem.IPublicUrlProvider +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [PublicUrlProvider](./proffer.storage.filesystem.server.internal.publicurlprovider)
+Implements IPublicUrlProvider + +## Constructors + +### **PublicUrlProvider(IOptions<FileSystemStorageServerOptions>)** + +Initializes a new instance of the [PublicUrlProvider](./proffer.storage.filesystem.server.internal.publicurlprovider) class. + +```csharp +public PublicUrlProvider(IOptions options) +``` + +#### Parameters + +`options` IOptions<FileSystemStorageServerOptions>
+The options. + +## Methods + +### **GetPublicUrl(String, FileSystemFileReference)** + +Gets the public URL of a file reference. + +```csharp +public string GetPublicUrl(string storeName, FileSystemFileReference file) +``` + +#### Parameters + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the store. + +`file` FileSystemFileReference
+The reference holding the file path. + +#### Returns + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ + The public URL. diff --git a/docs/storage/filesystem/server/proffer.storage.servicecollectionextensions.md b/docs/storage/filesystem/server/proffer.storage.servicecollectionextensions.md new file mode 100644 index 0000000..8809932 --- /dev/null +++ b/docs/storage/filesystem/server/proffer.storage.servicecollectionextensions.md @@ -0,0 +1,52 @@ +# ServiceCollectionExtensions + +Namespace: Proffer.Storage + +Microsoft.Extensions.DependencyInjection.IServiceCollection extension methods. + +```csharp +public static class ServiceCollectionExtensions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ServiceCollectionExtensions](./proffer.storage.servicecollectionextensions) + +## Methods + +### **AddFileSystemStorageServer(IServiceCollection, Action<FileSystemStorageServerOptions>)** + +Adds a File System provider Storage Server, serving files over HTTP. + +```csharp +public static IServiceCollection AddFileSystemStorageServer(IServiceCollection services, Action configure) +``` + +#### Parameters + +`services` IServiceCollection
+The service collection. + +`configure` [Action<FileSystemStorageServerOptions>](https://docs.microsoft.com/en-us/dotnet/api/system.action-1)
+The action to configure options. + +#### Returns + +IServiceCollection
+The service collection. + +### **UseFileSystemStorageServer(IApplicationBuilder)** + +Adds a [FileSystemStorageServerMiddleware](./proffer.storage.filesystem.server.filesystemstorageservermiddleware) to the application's request pipeline. + +```csharp +public static IApplicationBuilder UseFileSystemStorageServer(IApplicationBuilder app) +``` + +#### Parameters + +`app` IApplicationBuilder
+The application builder. + +#### Returns + +IApplicationBuilder
+The application builder. diff --git a/docs/storage/proffer.storage.configuration.accesslevel.md b/docs/storage/proffer.storage.configuration.accesslevel.md new file mode 100644 index 0000000..74f7a34 --- /dev/null +++ b/docs/storage/proffer.storage.configuration.accesslevel.md @@ -0,0 +1,20 @@ +# AccessLevel + +Namespace: Proffer.Storage.Configuration + +Defines a store access level. + +```csharp +public enum AccessLevel +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ValueType](https://docs.microsoft.com/en-us/dotnet/api/system.valuetype) → [Enum](https://docs.microsoft.com/en-us/dotnet/api/system.enum) → [AccessLevel](./proffer.storage.configuration.accesslevel)
+Implements [IComparable](https://docs.microsoft.com/en-us/dotnet/api/system.icomparable), [IFormattable](https://docs.microsoft.com/en-us/dotnet/api/system.iformattable), [IConvertible](https://docs.microsoft.com/en-us/dotnet/api/system.iconvertible) + +## Fields + +| Name | Value | Description | +| --- | --: | --- | +| Private | 0 | No public access. | +| Confidential | 1 | Public files without listing. | +| Public | 2 | Public access. | diff --git a/docs/storage/proffer.storage.configuration.configurationextensions.md b/docs/storage/proffer.storage.configuration.configurationextensions.md new file mode 100644 index 0000000..41d2c3c --- /dev/null +++ b/docs/storage/proffer.storage.configuration.configurationextensions.md @@ -0,0 +1,217 @@ +# ConfigurationExtensions + +Namespace: Proffer.Storage.Configuration + +Extensions methods to parse and bind options. + +```csharp +public static class ConfigurationExtensions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ConfigurationExtensions](./proffer.storage.configuration.configurationextensions) + +## Methods + +### **Parse<TOptions>(IReadOnlyDictionary<String, IConfigurationSection>)** + +Parses the specified unparsed configuration. + +```csharp +public static IReadOnlyDictionary Parse(IReadOnlyDictionary unparsedConfiguration) +``` + +#### Type Parameters + +`TOptions`
+The type of the options. + +#### Parameters + +`unparsedConfiguration` [IReadOnlyDictionary<String, IConfigurationSection>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
+The unparsed configuration. + +#### Returns + +IReadOnlyDictionary<String, TOptions>
+A typed dictionary with options binding from the given unparsed configuration. + +### **GetStoreConfiguration<TInstanceOptions, TStoreOptions, TScopedStoreOptions>(IParsedOptions<TInstanceOptions, TStoreOptions, TScopedStoreOptions>, String, Boolean)** + +Gets the store configuration. + +```csharp +public static TStoreOptions GetStoreConfiguration(IParsedOptions parsedOptions, string storeName, bool throwIfNotFound) +``` + +#### Type Parameters + +`TInstanceOptions`
+The type of the provider instance options. + +`TStoreOptions`
+The type of the store options. + +`TScopedStoreOptions`
+The type of the scoped store options. + +#### Parameters + +`parsedOptions` IParsedOptions<TInstanceOptions, TStoreOptions, TScopedStoreOptions>
+The parsed options. + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the store. + +`throwIfNotFound` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, throws an exception if the store configuration is not found. + +#### Returns + +TStoreOptions
+The typed store configuration. + +#### Exceptions + +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
+ +### **GetScopedStoreConfiguration<TInstanceOptions, TStoreOptions, TScopedStoreOptions>(IParsedOptions<TInstanceOptions, TStoreOptions, TScopedStoreOptions>, String, Boolean)** + +Gets the scoped store configuration. + +```csharp +public static TScopedStoreOptions GetScopedStoreConfiguration(IParsedOptions parsedOptions, string storeName, bool throwIfNotFound) +``` + +#### Type Parameters + +`TInstanceOptions`
+The type of the provider instance options. + +`TStoreOptions`
+The type of the store options. + +`TScopedStoreOptions`
+The type of the scoped store options. + +#### Parameters + +`parsedOptions` IParsedOptions<TInstanceOptions, TStoreOptions, TScopedStoreOptions>
+The parsed options. + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the store. + +`throwIfNotFound` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, throws an exception if the store configuration is not found. + +#### Returns + +TScopedStoreOptions
+The typed scoped store configuration. + +#### Exceptions + +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
+ +### **Compute<TParsedOptions, TProviderOptions, TStoreOptions, TScopedStoreOptions>(TProviderOptions, TParsedOptions)** + +Computes the specified options. + +```csharp +public static void Compute(TProviderOptions providerOptions, TParsedOptions options) +``` + +#### Type Parameters + +`TParsedOptions`
+The type of the parsed options. + +`TProviderOptions`
+The type of the provider instance options. + +`TStoreOptions`
+The type of the store options. + +`TScopedStoreOptions`
+The type of the scoped store options. + +#### Parameters + +`providerOptions` TProviderOptions
+The provider options. + +`options` TParsedOptions
+The options. + +#### Exceptions + +[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
+ +### **Compute<TParsedOptions, TInstanceOptions, TStoreOptions, TScopedStoreOptions>(TStoreOptions, TParsedOptions)** + +Computes the specified options. + +```csharp +public static void Compute(TStoreOptions parsedStore, TParsedOptions options) +``` + +#### Type Parameters + +`TParsedOptions`
+The type of the parsed options. + +`TInstanceOptions`
+The type of the provider instance options. + +`TStoreOptions`
+The type of the store options. + +`TScopedStoreOptions`
+The type of the scoped store options. + +#### Parameters + +`parsedStore` TStoreOptions
+The parsed store options. + +`options` TParsedOptions
+The options. + +#### Exceptions + +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
+ +### **ParseStoreOptions<TParsedOptions, TInstanceOptions, TStoreOptions, TScopedStoreOptions>(IStoreOptions, TParsedOptions)** + +Parses the store options. + +```csharp +public static TStoreOptions ParseStoreOptions(IStoreOptions storeOptions, TParsedOptions options) +``` + +#### Type Parameters + +`TParsedOptions`
+The type of the parsed options. + +`TInstanceOptions`
+The type of the provider instance options. + +`TStoreOptions`
+The type of the store options. + +`TScopedStoreOptions`
+The type of the scoped store options. + +#### Parameters + +`storeOptions` [IStoreOptions](./proffer.storage.configuration.istoreoptions)
+The store options. + +`options` TParsedOptions
+The options. + +#### Returns + +TStoreOptions
+The parsed store options. diff --git a/docs/storage/proffer.storage.configuration.iparsedoptions-3.md b/docs/storage/proffer.storage.configuration.iparsedoptions-3.md new file mode 100644 index 0000000..358d370 --- /dev/null +++ b/docs/storage/proffer.storage.configuration.iparsedoptions-3.md @@ -0,0 +1,117 @@ +# IParsedOptions<TProviderOptions, TStoreOptions, TScopedStoreOptions> + +Namespace: Proffer.Storage.Configuration + +Typed options parsed from the dynamic configuration. + +```csharp +public interface IParsedOptions +``` + +#### Type Parameters + +`TProviderOptions`
+The type of the provider instance options. + +`TStoreOptions`
+The type of the store options. + +`TScopedStoreOptions`
+The type of the scoped store options. + +## Properties + +### **Name** + +Gets the name. + +```csharp +public abstract string Name { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ConnectionStrings** + +Gets or sets the connection strings. + +```csharp +public abstract IReadOnlyDictionary ConnectionStrings { get; set; } +``` + +#### Property Value + +[IReadOnlyDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
+ +### **ParsedProviders** + +Gets or sets the parsed provider options. + +```csharp +public abstract IReadOnlyDictionary ParsedProviders { get; set; } +``` + +#### Property Value + +IReadOnlyDictionary<String, TProviderOptions>
+ +### **ParsedStores** + +Gets or sets the parsed stores options. + +```csharp +public abstract IReadOnlyDictionary ParsedStores { get; set; } +``` + +#### Property Value + +IReadOnlyDictionary<String, TStoreOptions>
+ +### **ParsedScopedStores** + +Gets or sets the parsed scoped stores options. + +```csharp +public abstract IReadOnlyDictionary ParsedScopedStores { get; set; } +``` + +#### Property Value + +IReadOnlyDictionary<String, TScopedStoreOptions>
+ +## Methods + +### **BindProviderOptions(TProviderOptions)** + +Binds the provider options. + +```csharp +void BindProviderOptions(TProviderOptions providerOptions) +``` + +#### Parameters + +`providerOptions` TProviderOptions
+The provider options. + +### **BindStoreOptions(TStoreOptions, TProviderOptions)** + +Binds the store options. + +```csharp +void BindStoreOptions(TStoreOptions storeOptions, TProviderOptions providerInstanceOptions) +``` + +#### Parameters + +`storeOptions` TStoreOptions
+The store options. + +`providerInstanceOptions` TProviderOptions
+The provider instance options. + +#### Exceptions + +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
diff --git a/docs/storage/proffer.storage.configuration.iscopedstoreoptions.md b/docs/storage/proffer.storage.configuration.iscopedstoreoptions.md new file mode 100644 index 0000000..4046127 --- /dev/null +++ b/docs/storage/proffer.storage.configuration.iscopedstoreoptions.md @@ -0,0 +1,25 @@ +# IScopedStoreOptions + +Namespace: Proffer.Storage.Configuration + +Options for a scoped [IStore](./proffer.storage.istore). + +```csharp +public interface IScopedStoreOptions : IStoreOptions, Proffer.Configuration.INamedElementOptions +``` + +Implements [IStoreOptions](./proffer.storage.configuration.istoreoptions), INamedElementOptions + +## Properties + +### **FolderNameFormat** + +Gets the folder name format. + +```csharp +public abstract string FolderNameFormat { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
diff --git a/docs/storage/proffer.storage.configuration.istoreoptions.md b/docs/storage/proffer.storage.configuration.istoreoptions.md new file mode 100644 index 0000000..e9f2573 --- /dev/null +++ b/docs/storage/proffer.storage.configuration.istoreoptions.md @@ -0,0 +1,85 @@ +# IStoreOptions + +Namespace: Proffer.Storage.Configuration + +Options for an [IStore](./proffer.storage.istore). + +```csharp +public interface IStoreOptions : Proffer.Configuration.INamedElementOptions +``` + +Implements INamedElementOptions + +## Properties + +### **ProviderName** + +Gets or sets the name of the provider. + +```csharp +public abstract string ProviderName { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ProviderType** + +Gets or sets the type of the provider. + +```csharp +public abstract string ProviderType { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **AccessLevel** + +Gets or sets the access level. + +```csharp +public abstract AccessLevel AccessLevel { get; set; } +``` + +#### Property Value + +[AccessLevel](./proffer.storage.configuration.accesslevel)
+ +### **FolderName** + +Gets or sets the name of the folder. + +```csharp +public abstract string FolderName { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Methods + +### **Validate(Boolean)** + +Validates the options. + +```csharp +IEnumerable Validate(bool throwOnError) +``` + +#### Parameters + +`throwOnError` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, throws an exception when the validation fails with any . + +#### Returns + +[IEnumerable<IOptionError>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The returned by the validation, if any. + +#### Exceptions + +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
diff --git a/docs/storage/proffer.storage.configuration.scopedstoreoptions.md b/docs/storage/proffer.storage.configuration.scopedstoreoptions.md new file mode 100644 index 0000000..9ebd49f --- /dev/null +++ b/docs/storage/proffer.storage.configuration.scopedstoreoptions.md @@ -0,0 +1,96 @@ +# ScopedStoreOptions + +Namespace: Proffer.Storage.Configuration + +Generic options for a scoped [IStore](./proffer.storage.istore). + +```csharp +public class ScopedStoreOptions : StoreOptions, IStoreOptions, Proffer.Configuration.INamedElementOptions, IScopedStoreOptions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [StoreOptions](./proffer.storage.configuration.storeoptions) → [ScopedStoreOptions](./proffer.storage.configuration.scopedstoreoptions)
+Implements [IStoreOptions](./proffer.storage.configuration.istoreoptions), INamedElementOptions, [IScopedStoreOptions](./proffer.storage.configuration.iscopedstoreoptions) + +## Properties + +### **FolderNameFormat** + +Gets the folder name format. + +```csharp +public string FolderNameFormat { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Name** + +Gets or sets the name. + +```csharp +public string Name { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ProviderName** + +Gets or sets the name of the provider. + +```csharp +public string ProviderName { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ProviderType** + +Gets or sets the type of the provider. + +```csharp +public string ProviderType { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **AccessLevel** + +Gets or sets the access level. + +```csharp +public AccessLevel AccessLevel { get; set; } +``` + +#### Property Value + +[AccessLevel](./proffer.storage.configuration.accesslevel)
+ +### **FolderName** + +Gets or sets the name of the folder. + +```csharp +public string FolderName { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Constructors + +### **ScopedStoreOptions()** + + + +```csharp +public ScopedStoreOptions() +``` diff --git a/docs/storage/proffer.storage.configuration.storageoptions.md b/docs/storage/proffer.storage.configuration.storageoptions.md new file mode 100644 index 0000000..abbe887 --- /dev/null +++ b/docs/storage/proffer.storage.configuration.storageoptions.md @@ -0,0 +1,161 @@ +# StorageOptions + +Namespace: Proffer.Storage.Configuration + +The Proffer.Storage options with providers and stores. + +```csharp +public class StorageOptions : IParsedOptions`3 +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [StorageOptions](./proffer.storage.configuration.storageoptions)
+Implements [IParsedOptions<ProviderOptions, StoreOptions, ScopedStoreOptions>](./proffer.storage.configuration.iparsedoptions-3) + +## Fields + +### **DefaultConfigurationSectionName** + +The default configuration section name. + +```csharp +public static string DefaultConfigurationSectionName; +``` + +## Properties + +### **Name** + +Gets the name. + +```csharp +public string Name { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Providers** + +Gets or sets the providers unparsed options. + +```csharp +public IReadOnlyDictionary Providers { get; set; } +``` + +#### Property Value + +[IReadOnlyDictionary<String, IConfigurationSection>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
+ +### **Stores** + +Gets or sets the stores unparsed options. + +```csharp +public IReadOnlyDictionary Stores { get; set; } +``` + +#### Property Value + +[IReadOnlyDictionary<String, IConfigurationSection>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
+ +### **ScopedStores** + +Gets or sets the scoped stores unparsed options. + +```csharp +public IReadOnlyDictionary ScopedStores { get; set; } +``` + +#### Property Value + +[IReadOnlyDictionary<String, IConfigurationSection>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
+ +### **ConnectionStrings** + +Gets or sets the connection strings. + +```csharp +public IReadOnlyDictionary ConnectionStrings { get; set; } +``` + +#### Property Value + +[IReadOnlyDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
+ +### **ParsedProviders** + +Gets or sets the parsed provider instances options. + +```csharp +public IReadOnlyDictionary ParsedProviders { get; set; } +``` + +#### Property Value + +[IReadOnlyDictionary<String, ProviderOptions>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
+ +### **ParsedStores** + +Gets or sets the parsed stores options. + +```csharp +public IReadOnlyDictionary ParsedStores { get; set; } +``` + +#### Property Value + +[IReadOnlyDictionary<String, StoreOptions>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
+ +### **ParsedScopedStores** + +Gets or sets the parsed scoped stores options. + +```csharp +public IReadOnlyDictionary ParsedScopedStores { get; set; } +``` + +#### Property Value + +[IReadOnlyDictionary<String, ScopedStoreOptions>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ireadonlydictionary-2)
+ +## Constructors + +### **StorageOptions()** + +Initializes a new instance of the [StorageOptions](./proffer.storage.configuration.storageoptions) class. + +```csharp +public StorageOptions() +``` + +## Methods + +### **BindProviderOptions(ProviderOptions)** + +Binds the provider instance options. + +```csharp +public void BindProviderOptions(ProviderOptions providerInstanceOptions) +``` + +#### Parameters + +`providerInstanceOptions` ProviderOptions
+The provider instance options. + +### **BindStoreOptions(StoreOptions, ProviderOptions)** + +Binds the store options. + +```csharp +public void BindStoreOptions(StoreOptions storeOptions, ProviderOptions providerInstanceOptions) +``` + +#### Parameters + +`storeOptions` [StoreOptions](./proffer.storage.configuration.storeoptions)
+The store options. + +`providerInstanceOptions` ProviderOptions
+The provider instance options. diff --git a/docs/storage/proffer.storage.configuration.storeoptions.md b/docs/storage/proffer.storage.configuration.storeoptions.md new file mode 100644 index 0000000..c9985f1 --- /dev/null +++ b/docs/storage/proffer.storage.configuration.storeoptions.md @@ -0,0 +1,125 @@ +# StoreOptions + +Namespace: Proffer.Storage.Configuration + +Generic options for an [IStore](./proffer.storage.istore). + +```csharp +public class StoreOptions : IStoreOptions, Proffer.Configuration.INamedElementOptions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [StoreOptions](./proffer.storage.configuration.storeoptions)
+Implements [IStoreOptions](./proffer.storage.configuration.istoreoptions), INamedElementOptions + +## Properties + +### **Name** + +Gets or sets the name. + +```csharp +public string Name { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ProviderName** + +Gets or sets the name of the provider. + +```csharp +public string ProviderName { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ProviderType** + +Gets or sets the type of the provider. + +```csharp +public string ProviderType { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **AccessLevel** + +Gets or sets the access level. + +```csharp +public AccessLevel AccessLevel { get; set; } +``` + +#### Property Value + +[AccessLevel](./proffer.storage.configuration.accesslevel)
+ +### **FolderName** + +Gets or sets the name of the folder. + +```csharp +public string FolderName { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Constructors + +### **StoreOptions()** + + + +```csharp +public StoreOptions() +``` + +## Methods + +### **Validate(Boolean)** + +Validates the options. + +```csharp +public IEnumerable Validate(bool throwOnError) +``` + +#### Parameters + +`throwOnError` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, throws an exception when the validation fails with any . + +#### Returns + +[IEnumerable<IOptionError>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+ + The returned by the validation, if any. + +#### Exceptions + +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
+ +### **PushMissingPropertyError(List<OptionError>, String)** + +Pushes a missing property Proffer.Configuration.IOptionError to the list or errors. + +```csharp +protected void PushMissingPropertyError(List optionErrors, string propertyName) +``` + +#### Parameters + +`optionErrors` [List<OptionError>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1)
+The option errors. + +`propertyName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the missing property. diff --git a/docs/storage/proffer.storage.exceptions.badproviderconfiguration.md b/docs/storage/proffer.storage.exceptions.badproviderconfiguration.md new file mode 100644 index 0000000..a340fcb --- /dev/null +++ b/docs/storage/proffer.storage.exceptions.badproviderconfiguration.md @@ -0,0 +1,128 @@ +# BadProviderConfiguration + +Namespace: Proffer.Storage.Exceptions + +Thrown when a provider was not properly configured. + +```csharp +public class BadProviderConfiguration : System.Exception, System.Runtime.Serialization.ISerializable +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
+Implements [ISerializable](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.serialization.iserializable) + +## Properties + +### **TargetSite** + + + +```csharp +public MethodBase TargetSite { get; } +``` + +#### Property Value + +[MethodBase](https://docs.microsoft.com/en-us/dotnet/api/system.reflection.methodbase)
+ +### **StackTrace** + + + +```csharp +public string StackTrace { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Message** + + + +```csharp +public string Message { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Data** + + + +```csharp +public IDictionary Data { get; } +``` + +#### Property Value + +[IDictionary](https://docs.microsoft.com/en-us/dotnet/api/system.collections.idictionary)
+ +### **InnerException** + + + +```csharp +public Exception InnerException { get; } +``` + +#### Property Value + +[Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception)
+ +### **HelpLink** + + + +```csharp +public string HelpLink { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Source** + + + +```csharp +public string Source { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **HResult** + + + +```csharp +public int HResult { get; set; } +``` + +#### Property Value + +[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
+ +## Constructors + +### **BadProviderConfiguration(String, String)** + +Initializes a new instance of the [BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration) class. + +```csharp +public BadProviderConfiguration(string providerName, string details) +``` + +#### Parameters + +`providerName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the provider. + +`details` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The details. diff --git a/docs/storage/proffer.storage.exceptions.badscopedstoreconfiguration.md b/docs/storage/proffer.storage.exceptions.badscopedstoreconfiguration.md new file mode 100644 index 0000000..42dbe05 --- /dev/null +++ b/docs/storage/proffer.storage.exceptions.badscopedstoreconfiguration.md @@ -0,0 +1,131 @@ +# BadScopedStoreConfiguration + +Namespace: Proffer.Storage.Exceptions + +Thrown when a scoped store was not properly configured. + +```csharp +public class BadScopedStoreConfiguration : System.Exception, System.Runtime.Serialization.ISerializable +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [BadScopedStoreConfiguration](./proffer.storage.exceptions.badscopedstoreconfiguration)
+Implements [ISerializable](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.serialization.iserializable) + +## Properties + +### **TargetSite** + + + +```csharp +public MethodBase TargetSite { get; } +``` + +#### Property Value + +[MethodBase](https://docs.microsoft.com/en-us/dotnet/api/system.reflection.methodbase)
+ +### **StackTrace** + + + +```csharp +public string StackTrace { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Message** + + + +```csharp +public string Message { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Data** + + + +```csharp +public IDictionary Data { get; } +``` + +#### Property Value + +[IDictionary](https://docs.microsoft.com/en-us/dotnet/api/system.collections.idictionary)
+ +### **InnerException** + + + +```csharp +public Exception InnerException { get; } +``` + +#### Property Value + +[Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception)
+ +### **HelpLink** + + + +```csharp +public string HelpLink { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Source** + + + +```csharp +public string Source { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **HResult** + + + +```csharp +public int HResult { get; set; } +``` + +#### Property Value + +[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
+ +## Constructors + +### **BadScopedStoreConfiguration(String, String, Exception)** + +Initializes a new instance of the [BadScopedStoreConfiguration](./proffer.storage.exceptions.badscopedstoreconfiguration) class. + +```csharp +public BadScopedStoreConfiguration(string storeName, string details, Exception innerException) +``` + +#### Parameters + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the store. + +`details` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The details. + +`innerException` [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception)
+The inner exception. diff --git a/docs/storage/proffer.storage.exceptions.badstoreconfiguration.md b/docs/storage/proffer.storage.exceptions.badstoreconfiguration.md new file mode 100644 index 0000000..3ba48e2 --- /dev/null +++ b/docs/storage/proffer.storage.exceptions.badstoreconfiguration.md @@ -0,0 +1,156 @@ +# BadStoreConfiguration + +Namespace: Proffer.Storage.Exceptions + +Thrown when a store was not properly configured. + +```csharp +public class BadStoreConfiguration : System.Exception, System.Runtime.Serialization.ISerializable +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
+Implements [ISerializable](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.serialization.iserializable) + +## Properties + +### **Errors** + +Gets the validation errors. + +```csharp +public IEnumerable Errors { get; } +``` + +#### Property Value + +[IEnumerable<IOptionError>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+ +### **TargetSite** + + + +```csharp +public MethodBase TargetSite { get; } +``` + +#### Property Value + +[MethodBase](https://docs.microsoft.com/en-us/dotnet/api/system.reflection.methodbase)
+ +### **StackTrace** + + + +```csharp +public string StackTrace { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Message** + + + +```csharp +public string Message { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Data** + + + +```csharp +public IDictionary Data { get; } +``` + +#### Property Value + +[IDictionary](https://docs.microsoft.com/en-us/dotnet/api/system.collections.idictionary)
+ +### **InnerException** + + + +```csharp +public Exception InnerException { get; } +``` + +#### Property Value + +[Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception)
+ +### **HelpLink** + + + +```csharp +public string HelpLink { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Source** + + + +```csharp +public string Source { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **HResult** + + + +```csharp +public int HResult { get; set; } +``` + +#### Property Value + +[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
+ +## Constructors + +### **BadStoreConfiguration(String, String)** + +Initializes a new instance of the [BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration) class. + +```csharp +public BadStoreConfiguration(string storeName, string details) +``` + +#### Parameters + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the store. + +`details` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The details. + +### **BadStoreConfiguration(String, IEnumerable<IOptionError>)** + +Initializes a new instance of the [BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration) class. + +```csharp +public BadStoreConfiguration(string storeName, IEnumerable errors) +``` + +#### Parameters + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the store. + +`errors` [IEnumerable<IOptionError>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The errors. diff --git a/docs/storage/proffer.storage.exceptions.filealreadyexistsexception.md b/docs/storage/proffer.storage.exceptions.filealreadyexistsexception.md new file mode 100644 index 0000000..36ce657 --- /dev/null +++ b/docs/storage/proffer.storage.exceptions.filealreadyexistsexception.md @@ -0,0 +1,128 @@ +# FileAlreadyExistsException + +Namespace: Proffer.Storage.Exceptions + +Thrown when trying to create a file that already exists in a store. + +```csharp +public class FileAlreadyExistsException : System.Exception, System.Runtime.Serialization.ISerializable +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception)
+Implements [ISerializable](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.serialization.iserializable) + +## Properties + +### **TargetSite** + + + +```csharp +public MethodBase TargetSite { get; } +``` + +#### Property Value + +[MethodBase](https://docs.microsoft.com/en-us/dotnet/api/system.reflection.methodbase)
+ +### **StackTrace** + + + +```csharp +public string StackTrace { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Message** + + + +```csharp +public string Message { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Data** + + + +```csharp +public IDictionary Data { get; } +``` + +#### Property Value + +[IDictionary](https://docs.microsoft.com/en-us/dotnet/api/system.collections.idictionary)
+ +### **InnerException** + + + +```csharp +public Exception InnerException { get; } +``` + +#### Property Value + +[Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception)
+ +### **HelpLink** + + + +```csharp +public string HelpLink { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Source** + + + +```csharp +public string Source { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **HResult** + + + +```csharp +public int HResult { get; set; } +``` + +#### Property Value + +[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
+ +## Constructors + +### **FileAlreadyExistsException(String, String)** + +Initializes a new instance of the [FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception) class. + +```csharp +public FileAlreadyExistsException(string storeName, string filePath) +``` + +#### Parameters + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the store. + +`filePath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The file path. diff --git a/docs/storage/proffer.storage.exceptions.providernotfoundexception.md b/docs/storage/proffer.storage.exceptions.providernotfoundexception.md new file mode 100644 index 0000000..4599e72 --- /dev/null +++ b/docs/storage/proffer.storage.exceptions.providernotfoundexception.md @@ -0,0 +1,125 @@ +# ProviderNotFoundException + +Namespace: Proffer.Storage.Exceptions + +Thrown when a configured provider cannot be resolved through dependency injection. + +```csharp +public class ProviderNotFoundException : System.Exception, System.Runtime.Serialization.ISerializable +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
+Implements [ISerializable](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.serialization.iserializable) + +## Properties + +### **TargetSite** + + + +```csharp +public MethodBase TargetSite { get; } +``` + +#### Property Value + +[MethodBase](https://docs.microsoft.com/en-us/dotnet/api/system.reflection.methodbase)
+ +### **StackTrace** + + + +```csharp +public string StackTrace { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Message** + + + +```csharp +public string Message { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Data** + + + +```csharp +public IDictionary Data { get; } +``` + +#### Property Value + +[IDictionary](https://docs.microsoft.com/en-us/dotnet/api/system.collections.idictionary)
+ +### **InnerException** + + + +```csharp +public Exception InnerException { get; } +``` + +#### Property Value + +[Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception)
+ +### **HelpLink** + + + +```csharp +public string HelpLink { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Source** + + + +```csharp +public string Source { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **HResult** + + + +```csharp +public int HResult { get; set; } +``` + +#### Property Value + +[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
+ +## Constructors + +### **ProviderNotFoundException(String)** + +Initializes a new instance of the [ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception) class. + +```csharp +public ProviderNotFoundException(string providerName) +``` + +#### Parameters + +`providerName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the provider. diff --git a/docs/storage/proffer.storage.exceptions.storenotfoundexception.md b/docs/storage/proffer.storage.exceptions.storenotfoundexception.md new file mode 100644 index 0000000..76784bd --- /dev/null +++ b/docs/storage/proffer.storage.exceptions.storenotfoundexception.md @@ -0,0 +1,125 @@ +# StoreNotFoundException + +Namespace: Proffer.Storage.Exceptions + +Thrown when a store was not found in the configuration. + +```csharp +public class StoreNotFoundException : System.Exception, System.Runtime.Serialization.ISerializable +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
+Implements [ISerializable](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.serialization.iserializable) + +## Properties + +### **TargetSite** + + + +```csharp +public MethodBase TargetSite { get; } +``` + +#### Property Value + +[MethodBase](https://docs.microsoft.com/en-us/dotnet/api/system.reflection.methodbase)
+ +### **StackTrace** + + + +```csharp +public string StackTrace { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Message** + + + +```csharp +public string Message { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Data** + + + +```csharp +public IDictionary Data { get; } +``` + +#### Property Value + +[IDictionary](https://docs.microsoft.com/en-us/dotnet/api/system.collections.idictionary)
+ +### **InnerException** + + + +```csharp +public Exception InnerException { get; } +``` + +#### Property Value + +[Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception)
+ +### **HelpLink** + + + +```csharp +public string HelpLink { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Source** + + + +```csharp +public string Source { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **HResult** + + + +```csharp +public int HResult { get; set; } +``` + +#### Property Value + +[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
+ +## Constructors + +### **StoreNotFoundException(String)** + +Initializes a new instance of the [StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception) class. + +```csharp +public StoreNotFoundException(string storeName) +``` + +#### Parameters + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the store. diff --git a/docs/storage/proffer.storage.ifileproperties.md b/docs/storage/proffer.storage.ifileproperties.md new file mode 100644 index 0000000..7bfadcb --- /dev/null +++ b/docs/storage/proffer.storage.ifileproperties.md @@ -0,0 +1,95 @@ +# IFileProperties + +Namespace: Proffer.Storage + +File common properties with metadata. + +```csharp +public interface IFileProperties +``` + +## Properties + +### **LastModified** + +Gets the last modified time. + +```csharp +public abstract Nullable LastModified { get; } +``` + +#### Property Value + +[Nullable<DateTimeOffset>](https://docs.microsoft.com/en-us/dotnet/api/system.nullable-1)
+ +### **Length** + +Gets the length of the content. + +```csharp +public abstract long Length { get; } +``` + +#### Property Value + +[Int64](https://docs.microsoft.com/en-us/dotnet/api/system.int64)
+ +### **ContentType** + +Gets or sets the content-type. + +```csharp +public abstract string ContentType { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ETag** + +Gets the etag. + +```csharp +public abstract string ETag { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **CacheControl** + +Gets or sets the cache control. + +```csharp +public abstract string CacheControl { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **ContentMD5** + +Gets the MD5 digest of the content. + +```csharp +public abstract string ContentMD5 { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Metadata** + +Gets the metadata. + +```csharp +public abstract IDictionary Metadata { get; } +``` + +#### Property Value + +[IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
diff --git a/docs/storage/proffer.storage.ifilereference.md b/docs/storage/proffer.storage.ifilereference.md new file mode 100644 index 0000000..374663e --- /dev/null +++ b/docs/storage/proffer.storage.ifilereference.md @@ -0,0 +1,171 @@ +# IFileReference + +Namespace: Proffer.Storage + +A reference of a stored file at a given path. + +```csharp +public interface IFileReference : IPrivateFileReference +``` + +Implements [IPrivateFileReference](./proffer.storage.iprivatefilereference) + +## Properties + +### **PublicUrl** + +Gets the public URL. + +```csharp +public abstract string PublicUrl { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Properties** + +Gets the properties. + +```csharp +public abstract IFileProperties Properties { get; } +``` + +#### Property Value + +[IFileProperties](./proffer.storage.ifileproperties)
+ +## Methods + +### **ReadToStreamAsync(Stream)** + +Reads the file content into the given stream. + +```csharp +Task ReadToStreamAsync(Stream targetStream) +``` + +#### Parameters + +`targetStream` [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream)
+The target stream. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+A task that represents the asynchronous operation. + +### **ReadAsync()** + +Reads the file content. + +```csharp +ValueTask ReadAsync() +``` + +#### Returns + +ValueTask<Stream>
+A containing the file content. + +### **ReadAllTextAsync()** + +Reads the file content. + +```csharp +ValueTask ReadAllTextAsync() +``` + +#### Returns + +ValueTask<String>
+A containing the file content. + +### **ReadAllBytesAsync()** + +Reads the file content. + +```csharp +ValueTask ReadAllBytesAsync() +``` + +#### Returns + +ValueTask<Byte[]>
+A containing the file content. + +### **DeleteAsync()** + +Deletes the file. + +```csharp +Task DeleteAsync() +``` + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+A task that represents the asynchronous operation. + +### **UpdateAsync(Stream)** + +Updates the file content with the given [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream). + +```csharp +Task UpdateAsync(Stream stream) +``` + +#### Parameters + +`stream` [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream)
+The new file content. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+A task that represents the asynchronous operation. + +### **SavePropertiesAsync()** + +Saves the file properties. + +```csharp +Task SavePropertiesAsync() +``` + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+A task that represents the asynchronous operation. + +### **GetSharedAccessSignature(ISharedAccessPolicy)** + +Gets a shared access signature. + +```csharp +ValueTask GetSharedAccessSignature(ISharedAccessPolicy policy) +``` + +#### Parameters + +`policy` [ISharedAccessPolicy](./proffer.storage.isharedaccesspolicy)
+The policy. + +#### Returns + +ValueTask<String>
+A shared access signature to read file. + +### **FetchProperties()** + +Fetches the file properties. + +```csharp +Task FetchProperties() +``` + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+A task that represents the asynchronous operation. diff --git a/docs/storage/proffer.storage.internal.configureprovideroptions-4.md b/docs/storage/proffer.storage.internal.configureprovideroptions-4.md new file mode 100644 index 0000000..b7f1613 --- /dev/null +++ b/docs/storage/proffer.storage.internal.configureprovideroptions-4.md @@ -0,0 +1,62 @@ +# ConfigureProviderOptions<TParsedOptions, TProviderOptions, TStoreOptions, TScopedStoreOptions> + +Namespace: Proffer.Storage.Internal + +Configures a provider from generic [StorageOptions](./proffer.storage.configuration.storageoptions). + +```csharp +public class ConfigureProviderOptions : +``` + +#### Type Parameters + +`TParsedOptions`
+The type of the parsed options. + +`TProviderOptions`
+The type of the provider instance options. + +`TStoreOptions`
+The type of the store options. + +`TScopedStoreOptions`
+The type of the scoped store options. + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ConfigureProviderOptions<TParsedOptions, TProviderOptions, TStoreOptions, TScopedStoreOptions>](./proffer.storage.internal.configureprovideroptions-4)
+Implements IConfigureOptions<TParsedOptions> + +## Constructors + +### **ConfigureProviderOptions(IOptions<StorageOptions>)** + +Initializes a new instance of the [ConfigureProviderOptions<TParsedOptions, TProviderOptions, TStoreOptions, TScopedStoreOptions>](./proffer.storage.internal.configureprovideroptions-4) class. + +```csharp +public ConfigureProviderOptions(IOptions storageOptions) +``` + +#### Parameters + +`storageOptions` IOptions<StorageOptions>
+The storage options. + +## Methods + +### **Configure(TParsedOptions)** + +Invoked to configure a instance. + +```csharp +public void Configure(TParsedOptions options) +``` + +#### Parameters + +`options` TParsedOptions
+The options instance to configure. + +#### Exceptions + +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
+ +[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
diff --git a/docs/storage/proffer.storage.internal.genericstoreproxy-1.md b/docs/storage/proffer.storage.internal.genericstoreproxy-1.md new file mode 100644 index 0000000..0213c13 --- /dev/null +++ b/docs/storage/proffer.storage.internal.genericstoreproxy-1.md @@ -0,0 +1,343 @@ +# GenericStoreProxy<TOptions> + +Namespace: Proffer.Storage.Internal + +Generic [IStore](./proffer.storage.istore) proxy to allow direct dependency injection of a [IStore<TOptions>](./proffer.storage.istore-1). + +```csharp +public class GenericStoreProxy : Proffer.Storage.IStore, +``` + +#### Type Parameters + +`TOptions`
+The type of the store options. + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [GenericStoreProxy<TOptions>](./proffer.storage.internal.genericstoreproxy-1)
+Implements [IStore](./proffer.storage.istore), IStore<TOptions> + +## Properties + +### **Name** + +Gets the name of the store. + +```csharp +public string Name { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Constructors + +### **GenericStoreProxy(IStorageFactory, IOptions<TOptions>)** + +Initializes a new instance of the [GenericStoreProxy<TOptions>](./proffer.storage.internal.genericstoreproxy-1) class. + +```csharp +public GenericStoreProxy(IStorageFactory factory, IOptions options) +``` + +#### Parameters + +`factory` [IStorageFactory](./proffer.storage.istoragefactory)
+The storage factory. + +`options` IOptions<TOptions>
+The options. + +#### Exceptions + +[ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/system.argumentnullexception)
+ +## Methods + +### **InitAsync(CancellationToken)** + +Initializes the store by creating a container in its [IStorageProvider](./proffer.storage.istorageprovider). + +```csharp +public Task InitAsync(CancellationToken cancellationToken) +``` + +#### Parameters + +`cancellationToken` [CancellationToken](https://docs.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken)
+ +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **DeleteAsync(IPrivateFileReference)** + +Deletes the file. + +```csharp +public Task DeleteAsync(IPrivateFileReference file) +``` + +#### Parameters + +`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
+The reference holding the file path. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **GetAsync(Uri, Boolean)** + +Gets the file reference from URI. + +```csharp +public ValueTask GetAsync(Uri file, bool withMetadata) +``` + +#### Parameters + +`file` Uri
+The file uniform resource identifier (URI). + +`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, fetch metadata for the file. + +#### Returns + +ValueTask<IFileReference>
+ + The at path. + +#### Exceptions + +[InvalidOperationException](https://docs.microsoft.com/en-us/dotnet/api/system.invalidoperationexception)
+ +### **GetAsync(IPrivateFileReference, Boolean)** + +Gets the file reference from path. + +```csharp +public ValueTask GetAsync(IPrivateFileReference file, bool withMetadata) +``` + +#### Parameters + +`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
+The reference holding the file path. + +`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, fetch metadata for the file. + +#### Returns + +ValueTask<IFileReference>
+ + The at path. + +### **ListAsync(String, Boolean, Boolean)** + +Lists the files under . + +```csharp +public ValueTask ListAsync(string path, bool recursive, bool withMetadata) +``` + +#### Parameters + +`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The path. + +`recursive` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, recurse the listing across folders. + +`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, fetch metadata for each file. + +#### Returns + +ValueTask<IFileReference[]>
+ + The list under . + +### **ListAsync(String, String, Boolean, Boolean)** + +Lists the files under matching the . + +```csharp +public ValueTask ListAsync(string path, string searchPattern, bool recursive, bool withMetadata) +``` + +#### Parameters + +`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The path. + +`searchPattern` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The search pattern. + +`recursive` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, recurse the listing across folders. + +`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, fetch metadata for each file. + +#### Returns + +ValueTask<IFileReference[]>
+ + The list under matching the . + +### **ReadAllBytesAsync(IPrivateFileReference)** + +Reads the file content. + +```csharp +public ValueTask ReadAllBytesAsync(IPrivateFileReference file) +``` + +#### Parameters + +`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
+The reference holding the file path. + +#### Returns + +ValueTask<Byte[]>
+ + A containing the file content. + +### **ReadAllTextAsync(IPrivateFileReference)** + +Reads the file content. + +```csharp +public ValueTask ReadAllTextAsync(IPrivateFileReference file) +``` + +#### Parameters + +`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
+The reference holding the file path. + +#### Returns + +ValueTask<String>
+ + A containing the file content. + +### **ReadAsync(IPrivateFileReference)** + +Reads the file content. + +```csharp +public ValueTask ReadAsync(IPrivateFileReference file) +``` + +#### Parameters + +`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
+The reference holding the file path. + +#### Returns + +ValueTask<Stream>
+ + A containing the file content. + +### **SaveAsync(Stream, IPrivateFileReference, String, OverwritePolicy, IDictionary<String, String>)** + +Saves the file. + +```csharp +public ValueTask SaveAsync(Stream data, IPrivateFileReference file, string contentType, OverwritePolicy overwritePolicy, IDictionary metadata) +``` + +#### Parameters + +`data` [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream)
+The file content. + +`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
+The reference holding the file path. + +`contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The content-type of the file. + +`overwritePolicy` [OverwritePolicy](./proffer.storage.overwritepolicy)
+The overwrite policy. + +`metadata` [IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
+The metadata. + +#### Returns + +ValueTask<IFileReference>
+ + The saved . + +#### Exceptions + +[FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception)
+ +### **SaveAsync(Byte[], IPrivateFileReference, String, OverwritePolicy, IDictionary<String, String>)** + +Saves the file. + +```csharp +public ValueTask SaveAsync(Byte[] data, IPrivateFileReference file, string contentType, OverwritePolicy overwritePolicy, IDictionary metadata) +``` + +#### Parameters + +`data` [Byte[]](https://docs.microsoft.com/en-us/dotnet/api/system.byte)
+The file content. + +`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
+The reference holding the file path. + +`contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The content-type of the file. + +`overwritePolicy` [OverwritePolicy](./proffer.storage.overwritepolicy)
+The overwrite policy. + +`metadata` [IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
+The metadata. + +#### Returns + +ValueTask<IFileReference>
+ + The saved . + +#### Exceptions + +[FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception)
+ +### **GetSharedAccessSignatureAsync(ISharedAccessPolicy)** + +Gets a shared access signature. + +```csharp +public ValueTask GetSharedAccessSignatureAsync(ISharedAccessPolicy policy) +``` + +#### Parameters + +`policy` [ISharedAccessPolicy](./proffer.storage.isharedaccesspolicy)
+The policy. + +#### Returns + +ValueTask<String>
+ + A shared access signature to read or list the store files. + +#### Exceptions + +[NotSupportedException](https://docs.microsoft.com/en-us/dotnet/api/system.notsupportedexception)
diff --git a/docs/storage/proffer.storage.internal.privatefilereference.md b/docs/storage/proffer.storage.internal.privatefilereference.md new file mode 100644 index 0000000..7b8dd38 --- /dev/null +++ b/docs/storage/proffer.storage.internal.privatefilereference.md @@ -0,0 +1,41 @@ +# PrivateFileReference + +Namespace: Proffer.Storage.Internal + +A simple reference of a stored file at a given path. + +```csharp +public class PrivateFileReference : Proffer.Storage.IPrivateFileReference +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [PrivateFileReference](./proffer.storage.internal.privatefilereference)
+Implements [IPrivateFileReference](./proffer.storage.iprivatefilereference) + +## Properties + +### **Path** + +Gets the file path. + +```csharp +public string Path { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Constructors + +### **PrivateFileReference(String)** + +Initializes a new instance of the [PrivateFileReference](./proffer.storage.internal.privatefilereference) class. + +```csharp +public PrivateFileReference(string path) +``` + +#### Parameters + +`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The file path. diff --git a/docs/storage/proffer.storage.internal.storagefactory.md b/docs/storage/proffer.storage.internal.storagefactory.md new file mode 100644 index 0000000..63a03a9 --- /dev/null +++ b/docs/storage/proffer.storage.internal.storagefactory.md @@ -0,0 +1,192 @@ +# StorageFactory + +Namespace: Proffer.Storage.Internal + +Default storage factory to build [IStore](./proffer.storage.istore) from configured [IStorageProvider](./proffer.storage.istorageprovider). + +```csharp +public class StorageFactory : Proffer.Storage.IStorageFactory +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [StorageFactory](./proffer.storage.internal.storagefactory)
+Implements [IStorageFactory](./proffer.storage.istoragefactory) + +## Constructors + +### **StorageFactory(IEnumerable<IStorageProvider>, IOptions<StorageOptions>)** + +Initializes a new instance of the [StorageFactory](./proffer.storage.internal.storagefactory) class. + +```csharp +public StorageFactory(IEnumerable storageProviders, IOptions options) +``` + +#### Parameters + +`storageProviders` [IEnumerable<IStorageProvider>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The storage providers. + +`options` IOptions<StorageOptions>
+The options. + +## Methods + +### **GetStore(String, IStoreOptions)** + +Gets a store with specific options. + +```csharp +public IStore GetStore(string storeName, IStoreOptions configuration) +``` + +#### Parameters + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the store. + +`configuration` [IStoreOptions](./proffer.storage.configuration.istoreoptions)
+The store options. + +#### Returns + +[IStore](./proffer.storage.istore)
+ + A configured . + +#### Exceptions + +[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
+ +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
+ +[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
+ +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
+ +### **GetStore(String)** + +Gets a store from configured options. + +```csharp +public IStore GetStore(string storeName) +``` + +#### Parameters + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the store. + +#### Returns + +[IStore](./proffer.storage.istore)
+ + A configured . + +#### Exceptions + +[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
+ +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
+ +[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
+ +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
+ +### **GetScopedStore(String, Object[])** + +Gets a scoped store from configured options. + +```csharp +public IStore GetScopedStore(string storeName, Object[] args) +``` + +#### Parameters + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the scoped store. + +`args` [Object[]](https://docs.microsoft.com/en-us/dotnet/api/system.object)
+The arguments to apply to the scoped store name format. + +#### Returns + +[IStore](./proffer.storage.istore)
+ + A configured . + +#### Exceptions + +[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
+ +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
+ +[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
+ +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
+ +[BadScopedStoreConfiguration](./proffer.storage.exceptions.badscopedstoreconfiguration)
+ +### **TryGetStore(String, IStore&)** + +Gets a store from configured options. + +```csharp +public bool TryGetStore(string storeName, IStore& store) +``` + +#### Parameters + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the store. + +`store` [IStore&](./proffer.storage.istore&)
+When this method returns, contains the store associated with the specified name, if it is found in the ; otherwise, null. This parameter is passed uninitialized. + +#### Returns + +[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+true if the store was configured and built from its provider; otherwise, false. + +#### Exceptions + +[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
+ +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
+ +[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
+ +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
+ +### **TryGetStore(String, IStore&, String)** + +Gets a store from configured options. + +```csharp +public bool TryGetStore(string storeName, IStore& store, string providerName) +``` + +#### Parameters + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the store. + +`store` [IStore&](./proffer.storage.istore&)
+When this method returns, contains the store associated with the specified name, if it is found in the ; otherwise, null. This parameter is passed uninitialized. + +`providerName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The explicit provider name from which the store should be built. + +#### Returns + +[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+true if the store was configured and built from its provider; otherwise, false. + +#### Exceptions + +[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
+ +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
+ +[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
+ +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
diff --git a/docs/storage/proffer.storage.internal.storageproviderbase-4.md b/docs/storage/proffer.storage.internal.storageproviderbase-4.md new file mode 100644 index 0000000..bc3f53b --- /dev/null +++ b/docs/storage/proffer.storage.internal.storageproviderbase-4.md @@ -0,0 +1,152 @@ +# StorageProviderBase<TParsedOptions, TInstanceOptions, TStoreOptions, TScopedStoreOptions> + +Namespace: Proffer.Storage.Internal + +A base provider to handle and build file stores pointing on a particular storage system location. + +```csharp +public abstract class StorageProviderBase : Proffer.Storage.IStorageProvider +``` + +#### Type Parameters + +`TParsedOptions`
+The type of the parsed options. + +`TInstanceOptions`
+The type of the provider instance options. + +`TStoreOptions`
+The type of the store options. + +`TScopedStoreOptions`
+The type of the scoped store options. + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [StorageProviderBase<TParsedOptions, TInstanceOptions, TStoreOptions, TScopedStoreOptions>](./proffer.storage.internal.storageproviderbase-4)
+Implements [IStorageProvider](./proffer.storage.istorageprovider) + +## Properties + +### **Name** + +Gets the name of this provider. + +```csharp +public abstract string Name { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Constructors + +### **StorageProviderBase(IOptions<TParsedOptions>)** + +Initializes a new instance of the [StorageProviderBase<TParsedOptions, TInstanceOptions, TStoreOptions, TScopedStoreOptions>](./proffer.storage.internal.storageproviderbase-4) class. + +```csharp +public StorageProviderBase(IOptions options) +``` + +#### Parameters + +`options` IOptions<TParsedOptions>
+The options. + +## Methods + +### **BuildStore(String)** + +Builds a store from configured options. + +```csharp +public IStore BuildStore(string storeName) +``` + +#### Parameters + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the store. + +#### Returns + +[IStore](./proffer.storage.istore)
+ + A configured . + +#### Exceptions + +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
+ +### **BuildStore(String, IStoreOptions)** + +Builds a store with specific options. + +```csharp +public IStore BuildStore(string storeName, IStoreOptions storeOptions) +``` + +#### Parameters + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the store. + +`storeOptions` [IStoreOptions](./proffer.storage.configuration.istoreoptions)
+The store options. + +#### Returns + +[IStore](./proffer.storage.istore)
+ + A configured . + +### **BuildScopedStore(String, Object[])** + +Builds a scoped store from configured options. + +```csharp +public IStore BuildScopedStore(string storeName, Object[] args) +``` + +#### Parameters + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the store. + +`args` [Object[]](https://docs.microsoft.com/en-us/dotnet/api/system.object)
+The arguments to apply to the scoped store name format. + +#### Returns + +[IStore](./proffer.storage.istore)
+ + A configured . + +#### Exceptions + +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
+ +[BadScopedStoreConfiguration](./proffer.storage.exceptions.badscopedstoreconfiguration)
+ +### **BuildStoreInternal(String, TStoreOptions)** + +Provider-specific build of a store with specific options. + +```csharp +protected abstract IStore BuildStoreInternal(string storeName, TStoreOptions storeOptions) +``` + +#### Parameters + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the store. + +`storeOptions` TStoreOptions
+The store options. + +#### Returns + +[IStore](./proffer.storage.istore)
+ + A configured . diff --git a/docs/storage/proffer.storage.iprivatefilereference.md b/docs/storage/proffer.storage.iprivatefilereference.md new file mode 100644 index 0000000..a82c61e --- /dev/null +++ b/docs/storage/proffer.storage.iprivatefilereference.md @@ -0,0 +1,23 @@ +# IPrivateFileReference + +Namespace: Proffer.Storage + +A reference of a stored file at a given path. + +```csharp +public interface IPrivateFileReference +``` + +## Properties + +### **Path** + +Gets the file path. + +```csharp +public abstract string Path { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
diff --git a/docs/storage/proffer.storage.isharedaccesspolicy.md b/docs/storage/proffer.storage.isharedaccesspolicy.md new file mode 100644 index 0000000..143e7de --- /dev/null +++ b/docs/storage/proffer.storage.isharedaccesspolicy.md @@ -0,0 +1,47 @@ +# ISharedAccessPolicy + +Namespace: Proffer.Storage + +Represents a shared access policy, which specifies the start time, expiry time, and permissions for a shared access signature. + +```csharp +public interface ISharedAccessPolicy +``` + +## Properties + +### **StartTime** + +Gets the start time. + +```csharp +public abstract Nullable StartTime { get; } +``` + +#### Property Value + +[Nullable<DateTimeOffset>](https://docs.microsoft.com/en-us/dotnet/api/system.nullable-1)
+ +### **ExpiryTime** + +Gets the expiry time. + +```csharp +public abstract Nullable ExpiryTime { get; } +``` + +#### Property Value + +[Nullable<DateTimeOffset>](https://docs.microsoft.com/en-us/dotnet/api/system.nullable-1)
+ +### **Permissions** + +Gets the permissions. + +```csharp +public abstract SharedAccessPermissions Permissions { get; } +``` + +#### Property Value + +[SharedAccessPermissions](./proffer.storage.sharedaccesspermissions)
diff --git a/docs/storage/proffer.storage.istoragefactory.md b/docs/storage/proffer.storage.istoragefactory.md new file mode 100644 index 0000000..5bdc99d --- /dev/null +++ b/docs/storage/proffer.storage.istoragefactory.md @@ -0,0 +1,171 @@ +# IStorageFactory + +Namespace: Proffer.Storage + +Builds [IStore](./proffer.storage.istore) from configured [IStorageProvider](./proffer.storage.istorageprovider). + +```csharp +public interface IStorageFactory +``` + +## Methods + +### **GetStore(String, IStoreOptions)** + +Gets a store with specific options. + +```csharp +IStore GetStore(string storeName, IStoreOptions configuration) +``` + +#### Parameters + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the store. + +`configuration` [IStoreOptions](./proffer.storage.configuration.istoreoptions)
+The store options. + +#### Returns + +[IStore](./proffer.storage.istore)
+ + A configured . + +#### Exceptions + +[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
+ +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
+ +[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
+ +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
+ +### **GetStore(String)** + +Gets a store from configured options. + +```csharp +IStore GetStore(string storeName) +``` + +#### Parameters + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the store. + +#### Returns + +[IStore](./proffer.storage.istore)
+ + A configured . + +#### Exceptions + +[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
+ +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
+ +[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
+ +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
+ +### **GetScopedStore(String, Object[])** + +Gets a scoped store from configured options. + +```csharp +IStore GetScopedStore(string storeName, Object[] args) +``` + +#### Parameters + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the scoped store. + +`args` [Object[]](https://docs.microsoft.com/en-us/dotnet/api/system.object)
+The arguments to apply to the scoped store name format. + +#### Returns + +[IStore](./proffer.storage.istore)
+ + A configured . + +#### Exceptions + +[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
+ +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
+ +[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
+ +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
+ +[BadScopedStoreConfiguration](./proffer.storage.exceptions.badscopedstoreconfiguration)
+ +### **TryGetStore(String, IStore&)** + +Gets a store from configured options. + +```csharp +bool TryGetStore(string storeName, IStore& store) +``` + +#### Parameters + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the store. + +`store` [IStore&](./proffer.storage.istore&)
+When this method returns, contains the store associated with the specified name, if it is found in the ; otherwise, null. This parameter is passed uninitialized. + +#### Returns + +[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+true if the store was configured and built from its provider; otherwise, false. + +#### Exceptions + +[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
+ +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
+ +[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
+ +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
+ +### **TryGetStore(String, IStore&, String)** + +Gets a store from configured options. + +```csharp +bool TryGetStore(string storeName, IStore& store, string providerName) +``` + +#### Parameters + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the store. + +`store` [IStore&](./proffer.storage.istore&)
+When this method returns, contains the store associated with the specified name, if it is found in the ; otherwise, null. This parameter is passed uninitialized. + +`providerName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The explicit provider name from which the store should be built. + +#### Returns + +[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+true if the store was configured and built from its provider; otherwise, false. + +#### Exceptions + +[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
+ +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
+ +[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
+ +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
diff --git a/docs/storage/proffer.storage.istorageprovider.md b/docs/storage/proffer.storage.istorageprovider.md new file mode 100644 index 0000000..7423d04 --- /dev/null +++ b/docs/storage/proffer.storage.istorageprovider.md @@ -0,0 +1,98 @@ +# IStorageProvider + +Namespace: Proffer.Storage + +A provider handles and builds file stores pointing on a particular storage system location. + +```csharp +public interface IStorageProvider +``` + +## Properties + +### **Name** + +Gets the name of this provider. + +```csharp +public abstract string Name { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Methods + +### **BuildStore(String)** + +Builds a store from configured options. + +```csharp +IStore BuildStore(string storeName) +``` + +#### Parameters + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the store. + +#### Returns + +[IStore](./proffer.storage.istore)
+ + A configured . + +#### Exceptions + +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
+ +### **BuildStore(String, IStoreOptions)** + +Builds a store with specific options. + +```csharp +IStore BuildStore(string storeName, IStoreOptions storeOptions) +``` + +#### Parameters + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the store. + +`storeOptions` [IStoreOptions](./proffer.storage.configuration.istoreoptions)
+The store options. + +#### Returns + +[IStore](./proffer.storage.istore)
+ + A configured . + +### **BuildScopedStore(String, Object[])** + +Builds a scoped store from configured options. + +```csharp +IStore BuildScopedStore(string storeName, Object[] args) +``` + +#### Parameters + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the store. + +`args` [Object[]](https://docs.microsoft.com/en-us/dotnet/api/system.object)
+The arguments to apply to the scoped store name format. + +#### Returns + +[IStore](./proffer.storage.istore)
+ + A configured . + +#### Exceptions + +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
+ +[BadScopedStoreConfiguration](./proffer.storage.exceptions.badscopedstoreconfiguration)
diff --git a/docs/storage/proffer.storage.istore-1.md b/docs/storage/proffer.storage.istore-1.md new file mode 100644 index 0000000..ed0bf81 --- /dev/null +++ b/docs/storage/proffer.storage.istore-1.md @@ -0,0 +1,16 @@ +# IStore<TOptions> + +Namespace: Proffer.Storage + +Injectable typed store, which allows to save, list or read files on a container in its configured [IStorageProvider](./proffer.storage.istorageprovider). + +```csharp +public interface IStore : IStore +``` + +#### Type Parameters + +`TOptions`
+The type of the store options. + +Implements [IStore](./proffer.storage.istore) diff --git a/docs/storage/proffer.storage.istore.md b/docs/storage/proffer.storage.istore.md new file mode 100644 index 0000000..7826d8a --- /dev/null +++ b/docs/storage/proffer.storage.istore.md @@ -0,0 +1,301 @@ +# IStore + +Namespace: Proffer.Storage + +A store allows to save, list or read files on a container in its configured [IStorageProvider](./proffer.storage.istorageprovider). + +```csharp +public interface IStore +``` + +## Properties + +### **Name** + +Gets the name of the store. + +```csharp +public abstract string Name { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +## Methods + +### **InitAsync(CancellationToken)** + +Initializes the store by creating a container in its [IStorageProvider](./proffer.storage.istorageprovider). + +```csharp +Task InitAsync(CancellationToken cancellationToken) +``` + +#### Parameters + +`cancellationToken` [CancellationToken](https://docs.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken)
+ +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+A task that represents the asynchronous operation. + +### **ListAsync(String, Boolean, Boolean)** + +Lists the files under . + +```csharp +ValueTask ListAsync(string path, bool recursive, bool withMetadata) +``` + +#### Parameters + +`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The path. + +`recursive` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, recurse the listing across folders. + +`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, fetch metadata for each file. + +#### Returns + +ValueTask<IFileReference[]>
+The list under . + +### **ListAsync(String, String, Boolean, Boolean)** + +Lists the files under matching the . + +```csharp +ValueTask ListAsync(string path, string searchPattern, bool recursive, bool withMetadata) +``` + +#### Parameters + +`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The path. + +`searchPattern` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The search pattern. + +`recursive` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, recurse the listing across folders. + +`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, fetch metadata for each file. + +#### Returns + +ValueTask<IFileReference[]>
+The list under matching the . + +### **GetAsync(IPrivateFileReference, Boolean)** + +Gets the file reference from path. + +```csharp +ValueTask GetAsync(IPrivateFileReference file, bool withMetadata) +``` + +#### Parameters + +`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
+The reference holding the file path. + +`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, fetch metadata for the file. + +#### Returns + +ValueTask<IFileReference>
+The at path. + +### **GetAsync(Uri, Boolean)** + +Gets the file reference from URI. + +```csharp +ValueTask GetAsync(Uri uri, bool withMetadata) +``` + +#### Parameters + +`uri` Uri
+The file uniform resource identifier (URI). + +`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, fetch metadata for the file. + +#### Returns + +ValueTask<IFileReference>
+The at path. + +#### Exceptions + +[InvalidOperationException](https://docs.microsoft.com/en-us/dotnet/api/system.invalidoperationexception)
+ +### **DeleteAsync(IPrivateFileReference)** + +Deletes the file. + +```csharp +Task DeleteAsync(IPrivateFileReference file) +``` + +#### Parameters + +`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
+The reference holding the file path. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+A task that represents the asynchronous operation. + +### **ReadAsync(IPrivateFileReference)** + +Reads the file content. + +```csharp +ValueTask ReadAsync(IPrivateFileReference file) +``` + +#### Parameters + +`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
+The reference holding the file path. + +#### Returns + +ValueTask<Stream>
+A containing the file content. + +### **ReadAllBytesAsync(IPrivateFileReference)** + +Reads the file content. + +```csharp +ValueTask ReadAllBytesAsync(IPrivateFileReference file) +``` + +#### Parameters + +`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
+The reference holding the file path. + +#### Returns + +ValueTask<Byte[]>
+A containing the file content. + +### **ReadAllTextAsync(IPrivateFileReference)** + +Reads the file content. + +```csharp +ValueTask ReadAllTextAsync(IPrivateFileReference file) +``` + +#### Parameters + +`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
+The reference holding the file path. + +#### Returns + +ValueTask<String>
+A containing the file content. + +### **SaveAsync(Byte[], IPrivateFileReference, String, OverwritePolicy, IDictionary<String, String>)** + +Saves the file. + +```csharp +ValueTask SaveAsync(Byte[] data, IPrivateFileReference file, string contentType, OverwritePolicy overwritePolicy, IDictionary metadata) +``` + +#### Parameters + +`data` [Byte[]](https://docs.microsoft.com/en-us/dotnet/api/system.byte)
+The file content. + +`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
+The reference holding the file path. + +`contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The content-type of the file. + +`overwritePolicy` [OverwritePolicy](./proffer.storage.overwritepolicy)
+The overwrite policy. + +`metadata` [IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
+The metadata. + +#### Returns + +ValueTask<IFileReference>
+The saved . + +#### Exceptions + +[FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception)
+ +### **SaveAsync(Stream, IPrivateFileReference, String, OverwritePolicy, IDictionary<String, String>)** + +Saves the file. + +```csharp +ValueTask SaveAsync(Stream data, IPrivateFileReference file, string contentType, OverwritePolicy overwritePolicy, IDictionary metadata) +``` + +#### Parameters + +`data` [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream)
+The file content. + +`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
+The reference holding the file path. + +`contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The content-type of the file. + +`overwritePolicy` [OverwritePolicy](./proffer.storage.overwritepolicy)
+The overwrite policy. + +`metadata` [IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
+The metadata. + +#### Returns + +ValueTask<IFileReference>
+The saved . + +#### Exceptions + +[FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception)
+ +### **GetSharedAccessSignatureAsync(ISharedAccessPolicy)** + +Gets a shared access signature. + +```csharp +ValueTask GetSharedAccessSignatureAsync(ISharedAccessPolicy policy) +``` + +#### Parameters + +`policy` [ISharedAccessPolicy](./proffer.storage.isharedaccesspolicy)
+The policy. + +#### Returns + +ValueTask<String>
+A shared access signature to read or list the store files. + +#### Exceptions + +[NotSupportedException](https://docs.microsoft.com/en-us/dotnet/api/system.notsupportedexception)
diff --git a/docs/storage/proffer.storage.istoreextensions.md b/docs/storage/proffer.storage.istoreextensions.md new file mode 100644 index 0000000..c051a6e --- /dev/null +++ b/docs/storage/proffer.storage.istoreextensions.md @@ -0,0 +1,261 @@ +# IStoreExtensions + +Namespace: Proffer.Storage + +[IStore](./proffer.storage.istore) extension methods. + +```csharp +public static class IStoreExtensions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [IStoreExtensions](./proffer.storage.istoreextensions) + +## Methods + +### **ListAsync(IStore, String, Boolean, Boolean)** + +Lists the files under . + +```csharp +public static ValueTask ListAsync(IStore store, string path, bool recursive, bool withMetadata) +``` + +#### Parameters + +`store` [IStore](./proffer.storage.istore)
+The store. + +`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The path. + +`recursive` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, recurse the listing across folders. + +`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, fetch metadata for each file. + +#### Returns + +ValueTask<IFileReference[]>
+ + The list under . + +### **ListAsync(IStore, String, String, Boolean, Boolean)** + +Lists the files under matching the . + +```csharp +public static ValueTask ListAsync(IStore store, string path, string searchPattern, bool recursive, bool withMetadata) +``` + +#### Parameters + +`store` [IStore](./proffer.storage.istore)
+The store. + +`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The path. + +`searchPattern` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The search pattern. + +`recursive` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, recurse the listing across folders. + +`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, fetch metadata for each file. + +#### Returns + +ValueTask<IFileReference[]>
+ + The list under matching the . + +### **DeleteAsync(IStore, String)** + +Deletes the file. + +```csharp +public static Task DeleteAsync(IStore store, string path) +``` + +#### Parameters + +`store` [IStore](./proffer.storage.istore)
+The store. + +`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The file path. + +#### Returns + +[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ + A task that represents the asynchronous operation. + +### **GetAsync(IStore, String, Boolean)** + +Gets the file reference from path. + +```csharp +public static ValueTask GetAsync(IStore store, string path, bool withMetadata) +``` + +#### Parameters + +`store` [IStore](./proffer.storage.istore)
+The store. + +`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The file path. + +`withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+If set to true, fetch metadata for the file. + +#### Returns + +ValueTask<IFileReference>
+ + The at path. + +### **ReadAsync(IStore, String)** + +Reads the file content. + +```csharp +public static ValueTask ReadAsync(IStore store, string path) +``` + +#### Parameters + +`store` [IStore](./proffer.storage.istore)
+The store. + +`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The file path. + +#### Returns + +ValueTask<Stream>
+ + A containing the file content. + +### **ReadAllBytesAsync(IStore, String)** + +Reads the file content. + +```csharp +public static ValueTask ReadAllBytesAsync(IStore store, string path) +``` + +#### Parameters + +`store` [IStore](./proffer.storage.istore)
+The store. + +`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The file path. + +#### Returns + +ValueTask<Byte[]>
+ + A containing the file content. + +### **ReadAllTextAsync(IStore, String)** + +Reads the file content. + +```csharp +public static ValueTask ReadAllTextAsync(IStore store, string path) +``` + +#### Parameters + +`store` [IStore](./proffer.storage.istore)
+The store. + +`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The file path. + +#### Returns + +ValueTask<String>
+ + A containing the file content. + +### **SaveAsync(IStore, Byte[], String, String, OverwritePolicy, IDictionary<String, String>)** + +Saves the file. + +```csharp +public static ValueTask SaveAsync(IStore store, Byte[] data, string path, string contentType, OverwritePolicy overwritePolicy, IDictionary metadata) +``` + +#### Parameters + +`store` [IStore](./proffer.storage.istore)
+The store. + +`data` [Byte[]](https://docs.microsoft.com/en-us/dotnet/api/system.byte)
+The file content. + +`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The file path. + +`contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The content-type of the file. + +`overwritePolicy` [OverwritePolicy](./proffer.storage.overwritepolicy)
+The overwrite policy. + +`metadata` [IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
+The metadata. + +#### Returns + +ValueTask<IFileReference>
+ + The saved . + +#### Exceptions + +[FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception)
+ +### **SaveAsync(IStore, Stream, String, String, OverwritePolicy, IDictionary<String, String>)** + +Saves the file. + +```csharp +public static ValueTask SaveAsync(IStore store, Stream data, string path, string contentType, OverwritePolicy overwritePolicy, IDictionary metadata) +``` + +#### Parameters + +`store` [IStore](./proffer.storage.istore)
+The store. + +`data` [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream)
+The file content. + +`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The file path. + +`contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The content-type of the file. + +`overwritePolicy` [OverwritePolicy](./proffer.storage.overwritepolicy)
+The overwrite policy. + +`metadata` [IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
+The metadata. + +#### Returns + +ValueTask<IFileReference>
+ + The saved . + +#### Exceptions + +[FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception)
diff --git a/docs/storage/proffer.storage.overwritepolicy.md b/docs/storage/proffer.storage.overwritepolicy.md new file mode 100644 index 0000000..a68b80c --- /dev/null +++ b/docs/storage/proffer.storage.overwritepolicy.md @@ -0,0 +1,20 @@ +# OverwritePolicy + +Namespace: Proffer.Storage + +Defines an overwrite policy when saving a file to a store. + +```csharp +public enum OverwritePolicy +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ValueType](https://docs.microsoft.com/en-us/dotnet/api/system.valuetype) → [Enum](https://docs.microsoft.com/en-us/dotnet/api/system.enum) → [OverwritePolicy](./proffer.storage.overwritepolicy)
+Implements [IComparable](https://docs.microsoft.com/en-us/dotnet/api/system.icomparable), [IFormattable](https://docs.microsoft.com/en-us/dotnet/api/system.iformattable), [IConvertible](https://docs.microsoft.com/en-us/dotnet/api/system.iconvertible) + +## Fields + +| Name | Value | Description | +| --- | --: | --- | +| Always | 0 | Always overwrite. | +| IfContentModified | 1 | Overwrite only if the file content is modified. | +| Never | 2 | Never overwrite. | diff --git a/docs/storage/proffer.storage.sharedaccesspermissions.md b/docs/storage/proffer.storage.sharedaccesspermissions.md new file mode 100644 index 0000000..78eac58 --- /dev/null +++ b/docs/storage/proffer.storage.sharedaccesspermissions.md @@ -0,0 +1,24 @@ +# SharedAccessPermissions + +Namespace: Proffer.Storage + +Specifies the set of possible permissions for a shared access policy. + +```csharp +public enum SharedAccessPermissions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ValueType](https://docs.microsoft.com/en-us/dotnet/api/system.valuetype) → [Enum](https://docs.microsoft.com/en-us/dotnet/api/system.enum) → [SharedAccessPermissions](./proffer.storage.sharedaccesspermissions)
+Implements [IComparable](https://docs.microsoft.com/en-us/dotnet/api/system.icomparable), [IFormattable](https://docs.microsoft.com/en-us/dotnet/api/system.iformattable), [IConvertible](https://docs.microsoft.com/en-us/dotnet/api/system.iconvertible) + +## Fields + +| Name | Value | Description | +| --- | --: | --- | +| None | 0 | No shared access granted. | +| Read | 1 | Read access granted. | +| Write | 2 | Write access granted. | +| Delete | 4 | Delete access granted. | +| List | 8 | List access granted. | +| Add | 16 | Add access granted. | +| Create | 32 | Create access granted. | diff --git a/docs/storage/proffer.storage.sharedaccesspolicy.md b/docs/storage/proffer.storage.sharedaccesspolicy.md new file mode 100644 index 0000000..fd74e22 --- /dev/null +++ b/docs/storage/proffer.storage.sharedaccesspolicy.md @@ -0,0 +1,60 @@ +# SharedAccessPolicy + +Namespace: Proffer.Storage + +Represents a simple shared access policy, which specifies the start time, expiry time, and permissions for a shared access signature. + +```csharp +public class SharedAccessPolicy : ISharedAccessPolicy +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [SharedAccessPolicy](./proffer.storage.sharedaccesspolicy)
+Implements [ISharedAccessPolicy](./proffer.storage.isharedaccesspolicy) + +## Properties + +### **StartTime** + +Gets or sets the start time. + +```csharp +public Nullable StartTime { get; set; } +``` + +#### Property Value + +[Nullable<DateTimeOffset>](https://docs.microsoft.com/en-us/dotnet/api/system.nullable-1)
+ +### **ExpiryTime** + +Gets or sets the expiry time. + +```csharp +public Nullable ExpiryTime { get; set; } +``` + +#### Property Value + +[Nullable<DateTimeOffset>](https://docs.microsoft.com/en-us/dotnet/api/system.nullable-1)
+ +### **Permissions** + +Gets or sets the permissions. + +```csharp +public SharedAccessPermissions Permissions { get; set; } +``` + +#### Property Value + +[SharedAccessPermissions](./proffer.storage.sharedaccesspermissions)
+ +## Constructors + +### **SharedAccessPolicy()** + + + +```csharp +public SharedAccessPolicy() +``` diff --git a/docs/storage/proffer.storage.storageservicecollectionextensions.md b/docs/storage/proffer.storage.storageservicecollectionextensions.md new file mode 100644 index 0000000..1b4de1c --- /dev/null +++ b/docs/storage/proffer.storage.storageservicecollectionextensions.md @@ -0,0 +1,77 @@ +# StorageServiceCollectionExtensions + +Namespace: Proffer.Storage + +Microsoft.Extensions.DependencyInjection.IServiceCollection extension methods. + +```csharp +public static class StorageServiceCollectionExtensions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [StorageServiceCollectionExtensions](./proffer.storage.storageservicecollectionextensions) + +## Methods + +### **AddStorage(IServiceCollection)** + +Registers Proffer.Storage services. + +```csharp +public static IServiceCollection AddStorage(IServiceCollection services) +``` + +#### Parameters + +`services` IServiceCollection
+The service collection. + +#### Returns + +IServiceCollection
+The service collection. + +### **AddStorage(IServiceCollection, IConfigurationSection)** + +Registers Proffer.Storage services and configures it with the given section. + +```csharp +public static IServiceCollection AddStorage(IServiceCollection services, IConfigurationSection configurationSection) +``` + +#### Parameters + +`services` IServiceCollection
+The service collection. + +`configurationSection` IConfigurationSection
+The configuration section. + +#### Returns + +IServiceCollection
+The service collection. + +### **AddStorage(IServiceCollection, IConfigurationRoot, String)** + +Registers Proffer.Storage services and configures it from the given at section . + +```csharp +public static IServiceCollection AddStorage(IServiceCollection services, IConfigurationRoot configurationRoot, string sectionName) +``` + +#### Parameters + +`services` IServiceCollection
+The service collection. + +`configurationRoot` IConfigurationRoot
+The configuration root. + +`sectionName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the section. + +#### Returns + +IServiceCollection
+ + The service collection. diff --git a/docs/storage/proffer.storage.storebase.md b/docs/storage/proffer.storage.storebase.md new file mode 100644 index 0000000..4d299ef --- /dev/null +++ b/docs/storage/proffer.storage.storebase.md @@ -0,0 +1,43 @@ +# StoreBase + +Namespace: Proffer.Storage + +Abstract base typed store. + +```csharp +public abstract class StoreBase +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [StoreBase](./proffer.storage.storebase) + +## Properties + +### **Store** + +Gets the store. + +```csharp +public IStore Store { get; } +``` + +#### Property Value + +[IStore](./proffer.storage.istore)
+ +## Constructors + +### **StoreBase(String, IStorageFactory)** + +Initializes a new instance of the [StoreBase](./proffer.storage.storebase) class. + +```csharp +public StoreBase(string storeName, IStorageFactory storageFactory) +``` + +#### Parameters + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the store. + +`storageFactory` [IStorageFactory](./proffer.storage.istoragefactory)
+The storage factory. diff --git a/docs/templating/api.md b/docs/templating/api.md new file mode 100644 index 0000000..028a4b4 --- /dev/null +++ b/docs/templating/api.md @@ -0,0 +1,33 @@ +# Proffer.Templating + +## Proffer.Templating + +[InvalidContextException](./proffer.templating.invalidcontextexception) + +[ITemplate](./proffer.templating.itemplate) + +[ITemplateLoader](./proffer.templating.itemplateloader) + +[ITemplateLoaderFactory](./proffer.templating.itemplateloaderfactory) + +[ITemplateProvider](./proffer.templating.itemplateprovider) + +[ITemplateProviderScope](./proffer.templating.itemplateproviderscope) + +[TemplateCollectionBase](./proffer.templating.templatecollectionbase) + +[TemplateCollectionBase<TStore>](./proffer.templating.templatecollectionbase-1) + +[TemplatingServiceCollectionExtensions](./proffer.templating.templatingservicecollectionextensions) + +## Proffer.Templating.Exceptions + +[ProviderNotFoundException](./proffer.templating.exceptions.providernotfoundexception) + +[TemplateNotFoundException](./proffer.templating.exceptions.templatenotfoundexception) + +## Proffer.Templating.Internal + +[TemplateLoader](./proffer.templating.internal.templateloader) + +[TemplateLoaderFactory](./proffer.templating.internal.templateloaderfactory) diff --git a/docs/templating/handlebars/api.md b/docs/templating/handlebars/api.md new file mode 100644 index 0000000..88b5fa0 --- /dev/null +++ b/docs/templating/handlebars/api.md @@ -0,0 +1,11 @@ +# Proffer.Templating.Handlebars + +## Proffer.Templating + +[HandlebarsServiceCollectionExtensions](./proffer.templating.handlebarsservicecollectionextensions) + +## Proffer.Templating.Handlebars + +[HandlebarsTemplate](./proffer.templating.handlebars.handlebarstemplate) + +[HandlebarsTemplateProvider](./proffer.templating.handlebars.handlebarstemplateprovider) diff --git a/docs/templating/handlebars/proffer.templating.handlebars.handlebarstemplate.md b/docs/templating/handlebars/proffer.templating.handlebars.handlebarstemplate.md new file mode 100644 index 0000000..eb6c540 --- /dev/null +++ b/docs/templating/handlebars/proffer.templating.handlebars.handlebarstemplate.md @@ -0,0 +1,86 @@ +# HandlebarsTemplate + +Namespace: Proffer.Templating.Handlebars + +A template reference can be executed on a specific context using N:HandlebarsDotNet. + +```csharp +public class HandlebarsTemplate : Proffer.Templating.ITemplate +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [HandlebarsTemplate](./proffer.templating.handlebars.handlebarstemplate)
+Implements ITemplate + +## Constructors + +### **HandlebarsTemplate(String)** + +Initializes a new instance of the [HandlebarsTemplate](./proffer.templating.handlebars.handlebarstemplate) class. + +```csharp +public HandlebarsTemplate(string templateContent) +``` + +#### Parameters + +`templateContent` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+Content of the template. + +### **HandlebarsTemplate(IHandlebars, String)** + +Initializes a new instance of the [HandlebarsTemplate](./proffer.templating.handlebars.handlebarstemplate) class. + +```csharp +public HandlebarsTemplate(IHandlebars handlebars, string templateContent) +``` + +#### Parameters + +`handlebars` IHandlebars
+The Handlebars service. + +`templateContent` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+Content of the template. + +## Methods + +### **Apply(Object)** + +Applies the specified context on the template. + +```csharp +public string Apply(object context) +``` + +#### Parameters + +`context` [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)
+The context. + +#### Returns + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ + The templated result. + +### **Apply(Object, IFormatProvider)** + +Applies the specified context on the template with format provider. + +```csharp +public string Apply(object context, IFormatProvider formatProvider) +``` + +#### Parameters + +`context` [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)
+The context. + +`formatProvider` [IFormatProvider](https://docs.microsoft.com/en-us/dotnet/api/system.iformatprovider)
+The format provider. + +#### Returns + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ + The templated result. diff --git a/docs/templating/handlebars/proffer.templating.handlebars.handlebarstemplateprovider.md b/docs/templating/handlebars/proffer.templating.handlebars.handlebarstemplateprovider.md new file mode 100644 index 0000000..8447132 --- /dev/null +++ b/docs/templating/handlebars/proffer.templating.handlebars.handlebarstemplateprovider.md @@ -0,0 +1,82 @@ +# HandlebarsTemplateProvider + +Namespace: Proffer.Templating.Handlebars + +A provider handles and compiles templates using N:HandlebarsDotNet. + +```csharp +public class HandlebarsTemplateProvider : Proffer.Templating.ITemplateProvider +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [HandlebarsTemplateProvider](./proffer.templating.handlebars.handlebarstemplateprovider)
+Implements ITemplateProvider + +## Properties + +### **MimeTypes** + +Gets the MIME types. + +```csharp +public ISet MimeTypes { get; } +``` + +#### Property Value + +[ISet<String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.iset-1)
+ +### **Extensions** + +Gets the extensions. + +```csharp +public ISet Extensions { get; } +``` + +#### Property Value + +[ISet<String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.iset-1)
+ +## Constructors + +### **HandlebarsTemplateProvider()** + +Initializes a new instance of the [HandlebarsTemplateProvider](./proffer.templating.handlebars.handlebarstemplateprovider) class. + +```csharp +public HandlebarsTemplateProvider() +``` + +## Methods + +### **Compile(String)** + +Compiles the specified template content. + +```csharp +public ITemplate Compile(string templateContent) +``` + +#### Parameters + +`templateContent` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+Content of the template. + +#### Returns + +ITemplate
+A compiled . + +### **CreateScope()** + +Creates a template provider scope. + +```csharp +public ITemplateProviderScope CreateScope() +``` + +#### Returns + +ITemplateProviderScope
+ + A new templating provider scope. diff --git a/docs/templating/handlebars/proffer.templating.handlebarsservicecollectionextensions.md b/docs/templating/handlebars/proffer.templating.handlebarsservicecollectionextensions.md new file mode 100644 index 0000000..4e5e4ba --- /dev/null +++ b/docs/templating/handlebars/proffer.templating.handlebarsservicecollectionextensions.md @@ -0,0 +1,31 @@ +# HandlebarsServiceCollectionExtensions + +Namespace: Proffer.Templating + +Microsoft.Extensions.DependencyInjection.IServiceCollection extension methods. + +```csharp +public static class HandlebarsServiceCollectionExtensions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [HandlebarsServiceCollectionExtensions](./proffer.templating.handlebarsservicecollectionextensions) + +## Methods + +### **AddHandlebars(IServiceCollection)** + +Registers the Proffer.Templating services to use N:HandlebarsDotNet. + +```csharp +public static IServiceCollection AddHandlebars(IServiceCollection services) +``` + +#### Parameters + +`services` IServiceCollection
+The service collection. + +#### Returns + +IServiceCollection
+The service collection. diff --git a/docs/templating/mustache/api.md b/docs/templating/mustache/api.md new file mode 100644 index 0000000..deac3e4 --- /dev/null +++ b/docs/templating/mustache/api.md @@ -0,0 +1,11 @@ +# Proffer.Templating.Mustache + +## Proffer.Templating + +[MustacheServiceCollectionExtensions](./proffer.templating.mustacheservicecollectionextensions) + +## Proffer.Templating.Mustache + +[MustacheTemplate](./proffer.templating.mustache.mustachetemplate) + +[MustacheTemplateProvider](./proffer.templating.mustache.mustachetemplateprovider) diff --git a/docs/templating/mustache/proffer.templating.mustache.mustachetemplate.md b/docs/templating/mustache/proffer.templating.mustache.mustachetemplate.md new file mode 100644 index 0000000..dfab2b8 --- /dev/null +++ b/docs/templating/mustache/proffer.templating.mustache.mustachetemplate.md @@ -0,0 +1,78 @@ +# MustacheTemplate + +Namespace: Proffer.Templating.Mustache + +A template reference can be executed on a specific context using N:Mustache. + +```csharp +public class MustacheTemplate : Proffer.Templating.ITemplate +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [MustacheTemplate](./proffer.templating.mustache.mustachetemplate)
+Implements ITemplate + +## Constructors + +### **MustacheTemplate(String)** + +Initializes a new instance of the [MustacheTemplate](./proffer.templating.mustache.mustachetemplate) class. + +```csharp +public MustacheTemplate(string templateContent) +``` + +#### Parameters + +`templateContent` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+Content of the template. + +## Methods + +### **Apply(Object)** + +Applies the specified context on the template. + +```csharp +public string Apply(object context) +``` + +#### Parameters + +`context` [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)
+The context. + +#### Returns + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ + The templated result. + +#### Exceptions + +Proffer.Templating.InvalidContextException
+ +### **Apply(Object, IFormatProvider)** + +Applies the specified context on the template with format provider. + +```csharp +public string Apply(object context, IFormatProvider formatProvider) +``` + +#### Parameters + +`context` [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)
+The context. + +`formatProvider` [IFormatProvider](https://docs.microsoft.com/en-us/dotnet/api/system.iformatprovider)
+The format provider. + +#### Returns + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ + The templated result. + +#### Exceptions + +Proffer.Templating.InvalidContextException
diff --git a/docs/templating/mustache/proffer.templating.mustache.mustachetemplateprovider.md b/docs/templating/mustache/proffer.templating.mustache.mustachetemplateprovider.md new file mode 100644 index 0000000..dc24e61 --- /dev/null +++ b/docs/templating/mustache/proffer.templating.mustache.mustachetemplateprovider.md @@ -0,0 +1,103 @@ +# MustacheTemplateProvider + +Namespace: Proffer.Templating.Mustache + +A provider handles and compiles templates using N:Mustache. + +```csharp +public class MustacheTemplateProvider : Proffer.Templating.ITemplateProvider, Proffer.Templating.ITemplateProviderScope +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [MustacheTemplateProvider](./proffer.templating.mustache.mustachetemplateprovider)
+Implements ITemplateProvider, ITemplateProviderScope + +## Properties + +### **MimeTypes** + +Gets the MIME types. + +```csharp +public ISet MimeTypes { get; } +``` + +#### Property Value + +[ISet<String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.iset-1)
+ +### **Extensions** + +Gets the extensions. + +```csharp +public ISet Extensions { get; } +``` + +#### Property Value + +[ISet<String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.iset-1)
+ +## Constructors + +### **MustacheTemplateProvider()** + +Initializes a new instance of the [MustacheTemplateProvider](./proffer.templating.mustache.mustachetemplateprovider) class. + +```csharp +public MustacheTemplateProvider() +``` + +## Methods + +### **Compile(String)** + +Compiles the specified template content. + +```csharp +public ITemplate Compile(string templateContent) +``` + +#### Parameters + +`templateContent` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+Content of the template. + +#### Returns + +ITemplate
+ + A new compiled from the content. + +### **CreateScope()** + +Creates a template provider scope. + +```csharp +public ITemplateProviderScope CreateScope() +``` + +#### Returns + +ITemplateProviderScope
+ + A new templating provider scope. + +### **RegisterPartial(String, String)** + +Registers a partial template with a name. + +```csharp +public void RegisterPartial(string name, string template) +``` + +#### Parameters + +`name` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name. + +`template` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The template. + +#### Exceptions + +[NotSupportedException](https://docs.microsoft.com/en-us/dotnet/api/system.notsupportedexception)
diff --git a/docs/templating/mustache/proffer.templating.mustacheservicecollectionextensions.md b/docs/templating/mustache/proffer.templating.mustacheservicecollectionextensions.md new file mode 100644 index 0000000..e6abe28 --- /dev/null +++ b/docs/templating/mustache/proffer.templating.mustacheservicecollectionextensions.md @@ -0,0 +1,31 @@ +# MustacheServiceCollectionExtensions + +Namespace: Proffer.Templating + +Microsoft.Extensions.DependencyInjection.IServiceCollection extension methods. + +```csharp +public static class MustacheServiceCollectionExtensions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [MustacheServiceCollectionExtensions](./proffer.templating.mustacheservicecollectionextensions) + +## Methods + +### **AddMustache(IServiceCollection)** + +Registers the Proffer.Templating services to use N:Mustache. + +```csharp +public static IServiceCollection AddMustache(IServiceCollection services) +``` + +#### Parameters + +`services` IServiceCollection
+The service collection. + +#### Returns + +IServiceCollection
+The service collection. diff --git a/docs/templating/proffer.templating.exceptions.providernotfoundexception.md b/docs/templating/proffer.templating.exceptions.providernotfoundexception.md new file mode 100644 index 0000000..11ba9e3 --- /dev/null +++ b/docs/templating/proffer.templating.exceptions.providernotfoundexception.md @@ -0,0 +1,131 @@ +# ProviderNotFoundException + +Namespace: Proffer.Templating.Exceptions + +Thrown when a matching provider was not found for a given template. + +```csharp +public class ProviderNotFoundException : System.Exception, System.Runtime.Serialization.ISerializable +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [ProviderNotFoundException](./proffer.templating.exceptions.providernotfoundexception)
+Implements [ISerializable](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.serialization.iserializable) + +## Properties + +### **TargetSite** + + + +```csharp +public MethodBase TargetSite { get; } +``` + +#### Property Value + +[MethodBase](https://docs.microsoft.com/en-us/dotnet/api/system.reflection.methodbase)
+ +### **StackTrace** + + + +```csharp +public string StackTrace { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Message** + + + +```csharp +public string Message { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Data** + + + +```csharp +public IDictionary Data { get; } +``` + +#### Property Value + +[IDictionary](https://docs.microsoft.com/en-us/dotnet/api/system.collections.idictionary)
+ +### **InnerException** + + + +```csharp +public Exception InnerException { get; } +``` + +#### Property Value + +[Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception)
+ +### **HelpLink** + + + +```csharp +public string HelpLink { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Source** + + + +```csharp +public string Source { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **HResult** + + + +```csharp +public int HResult { get; set; } +``` + +#### Property Value + +[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
+ +## Constructors + +### **ProviderNotFoundException(String, String, String)** + +Initializes a new instance of the [ProviderNotFoundException](./proffer.templating.exceptions.providernotfoundexception) class. + +```csharp +public ProviderNotFoundException(string templateName, string extension, string contentType) +``` + +#### Parameters + +`templateName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the unmatched template. + +`extension` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The extension of the unmatched template. + +`contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The MIME type of the unmatched template. diff --git a/docs/templating/proffer.templating.exceptions.templatenotfoundexception.md b/docs/templating/proffer.templating.exceptions.templatenotfoundexception.md new file mode 100644 index 0000000..4ffffe5 --- /dev/null +++ b/docs/templating/proffer.templating.exceptions.templatenotfoundexception.md @@ -0,0 +1,125 @@ +# TemplateNotFoundException + +Namespace: Proffer.Templating.Exceptions + +Thrown when a template was not found in the store. + +```csharp +public class TemplateNotFoundException : System.Exception, System.Runtime.Serialization.ISerializable +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [TemplateNotFoundException](./proffer.templating.exceptions.templatenotfoundexception)
+Implements [ISerializable](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.serialization.iserializable) + +## Properties + +### **TargetSite** + + + +```csharp +public MethodBase TargetSite { get; } +``` + +#### Property Value + +[MethodBase](https://docs.microsoft.com/en-us/dotnet/api/system.reflection.methodbase)
+ +### **StackTrace** + + + +```csharp +public string StackTrace { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Message** + + + +```csharp +public string Message { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Data** + + + +```csharp +public IDictionary Data { get; } +``` + +#### Property Value + +[IDictionary](https://docs.microsoft.com/en-us/dotnet/api/system.collections.idictionary)
+ +### **InnerException** + + + +```csharp +public Exception InnerException { get; } +``` + +#### Property Value + +[Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception)
+ +### **HelpLink** + + + +```csharp +public string HelpLink { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Source** + + + +```csharp +public string Source { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **HResult** + + + +```csharp +public int HResult { get; set; } +``` + +#### Property Value + +[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
+ +## Constructors + +### **TemplateNotFoundException(String)** + +Initializes a new instance of the [TemplateNotFoundException](./proffer.templating.exceptions.templatenotfoundexception) class. + +```csharp +public TemplateNotFoundException(string templateName) +``` + +#### Parameters + +`templateName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the missing template. diff --git a/docs/templating/proffer.templating.internal.templateloader.md b/docs/templating/proffer.templating.internal.templateloader.md new file mode 100644 index 0000000..fb9230b --- /dev/null +++ b/docs/templating/proffer.templating.internal.templateloader.md @@ -0,0 +1,54 @@ +# TemplateLoader + +Namespace: Proffer.Templating.Internal + +Loads template references from an Proffer.Storage.IStore and cache results. + +```csharp +public class TemplateLoader : Proffer.Templating.ITemplateLoader +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [TemplateLoader](./proffer.templating.internal.templateloader)
+Implements [ITemplateLoader](./proffer.templating.itemplateloader) + +## Constructors + +### **TemplateLoader(IStore, IEnumerable<ITemplateProvider>, IMemoryCache)** + +Initializes a new instance of the [TemplateLoader](./proffer.templating.internal.templateloader) class. + +```csharp +public TemplateLoader(IStore store, IEnumerable providers, IMemoryCache memoryCache) +``` + +#### Parameters + +`store` IStore
+The store. + +`providers` [IEnumerable<ITemplateProvider>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The providers. + +`memoryCache` IMemoryCache
+The memory cache. + +## Methods + +### **GetTemplate(String)** + +Gets a template by name. + +```csharp +public Task GetTemplate(string name) +``` + +#### Parameters + +`name` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The template name. + +#### Returns + +[Task<ITemplate>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)
+ + The matching . diff --git a/docs/templating/proffer.templating.internal.templateloaderfactory.md b/docs/templating/proffer.templating.internal.templateloaderfactory.md new file mode 100644 index 0000000..3232679 --- /dev/null +++ b/docs/templating/proffer.templating.internal.templateloaderfactory.md @@ -0,0 +1,73 @@ +# TemplateLoaderFactory + +Namespace: Proffer.Templating.Internal + +Creates [ITemplateLoader](./proffer.templating.itemplateloader) from Proffer.Storage.IStore. + +```csharp +public class TemplateLoaderFactory : Proffer.Templating.ITemplateLoaderFactory +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [TemplateLoaderFactory](./proffer.templating.internal.templateloaderfactory)
+Implements [ITemplateLoaderFactory](./proffer.templating.itemplateloaderfactory) + +## Constructors + +### **TemplateLoaderFactory(IEnumerable<ITemplateProvider>, IMemoryCache)** + +Initializes a new instance of the [TemplateLoaderFactory](./proffer.templating.internal.templateloaderfactory) class. + +```csharp +public TemplateLoaderFactory(IEnumerable providers, IMemoryCache memoryCache) +``` + +#### Parameters + +`providers` [IEnumerable<ITemplateProvider>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
+The providers. + +`memoryCache` IMemoryCache
+The memory cache. + +## Methods + +### **Create(IStore)** + +Creates a template loader from the specified store. + +```csharp +public ITemplateLoader Create(IStore store) +``` + +#### Parameters + +`store` IStore
+The store. + +#### Returns + +[ITemplateLoader](./proffer.templating.itemplateloader)
+ + A that loads templates from the given . + +### **Create(IStore, String)** + +Creates a template loader from the specified store with the specified cache scope. + +```csharp +public ITemplateLoader Create(IStore store, string scope) +``` + +#### Parameters + +`store` IStore
+The store. + +`scope` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The scope. + +#### Returns + +[ITemplateLoader](./proffer.templating.itemplateloader)
+ + A that loads templates from the given . diff --git a/docs/templating/proffer.templating.invalidcontextexception.md b/docs/templating/proffer.templating.invalidcontextexception.md new file mode 100644 index 0000000..c272aec --- /dev/null +++ b/docs/templating/proffer.templating.invalidcontextexception.md @@ -0,0 +1,125 @@ +# InvalidContextException + +Namespace: Proffer.Templating + +Thrown when the generation context is invalid for a template. + +```csharp +public class InvalidContextException : System.Exception, System.Runtime.Serialization.ISerializable +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [InvalidContextException](./proffer.templating.invalidcontextexception)
+Implements [ISerializable](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.serialization.iserializable) + +## Properties + +### **TargetSite** + + + +```csharp +public MethodBase TargetSite { get; } +``` + +#### Property Value + +[MethodBase](https://docs.microsoft.com/en-us/dotnet/api/system.reflection.methodbase)
+ +### **StackTrace** + + + +```csharp +public string StackTrace { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Message** + + + +```csharp +public string Message { get; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Data** + + + +```csharp +public IDictionary Data { get; } +``` + +#### Property Value + +[IDictionary](https://docs.microsoft.com/en-us/dotnet/api/system.collections.idictionary)
+ +### **InnerException** + + + +```csharp +public Exception InnerException { get; } +``` + +#### Property Value + +[Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception)
+ +### **HelpLink** + + + +```csharp +public string HelpLink { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **Source** + + + +```csharp +public string Source { get; set; } +``` + +#### Property Value + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ +### **HResult** + + + +```csharp +public int HResult { get; set; } +``` + +#### Property Value + +[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
+ +## Constructors + +### **InvalidContextException(Exception)** + +Initializes a new instance of the [InvalidContextException](./proffer.templating.invalidcontextexception) class. + +```csharp +public InvalidContextException(Exception innerException) +``` + +#### Parameters + +`innerException` [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception)
+The inner exception. diff --git a/docs/templating/proffer.templating.itemplate.md b/docs/templating/proffer.templating.itemplate.md new file mode 100644 index 0000000..52e80c2 --- /dev/null +++ b/docs/templating/proffer.templating.itemplate.md @@ -0,0 +1,59 @@ +# ITemplate + +Namespace: Proffer.Templating + +A template reference can be executed on a specific context using an Apply method. + +```csharp +public interface ITemplate +``` + +## Methods + +### **Apply(Object)** + +Applies the specified context on the template. + +```csharp +string Apply(object context) +``` + +#### Parameters + +`context` [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)
+The context. + +#### Returns + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The templated result. + +#### Exceptions + +[InvalidContextException](./proffer.templating.invalidcontextexception)
+ +### **Apply(Object, IFormatProvider)** + +Applies the specified context on the template with format provider. + +```csharp +string Apply(object context, IFormatProvider formatProvider) +``` + +#### Parameters + +`context` [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)
+The context. + +`formatProvider` [IFormatProvider](https://docs.microsoft.com/en-us/dotnet/api/system.iformatprovider)
+The format provider. + +#### Returns + +[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ + The templated result. + +#### Exceptions + +[InvalidContextException](./proffer.templating.invalidcontextexception)
diff --git a/docs/templating/proffer.templating.itemplateloader.md b/docs/templating/proffer.templating.itemplateloader.md new file mode 100644 index 0000000..34671a4 --- /dev/null +++ b/docs/templating/proffer.templating.itemplateloader.md @@ -0,0 +1,29 @@ +# ITemplateLoader + +Namespace: Proffer.Templating + +Loads template references. + +```csharp +public interface ITemplateLoader +``` + +## Methods + +### **GetTemplate(String)** + +Gets a template by name. + +```csharp +Task GetTemplate(string name) +``` + +#### Parameters + +`name` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The template name. + +#### Returns + +[Task<ITemplate>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)
+The matching . diff --git a/docs/templating/proffer.templating.itemplateloaderfactory.md b/docs/templating/proffer.templating.itemplateloaderfactory.md new file mode 100644 index 0000000..8a50631 --- /dev/null +++ b/docs/templating/proffer.templating.itemplateloaderfactory.md @@ -0,0 +1,50 @@ +# ITemplateLoaderFactory + +Namespace: Proffer.Templating + +Creates [ITemplateLoader](./proffer.templating.itemplateloader) from Proffer.Storage.IStore. + +```csharp +public interface ITemplateLoaderFactory +``` + +## Methods + +### **Create(IStore)** + +Creates a template loader from the specified store. + +```csharp +ITemplateLoader Create(IStore store) +``` + +#### Parameters + +`store` IStore
+The store. + +#### Returns + +[ITemplateLoader](./proffer.templating.itemplateloader)
+A that loads templates from the given . + +### **Create(IStore, String)** + +Creates a template loader from the specified store with the specified cache scope. + +```csharp +ITemplateLoader Create(IStore store, string scope) +``` + +#### Parameters + +`store` IStore
+The store. + +`scope` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The cache scope. + +#### Returns + +[ITemplateLoader](./proffer.templating.itemplateloader)
+A that loads templates from the given . diff --git a/docs/templating/proffer.templating.itemplateprovider.md b/docs/templating/proffer.templating.itemplateprovider.md new file mode 100644 index 0000000..2bb75c1 --- /dev/null +++ b/docs/templating/proffer.templating.itemplateprovider.md @@ -0,0 +1,50 @@ +# ITemplateProvider + +Namespace: Proffer.Templating + +A provider handles and compiles templates using a particular templating library. + +```csharp +public interface ITemplateProvider +``` + +## Properties + +### **MimeTypes** + +Gets the MIME types. + +```csharp +public abstract ISet MimeTypes { get; } +``` + +#### Property Value + +[ISet<String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.iset-1)
+ +### **Extensions** + +Gets the extensions. + +```csharp +public abstract ISet Extensions { get; } +``` + +#### Property Value + +[ISet<String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.iset-1)
+ +## Methods + +### **CreateScope()** + +Creates a template provider scope. + +```csharp +ITemplateProviderScope CreateScope() +``` + +#### Returns + +[ITemplateProviderScope](./proffer.templating.itemplateproviderscope)
+A new templating provider scope. diff --git a/docs/templating/proffer.templating.itemplateproviderscope.md b/docs/templating/proffer.templating.itemplateproviderscope.md new file mode 100644 index 0000000..306c2d1 --- /dev/null +++ b/docs/templating/proffer.templating.itemplateproviderscope.md @@ -0,0 +1,49 @@ +# ITemplateProviderScope + +Namespace: Proffer.Templating + +Templating scope for a configured provider. + +```csharp +public interface ITemplateProviderScope +``` + +## Methods + +### **Compile(String)** + +Compiles the specified template content. + +```csharp +ITemplate Compile(string templateContent) +``` + +#### Parameters + +`templateContent` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+Content of the template. + +#### Returns + +[ITemplate](./proffer.templating.itemplate)
+A new compiled from the content. + +### **RegisterPartial(String, String)** + +Registers a partial template with a name. + +```csharp +void RegisterPartial(string name, string template) +``` + +#### Parameters + +`name` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name. + +`template` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The template. + +#### Exceptions + +[NotSupportedException](https://docs.microsoft.com/en-us/dotnet/api/system.notsupportedexception)
diff --git a/docs/templating/proffer.templating.templatecollectionbase-1.md b/docs/templating/proffer.templating.templatecollectionbase-1.md new file mode 100644 index 0000000..d8b0d0b --- /dev/null +++ b/docs/templating/proffer.templating.templatecollectionbase-1.md @@ -0,0 +1,48 @@ +# TemplateCollectionBase<TStore> + +Namespace: Proffer.Templating + +Abstract base class to load and apply templates from a typed . + +```csharp +public abstract class TemplateCollectionBase : TemplateCollectionBase +``` + +#### Type Parameters + +`TStore`
+The type of the store. + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [TemplateCollectionBase](./proffer.templating.templatecollectionbase) → [TemplateCollectionBase<TStore>](./proffer.templating.templatecollectionbase-1) + +## Properties + +### **Loader** + +Gets the templates loader. + +```csharp +public ITemplateLoader Loader { get; } +``` + +#### Property Value + +[ITemplateLoader](./proffer.templating.itemplateloader)
+ +## Constructors + +### **TemplateCollectionBase(TStore, ITemplateLoaderFactory)** + +Initializes a new instance of the [TemplateCollectionBase<TStore>](./proffer.templating.templatecollectionbase-1) class. + +```csharp +public TemplateCollectionBase(TStore store, ITemplateLoaderFactory templateLoaderFactory) +``` + +#### Parameters + +`store` TStore
+The typed store. + +`templateLoaderFactory` [ITemplateLoaderFactory](./proffer.templating.itemplateloaderfactory)
+The template loader factory. diff --git a/docs/templating/proffer.templating.templatecollectionbase.md b/docs/templating/proffer.templating.templatecollectionbase.md new file mode 100644 index 0000000..8dd1cc1 --- /dev/null +++ b/docs/templating/proffer.templating.templatecollectionbase.md @@ -0,0 +1,94 @@ +# TemplateCollectionBase + +Namespace: Proffer.Templating + +Abstract base class to load and apply templates from a named Proffer.Storage.IStore. + +```csharp +public abstract class TemplateCollectionBase +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [TemplateCollectionBase](./proffer.templating.templatecollectionbase) + +## Properties + +### **Loader** + +Gets the templates loader. + +```csharp +public ITemplateLoader Loader { get; } +``` + +#### Property Value + +[ITemplateLoader](./proffer.templating.itemplateloader)
+ +## Constructors + +### **TemplateCollectionBase(String, IStorageFactory, ITemplateLoaderFactory)** + +Initializes a new instance of the [TemplateCollectionBase](./proffer.templating.templatecollectionbase) class. + +```csharp +public TemplateCollectionBase(string storeName, IStorageFactory storageFactory, ITemplateLoaderFactory templateLoaderFactory) +``` + +#### Parameters + +`storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The name of the store. + +`storageFactory` IStorageFactory
+The storage factory. + +`templateLoaderFactory` [ITemplateLoaderFactory](./proffer.templating.itemplateloaderfactory)
+The template loader factory. + +## Methods + +### **LoadAndApplyTemplate(String, Object)** + +Loads the template and applies context. + +```csharp +protected Task LoadAndApplyTemplate(string templatePath, object context) +``` + +#### Parameters + +`templatePath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The template path. + +`context` [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)
+The context. + +#### Returns + +[Task<String>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)
+The templated result. + +### **LoadAndApplyTemplate(String, Object, IFormatProvider)** + +Loads the template and applies context. + +```csharp +protected Task LoadAndApplyTemplate(string templatePath, object context, IFormatProvider formatProvider) +``` + +#### Parameters + +`templatePath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+The template path. + +`context` [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)
+The context. + +`formatProvider` [IFormatProvider](https://docs.microsoft.com/en-us/dotnet/api/system.iformatprovider)
+The format provider. + +#### Returns + +[Task<String>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)
+ + The templated result. diff --git a/docs/templating/proffer.templating.templatingservicecollectionextensions.md b/docs/templating/proffer.templating.templatingservicecollectionextensions.md new file mode 100644 index 0000000..13d4662 --- /dev/null +++ b/docs/templating/proffer.templating.templatingservicecollectionextensions.md @@ -0,0 +1,31 @@ +# TemplatingServiceCollectionExtensions + +Namespace: Proffer.Templating + +Microsoft.Extensions.DependencyInjection.IServiceCollection extension methods. + +```csharp +public static class TemplatingServiceCollectionExtensions +``` + +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [TemplatingServiceCollectionExtensions](./proffer.templating.templatingservicecollectionextensions) + +## Methods + +### **AddTemplating(IServiceCollection)** + +Registers Proffer.Templating services. + +```csharp +public static IServiceCollection AddTemplating(IServiceCollection services) +``` + +#### Parameters + +`services` IServiceCollection
+The service collection. + +#### Returns + +IServiceCollection
+The service collection. diff --git a/src/Directory.Build.targets b/src/Directory.Build.targets index da70410..85d7d67 100644 --- a/src/Directory.Build.targets +++ b/src/Directory.Build.targets @@ -1,6 +1,6 @@ - + \ No newline at end of file From 324895210ee99179c3dd17959a71ba103d32f4bd Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Sat, 22 May 2021 00:57:14 +0200 Subject: [PATCH 26/45] Move again --- docs/_layouts/default.html | 2 +- docs/api.md | 37 +++++++++++++++++++ docs/code/index.md | 37 ------------------- docs/core/{api.md => api/index.md} | 0 ...ffer.configuration.inamedelementoptions.md | 0 .../proffer.configuration.ioptionerror.md | 0 .../proffer.configuration.iprovideroptions.md | 0 .../proffer.configuration.optionerror.md | 0 .../proffer.configuration.provideroptions.md | 0 .../proffer.equalitycomparerbase-1.md | 0 docs/core/azure/{api.md => api/index.md} | 0 ...zure.configuration.iazurestorageoptions.md | 0 docs/email/{api.md => api/index.md} | 0 .../{ => api}/proffer.email.emailoptions.md | 0 .../proffer.email.emailprovideroptions.md | 0 ....email.emailservicecollectionextensions.md | 0 .../proffer.email.emailtemplatetype.md | 0 .../{ => api}/proffer.email.iemailaddress.md | 0 .../proffer.email.iemailattachment.md | 0 .../{ => api}/proffer.email.iemailprovider.md | 0 .../proffer.email.iemailprovideroptions.md | 0 .../proffer.email.iemailprovidertype.md | 0 .../{ => api}/proffer.email.iemailsender.md | 0 .../proffer.email.internal.emailaddress.md | 0 ...l.internal.emailaddressequalitycomparer.md | 0 ...rnal.emailaddressstrictequalitycomparer.md | 0 .../proffer.email.internal.emailattachment.md | 0 ...nternal.emailattachmentequalitycomparer.md | 0 .../proffer.email.internal.emailsender.md | 0 .../proffer.email.mockupexceptionsoptions.md | 0 .../{ => api}/proffer.email.mockupoptions.md | 0 docs/email/in-memory/{api.md => api/index.md} | 0 ...email.inmemory.iinmemoryemailrepository.md | 0 .../proffer.email.inmemory.inmemoryemail.md | 0 ...er.email.inmemory.inmemoryemailprovider.md | 0 ...mail.inmemory.inmemoryemailprovidertype.md | 0 ....email.inmemory.inmemoryemailrepository.md | 0 ...nmemoryemailservicecollectionextensions.md | 0 docs/email/sendgrid/{api.md => api/index.md} | 0 ...er.email.sendgrid.sendgridemailprovider.md | 0 ...mail.sendgrid.sendgridemailprovidertype.md | 0 ...offer.email.servicecollectionextensions.md | 0 docs/email/smtp/{api.md => api/index.md} | 0 .../proffer.email.smtp.smtpemailprovider.md | 0 ...roffer.email.smtp.smtpemailprovidertype.md | 0 ...il.smtpemailservicecollectionextensions.md | 0 docs/index.md | 3 ++ docs/storage/{api.md => api/index.md} | 0 ...offer.storage.configuration.accesslevel.md | 0 ...e.configuration.configurationextensions.md | 0 ....storage.configuration.iparsedoptions-3.md | 0 ...orage.configuration.iscopedstoreoptions.md | 0 ...fer.storage.configuration.istoreoptions.md | 0 ...torage.configuration.scopedstoreoptions.md | 0 ...er.storage.configuration.storageoptions.md | 0 ...ffer.storage.configuration.storeoptions.md | 0 ...age.exceptions.badproviderconfiguration.md | 0 ....exceptions.badscopedstoreconfiguration.md | 0 ...torage.exceptions.badstoreconfiguration.md | 0 ...e.exceptions.filealreadyexistsexception.md | 0 ...ge.exceptions.providernotfoundexception.md | 0 ...orage.exceptions.storenotfoundexception.md | 0 .../proffer.storage.ifileproperties.md | 0 .../proffer.storage.ifilereference.md | 0 ...age.internal.configureprovideroptions-4.md | 0 ...er.storage.internal.genericstoreproxy-1.md | 0 ...r.storage.internal.privatefilereference.md | 0 ...proffer.storage.internal.storagefactory.md | 0 ....storage.internal.storageproviderbase-4.md | 0 .../proffer.storage.iprivatefilereference.md | 0 .../proffer.storage.isharedaccesspolicy.md | 0 .../proffer.storage.istoragefactory.md | 0 .../proffer.storage.istorageprovider.md | 0 .../{ => api}/proffer.storage.istore-1.md | 0 .../{ => api}/proffer.storage.istore.md | 0 .../proffer.storage.istoreextensions.md | 0 .../proffer.storage.overwritepolicy.md | 0 ...proffer.storage.sharedaccesspermissions.md | 0 .../proffer.storage.sharedaccesspolicy.md | 0 ...rage.storageservicecollectionextensions.md | 0 .../{ => api}/proffer.storage.storebase.md | 0 .../azure/blobs/{api.md => api/index.md} | 0 ...e.azure.blobs.azureblobsstorageprovider.md | 0 ...fer.storage.azure.blobs.azureblobsstore.md | 0 ...s.configuration.azureblobsparsedoptions.md | 0 ...configuration.azureblobsprovideroptions.md | 0 ...figuration.azureblobsscopedstoreoptions.md | 0 ...bs.configuration.azureblobsstoreoptions.md | 0 ...blobs.internal.azureblobsfileproperties.md | 0 ....blobs.internal.azureblobsfilereference.md | 0 ...internal.azureblobslistdirectorywrapper.md | 0 ...lobs.internal.azureblobslistfilewrapper.md | 0 ...blobsstorageservicecollectionextensions.md | 0 .../filesystem/{api.md => api/index.md} | 0 ...m.configuration.filesystemparsedoptions.md | 0 ...configuration.filesystemprovideroptions.md | 0 ...figuration.filesystemscopedstoreoptions.md | 0 ...em.configuration.filesystemstoreoptions.md | 0 ...ge.filesystem.filesystemstorageprovider.md | 0 ...ffer.storage.filesystem.filesystemstore.md | 0 ....filesystem.iextendedpropertiesprovider.md | 0 ...esystem.internal.fileextendedproperties.md | 0 ...ystem.internal.filesystemfileproperties.md | 0 ...system.internal.filesystemfilereference.md | 0 ...r.storage.filesystem.ipublicurlprovider.md | 0 ...filesystem.noextendedpropertiesprovider.md | 0 ...ystemstorageservicecollectionextensions.md | 0 .../properties/json/{api.md => api/index.md} | 0 ...es.json.filesystempropertiesjsonoptions.md | 0 ...son.internal.extendedpropertiesprovider.md | 0 ...opertiesjsonservicecollectionextensions.md | 0 .../server/{api.md => api/index.md} | 0 ...erver.filesystemstorageservermiddleware.md | 0 ...m.server.filesystemstorageserveroptions.md | 0 ...ystem.server.internal.publicurlprovider.md | 0 ...fer.storage.servicecollectionextensions.md | 0 docs/templating/{api.md => api/index.md} | 0 ...ng.exceptions.providernotfoundexception.md | 0 ...ng.exceptions.templatenotfoundexception.md | 0 ...ffer.templating.internal.templateloader.md | 0 ...mplating.internal.templateloaderfactory.md | 0 ...ffer.templating.invalidcontextexception.md | 0 .../{ => api}/proffer.templating.itemplate.md | 0 .../proffer.templating.itemplateloader.md | 0 ...offer.templating.itemplateloaderfactory.md | 0 .../proffer.templating.itemplateprovider.md | 0 ...offer.templating.itemplateproviderscope.md | 0 ...fer.templating.templatecollectionbase-1.md | 0 ...offer.templating.templatecollectionbase.md | 0 ...g.templatingservicecollectionextensions.md | 0 .../handlebars/{api.md => api/index.md} | 0 ...emplating.handlebars.handlebarstemplate.md | 0 ...g.handlebars.handlebarstemplateprovider.md | 0 ...g.handlebarsservicecollectionextensions.md | 0 .../mustache/{api.md => api/index.md} | 0 ...er.templating.mustache.mustachetemplate.md | 0 ...ating.mustache.mustachetemplateprovider.md | 0 ...ing.mustacheservicecollectionextensions.md | 0 src/Directory.Build.targets | 2 +- 139 files changed, 42 insertions(+), 39 deletions(-) create mode 100644 docs/api.md delete mode 100644 docs/code/index.md rename docs/core/{api.md => api/index.md} (100%) rename docs/core/{ => api}/proffer.configuration.inamedelementoptions.md (100%) rename docs/core/{ => api}/proffer.configuration.ioptionerror.md (100%) rename docs/core/{ => api}/proffer.configuration.iprovideroptions.md (100%) rename docs/core/{ => api}/proffer.configuration.optionerror.md (100%) rename docs/core/{ => api}/proffer.configuration.provideroptions.md (100%) rename docs/core/{ => api}/proffer.equalitycomparerbase-1.md (100%) rename docs/core/azure/{api.md => api/index.md} (100%) rename docs/core/azure/{ => api}/proffer.azure.configuration.iazurestorageoptions.md (100%) rename docs/email/{api.md => api/index.md} (100%) rename docs/email/{ => api}/proffer.email.emailoptions.md (100%) rename docs/email/{ => api}/proffer.email.emailprovideroptions.md (100%) rename docs/email/{ => api}/proffer.email.emailservicecollectionextensions.md (100%) rename docs/email/{ => api}/proffer.email.emailtemplatetype.md (100%) rename docs/email/{ => api}/proffer.email.iemailaddress.md (100%) rename docs/email/{ => api}/proffer.email.iemailattachment.md (100%) rename docs/email/{ => api}/proffer.email.iemailprovider.md (100%) rename docs/email/{ => api}/proffer.email.iemailprovideroptions.md (100%) rename docs/email/{ => api}/proffer.email.iemailprovidertype.md (100%) rename docs/email/{ => api}/proffer.email.iemailsender.md (100%) rename docs/email/{ => api}/proffer.email.internal.emailaddress.md (100%) rename docs/email/{ => api}/proffer.email.internal.emailaddressequalitycomparer.md (100%) rename docs/email/{ => api}/proffer.email.internal.emailaddressstrictequalitycomparer.md (100%) rename docs/email/{ => api}/proffer.email.internal.emailattachment.md (100%) rename docs/email/{ => api}/proffer.email.internal.emailattachmentequalitycomparer.md (100%) rename docs/email/{ => api}/proffer.email.internal.emailsender.md (100%) rename docs/email/{ => api}/proffer.email.mockupexceptionsoptions.md (100%) rename docs/email/{ => api}/proffer.email.mockupoptions.md (100%) rename docs/email/in-memory/{api.md => api/index.md} (100%) rename docs/email/in-memory/{ => api}/proffer.email.inmemory.iinmemoryemailrepository.md (100%) rename docs/email/in-memory/{ => api}/proffer.email.inmemory.inmemoryemail.md (100%) rename docs/email/in-memory/{ => api}/proffer.email.inmemory.inmemoryemailprovider.md (100%) rename docs/email/in-memory/{ => api}/proffer.email.inmemory.inmemoryemailprovidertype.md (100%) rename docs/email/in-memory/{ => api}/proffer.email.inmemory.inmemoryemailrepository.md (100%) rename docs/email/in-memory/{ => api}/proffer.email.inmemoryemailservicecollectionextensions.md (100%) rename docs/email/sendgrid/{api.md => api/index.md} (100%) rename docs/email/sendgrid/{ => api}/proffer.email.sendgrid.sendgridemailprovider.md (100%) rename docs/email/sendgrid/{ => api}/proffer.email.sendgrid.sendgridemailprovidertype.md (100%) rename docs/email/sendgrid/{ => api}/proffer.email.servicecollectionextensions.md (100%) rename docs/email/smtp/{api.md => api/index.md} (100%) rename docs/email/smtp/{ => api}/proffer.email.smtp.smtpemailprovider.md (100%) rename docs/email/smtp/{ => api}/proffer.email.smtp.smtpemailprovidertype.md (100%) rename docs/email/smtp/{ => api}/proffer.email.smtpemailservicecollectionextensions.md (100%) rename docs/storage/{api.md => api/index.md} (100%) rename docs/storage/{ => api}/proffer.storage.configuration.accesslevel.md (100%) rename docs/storage/{ => api}/proffer.storage.configuration.configurationextensions.md (100%) rename docs/storage/{ => api}/proffer.storage.configuration.iparsedoptions-3.md (100%) rename docs/storage/{ => api}/proffer.storage.configuration.iscopedstoreoptions.md (100%) rename docs/storage/{ => api}/proffer.storage.configuration.istoreoptions.md (100%) rename docs/storage/{ => api}/proffer.storage.configuration.scopedstoreoptions.md (100%) rename docs/storage/{ => api}/proffer.storage.configuration.storageoptions.md (100%) rename docs/storage/{ => api}/proffer.storage.configuration.storeoptions.md (100%) rename docs/storage/{ => api}/proffer.storage.exceptions.badproviderconfiguration.md (100%) rename docs/storage/{ => api}/proffer.storage.exceptions.badscopedstoreconfiguration.md (100%) rename docs/storage/{ => api}/proffer.storage.exceptions.badstoreconfiguration.md (100%) rename docs/storage/{ => api}/proffer.storage.exceptions.filealreadyexistsexception.md (100%) rename docs/storage/{ => api}/proffer.storage.exceptions.providernotfoundexception.md (100%) rename docs/storage/{ => api}/proffer.storage.exceptions.storenotfoundexception.md (100%) rename docs/storage/{ => api}/proffer.storage.ifileproperties.md (100%) rename docs/storage/{ => api}/proffer.storage.ifilereference.md (100%) rename docs/storage/{ => api}/proffer.storage.internal.configureprovideroptions-4.md (100%) rename docs/storage/{ => api}/proffer.storage.internal.genericstoreproxy-1.md (100%) rename docs/storage/{ => api}/proffer.storage.internal.privatefilereference.md (100%) rename docs/storage/{ => api}/proffer.storage.internal.storagefactory.md (100%) rename docs/storage/{ => api}/proffer.storage.internal.storageproviderbase-4.md (100%) rename docs/storage/{ => api}/proffer.storage.iprivatefilereference.md (100%) rename docs/storage/{ => api}/proffer.storage.isharedaccesspolicy.md (100%) rename docs/storage/{ => api}/proffer.storage.istoragefactory.md (100%) rename docs/storage/{ => api}/proffer.storage.istorageprovider.md (100%) rename docs/storage/{ => api}/proffer.storage.istore-1.md (100%) rename docs/storage/{ => api}/proffer.storage.istore.md (100%) rename docs/storage/{ => api}/proffer.storage.istoreextensions.md (100%) rename docs/storage/{ => api}/proffer.storage.overwritepolicy.md (100%) rename docs/storage/{ => api}/proffer.storage.sharedaccesspermissions.md (100%) rename docs/storage/{ => api}/proffer.storage.sharedaccesspolicy.md (100%) rename docs/storage/{ => api}/proffer.storage.storageservicecollectionextensions.md (100%) rename docs/storage/{ => api}/proffer.storage.storebase.md (100%) rename docs/storage/azure/blobs/{api.md => api/index.md} (100%) rename docs/storage/azure/blobs/{ => api}/proffer.storage.azure.blobs.azureblobsstorageprovider.md (100%) rename docs/storage/azure/blobs/{ => api}/proffer.storage.azure.blobs.azureblobsstore.md (100%) rename docs/storage/azure/blobs/{ => api}/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md (100%) rename docs/storage/azure/blobs/{ => api}/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md (100%) rename docs/storage/azure/blobs/{ => api}/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md (100%) rename docs/storage/azure/blobs/{ => api}/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md (100%) rename docs/storage/azure/blobs/{ => api}/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md (100%) rename docs/storage/azure/blobs/{ => api}/proffer.storage.azure.blobs.internal.azureblobsfilereference.md (100%) rename docs/storage/azure/blobs/{ => api}/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md (100%) rename docs/storage/azure/blobs/{ => api}/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md (100%) rename docs/storage/azure/blobs/{ => api}/proffer.storage.azureblobsstorageservicecollectionextensions.md (100%) rename docs/storage/filesystem/{api.md => api/index.md} (100%) rename docs/storage/filesystem/{ => api}/proffer.storage.filesystem.configuration.filesystemparsedoptions.md (100%) rename docs/storage/filesystem/{ => api}/proffer.storage.filesystem.configuration.filesystemprovideroptions.md (100%) rename docs/storage/filesystem/{ => api}/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md (100%) rename docs/storage/filesystem/{ => api}/proffer.storage.filesystem.configuration.filesystemstoreoptions.md (100%) rename docs/storage/filesystem/{ => api}/proffer.storage.filesystem.filesystemstorageprovider.md (100%) rename docs/storage/filesystem/{ => api}/proffer.storage.filesystem.filesystemstore.md (100%) rename docs/storage/filesystem/{ => api}/proffer.storage.filesystem.iextendedpropertiesprovider.md (100%) rename docs/storage/filesystem/{ => api}/proffer.storage.filesystem.internal.fileextendedproperties.md (100%) rename docs/storage/filesystem/{ => api}/proffer.storage.filesystem.internal.filesystemfileproperties.md (100%) rename docs/storage/filesystem/{ => api}/proffer.storage.filesystem.internal.filesystemfilereference.md (100%) rename docs/storage/filesystem/{ => api}/proffer.storage.filesystem.ipublicurlprovider.md (100%) rename docs/storage/filesystem/{ => api}/proffer.storage.filesystem.noextendedpropertiesprovider.md (100%) rename docs/storage/filesystem/{ => api}/proffer.storage.filesystemstorageservicecollectionextensions.md (100%) rename docs/storage/filesystem/properties/json/{api.md => api/index.md} (100%) rename docs/storage/filesystem/properties/json/{ => api}/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md (100%) rename docs/storage/filesystem/properties/json/{ => api}/proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md (100%) rename docs/storage/filesystem/properties/json/{ => api}/proffer.storage.filesystempropertiesjsonservicecollectionextensions.md (100%) rename docs/storage/filesystem/server/{api.md => api/index.md} (100%) rename docs/storage/filesystem/server/{ => api}/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md (100%) rename docs/storage/filesystem/server/{ => api}/proffer.storage.filesystem.server.filesystemstorageserveroptions.md (100%) rename docs/storage/filesystem/server/{ => api}/proffer.storage.filesystem.server.internal.publicurlprovider.md (100%) rename docs/storage/filesystem/server/{ => api}/proffer.storage.servicecollectionextensions.md (100%) rename docs/templating/{api.md => api/index.md} (100%) rename docs/templating/{ => api}/proffer.templating.exceptions.providernotfoundexception.md (100%) rename docs/templating/{ => api}/proffer.templating.exceptions.templatenotfoundexception.md (100%) rename docs/templating/{ => api}/proffer.templating.internal.templateloader.md (100%) rename docs/templating/{ => api}/proffer.templating.internal.templateloaderfactory.md (100%) rename docs/templating/{ => api}/proffer.templating.invalidcontextexception.md (100%) rename docs/templating/{ => api}/proffer.templating.itemplate.md (100%) rename docs/templating/{ => api}/proffer.templating.itemplateloader.md (100%) rename docs/templating/{ => api}/proffer.templating.itemplateloaderfactory.md (100%) rename docs/templating/{ => api}/proffer.templating.itemplateprovider.md (100%) rename docs/templating/{ => api}/proffer.templating.itemplateproviderscope.md (100%) rename docs/templating/{ => api}/proffer.templating.templatecollectionbase-1.md (100%) rename docs/templating/{ => api}/proffer.templating.templatecollectionbase.md (100%) rename docs/templating/{ => api}/proffer.templating.templatingservicecollectionextensions.md (100%) rename docs/templating/handlebars/{api.md => api/index.md} (100%) rename docs/templating/handlebars/{ => api}/proffer.templating.handlebars.handlebarstemplate.md (100%) rename docs/templating/handlebars/{ => api}/proffer.templating.handlebars.handlebarstemplateprovider.md (100%) rename docs/templating/handlebars/{ => api}/proffer.templating.handlebarsservicecollectionextensions.md (100%) rename docs/templating/mustache/{api.md => api/index.md} (100%) rename docs/templating/mustache/{ => api}/proffer.templating.mustache.mustachetemplate.md (100%) rename docs/templating/mustache/{ => api}/proffer.templating.mustache.mustachetemplateprovider.md (100%) rename docs/templating/mustache/{ => api}/proffer.templating.mustacheservicecollectionextensions.md (100%) diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index d72a481..13f4075 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -63,7 +63,7 @@

{{ site.description | default: site.github.project_tagline }}

{% endif %}

This page was generated by GitHub Pages.

diff --git a/docs/api.md b/docs/api.md new file mode 100644 index 0000000..796b179 --- /dev/null +++ b/docs/api.md @@ -0,0 +1,37 @@ +# API documentation + +## Core libraries + +[Proffer](/core/api) + +[Proffer.Azure](/core/azure/api) + +## Storage + +[Proffer.Storage](/storage/api) + +[Proffer.Storage.Azure.Blobs](/storage/azure/blobs/api) + +[Proffer.Storage.FileSystem](/storage/filesystem/api) + +[Proffer.Storage.FileSystem.Properties.Json](/storage/filesystem/properties/json/api) + +[Proffer.Storage.FileSystem.Server](/storage/filesystem/server/api) + +## Templating + +[Proffer.Templating](/templating/api) + +[Proffer.Templating.Handlebars](/templating/handlebars/api) + +[Proffer.Templating.Mustache](/templating/mustache/api) + +## Email + +[Proffer.Email](/email/api) + +[Proffer.Email.Smtp](/email/smtp/api) + +[Proffer.Email.SendGrid](/email/sendgrid/api) + +[Proffer.Email.InMemory](/email/in-memory/api) diff --git a/docs/code/index.md b/docs/code/index.md deleted file mode 100644 index 75703c7..0000000 --- a/docs/code/index.md +++ /dev/null @@ -1,37 +0,0 @@ -# API documentation - -## Core libraries - -[Proffer](./core) - -[Proffer.Azure](./core/azure) - -## Storage - -[Proffer.Storage](./storage) - -[Proffer.Storage.Azure.Blobs](./storage/azure/blobs) - -[Proffer.Storage.FileSystem](./storage/filesystem) - -[Proffer.Storage.FileSystem.Properties.Json](./storage/filesystem/properties/json) - -[Proffer.Storage.FileSystem.Server](./storage/filesystem/server) - -## Templating - -[Proffer.Templating](./templating) - -[Proffer.Templating.Handlebars](./templating/handlebars) - -[Proffer.Templating.Mustache](./templating/mustache) - -## Email - -[Proffer.Email](./email) - -[Proffer.Email.Smtp](./email/smtp) - -[Proffer.Email.SendGrid](./email/sendgrid) - -[Proffer.Email.InMemory](./email/in-memory) diff --git a/docs/core/api.md b/docs/core/api/index.md similarity index 100% rename from docs/core/api.md rename to docs/core/api/index.md diff --git a/docs/core/proffer.configuration.inamedelementoptions.md b/docs/core/api/proffer.configuration.inamedelementoptions.md similarity index 100% rename from docs/core/proffer.configuration.inamedelementoptions.md rename to docs/core/api/proffer.configuration.inamedelementoptions.md diff --git a/docs/core/proffer.configuration.ioptionerror.md b/docs/core/api/proffer.configuration.ioptionerror.md similarity index 100% rename from docs/core/proffer.configuration.ioptionerror.md rename to docs/core/api/proffer.configuration.ioptionerror.md diff --git a/docs/core/proffer.configuration.iprovideroptions.md b/docs/core/api/proffer.configuration.iprovideroptions.md similarity index 100% rename from docs/core/proffer.configuration.iprovideroptions.md rename to docs/core/api/proffer.configuration.iprovideroptions.md diff --git a/docs/core/proffer.configuration.optionerror.md b/docs/core/api/proffer.configuration.optionerror.md similarity index 100% rename from docs/core/proffer.configuration.optionerror.md rename to docs/core/api/proffer.configuration.optionerror.md diff --git a/docs/core/proffer.configuration.provideroptions.md b/docs/core/api/proffer.configuration.provideroptions.md similarity index 100% rename from docs/core/proffer.configuration.provideroptions.md rename to docs/core/api/proffer.configuration.provideroptions.md diff --git a/docs/core/proffer.equalitycomparerbase-1.md b/docs/core/api/proffer.equalitycomparerbase-1.md similarity index 100% rename from docs/core/proffer.equalitycomparerbase-1.md rename to docs/core/api/proffer.equalitycomparerbase-1.md diff --git a/docs/core/azure/api.md b/docs/core/azure/api/index.md similarity index 100% rename from docs/core/azure/api.md rename to docs/core/azure/api/index.md diff --git a/docs/core/azure/proffer.azure.configuration.iazurestorageoptions.md b/docs/core/azure/api/proffer.azure.configuration.iazurestorageoptions.md similarity index 100% rename from docs/core/azure/proffer.azure.configuration.iazurestorageoptions.md rename to docs/core/azure/api/proffer.azure.configuration.iazurestorageoptions.md diff --git a/docs/email/api.md b/docs/email/api/index.md similarity index 100% rename from docs/email/api.md rename to docs/email/api/index.md diff --git a/docs/email/proffer.email.emailoptions.md b/docs/email/api/proffer.email.emailoptions.md similarity index 100% rename from docs/email/proffer.email.emailoptions.md rename to docs/email/api/proffer.email.emailoptions.md diff --git a/docs/email/proffer.email.emailprovideroptions.md b/docs/email/api/proffer.email.emailprovideroptions.md similarity index 100% rename from docs/email/proffer.email.emailprovideroptions.md rename to docs/email/api/proffer.email.emailprovideroptions.md diff --git a/docs/email/proffer.email.emailservicecollectionextensions.md b/docs/email/api/proffer.email.emailservicecollectionextensions.md similarity index 100% rename from docs/email/proffer.email.emailservicecollectionextensions.md rename to docs/email/api/proffer.email.emailservicecollectionextensions.md diff --git a/docs/email/proffer.email.emailtemplatetype.md b/docs/email/api/proffer.email.emailtemplatetype.md similarity index 100% rename from docs/email/proffer.email.emailtemplatetype.md rename to docs/email/api/proffer.email.emailtemplatetype.md diff --git a/docs/email/proffer.email.iemailaddress.md b/docs/email/api/proffer.email.iemailaddress.md similarity index 100% rename from docs/email/proffer.email.iemailaddress.md rename to docs/email/api/proffer.email.iemailaddress.md diff --git a/docs/email/proffer.email.iemailattachment.md b/docs/email/api/proffer.email.iemailattachment.md similarity index 100% rename from docs/email/proffer.email.iemailattachment.md rename to docs/email/api/proffer.email.iemailattachment.md diff --git a/docs/email/proffer.email.iemailprovider.md b/docs/email/api/proffer.email.iemailprovider.md similarity index 100% rename from docs/email/proffer.email.iemailprovider.md rename to docs/email/api/proffer.email.iemailprovider.md diff --git a/docs/email/proffer.email.iemailprovideroptions.md b/docs/email/api/proffer.email.iemailprovideroptions.md similarity index 100% rename from docs/email/proffer.email.iemailprovideroptions.md rename to docs/email/api/proffer.email.iemailprovideroptions.md diff --git a/docs/email/proffer.email.iemailprovidertype.md b/docs/email/api/proffer.email.iemailprovidertype.md similarity index 100% rename from docs/email/proffer.email.iemailprovidertype.md rename to docs/email/api/proffer.email.iemailprovidertype.md diff --git a/docs/email/proffer.email.iemailsender.md b/docs/email/api/proffer.email.iemailsender.md similarity index 100% rename from docs/email/proffer.email.iemailsender.md rename to docs/email/api/proffer.email.iemailsender.md diff --git a/docs/email/proffer.email.internal.emailaddress.md b/docs/email/api/proffer.email.internal.emailaddress.md similarity index 100% rename from docs/email/proffer.email.internal.emailaddress.md rename to docs/email/api/proffer.email.internal.emailaddress.md diff --git a/docs/email/proffer.email.internal.emailaddressequalitycomparer.md b/docs/email/api/proffer.email.internal.emailaddressequalitycomparer.md similarity index 100% rename from docs/email/proffer.email.internal.emailaddressequalitycomparer.md rename to docs/email/api/proffer.email.internal.emailaddressequalitycomparer.md diff --git a/docs/email/proffer.email.internal.emailaddressstrictequalitycomparer.md b/docs/email/api/proffer.email.internal.emailaddressstrictequalitycomparer.md similarity index 100% rename from docs/email/proffer.email.internal.emailaddressstrictequalitycomparer.md rename to docs/email/api/proffer.email.internal.emailaddressstrictequalitycomparer.md diff --git a/docs/email/proffer.email.internal.emailattachment.md b/docs/email/api/proffer.email.internal.emailattachment.md similarity index 100% rename from docs/email/proffer.email.internal.emailattachment.md rename to docs/email/api/proffer.email.internal.emailattachment.md diff --git a/docs/email/proffer.email.internal.emailattachmentequalitycomparer.md b/docs/email/api/proffer.email.internal.emailattachmentequalitycomparer.md similarity index 100% rename from docs/email/proffer.email.internal.emailattachmentequalitycomparer.md rename to docs/email/api/proffer.email.internal.emailattachmentequalitycomparer.md diff --git a/docs/email/proffer.email.internal.emailsender.md b/docs/email/api/proffer.email.internal.emailsender.md similarity index 100% rename from docs/email/proffer.email.internal.emailsender.md rename to docs/email/api/proffer.email.internal.emailsender.md diff --git a/docs/email/proffer.email.mockupexceptionsoptions.md b/docs/email/api/proffer.email.mockupexceptionsoptions.md similarity index 100% rename from docs/email/proffer.email.mockupexceptionsoptions.md rename to docs/email/api/proffer.email.mockupexceptionsoptions.md diff --git a/docs/email/proffer.email.mockupoptions.md b/docs/email/api/proffer.email.mockupoptions.md similarity index 100% rename from docs/email/proffer.email.mockupoptions.md rename to docs/email/api/proffer.email.mockupoptions.md diff --git a/docs/email/in-memory/api.md b/docs/email/in-memory/api/index.md similarity index 100% rename from docs/email/in-memory/api.md rename to docs/email/in-memory/api/index.md diff --git a/docs/email/in-memory/proffer.email.inmemory.iinmemoryemailrepository.md b/docs/email/in-memory/api/proffer.email.inmemory.iinmemoryemailrepository.md similarity index 100% rename from docs/email/in-memory/proffer.email.inmemory.iinmemoryemailrepository.md rename to docs/email/in-memory/api/proffer.email.inmemory.iinmemoryemailrepository.md diff --git a/docs/email/in-memory/proffer.email.inmemory.inmemoryemail.md b/docs/email/in-memory/api/proffer.email.inmemory.inmemoryemail.md similarity index 100% rename from docs/email/in-memory/proffer.email.inmemory.inmemoryemail.md rename to docs/email/in-memory/api/proffer.email.inmemory.inmemoryemail.md diff --git a/docs/email/in-memory/proffer.email.inmemory.inmemoryemailprovider.md b/docs/email/in-memory/api/proffer.email.inmemory.inmemoryemailprovider.md similarity index 100% rename from docs/email/in-memory/proffer.email.inmemory.inmemoryemailprovider.md rename to docs/email/in-memory/api/proffer.email.inmemory.inmemoryemailprovider.md diff --git a/docs/email/in-memory/proffer.email.inmemory.inmemoryemailprovidertype.md b/docs/email/in-memory/api/proffer.email.inmemory.inmemoryemailprovidertype.md similarity index 100% rename from docs/email/in-memory/proffer.email.inmemory.inmemoryemailprovidertype.md rename to docs/email/in-memory/api/proffer.email.inmemory.inmemoryemailprovidertype.md diff --git a/docs/email/in-memory/proffer.email.inmemory.inmemoryemailrepository.md b/docs/email/in-memory/api/proffer.email.inmemory.inmemoryemailrepository.md similarity index 100% rename from docs/email/in-memory/proffer.email.inmemory.inmemoryemailrepository.md rename to docs/email/in-memory/api/proffer.email.inmemory.inmemoryemailrepository.md diff --git a/docs/email/in-memory/proffer.email.inmemoryemailservicecollectionextensions.md b/docs/email/in-memory/api/proffer.email.inmemoryemailservicecollectionextensions.md similarity index 100% rename from docs/email/in-memory/proffer.email.inmemoryemailservicecollectionextensions.md rename to docs/email/in-memory/api/proffer.email.inmemoryemailservicecollectionextensions.md diff --git a/docs/email/sendgrid/api.md b/docs/email/sendgrid/api/index.md similarity index 100% rename from docs/email/sendgrid/api.md rename to docs/email/sendgrid/api/index.md diff --git a/docs/email/sendgrid/proffer.email.sendgrid.sendgridemailprovider.md b/docs/email/sendgrid/api/proffer.email.sendgrid.sendgridemailprovider.md similarity index 100% rename from docs/email/sendgrid/proffer.email.sendgrid.sendgridemailprovider.md rename to docs/email/sendgrid/api/proffer.email.sendgrid.sendgridemailprovider.md diff --git a/docs/email/sendgrid/proffer.email.sendgrid.sendgridemailprovidertype.md b/docs/email/sendgrid/api/proffer.email.sendgrid.sendgridemailprovidertype.md similarity index 100% rename from docs/email/sendgrid/proffer.email.sendgrid.sendgridemailprovidertype.md rename to docs/email/sendgrid/api/proffer.email.sendgrid.sendgridemailprovidertype.md diff --git a/docs/email/sendgrid/proffer.email.servicecollectionextensions.md b/docs/email/sendgrid/api/proffer.email.servicecollectionextensions.md similarity index 100% rename from docs/email/sendgrid/proffer.email.servicecollectionextensions.md rename to docs/email/sendgrid/api/proffer.email.servicecollectionextensions.md diff --git a/docs/email/smtp/api.md b/docs/email/smtp/api/index.md similarity index 100% rename from docs/email/smtp/api.md rename to docs/email/smtp/api/index.md diff --git a/docs/email/smtp/proffer.email.smtp.smtpemailprovider.md b/docs/email/smtp/api/proffer.email.smtp.smtpemailprovider.md similarity index 100% rename from docs/email/smtp/proffer.email.smtp.smtpemailprovider.md rename to docs/email/smtp/api/proffer.email.smtp.smtpemailprovider.md diff --git a/docs/email/smtp/proffer.email.smtp.smtpemailprovidertype.md b/docs/email/smtp/api/proffer.email.smtp.smtpemailprovidertype.md similarity index 100% rename from docs/email/smtp/proffer.email.smtp.smtpemailprovidertype.md rename to docs/email/smtp/api/proffer.email.smtp.smtpemailprovidertype.md diff --git a/docs/email/smtp/proffer.email.smtpemailservicecollectionextensions.md b/docs/email/smtp/api/proffer.email.smtpemailservicecollectionextensions.md similarity index 100% rename from docs/email/smtp/proffer.email.smtpemailservicecollectionextensions.md rename to docs/email/smtp/api/proffer.email.smtpemailservicecollectionextensions.md diff --git a/docs/index.md b/docs/index.md index 9edbc8c..ac38724 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,6 @@ +# Proffer + + ## Welcome to GitHub Pages You can use the [editor on GitHub](https://github.com/asiffermann/proffer/edit/topics/docs/docs/index.md) to maintain and preview the content for your website in Markdown files. diff --git a/docs/storage/api.md b/docs/storage/api/index.md similarity index 100% rename from docs/storage/api.md rename to docs/storage/api/index.md diff --git a/docs/storage/proffer.storage.configuration.accesslevel.md b/docs/storage/api/proffer.storage.configuration.accesslevel.md similarity index 100% rename from docs/storage/proffer.storage.configuration.accesslevel.md rename to docs/storage/api/proffer.storage.configuration.accesslevel.md diff --git a/docs/storage/proffer.storage.configuration.configurationextensions.md b/docs/storage/api/proffer.storage.configuration.configurationextensions.md similarity index 100% rename from docs/storage/proffer.storage.configuration.configurationextensions.md rename to docs/storage/api/proffer.storage.configuration.configurationextensions.md diff --git a/docs/storage/proffer.storage.configuration.iparsedoptions-3.md b/docs/storage/api/proffer.storage.configuration.iparsedoptions-3.md similarity index 100% rename from docs/storage/proffer.storage.configuration.iparsedoptions-3.md rename to docs/storage/api/proffer.storage.configuration.iparsedoptions-3.md diff --git a/docs/storage/proffer.storage.configuration.iscopedstoreoptions.md b/docs/storage/api/proffer.storage.configuration.iscopedstoreoptions.md similarity index 100% rename from docs/storage/proffer.storage.configuration.iscopedstoreoptions.md rename to docs/storage/api/proffer.storage.configuration.iscopedstoreoptions.md diff --git a/docs/storage/proffer.storage.configuration.istoreoptions.md b/docs/storage/api/proffer.storage.configuration.istoreoptions.md similarity index 100% rename from docs/storage/proffer.storage.configuration.istoreoptions.md rename to docs/storage/api/proffer.storage.configuration.istoreoptions.md diff --git a/docs/storage/proffer.storage.configuration.scopedstoreoptions.md b/docs/storage/api/proffer.storage.configuration.scopedstoreoptions.md similarity index 100% rename from docs/storage/proffer.storage.configuration.scopedstoreoptions.md rename to docs/storage/api/proffer.storage.configuration.scopedstoreoptions.md diff --git a/docs/storage/proffer.storage.configuration.storageoptions.md b/docs/storage/api/proffer.storage.configuration.storageoptions.md similarity index 100% rename from docs/storage/proffer.storage.configuration.storageoptions.md rename to docs/storage/api/proffer.storage.configuration.storageoptions.md diff --git a/docs/storage/proffer.storage.configuration.storeoptions.md b/docs/storage/api/proffer.storage.configuration.storeoptions.md similarity index 100% rename from docs/storage/proffer.storage.configuration.storeoptions.md rename to docs/storage/api/proffer.storage.configuration.storeoptions.md diff --git a/docs/storage/proffer.storage.exceptions.badproviderconfiguration.md b/docs/storage/api/proffer.storage.exceptions.badproviderconfiguration.md similarity index 100% rename from docs/storage/proffer.storage.exceptions.badproviderconfiguration.md rename to docs/storage/api/proffer.storage.exceptions.badproviderconfiguration.md diff --git a/docs/storage/proffer.storage.exceptions.badscopedstoreconfiguration.md b/docs/storage/api/proffer.storage.exceptions.badscopedstoreconfiguration.md similarity index 100% rename from docs/storage/proffer.storage.exceptions.badscopedstoreconfiguration.md rename to docs/storage/api/proffer.storage.exceptions.badscopedstoreconfiguration.md diff --git a/docs/storage/proffer.storage.exceptions.badstoreconfiguration.md b/docs/storage/api/proffer.storage.exceptions.badstoreconfiguration.md similarity index 100% rename from docs/storage/proffer.storage.exceptions.badstoreconfiguration.md rename to docs/storage/api/proffer.storage.exceptions.badstoreconfiguration.md diff --git a/docs/storage/proffer.storage.exceptions.filealreadyexistsexception.md b/docs/storage/api/proffer.storage.exceptions.filealreadyexistsexception.md similarity index 100% rename from docs/storage/proffer.storage.exceptions.filealreadyexistsexception.md rename to docs/storage/api/proffer.storage.exceptions.filealreadyexistsexception.md diff --git a/docs/storage/proffer.storage.exceptions.providernotfoundexception.md b/docs/storage/api/proffer.storage.exceptions.providernotfoundexception.md similarity index 100% rename from docs/storage/proffer.storage.exceptions.providernotfoundexception.md rename to docs/storage/api/proffer.storage.exceptions.providernotfoundexception.md diff --git a/docs/storage/proffer.storage.exceptions.storenotfoundexception.md b/docs/storage/api/proffer.storage.exceptions.storenotfoundexception.md similarity index 100% rename from docs/storage/proffer.storage.exceptions.storenotfoundexception.md rename to docs/storage/api/proffer.storage.exceptions.storenotfoundexception.md diff --git a/docs/storage/proffer.storage.ifileproperties.md b/docs/storage/api/proffer.storage.ifileproperties.md similarity index 100% rename from docs/storage/proffer.storage.ifileproperties.md rename to docs/storage/api/proffer.storage.ifileproperties.md diff --git a/docs/storage/proffer.storage.ifilereference.md b/docs/storage/api/proffer.storage.ifilereference.md similarity index 100% rename from docs/storage/proffer.storage.ifilereference.md rename to docs/storage/api/proffer.storage.ifilereference.md diff --git a/docs/storage/proffer.storage.internal.configureprovideroptions-4.md b/docs/storage/api/proffer.storage.internal.configureprovideroptions-4.md similarity index 100% rename from docs/storage/proffer.storage.internal.configureprovideroptions-4.md rename to docs/storage/api/proffer.storage.internal.configureprovideroptions-4.md diff --git a/docs/storage/proffer.storage.internal.genericstoreproxy-1.md b/docs/storage/api/proffer.storage.internal.genericstoreproxy-1.md similarity index 100% rename from docs/storage/proffer.storage.internal.genericstoreproxy-1.md rename to docs/storage/api/proffer.storage.internal.genericstoreproxy-1.md diff --git a/docs/storage/proffer.storage.internal.privatefilereference.md b/docs/storage/api/proffer.storage.internal.privatefilereference.md similarity index 100% rename from docs/storage/proffer.storage.internal.privatefilereference.md rename to docs/storage/api/proffer.storage.internal.privatefilereference.md diff --git a/docs/storage/proffer.storage.internal.storagefactory.md b/docs/storage/api/proffer.storage.internal.storagefactory.md similarity index 100% rename from docs/storage/proffer.storage.internal.storagefactory.md rename to docs/storage/api/proffer.storage.internal.storagefactory.md diff --git a/docs/storage/proffer.storage.internal.storageproviderbase-4.md b/docs/storage/api/proffer.storage.internal.storageproviderbase-4.md similarity index 100% rename from docs/storage/proffer.storage.internal.storageproviderbase-4.md rename to docs/storage/api/proffer.storage.internal.storageproviderbase-4.md diff --git a/docs/storage/proffer.storage.iprivatefilereference.md b/docs/storage/api/proffer.storage.iprivatefilereference.md similarity index 100% rename from docs/storage/proffer.storage.iprivatefilereference.md rename to docs/storage/api/proffer.storage.iprivatefilereference.md diff --git a/docs/storage/proffer.storage.isharedaccesspolicy.md b/docs/storage/api/proffer.storage.isharedaccesspolicy.md similarity index 100% rename from docs/storage/proffer.storage.isharedaccesspolicy.md rename to docs/storage/api/proffer.storage.isharedaccesspolicy.md diff --git a/docs/storage/proffer.storage.istoragefactory.md b/docs/storage/api/proffer.storage.istoragefactory.md similarity index 100% rename from docs/storage/proffer.storage.istoragefactory.md rename to docs/storage/api/proffer.storage.istoragefactory.md diff --git a/docs/storage/proffer.storage.istorageprovider.md b/docs/storage/api/proffer.storage.istorageprovider.md similarity index 100% rename from docs/storage/proffer.storage.istorageprovider.md rename to docs/storage/api/proffer.storage.istorageprovider.md diff --git a/docs/storage/proffer.storage.istore-1.md b/docs/storage/api/proffer.storage.istore-1.md similarity index 100% rename from docs/storage/proffer.storage.istore-1.md rename to docs/storage/api/proffer.storage.istore-1.md diff --git a/docs/storage/proffer.storage.istore.md b/docs/storage/api/proffer.storage.istore.md similarity index 100% rename from docs/storage/proffer.storage.istore.md rename to docs/storage/api/proffer.storage.istore.md diff --git a/docs/storage/proffer.storage.istoreextensions.md b/docs/storage/api/proffer.storage.istoreextensions.md similarity index 100% rename from docs/storage/proffer.storage.istoreextensions.md rename to docs/storage/api/proffer.storage.istoreextensions.md diff --git a/docs/storage/proffer.storage.overwritepolicy.md b/docs/storage/api/proffer.storage.overwritepolicy.md similarity index 100% rename from docs/storage/proffer.storage.overwritepolicy.md rename to docs/storage/api/proffer.storage.overwritepolicy.md diff --git a/docs/storage/proffer.storage.sharedaccesspermissions.md b/docs/storage/api/proffer.storage.sharedaccesspermissions.md similarity index 100% rename from docs/storage/proffer.storage.sharedaccesspermissions.md rename to docs/storage/api/proffer.storage.sharedaccesspermissions.md diff --git a/docs/storage/proffer.storage.sharedaccesspolicy.md b/docs/storage/api/proffer.storage.sharedaccesspolicy.md similarity index 100% rename from docs/storage/proffer.storage.sharedaccesspolicy.md rename to docs/storage/api/proffer.storage.sharedaccesspolicy.md diff --git a/docs/storage/proffer.storage.storageservicecollectionextensions.md b/docs/storage/api/proffer.storage.storageservicecollectionextensions.md similarity index 100% rename from docs/storage/proffer.storage.storageservicecollectionextensions.md rename to docs/storage/api/proffer.storage.storageservicecollectionextensions.md diff --git a/docs/storage/proffer.storage.storebase.md b/docs/storage/api/proffer.storage.storebase.md similarity index 100% rename from docs/storage/proffer.storage.storebase.md rename to docs/storage/api/proffer.storage.storebase.md diff --git a/docs/storage/azure/blobs/api.md b/docs/storage/azure/blobs/api/index.md similarity index 100% rename from docs/storage/azure/blobs/api.md rename to docs/storage/azure/blobs/api/index.md diff --git a/docs/storage/azure/blobs/proffer.storage.azure.blobs.azureblobsstorageprovider.md b/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.azureblobsstorageprovider.md similarity index 100% rename from docs/storage/azure/blobs/proffer.storage.azure.blobs.azureblobsstorageprovider.md rename to docs/storage/azure/blobs/api/proffer.storage.azure.blobs.azureblobsstorageprovider.md diff --git a/docs/storage/azure/blobs/proffer.storage.azure.blobs.azureblobsstore.md b/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.azureblobsstore.md similarity index 100% rename from docs/storage/azure/blobs/proffer.storage.azure.blobs.azureblobsstore.md rename to docs/storage/azure/blobs/api/proffer.storage.azure.blobs.azureblobsstore.md diff --git a/docs/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md b/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md similarity index 100% rename from docs/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md rename to docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md diff --git a/docs/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md b/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md similarity index 100% rename from docs/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md rename to docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md diff --git a/docs/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md b/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md similarity index 100% rename from docs/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md rename to docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md diff --git a/docs/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md b/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md similarity index 100% rename from docs/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md rename to docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md diff --git a/docs/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md b/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md similarity index 100% rename from docs/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md rename to docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md diff --git a/docs/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobsfilereference.md b/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobsfilereference.md similarity index 100% rename from docs/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobsfilereference.md rename to docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobsfilereference.md diff --git a/docs/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md b/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md similarity index 100% rename from docs/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md rename to docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md diff --git a/docs/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md b/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md similarity index 100% rename from docs/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md rename to docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md diff --git a/docs/storage/azure/blobs/proffer.storage.azureblobsstorageservicecollectionextensions.md b/docs/storage/azure/blobs/api/proffer.storage.azureblobsstorageservicecollectionextensions.md similarity index 100% rename from docs/storage/azure/blobs/proffer.storage.azureblobsstorageservicecollectionextensions.md rename to docs/storage/azure/blobs/api/proffer.storage.azureblobsstorageservicecollectionextensions.md diff --git a/docs/storage/filesystem/api.md b/docs/storage/filesystem/api/index.md similarity index 100% rename from docs/storage/filesystem/api.md rename to docs/storage/filesystem/api/index.md diff --git a/docs/storage/filesystem/proffer.storage.filesystem.configuration.filesystemparsedoptions.md b/docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemparsedoptions.md similarity index 100% rename from docs/storage/filesystem/proffer.storage.filesystem.configuration.filesystemparsedoptions.md rename to docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemparsedoptions.md diff --git a/docs/storage/filesystem/proffer.storage.filesystem.configuration.filesystemprovideroptions.md b/docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemprovideroptions.md similarity index 100% rename from docs/storage/filesystem/proffer.storage.filesystem.configuration.filesystemprovideroptions.md rename to docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemprovideroptions.md diff --git a/docs/storage/filesystem/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md b/docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md similarity index 100% rename from docs/storage/filesystem/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md rename to docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md diff --git a/docs/storage/filesystem/proffer.storage.filesystem.configuration.filesystemstoreoptions.md b/docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemstoreoptions.md similarity index 100% rename from docs/storage/filesystem/proffer.storage.filesystem.configuration.filesystemstoreoptions.md rename to docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemstoreoptions.md diff --git a/docs/storage/filesystem/proffer.storage.filesystem.filesystemstorageprovider.md b/docs/storage/filesystem/api/proffer.storage.filesystem.filesystemstorageprovider.md similarity index 100% rename from docs/storage/filesystem/proffer.storage.filesystem.filesystemstorageprovider.md rename to docs/storage/filesystem/api/proffer.storage.filesystem.filesystemstorageprovider.md diff --git a/docs/storage/filesystem/proffer.storage.filesystem.filesystemstore.md b/docs/storage/filesystem/api/proffer.storage.filesystem.filesystemstore.md similarity index 100% rename from docs/storage/filesystem/proffer.storage.filesystem.filesystemstore.md rename to docs/storage/filesystem/api/proffer.storage.filesystem.filesystemstore.md diff --git a/docs/storage/filesystem/proffer.storage.filesystem.iextendedpropertiesprovider.md b/docs/storage/filesystem/api/proffer.storage.filesystem.iextendedpropertiesprovider.md similarity index 100% rename from docs/storage/filesystem/proffer.storage.filesystem.iextendedpropertiesprovider.md rename to docs/storage/filesystem/api/proffer.storage.filesystem.iextendedpropertiesprovider.md diff --git a/docs/storage/filesystem/proffer.storage.filesystem.internal.fileextendedproperties.md b/docs/storage/filesystem/api/proffer.storage.filesystem.internal.fileextendedproperties.md similarity index 100% rename from docs/storage/filesystem/proffer.storage.filesystem.internal.fileextendedproperties.md rename to docs/storage/filesystem/api/proffer.storage.filesystem.internal.fileextendedproperties.md diff --git a/docs/storage/filesystem/proffer.storage.filesystem.internal.filesystemfileproperties.md b/docs/storage/filesystem/api/proffer.storage.filesystem.internal.filesystemfileproperties.md similarity index 100% rename from docs/storage/filesystem/proffer.storage.filesystem.internal.filesystemfileproperties.md rename to docs/storage/filesystem/api/proffer.storage.filesystem.internal.filesystemfileproperties.md diff --git a/docs/storage/filesystem/proffer.storage.filesystem.internal.filesystemfilereference.md b/docs/storage/filesystem/api/proffer.storage.filesystem.internal.filesystemfilereference.md similarity index 100% rename from docs/storage/filesystem/proffer.storage.filesystem.internal.filesystemfilereference.md rename to docs/storage/filesystem/api/proffer.storage.filesystem.internal.filesystemfilereference.md diff --git a/docs/storage/filesystem/proffer.storage.filesystem.ipublicurlprovider.md b/docs/storage/filesystem/api/proffer.storage.filesystem.ipublicurlprovider.md similarity index 100% rename from docs/storage/filesystem/proffer.storage.filesystem.ipublicurlprovider.md rename to docs/storage/filesystem/api/proffer.storage.filesystem.ipublicurlprovider.md diff --git a/docs/storage/filesystem/proffer.storage.filesystem.noextendedpropertiesprovider.md b/docs/storage/filesystem/api/proffer.storage.filesystem.noextendedpropertiesprovider.md similarity index 100% rename from docs/storage/filesystem/proffer.storage.filesystem.noextendedpropertiesprovider.md rename to docs/storage/filesystem/api/proffer.storage.filesystem.noextendedpropertiesprovider.md diff --git a/docs/storage/filesystem/proffer.storage.filesystemstorageservicecollectionextensions.md b/docs/storage/filesystem/api/proffer.storage.filesystemstorageservicecollectionextensions.md similarity index 100% rename from docs/storage/filesystem/proffer.storage.filesystemstorageservicecollectionextensions.md rename to docs/storage/filesystem/api/proffer.storage.filesystemstorageservicecollectionextensions.md diff --git a/docs/storage/filesystem/properties/json/api.md b/docs/storage/filesystem/properties/json/api/index.md similarity index 100% rename from docs/storage/filesystem/properties/json/api.md rename to docs/storage/filesystem/properties/json/api/index.md diff --git a/docs/storage/filesystem/properties/json/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md b/docs/storage/filesystem/properties/json/api/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md similarity index 100% rename from docs/storage/filesystem/properties/json/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md rename to docs/storage/filesystem/properties/json/api/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md diff --git a/docs/storage/filesystem/properties/json/proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md b/docs/storage/filesystem/properties/json/api/proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md similarity index 100% rename from docs/storage/filesystem/properties/json/proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md rename to docs/storage/filesystem/properties/json/api/proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md diff --git a/docs/storage/filesystem/properties/json/proffer.storage.filesystempropertiesjsonservicecollectionextensions.md b/docs/storage/filesystem/properties/json/api/proffer.storage.filesystempropertiesjsonservicecollectionextensions.md similarity index 100% rename from docs/storage/filesystem/properties/json/proffer.storage.filesystempropertiesjsonservicecollectionextensions.md rename to docs/storage/filesystem/properties/json/api/proffer.storage.filesystempropertiesjsonservicecollectionextensions.md diff --git a/docs/storage/filesystem/server/api.md b/docs/storage/filesystem/server/api/index.md similarity index 100% rename from docs/storage/filesystem/server/api.md rename to docs/storage/filesystem/server/api/index.md diff --git a/docs/storage/filesystem/server/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md b/docs/storage/filesystem/server/api/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md similarity index 100% rename from docs/storage/filesystem/server/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md rename to docs/storage/filesystem/server/api/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md diff --git a/docs/storage/filesystem/server/proffer.storage.filesystem.server.filesystemstorageserveroptions.md b/docs/storage/filesystem/server/api/proffer.storage.filesystem.server.filesystemstorageserveroptions.md similarity index 100% rename from docs/storage/filesystem/server/proffer.storage.filesystem.server.filesystemstorageserveroptions.md rename to docs/storage/filesystem/server/api/proffer.storage.filesystem.server.filesystemstorageserveroptions.md diff --git a/docs/storage/filesystem/server/proffer.storage.filesystem.server.internal.publicurlprovider.md b/docs/storage/filesystem/server/api/proffer.storage.filesystem.server.internal.publicurlprovider.md similarity index 100% rename from docs/storage/filesystem/server/proffer.storage.filesystem.server.internal.publicurlprovider.md rename to docs/storage/filesystem/server/api/proffer.storage.filesystem.server.internal.publicurlprovider.md diff --git a/docs/storage/filesystem/server/proffer.storage.servicecollectionextensions.md b/docs/storage/filesystem/server/api/proffer.storage.servicecollectionextensions.md similarity index 100% rename from docs/storage/filesystem/server/proffer.storage.servicecollectionextensions.md rename to docs/storage/filesystem/server/api/proffer.storage.servicecollectionextensions.md diff --git a/docs/templating/api.md b/docs/templating/api/index.md similarity index 100% rename from docs/templating/api.md rename to docs/templating/api/index.md diff --git a/docs/templating/proffer.templating.exceptions.providernotfoundexception.md b/docs/templating/api/proffer.templating.exceptions.providernotfoundexception.md similarity index 100% rename from docs/templating/proffer.templating.exceptions.providernotfoundexception.md rename to docs/templating/api/proffer.templating.exceptions.providernotfoundexception.md diff --git a/docs/templating/proffer.templating.exceptions.templatenotfoundexception.md b/docs/templating/api/proffer.templating.exceptions.templatenotfoundexception.md similarity index 100% rename from docs/templating/proffer.templating.exceptions.templatenotfoundexception.md rename to docs/templating/api/proffer.templating.exceptions.templatenotfoundexception.md diff --git a/docs/templating/proffer.templating.internal.templateloader.md b/docs/templating/api/proffer.templating.internal.templateloader.md similarity index 100% rename from docs/templating/proffer.templating.internal.templateloader.md rename to docs/templating/api/proffer.templating.internal.templateloader.md diff --git a/docs/templating/proffer.templating.internal.templateloaderfactory.md b/docs/templating/api/proffer.templating.internal.templateloaderfactory.md similarity index 100% rename from docs/templating/proffer.templating.internal.templateloaderfactory.md rename to docs/templating/api/proffer.templating.internal.templateloaderfactory.md diff --git a/docs/templating/proffer.templating.invalidcontextexception.md b/docs/templating/api/proffer.templating.invalidcontextexception.md similarity index 100% rename from docs/templating/proffer.templating.invalidcontextexception.md rename to docs/templating/api/proffer.templating.invalidcontextexception.md diff --git a/docs/templating/proffer.templating.itemplate.md b/docs/templating/api/proffer.templating.itemplate.md similarity index 100% rename from docs/templating/proffer.templating.itemplate.md rename to docs/templating/api/proffer.templating.itemplate.md diff --git a/docs/templating/proffer.templating.itemplateloader.md b/docs/templating/api/proffer.templating.itemplateloader.md similarity index 100% rename from docs/templating/proffer.templating.itemplateloader.md rename to docs/templating/api/proffer.templating.itemplateloader.md diff --git a/docs/templating/proffer.templating.itemplateloaderfactory.md b/docs/templating/api/proffer.templating.itemplateloaderfactory.md similarity index 100% rename from docs/templating/proffer.templating.itemplateloaderfactory.md rename to docs/templating/api/proffer.templating.itemplateloaderfactory.md diff --git a/docs/templating/proffer.templating.itemplateprovider.md b/docs/templating/api/proffer.templating.itemplateprovider.md similarity index 100% rename from docs/templating/proffer.templating.itemplateprovider.md rename to docs/templating/api/proffer.templating.itemplateprovider.md diff --git a/docs/templating/proffer.templating.itemplateproviderscope.md b/docs/templating/api/proffer.templating.itemplateproviderscope.md similarity index 100% rename from docs/templating/proffer.templating.itemplateproviderscope.md rename to docs/templating/api/proffer.templating.itemplateproviderscope.md diff --git a/docs/templating/proffer.templating.templatecollectionbase-1.md b/docs/templating/api/proffer.templating.templatecollectionbase-1.md similarity index 100% rename from docs/templating/proffer.templating.templatecollectionbase-1.md rename to docs/templating/api/proffer.templating.templatecollectionbase-1.md diff --git a/docs/templating/proffer.templating.templatecollectionbase.md b/docs/templating/api/proffer.templating.templatecollectionbase.md similarity index 100% rename from docs/templating/proffer.templating.templatecollectionbase.md rename to docs/templating/api/proffer.templating.templatecollectionbase.md diff --git a/docs/templating/proffer.templating.templatingservicecollectionextensions.md b/docs/templating/api/proffer.templating.templatingservicecollectionextensions.md similarity index 100% rename from docs/templating/proffer.templating.templatingservicecollectionextensions.md rename to docs/templating/api/proffer.templating.templatingservicecollectionextensions.md diff --git a/docs/templating/handlebars/api.md b/docs/templating/handlebars/api/index.md similarity index 100% rename from docs/templating/handlebars/api.md rename to docs/templating/handlebars/api/index.md diff --git a/docs/templating/handlebars/proffer.templating.handlebars.handlebarstemplate.md b/docs/templating/handlebars/api/proffer.templating.handlebars.handlebarstemplate.md similarity index 100% rename from docs/templating/handlebars/proffer.templating.handlebars.handlebarstemplate.md rename to docs/templating/handlebars/api/proffer.templating.handlebars.handlebarstemplate.md diff --git a/docs/templating/handlebars/proffer.templating.handlebars.handlebarstemplateprovider.md b/docs/templating/handlebars/api/proffer.templating.handlebars.handlebarstemplateprovider.md similarity index 100% rename from docs/templating/handlebars/proffer.templating.handlebars.handlebarstemplateprovider.md rename to docs/templating/handlebars/api/proffer.templating.handlebars.handlebarstemplateprovider.md diff --git a/docs/templating/handlebars/proffer.templating.handlebarsservicecollectionextensions.md b/docs/templating/handlebars/api/proffer.templating.handlebarsservicecollectionextensions.md similarity index 100% rename from docs/templating/handlebars/proffer.templating.handlebarsservicecollectionextensions.md rename to docs/templating/handlebars/api/proffer.templating.handlebarsservicecollectionextensions.md diff --git a/docs/templating/mustache/api.md b/docs/templating/mustache/api/index.md similarity index 100% rename from docs/templating/mustache/api.md rename to docs/templating/mustache/api/index.md diff --git a/docs/templating/mustache/proffer.templating.mustache.mustachetemplate.md b/docs/templating/mustache/api/proffer.templating.mustache.mustachetemplate.md similarity index 100% rename from docs/templating/mustache/proffer.templating.mustache.mustachetemplate.md rename to docs/templating/mustache/api/proffer.templating.mustache.mustachetemplate.md diff --git a/docs/templating/mustache/proffer.templating.mustache.mustachetemplateprovider.md b/docs/templating/mustache/api/proffer.templating.mustache.mustachetemplateprovider.md similarity index 100% rename from docs/templating/mustache/proffer.templating.mustache.mustachetemplateprovider.md rename to docs/templating/mustache/api/proffer.templating.mustache.mustachetemplateprovider.md diff --git a/docs/templating/mustache/proffer.templating.mustacheservicecollectionextensions.md b/docs/templating/mustache/api/proffer.templating.mustacheservicecollectionextensions.md similarity index 100% rename from docs/templating/mustache/proffer.templating.mustacheservicecollectionextensions.md rename to docs/templating/mustache/api/proffer.templating.mustacheservicecollectionextensions.md diff --git a/src/Directory.Build.targets b/src/Directory.Build.targets index 85d7d67..1625a69 100644 --- a/src/Directory.Build.targets +++ b/src/Directory.Build.targets @@ -1,6 +1,6 @@ - + \ No newline at end of file From 7965a9bb4bb1237d4b9144b788d34c1d6c06d122 Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Sat, 22 May 2021 01:41:27 +0200 Subject: [PATCH 27/45] Core --- .vscode/extensions.json | 5 +++++ docs/_layouts/default.html | 18 ++++++++++++++---- docs/core/azure/index.md | 9 +++++++++ docs/core/index.md | 10 ++++++++++ docs/index.md | 5 ++++- docs/use-cases.md | 0 6 files changed, 42 insertions(+), 5 deletions(-) create mode 100644 .vscode/extensions.json create mode 100644 docs/core/azure/index.md create mode 100644 docs/core/index.md create mode 100644 docs/use-cases.md diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..4359a2c --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,5 @@ +{ + "recommendations": [ + "bierner.github-markdown-preview" + ] +} \ No newline at end of file diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 13f4075..bdf0572 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -58,14 +58,24 @@

{{ site.description | default: site.github.project_tagline }}

{% endif %} - {% if site.github.is_project_page %} -

{{ site.github.repository_name }} is maintained by {{ site.github.owner_name }}.

- {% endif %} - + {% if site.github.is_project_page %} +

{{ site.github.repository_name }} is maintained by {{ site.github.owner_name }}.

+ {% endif %} +

This page was generated by GitHub Pages.

diff --git a/docs/core/azure/index.md b/docs/core/azure/index.md new file mode 100644 index 0000000..10540fa --- /dev/null +++ b/docs/core/azure/index.md @@ -0,0 +1,9 @@ +# Core Azure library + +This library provides common abstractions for any Proffer provider connected to Azure Storage (like [Proffer.Storage.Azure.Blobs](../../storage/azure/blobs) or Proffer.Events.Azure.Queues). + +There is not much here until the configuration will be shared across all different projects. + +## API Documentation + +- [Proffer.Azure](./api) \ No newline at end of file diff --git a/docs/core/index.md b/docs/core/index.md new file mode 100644 index 0000000..f7e56ac --- /dev/null +++ b/docs/core/index.md @@ -0,0 +1,10 @@ +# Core libraries + +Those libraries provide common abstractions for any Proffer project or provider. + +There is not much here until the configuration will be shared across all different projects. + +## API Documentation + +- [Proffer](./api) +- [Proffer.Azure](./azure/api) diff --git a/docs/index.md b/docs/index.md index ac38724..f1a7b26 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,7 @@ -# Proffer +title: "Proffer" + +# Why Proffer? + ## Welcome to GitHub Pages diff --git a/docs/use-cases.md b/docs/use-cases.md new file mode 100644 index 0000000..e69de29 From 23c37681dcaa15d5a32e8d6e6ef712cef5f1c7cf Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Sat, 22 May 2021 01:48:23 +0200 Subject: [PATCH 28/45] Core --- docs/_layouts/default.html | 2 +- docs/api.md | 38 ++++++++++++------------------- docs/core/azure/index.md | 2 +- docs/core/index.md | 6 ++++- docs/storage/azure/blobs/index.md | 0 5 files changed, 21 insertions(+), 27 deletions(-) create mode 100644 docs/storage/azure/blobs/index.md diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index bdf0572..601f964 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -68,7 +68,7 @@

{{ site.description | default: site.github.project_tagline }}

  • Email
    • -
  • API Documentation
    • +
  • API documentation
  • Use cases
    • diff --git a/docs/api.md b/docs/api.md index 796b179..b449660 100644 --- a/docs/api.md +++ b/docs/api.md @@ -2,36 +2,26 @@ ## Core libraries -[Proffer](/core/api) - -[Proffer.Azure](/core/azure/api) +- [Proffer](/core/api) +- [Proffer.Azure](/core/azure/api) ## Storage -[Proffer.Storage](/storage/api) - -[Proffer.Storage.Azure.Blobs](/storage/azure/blobs/api) - -[Proffer.Storage.FileSystem](/storage/filesystem/api) - -[Proffer.Storage.FileSystem.Properties.Json](/storage/filesystem/properties/json/api) - -[Proffer.Storage.FileSystem.Server](/storage/filesystem/server/api) +- [Proffer.Storage](/storage/api) +- [Proffer.Storage.Azure.Blobs](/storage/azure/blobs/api) +- [Proffer.Storage.FileSystem](/storage/filesystem/api) +- [Proffer.Storage.FileSystem.Properties.Json](/storage/filesystem/- properties/json/api) +- [Proffer.Storage.FileSystem.Server](/storage/filesystem/server/api) ## Templating -[Proffer.Templating](/templating/api) - -[Proffer.Templating.Handlebars](/templating/handlebars/api) - -[Proffer.Templating.Mustache](/templating/mustache/api) +- [Proffer.Templating](/templating/api) +- [Proffer.Templating.Handlebars](/templating/handlebars/api) +- [Proffer.Templating.Mustache](/templating/mustache/api) ## Email -[Proffer.Email](/email/api) - -[Proffer.Email.Smtp](/email/smtp/api) - -[Proffer.Email.SendGrid](/email/sendgrid/api) - -[Proffer.Email.InMemory](/email/in-memory/api) +- [Proffer.Email](/email/api) +- [Proffer.Email.Smtp](/email/smtp/api) +- [Proffer.Email.SendGrid](/email/sendgrid/api) +- [Proffer.Email.InMemory](/email/in-memory/api) diff --git a/docs/core/azure/index.md b/docs/core/azure/index.md index 10540fa..838c806 100644 --- a/docs/core/azure/index.md +++ b/docs/core/azure/index.md @@ -4,6 +4,6 @@ This library provides common abstractions for any Proffer provider connected to There is not much here until the configuration will be shared across all different projects. -## API Documentation +## API documentation - [Proffer.Azure](./api) \ No newline at end of file diff --git a/docs/core/index.md b/docs/core/index.md index f7e56ac..e05a7f8 100644 --- a/docs/core/index.md +++ b/docs/core/index.md @@ -4,7 +4,11 @@ Those libraries provide common abstractions for any Proffer project or provider. There is not much here until the configuration will be shared across all different projects. -## API Documentation +## Projects + +- [Proffer.Azure](./azure) + +## API documentation - [Proffer](./api) - [Proffer.Azure](./azure/api) diff --git a/docs/storage/azure/blobs/index.md b/docs/storage/azure/blobs/index.md new file mode 100644 index 0000000..e69de29 From f664f9b6500466da6b1d2b09639bb6f4130d64ec Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Sat, 22 May 2021 02:20:02 +0200 Subject: [PATCH 29/45] Change theme --- docs/Gemfile | 4 ++++ docs/_config.yml | 5 ++++- docs/_layouts/{default.html => default2.html} | 0 docs/api.md | 2 +- docs/index.md | 2 ++ 5 files changed, 11 insertions(+), 2 deletions(-) create mode 100644 docs/Gemfile rename docs/_layouts/{default.html => default2.html} (100%) diff --git a/docs/Gemfile b/docs/Gemfile new file mode 100644 index 0000000..595e3be --- /dev/null +++ b/docs/Gemfile @@ -0,0 +1,4 @@ +source "https://rubygems.org" + +gem "github-pages", group: :jekyll_plugins +gem "jekyll-include-cache", group: :jekyll_plugins \ No newline at end of file diff --git a/docs/_config.yml b/docs/_config.yml index c007852..d914bfb 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,4 +1,4 @@ -theme: jekyll-theme-architect +remote_theme: "mmistakes/minimal-mistakes@4.23.0" main_color: "#5c2d91" show_downloads: true show_title: false @@ -22,3 +22,6 @@ defaults: path: "" values: image: /assets/img/banner.png + +plugins: + - jekyll-include-cache \ No newline at end of file diff --git a/docs/_layouts/default.html b/docs/_layouts/default2.html similarity index 100% rename from docs/_layouts/default.html rename to docs/_layouts/default2.html diff --git a/docs/api.md b/docs/api.md index b449660..09f034e 100644 --- a/docs/api.md +++ b/docs/api.md @@ -10,7 +10,7 @@ - [Proffer.Storage](/storage/api) - [Proffer.Storage.Azure.Blobs](/storage/azure/blobs/api) - [Proffer.Storage.FileSystem](/storage/filesystem/api) -- [Proffer.Storage.FileSystem.Properties.Json](/storage/filesystem/- properties/json/api) +- [Proffer.Storage.FileSystem.Properties.Json](/storage/filesystem/properties/json/api) - [Proffer.Storage.FileSystem.Server](/storage/filesystem/server/api) ## Templating diff --git a/docs/index.md b/docs/index.md index f1a7b26..c2ab510 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,6 @@ +--- title: "Proffer" +--- # Why Proffer? From 3fbc145717e05c8ebee0cc41a3d331edca460a30 Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Sat, 22 May 2021 02:36:31 +0200 Subject: [PATCH 30/45] Config.yml for theme --- docs/_config.yml | 255 ++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 241 insertions(+), 14 deletions(-) diff --git a/docs/_config.yml b/docs/_config.yml index d914bfb..0b36195 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,27 +1,254 @@ -remote_theme: "mmistakes/minimal-mistakes@4.23.0" -main_color: "#5c2d91" -show_downloads: true -show_title: false +# Welcome to Jekyll! +# +# This config file is meant for settings that affect your entire site, values +# which you are expected to set up once and rarely need to edit after that. +# For technical reasons, this file is *NOT* reloaded automatically when you use +# `jekyll serve`. If you change this file, please restart the server process. -title: Proffer -logo: /assets/img/logo.png -banner: /assets/img/banner.png +# Theme Settings +# +# Review documentation to determine if you should use `theme` or `remote_theme` +# https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/#installing-the-theme -author: asiffermann +# theme : "minimal-mistakes-jekyll" +remote_theme : "mmistakes/minimal-mistakes" +minimal_mistakes_skin : "default" # "air", "aqua", "contrast", "dark", "dirt", "neon", "mint", "plum", "sunrise" + +# Site Settings +locale : "en-US" +title : "Proffer" +title_separator : "-" +subtitle : # site tagline that appears below site title in masthead +name : "Your Name" +description : "An amazing website." +url : # the base hostname & protocol for your site e.g. "https://mmistakes.github.io" +baseurl : # the subpath of your site, e.g. "/blog" +repository : # GitHub username/repo-name e.g. "mmistakes/minimal-mistakes" +teaser : # path of fallback teaser image, e.g. "/assets/images/500x300.png" +logo : /assets/img/logo.png # path of logo image to display in the masthead, e.g. "/assets/images/88x88.png" +masthead_title : # overrides the website title displayed in the masthead, use " " for no title +# breadcrumbs : false # true, false (default) +words_per_minute : 200 +comments: + provider : # false (default), "disqus", "discourse", "facebook", "staticman", "staticman_v2", "utterances", "custom" + disqus: + shortname : # https://help.disqus.com/customer/portal/articles/466208-what-s-a-shortname- + discourse: + server : # https://meta.discourse.org/t/embedding-discourse-comments-via-javascript/31963 , e.g.: meta.discourse.org + facebook: + # https://developers.facebook.com/docs/plugins/comments + appid : + num_posts : # 5 (default) + colorscheme : # "light" (default), "dark" + utterances: + theme : # "github-light" (default), "github-dark" + issue_term : # "pathname" (default) + staticman: + branch : # "master" + endpoint : # "https://{your Staticman v3 API}/v3/entry/github/" +reCaptcha: + siteKey : + secret : +atom_feed: + path : # blank (default) uses feed.xml + hide : # true, false (default) +search : # true, false (default) +search_full_content : # true, false (default) +search_provider : # lunr (default), algolia, google +algolia: + application_id : # YOUR_APPLICATION_ID + index_name : # YOUR_INDEX_NAME + search_only_api_key : # YOUR_SEARCH_ONLY_API_KEY + powered_by : # true (default), false +google: + search_engine_id : # YOUR_SEARCH_ENGINE_ID + instant_search : # false (default), true +# SEO Related +google_site_verification : +bing_site_verification : +yandex_site_verification : +naver_site_verification : + +# Social Sharing twitter: - username: proffer_dotnet - card: summary_large_image + username : proffer_dotnet + card : summary_large_image +facebook: + username : + app_id : + publisher : +og_image : /assets/img/banner.png # Open Graph/Twitter default site image +# For specifying social profiles +# - https://developers.google.com/structured-data/customize/social-profiles social: - name: Proffer + type : Organization + name : Proffer links: - https://github.com/asiffermann/proffer - https://twitter.com/proffer_dotnet +# Analytics +analytics: + provider : false # false (default), "google", "google-universal", "google-gtag", "custom" + google: + tracking_id : + anonymize_ip : # true, false (default) + + +# Site Author +author: asiffermann + + +# Site Footer +footer: + links: + - label: "Twitter" + icon: "fab fa-fw fa-twitter-square" + url: https://twitter.com/proffer_dotnet + - label: "GitHub" + icon: "fab fa-fw fa-github" + url: https://github.com/asiffermann/proffer + + +# Reading Files +include: + - .htaccess + - _pages +exclude: + - "*.sublime-project" + - "*.sublime-workspace" + - vendor + - .asset-cache + - .bundle + - .jekyll-assets-cache + - .sass-cache + - assets/js/plugins + - assets/js/_main.js + - assets/js/vendor + - Capfile + - CHANGELOG + - config + - Gemfile + - Gruntfile.js + - gulpfile.js + - LICENSE + - log + - node_modules + - package.json + - package-lock.json + - Rakefile + - README + - tmp + - /docs # ignore Minimal Mistakes /docs + - /test # ignore Minimal Mistakes /test +keep_files: + - .git + - .svn +encoding: "utf-8" +markdown_ext: "markdown,mkdown,mkdn,mkd,md" + + +# Conversion +markdown: kramdown +highlighter: rouge +lsi: false +excerpt_separator: "\n\n" +incremental: false + + +# Markdown Processing +kramdown: + input: GFM + hard_wrap: false + auto_ids: true + footnote_nr: 1 + entity_output: as_char + toc_levels: 1..6 + smart_quotes: lsquo,rsquo,ldquo,rdquo + enable_coderay: false + + +# Sass/SCSS +sass: + sass_dir: _sass + style: compressed # https://sass-lang.com/documentation/file.SASS_REFERENCE.html#output_style + + +# Outputting +permalink: /:categories/:title/ +paginate: 5 # amount of posts to show +paginate_path: /page:num/ +timezone: # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones + + +# Plugins (previously gems:) +plugins: + - jekyll-paginate + - jekyll-sitemap + - jekyll-gist + - jekyll-feed + - jekyll-include-cache + +# mimic GitHub Pages with --safe +whitelist: + - jekyll-paginate + - jekyll-sitemap + - jekyll-gist + - jekyll-feed + - jekyll-include-cache + + +# Archives +# Type +# - GitHub Pages compatible archive pages built with Liquid ~> type: liquid (default) +# - Jekyll Archives plugin archive pages ~> type: jekyll-archives +# Path (examples) +# - Archive page should exist at path when using Liquid method or you can +# expect broken links (especially with breadcrumbs enabled) +# - /tags/my-awesome-tag/index.html ~> path: /tags/ +# - /categories/my-awesome-category/index.html ~> path: /categories/ +# - /my-awesome-category/index.html ~> path: / +category_archive: + type: liquid + path: /categories/ +tag_archive: + type: liquid + path: /tags/ +# https://github.com/jekyll/jekyll-archives +# jekyll-archives: +# enabled: +# - categories +# - tags +# layouts: +# category: archive-taxonomy +# tag: archive-taxonomy +# permalinks: +# category: /categories/:name/ +# tag: /tags/:name/ + + +# HTML Compression +# - https://jch.penibelst.de/ +compress_html: + clippings: all + ignore: + envs: development + + +# Defaults defaults: - scope: path: "" values: image: /assets/img/banner.png - -plugins: - - jekyll-include-cache \ No newline at end of file + # _posts + - scope: + path: "" + type: posts + values: + layout: single + author_profile: true + read_time: true + comments: # true + share: true + related: true From 307b02254345656220920483eb358a378a9379a2 Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Sat, 22 May 2021 02:49:02 +0200 Subject: [PATCH 31/45] Move pages again --- docs/_config.yml | 7 ++++++- docs/{ => _pages}/core/api/index.md | 0 .../core/api/proffer.configuration.inamedelementoptions.md | 0 .../core/api/proffer.configuration.ioptionerror.md | 0 .../core/api/proffer.configuration.iprovideroptions.md | 0 .../core/api/proffer.configuration.optionerror.md | 0 .../core/api/proffer.configuration.provideroptions.md | 0 .../core/api/proffer.equalitycomparerbase-1.md | 0 docs/{ => _pages}/core/azure/api/index.md | 0 .../proffer.azure.configuration.iazurestorageoptions.md | 0 docs/{ => _pages}/core/azure/index.md | 0 docs/{ => _pages}/core/index.md | 0 docs/{ => _pages}/email/api/index.md | 0 docs/{ => _pages}/email/api/proffer.email.emailoptions.md | 0 .../email/api/proffer.email.emailprovideroptions.md | 0 .../api/proffer.email.emailservicecollectionextensions.md | 0 .../email/api/proffer.email.emailtemplatetype.md | 0 docs/{ => _pages}/email/api/proffer.email.iemailaddress.md | 0 .../email/api/proffer.email.iemailattachment.md | 0 .../{ => _pages}/email/api/proffer.email.iemailprovider.md | 0 .../email/api/proffer.email.iemailprovideroptions.md | 0 .../email/api/proffer.email.iemailprovidertype.md | 0 docs/{ => _pages}/email/api/proffer.email.iemailsender.md | 0 .../email/api/proffer.email.internal.emailaddress.md | 0 .../proffer.email.internal.emailaddressequalitycomparer.md | 0 ...er.email.internal.emailaddressstrictequalitycomparer.md | 0 .../email/api/proffer.email.internal.emailattachment.md | 0 ...offer.email.internal.emailattachmentequalitycomparer.md | 0 .../email/api/proffer.email.internal.emailsender.md | 0 .../email/api/proffer.email.mockupexceptionsoptions.md | 0 docs/{ => _pages}/email/api/proffer.email.mockupoptions.md | 0 docs/{ => _pages}/email/in-memory/api/index.md | 0 .../api/proffer.email.inmemory.iinmemoryemailrepository.md | 0 .../in-memory/api/proffer.email.inmemory.inmemoryemail.md | 0 .../api/proffer.email.inmemory.inmemoryemailprovider.md | 0 .../proffer.email.inmemory.inmemoryemailprovidertype.md | 0 .../api/proffer.email.inmemory.inmemoryemailrepository.md | 0 ...offer.email.inmemoryemailservicecollectionextensions.md | 0 docs/{ => _pages}/email/sendgrid/api/index.md | 0 .../api/proffer.email.sendgrid.sendgridemailprovider.md | 0 .../proffer.email.sendgrid.sendgridemailprovidertype.md | 0 .../api/proffer.email.servicecollectionextensions.md | 0 docs/{ => _pages}/email/smtp/api/index.md | 0 .../email/smtp/api/proffer.email.smtp.smtpemailprovider.md | 0 .../smtp/api/proffer.email.smtp.smtpemailprovidertype.md | 0 .../proffer.email.smtpemailservicecollectionextensions.md | 0 docs/{ => _pages}/storage/api/index.md | 0 .../api/proffer.storage.configuration.accesslevel.md | 0 ...roffer.storage.configuration.configurationextensions.md | 0 .../api/proffer.storage.configuration.iparsedoptions-3.md | 0 .../proffer.storage.configuration.iscopedstoreoptions.md | 0 .../api/proffer.storage.configuration.istoreoptions.md | 0 .../proffer.storage.configuration.scopedstoreoptions.md | 0 .../api/proffer.storage.configuration.storageoptions.md | 0 .../api/proffer.storage.configuration.storeoptions.md | 0 .../proffer.storage.exceptions.badproviderconfiguration.md | 0 ...offer.storage.exceptions.badscopedstoreconfiguration.md | 0 .../proffer.storage.exceptions.badstoreconfiguration.md | 0 ...roffer.storage.exceptions.filealreadyexistsexception.md | 0 ...proffer.storage.exceptions.providernotfoundexception.md | 0 .../proffer.storage.exceptions.storenotfoundexception.md | 0 .../storage/api/proffer.storage.ifileproperties.md | 0 .../storage/api/proffer.storage.ifilereference.md | 0 .../proffer.storage.internal.configureprovideroptions-4.md | 0 .../api/proffer.storage.internal.genericstoreproxy-1.md | 0 .../api/proffer.storage.internal.privatefilereference.md | 0 .../storage/api/proffer.storage.internal.storagefactory.md | 0 .../api/proffer.storage.internal.storageproviderbase-4.md | 0 .../storage/api/proffer.storage.iprivatefilereference.md | 0 .../storage/api/proffer.storage.isharedaccesspolicy.md | 0 .../storage/api/proffer.storage.istoragefactory.md | 0 .../storage/api/proffer.storage.istorageprovider.md | 0 docs/{ => _pages}/storage/api/proffer.storage.istore-1.md | 0 docs/{ => _pages}/storage/api/proffer.storage.istore.md | 0 .../storage/api/proffer.storage.istoreextensions.md | 0 .../storage/api/proffer.storage.overwritepolicy.md | 0 .../storage/api/proffer.storage.sharedaccesspermissions.md | 0 .../storage/api/proffer.storage.sharedaccesspolicy.md | 0 .../proffer.storage.storageservicecollectionextensions.md | 0 docs/{ => _pages}/storage/api/proffer.storage.storebase.md | 0 docs/{ => _pages}/storage/azure/blobs/api/index.md | 0 ...roffer.storage.azure.blobs.azureblobsstorageprovider.md | 0 .../api/proffer.storage.azure.blobs.azureblobsstore.md | 0 ...ge.azure.blobs.configuration.azureblobsparsedoptions.md | 0 ....azure.blobs.configuration.azureblobsprovideroptions.md | 0 ...ure.blobs.configuration.azureblobsscopedstoreoptions.md | 0 ...age.azure.blobs.configuration.azureblobsstoreoptions.md | 0 ...torage.azure.blobs.internal.azureblobsfileproperties.md | 0 ...storage.azure.blobs.internal.azureblobsfilereference.md | 0 ....azure.blobs.internal.azureblobslistdirectorywrapper.md | 0 ...orage.azure.blobs.internal.azureblobslistfilewrapper.md | 0 ...storage.azureblobsstorageservicecollectionextensions.md | 0 docs/{ => _pages}/storage/azure/blobs/index.md | 0 docs/{ => _pages}/storage/filesystem/api/index.md | 0 ...age.filesystem.configuration.filesystemparsedoptions.md | 0 ...e.filesystem.configuration.filesystemprovideroptions.md | 0 ...ilesystem.configuration.filesystemscopedstoreoptions.md | 0 ...rage.filesystem.configuration.filesystemstoreoptions.md | 0 ...proffer.storage.filesystem.filesystemstorageprovider.md | 0 .../api/proffer.storage.filesystem.filesystemstore.md | 0 ...offer.storage.filesystem.iextendedpropertiesprovider.md | 0 ...r.storage.filesystem.internal.fileextendedproperties.md | 0 ...storage.filesystem.internal.filesystemfileproperties.md | 0 ....storage.filesystem.internal.filesystemfilereference.md | 0 .../api/proffer.storage.filesystem.ipublicurlprovider.md | 0 ...ffer.storage.filesystem.noextendedpropertiesprovider.md | 0 ...storage.filesystemstorageservicecollectionextensions.md | 0 .../storage/filesystem/properties/json/api/index.md | 0 ...stem.properties.json.filesystempropertiesjsonoptions.md | 0 ....properties.json.internal.extendedpropertiesprovider.md | 0 ....filesystempropertiesjsonservicecollectionextensions.md | 0 docs/{ => _pages}/storage/filesystem/server/api/index.md | 0 ....filesystem.server.filesystemstorageservermiddleware.md | 0 ...age.filesystem.server.filesystemstorageserveroptions.md | 0 ...storage.filesystem.server.internal.publicurlprovider.md | 0 .../api/proffer.storage.servicecollectionextensions.md | 0 docs/{ => _pages}/templating/api/index.md | 0 ...ffer.templating.exceptions.providernotfoundexception.md | 0 ...ffer.templating.exceptions.templatenotfoundexception.md | 0 .../api/proffer.templating.internal.templateloader.md | 0 .../proffer.templating.internal.templateloaderfactory.md | 0 .../api/proffer.templating.invalidcontextexception.md | 0 .../templating/api/proffer.templating.itemplate.md | 0 .../templating/api/proffer.templating.itemplateloader.md | 0 .../api/proffer.templating.itemplateloaderfactory.md | 0 .../templating/api/proffer.templating.itemplateprovider.md | 0 .../api/proffer.templating.itemplateproviderscope.md | 0 .../api/proffer.templating.templatecollectionbase-1.md | 0 .../api/proffer.templating.templatecollectionbase.md | 0 ...fer.templating.templatingservicecollectionextensions.md | 0 docs/{ => _pages}/templating/handlebars/api/index.md | 0 .../proffer.templating.handlebars.handlebarstemplate.md | 0 ...fer.templating.handlebars.handlebarstemplateprovider.md | 0 ...fer.templating.handlebarsservicecollectionextensions.md | 0 docs/{ => _pages}/templating/mustache/api/index.md | 0 .../api/proffer.templating.mustache.mustachetemplate.md | 0 ...proffer.templating.mustache.mustachetemplateprovider.md | 0 ...offer.templating.mustacheservicecollectionextensions.md | 0 src/Directory.Build.targets | 2 +- 139 files changed, 7 insertions(+), 2 deletions(-) rename docs/{ => _pages}/core/api/index.md (100%) rename docs/{ => _pages}/core/api/proffer.configuration.inamedelementoptions.md (100%) rename docs/{ => _pages}/core/api/proffer.configuration.ioptionerror.md (100%) rename docs/{ => _pages}/core/api/proffer.configuration.iprovideroptions.md (100%) rename docs/{ => _pages}/core/api/proffer.configuration.optionerror.md (100%) rename docs/{ => _pages}/core/api/proffer.configuration.provideroptions.md (100%) rename docs/{ => _pages}/core/api/proffer.equalitycomparerbase-1.md (100%) rename docs/{ => _pages}/core/azure/api/index.md (100%) rename docs/{ => _pages}/core/azure/api/proffer.azure.configuration.iazurestorageoptions.md (100%) rename docs/{ => _pages}/core/azure/index.md (100%) rename docs/{ => _pages}/core/index.md (100%) rename docs/{ => _pages}/email/api/index.md (100%) rename docs/{ => _pages}/email/api/proffer.email.emailoptions.md (100%) rename docs/{ => _pages}/email/api/proffer.email.emailprovideroptions.md (100%) rename docs/{ => _pages}/email/api/proffer.email.emailservicecollectionextensions.md (100%) rename docs/{ => _pages}/email/api/proffer.email.emailtemplatetype.md (100%) rename docs/{ => _pages}/email/api/proffer.email.iemailaddress.md (100%) rename docs/{ => _pages}/email/api/proffer.email.iemailattachment.md (100%) rename docs/{ => _pages}/email/api/proffer.email.iemailprovider.md (100%) rename docs/{ => _pages}/email/api/proffer.email.iemailprovideroptions.md (100%) rename docs/{ => _pages}/email/api/proffer.email.iemailprovidertype.md (100%) rename docs/{ => _pages}/email/api/proffer.email.iemailsender.md (100%) rename docs/{ => _pages}/email/api/proffer.email.internal.emailaddress.md (100%) rename docs/{ => _pages}/email/api/proffer.email.internal.emailaddressequalitycomparer.md (100%) rename docs/{ => _pages}/email/api/proffer.email.internal.emailaddressstrictequalitycomparer.md (100%) rename docs/{ => _pages}/email/api/proffer.email.internal.emailattachment.md (100%) rename docs/{ => _pages}/email/api/proffer.email.internal.emailattachmentequalitycomparer.md (100%) rename docs/{ => _pages}/email/api/proffer.email.internal.emailsender.md (100%) rename docs/{ => _pages}/email/api/proffer.email.mockupexceptionsoptions.md (100%) rename docs/{ => _pages}/email/api/proffer.email.mockupoptions.md (100%) rename docs/{ => _pages}/email/in-memory/api/index.md (100%) rename docs/{ => _pages}/email/in-memory/api/proffer.email.inmemory.iinmemoryemailrepository.md (100%) rename docs/{ => _pages}/email/in-memory/api/proffer.email.inmemory.inmemoryemail.md (100%) rename docs/{ => _pages}/email/in-memory/api/proffer.email.inmemory.inmemoryemailprovider.md (100%) rename docs/{ => _pages}/email/in-memory/api/proffer.email.inmemory.inmemoryemailprovidertype.md (100%) rename docs/{ => _pages}/email/in-memory/api/proffer.email.inmemory.inmemoryemailrepository.md (100%) rename docs/{ => _pages}/email/in-memory/api/proffer.email.inmemoryemailservicecollectionextensions.md (100%) rename docs/{ => _pages}/email/sendgrid/api/index.md (100%) rename docs/{ => _pages}/email/sendgrid/api/proffer.email.sendgrid.sendgridemailprovider.md (100%) rename docs/{ => _pages}/email/sendgrid/api/proffer.email.sendgrid.sendgridemailprovidertype.md (100%) rename docs/{ => _pages}/email/sendgrid/api/proffer.email.servicecollectionextensions.md (100%) rename docs/{ => _pages}/email/smtp/api/index.md (100%) rename docs/{ => _pages}/email/smtp/api/proffer.email.smtp.smtpemailprovider.md (100%) rename docs/{ => _pages}/email/smtp/api/proffer.email.smtp.smtpemailprovidertype.md (100%) rename docs/{ => _pages}/email/smtp/api/proffer.email.smtpemailservicecollectionextensions.md (100%) rename docs/{ => _pages}/storage/api/index.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.configuration.accesslevel.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.configuration.configurationextensions.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.configuration.iparsedoptions-3.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.configuration.iscopedstoreoptions.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.configuration.istoreoptions.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.configuration.scopedstoreoptions.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.configuration.storageoptions.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.configuration.storeoptions.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.exceptions.badproviderconfiguration.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.exceptions.badscopedstoreconfiguration.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.exceptions.badstoreconfiguration.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.exceptions.filealreadyexistsexception.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.exceptions.providernotfoundexception.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.exceptions.storenotfoundexception.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.ifileproperties.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.ifilereference.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.internal.configureprovideroptions-4.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.internal.genericstoreproxy-1.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.internal.privatefilereference.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.internal.storagefactory.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.internal.storageproviderbase-4.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.iprivatefilereference.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.isharedaccesspolicy.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.istoragefactory.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.istorageprovider.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.istore-1.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.istore.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.istoreextensions.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.overwritepolicy.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.sharedaccesspermissions.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.sharedaccesspolicy.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.storageservicecollectionextensions.md (100%) rename docs/{ => _pages}/storage/api/proffer.storage.storebase.md (100%) rename docs/{ => _pages}/storage/azure/blobs/api/index.md (100%) rename docs/{ => _pages}/storage/azure/blobs/api/proffer.storage.azure.blobs.azureblobsstorageprovider.md (100%) rename docs/{ => _pages}/storage/azure/blobs/api/proffer.storage.azure.blobs.azureblobsstore.md (100%) rename docs/{ => _pages}/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md (100%) rename docs/{ => _pages}/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md (100%) rename docs/{ => _pages}/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md (100%) rename docs/{ => _pages}/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md (100%) rename docs/{ => _pages}/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md (100%) rename docs/{ => _pages}/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobsfilereference.md (100%) rename docs/{ => _pages}/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md (100%) rename docs/{ => _pages}/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md (100%) rename docs/{ => _pages}/storage/azure/blobs/api/proffer.storage.azureblobsstorageservicecollectionextensions.md (100%) rename docs/{ => _pages}/storage/azure/blobs/index.md (100%) rename docs/{ => _pages}/storage/filesystem/api/index.md (100%) rename docs/{ => _pages}/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemparsedoptions.md (100%) rename docs/{ => _pages}/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemprovideroptions.md (100%) rename docs/{ => _pages}/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md (100%) rename docs/{ => _pages}/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemstoreoptions.md (100%) rename docs/{ => _pages}/storage/filesystem/api/proffer.storage.filesystem.filesystemstorageprovider.md (100%) rename docs/{ => _pages}/storage/filesystem/api/proffer.storage.filesystem.filesystemstore.md (100%) rename docs/{ => _pages}/storage/filesystem/api/proffer.storage.filesystem.iextendedpropertiesprovider.md (100%) rename docs/{ => _pages}/storage/filesystem/api/proffer.storage.filesystem.internal.fileextendedproperties.md (100%) rename docs/{ => _pages}/storage/filesystem/api/proffer.storage.filesystem.internal.filesystemfileproperties.md (100%) rename docs/{ => _pages}/storage/filesystem/api/proffer.storage.filesystem.internal.filesystemfilereference.md (100%) rename docs/{ => _pages}/storage/filesystem/api/proffer.storage.filesystem.ipublicurlprovider.md (100%) rename docs/{ => _pages}/storage/filesystem/api/proffer.storage.filesystem.noextendedpropertiesprovider.md (100%) rename docs/{ => _pages}/storage/filesystem/api/proffer.storage.filesystemstorageservicecollectionextensions.md (100%) rename docs/{ => _pages}/storage/filesystem/properties/json/api/index.md (100%) rename docs/{ => _pages}/storage/filesystem/properties/json/api/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md (100%) rename docs/{ => _pages}/storage/filesystem/properties/json/api/proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md (100%) rename docs/{ => _pages}/storage/filesystem/properties/json/api/proffer.storage.filesystempropertiesjsonservicecollectionextensions.md (100%) rename docs/{ => _pages}/storage/filesystem/server/api/index.md (100%) rename docs/{ => _pages}/storage/filesystem/server/api/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md (100%) rename docs/{ => _pages}/storage/filesystem/server/api/proffer.storage.filesystem.server.filesystemstorageserveroptions.md (100%) rename docs/{ => _pages}/storage/filesystem/server/api/proffer.storage.filesystem.server.internal.publicurlprovider.md (100%) rename docs/{ => _pages}/storage/filesystem/server/api/proffer.storage.servicecollectionextensions.md (100%) rename docs/{ => _pages}/templating/api/index.md (100%) rename docs/{ => _pages}/templating/api/proffer.templating.exceptions.providernotfoundexception.md (100%) rename docs/{ => _pages}/templating/api/proffer.templating.exceptions.templatenotfoundexception.md (100%) rename docs/{ => _pages}/templating/api/proffer.templating.internal.templateloader.md (100%) rename docs/{ => _pages}/templating/api/proffer.templating.internal.templateloaderfactory.md (100%) rename docs/{ => _pages}/templating/api/proffer.templating.invalidcontextexception.md (100%) rename docs/{ => _pages}/templating/api/proffer.templating.itemplate.md (100%) rename docs/{ => _pages}/templating/api/proffer.templating.itemplateloader.md (100%) rename docs/{ => _pages}/templating/api/proffer.templating.itemplateloaderfactory.md (100%) rename docs/{ => _pages}/templating/api/proffer.templating.itemplateprovider.md (100%) rename docs/{ => _pages}/templating/api/proffer.templating.itemplateproviderscope.md (100%) rename docs/{ => _pages}/templating/api/proffer.templating.templatecollectionbase-1.md (100%) rename docs/{ => _pages}/templating/api/proffer.templating.templatecollectionbase.md (100%) rename docs/{ => _pages}/templating/api/proffer.templating.templatingservicecollectionextensions.md (100%) rename docs/{ => _pages}/templating/handlebars/api/index.md (100%) rename docs/{ => _pages}/templating/handlebars/api/proffer.templating.handlebars.handlebarstemplate.md (100%) rename docs/{ => _pages}/templating/handlebars/api/proffer.templating.handlebars.handlebarstemplateprovider.md (100%) rename docs/{ => _pages}/templating/handlebars/api/proffer.templating.handlebarsservicecollectionextensions.md (100%) rename docs/{ => _pages}/templating/mustache/api/index.md (100%) rename docs/{ => _pages}/templating/mustache/api/proffer.templating.mustache.mustachetemplate.md (100%) rename docs/{ => _pages}/templating/mustache/api/proffer.templating.mustache.mustachetemplateprovider.md (100%) rename docs/{ => _pages}/templating/mustache/api/proffer.templating.mustacheservicecollectionextensions.md (100%) diff --git a/docs/_config.yml b/docs/_config.yml index 0b36195..a198059 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -12,7 +12,7 @@ # theme : "minimal-mistakes-jekyll" remote_theme : "mmistakes/minimal-mistakes" -minimal_mistakes_skin : "default" # "air", "aqua", "contrast", "dark", "dirt", "neon", "mint", "plum", "sunrise" +minimal_mistakes_skin : "dark" # "air", "aqua", "contrast", "dark", "dirt", "neon", "mint", "plum", "sunrise" # Site Settings locale : "en-US" @@ -252,3 +252,8 @@ defaults: comments: # true share: true related: true + - scope: + path: _pages + values: + layout: single + permalink: /:basename/ diff --git a/docs/core/api/index.md b/docs/_pages/core/api/index.md similarity index 100% rename from docs/core/api/index.md rename to docs/_pages/core/api/index.md diff --git a/docs/core/api/proffer.configuration.inamedelementoptions.md b/docs/_pages/core/api/proffer.configuration.inamedelementoptions.md similarity index 100% rename from docs/core/api/proffer.configuration.inamedelementoptions.md rename to docs/_pages/core/api/proffer.configuration.inamedelementoptions.md diff --git a/docs/core/api/proffer.configuration.ioptionerror.md b/docs/_pages/core/api/proffer.configuration.ioptionerror.md similarity index 100% rename from docs/core/api/proffer.configuration.ioptionerror.md rename to docs/_pages/core/api/proffer.configuration.ioptionerror.md diff --git a/docs/core/api/proffer.configuration.iprovideroptions.md b/docs/_pages/core/api/proffer.configuration.iprovideroptions.md similarity index 100% rename from docs/core/api/proffer.configuration.iprovideroptions.md rename to docs/_pages/core/api/proffer.configuration.iprovideroptions.md diff --git a/docs/core/api/proffer.configuration.optionerror.md b/docs/_pages/core/api/proffer.configuration.optionerror.md similarity index 100% rename from docs/core/api/proffer.configuration.optionerror.md rename to docs/_pages/core/api/proffer.configuration.optionerror.md diff --git a/docs/core/api/proffer.configuration.provideroptions.md b/docs/_pages/core/api/proffer.configuration.provideroptions.md similarity index 100% rename from docs/core/api/proffer.configuration.provideroptions.md rename to docs/_pages/core/api/proffer.configuration.provideroptions.md diff --git a/docs/core/api/proffer.equalitycomparerbase-1.md b/docs/_pages/core/api/proffer.equalitycomparerbase-1.md similarity index 100% rename from docs/core/api/proffer.equalitycomparerbase-1.md rename to docs/_pages/core/api/proffer.equalitycomparerbase-1.md diff --git a/docs/core/azure/api/index.md b/docs/_pages/core/azure/api/index.md similarity index 100% rename from docs/core/azure/api/index.md rename to docs/_pages/core/azure/api/index.md diff --git a/docs/core/azure/api/proffer.azure.configuration.iazurestorageoptions.md b/docs/_pages/core/azure/api/proffer.azure.configuration.iazurestorageoptions.md similarity index 100% rename from docs/core/azure/api/proffer.azure.configuration.iazurestorageoptions.md rename to docs/_pages/core/azure/api/proffer.azure.configuration.iazurestorageoptions.md diff --git a/docs/core/azure/index.md b/docs/_pages/core/azure/index.md similarity index 100% rename from docs/core/azure/index.md rename to docs/_pages/core/azure/index.md diff --git a/docs/core/index.md b/docs/_pages/core/index.md similarity index 100% rename from docs/core/index.md rename to docs/_pages/core/index.md diff --git a/docs/email/api/index.md b/docs/_pages/email/api/index.md similarity index 100% rename from docs/email/api/index.md rename to docs/_pages/email/api/index.md diff --git a/docs/email/api/proffer.email.emailoptions.md b/docs/_pages/email/api/proffer.email.emailoptions.md similarity index 100% rename from docs/email/api/proffer.email.emailoptions.md rename to docs/_pages/email/api/proffer.email.emailoptions.md diff --git a/docs/email/api/proffer.email.emailprovideroptions.md b/docs/_pages/email/api/proffer.email.emailprovideroptions.md similarity index 100% rename from docs/email/api/proffer.email.emailprovideroptions.md rename to docs/_pages/email/api/proffer.email.emailprovideroptions.md diff --git a/docs/email/api/proffer.email.emailservicecollectionextensions.md b/docs/_pages/email/api/proffer.email.emailservicecollectionextensions.md similarity index 100% rename from docs/email/api/proffer.email.emailservicecollectionextensions.md rename to docs/_pages/email/api/proffer.email.emailservicecollectionextensions.md diff --git a/docs/email/api/proffer.email.emailtemplatetype.md b/docs/_pages/email/api/proffer.email.emailtemplatetype.md similarity index 100% rename from docs/email/api/proffer.email.emailtemplatetype.md rename to docs/_pages/email/api/proffer.email.emailtemplatetype.md diff --git a/docs/email/api/proffer.email.iemailaddress.md b/docs/_pages/email/api/proffer.email.iemailaddress.md similarity index 100% rename from docs/email/api/proffer.email.iemailaddress.md rename to docs/_pages/email/api/proffer.email.iemailaddress.md diff --git a/docs/email/api/proffer.email.iemailattachment.md b/docs/_pages/email/api/proffer.email.iemailattachment.md similarity index 100% rename from docs/email/api/proffer.email.iemailattachment.md rename to docs/_pages/email/api/proffer.email.iemailattachment.md diff --git a/docs/email/api/proffer.email.iemailprovider.md b/docs/_pages/email/api/proffer.email.iemailprovider.md similarity index 100% rename from docs/email/api/proffer.email.iemailprovider.md rename to docs/_pages/email/api/proffer.email.iemailprovider.md diff --git a/docs/email/api/proffer.email.iemailprovideroptions.md b/docs/_pages/email/api/proffer.email.iemailprovideroptions.md similarity index 100% rename from docs/email/api/proffer.email.iemailprovideroptions.md rename to docs/_pages/email/api/proffer.email.iemailprovideroptions.md diff --git a/docs/email/api/proffer.email.iemailprovidertype.md b/docs/_pages/email/api/proffer.email.iemailprovidertype.md similarity index 100% rename from docs/email/api/proffer.email.iemailprovidertype.md rename to docs/_pages/email/api/proffer.email.iemailprovidertype.md diff --git a/docs/email/api/proffer.email.iemailsender.md b/docs/_pages/email/api/proffer.email.iemailsender.md similarity index 100% rename from docs/email/api/proffer.email.iemailsender.md rename to docs/_pages/email/api/proffer.email.iemailsender.md diff --git a/docs/email/api/proffer.email.internal.emailaddress.md b/docs/_pages/email/api/proffer.email.internal.emailaddress.md similarity index 100% rename from docs/email/api/proffer.email.internal.emailaddress.md rename to docs/_pages/email/api/proffer.email.internal.emailaddress.md diff --git a/docs/email/api/proffer.email.internal.emailaddressequalitycomparer.md b/docs/_pages/email/api/proffer.email.internal.emailaddressequalitycomparer.md similarity index 100% rename from docs/email/api/proffer.email.internal.emailaddressequalitycomparer.md rename to docs/_pages/email/api/proffer.email.internal.emailaddressequalitycomparer.md diff --git a/docs/email/api/proffer.email.internal.emailaddressstrictequalitycomparer.md b/docs/_pages/email/api/proffer.email.internal.emailaddressstrictequalitycomparer.md similarity index 100% rename from docs/email/api/proffer.email.internal.emailaddressstrictequalitycomparer.md rename to docs/_pages/email/api/proffer.email.internal.emailaddressstrictequalitycomparer.md diff --git a/docs/email/api/proffer.email.internal.emailattachment.md b/docs/_pages/email/api/proffer.email.internal.emailattachment.md similarity index 100% rename from docs/email/api/proffer.email.internal.emailattachment.md rename to docs/_pages/email/api/proffer.email.internal.emailattachment.md diff --git a/docs/email/api/proffer.email.internal.emailattachmentequalitycomparer.md b/docs/_pages/email/api/proffer.email.internal.emailattachmentequalitycomparer.md similarity index 100% rename from docs/email/api/proffer.email.internal.emailattachmentequalitycomparer.md rename to docs/_pages/email/api/proffer.email.internal.emailattachmentequalitycomparer.md diff --git a/docs/email/api/proffer.email.internal.emailsender.md b/docs/_pages/email/api/proffer.email.internal.emailsender.md similarity index 100% rename from docs/email/api/proffer.email.internal.emailsender.md rename to docs/_pages/email/api/proffer.email.internal.emailsender.md diff --git a/docs/email/api/proffer.email.mockupexceptionsoptions.md b/docs/_pages/email/api/proffer.email.mockupexceptionsoptions.md similarity index 100% rename from docs/email/api/proffer.email.mockupexceptionsoptions.md rename to docs/_pages/email/api/proffer.email.mockupexceptionsoptions.md diff --git a/docs/email/api/proffer.email.mockupoptions.md b/docs/_pages/email/api/proffer.email.mockupoptions.md similarity index 100% rename from docs/email/api/proffer.email.mockupoptions.md rename to docs/_pages/email/api/proffer.email.mockupoptions.md diff --git a/docs/email/in-memory/api/index.md b/docs/_pages/email/in-memory/api/index.md similarity index 100% rename from docs/email/in-memory/api/index.md rename to docs/_pages/email/in-memory/api/index.md diff --git a/docs/email/in-memory/api/proffer.email.inmemory.iinmemoryemailrepository.md b/docs/_pages/email/in-memory/api/proffer.email.inmemory.iinmemoryemailrepository.md similarity index 100% rename from docs/email/in-memory/api/proffer.email.inmemory.iinmemoryemailrepository.md rename to docs/_pages/email/in-memory/api/proffer.email.inmemory.iinmemoryemailrepository.md diff --git a/docs/email/in-memory/api/proffer.email.inmemory.inmemoryemail.md b/docs/_pages/email/in-memory/api/proffer.email.inmemory.inmemoryemail.md similarity index 100% rename from docs/email/in-memory/api/proffer.email.inmemory.inmemoryemail.md rename to docs/_pages/email/in-memory/api/proffer.email.inmemory.inmemoryemail.md diff --git a/docs/email/in-memory/api/proffer.email.inmemory.inmemoryemailprovider.md b/docs/_pages/email/in-memory/api/proffer.email.inmemory.inmemoryemailprovider.md similarity index 100% rename from docs/email/in-memory/api/proffer.email.inmemory.inmemoryemailprovider.md rename to docs/_pages/email/in-memory/api/proffer.email.inmemory.inmemoryemailprovider.md diff --git a/docs/email/in-memory/api/proffer.email.inmemory.inmemoryemailprovidertype.md b/docs/_pages/email/in-memory/api/proffer.email.inmemory.inmemoryemailprovidertype.md similarity index 100% rename from docs/email/in-memory/api/proffer.email.inmemory.inmemoryemailprovidertype.md rename to docs/_pages/email/in-memory/api/proffer.email.inmemory.inmemoryemailprovidertype.md diff --git a/docs/email/in-memory/api/proffer.email.inmemory.inmemoryemailrepository.md b/docs/_pages/email/in-memory/api/proffer.email.inmemory.inmemoryemailrepository.md similarity index 100% rename from docs/email/in-memory/api/proffer.email.inmemory.inmemoryemailrepository.md rename to docs/_pages/email/in-memory/api/proffer.email.inmemory.inmemoryemailrepository.md diff --git a/docs/email/in-memory/api/proffer.email.inmemoryemailservicecollectionextensions.md b/docs/_pages/email/in-memory/api/proffer.email.inmemoryemailservicecollectionextensions.md similarity index 100% rename from docs/email/in-memory/api/proffer.email.inmemoryemailservicecollectionextensions.md rename to docs/_pages/email/in-memory/api/proffer.email.inmemoryemailservicecollectionextensions.md diff --git a/docs/email/sendgrid/api/index.md b/docs/_pages/email/sendgrid/api/index.md similarity index 100% rename from docs/email/sendgrid/api/index.md rename to docs/_pages/email/sendgrid/api/index.md diff --git a/docs/email/sendgrid/api/proffer.email.sendgrid.sendgridemailprovider.md b/docs/_pages/email/sendgrid/api/proffer.email.sendgrid.sendgridemailprovider.md similarity index 100% rename from docs/email/sendgrid/api/proffer.email.sendgrid.sendgridemailprovider.md rename to docs/_pages/email/sendgrid/api/proffer.email.sendgrid.sendgridemailprovider.md diff --git a/docs/email/sendgrid/api/proffer.email.sendgrid.sendgridemailprovidertype.md b/docs/_pages/email/sendgrid/api/proffer.email.sendgrid.sendgridemailprovidertype.md similarity index 100% rename from docs/email/sendgrid/api/proffer.email.sendgrid.sendgridemailprovidertype.md rename to docs/_pages/email/sendgrid/api/proffer.email.sendgrid.sendgridemailprovidertype.md diff --git a/docs/email/sendgrid/api/proffer.email.servicecollectionextensions.md b/docs/_pages/email/sendgrid/api/proffer.email.servicecollectionextensions.md similarity index 100% rename from docs/email/sendgrid/api/proffer.email.servicecollectionextensions.md rename to docs/_pages/email/sendgrid/api/proffer.email.servicecollectionextensions.md diff --git a/docs/email/smtp/api/index.md b/docs/_pages/email/smtp/api/index.md similarity index 100% rename from docs/email/smtp/api/index.md rename to docs/_pages/email/smtp/api/index.md diff --git a/docs/email/smtp/api/proffer.email.smtp.smtpemailprovider.md b/docs/_pages/email/smtp/api/proffer.email.smtp.smtpemailprovider.md similarity index 100% rename from docs/email/smtp/api/proffer.email.smtp.smtpemailprovider.md rename to docs/_pages/email/smtp/api/proffer.email.smtp.smtpemailprovider.md diff --git a/docs/email/smtp/api/proffer.email.smtp.smtpemailprovidertype.md b/docs/_pages/email/smtp/api/proffer.email.smtp.smtpemailprovidertype.md similarity index 100% rename from docs/email/smtp/api/proffer.email.smtp.smtpemailprovidertype.md rename to docs/_pages/email/smtp/api/proffer.email.smtp.smtpemailprovidertype.md diff --git a/docs/email/smtp/api/proffer.email.smtpemailservicecollectionextensions.md b/docs/_pages/email/smtp/api/proffer.email.smtpemailservicecollectionextensions.md similarity index 100% rename from docs/email/smtp/api/proffer.email.smtpemailservicecollectionextensions.md rename to docs/_pages/email/smtp/api/proffer.email.smtpemailservicecollectionextensions.md diff --git a/docs/storage/api/index.md b/docs/_pages/storage/api/index.md similarity index 100% rename from docs/storage/api/index.md rename to docs/_pages/storage/api/index.md diff --git a/docs/storage/api/proffer.storage.configuration.accesslevel.md b/docs/_pages/storage/api/proffer.storage.configuration.accesslevel.md similarity index 100% rename from docs/storage/api/proffer.storage.configuration.accesslevel.md rename to docs/_pages/storage/api/proffer.storage.configuration.accesslevel.md diff --git a/docs/storage/api/proffer.storage.configuration.configurationextensions.md b/docs/_pages/storage/api/proffer.storage.configuration.configurationextensions.md similarity index 100% rename from docs/storage/api/proffer.storage.configuration.configurationextensions.md rename to docs/_pages/storage/api/proffer.storage.configuration.configurationextensions.md diff --git a/docs/storage/api/proffer.storage.configuration.iparsedoptions-3.md b/docs/_pages/storage/api/proffer.storage.configuration.iparsedoptions-3.md similarity index 100% rename from docs/storage/api/proffer.storage.configuration.iparsedoptions-3.md rename to docs/_pages/storage/api/proffer.storage.configuration.iparsedoptions-3.md diff --git a/docs/storage/api/proffer.storage.configuration.iscopedstoreoptions.md b/docs/_pages/storage/api/proffer.storage.configuration.iscopedstoreoptions.md similarity index 100% rename from docs/storage/api/proffer.storage.configuration.iscopedstoreoptions.md rename to docs/_pages/storage/api/proffer.storage.configuration.iscopedstoreoptions.md diff --git a/docs/storage/api/proffer.storage.configuration.istoreoptions.md b/docs/_pages/storage/api/proffer.storage.configuration.istoreoptions.md similarity index 100% rename from docs/storage/api/proffer.storage.configuration.istoreoptions.md rename to docs/_pages/storage/api/proffer.storage.configuration.istoreoptions.md diff --git a/docs/storage/api/proffer.storage.configuration.scopedstoreoptions.md b/docs/_pages/storage/api/proffer.storage.configuration.scopedstoreoptions.md similarity index 100% rename from docs/storage/api/proffer.storage.configuration.scopedstoreoptions.md rename to docs/_pages/storage/api/proffer.storage.configuration.scopedstoreoptions.md diff --git a/docs/storage/api/proffer.storage.configuration.storageoptions.md b/docs/_pages/storage/api/proffer.storage.configuration.storageoptions.md similarity index 100% rename from docs/storage/api/proffer.storage.configuration.storageoptions.md rename to docs/_pages/storage/api/proffer.storage.configuration.storageoptions.md diff --git a/docs/storage/api/proffer.storage.configuration.storeoptions.md b/docs/_pages/storage/api/proffer.storage.configuration.storeoptions.md similarity index 100% rename from docs/storage/api/proffer.storage.configuration.storeoptions.md rename to docs/_pages/storage/api/proffer.storage.configuration.storeoptions.md diff --git a/docs/storage/api/proffer.storage.exceptions.badproviderconfiguration.md b/docs/_pages/storage/api/proffer.storage.exceptions.badproviderconfiguration.md similarity index 100% rename from docs/storage/api/proffer.storage.exceptions.badproviderconfiguration.md rename to docs/_pages/storage/api/proffer.storage.exceptions.badproviderconfiguration.md diff --git a/docs/storage/api/proffer.storage.exceptions.badscopedstoreconfiguration.md b/docs/_pages/storage/api/proffer.storage.exceptions.badscopedstoreconfiguration.md similarity index 100% rename from docs/storage/api/proffer.storage.exceptions.badscopedstoreconfiguration.md rename to docs/_pages/storage/api/proffer.storage.exceptions.badscopedstoreconfiguration.md diff --git a/docs/storage/api/proffer.storage.exceptions.badstoreconfiguration.md b/docs/_pages/storage/api/proffer.storage.exceptions.badstoreconfiguration.md similarity index 100% rename from docs/storage/api/proffer.storage.exceptions.badstoreconfiguration.md rename to docs/_pages/storage/api/proffer.storage.exceptions.badstoreconfiguration.md diff --git a/docs/storage/api/proffer.storage.exceptions.filealreadyexistsexception.md b/docs/_pages/storage/api/proffer.storage.exceptions.filealreadyexistsexception.md similarity index 100% rename from docs/storage/api/proffer.storage.exceptions.filealreadyexistsexception.md rename to docs/_pages/storage/api/proffer.storage.exceptions.filealreadyexistsexception.md diff --git a/docs/storage/api/proffer.storage.exceptions.providernotfoundexception.md b/docs/_pages/storage/api/proffer.storage.exceptions.providernotfoundexception.md similarity index 100% rename from docs/storage/api/proffer.storage.exceptions.providernotfoundexception.md rename to docs/_pages/storage/api/proffer.storage.exceptions.providernotfoundexception.md diff --git a/docs/storage/api/proffer.storage.exceptions.storenotfoundexception.md b/docs/_pages/storage/api/proffer.storage.exceptions.storenotfoundexception.md similarity index 100% rename from docs/storage/api/proffer.storage.exceptions.storenotfoundexception.md rename to docs/_pages/storage/api/proffer.storage.exceptions.storenotfoundexception.md diff --git a/docs/storage/api/proffer.storage.ifileproperties.md b/docs/_pages/storage/api/proffer.storage.ifileproperties.md similarity index 100% rename from docs/storage/api/proffer.storage.ifileproperties.md rename to docs/_pages/storage/api/proffer.storage.ifileproperties.md diff --git a/docs/storage/api/proffer.storage.ifilereference.md b/docs/_pages/storage/api/proffer.storage.ifilereference.md similarity index 100% rename from docs/storage/api/proffer.storage.ifilereference.md rename to docs/_pages/storage/api/proffer.storage.ifilereference.md diff --git a/docs/storage/api/proffer.storage.internal.configureprovideroptions-4.md b/docs/_pages/storage/api/proffer.storage.internal.configureprovideroptions-4.md similarity index 100% rename from docs/storage/api/proffer.storage.internal.configureprovideroptions-4.md rename to docs/_pages/storage/api/proffer.storage.internal.configureprovideroptions-4.md diff --git a/docs/storage/api/proffer.storage.internal.genericstoreproxy-1.md b/docs/_pages/storage/api/proffer.storage.internal.genericstoreproxy-1.md similarity index 100% rename from docs/storage/api/proffer.storage.internal.genericstoreproxy-1.md rename to docs/_pages/storage/api/proffer.storage.internal.genericstoreproxy-1.md diff --git a/docs/storage/api/proffer.storage.internal.privatefilereference.md b/docs/_pages/storage/api/proffer.storage.internal.privatefilereference.md similarity index 100% rename from docs/storage/api/proffer.storage.internal.privatefilereference.md rename to docs/_pages/storage/api/proffer.storage.internal.privatefilereference.md diff --git a/docs/storage/api/proffer.storage.internal.storagefactory.md b/docs/_pages/storage/api/proffer.storage.internal.storagefactory.md similarity index 100% rename from docs/storage/api/proffer.storage.internal.storagefactory.md rename to docs/_pages/storage/api/proffer.storage.internal.storagefactory.md diff --git a/docs/storage/api/proffer.storage.internal.storageproviderbase-4.md b/docs/_pages/storage/api/proffer.storage.internal.storageproviderbase-4.md similarity index 100% rename from docs/storage/api/proffer.storage.internal.storageproviderbase-4.md rename to docs/_pages/storage/api/proffer.storage.internal.storageproviderbase-4.md diff --git a/docs/storage/api/proffer.storage.iprivatefilereference.md b/docs/_pages/storage/api/proffer.storage.iprivatefilereference.md similarity index 100% rename from docs/storage/api/proffer.storage.iprivatefilereference.md rename to docs/_pages/storage/api/proffer.storage.iprivatefilereference.md diff --git a/docs/storage/api/proffer.storage.isharedaccesspolicy.md b/docs/_pages/storage/api/proffer.storage.isharedaccesspolicy.md similarity index 100% rename from docs/storage/api/proffer.storage.isharedaccesspolicy.md rename to docs/_pages/storage/api/proffer.storage.isharedaccesspolicy.md diff --git a/docs/storage/api/proffer.storage.istoragefactory.md b/docs/_pages/storage/api/proffer.storage.istoragefactory.md similarity index 100% rename from docs/storage/api/proffer.storage.istoragefactory.md rename to docs/_pages/storage/api/proffer.storage.istoragefactory.md diff --git a/docs/storage/api/proffer.storage.istorageprovider.md b/docs/_pages/storage/api/proffer.storage.istorageprovider.md similarity index 100% rename from docs/storage/api/proffer.storage.istorageprovider.md rename to docs/_pages/storage/api/proffer.storage.istorageprovider.md diff --git a/docs/storage/api/proffer.storage.istore-1.md b/docs/_pages/storage/api/proffer.storage.istore-1.md similarity index 100% rename from docs/storage/api/proffer.storage.istore-1.md rename to docs/_pages/storage/api/proffer.storage.istore-1.md diff --git a/docs/storage/api/proffer.storage.istore.md b/docs/_pages/storage/api/proffer.storage.istore.md similarity index 100% rename from docs/storage/api/proffer.storage.istore.md rename to docs/_pages/storage/api/proffer.storage.istore.md diff --git a/docs/storage/api/proffer.storage.istoreextensions.md b/docs/_pages/storage/api/proffer.storage.istoreextensions.md similarity index 100% rename from docs/storage/api/proffer.storage.istoreextensions.md rename to docs/_pages/storage/api/proffer.storage.istoreextensions.md diff --git a/docs/storage/api/proffer.storage.overwritepolicy.md b/docs/_pages/storage/api/proffer.storage.overwritepolicy.md similarity index 100% rename from docs/storage/api/proffer.storage.overwritepolicy.md rename to docs/_pages/storage/api/proffer.storage.overwritepolicy.md diff --git a/docs/storage/api/proffer.storage.sharedaccesspermissions.md b/docs/_pages/storage/api/proffer.storage.sharedaccesspermissions.md similarity index 100% rename from docs/storage/api/proffer.storage.sharedaccesspermissions.md rename to docs/_pages/storage/api/proffer.storage.sharedaccesspermissions.md diff --git a/docs/storage/api/proffer.storage.sharedaccesspolicy.md b/docs/_pages/storage/api/proffer.storage.sharedaccesspolicy.md similarity index 100% rename from docs/storage/api/proffer.storage.sharedaccesspolicy.md rename to docs/_pages/storage/api/proffer.storage.sharedaccesspolicy.md diff --git a/docs/storage/api/proffer.storage.storageservicecollectionextensions.md b/docs/_pages/storage/api/proffer.storage.storageservicecollectionextensions.md similarity index 100% rename from docs/storage/api/proffer.storage.storageservicecollectionextensions.md rename to docs/_pages/storage/api/proffer.storage.storageservicecollectionextensions.md diff --git a/docs/storage/api/proffer.storage.storebase.md b/docs/_pages/storage/api/proffer.storage.storebase.md similarity index 100% rename from docs/storage/api/proffer.storage.storebase.md rename to docs/_pages/storage/api/proffer.storage.storebase.md diff --git a/docs/storage/azure/blobs/api/index.md b/docs/_pages/storage/azure/blobs/api/index.md similarity index 100% rename from docs/storage/azure/blobs/api/index.md rename to docs/_pages/storage/azure/blobs/api/index.md diff --git a/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.azureblobsstorageprovider.md b/docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.azureblobsstorageprovider.md similarity index 100% rename from docs/storage/azure/blobs/api/proffer.storage.azure.blobs.azureblobsstorageprovider.md rename to docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.azureblobsstorageprovider.md diff --git a/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.azureblobsstore.md b/docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.azureblobsstore.md similarity index 100% rename from docs/storage/azure/blobs/api/proffer.storage.azure.blobs.azureblobsstore.md rename to docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.azureblobsstore.md diff --git a/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md b/docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md similarity index 100% rename from docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md rename to docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md diff --git a/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md b/docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md similarity index 100% rename from docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md rename to docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md diff --git a/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md b/docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md similarity index 100% rename from docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md rename to docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md diff --git a/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md b/docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md similarity index 100% rename from docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md rename to docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md diff --git a/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md b/docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md similarity index 100% rename from docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md rename to docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md diff --git a/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobsfilereference.md b/docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobsfilereference.md similarity index 100% rename from docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobsfilereference.md rename to docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobsfilereference.md diff --git a/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md b/docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md similarity index 100% rename from docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md rename to docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md diff --git a/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md b/docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md similarity index 100% rename from docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md rename to docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md diff --git a/docs/storage/azure/blobs/api/proffer.storage.azureblobsstorageservicecollectionextensions.md b/docs/_pages/storage/azure/blobs/api/proffer.storage.azureblobsstorageservicecollectionextensions.md similarity index 100% rename from docs/storage/azure/blobs/api/proffer.storage.azureblobsstorageservicecollectionextensions.md rename to docs/_pages/storage/azure/blobs/api/proffer.storage.azureblobsstorageservicecollectionextensions.md diff --git a/docs/storage/azure/blobs/index.md b/docs/_pages/storage/azure/blobs/index.md similarity index 100% rename from docs/storage/azure/blobs/index.md rename to docs/_pages/storage/azure/blobs/index.md diff --git a/docs/storage/filesystem/api/index.md b/docs/_pages/storage/filesystem/api/index.md similarity index 100% rename from docs/storage/filesystem/api/index.md rename to docs/_pages/storage/filesystem/api/index.md diff --git a/docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemparsedoptions.md b/docs/_pages/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemparsedoptions.md similarity index 100% rename from docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemparsedoptions.md rename to docs/_pages/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemparsedoptions.md diff --git a/docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemprovideroptions.md b/docs/_pages/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemprovideroptions.md similarity index 100% rename from docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemprovideroptions.md rename to docs/_pages/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemprovideroptions.md diff --git a/docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md b/docs/_pages/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md similarity index 100% rename from docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md rename to docs/_pages/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md diff --git a/docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemstoreoptions.md b/docs/_pages/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemstoreoptions.md similarity index 100% rename from docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemstoreoptions.md rename to docs/_pages/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemstoreoptions.md diff --git a/docs/storage/filesystem/api/proffer.storage.filesystem.filesystemstorageprovider.md b/docs/_pages/storage/filesystem/api/proffer.storage.filesystem.filesystemstorageprovider.md similarity index 100% rename from docs/storage/filesystem/api/proffer.storage.filesystem.filesystemstorageprovider.md rename to docs/_pages/storage/filesystem/api/proffer.storage.filesystem.filesystemstorageprovider.md diff --git a/docs/storage/filesystem/api/proffer.storage.filesystem.filesystemstore.md b/docs/_pages/storage/filesystem/api/proffer.storage.filesystem.filesystemstore.md similarity index 100% rename from docs/storage/filesystem/api/proffer.storage.filesystem.filesystemstore.md rename to docs/_pages/storage/filesystem/api/proffer.storage.filesystem.filesystemstore.md diff --git a/docs/storage/filesystem/api/proffer.storage.filesystem.iextendedpropertiesprovider.md b/docs/_pages/storage/filesystem/api/proffer.storage.filesystem.iextendedpropertiesprovider.md similarity index 100% rename from docs/storage/filesystem/api/proffer.storage.filesystem.iextendedpropertiesprovider.md rename to docs/_pages/storage/filesystem/api/proffer.storage.filesystem.iextendedpropertiesprovider.md diff --git a/docs/storage/filesystem/api/proffer.storage.filesystem.internal.fileextendedproperties.md b/docs/_pages/storage/filesystem/api/proffer.storage.filesystem.internal.fileextendedproperties.md similarity index 100% rename from docs/storage/filesystem/api/proffer.storage.filesystem.internal.fileextendedproperties.md rename to docs/_pages/storage/filesystem/api/proffer.storage.filesystem.internal.fileextendedproperties.md diff --git a/docs/storage/filesystem/api/proffer.storage.filesystem.internal.filesystemfileproperties.md b/docs/_pages/storage/filesystem/api/proffer.storage.filesystem.internal.filesystemfileproperties.md similarity index 100% rename from docs/storage/filesystem/api/proffer.storage.filesystem.internal.filesystemfileproperties.md rename to docs/_pages/storage/filesystem/api/proffer.storage.filesystem.internal.filesystemfileproperties.md diff --git a/docs/storage/filesystem/api/proffer.storage.filesystem.internal.filesystemfilereference.md b/docs/_pages/storage/filesystem/api/proffer.storage.filesystem.internal.filesystemfilereference.md similarity index 100% rename from docs/storage/filesystem/api/proffer.storage.filesystem.internal.filesystemfilereference.md rename to docs/_pages/storage/filesystem/api/proffer.storage.filesystem.internal.filesystemfilereference.md diff --git a/docs/storage/filesystem/api/proffer.storage.filesystem.ipublicurlprovider.md b/docs/_pages/storage/filesystem/api/proffer.storage.filesystem.ipublicurlprovider.md similarity index 100% rename from docs/storage/filesystem/api/proffer.storage.filesystem.ipublicurlprovider.md rename to docs/_pages/storage/filesystem/api/proffer.storage.filesystem.ipublicurlprovider.md diff --git a/docs/storage/filesystem/api/proffer.storage.filesystem.noextendedpropertiesprovider.md b/docs/_pages/storage/filesystem/api/proffer.storage.filesystem.noextendedpropertiesprovider.md similarity index 100% rename from docs/storage/filesystem/api/proffer.storage.filesystem.noextendedpropertiesprovider.md rename to docs/_pages/storage/filesystem/api/proffer.storage.filesystem.noextendedpropertiesprovider.md diff --git a/docs/storage/filesystem/api/proffer.storage.filesystemstorageservicecollectionextensions.md b/docs/_pages/storage/filesystem/api/proffer.storage.filesystemstorageservicecollectionextensions.md similarity index 100% rename from docs/storage/filesystem/api/proffer.storage.filesystemstorageservicecollectionextensions.md rename to docs/_pages/storage/filesystem/api/proffer.storage.filesystemstorageservicecollectionextensions.md diff --git a/docs/storage/filesystem/properties/json/api/index.md b/docs/_pages/storage/filesystem/properties/json/api/index.md similarity index 100% rename from docs/storage/filesystem/properties/json/api/index.md rename to docs/_pages/storage/filesystem/properties/json/api/index.md diff --git a/docs/storage/filesystem/properties/json/api/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md b/docs/_pages/storage/filesystem/properties/json/api/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md similarity index 100% rename from docs/storage/filesystem/properties/json/api/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md rename to docs/_pages/storage/filesystem/properties/json/api/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md diff --git a/docs/storage/filesystem/properties/json/api/proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md b/docs/_pages/storage/filesystem/properties/json/api/proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md similarity index 100% rename from docs/storage/filesystem/properties/json/api/proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md rename to docs/_pages/storage/filesystem/properties/json/api/proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md diff --git a/docs/storage/filesystem/properties/json/api/proffer.storage.filesystempropertiesjsonservicecollectionextensions.md b/docs/_pages/storage/filesystem/properties/json/api/proffer.storage.filesystempropertiesjsonservicecollectionextensions.md similarity index 100% rename from docs/storage/filesystem/properties/json/api/proffer.storage.filesystempropertiesjsonservicecollectionextensions.md rename to docs/_pages/storage/filesystem/properties/json/api/proffer.storage.filesystempropertiesjsonservicecollectionextensions.md diff --git a/docs/storage/filesystem/server/api/index.md b/docs/_pages/storage/filesystem/server/api/index.md similarity index 100% rename from docs/storage/filesystem/server/api/index.md rename to docs/_pages/storage/filesystem/server/api/index.md diff --git a/docs/storage/filesystem/server/api/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md b/docs/_pages/storage/filesystem/server/api/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md similarity index 100% rename from docs/storage/filesystem/server/api/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md rename to docs/_pages/storage/filesystem/server/api/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md diff --git a/docs/storage/filesystem/server/api/proffer.storage.filesystem.server.filesystemstorageserveroptions.md b/docs/_pages/storage/filesystem/server/api/proffer.storage.filesystem.server.filesystemstorageserveroptions.md similarity index 100% rename from docs/storage/filesystem/server/api/proffer.storage.filesystem.server.filesystemstorageserveroptions.md rename to docs/_pages/storage/filesystem/server/api/proffer.storage.filesystem.server.filesystemstorageserveroptions.md diff --git a/docs/storage/filesystem/server/api/proffer.storage.filesystem.server.internal.publicurlprovider.md b/docs/_pages/storage/filesystem/server/api/proffer.storage.filesystem.server.internal.publicurlprovider.md similarity index 100% rename from docs/storage/filesystem/server/api/proffer.storage.filesystem.server.internal.publicurlprovider.md rename to docs/_pages/storage/filesystem/server/api/proffer.storage.filesystem.server.internal.publicurlprovider.md diff --git a/docs/storage/filesystem/server/api/proffer.storage.servicecollectionextensions.md b/docs/_pages/storage/filesystem/server/api/proffer.storage.servicecollectionextensions.md similarity index 100% rename from docs/storage/filesystem/server/api/proffer.storage.servicecollectionextensions.md rename to docs/_pages/storage/filesystem/server/api/proffer.storage.servicecollectionextensions.md diff --git a/docs/templating/api/index.md b/docs/_pages/templating/api/index.md similarity index 100% rename from docs/templating/api/index.md rename to docs/_pages/templating/api/index.md diff --git a/docs/templating/api/proffer.templating.exceptions.providernotfoundexception.md b/docs/_pages/templating/api/proffer.templating.exceptions.providernotfoundexception.md similarity index 100% rename from docs/templating/api/proffer.templating.exceptions.providernotfoundexception.md rename to docs/_pages/templating/api/proffer.templating.exceptions.providernotfoundexception.md diff --git a/docs/templating/api/proffer.templating.exceptions.templatenotfoundexception.md b/docs/_pages/templating/api/proffer.templating.exceptions.templatenotfoundexception.md similarity index 100% rename from docs/templating/api/proffer.templating.exceptions.templatenotfoundexception.md rename to docs/_pages/templating/api/proffer.templating.exceptions.templatenotfoundexception.md diff --git a/docs/templating/api/proffer.templating.internal.templateloader.md b/docs/_pages/templating/api/proffer.templating.internal.templateloader.md similarity index 100% rename from docs/templating/api/proffer.templating.internal.templateloader.md rename to docs/_pages/templating/api/proffer.templating.internal.templateloader.md diff --git a/docs/templating/api/proffer.templating.internal.templateloaderfactory.md b/docs/_pages/templating/api/proffer.templating.internal.templateloaderfactory.md similarity index 100% rename from docs/templating/api/proffer.templating.internal.templateloaderfactory.md rename to docs/_pages/templating/api/proffer.templating.internal.templateloaderfactory.md diff --git a/docs/templating/api/proffer.templating.invalidcontextexception.md b/docs/_pages/templating/api/proffer.templating.invalidcontextexception.md similarity index 100% rename from docs/templating/api/proffer.templating.invalidcontextexception.md rename to docs/_pages/templating/api/proffer.templating.invalidcontextexception.md diff --git a/docs/templating/api/proffer.templating.itemplate.md b/docs/_pages/templating/api/proffer.templating.itemplate.md similarity index 100% rename from docs/templating/api/proffer.templating.itemplate.md rename to docs/_pages/templating/api/proffer.templating.itemplate.md diff --git a/docs/templating/api/proffer.templating.itemplateloader.md b/docs/_pages/templating/api/proffer.templating.itemplateloader.md similarity index 100% rename from docs/templating/api/proffer.templating.itemplateloader.md rename to docs/_pages/templating/api/proffer.templating.itemplateloader.md diff --git a/docs/templating/api/proffer.templating.itemplateloaderfactory.md b/docs/_pages/templating/api/proffer.templating.itemplateloaderfactory.md similarity index 100% rename from docs/templating/api/proffer.templating.itemplateloaderfactory.md rename to docs/_pages/templating/api/proffer.templating.itemplateloaderfactory.md diff --git a/docs/templating/api/proffer.templating.itemplateprovider.md b/docs/_pages/templating/api/proffer.templating.itemplateprovider.md similarity index 100% rename from docs/templating/api/proffer.templating.itemplateprovider.md rename to docs/_pages/templating/api/proffer.templating.itemplateprovider.md diff --git a/docs/templating/api/proffer.templating.itemplateproviderscope.md b/docs/_pages/templating/api/proffer.templating.itemplateproviderscope.md similarity index 100% rename from docs/templating/api/proffer.templating.itemplateproviderscope.md rename to docs/_pages/templating/api/proffer.templating.itemplateproviderscope.md diff --git a/docs/templating/api/proffer.templating.templatecollectionbase-1.md b/docs/_pages/templating/api/proffer.templating.templatecollectionbase-1.md similarity index 100% rename from docs/templating/api/proffer.templating.templatecollectionbase-1.md rename to docs/_pages/templating/api/proffer.templating.templatecollectionbase-1.md diff --git a/docs/templating/api/proffer.templating.templatecollectionbase.md b/docs/_pages/templating/api/proffer.templating.templatecollectionbase.md similarity index 100% rename from docs/templating/api/proffer.templating.templatecollectionbase.md rename to docs/_pages/templating/api/proffer.templating.templatecollectionbase.md diff --git a/docs/templating/api/proffer.templating.templatingservicecollectionextensions.md b/docs/_pages/templating/api/proffer.templating.templatingservicecollectionextensions.md similarity index 100% rename from docs/templating/api/proffer.templating.templatingservicecollectionextensions.md rename to docs/_pages/templating/api/proffer.templating.templatingservicecollectionextensions.md diff --git a/docs/templating/handlebars/api/index.md b/docs/_pages/templating/handlebars/api/index.md similarity index 100% rename from docs/templating/handlebars/api/index.md rename to docs/_pages/templating/handlebars/api/index.md diff --git a/docs/templating/handlebars/api/proffer.templating.handlebars.handlebarstemplate.md b/docs/_pages/templating/handlebars/api/proffer.templating.handlebars.handlebarstemplate.md similarity index 100% rename from docs/templating/handlebars/api/proffer.templating.handlebars.handlebarstemplate.md rename to docs/_pages/templating/handlebars/api/proffer.templating.handlebars.handlebarstemplate.md diff --git a/docs/templating/handlebars/api/proffer.templating.handlebars.handlebarstemplateprovider.md b/docs/_pages/templating/handlebars/api/proffer.templating.handlebars.handlebarstemplateprovider.md similarity index 100% rename from docs/templating/handlebars/api/proffer.templating.handlebars.handlebarstemplateprovider.md rename to docs/_pages/templating/handlebars/api/proffer.templating.handlebars.handlebarstemplateprovider.md diff --git a/docs/templating/handlebars/api/proffer.templating.handlebarsservicecollectionextensions.md b/docs/_pages/templating/handlebars/api/proffer.templating.handlebarsservicecollectionextensions.md similarity index 100% rename from docs/templating/handlebars/api/proffer.templating.handlebarsservicecollectionextensions.md rename to docs/_pages/templating/handlebars/api/proffer.templating.handlebarsservicecollectionextensions.md diff --git a/docs/templating/mustache/api/index.md b/docs/_pages/templating/mustache/api/index.md similarity index 100% rename from docs/templating/mustache/api/index.md rename to docs/_pages/templating/mustache/api/index.md diff --git a/docs/templating/mustache/api/proffer.templating.mustache.mustachetemplate.md b/docs/_pages/templating/mustache/api/proffer.templating.mustache.mustachetemplate.md similarity index 100% rename from docs/templating/mustache/api/proffer.templating.mustache.mustachetemplate.md rename to docs/_pages/templating/mustache/api/proffer.templating.mustache.mustachetemplate.md diff --git a/docs/templating/mustache/api/proffer.templating.mustache.mustachetemplateprovider.md b/docs/_pages/templating/mustache/api/proffer.templating.mustache.mustachetemplateprovider.md similarity index 100% rename from docs/templating/mustache/api/proffer.templating.mustache.mustachetemplateprovider.md rename to docs/_pages/templating/mustache/api/proffer.templating.mustache.mustachetemplateprovider.md diff --git a/docs/templating/mustache/api/proffer.templating.mustacheservicecollectionextensions.md b/docs/_pages/templating/mustache/api/proffer.templating.mustacheservicecollectionextensions.md similarity index 100% rename from docs/templating/mustache/api/proffer.templating.mustacheservicecollectionextensions.md rename to docs/_pages/templating/mustache/api/proffer.templating.mustacheservicecollectionextensions.md diff --git a/src/Directory.Build.targets b/src/Directory.Build.targets index 1625a69..a7df5df 100644 --- a/src/Directory.Build.targets +++ b/src/Directory.Build.targets @@ -1,6 +1,6 @@ - + \ No newline at end of file From d92c886fff6b1aa753a3b37def8b201925d4f953 Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Sat, 22 May 2021 02:54:04 +0200 Subject: [PATCH 32/45] =?UTF-8?q?Remove=20=F0=9F=98=85?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/_config.yml | 6 +----- docs/{_pages => }/core/api/index.md | 0 .../core/api/proffer.configuration.inamedelementoptions.md | 0 .../core/api/proffer.configuration.ioptionerror.md | 0 .../core/api/proffer.configuration.iprovideroptions.md | 0 .../core/api/proffer.configuration.optionerror.md | 0 .../core/api/proffer.configuration.provideroptions.md | 0 .../{_pages => }/core/api/proffer.equalitycomparerbase-1.md | 0 docs/{_pages => }/core/azure/api/index.md | 0 .../api/proffer.azure.configuration.iazurestorageoptions.md | 0 docs/{_pages => }/core/azure/index.md | 0 docs/{_pages => }/core/index.md | 0 docs/{_pages => }/email/api/index.md | 0 docs/{_pages => }/email/api/proffer.email.emailoptions.md | 0 .../email/api/proffer.email.emailprovideroptions.md | 0 .../api/proffer.email.emailservicecollectionextensions.md | 0 .../email/api/proffer.email.emailtemplatetype.md | 0 docs/{_pages => }/email/api/proffer.email.iemailaddress.md | 0 .../email/api/proffer.email.iemailattachment.md | 0 docs/{_pages => }/email/api/proffer.email.iemailprovider.md | 0 .../email/api/proffer.email.iemailprovideroptions.md | 0 .../email/api/proffer.email.iemailprovidertype.md | 0 docs/{_pages => }/email/api/proffer.email.iemailsender.md | 0 .../email/api/proffer.email.internal.emailaddress.md | 0 .../proffer.email.internal.emailaddressequalitycomparer.md | 0 ...fer.email.internal.emailaddressstrictequalitycomparer.md | 0 .../email/api/proffer.email.internal.emailattachment.md | 0 ...roffer.email.internal.emailattachmentequalitycomparer.md | 0 .../email/api/proffer.email.internal.emailsender.md | 0 .../email/api/proffer.email.mockupexceptionsoptions.md | 0 docs/{_pages => }/email/api/proffer.email.mockupoptions.md | 0 docs/{_pages => }/email/in-memory/api/index.md | 0 .../api/proffer.email.inmemory.iinmemoryemailrepository.md | 0 .../in-memory/api/proffer.email.inmemory.inmemoryemail.md | 0 .../api/proffer.email.inmemory.inmemoryemailprovider.md | 0 .../api/proffer.email.inmemory.inmemoryemailprovidertype.md | 0 .../api/proffer.email.inmemory.inmemoryemailrepository.md | 0 ...roffer.email.inmemoryemailservicecollectionextensions.md | 0 docs/{_pages => }/email/sendgrid/api/index.md | 0 .../api/proffer.email.sendgrid.sendgridemailprovider.md | 0 .../api/proffer.email.sendgrid.sendgridemailprovidertype.md | 0 .../api/proffer.email.servicecollectionextensions.md | 0 docs/{_pages => }/email/smtp/api/index.md | 0 .../email/smtp/api/proffer.email.smtp.smtpemailprovider.md | 0 .../smtp/api/proffer.email.smtp.smtpemailprovidertype.md | 0 .../proffer.email.smtpemailservicecollectionextensions.md | 0 docs/{_pages => }/storage/api/index.md | 0 .../api/proffer.storage.configuration.accesslevel.md | 0 ...proffer.storage.configuration.configurationextensions.md | 0 .../api/proffer.storage.configuration.iparsedoptions-3.md | 0 .../proffer.storage.configuration.iscopedstoreoptions.md | 0 .../api/proffer.storage.configuration.istoreoptions.md | 0 .../api/proffer.storage.configuration.scopedstoreoptions.md | 0 .../api/proffer.storage.configuration.storageoptions.md | 0 .../api/proffer.storage.configuration.storeoptions.md | 0 .../proffer.storage.exceptions.badproviderconfiguration.md | 0 ...roffer.storage.exceptions.badscopedstoreconfiguration.md | 0 .../api/proffer.storage.exceptions.badstoreconfiguration.md | 0 ...proffer.storage.exceptions.filealreadyexistsexception.md | 0 .../proffer.storage.exceptions.providernotfoundexception.md | 0 .../proffer.storage.exceptions.storenotfoundexception.md | 0 .../storage/api/proffer.storage.ifileproperties.md | 0 .../storage/api/proffer.storage.ifilereference.md | 0 .../proffer.storage.internal.configureprovideroptions-4.md | 0 .../api/proffer.storage.internal.genericstoreproxy-1.md | 0 .../api/proffer.storage.internal.privatefilereference.md | 0 .../storage/api/proffer.storage.internal.storagefactory.md | 0 .../api/proffer.storage.internal.storageproviderbase-4.md | 0 .../storage/api/proffer.storage.iprivatefilereference.md | 0 .../storage/api/proffer.storage.isharedaccesspolicy.md | 0 .../storage/api/proffer.storage.istoragefactory.md | 0 .../storage/api/proffer.storage.istorageprovider.md | 0 docs/{_pages => }/storage/api/proffer.storage.istore-1.md | 0 docs/{_pages => }/storage/api/proffer.storage.istore.md | 0 .../storage/api/proffer.storage.istoreextensions.md | 0 .../storage/api/proffer.storage.overwritepolicy.md | 0 .../storage/api/proffer.storage.sharedaccesspermissions.md | 0 .../storage/api/proffer.storage.sharedaccesspolicy.md | 0 .../proffer.storage.storageservicecollectionextensions.md | 0 docs/{_pages => }/storage/api/proffer.storage.storebase.md | 0 docs/{_pages => }/storage/azure/blobs/api/index.md | 0 ...proffer.storage.azure.blobs.azureblobsstorageprovider.md | 0 .../api/proffer.storage.azure.blobs.azureblobsstore.md | 0 ...age.azure.blobs.configuration.azureblobsparsedoptions.md | 0 ...e.azure.blobs.configuration.azureblobsprovideroptions.md | 0 ...zure.blobs.configuration.azureblobsscopedstoreoptions.md | 0 ...rage.azure.blobs.configuration.azureblobsstoreoptions.md | 0 ...storage.azure.blobs.internal.azureblobsfileproperties.md | 0 ....storage.azure.blobs.internal.azureblobsfilereference.md | 0 ...e.azure.blobs.internal.azureblobslistdirectorywrapper.md | 0 ...torage.azure.blobs.internal.azureblobslistfilewrapper.md | 0 ....storage.azureblobsstorageservicecollectionextensions.md | 0 docs/{_pages => }/storage/azure/blobs/index.md | 0 docs/{_pages => }/storage/filesystem/api/index.md | 0 ...rage.filesystem.configuration.filesystemparsedoptions.md | 0 ...ge.filesystem.configuration.filesystemprovideroptions.md | 0 ...filesystem.configuration.filesystemscopedstoreoptions.md | 0 ...orage.filesystem.configuration.filesystemstoreoptions.md | 0 .../proffer.storage.filesystem.filesystemstorageprovider.md | 0 .../api/proffer.storage.filesystem.filesystemstore.md | 0 ...roffer.storage.filesystem.iextendedpropertiesprovider.md | 0 ...er.storage.filesystem.internal.fileextendedproperties.md | 0 ....storage.filesystem.internal.filesystemfileproperties.md | 0 ...r.storage.filesystem.internal.filesystemfilereference.md | 0 .../api/proffer.storage.filesystem.ipublicurlprovider.md | 0 ...offer.storage.filesystem.noextendedpropertiesprovider.md | 0 ....storage.filesystemstorageservicecollectionextensions.md | 0 .../storage/filesystem/properties/json/api/index.md | 0 ...ystem.properties.json.filesystempropertiesjsonoptions.md | 0 ...m.properties.json.internal.extendedpropertiesprovider.md | 0 ...e.filesystempropertiesjsonservicecollectionextensions.md | 0 docs/{_pages => }/storage/filesystem/server/api/index.md | 0 ...e.filesystem.server.filesystemstorageservermiddleware.md | 0 ...rage.filesystem.server.filesystemstorageserveroptions.md | 0 ....storage.filesystem.server.internal.publicurlprovider.md | 0 .../api/proffer.storage.servicecollectionextensions.md | 0 docs/{_pages => }/templating/api/index.md | 0 ...offer.templating.exceptions.providernotfoundexception.md | 0 ...offer.templating.exceptions.templatenotfoundexception.md | 0 .../api/proffer.templating.internal.templateloader.md | 0 .../proffer.templating.internal.templateloaderfactory.md | 0 .../api/proffer.templating.invalidcontextexception.md | 0 .../templating/api/proffer.templating.itemplate.md | 0 .../templating/api/proffer.templating.itemplateloader.md | 0 .../api/proffer.templating.itemplateloaderfactory.md | 0 .../templating/api/proffer.templating.itemplateprovider.md | 0 .../api/proffer.templating.itemplateproviderscope.md | 0 .../api/proffer.templating.templatecollectionbase-1.md | 0 .../api/proffer.templating.templatecollectionbase.md | 0 ...ffer.templating.templatingservicecollectionextensions.md | 0 docs/{_pages => }/templating/handlebars/api/index.md | 0 .../api/proffer.templating.handlebars.handlebarstemplate.md | 0 ...ffer.templating.handlebars.handlebarstemplateprovider.md | 0 ...ffer.templating.handlebarsservicecollectionextensions.md | 0 docs/{_pages => }/templating/mustache/api/index.md | 0 .../api/proffer.templating.mustache.mustachetemplate.md | 0 .../proffer.templating.mustache.mustachetemplateprovider.md | 0 ...roffer.templating.mustacheservicecollectionextensions.md | 0 src/Directory.Build.targets | 2 +- 139 files changed, 2 insertions(+), 6 deletions(-) rename docs/{_pages => }/core/api/index.md (100%) rename docs/{_pages => }/core/api/proffer.configuration.inamedelementoptions.md (100%) rename docs/{_pages => }/core/api/proffer.configuration.ioptionerror.md (100%) rename docs/{_pages => }/core/api/proffer.configuration.iprovideroptions.md (100%) rename docs/{_pages => }/core/api/proffer.configuration.optionerror.md (100%) rename docs/{_pages => }/core/api/proffer.configuration.provideroptions.md (100%) rename docs/{_pages => }/core/api/proffer.equalitycomparerbase-1.md (100%) rename docs/{_pages => }/core/azure/api/index.md (100%) rename docs/{_pages => }/core/azure/api/proffer.azure.configuration.iazurestorageoptions.md (100%) rename docs/{_pages => }/core/azure/index.md (100%) rename docs/{_pages => }/core/index.md (100%) rename docs/{_pages => }/email/api/index.md (100%) rename docs/{_pages => }/email/api/proffer.email.emailoptions.md (100%) rename docs/{_pages => }/email/api/proffer.email.emailprovideroptions.md (100%) rename docs/{_pages => }/email/api/proffer.email.emailservicecollectionextensions.md (100%) rename docs/{_pages => }/email/api/proffer.email.emailtemplatetype.md (100%) rename docs/{_pages => }/email/api/proffer.email.iemailaddress.md (100%) rename docs/{_pages => }/email/api/proffer.email.iemailattachment.md (100%) rename docs/{_pages => }/email/api/proffer.email.iemailprovider.md (100%) rename docs/{_pages => }/email/api/proffer.email.iemailprovideroptions.md (100%) rename docs/{_pages => }/email/api/proffer.email.iemailprovidertype.md (100%) rename docs/{_pages => }/email/api/proffer.email.iemailsender.md (100%) rename docs/{_pages => }/email/api/proffer.email.internal.emailaddress.md (100%) rename docs/{_pages => }/email/api/proffer.email.internal.emailaddressequalitycomparer.md (100%) rename docs/{_pages => }/email/api/proffer.email.internal.emailaddressstrictequalitycomparer.md (100%) rename docs/{_pages => }/email/api/proffer.email.internal.emailattachment.md (100%) rename docs/{_pages => }/email/api/proffer.email.internal.emailattachmentequalitycomparer.md (100%) rename docs/{_pages => }/email/api/proffer.email.internal.emailsender.md (100%) rename docs/{_pages => }/email/api/proffer.email.mockupexceptionsoptions.md (100%) rename docs/{_pages => }/email/api/proffer.email.mockupoptions.md (100%) rename docs/{_pages => }/email/in-memory/api/index.md (100%) rename docs/{_pages => }/email/in-memory/api/proffer.email.inmemory.iinmemoryemailrepository.md (100%) rename docs/{_pages => }/email/in-memory/api/proffer.email.inmemory.inmemoryemail.md (100%) rename docs/{_pages => }/email/in-memory/api/proffer.email.inmemory.inmemoryemailprovider.md (100%) rename docs/{_pages => }/email/in-memory/api/proffer.email.inmemory.inmemoryemailprovidertype.md (100%) rename docs/{_pages => }/email/in-memory/api/proffer.email.inmemory.inmemoryemailrepository.md (100%) rename docs/{_pages => }/email/in-memory/api/proffer.email.inmemoryemailservicecollectionextensions.md (100%) rename docs/{_pages => }/email/sendgrid/api/index.md (100%) rename docs/{_pages => }/email/sendgrid/api/proffer.email.sendgrid.sendgridemailprovider.md (100%) rename docs/{_pages => }/email/sendgrid/api/proffer.email.sendgrid.sendgridemailprovidertype.md (100%) rename docs/{_pages => }/email/sendgrid/api/proffer.email.servicecollectionextensions.md (100%) rename docs/{_pages => }/email/smtp/api/index.md (100%) rename docs/{_pages => }/email/smtp/api/proffer.email.smtp.smtpemailprovider.md (100%) rename docs/{_pages => }/email/smtp/api/proffer.email.smtp.smtpemailprovidertype.md (100%) rename docs/{_pages => }/email/smtp/api/proffer.email.smtpemailservicecollectionextensions.md (100%) rename docs/{_pages => }/storage/api/index.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.configuration.accesslevel.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.configuration.configurationextensions.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.configuration.iparsedoptions-3.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.configuration.iscopedstoreoptions.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.configuration.istoreoptions.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.configuration.scopedstoreoptions.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.configuration.storageoptions.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.configuration.storeoptions.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.exceptions.badproviderconfiguration.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.exceptions.badscopedstoreconfiguration.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.exceptions.badstoreconfiguration.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.exceptions.filealreadyexistsexception.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.exceptions.providernotfoundexception.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.exceptions.storenotfoundexception.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.ifileproperties.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.ifilereference.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.internal.configureprovideroptions-4.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.internal.genericstoreproxy-1.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.internal.privatefilereference.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.internal.storagefactory.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.internal.storageproviderbase-4.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.iprivatefilereference.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.isharedaccesspolicy.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.istoragefactory.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.istorageprovider.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.istore-1.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.istore.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.istoreextensions.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.overwritepolicy.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.sharedaccesspermissions.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.sharedaccesspolicy.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.storageservicecollectionextensions.md (100%) rename docs/{_pages => }/storage/api/proffer.storage.storebase.md (100%) rename docs/{_pages => }/storage/azure/blobs/api/index.md (100%) rename docs/{_pages => }/storage/azure/blobs/api/proffer.storage.azure.blobs.azureblobsstorageprovider.md (100%) rename docs/{_pages => }/storage/azure/blobs/api/proffer.storage.azure.blobs.azureblobsstore.md (100%) rename docs/{_pages => }/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md (100%) rename docs/{_pages => }/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md (100%) rename docs/{_pages => }/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md (100%) rename docs/{_pages => }/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md (100%) rename docs/{_pages => }/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md (100%) rename docs/{_pages => }/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobsfilereference.md (100%) rename docs/{_pages => }/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md (100%) rename docs/{_pages => }/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md (100%) rename docs/{_pages => }/storage/azure/blobs/api/proffer.storage.azureblobsstorageservicecollectionextensions.md (100%) rename docs/{_pages => }/storage/azure/blobs/index.md (100%) rename docs/{_pages => }/storage/filesystem/api/index.md (100%) rename docs/{_pages => }/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemparsedoptions.md (100%) rename docs/{_pages => }/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemprovideroptions.md (100%) rename docs/{_pages => }/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md (100%) rename docs/{_pages => }/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemstoreoptions.md (100%) rename docs/{_pages => }/storage/filesystem/api/proffer.storage.filesystem.filesystemstorageprovider.md (100%) rename docs/{_pages => }/storage/filesystem/api/proffer.storage.filesystem.filesystemstore.md (100%) rename docs/{_pages => }/storage/filesystem/api/proffer.storage.filesystem.iextendedpropertiesprovider.md (100%) rename docs/{_pages => }/storage/filesystem/api/proffer.storage.filesystem.internal.fileextendedproperties.md (100%) rename docs/{_pages => }/storage/filesystem/api/proffer.storage.filesystem.internal.filesystemfileproperties.md (100%) rename docs/{_pages => }/storage/filesystem/api/proffer.storage.filesystem.internal.filesystemfilereference.md (100%) rename docs/{_pages => }/storage/filesystem/api/proffer.storage.filesystem.ipublicurlprovider.md (100%) rename docs/{_pages => }/storage/filesystem/api/proffer.storage.filesystem.noextendedpropertiesprovider.md (100%) rename docs/{_pages => }/storage/filesystem/api/proffer.storage.filesystemstorageservicecollectionextensions.md (100%) rename docs/{_pages => }/storage/filesystem/properties/json/api/index.md (100%) rename docs/{_pages => }/storage/filesystem/properties/json/api/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md (100%) rename docs/{_pages => }/storage/filesystem/properties/json/api/proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md (100%) rename docs/{_pages => }/storage/filesystem/properties/json/api/proffer.storage.filesystempropertiesjsonservicecollectionextensions.md (100%) rename docs/{_pages => }/storage/filesystem/server/api/index.md (100%) rename docs/{_pages => }/storage/filesystem/server/api/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md (100%) rename docs/{_pages => }/storage/filesystem/server/api/proffer.storage.filesystem.server.filesystemstorageserveroptions.md (100%) rename docs/{_pages => }/storage/filesystem/server/api/proffer.storage.filesystem.server.internal.publicurlprovider.md (100%) rename docs/{_pages => }/storage/filesystem/server/api/proffer.storage.servicecollectionextensions.md (100%) rename docs/{_pages => }/templating/api/index.md (100%) rename docs/{_pages => }/templating/api/proffer.templating.exceptions.providernotfoundexception.md (100%) rename docs/{_pages => }/templating/api/proffer.templating.exceptions.templatenotfoundexception.md (100%) rename docs/{_pages => }/templating/api/proffer.templating.internal.templateloader.md (100%) rename docs/{_pages => }/templating/api/proffer.templating.internal.templateloaderfactory.md (100%) rename docs/{_pages => }/templating/api/proffer.templating.invalidcontextexception.md (100%) rename docs/{_pages => }/templating/api/proffer.templating.itemplate.md (100%) rename docs/{_pages => }/templating/api/proffer.templating.itemplateloader.md (100%) rename docs/{_pages => }/templating/api/proffer.templating.itemplateloaderfactory.md (100%) rename docs/{_pages => }/templating/api/proffer.templating.itemplateprovider.md (100%) rename docs/{_pages => }/templating/api/proffer.templating.itemplateproviderscope.md (100%) rename docs/{_pages => }/templating/api/proffer.templating.templatecollectionbase-1.md (100%) rename docs/{_pages => }/templating/api/proffer.templating.templatecollectionbase.md (100%) rename docs/{_pages => }/templating/api/proffer.templating.templatingservicecollectionextensions.md (100%) rename docs/{_pages => }/templating/handlebars/api/index.md (100%) rename docs/{_pages => }/templating/handlebars/api/proffer.templating.handlebars.handlebarstemplate.md (100%) rename docs/{_pages => }/templating/handlebars/api/proffer.templating.handlebars.handlebarstemplateprovider.md (100%) rename docs/{_pages => }/templating/handlebars/api/proffer.templating.handlebarsservicecollectionextensions.md (100%) rename docs/{_pages => }/templating/mustache/api/index.md (100%) rename docs/{_pages => }/templating/mustache/api/proffer.templating.mustache.mustachetemplate.md (100%) rename docs/{_pages => }/templating/mustache/api/proffer.templating.mustache.mustachetemplateprovider.md (100%) rename docs/{_pages => }/templating/mustache/api/proffer.templating.mustacheservicecollectionextensions.md (100%) diff --git a/docs/_config.yml b/docs/_config.yml index a198059..f2b0f85 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -241,6 +241,7 @@ defaults: path: "" values: image: /assets/img/banner.png + layout: single # _posts - scope: path: "" @@ -252,8 +253,3 @@ defaults: comments: # true share: true related: true - - scope: - path: _pages - values: - layout: single - permalink: /:basename/ diff --git a/docs/_pages/core/api/index.md b/docs/core/api/index.md similarity index 100% rename from docs/_pages/core/api/index.md rename to docs/core/api/index.md diff --git a/docs/_pages/core/api/proffer.configuration.inamedelementoptions.md b/docs/core/api/proffer.configuration.inamedelementoptions.md similarity index 100% rename from docs/_pages/core/api/proffer.configuration.inamedelementoptions.md rename to docs/core/api/proffer.configuration.inamedelementoptions.md diff --git a/docs/_pages/core/api/proffer.configuration.ioptionerror.md b/docs/core/api/proffer.configuration.ioptionerror.md similarity index 100% rename from docs/_pages/core/api/proffer.configuration.ioptionerror.md rename to docs/core/api/proffer.configuration.ioptionerror.md diff --git a/docs/_pages/core/api/proffer.configuration.iprovideroptions.md b/docs/core/api/proffer.configuration.iprovideroptions.md similarity index 100% rename from docs/_pages/core/api/proffer.configuration.iprovideroptions.md rename to docs/core/api/proffer.configuration.iprovideroptions.md diff --git a/docs/_pages/core/api/proffer.configuration.optionerror.md b/docs/core/api/proffer.configuration.optionerror.md similarity index 100% rename from docs/_pages/core/api/proffer.configuration.optionerror.md rename to docs/core/api/proffer.configuration.optionerror.md diff --git a/docs/_pages/core/api/proffer.configuration.provideroptions.md b/docs/core/api/proffer.configuration.provideroptions.md similarity index 100% rename from docs/_pages/core/api/proffer.configuration.provideroptions.md rename to docs/core/api/proffer.configuration.provideroptions.md diff --git a/docs/_pages/core/api/proffer.equalitycomparerbase-1.md b/docs/core/api/proffer.equalitycomparerbase-1.md similarity index 100% rename from docs/_pages/core/api/proffer.equalitycomparerbase-1.md rename to docs/core/api/proffer.equalitycomparerbase-1.md diff --git a/docs/_pages/core/azure/api/index.md b/docs/core/azure/api/index.md similarity index 100% rename from docs/_pages/core/azure/api/index.md rename to docs/core/azure/api/index.md diff --git a/docs/_pages/core/azure/api/proffer.azure.configuration.iazurestorageoptions.md b/docs/core/azure/api/proffer.azure.configuration.iazurestorageoptions.md similarity index 100% rename from docs/_pages/core/azure/api/proffer.azure.configuration.iazurestorageoptions.md rename to docs/core/azure/api/proffer.azure.configuration.iazurestorageoptions.md diff --git a/docs/_pages/core/azure/index.md b/docs/core/azure/index.md similarity index 100% rename from docs/_pages/core/azure/index.md rename to docs/core/azure/index.md diff --git a/docs/_pages/core/index.md b/docs/core/index.md similarity index 100% rename from docs/_pages/core/index.md rename to docs/core/index.md diff --git a/docs/_pages/email/api/index.md b/docs/email/api/index.md similarity index 100% rename from docs/_pages/email/api/index.md rename to docs/email/api/index.md diff --git a/docs/_pages/email/api/proffer.email.emailoptions.md b/docs/email/api/proffer.email.emailoptions.md similarity index 100% rename from docs/_pages/email/api/proffer.email.emailoptions.md rename to docs/email/api/proffer.email.emailoptions.md diff --git a/docs/_pages/email/api/proffer.email.emailprovideroptions.md b/docs/email/api/proffer.email.emailprovideroptions.md similarity index 100% rename from docs/_pages/email/api/proffer.email.emailprovideroptions.md rename to docs/email/api/proffer.email.emailprovideroptions.md diff --git a/docs/_pages/email/api/proffer.email.emailservicecollectionextensions.md b/docs/email/api/proffer.email.emailservicecollectionextensions.md similarity index 100% rename from docs/_pages/email/api/proffer.email.emailservicecollectionextensions.md rename to docs/email/api/proffer.email.emailservicecollectionextensions.md diff --git a/docs/_pages/email/api/proffer.email.emailtemplatetype.md b/docs/email/api/proffer.email.emailtemplatetype.md similarity index 100% rename from docs/_pages/email/api/proffer.email.emailtemplatetype.md rename to docs/email/api/proffer.email.emailtemplatetype.md diff --git a/docs/_pages/email/api/proffer.email.iemailaddress.md b/docs/email/api/proffer.email.iemailaddress.md similarity index 100% rename from docs/_pages/email/api/proffer.email.iemailaddress.md rename to docs/email/api/proffer.email.iemailaddress.md diff --git a/docs/_pages/email/api/proffer.email.iemailattachment.md b/docs/email/api/proffer.email.iemailattachment.md similarity index 100% rename from docs/_pages/email/api/proffer.email.iemailattachment.md rename to docs/email/api/proffer.email.iemailattachment.md diff --git a/docs/_pages/email/api/proffer.email.iemailprovider.md b/docs/email/api/proffer.email.iemailprovider.md similarity index 100% rename from docs/_pages/email/api/proffer.email.iemailprovider.md rename to docs/email/api/proffer.email.iemailprovider.md diff --git a/docs/_pages/email/api/proffer.email.iemailprovideroptions.md b/docs/email/api/proffer.email.iemailprovideroptions.md similarity index 100% rename from docs/_pages/email/api/proffer.email.iemailprovideroptions.md rename to docs/email/api/proffer.email.iemailprovideroptions.md diff --git a/docs/_pages/email/api/proffer.email.iemailprovidertype.md b/docs/email/api/proffer.email.iemailprovidertype.md similarity index 100% rename from docs/_pages/email/api/proffer.email.iemailprovidertype.md rename to docs/email/api/proffer.email.iemailprovidertype.md diff --git a/docs/_pages/email/api/proffer.email.iemailsender.md b/docs/email/api/proffer.email.iemailsender.md similarity index 100% rename from docs/_pages/email/api/proffer.email.iemailsender.md rename to docs/email/api/proffer.email.iemailsender.md diff --git a/docs/_pages/email/api/proffer.email.internal.emailaddress.md b/docs/email/api/proffer.email.internal.emailaddress.md similarity index 100% rename from docs/_pages/email/api/proffer.email.internal.emailaddress.md rename to docs/email/api/proffer.email.internal.emailaddress.md diff --git a/docs/_pages/email/api/proffer.email.internal.emailaddressequalitycomparer.md b/docs/email/api/proffer.email.internal.emailaddressequalitycomparer.md similarity index 100% rename from docs/_pages/email/api/proffer.email.internal.emailaddressequalitycomparer.md rename to docs/email/api/proffer.email.internal.emailaddressequalitycomparer.md diff --git a/docs/_pages/email/api/proffer.email.internal.emailaddressstrictequalitycomparer.md b/docs/email/api/proffer.email.internal.emailaddressstrictequalitycomparer.md similarity index 100% rename from docs/_pages/email/api/proffer.email.internal.emailaddressstrictequalitycomparer.md rename to docs/email/api/proffer.email.internal.emailaddressstrictequalitycomparer.md diff --git a/docs/_pages/email/api/proffer.email.internal.emailattachment.md b/docs/email/api/proffer.email.internal.emailattachment.md similarity index 100% rename from docs/_pages/email/api/proffer.email.internal.emailattachment.md rename to docs/email/api/proffer.email.internal.emailattachment.md diff --git a/docs/_pages/email/api/proffer.email.internal.emailattachmentequalitycomparer.md b/docs/email/api/proffer.email.internal.emailattachmentequalitycomparer.md similarity index 100% rename from docs/_pages/email/api/proffer.email.internal.emailattachmentequalitycomparer.md rename to docs/email/api/proffer.email.internal.emailattachmentequalitycomparer.md diff --git a/docs/_pages/email/api/proffer.email.internal.emailsender.md b/docs/email/api/proffer.email.internal.emailsender.md similarity index 100% rename from docs/_pages/email/api/proffer.email.internal.emailsender.md rename to docs/email/api/proffer.email.internal.emailsender.md diff --git a/docs/_pages/email/api/proffer.email.mockupexceptionsoptions.md b/docs/email/api/proffer.email.mockupexceptionsoptions.md similarity index 100% rename from docs/_pages/email/api/proffer.email.mockupexceptionsoptions.md rename to docs/email/api/proffer.email.mockupexceptionsoptions.md diff --git a/docs/_pages/email/api/proffer.email.mockupoptions.md b/docs/email/api/proffer.email.mockupoptions.md similarity index 100% rename from docs/_pages/email/api/proffer.email.mockupoptions.md rename to docs/email/api/proffer.email.mockupoptions.md diff --git a/docs/_pages/email/in-memory/api/index.md b/docs/email/in-memory/api/index.md similarity index 100% rename from docs/_pages/email/in-memory/api/index.md rename to docs/email/in-memory/api/index.md diff --git a/docs/_pages/email/in-memory/api/proffer.email.inmemory.iinmemoryemailrepository.md b/docs/email/in-memory/api/proffer.email.inmemory.iinmemoryemailrepository.md similarity index 100% rename from docs/_pages/email/in-memory/api/proffer.email.inmemory.iinmemoryemailrepository.md rename to docs/email/in-memory/api/proffer.email.inmemory.iinmemoryemailrepository.md diff --git a/docs/_pages/email/in-memory/api/proffer.email.inmemory.inmemoryemail.md b/docs/email/in-memory/api/proffer.email.inmemory.inmemoryemail.md similarity index 100% rename from docs/_pages/email/in-memory/api/proffer.email.inmemory.inmemoryemail.md rename to docs/email/in-memory/api/proffer.email.inmemory.inmemoryemail.md diff --git a/docs/_pages/email/in-memory/api/proffer.email.inmemory.inmemoryemailprovider.md b/docs/email/in-memory/api/proffer.email.inmemory.inmemoryemailprovider.md similarity index 100% rename from docs/_pages/email/in-memory/api/proffer.email.inmemory.inmemoryemailprovider.md rename to docs/email/in-memory/api/proffer.email.inmemory.inmemoryemailprovider.md diff --git a/docs/_pages/email/in-memory/api/proffer.email.inmemory.inmemoryemailprovidertype.md b/docs/email/in-memory/api/proffer.email.inmemory.inmemoryemailprovidertype.md similarity index 100% rename from docs/_pages/email/in-memory/api/proffer.email.inmemory.inmemoryemailprovidertype.md rename to docs/email/in-memory/api/proffer.email.inmemory.inmemoryemailprovidertype.md diff --git a/docs/_pages/email/in-memory/api/proffer.email.inmemory.inmemoryemailrepository.md b/docs/email/in-memory/api/proffer.email.inmemory.inmemoryemailrepository.md similarity index 100% rename from docs/_pages/email/in-memory/api/proffer.email.inmemory.inmemoryemailrepository.md rename to docs/email/in-memory/api/proffer.email.inmemory.inmemoryemailrepository.md diff --git a/docs/_pages/email/in-memory/api/proffer.email.inmemoryemailservicecollectionextensions.md b/docs/email/in-memory/api/proffer.email.inmemoryemailservicecollectionextensions.md similarity index 100% rename from docs/_pages/email/in-memory/api/proffer.email.inmemoryemailservicecollectionextensions.md rename to docs/email/in-memory/api/proffer.email.inmemoryemailservicecollectionextensions.md diff --git a/docs/_pages/email/sendgrid/api/index.md b/docs/email/sendgrid/api/index.md similarity index 100% rename from docs/_pages/email/sendgrid/api/index.md rename to docs/email/sendgrid/api/index.md diff --git a/docs/_pages/email/sendgrid/api/proffer.email.sendgrid.sendgridemailprovider.md b/docs/email/sendgrid/api/proffer.email.sendgrid.sendgridemailprovider.md similarity index 100% rename from docs/_pages/email/sendgrid/api/proffer.email.sendgrid.sendgridemailprovider.md rename to docs/email/sendgrid/api/proffer.email.sendgrid.sendgridemailprovider.md diff --git a/docs/_pages/email/sendgrid/api/proffer.email.sendgrid.sendgridemailprovidertype.md b/docs/email/sendgrid/api/proffer.email.sendgrid.sendgridemailprovidertype.md similarity index 100% rename from docs/_pages/email/sendgrid/api/proffer.email.sendgrid.sendgridemailprovidertype.md rename to docs/email/sendgrid/api/proffer.email.sendgrid.sendgridemailprovidertype.md diff --git a/docs/_pages/email/sendgrid/api/proffer.email.servicecollectionextensions.md b/docs/email/sendgrid/api/proffer.email.servicecollectionextensions.md similarity index 100% rename from docs/_pages/email/sendgrid/api/proffer.email.servicecollectionextensions.md rename to docs/email/sendgrid/api/proffer.email.servicecollectionextensions.md diff --git a/docs/_pages/email/smtp/api/index.md b/docs/email/smtp/api/index.md similarity index 100% rename from docs/_pages/email/smtp/api/index.md rename to docs/email/smtp/api/index.md diff --git a/docs/_pages/email/smtp/api/proffer.email.smtp.smtpemailprovider.md b/docs/email/smtp/api/proffer.email.smtp.smtpemailprovider.md similarity index 100% rename from docs/_pages/email/smtp/api/proffer.email.smtp.smtpemailprovider.md rename to docs/email/smtp/api/proffer.email.smtp.smtpemailprovider.md diff --git a/docs/_pages/email/smtp/api/proffer.email.smtp.smtpemailprovidertype.md b/docs/email/smtp/api/proffer.email.smtp.smtpemailprovidertype.md similarity index 100% rename from docs/_pages/email/smtp/api/proffer.email.smtp.smtpemailprovidertype.md rename to docs/email/smtp/api/proffer.email.smtp.smtpemailprovidertype.md diff --git a/docs/_pages/email/smtp/api/proffer.email.smtpemailservicecollectionextensions.md b/docs/email/smtp/api/proffer.email.smtpemailservicecollectionextensions.md similarity index 100% rename from docs/_pages/email/smtp/api/proffer.email.smtpemailservicecollectionextensions.md rename to docs/email/smtp/api/proffer.email.smtpemailservicecollectionextensions.md diff --git a/docs/_pages/storage/api/index.md b/docs/storage/api/index.md similarity index 100% rename from docs/_pages/storage/api/index.md rename to docs/storage/api/index.md diff --git a/docs/_pages/storage/api/proffer.storage.configuration.accesslevel.md b/docs/storage/api/proffer.storage.configuration.accesslevel.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.configuration.accesslevel.md rename to docs/storage/api/proffer.storage.configuration.accesslevel.md diff --git a/docs/_pages/storage/api/proffer.storage.configuration.configurationextensions.md b/docs/storage/api/proffer.storage.configuration.configurationextensions.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.configuration.configurationextensions.md rename to docs/storage/api/proffer.storage.configuration.configurationextensions.md diff --git a/docs/_pages/storage/api/proffer.storage.configuration.iparsedoptions-3.md b/docs/storage/api/proffer.storage.configuration.iparsedoptions-3.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.configuration.iparsedoptions-3.md rename to docs/storage/api/proffer.storage.configuration.iparsedoptions-3.md diff --git a/docs/_pages/storage/api/proffer.storage.configuration.iscopedstoreoptions.md b/docs/storage/api/proffer.storage.configuration.iscopedstoreoptions.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.configuration.iscopedstoreoptions.md rename to docs/storage/api/proffer.storage.configuration.iscopedstoreoptions.md diff --git a/docs/_pages/storage/api/proffer.storage.configuration.istoreoptions.md b/docs/storage/api/proffer.storage.configuration.istoreoptions.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.configuration.istoreoptions.md rename to docs/storage/api/proffer.storage.configuration.istoreoptions.md diff --git a/docs/_pages/storage/api/proffer.storage.configuration.scopedstoreoptions.md b/docs/storage/api/proffer.storage.configuration.scopedstoreoptions.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.configuration.scopedstoreoptions.md rename to docs/storage/api/proffer.storage.configuration.scopedstoreoptions.md diff --git a/docs/_pages/storage/api/proffer.storage.configuration.storageoptions.md b/docs/storage/api/proffer.storage.configuration.storageoptions.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.configuration.storageoptions.md rename to docs/storage/api/proffer.storage.configuration.storageoptions.md diff --git a/docs/_pages/storage/api/proffer.storage.configuration.storeoptions.md b/docs/storage/api/proffer.storage.configuration.storeoptions.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.configuration.storeoptions.md rename to docs/storage/api/proffer.storage.configuration.storeoptions.md diff --git a/docs/_pages/storage/api/proffer.storage.exceptions.badproviderconfiguration.md b/docs/storage/api/proffer.storage.exceptions.badproviderconfiguration.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.exceptions.badproviderconfiguration.md rename to docs/storage/api/proffer.storage.exceptions.badproviderconfiguration.md diff --git a/docs/_pages/storage/api/proffer.storage.exceptions.badscopedstoreconfiguration.md b/docs/storage/api/proffer.storage.exceptions.badscopedstoreconfiguration.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.exceptions.badscopedstoreconfiguration.md rename to docs/storage/api/proffer.storage.exceptions.badscopedstoreconfiguration.md diff --git a/docs/_pages/storage/api/proffer.storage.exceptions.badstoreconfiguration.md b/docs/storage/api/proffer.storage.exceptions.badstoreconfiguration.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.exceptions.badstoreconfiguration.md rename to docs/storage/api/proffer.storage.exceptions.badstoreconfiguration.md diff --git a/docs/_pages/storage/api/proffer.storage.exceptions.filealreadyexistsexception.md b/docs/storage/api/proffer.storage.exceptions.filealreadyexistsexception.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.exceptions.filealreadyexistsexception.md rename to docs/storage/api/proffer.storage.exceptions.filealreadyexistsexception.md diff --git a/docs/_pages/storage/api/proffer.storage.exceptions.providernotfoundexception.md b/docs/storage/api/proffer.storage.exceptions.providernotfoundexception.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.exceptions.providernotfoundexception.md rename to docs/storage/api/proffer.storage.exceptions.providernotfoundexception.md diff --git a/docs/_pages/storage/api/proffer.storage.exceptions.storenotfoundexception.md b/docs/storage/api/proffer.storage.exceptions.storenotfoundexception.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.exceptions.storenotfoundexception.md rename to docs/storage/api/proffer.storage.exceptions.storenotfoundexception.md diff --git a/docs/_pages/storage/api/proffer.storage.ifileproperties.md b/docs/storage/api/proffer.storage.ifileproperties.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.ifileproperties.md rename to docs/storage/api/proffer.storage.ifileproperties.md diff --git a/docs/_pages/storage/api/proffer.storage.ifilereference.md b/docs/storage/api/proffer.storage.ifilereference.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.ifilereference.md rename to docs/storage/api/proffer.storage.ifilereference.md diff --git a/docs/_pages/storage/api/proffer.storage.internal.configureprovideroptions-4.md b/docs/storage/api/proffer.storage.internal.configureprovideroptions-4.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.internal.configureprovideroptions-4.md rename to docs/storage/api/proffer.storage.internal.configureprovideroptions-4.md diff --git a/docs/_pages/storage/api/proffer.storage.internal.genericstoreproxy-1.md b/docs/storage/api/proffer.storage.internal.genericstoreproxy-1.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.internal.genericstoreproxy-1.md rename to docs/storage/api/proffer.storage.internal.genericstoreproxy-1.md diff --git a/docs/_pages/storage/api/proffer.storage.internal.privatefilereference.md b/docs/storage/api/proffer.storage.internal.privatefilereference.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.internal.privatefilereference.md rename to docs/storage/api/proffer.storage.internal.privatefilereference.md diff --git a/docs/_pages/storage/api/proffer.storage.internal.storagefactory.md b/docs/storage/api/proffer.storage.internal.storagefactory.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.internal.storagefactory.md rename to docs/storage/api/proffer.storage.internal.storagefactory.md diff --git a/docs/_pages/storage/api/proffer.storage.internal.storageproviderbase-4.md b/docs/storage/api/proffer.storage.internal.storageproviderbase-4.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.internal.storageproviderbase-4.md rename to docs/storage/api/proffer.storage.internal.storageproviderbase-4.md diff --git a/docs/_pages/storage/api/proffer.storage.iprivatefilereference.md b/docs/storage/api/proffer.storage.iprivatefilereference.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.iprivatefilereference.md rename to docs/storage/api/proffer.storage.iprivatefilereference.md diff --git a/docs/_pages/storage/api/proffer.storage.isharedaccesspolicy.md b/docs/storage/api/proffer.storage.isharedaccesspolicy.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.isharedaccesspolicy.md rename to docs/storage/api/proffer.storage.isharedaccesspolicy.md diff --git a/docs/_pages/storage/api/proffer.storage.istoragefactory.md b/docs/storage/api/proffer.storage.istoragefactory.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.istoragefactory.md rename to docs/storage/api/proffer.storage.istoragefactory.md diff --git a/docs/_pages/storage/api/proffer.storage.istorageprovider.md b/docs/storage/api/proffer.storage.istorageprovider.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.istorageprovider.md rename to docs/storage/api/proffer.storage.istorageprovider.md diff --git a/docs/_pages/storage/api/proffer.storage.istore-1.md b/docs/storage/api/proffer.storage.istore-1.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.istore-1.md rename to docs/storage/api/proffer.storage.istore-1.md diff --git a/docs/_pages/storage/api/proffer.storage.istore.md b/docs/storage/api/proffer.storage.istore.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.istore.md rename to docs/storage/api/proffer.storage.istore.md diff --git a/docs/_pages/storage/api/proffer.storage.istoreextensions.md b/docs/storage/api/proffer.storage.istoreextensions.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.istoreextensions.md rename to docs/storage/api/proffer.storage.istoreextensions.md diff --git a/docs/_pages/storage/api/proffer.storage.overwritepolicy.md b/docs/storage/api/proffer.storage.overwritepolicy.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.overwritepolicy.md rename to docs/storage/api/proffer.storage.overwritepolicy.md diff --git a/docs/_pages/storage/api/proffer.storage.sharedaccesspermissions.md b/docs/storage/api/proffer.storage.sharedaccesspermissions.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.sharedaccesspermissions.md rename to docs/storage/api/proffer.storage.sharedaccesspermissions.md diff --git a/docs/_pages/storage/api/proffer.storage.sharedaccesspolicy.md b/docs/storage/api/proffer.storage.sharedaccesspolicy.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.sharedaccesspolicy.md rename to docs/storage/api/proffer.storage.sharedaccesspolicy.md diff --git a/docs/_pages/storage/api/proffer.storage.storageservicecollectionextensions.md b/docs/storage/api/proffer.storage.storageservicecollectionextensions.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.storageservicecollectionextensions.md rename to docs/storage/api/proffer.storage.storageservicecollectionextensions.md diff --git a/docs/_pages/storage/api/proffer.storage.storebase.md b/docs/storage/api/proffer.storage.storebase.md similarity index 100% rename from docs/_pages/storage/api/proffer.storage.storebase.md rename to docs/storage/api/proffer.storage.storebase.md diff --git a/docs/_pages/storage/azure/blobs/api/index.md b/docs/storage/azure/blobs/api/index.md similarity index 100% rename from docs/_pages/storage/azure/blobs/api/index.md rename to docs/storage/azure/blobs/api/index.md diff --git a/docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.azureblobsstorageprovider.md b/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.azureblobsstorageprovider.md similarity index 100% rename from docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.azureblobsstorageprovider.md rename to docs/storage/azure/blobs/api/proffer.storage.azure.blobs.azureblobsstorageprovider.md diff --git a/docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.azureblobsstore.md b/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.azureblobsstore.md similarity index 100% rename from docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.azureblobsstore.md rename to docs/storage/azure/blobs/api/proffer.storage.azure.blobs.azureblobsstore.md diff --git a/docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md b/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md similarity index 100% rename from docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md rename to docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md diff --git a/docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md b/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md similarity index 100% rename from docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md rename to docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md diff --git a/docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md b/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md similarity index 100% rename from docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md rename to docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md diff --git a/docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md b/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md similarity index 100% rename from docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md rename to docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md diff --git a/docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md b/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md similarity index 100% rename from docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md rename to docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md diff --git a/docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobsfilereference.md b/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobsfilereference.md similarity index 100% rename from docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobsfilereference.md rename to docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobsfilereference.md diff --git a/docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md b/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md similarity index 100% rename from docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md rename to docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md diff --git a/docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md b/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md similarity index 100% rename from docs/_pages/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md rename to docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md diff --git a/docs/_pages/storage/azure/blobs/api/proffer.storage.azureblobsstorageservicecollectionextensions.md b/docs/storage/azure/blobs/api/proffer.storage.azureblobsstorageservicecollectionextensions.md similarity index 100% rename from docs/_pages/storage/azure/blobs/api/proffer.storage.azureblobsstorageservicecollectionextensions.md rename to docs/storage/azure/blobs/api/proffer.storage.azureblobsstorageservicecollectionextensions.md diff --git a/docs/_pages/storage/azure/blobs/index.md b/docs/storage/azure/blobs/index.md similarity index 100% rename from docs/_pages/storage/azure/blobs/index.md rename to docs/storage/azure/blobs/index.md diff --git a/docs/_pages/storage/filesystem/api/index.md b/docs/storage/filesystem/api/index.md similarity index 100% rename from docs/_pages/storage/filesystem/api/index.md rename to docs/storage/filesystem/api/index.md diff --git a/docs/_pages/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemparsedoptions.md b/docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemparsedoptions.md similarity index 100% rename from docs/_pages/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemparsedoptions.md rename to docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemparsedoptions.md diff --git a/docs/_pages/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemprovideroptions.md b/docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemprovideroptions.md similarity index 100% rename from docs/_pages/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemprovideroptions.md rename to docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemprovideroptions.md diff --git a/docs/_pages/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md b/docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md similarity index 100% rename from docs/_pages/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md rename to docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md diff --git a/docs/_pages/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemstoreoptions.md b/docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemstoreoptions.md similarity index 100% rename from docs/_pages/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemstoreoptions.md rename to docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemstoreoptions.md diff --git a/docs/_pages/storage/filesystem/api/proffer.storage.filesystem.filesystemstorageprovider.md b/docs/storage/filesystem/api/proffer.storage.filesystem.filesystemstorageprovider.md similarity index 100% rename from docs/_pages/storage/filesystem/api/proffer.storage.filesystem.filesystemstorageprovider.md rename to docs/storage/filesystem/api/proffer.storage.filesystem.filesystemstorageprovider.md diff --git a/docs/_pages/storage/filesystem/api/proffer.storage.filesystem.filesystemstore.md b/docs/storage/filesystem/api/proffer.storage.filesystem.filesystemstore.md similarity index 100% rename from docs/_pages/storage/filesystem/api/proffer.storage.filesystem.filesystemstore.md rename to docs/storage/filesystem/api/proffer.storage.filesystem.filesystemstore.md diff --git a/docs/_pages/storage/filesystem/api/proffer.storage.filesystem.iextendedpropertiesprovider.md b/docs/storage/filesystem/api/proffer.storage.filesystem.iextendedpropertiesprovider.md similarity index 100% rename from docs/_pages/storage/filesystem/api/proffer.storage.filesystem.iextendedpropertiesprovider.md rename to docs/storage/filesystem/api/proffer.storage.filesystem.iextendedpropertiesprovider.md diff --git a/docs/_pages/storage/filesystem/api/proffer.storage.filesystem.internal.fileextendedproperties.md b/docs/storage/filesystem/api/proffer.storage.filesystem.internal.fileextendedproperties.md similarity index 100% rename from docs/_pages/storage/filesystem/api/proffer.storage.filesystem.internal.fileextendedproperties.md rename to docs/storage/filesystem/api/proffer.storage.filesystem.internal.fileextendedproperties.md diff --git a/docs/_pages/storage/filesystem/api/proffer.storage.filesystem.internal.filesystemfileproperties.md b/docs/storage/filesystem/api/proffer.storage.filesystem.internal.filesystemfileproperties.md similarity index 100% rename from docs/_pages/storage/filesystem/api/proffer.storage.filesystem.internal.filesystemfileproperties.md rename to docs/storage/filesystem/api/proffer.storage.filesystem.internal.filesystemfileproperties.md diff --git a/docs/_pages/storage/filesystem/api/proffer.storage.filesystem.internal.filesystemfilereference.md b/docs/storage/filesystem/api/proffer.storage.filesystem.internal.filesystemfilereference.md similarity index 100% rename from docs/_pages/storage/filesystem/api/proffer.storage.filesystem.internal.filesystemfilereference.md rename to docs/storage/filesystem/api/proffer.storage.filesystem.internal.filesystemfilereference.md diff --git a/docs/_pages/storage/filesystem/api/proffer.storage.filesystem.ipublicurlprovider.md b/docs/storage/filesystem/api/proffer.storage.filesystem.ipublicurlprovider.md similarity index 100% rename from docs/_pages/storage/filesystem/api/proffer.storage.filesystem.ipublicurlprovider.md rename to docs/storage/filesystem/api/proffer.storage.filesystem.ipublicurlprovider.md diff --git a/docs/_pages/storage/filesystem/api/proffer.storage.filesystem.noextendedpropertiesprovider.md b/docs/storage/filesystem/api/proffer.storage.filesystem.noextendedpropertiesprovider.md similarity index 100% rename from docs/_pages/storage/filesystem/api/proffer.storage.filesystem.noextendedpropertiesprovider.md rename to docs/storage/filesystem/api/proffer.storage.filesystem.noextendedpropertiesprovider.md diff --git a/docs/_pages/storage/filesystem/api/proffer.storage.filesystemstorageservicecollectionextensions.md b/docs/storage/filesystem/api/proffer.storage.filesystemstorageservicecollectionextensions.md similarity index 100% rename from docs/_pages/storage/filesystem/api/proffer.storage.filesystemstorageservicecollectionextensions.md rename to docs/storage/filesystem/api/proffer.storage.filesystemstorageservicecollectionextensions.md diff --git a/docs/_pages/storage/filesystem/properties/json/api/index.md b/docs/storage/filesystem/properties/json/api/index.md similarity index 100% rename from docs/_pages/storage/filesystem/properties/json/api/index.md rename to docs/storage/filesystem/properties/json/api/index.md diff --git a/docs/_pages/storage/filesystem/properties/json/api/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md b/docs/storage/filesystem/properties/json/api/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md similarity index 100% rename from docs/_pages/storage/filesystem/properties/json/api/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md rename to docs/storage/filesystem/properties/json/api/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md diff --git a/docs/_pages/storage/filesystem/properties/json/api/proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md b/docs/storage/filesystem/properties/json/api/proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md similarity index 100% rename from docs/_pages/storage/filesystem/properties/json/api/proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md rename to docs/storage/filesystem/properties/json/api/proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md diff --git a/docs/_pages/storage/filesystem/properties/json/api/proffer.storage.filesystempropertiesjsonservicecollectionextensions.md b/docs/storage/filesystem/properties/json/api/proffer.storage.filesystempropertiesjsonservicecollectionextensions.md similarity index 100% rename from docs/_pages/storage/filesystem/properties/json/api/proffer.storage.filesystempropertiesjsonservicecollectionextensions.md rename to docs/storage/filesystem/properties/json/api/proffer.storage.filesystempropertiesjsonservicecollectionextensions.md diff --git a/docs/_pages/storage/filesystem/server/api/index.md b/docs/storage/filesystem/server/api/index.md similarity index 100% rename from docs/_pages/storage/filesystem/server/api/index.md rename to docs/storage/filesystem/server/api/index.md diff --git a/docs/_pages/storage/filesystem/server/api/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md b/docs/storage/filesystem/server/api/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md similarity index 100% rename from docs/_pages/storage/filesystem/server/api/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md rename to docs/storage/filesystem/server/api/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md diff --git a/docs/_pages/storage/filesystem/server/api/proffer.storage.filesystem.server.filesystemstorageserveroptions.md b/docs/storage/filesystem/server/api/proffer.storage.filesystem.server.filesystemstorageserveroptions.md similarity index 100% rename from docs/_pages/storage/filesystem/server/api/proffer.storage.filesystem.server.filesystemstorageserveroptions.md rename to docs/storage/filesystem/server/api/proffer.storage.filesystem.server.filesystemstorageserveroptions.md diff --git a/docs/_pages/storage/filesystem/server/api/proffer.storage.filesystem.server.internal.publicurlprovider.md b/docs/storage/filesystem/server/api/proffer.storage.filesystem.server.internal.publicurlprovider.md similarity index 100% rename from docs/_pages/storage/filesystem/server/api/proffer.storage.filesystem.server.internal.publicurlprovider.md rename to docs/storage/filesystem/server/api/proffer.storage.filesystem.server.internal.publicurlprovider.md diff --git a/docs/_pages/storage/filesystem/server/api/proffer.storage.servicecollectionextensions.md b/docs/storage/filesystem/server/api/proffer.storage.servicecollectionextensions.md similarity index 100% rename from docs/_pages/storage/filesystem/server/api/proffer.storage.servicecollectionextensions.md rename to docs/storage/filesystem/server/api/proffer.storage.servicecollectionextensions.md diff --git a/docs/_pages/templating/api/index.md b/docs/templating/api/index.md similarity index 100% rename from docs/_pages/templating/api/index.md rename to docs/templating/api/index.md diff --git a/docs/_pages/templating/api/proffer.templating.exceptions.providernotfoundexception.md b/docs/templating/api/proffer.templating.exceptions.providernotfoundexception.md similarity index 100% rename from docs/_pages/templating/api/proffer.templating.exceptions.providernotfoundexception.md rename to docs/templating/api/proffer.templating.exceptions.providernotfoundexception.md diff --git a/docs/_pages/templating/api/proffer.templating.exceptions.templatenotfoundexception.md b/docs/templating/api/proffer.templating.exceptions.templatenotfoundexception.md similarity index 100% rename from docs/_pages/templating/api/proffer.templating.exceptions.templatenotfoundexception.md rename to docs/templating/api/proffer.templating.exceptions.templatenotfoundexception.md diff --git a/docs/_pages/templating/api/proffer.templating.internal.templateloader.md b/docs/templating/api/proffer.templating.internal.templateloader.md similarity index 100% rename from docs/_pages/templating/api/proffer.templating.internal.templateloader.md rename to docs/templating/api/proffer.templating.internal.templateloader.md diff --git a/docs/_pages/templating/api/proffer.templating.internal.templateloaderfactory.md b/docs/templating/api/proffer.templating.internal.templateloaderfactory.md similarity index 100% rename from docs/_pages/templating/api/proffer.templating.internal.templateloaderfactory.md rename to docs/templating/api/proffer.templating.internal.templateloaderfactory.md diff --git a/docs/_pages/templating/api/proffer.templating.invalidcontextexception.md b/docs/templating/api/proffer.templating.invalidcontextexception.md similarity index 100% rename from docs/_pages/templating/api/proffer.templating.invalidcontextexception.md rename to docs/templating/api/proffer.templating.invalidcontextexception.md diff --git a/docs/_pages/templating/api/proffer.templating.itemplate.md b/docs/templating/api/proffer.templating.itemplate.md similarity index 100% rename from docs/_pages/templating/api/proffer.templating.itemplate.md rename to docs/templating/api/proffer.templating.itemplate.md diff --git a/docs/_pages/templating/api/proffer.templating.itemplateloader.md b/docs/templating/api/proffer.templating.itemplateloader.md similarity index 100% rename from docs/_pages/templating/api/proffer.templating.itemplateloader.md rename to docs/templating/api/proffer.templating.itemplateloader.md diff --git a/docs/_pages/templating/api/proffer.templating.itemplateloaderfactory.md b/docs/templating/api/proffer.templating.itemplateloaderfactory.md similarity index 100% rename from docs/_pages/templating/api/proffer.templating.itemplateloaderfactory.md rename to docs/templating/api/proffer.templating.itemplateloaderfactory.md diff --git a/docs/_pages/templating/api/proffer.templating.itemplateprovider.md b/docs/templating/api/proffer.templating.itemplateprovider.md similarity index 100% rename from docs/_pages/templating/api/proffer.templating.itemplateprovider.md rename to docs/templating/api/proffer.templating.itemplateprovider.md diff --git a/docs/_pages/templating/api/proffer.templating.itemplateproviderscope.md b/docs/templating/api/proffer.templating.itemplateproviderscope.md similarity index 100% rename from docs/_pages/templating/api/proffer.templating.itemplateproviderscope.md rename to docs/templating/api/proffer.templating.itemplateproviderscope.md diff --git a/docs/_pages/templating/api/proffer.templating.templatecollectionbase-1.md b/docs/templating/api/proffer.templating.templatecollectionbase-1.md similarity index 100% rename from docs/_pages/templating/api/proffer.templating.templatecollectionbase-1.md rename to docs/templating/api/proffer.templating.templatecollectionbase-1.md diff --git a/docs/_pages/templating/api/proffer.templating.templatecollectionbase.md b/docs/templating/api/proffer.templating.templatecollectionbase.md similarity index 100% rename from docs/_pages/templating/api/proffer.templating.templatecollectionbase.md rename to docs/templating/api/proffer.templating.templatecollectionbase.md diff --git a/docs/_pages/templating/api/proffer.templating.templatingservicecollectionextensions.md b/docs/templating/api/proffer.templating.templatingservicecollectionextensions.md similarity index 100% rename from docs/_pages/templating/api/proffer.templating.templatingservicecollectionextensions.md rename to docs/templating/api/proffer.templating.templatingservicecollectionextensions.md diff --git a/docs/_pages/templating/handlebars/api/index.md b/docs/templating/handlebars/api/index.md similarity index 100% rename from docs/_pages/templating/handlebars/api/index.md rename to docs/templating/handlebars/api/index.md diff --git a/docs/_pages/templating/handlebars/api/proffer.templating.handlebars.handlebarstemplate.md b/docs/templating/handlebars/api/proffer.templating.handlebars.handlebarstemplate.md similarity index 100% rename from docs/_pages/templating/handlebars/api/proffer.templating.handlebars.handlebarstemplate.md rename to docs/templating/handlebars/api/proffer.templating.handlebars.handlebarstemplate.md diff --git a/docs/_pages/templating/handlebars/api/proffer.templating.handlebars.handlebarstemplateprovider.md b/docs/templating/handlebars/api/proffer.templating.handlebars.handlebarstemplateprovider.md similarity index 100% rename from docs/_pages/templating/handlebars/api/proffer.templating.handlebars.handlebarstemplateprovider.md rename to docs/templating/handlebars/api/proffer.templating.handlebars.handlebarstemplateprovider.md diff --git a/docs/_pages/templating/handlebars/api/proffer.templating.handlebarsservicecollectionextensions.md b/docs/templating/handlebars/api/proffer.templating.handlebarsservicecollectionextensions.md similarity index 100% rename from docs/_pages/templating/handlebars/api/proffer.templating.handlebarsservicecollectionextensions.md rename to docs/templating/handlebars/api/proffer.templating.handlebarsservicecollectionextensions.md diff --git a/docs/_pages/templating/mustache/api/index.md b/docs/templating/mustache/api/index.md similarity index 100% rename from docs/_pages/templating/mustache/api/index.md rename to docs/templating/mustache/api/index.md diff --git a/docs/_pages/templating/mustache/api/proffer.templating.mustache.mustachetemplate.md b/docs/templating/mustache/api/proffer.templating.mustache.mustachetemplate.md similarity index 100% rename from docs/_pages/templating/mustache/api/proffer.templating.mustache.mustachetemplate.md rename to docs/templating/mustache/api/proffer.templating.mustache.mustachetemplate.md diff --git a/docs/_pages/templating/mustache/api/proffer.templating.mustache.mustachetemplateprovider.md b/docs/templating/mustache/api/proffer.templating.mustache.mustachetemplateprovider.md similarity index 100% rename from docs/_pages/templating/mustache/api/proffer.templating.mustache.mustachetemplateprovider.md rename to docs/templating/mustache/api/proffer.templating.mustache.mustachetemplateprovider.md diff --git a/docs/_pages/templating/mustache/api/proffer.templating.mustacheservicecollectionextensions.md b/docs/templating/mustache/api/proffer.templating.mustacheservicecollectionextensions.md similarity index 100% rename from docs/_pages/templating/mustache/api/proffer.templating.mustacheservicecollectionextensions.md rename to docs/templating/mustache/api/proffer.templating.mustacheservicecollectionextensions.md diff --git a/src/Directory.Build.targets b/src/Directory.Build.targets index a7df5df..1625a69 100644 --- a/src/Directory.Build.targets +++ b/src/Directory.Build.targets @@ -1,6 +1,6 @@ - + \ No newline at end of file From 6469ecc201b7d929313e43416ef9e18cc51af40d Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Sat, 22 May 2021 04:32:48 +0200 Subject: [PATCH 33/45] Site structure --- docs/404.html | 135 ----------------- docs/_config.yml | 138 +++++++++--------- docs/_data/authors.yml | 14 ++ docs/_data/navigation.yml | 11 ++ docs/_includes/head/custom.html | 9 ++ docs/_layouts/default2.html | 84 ----------- docs/_pages/api.md | 31 ++++ .../azure/index.md => _pages/core.azure.md} | 6 +- docs/{core/index.md => _pages/core.md} | 10 +- docs/_pages/home.md | 47 ++++++ docs/_pages/use-cases.md | 5 + docs/_posts/2021-05-22-hello-proffer.md | 13 ++ docs/api.md | 27 ---- .../azure/api => api/core/azure}/index.md | 0 ...zure.configuration.iazurestorageoptions.md | 0 docs/{core/api => api/core}/index.md | 0 ...ffer.configuration.inamedelementoptions.md | 0 .../proffer.configuration.ioptionerror.md | 0 .../proffer.configuration.iprovideroptions.md | 0 .../proffer.configuration.optionerror.md | 0 .../proffer.configuration.provideroptions.md | 0 .../core}/proffer.equalitycomparerbase-1.md | 0 .../api => api/email/in-memory}/index.md | 0 ...email.inmemory.iinmemoryemailrepository.md | 0 .../proffer.email.inmemory.inmemoryemail.md | 0 ...er.email.inmemory.inmemoryemailprovider.md | 0 ...mail.inmemory.inmemoryemailprovidertype.md | 0 ....email.inmemory.inmemoryemailrepository.md | 0 ...nmemoryemailservicecollectionextensions.md | 0 docs/{email/api => api/email}/index.md | 0 .../email}/proffer.email.emailoptions.md | 0 .../proffer.email.emailprovideroptions.md | 0 ....email.emailservicecollectionextensions.md | 0 .../email}/proffer.email.emailtemplatetype.md | 0 .../email}/proffer.email.iemailaddress.md | 0 .../email}/proffer.email.iemailattachment.md | 0 .../email}/proffer.email.iemailprovider.md | 0 .../proffer.email.iemailprovideroptions.md | 0 .../proffer.email.iemailprovidertype.md | 0 .../email}/proffer.email.iemailsender.md | 0 .../proffer.email.internal.emailaddress.md | 0 ...l.internal.emailaddressequalitycomparer.md | 0 ...rnal.emailaddressstrictequalitycomparer.md | 0 .../proffer.email.internal.emailattachment.md | 0 ...nternal.emailattachmentequalitycomparer.md | 0 .../proffer.email.internal.emailsender.md | 0 .../proffer.email.mockupexceptionsoptions.md | 0 .../email}/proffer.email.mockupoptions.md | 0 .../api => api/email/sendgrid}/index.md | 0 ...er.email.sendgrid.sendgridemailprovider.md | 0 ...mail.sendgrid.sendgridemailprovidertype.md | 0 ...offer.email.servicecollectionextensions.md | 0 .../smtp/api => api/email/smtp}/index.md | 0 .../proffer.email.smtp.smtpemailprovider.md | 0 ...roffer.email.smtp.smtpemailprovidertype.md | 0 ...il.smtpemailservicecollectionextensions.md | 0 .../api => api/storage/azure/blobs}/index.md | 0 ...e.azure.blobs.azureblobsstorageprovider.md | 0 ...fer.storage.azure.blobs.azureblobsstore.md | 0 ...s.configuration.azureblobsparsedoptions.md | 0 ...configuration.azureblobsprovideroptions.md | 0 ...figuration.azureblobsscopedstoreoptions.md | 0 ...bs.configuration.azureblobsstoreoptions.md | 0 ...blobs.internal.azureblobsfileproperties.md | 0 ....blobs.internal.azureblobsfilereference.md | 0 ...internal.azureblobslistdirectorywrapper.md | 0 ...lobs.internal.azureblobslistfilewrapper.md | 0 ...blobsstorageservicecollectionextensions.md | 0 .../api => api/storage/filesystem}/index.md | 0 ...m.configuration.filesystemparsedoptions.md | 0 ...configuration.filesystemprovideroptions.md | 0 ...figuration.filesystemscopedstoreoptions.md | 0 ...em.configuration.filesystemstoreoptions.md | 0 ...ge.filesystem.filesystemstorageprovider.md | 0 ...ffer.storage.filesystem.filesystemstore.md | 0 ....filesystem.iextendedpropertiesprovider.md | 0 ...esystem.internal.fileextendedproperties.md | 0 ...ystem.internal.filesystemfileproperties.md | 0 ...system.internal.filesystemfilereference.md | 0 ...r.storage.filesystem.ipublicurlprovider.md | 0 ...filesystem.noextendedpropertiesprovider.md | 0 ...ystemstorageservicecollectionextensions.md | 0 .../filesystem/properties/json}/index.md | 0 ...es.json.filesystempropertiesjsonoptions.md | 0 ...son.internal.extendedpropertiesprovider.md | 0 ...opertiesjsonservicecollectionextensions.md | 0 .../storage/filesystem/server}/index.md | 0 ...erver.filesystemstorageservermiddleware.md | 0 ...m.server.filesystemstorageserveroptions.md | 0 ...ystem.server.internal.publicurlprovider.md | 0 ...fer.storage.servicecollectionextensions.md | 0 docs/{storage/api => api/storage}/index.md | 0 ...offer.storage.configuration.accesslevel.md | 0 ...e.configuration.configurationextensions.md | 0 ....storage.configuration.iparsedoptions-3.md | 0 ...orage.configuration.iscopedstoreoptions.md | 0 ...fer.storage.configuration.istoreoptions.md | 0 ...torage.configuration.scopedstoreoptions.md | 0 ...er.storage.configuration.storageoptions.md | 0 ...ffer.storage.configuration.storeoptions.md | 0 ...age.exceptions.badproviderconfiguration.md | 0 ....exceptions.badscopedstoreconfiguration.md | 0 ...torage.exceptions.badstoreconfiguration.md | 0 ...e.exceptions.filealreadyexistsexception.md | 0 ...ge.exceptions.providernotfoundexception.md | 0 ...orage.exceptions.storenotfoundexception.md | 0 .../proffer.storage.ifileproperties.md | 0 .../proffer.storage.ifilereference.md | 0 ...age.internal.configureprovideroptions-4.md | 0 ...er.storage.internal.genericstoreproxy-1.md | 0 ...r.storage.internal.privatefilereference.md | 0 ...proffer.storage.internal.storagefactory.md | 0 ....storage.internal.storageproviderbase-4.md | 0 .../proffer.storage.iprivatefilereference.md | 0 .../proffer.storage.isharedaccesspolicy.md | 0 .../proffer.storage.istoragefactory.md | 0 .../proffer.storage.istorageprovider.md | 0 .../storage}/proffer.storage.istore-1.md | 0 .../storage}/proffer.storage.istore.md | 0 .../proffer.storage.istoreextensions.md | 0 .../proffer.storage.overwritepolicy.md | 0 ...proffer.storage.sharedaccesspermissions.md | 0 .../proffer.storage.sharedaccesspolicy.md | 0 ...rage.storageservicecollectionextensions.md | 0 .../storage}/proffer.storage.storebase.md | 0 .../templating/handlebars}/index.md | 0 ...emplating.handlebars.handlebarstemplate.md | 0 ...g.handlebars.handlebarstemplateprovider.md | 0 ...g.handlebarsservicecollectionextensions.md | 0 .../api => api/templating}/index.md | 0 .../api => api/templating/mustache}/index.md | 0 ...er.templating.mustache.mustachetemplate.md | 0 ...ating.mustache.mustachetemplateprovider.md | 0 ...ing.mustacheservicecollectionextensions.md | 0 ...ng.exceptions.providernotfoundexception.md | 0 ...ng.exceptions.templatenotfoundexception.md | 0 ...ffer.templating.internal.templateloader.md | 0 ...mplating.internal.templateloaderfactory.md | 0 ...ffer.templating.invalidcontextexception.md | 0 .../proffer.templating.itemplate.md | 0 .../proffer.templating.itemplateloader.md | 0 ...offer.templating.itemplateloaderfactory.md | 0 .../proffer.templating.itemplateprovider.md | 0 ...offer.templating.itemplateproviderscope.md | 0 ...fer.templating.templatecollectionbase-1.md | 0 ...offer.templating.templatecollectionbase.md | 0 ...g.templatingservicecollectionextensions.md | 0 docs/assets/css/style.scss | 5 - docs/assets/{img => images}/banner.png | Bin docs/assets/{img => images}/logo.png | Bin docs/index.md | 47 ------ docs/storage/azure/blobs/index.md | 0 docs/use-cases.md | 0 src/Directory.Build.targets | 2 +- src/Proffer.Email/Proffer.Email.csproj | 4 +- 155 files changed, 209 insertions(+), 379 deletions(-) delete mode 100644 docs/404.html create mode 100644 docs/_data/authors.yml create mode 100644 docs/_data/navigation.yml create mode 100644 docs/_includes/head/custom.html delete mode 100644 docs/_layouts/default2.html create mode 100644 docs/_pages/api.md rename docs/{core/azure/index.md => _pages/core.azure.md} (83%) rename docs/{core/index.md => _pages/core.md} (66%) create mode 100644 docs/_pages/home.md create mode 100644 docs/_pages/use-cases.md create mode 100644 docs/_posts/2021-05-22-hello-proffer.md delete mode 100644 docs/api.md rename docs/{core/azure/api => api/core/azure}/index.md (100%) rename docs/{core/azure/api => api/core/azure}/proffer.azure.configuration.iazurestorageoptions.md (100%) rename docs/{core/api => api/core}/index.md (100%) rename docs/{core/api => api/core}/proffer.configuration.inamedelementoptions.md (100%) rename docs/{core/api => api/core}/proffer.configuration.ioptionerror.md (100%) rename docs/{core/api => api/core}/proffer.configuration.iprovideroptions.md (100%) rename docs/{core/api => api/core}/proffer.configuration.optionerror.md (100%) rename docs/{core/api => api/core}/proffer.configuration.provideroptions.md (100%) rename docs/{core/api => api/core}/proffer.equalitycomparerbase-1.md (100%) rename docs/{email/in-memory/api => api/email/in-memory}/index.md (100%) rename docs/{email/in-memory/api => api/email/in-memory}/proffer.email.inmemory.iinmemoryemailrepository.md (100%) rename docs/{email/in-memory/api => api/email/in-memory}/proffer.email.inmemory.inmemoryemail.md (100%) rename docs/{email/in-memory/api => api/email/in-memory}/proffer.email.inmemory.inmemoryemailprovider.md (100%) rename docs/{email/in-memory/api => api/email/in-memory}/proffer.email.inmemory.inmemoryemailprovidertype.md (100%) rename docs/{email/in-memory/api => api/email/in-memory}/proffer.email.inmemory.inmemoryemailrepository.md (100%) rename docs/{email/in-memory/api => api/email/in-memory}/proffer.email.inmemoryemailservicecollectionextensions.md (100%) rename docs/{email/api => api/email}/index.md (100%) rename docs/{email/api => api/email}/proffer.email.emailoptions.md (100%) rename docs/{email/api => api/email}/proffer.email.emailprovideroptions.md (100%) rename docs/{email/api => api/email}/proffer.email.emailservicecollectionextensions.md (100%) rename docs/{email/api => api/email}/proffer.email.emailtemplatetype.md (100%) rename docs/{email/api => api/email}/proffer.email.iemailaddress.md (100%) rename docs/{email/api => api/email}/proffer.email.iemailattachment.md (100%) rename docs/{email/api => api/email}/proffer.email.iemailprovider.md (100%) rename docs/{email/api => api/email}/proffer.email.iemailprovideroptions.md (100%) rename docs/{email/api => api/email}/proffer.email.iemailprovidertype.md (100%) rename docs/{email/api => api/email}/proffer.email.iemailsender.md (100%) rename docs/{email/api => api/email}/proffer.email.internal.emailaddress.md (100%) rename docs/{email/api => api/email}/proffer.email.internal.emailaddressequalitycomparer.md (100%) rename docs/{email/api => api/email}/proffer.email.internal.emailaddressstrictequalitycomparer.md (100%) rename docs/{email/api => api/email}/proffer.email.internal.emailattachment.md (100%) rename docs/{email/api => api/email}/proffer.email.internal.emailattachmentequalitycomparer.md (100%) rename docs/{email/api => api/email}/proffer.email.internal.emailsender.md (100%) rename docs/{email/api => api/email}/proffer.email.mockupexceptionsoptions.md (100%) rename docs/{email/api => api/email}/proffer.email.mockupoptions.md (100%) rename docs/{email/sendgrid/api => api/email/sendgrid}/index.md (100%) rename docs/{email/sendgrid/api => api/email/sendgrid}/proffer.email.sendgrid.sendgridemailprovider.md (100%) rename docs/{email/sendgrid/api => api/email/sendgrid}/proffer.email.sendgrid.sendgridemailprovidertype.md (100%) rename docs/{email/sendgrid/api => api/email/sendgrid}/proffer.email.servicecollectionextensions.md (100%) rename docs/{email/smtp/api => api/email/smtp}/index.md (100%) rename docs/{email/smtp/api => api/email/smtp}/proffer.email.smtp.smtpemailprovider.md (100%) rename docs/{email/smtp/api => api/email/smtp}/proffer.email.smtp.smtpemailprovidertype.md (100%) rename docs/{email/smtp/api => api/email/smtp}/proffer.email.smtpemailservicecollectionextensions.md (100%) rename docs/{storage/azure/blobs/api => api/storage/azure/blobs}/index.md (100%) rename docs/{storage/azure/blobs/api => api/storage/azure/blobs}/proffer.storage.azure.blobs.azureblobsstorageprovider.md (100%) rename docs/{storage/azure/blobs/api => api/storage/azure/blobs}/proffer.storage.azure.blobs.azureblobsstore.md (100%) rename docs/{storage/azure/blobs/api => api/storage/azure/blobs}/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md (100%) rename docs/{storage/azure/blobs/api => api/storage/azure/blobs}/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md (100%) rename docs/{storage/azure/blobs/api => api/storage/azure/blobs}/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md (100%) rename docs/{storage/azure/blobs/api => api/storage/azure/blobs}/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md (100%) rename docs/{storage/azure/blobs/api => api/storage/azure/blobs}/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md (100%) rename docs/{storage/azure/blobs/api => api/storage/azure/blobs}/proffer.storage.azure.blobs.internal.azureblobsfilereference.md (100%) rename docs/{storage/azure/blobs/api => api/storage/azure/blobs}/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md (100%) rename docs/{storage/azure/blobs/api => api/storage/azure/blobs}/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md (100%) rename docs/{storage/azure/blobs/api => api/storage/azure/blobs}/proffer.storage.azureblobsstorageservicecollectionextensions.md (100%) rename docs/{storage/filesystem/api => api/storage/filesystem}/index.md (100%) rename docs/{storage/filesystem/api => api/storage/filesystem}/proffer.storage.filesystem.configuration.filesystemparsedoptions.md (100%) rename docs/{storage/filesystem/api => api/storage/filesystem}/proffer.storage.filesystem.configuration.filesystemprovideroptions.md (100%) rename docs/{storage/filesystem/api => api/storage/filesystem}/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md (100%) rename docs/{storage/filesystem/api => api/storage/filesystem}/proffer.storage.filesystem.configuration.filesystemstoreoptions.md (100%) rename docs/{storage/filesystem/api => api/storage/filesystem}/proffer.storage.filesystem.filesystemstorageprovider.md (100%) rename docs/{storage/filesystem/api => api/storage/filesystem}/proffer.storage.filesystem.filesystemstore.md (100%) rename docs/{storage/filesystem/api => api/storage/filesystem}/proffer.storage.filesystem.iextendedpropertiesprovider.md (100%) rename docs/{storage/filesystem/api => api/storage/filesystem}/proffer.storage.filesystem.internal.fileextendedproperties.md (100%) rename docs/{storage/filesystem/api => api/storage/filesystem}/proffer.storage.filesystem.internal.filesystemfileproperties.md (100%) rename docs/{storage/filesystem/api => api/storage/filesystem}/proffer.storage.filesystem.internal.filesystemfilereference.md (100%) rename docs/{storage/filesystem/api => api/storage/filesystem}/proffer.storage.filesystem.ipublicurlprovider.md (100%) rename docs/{storage/filesystem/api => api/storage/filesystem}/proffer.storage.filesystem.noextendedpropertiesprovider.md (100%) rename docs/{storage/filesystem/api => api/storage/filesystem}/proffer.storage.filesystemstorageservicecollectionextensions.md (100%) rename docs/{storage/filesystem/properties/json/api => api/storage/filesystem/properties/json}/index.md (100%) rename docs/{storage/filesystem/properties/json/api => api/storage/filesystem/properties/json}/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md (100%) rename docs/{storage/filesystem/properties/json/api => api/storage/filesystem/properties/json}/proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md (100%) rename docs/{storage/filesystem/properties/json/api => api/storage/filesystem/properties/json}/proffer.storage.filesystempropertiesjsonservicecollectionextensions.md (100%) rename docs/{storage/filesystem/server/api => api/storage/filesystem/server}/index.md (100%) rename docs/{storage/filesystem/server/api => api/storage/filesystem/server}/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md (100%) rename docs/{storage/filesystem/server/api => api/storage/filesystem/server}/proffer.storage.filesystem.server.filesystemstorageserveroptions.md (100%) rename docs/{storage/filesystem/server/api => api/storage/filesystem/server}/proffer.storage.filesystem.server.internal.publicurlprovider.md (100%) rename docs/{storage/filesystem/server/api => api/storage/filesystem/server}/proffer.storage.servicecollectionextensions.md (100%) rename docs/{storage/api => api/storage}/index.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.configuration.accesslevel.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.configuration.configurationextensions.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.configuration.iparsedoptions-3.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.configuration.iscopedstoreoptions.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.configuration.istoreoptions.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.configuration.scopedstoreoptions.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.configuration.storageoptions.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.configuration.storeoptions.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.exceptions.badproviderconfiguration.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.exceptions.badscopedstoreconfiguration.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.exceptions.badstoreconfiguration.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.exceptions.filealreadyexistsexception.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.exceptions.providernotfoundexception.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.exceptions.storenotfoundexception.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.ifileproperties.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.ifilereference.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.internal.configureprovideroptions-4.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.internal.genericstoreproxy-1.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.internal.privatefilereference.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.internal.storagefactory.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.internal.storageproviderbase-4.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.iprivatefilereference.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.isharedaccesspolicy.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.istoragefactory.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.istorageprovider.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.istore-1.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.istore.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.istoreextensions.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.overwritepolicy.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.sharedaccesspermissions.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.sharedaccesspolicy.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.storageservicecollectionextensions.md (100%) rename docs/{storage/api => api/storage}/proffer.storage.storebase.md (100%) rename docs/{templating/handlebars/api => api/templating/handlebars}/index.md (100%) rename docs/{templating/handlebars/api => api/templating/handlebars}/proffer.templating.handlebars.handlebarstemplate.md (100%) rename docs/{templating/handlebars/api => api/templating/handlebars}/proffer.templating.handlebars.handlebarstemplateprovider.md (100%) rename docs/{templating/handlebars/api => api/templating/handlebars}/proffer.templating.handlebarsservicecollectionextensions.md (100%) rename docs/{templating/api => api/templating}/index.md (100%) rename docs/{templating/mustache/api => api/templating/mustache}/index.md (100%) rename docs/{templating/mustache/api => api/templating/mustache}/proffer.templating.mustache.mustachetemplate.md (100%) rename docs/{templating/mustache/api => api/templating/mustache}/proffer.templating.mustache.mustachetemplateprovider.md (100%) rename docs/{templating/mustache/api => api/templating/mustache}/proffer.templating.mustacheservicecollectionextensions.md (100%) rename docs/{templating/api => api/templating}/proffer.templating.exceptions.providernotfoundexception.md (100%) rename docs/{templating/api => api/templating}/proffer.templating.exceptions.templatenotfoundexception.md (100%) rename docs/{templating/api => api/templating}/proffer.templating.internal.templateloader.md (100%) rename docs/{templating/api => api/templating}/proffer.templating.internal.templateloaderfactory.md (100%) rename docs/{templating/api => api/templating}/proffer.templating.invalidcontextexception.md (100%) rename docs/{templating/api => api/templating}/proffer.templating.itemplate.md (100%) rename docs/{templating/api => api/templating}/proffer.templating.itemplateloader.md (100%) rename docs/{templating/api => api/templating}/proffer.templating.itemplateloaderfactory.md (100%) rename docs/{templating/api => api/templating}/proffer.templating.itemplateprovider.md (100%) rename docs/{templating/api => api/templating}/proffer.templating.itemplateproviderscope.md (100%) rename docs/{templating/api => api/templating}/proffer.templating.templatecollectionbase-1.md (100%) rename docs/{templating/api => api/templating}/proffer.templating.templatecollectionbase.md (100%) rename docs/{templating/api => api/templating}/proffer.templating.templatingservicecollectionextensions.md (100%) delete mode 100644 docs/assets/css/style.scss rename docs/assets/{img => images}/banner.png (100%) rename docs/assets/{img => images}/logo.png (100%) delete mode 100644 docs/index.md delete mode 100644 docs/storage/azure/blobs/index.md delete mode 100644 docs/use-cases.md diff --git a/docs/404.html b/docs/404.html deleted file mode 100644 index 9656eab..0000000 --- a/docs/404.html +++ /dev/null @@ -1,135 +0,0 @@ - - - - - 404 - - - - - - diff --git a/docs/_config.yml b/docs/_config.yml index f2b0f85..9d1d705 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -6,98 +6,93 @@ # `jekyll serve`. If you change this file, please restart the server process. # Theme Settings -# -# Review documentation to determine if you should use `theme` or `remote_theme` # https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/#installing-the-theme -# theme : "minimal-mistakes-jekyll" -remote_theme : "mmistakes/minimal-mistakes" -minimal_mistakes_skin : "dark" # "air", "aqua", "contrast", "dark", "dirt", "neon", "mint", "plum", "sunrise" +remote_theme: "mmistakes/minimal-mistakes" +minimal_mistakes_skin: "dark" # "air", "aqua", "contrast", "dark", "dirt", "neon", "mint", "plum", "sunrise" +main_color: "#5c2d91" # Site Settings -locale : "en-US" -title : "Proffer" -title_separator : "-" -subtitle : # site tagline that appears below site title in masthead -name : "Your Name" -description : "An amazing website." -url : # the base hostname & protocol for your site e.g. "https://mmistakes.github.io" -baseurl : # the subpath of your site, e.g. "/blog" -repository : # GitHub username/repo-name e.g. "mmistakes/minimal-mistakes" -teaser : # path of fallback teaser image, e.g. "/assets/images/500x300.png" -logo : /assets/img/logo.png # path of logo image to display in the masthead, e.g. "/assets/images/88x88.png" -masthead_title : # overrides the website title displayed in the masthead, use " " for no title +locale: "en-US" +title: "Proffer" +title_separator: "-" +subtitle: # site tagline that appears below site title in masthead +name: &name "Adrien Siffermann" +description: &description ".NET Core basic abstractions to configuration-driven providers" +url: https://getproffer.net +repository: asiffermann/proffer +teaser: /assets/images/banner.png +logo: /assets/images/logo.png +masthead_title: # overrides the website title displayed in the masthead, use " " for no title # breadcrumbs : false # true, false (default) -words_per_minute : 200 +words_per_minute: 200 comments: - provider : # false (default), "disqus", "discourse", "facebook", "staticman", "staticman_v2", "utterances", "custom" + provider: # false (default), "disqus", "discourse", "facebook", "staticman", "staticman_v2", "utterances", "custom" disqus: - shortname : # https://help.disqus.com/customer/portal/articles/466208-what-s-a-shortname- + shortname: # https://help.disqus.com/customer/portal/articles/466208-what-s-a-shortname- discourse: - server : # https://meta.discourse.org/t/embedding-discourse-comments-via-javascript/31963 , e.g.: meta.discourse.org + server: # https://meta.discourse.org/t/embedding-discourse-comments-via-javascript/31963 , e.g.: meta.discourse.org facebook: # https://developers.facebook.com/docs/plugins/comments - appid : - num_posts : # 5 (default) - colorscheme : # "light" (default), "dark" + appid: + num_posts: # 5 (default) + colorscheme: # "light" (default), "dark" utterances: - theme : # "github-light" (default), "github-dark" - issue_term : # "pathname" (default) + theme: # "github-light" (default), "github-dark" + issue_term: # "pathname" (default) staticman: - branch : # "master" - endpoint : # "https://{your Staticman v3 API}/v3/entry/github/" + branch: # "master" + endpoint: # "https://{your Staticman v3 API}/v3/entry/github/" reCaptcha: - siteKey : - secret : + siteKey: + secret: atom_feed: - path : # blank (default) uses feed.xml - hide : # true, false (default) -search : # true, false (default) -search_full_content : # true, false (default) -search_provider : # lunr (default), algolia, google + path: # blank (default) uses feed.xml + hide: # true, false (default) +search: # true, false (default) +search_full_content: # true, false (default) +search_provider: # lunr (default), algolia, google algolia: - application_id : # YOUR_APPLICATION_ID - index_name : # YOUR_INDEX_NAME - search_only_api_key : # YOUR_SEARCH_ONLY_API_KEY - powered_by : # true (default), false + application_id: # YOUR_APPLICATION_ID + index_name: # YOUR_INDEX_NAME + search_only_api_key: # YOUR_SEARCH_ONLY_API_KEY + powered_by: # true (default), false google: - search_engine_id : # YOUR_SEARCH_ENGINE_ID - instant_search : # false (default), true + search_engine_id: # YOUR_SEARCH_ENGINE_ID + instant_search: # false (default), true # SEO Related -google_site_verification : -bing_site_verification : -yandex_site_verification : -naver_site_verification : +google_site_verification: +bing_site_verification: +yandex_site_verification: +naver_site_verification: # Social Sharing twitter: - username : proffer_dotnet - card : summary_large_image + username: &twitter proffer_dotnet + card: summary_large_image facebook: - username : - app_id : - publisher : -og_image : /assets/img/banner.png # Open Graph/Twitter default site image + username: + app_id: + publisher: +og_image: /assets/images/banner.png # Open Graph/Twitter default site image # For specifying social profiles # - https://developers.google.com/structured-data/customize/social-profiles social: - type : Organization - name : Proffer + type: Organization + name: Proffer links: - https://github.com/asiffermann/proffer - https://twitter.com/proffer_dotnet # Analytics analytics: - provider : false # false (default), "google", "google-universal", "google-gtag", "custom" + provider: false # false (default), "google", "google-universal", "google-gtag", "custom" google: - tracking_id : - anonymize_ip : # true, false (default) - + tracking_id: + anonymize_ip: # true, false (default) # Site Author -author: asiffermann - +author: *name # Site Footer footer: @@ -109,7 +104,6 @@ footer: icon: "fab fa-fw fa-github" url: https://github.com/asiffermann/proffer - # Reading Files include: - .htaccess @@ -147,7 +141,6 @@ keep_files: encoding: "utf-8" markdown_ext: "markdown,mkdown,mkdn,mkd,md" - # Conversion markdown: kramdown highlighter: rouge @@ -155,7 +148,6 @@ lsi: false excerpt_separator: "\n\n" incremental: false - # Markdown Processing kramdown: input: GFM @@ -167,19 +159,16 @@ kramdown: smart_quotes: lsquo,rsquo,ldquo,rdquo enable_coderay: false - # Sass/SCSS sass: sass_dir: _sass style: compressed # https://sass-lang.com/documentation/file.SASS_REFERENCE.html#output_style - # Outputting permalink: /:categories/:title/ paginate: 5 # amount of posts to show paginate_path: /page:num/ -timezone: # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones - +timezone: Europe/Paris # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones # Plugins (previously gems:) plugins: @@ -197,7 +186,6 @@ whitelist: - jekyll-feed - jekyll-include-cache - # Archives # Type # - GitHub Pages compatible archive pages built with Liquid ~> type: liquid (default) @@ -226,7 +214,6 @@ tag_archive: # category: /categories/:name/ # tag: /tags/:name/ - # HTML Compression # - https://jch.penibelst.de/ compress_html: @@ -234,14 +221,12 @@ compress_html: ignore: envs: development +titles_from_headings: + enabled: true + strip_title: true # Defaults defaults: - - scope: - path: "" - values: - image: /assets/img/banner.png - layout: single # _posts - scope: path: "" @@ -253,3 +238,10 @@ defaults: comments: # true share: true related: true + # _pages + - scope: + path: "_pages" + type: pages + values: + layout: single + author_profile: false diff --git a/docs/_data/authors.yml b/docs/_data/authors.yml new file mode 100644 index 0000000..5e00019 --- /dev/null +++ b/docs/_data/authors.yml @@ -0,0 +1,14 @@ +Adrien Siffermann: + name: "Adrien Siffermann" + avatar: https://avatars.githubusercontent.com/u/12293953?v=4 + bio: "I'm a freelance full stack developer. I love Cloud and Web development, automation and ALM. Cultural all-rounder, science addict and bon vivant above all!" + location: "Paris, France" + email: adrien@siffermann.me + links: + - label: "Twitter" + icon: "fab fa-fw fa-twitter-square" + url: "https://twitter.com/asiffermann" + - label: "GitHub" + icon: "fab fa-fw fa-github" + url: "https://github.com/asiffermann" + diff --git a/docs/_data/navigation.yml b/docs/_data/navigation.yml new file mode 100644 index 0000000..89b4a53 --- /dev/null +++ b/docs/_data/navigation.yml @@ -0,0 +1,11 @@ +main: + - title: "Getting started" + url: /getting-started/ + - title: "About" + url: /about/ + - title: "Posts" + url: /year-archive/ + - title: "Use cases" + url: /use-cases/ + - title: "API documentation" + url: /api/ \ No newline at end of file diff --git a/docs/_includes/head/custom.html b/docs/_includes/head/custom.html new file mode 100644 index 0000000..b57e5c5 --- /dev/null +++ b/docs/_includes/head/custom.html @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/_layouts/default2.html b/docs/_layouts/default2.html deleted file mode 100644 index 601f964..0000000 --- a/docs/_layouts/default2.html +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - {% seo %} - - -
    -
    - -

    {{ site.title | default: site.github.repository_name }}

    -     -

    {{ site.description | default: site.github.project_tagline }}

    - {% if site.github.is_project_page %} - View project on GitHub - {% endif %} - {% if site.github.is_user_page %} - Follow me on GitHub - {% endif %} -
    -
    - -
    -
    -
    - {{ content }} -
    - - -
    -
    - - diff --git a/docs/_pages/api.md b/docs/_pages/api.md new file mode 100644 index 0000000..29a5f94 --- /dev/null +++ b/docs/_pages/api.md @@ -0,0 +1,31 @@ +--- +permalink: /api/ +--- + +# API documentation + +## Core libraries + +- [Proffer](/api/core) +- [Proffer.Azure](/api/core/azure) + +## Storage + +- [Proffer.Storage](/api/storage) +- [Proffer.Storage.Azure.Blobs](/api/storage/azure/blobs) +- [Proffer.Storage.FileSystem](/api/storage/filesystem) +- [Proffer.Storage.FileSystem.Properties.Json](/api/storage/filesystem/properties/json) +- [Proffer.Storage.FileSystem.Server](/api/storage/filesystem/server) + +## Templating + +- [Proffer.Templating](/api/templating) +- [Proffer.Templating.Handlebars](/api/templating/handlebars) +- [Proffer.Templating.Mustache](/api/templating/mustache) + +## Email + +- [Proffer.Email](/api/email) +- [Proffer.Email.Smtp](/api/email/smtp) +- [Proffer.Email.SendGrid](/api/email/sendgrid) +- [Proffer.Email.InMemory](/api/email/in-memory) diff --git a/docs/core/azure/index.md b/docs/_pages/core.azure.md similarity index 83% rename from docs/core/azure/index.md rename to docs/_pages/core.azure.md index 838c806..85634b2 100644 --- a/docs/core/azure/index.md +++ b/docs/_pages/core.azure.md @@ -1,3 +1,7 @@ +--- +permalink: /core/azure/ +--- + # Core Azure library This library provides common abstractions for any Proffer provider connected to Azure Storage (like [Proffer.Storage.Azure.Blobs](../../storage/azure/blobs) or Proffer.Events.Azure.Queues). @@ -6,4 +10,4 @@ There is not much here until the configuration will be shared across all differe ## API documentation -- [Proffer.Azure](./api) \ No newline at end of file +- [Proffer.Azure](/api/core/azure) \ No newline at end of file diff --git a/docs/core/index.md b/docs/_pages/core.md similarity index 66% rename from docs/core/index.md rename to docs/_pages/core.md index e05a7f8..d44097c 100644 --- a/docs/core/index.md +++ b/docs/_pages/core.md @@ -1,3 +1,7 @@ +--- +permalink: /core/ +--- + # Core libraries Those libraries provide common abstractions for any Proffer project or provider. @@ -6,9 +10,9 @@ There is not much here until the configuration will be shared across all differe ## Projects -- [Proffer.Azure](./azure) +- [Proffer.Azure](/core/azure) ## API documentation -- [Proffer](./api) -- [Proffer.Azure](./azure/api) +- [Proffer](/api/core) +- [Proffer.Azure](/api/core/azure) diff --git a/docs/_pages/home.md b/docs/_pages/home.md new file mode 100644 index 0000000..528ddf1 --- /dev/null +++ b/docs/_pages/home.md @@ -0,0 +1,47 @@ +--- +layout: splash +permalink: / +hidden: true +header: + overlay_color: "#5c2d91" + overlay_image: /assets/images/banner.png + actions: + - label: " Install now" + url: "/getting-started/" + - label: " View on GitHub" + url: "https://github.com/asiffermann/proffer" +excerpt: > + .NET Core basic abstractions to configuration-driven providers
    + Latest release v0.1.0 +feature_row: + - image_path: /assets/images/banner.png + alt: "core" + title: "Core libraries" + excerpt: "Provide common abstractions for any Proffer project or provider." + url: "/core/" + btn_class: "btn--primary" + btn_label: "Learn more" + - image_path: /assets/images/banner.png + alt: "storage" + title: "Storage" + excerpt: "File Storage abstractions with providers." + url: "/storage/" + btn_class: "btn--primary" + btn_label: "Learn more" + - image_path: /assets/images/banner.png + alt: "templating" + title: "Templating" + excerpt: "Templating abstractions with providers." + url: "/templating/" + btn_class: "btn--primary" + btn_label: "Learn more" + - image_path: /assets/images/banner.png + alt: "email" + title: "Email" + excerpt: "Templated email sending abstractions with providers." + url: "/email/" + btn_class: "btn--primary" + btn_label: "Learn more" +--- + +{% include feature_row %} \ No newline at end of file diff --git a/docs/_pages/use-cases.md b/docs/_pages/use-cases.md new file mode 100644 index 0000000..d33084f --- /dev/null +++ b/docs/_pages/use-cases.md @@ -0,0 +1,5 @@ +--- +permalink: /use-cases/ +--- + +# Use cases \ No newline at end of file diff --git a/docs/_posts/2021-05-22-hello-proffer.md b/docs/_posts/2021-05-22-hello-proffer.md new file mode 100644 index 0000000..ba4f6cc --- /dev/null +++ b/docs/_posts/2021-05-22-hello-proffer.md @@ -0,0 +1,13 @@ +--- +categories: + - News +tags: + - Core + - Storage + - Templating + - Email +--- + +# Hello Proffer! + +New release ... diff --git a/docs/api.md b/docs/api.md deleted file mode 100644 index 09f034e..0000000 --- a/docs/api.md +++ /dev/null @@ -1,27 +0,0 @@ -# API documentation - -## Core libraries - -- [Proffer](/core/api) -- [Proffer.Azure](/core/azure/api) - -## Storage - -- [Proffer.Storage](/storage/api) -- [Proffer.Storage.Azure.Blobs](/storage/azure/blobs/api) -- [Proffer.Storage.FileSystem](/storage/filesystem/api) -- [Proffer.Storage.FileSystem.Properties.Json](/storage/filesystem/properties/json/api) -- [Proffer.Storage.FileSystem.Server](/storage/filesystem/server/api) - -## Templating - -- [Proffer.Templating](/templating/api) -- [Proffer.Templating.Handlebars](/templating/handlebars/api) -- [Proffer.Templating.Mustache](/templating/mustache/api) - -## Email - -- [Proffer.Email](/email/api) -- [Proffer.Email.Smtp](/email/smtp/api) -- [Proffer.Email.SendGrid](/email/sendgrid/api) -- [Proffer.Email.InMemory](/email/in-memory/api) diff --git a/docs/core/azure/api/index.md b/docs/api/core/azure/index.md similarity index 100% rename from docs/core/azure/api/index.md rename to docs/api/core/azure/index.md diff --git a/docs/core/azure/api/proffer.azure.configuration.iazurestorageoptions.md b/docs/api/core/azure/proffer.azure.configuration.iazurestorageoptions.md similarity index 100% rename from docs/core/azure/api/proffer.azure.configuration.iazurestorageoptions.md rename to docs/api/core/azure/proffer.azure.configuration.iazurestorageoptions.md diff --git a/docs/core/api/index.md b/docs/api/core/index.md similarity index 100% rename from docs/core/api/index.md rename to docs/api/core/index.md diff --git a/docs/core/api/proffer.configuration.inamedelementoptions.md b/docs/api/core/proffer.configuration.inamedelementoptions.md similarity index 100% rename from docs/core/api/proffer.configuration.inamedelementoptions.md rename to docs/api/core/proffer.configuration.inamedelementoptions.md diff --git a/docs/core/api/proffer.configuration.ioptionerror.md b/docs/api/core/proffer.configuration.ioptionerror.md similarity index 100% rename from docs/core/api/proffer.configuration.ioptionerror.md rename to docs/api/core/proffer.configuration.ioptionerror.md diff --git a/docs/core/api/proffer.configuration.iprovideroptions.md b/docs/api/core/proffer.configuration.iprovideroptions.md similarity index 100% rename from docs/core/api/proffer.configuration.iprovideroptions.md rename to docs/api/core/proffer.configuration.iprovideroptions.md diff --git a/docs/core/api/proffer.configuration.optionerror.md b/docs/api/core/proffer.configuration.optionerror.md similarity index 100% rename from docs/core/api/proffer.configuration.optionerror.md rename to docs/api/core/proffer.configuration.optionerror.md diff --git a/docs/core/api/proffer.configuration.provideroptions.md b/docs/api/core/proffer.configuration.provideroptions.md similarity index 100% rename from docs/core/api/proffer.configuration.provideroptions.md rename to docs/api/core/proffer.configuration.provideroptions.md diff --git a/docs/core/api/proffer.equalitycomparerbase-1.md b/docs/api/core/proffer.equalitycomparerbase-1.md similarity index 100% rename from docs/core/api/proffer.equalitycomparerbase-1.md rename to docs/api/core/proffer.equalitycomparerbase-1.md diff --git a/docs/email/in-memory/api/index.md b/docs/api/email/in-memory/index.md similarity index 100% rename from docs/email/in-memory/api/index.md rename to docs/api/email/in-memory/index.md diff --git a/docs/email/in-memory/api/proffer.email.inmemory.iinmemoryemailrepository.md b/docs/api/email/in-memory/proffer.email.inmemory.iinmemoryemailrepository.md similarity index 100% rename from docs/email/in-memory/api/proffer.email.inmemory.iinmemoryemailrepository.md rename to docs/api/email/in-memory/proffer.email.inmemory.iinmemoryemailrepository.md diff --git a/docs/email/in-memory/api/proffer.email.inmemory.inmemoryemail.md b/docs/api/email/in-memory/proffer.email.inmemory.inmemoryemail.md similarity index 100% rename from docs/email/in-memory/api/proffer.email.inmemory.inmemoryemail.md rename to docs/api/email/in-memory/proffer.email.inmemory.inmemoryemail.md diff --git a/docs/email/in-memory/api/proffer.email.inmemory.inmemoryemailprovider.md b/docs/api/email/in-memory/proffer.email.inmemory.inmemoryemailprovider.md similarity index 100% rename from docs/email/in-memory/api/proffer.email.inmemory.inmemoryemailprovider.md rename to docs/api/email/in-memory/proffer.email.inmemory.inmemoryemailprovider.md diff --git a/docs/email/in-memory/api/proffer.email.inmemory.inmemoryemailprovidertype.md b/docs/api/email/in-memory/proffer.email.inmemory.inmemoryemailprovidertype.md similarity index 100% rename from docs/email/in-memory/api/proffer.email.inmemory.inmemoryemailprovidertype.md rename to docs/api/email/in-memory/proffer.email.inmemory.inmemoryemailprovidertype.md diff --git a/docs/email/in-memory/api/proffer.email.inmemory.inmemoryemailrepository.md b/docs/api/email/in-memory/proffer.email.inmemory.inmemoryemailrepository.md similarity index 100% rename from docs/email/in-memory/api/proffer.email.inmemory.inmemoryemailrepository.md rename to docs/api/email/in-memory/proffer.email.inmemory.inmemoryemailrepository.md diff --git a/docs/email/in-memory/api/proffer.email.inmemoryemailservicecollectionextensions.md b/docs/api/email/in-memory/proffer.email.inmemoryemailservicecollectionextensions.md similarity index 100% rename from docs/email/in-memory/api/proffer.email.inmemoryemailservicecollectionextensions.md rename to docs/api/email/in-memory/proffer.email.inmemoryemailservicecollectionextensions.md diff --git a/docs/email/api/index.md b/docs/api/email/index.md similarity index 100% rename from docs/email/api/index.md rename to docs/api/email/index.md diff --git a/docs/email/api/proffer.email.emailoptions.md b/docs/api/email/proffer.email.emailoptions.md similarity index 100% rename from docs/email/api/proffer.email.emailoptions.md rename to docs/api/email/proffer.email.emailoptions.md diff --git a/docs/email/api/proffer.email.emailprovideroptions.md b/docs/api/email/proffer.email.emailprovideroptions.md similarity index 100% rename from docs/email/api/proffer.email.emailprovideroptions.md rename to docs/api/email/proffer.email.emailprovideroptions.md diff --git a/docs/email/api/proffer.email.emailservicecollectionextensions.md b/docs/api/email/proffer.email.emailservicecollectionextensions.md similarity index 100% rename from docs/email/api/proffer.email.emailservicecollectionextensions.md rename to docs/api/email/proffer.email.emailservicecollectionextensions.md diff --git a/docs/email/api/proffer.email.emailtemplatetype.md b/docs/api/email/proffer.email.emailtemplatetype.md similarity index 100% rename from docs/email/api/proffer.email.emailtemplatetype.md rename to docs/api/email/proffer.email.emailtemplatetype.md diff --git a/docs/email/api/proffer.email.iemailaddress.md b/docs/api/email/proffer.email.iemailaddress.md similarity index 100% rename from docs/email/api/proffer.email.iemailaddress.md rename to docs/api/email/proffer.email.iemailaddress.md diff --git a/docs/email/api/proffer.email.iemailattachment.md b/docs/api/email/proffer.email.iemailattachment.md similarity index 100% rename from docs/email/api/proffer.email.iemailattachment.md rename to docs/api/email/proffer.email.iemailattachment.md diff --git a/docs/email/api/proffer.email.iemailprovider.md b/docs/api/email/proffer.email.iemailprovider.md similarity index 100% rename from docs/email/api/proffer.email.iemailprovider.md rename to docs/api/email/proffer.email.iemailprovider.md diff --git a/docs/email/api/proffer.email.iemailprovideroptions.md b/docs/api/email/proffer.email.iemailprovideroptions.md similarity index 100% rename from docs/email/api/proffer.email.iemailprovideroptions.md rename to docs/api/email/proffer.email.iemailprovideroptions.md diff --git a/docs/email/api/proffer.email.iemailprovidertype.md b/docs/api/email/proffer.email.iemailprovidertype.md similarity index 100% rename from docs/email/api/proffer.email.iemailprovidertype.md rename to docs/api/email/proffer.email.iemailprovidertype.md diff --git a/docs/email/api/proffer.email.iemailsender.md b/docs/api/email/proffer.email.iemailsender.md similarity index 100% rename from docs/email/api/proffer.email.iemailsender.md rename to docs/api/email/proffer.email.iemailsender.md diff --git a/docs/email/api/proffer.email.internal.emailaddress.md b/docs/api/email/proffer.email.internal.emailaddress.md similarity index 100% rename from docs/email/api/proffer.email.internal.emailaddress.md rename to docs/api/email/proffer.email.internal.emailaddress.md diff --git a/docs/email/api/proffer.email.internal.emailaddressequalitycomparer.md b/docs/api/email/proffer.email.internal.emailaddressequalitycomparer.md similarity index 100% rename from docs/email/api/proffer.email.internal.emailaddressequalitycomparer.md rename to docs/api/email/proffer.email.internal.emailaddressequalitycomparer.md diff --git a/docs/email/api/proffer.email.internal.emailaddressstrictequalitycomparer.md b/docs/api/email/proffer.email.internal.emailaddressstrictequalitycomparer.md similarity index 100% rename from docs/email/api/proffer.email.internal.emailaddressstrictequalitycomparer.md rename to docs/api/email/proffer.email.internal.emailaddressstrictequalitycomparer.md diff --git a/docs/email/api/proffer.email.internal.emailattachment.md b/docs/api/email/proffer.email.internal.emailattachment.md similarity index 100% rename from docs/email/api/proffer.email.internal.emailattachment.md rename to docs/api/email/proffer.email.internal.emailattachment.md diff --git a/docs/email/api/proffer.email.internal.emailattachmentequalitycomparer.md b/docs/api/email/proffer.email.internal.emailattachmentequalitycomparer.md similarity index 100% rename from docs/email/api/proffer.email.internal.emailattachmentequalitycomparer.md rename to docs/api/email/proffer.email.internal.emailattachmentequalitycomparer.md diff --git a/docs/email/api/proffer.email.internal.emailsender.md b/docs/api/email/proffer.email.internal.emailsender.md similarity index 100% rename from docs/email/api/proffer.email.internal.emailsender.md rename to docs/api/email/proffer.email.internal.emailsender.md diff --git a/docs/email/api/proffer.email.mockupexceptionsoptions.md b/docs/api/email/proffer.email.mockupexceptionsoptions.md similarity index 100% rename from docs/email/api/proffer.email.mockupexceptionsoptions.md rename to docs/api/email/proffer.email.mockupexceptionsoptions.md diff --git a/docs/email/api/proffer.email.mockupoptions.md b/docs/api/email/proffer.email.mockupoptions.md similarity index 100% rename from docs/email/api/proffer.email.mockupoptions.md rename to docs/api/email/proffer.email.mockupoptions.md diff --git a/docs/email/sendgrid/api/index.md b/docs/api/email/sendgrid/index.md similarity index 100% rename from docs/email/sendgrid/api/index.md rename to docs/api/email/sendgrid/index.md diff --git a/docs/email/sendgrid/api/proffer.email.sendgrid.sendgridemailprovider.md b/docs/api/email/sendgrid/proffer.email.sendgrid.sendgridemailprovider.md similarity index 100% rename from docs/email/sendgrid/api/proffer.email.sendgrid.sendgridemailprovider.md rename to docs/api/email/sendgrid/proffer.email.sendgrid.sendgridemailprovider.md diff --git a/docs/email/sendgrid/api/proffer.email.sendgrid.sendgridemailprovidertype.md b/docs/api/email/sendgrid/proffer.email.sendgrid.sendgridemailprovidertype.md similarity index 100% rename from docs/email/sendgrid/api/proffer.email.sendgrid.sendgridemailprovidertype.md rename to docs/api/email/sendgrid/proffer.email.sendgrid.sendgridemailprovidertype.md diff --git a/docs/email/sendgrid/api/proffer.email.servicecollectionextensions.md b/docs/api/email/sendgrid/proffer.email.servicecollectionextensions.md similarity index 100% rename from docs/email/sendgrid/api/proffer.email.servicecollectionextensions.md rename to docs/api/email/sendgrid/proffer.email.servicecollectionextensions.md diff --git a/docs/email/smtp/api/index.md b/docs/api/email/smtp/index.md similarity index 100% rename from docs/email/smtp/api/index.md rename to docs/api/email/smtp/index.md diff --git a/docs/email/smtp/api/proffer.email.smtp.smtpemailprovider.md b/docs/api/email/smtp/proffer.email.smtp.smtpemailprovider.md similarity index 100% rename from docs/email/smtp/api/proffer.email.smtp.smtpemailprovider.md rename to docs/api/email/smtp/proffer.email.smtp.smtpemailprovider.md diff --git a/docs/email/smtp/api/proffer.email.smtp.smtpemailprovidertype.md b/docs/api/email/smtp/proffer.email.smtp.smtpemailprovidertype.md similarity index 100% rename from docs/email/smtp/api/proffer.email.smtp.smtpemailprovidertype.md rename to docs/api/email/smtp/proffer.email.smtp.smtpemailprovidertype.md diff --git a/docs/email/smtp/api/proffer.email.smtpemailservicecollectionextensions.md b/docs/api/email/smtp/proffer.email.smtpemailservicecollectionextensions.md similarity index 100% rename from docs/email/smtp/api/proffer.email.smtpemailservicecollectionextensions.md rename to docs/api/email/smtp/proffer.email.smtpemailservicecollectionextensions.md diff --git a/docs/storage/azure/blobs/api/index.md b/docs/api/storage/azure/blobs/index.md similarity index 100% rename from docs/storage/azure/blobs/api/index.md rename to docs/api/storage/azure/blobs/index.md diff --git a/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.azureblobsstorageprovider.md b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.azureblobsstorageprovider.md similarity index 100% rename from docs/storage/azure/blobs/api/proffer.storage.azure.blobs.azureblobsstorageprovider.md rename to docs/api/storage/azure/blobs/proffer.storage.azure.blobs.azureblobsstorageprovider.md diff --git a/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.azureblobsstore.md b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.azureblobsstore.md similarity index 100% rename from docs/storage/azure/blobs/api/proffer.storage.azure.blobs.azureblobsstore.md rename to docs/api/storage/azure/blobs/proffer.storage.azure.blobs.azureblobsstore.md diff --git a/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md similarity index 100% rename from docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md rename to docs/api/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md diff --git a/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md similarity index 100% rename from docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md rename to docs/api/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md diff --git a/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md similarity index 100% rename from docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md rename to docs/api/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md diff --git a/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md similarity index 100% rename from docs/storage/azure/blobs/api/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md rename to docs/api/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md diff --git a/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md similarity index 100% rename from docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md rename to docs/api/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md diff --git a/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobsfilereference.md b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobsfilereference.md similarity index 100% rename from docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobsfilereference.md rename to docs/api/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobsfilereference.md diff --git a/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md similarity index 100% rename from docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md rename to docs/api/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md diff --git a/docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md similarity index 100% rename from docs/storage/azure/blobs/api/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md rename to docs/api/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md diff --git a/docs/storage/azure/blobs/api/proffer.storage.azureblobsstorageservicecollectionextensions.md b/docs/api/storage/azure/blobs/proffer.storage.azureblobsstorageservicecollectionextensions.md similarity index 100% rename from docs/storage/azure/blobs/api/proffer.storage.azureblobsstorageservicecollectionextensions.md rename to docs/api/storage/azure/blobs/proffer.storage.azureblobsstorageservicecollectionextensions.md diff --git a/docs/storage/filesystem/api/index.md b/docs/api/storage/filesystem/index.md similarity index 100% rename from docs/storage/filesystem/api/index.md rename to docs/api/storage/filesystem/index.md diff --git a/docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemparsedoptions.md b/docs/api/storage/filesystem/proffer.storage.filesystem.configuration.filesystemparsedoptions.md similarity index 100% rename from docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemparsedoptions.md rename to docs/api/storage/filesystem/proffer.storage.filesystem.configuration.filesystemparsedoptions.md diff --git a/docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemprovideroptions.md b/docs/api/storage/filesystem/proffer.storage.filesystem.configuration.filesystemprovideroptions.md similarity index 100% rename from docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemprovideroptions.md rename to docs/api/storage/filesystem/proffer.storage.filesystem.configuration.filesystemprovideroptions.md diff --git a/docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md b/docs/api/storage/filesystem/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md similarity index 100% rename from docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md rename to docs/api/storage/filesystem/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md diff --git a/docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemstoreoptions.md b/docs/api/storage/filesystem/proffer.storage.filesystem.configuration.filesystemstoreoptions.md similarity index 100% rename from docs/storage/filesystem/api/proffer.storage.filesystem.configuration.filesystemstoreoptions.md rename to docs/api/storage/filesystem/proffer.storage.filesystem.configuration.filesystemstoreoptions.md diff --git a/docs/storage/filesystem/api/proffer.storage.filesystem.filesystemstorageprovider.md b/docs/api/storage/filesystem/proffer.storage.filesystem.filesystemstorageprovider.md similarity index 100% rename from docs/storage/filesystem/api/proffer.storage.filesystem.filesystemstorageprovider.md rename to docs/api/storage/filesystem/proffer.storage.filesystem.filesystemstorageprovider.md diff --git a/docs/storage/filesystem/api/proffer.storage.filesystem.filesystemstore.md b/docs/api/storage/filesystem/proffer.storage.filesystem.filesystemstore.md similarity index 100% rename from docs/storage/filesystem/api/proffer.storage.filesystem.filesystemstore.md rename to docs/api/storage/filesystem/proffer.storage.filesystem.filesystemstore.md diff --git a/docs/storage/filesystem/api/proffer.storage.filesystem.iextendedpropertiesprovider.md b/docs/api/storage/filesystem/proffer.storage.filesystem.iextendedpropertiesprovider.md similarity index 100% rename from docs/storage/filesystem/api/proffer.storage.filesystem.iextendedpropertiesprovider.md rename to docs/api/storage/filesystem/proffer.storage.filesystem.iextendedpropertiesprovider.md diff --git a/docs/storage/filesystem/api/proffer.storage.filesystem.internal.fileextendedproperties.md b/docs/api/storage/filesystem/proffer.storage.filesystem.internal.fileextendedproperties.md similarity index 100% rename from docs/storage/filesystem/api/proffer.storage.filesystem.internal.fileextendedproperties.md rename to docs/api/storage/filesystem/proffer.storage.filesystem.internal.fileextendedproperties.md diff --git a/docs/storage/filesystem/api/proffer.storage.filesystem.internal.filesystemfileproperties.md b/docs/api/storage/filesystem/proffer.storage.filesystem.internal.filesystemfileproperties.md similarity index 100% rename from docs/storage/filesystem/api/proffer.storage.filesystem.internal.filesystemfileproperties.md rename to docs/api/storage/filesystem/proffer.storage.filesystem.internal.filesystemfileproperties.md diff --git a/docs/storage/filesystem/api/proffer.storage.filesystem.internal.filesystemfilereference.md b/docs/api/storage/filesystem/proffer.storage.filesystem.internal.filesystemfilereference.md similarity index 100% rename from docs/storage/filesystem/api/proffer.storage.filesystem.internal.filesystemfilereference.md rename to docs/api/storage/filesystem/proffer.storage.filesystem.internal.filesystemfilereference.md diff --git a/docs/storage/filesystem/api/proffer.storage.filesystem.ipublicurlprovider.md b/docs/api/storage/filesystem/proffer.storage.filesystem.ipublicurlprovider.md similarity index 100% rename from docs/storage/filesystem/api/proffer.storage.filesystem.ipublicurlprovider.md rename to docs/api/storage/filesystem/proffer.storage.filesystem.ipublicurlprovider.md diff --git a/docs/storage/filesystem/api/proffer.storage.filesystem.noextendedpropertiesprovider.md b/docs/api/storage/filesystem/proffer.storage.filesystem.noextendedpropertiesprovider.md similarity index 100% rename from docs/storage/filesystem/api/proffer.storage.filesystem.noextendedpropertiesprovider.md rename to docs/api/storage/filesystem/proffer.storage.filesystem.noextendedpropertiesprovider.md diff --git a/docs/storage/filesystem/api/proffer.storage.filesystemstorageservicecollectionextensions.md b/docs/api/storage/filesystem/proffer.storage.filesystemstorageservicecollectionextensions.md similarity index 100% rename from docs/storage/filesystem/api/proffer.storage.filesystemstorageservicecollectionextensions.md rename to docs/api/storage/filesystem/proffer.storage.filesystemstorageservicecollectionextensions.md diff --git a/docs/storage/filesystem/properties/json/api/index.md b/docs/api/storage/filesystem/properties/json/index.md similarity index 100% rename from docs/storage/filesystem/properties/json/api/index.md rename to docs/api/storage/filesystem/properties/json/index.md diff --git a/docs/storage/filesystem/properties/json/api/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md b/docs/api/storage/filesystem/properties/json/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md similarity index 100% rename from docs/storage/filesystem/properties/json/api/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md rename to docs/api/storage/filesystem/properties/json/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md diff --git a/docs/storage/filesystem/properties/json/api/proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md b/docs/api/storage/filesystem/properties/json/proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md similarity index 100% rename from docs/storage/filesystem/properties/json/api/proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md rename to docs/api/storage/filesystem/properties/json/proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md diff --git a/docs/storage/filesystem/properties/json/api/proffer.storage.filesystempropertiesjsonservicecollectionextensions.md b/docs/api/storage/filesystem/properties/json/proffer.storage.filesystempropertiesjsonservicecollectionextensions.md similarity index 100% rename from docs/storage/filesystem/properties/json/api/proffer.storage.filesystempropertiesjsonservicecollectionextensions.md rename to docs/api/storage/filesystem/properties/json/proffer.storage.filesystempropertiesjsonservicecollectionextensions.md diff --git a/docs/storage/filesystem/server/api/index.md b/docs/api/storage/filesystem/server/index.md similarity index 100% rename from docs/storage/filesystem/server/api/index.md rename to docs/api/storage/filesystem/server/index.md diff --git a/docs/storage/filesystem/server/api/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md b/docs/api/storage/filesystem/server/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md similarity index 100% rename from docs/storage/filesystem/server/api/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md rename to docs/api/storage/filesystem/server/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md diff --git a/docs/storage/filesystem/server/api/proffer.storage.filesystem.server.filesystemstorageserveroptions.md b/docs/api/storage/filesystem/server/proffer.storage.filesystem.server.filesystemstorageserveroptions.md similarity index 100% rename from docs/storage/filesystem/server/api/proffer.storage.filesystem.server.filesystemstorageserveroptions.md rename to docs/api/storage/filesystem/server/proffer.storage.filesystem.server.filesystemstorageserveroptions.md diff --git a/docs/storage/filesystem/server/api/proffer.storage.filesystem.server.internal.publicurlprovider.md b/docs/api/storage/filesystem/server/proffer.storage.filesystem.server.internal.publicurlprovider.md similarity index 100% rename from docs/storage/filesystem/server/api/proffer.storage.filesystem.server.internal.publicurlprovider.md rename to docs/api/storage/filesystem/server/proffer.storage.filesystem.server.internal.publicurlprovider.md diff --git a/docs/storage/filesystem/server/api/proffer.storage.servicecollectionextensions.md b/docs/api/storage/filesystem/server/proffer.storage.servicecollectionextensions.md similarity index 100% rename from docs/storage/filesystem/server/api/proffer.storage.servicecollectionextensions.md rename to docs/api/storage/filesystem/server/proffer.storage.servicecollectionextensions.md diff --git a/docs/storage/api/index.md b/docs/api/storage/index.md similarity index 100% rename from docs/storage/api/index.md rename to docs/api/storage/index.md diff --git a/docs/storage/api/proffer.storage.configuration.accesslevel.md b/docs/api/storage/proffer.storage.configuration.accesslevel.md similarity index 100% rename from docs/storage/api/proffer.storage.configuration.accesslevel.md rename to docs/api/storage/proffer.storage.configuration.accesslevel.md diff --git a/docs/storage/api/proffer.storage.configuration.configurationextensions.md b/docs/api/storage/proffer.storage.configuration.configurationextensions.md similarity index 100% rename from docs/storage/api/proffer.storage.configuration.configurationextensions.md rename to docs/api/storage/proffer.storage.configuration.configurationextensions.md diff --git a/docs/storage/api/proffer.storage.configuration.iparsedoptions-3.md b/docs/api/storage/proffer.storage.configuration.iparsedoptions-3.md similarity index 100% rename from docs/storage/api/proffer.storage.configuration.iparsedoptions-3.md rename to docs/api/storage/proffer.storage.configuration.iparsedoptions-3.md diff --git a/docs/storage/api/proffer.storage.configuration.iscopedstoreoptions.md b/docs/api/storage/proffer.storage.configuration.iscopedstoreoptions.md similarity index 100% rename from docs/storage/api/proffer.storage.configuration.iscopedstoreoptions.md rename to docs/api/storage/proffer.storage.configuration.iscopedstoreoptions.md diff --git a/docs/storage/api/proffer.storage.configuration.istoreoptions.md b/docs/api/storage/proffer.storage.configuration.istoreoptions.md similarity index 100% rename from docs/storage/api/proffer.storage.configuration.istoreoptions.md rename to docs/api/storage/proffer.storage.configuration.istoreoptions.md diff --git a/docs/storage/api/proffer.storage.configuration.scopedstoreoptions.md b/docs/api/storage/proffer.storage.configuration.scopedstoreoptions.md similarity index 100% rename from docs/storage/api/proffer.storage.configuration.scopedstoreoptions.md rename to docs/api/storage/proffer.storage.configuration.scopedstoreoptions.md diff --git a/docs/storage/api/proffer.storage.configuration.storageoptions.md b/docs/api/storage/proffer.storage.configuration.storageoptions.md similarity index 100% rename from docs/storage/api/proffer.storage.configuration.storageoptions.md rename to docs/api/storage/proffer.storage.configuration.storageoptions.md diff --git a/docs/storage/api/proffer.storage.configuration.storeoptions.md b/docs/api/storage/proffer.storage.configuration.storeoptions.md similarity index 100% rename from docs/storage/api/proffer.storage.configuration.storeoptions.md rename to docs/api/storage/proffer.storage.configuration.storeoptions.md diff --git a/docs/storage/api/proffer.storage.exceptions.badproviderconfiguration.md b/docs/api/storage/proffer.storage.exceptions.badproviderconfiguration.md similarity index 100% rename from docs/storage/api/proffer.storage.exceptions.badproviderconfiguration.md rename to docs/api/storage/proffer.storage.exceptions.badproviderconfiguration.md diff --git a/docs/storage/api/proffer.storage.exceptions.badscopedstoreconfiguration.md b/docs/api/storage/proffer.storage.exceptions.badscopedstoreconfiguration.md similarity index 100% rename from docs/storage/api/proffer.storage.exceptions.badscopedstoreconfiguration.md rename to docs/api/storage/proffer.storage.exceptions.badscopedstoreconfiguration.md diff --git a/docs/storage/api/proffer.storage.exceptions.badstoreconfiguration.md b/docs/api/storage/proffer.storage.exceptions.badstoreconfiguration.md similarity index 100% rename from docs/storage/api/proffer.storage.exceptions.badstoreconfiguration.md rename to docs/api/storage/proffer.storage.exceptions.badstoreconfiguration.md diff --git a/docs/storage/api/proffer.storage.exceptions.filealreadyexistsexception.md b/docs/api/storage/proffer.storage.exceptions.filealreadyexistsexception.md similarity index 100% rename from docs/storage/api/proffer.storage.exceptions.filealreadyexistsexception.md rename to docs/api/storage/proffer.storage.exceptions.filealreadyexistsexception.md diff --git a/docs/storage/api/proffer.storage.exceptions.providernotfoundexception.md b/docs/api/storage/proffer.storage.exceptions.providernotfoundexception.md similarity index 100% rename from docs/storage/api/proffer.storage.exceptions.providernotfoundexception.md rename to docs/api/storage/proffer.storage.exceptions.providernotfoundexception.md diff --git a/docs/storage/api/proffer.storage.exceptions.storenotfoundexception.md b/docs/api/storage/proffer.storage.exceptions.storenotfoundexception.md similarity index 100% rename from docs/storage/api/proffer.storage.exceptions.storenotfoundexception.md rename to docs/api/storage/proffer.storage.exceptions.storenotfoundexception.md diff --git a/docs/storage/api/proffer.storage.ifileproperties.md b/docs/api/storage/proffer.storage.ifileproperties.md similarity index 100% rename from docs/storage/api/proffer.storage.ifileproperties.md rename to docs/api/storage/proffer.storage.ifileproperties.md diff --git a/docs/storage/api/proffer.storage.ifilereference.md b/docs/api/storage/proffer.storage.ifilereference.md similarity index 100% rename from docs/storage/api/proffer.storage.ifilereference.md rename to docs/api/storage/proffer.storage.ifilereference.md diff --git a/docs/storage/api/proffer.storage.internal.configureprovideroptions-4.md b/docs/api/storage/proffer.storage.internal.configureprovideroptions-4.md similarity index 100% rename from docs/storage/api/proffer.storage.internal.configureprovideroptions-4.md rename to docs/api/storage/proffer.storage.internal.configureprovideroptions-4.md diff --git a/docs/storage/api/proffer.storage.internal.genericstoreproxy-1.md b/docs/api/storage/proffer.storage.internal.genericstoreproxy-1.md similarity index 100% rename from docs/storage/api/proffer.storage.internal.genericstoreproxy-1.md rename to docs/api/storage/proffer.storage.internal.genericstoreproxy-1.md diff --git a/docs/storage/api/proffer.storage.internal.privatefilereference.md b/docs/api/storage/proffer.storage.internal.privatefilereference.md similarity index 100% rename from docs/storage/api/proffer.storage.internal.privatefilereference.md rename to docs/api/storage/proffer.storage.internal.privatefilereference.md diff --git a/docs/storage/api/proffer.storage.internal.storagefactory.md b/docs/api/storage/proffer.storage.internal.storagefactory.md similarity index 100% rename from docs/storage/api/proffer.storage.internal.storagefactory.md rename to docs/api/storage/proffer.storage.internal.storagefactory.md diff --git a/docs/storage/api/proffer.storage.internal.storageproviderbase-4.md b/docs/api/storage/proffer.storage.internal.storageproviderbase-4.md similarity index 100% rename from docs/storage/api/proffer.storage.internal.storageproviderbase-4.md rename to docs/api/storage/proffer.storage.internal.storageproviderbase-4.md diff --git a/docs/storage/api/proffer.storage.iprivatefilereference.md b/docs/api/storage/proffer.storage.iprivatefilereference.md similarity index 100% rename from docs/storage/api/proffer.storage.iprivatefilereference.md rename to docs/api/storage/proffer.storage.iprivatefilereference.md diff --git a/docs/storage/api/proffer.storage.isharedaccesspolicy.md b/docs/api/storage/proffer.storage.isharedaccesspolicy.md similarity index 100% rename from docs/storage/api/proffer.storage.isharedaccesspolicy.md rename to docs/api/storage/proffer.storage.isharedaccesspolicy.md diff --git a/docs/storage/api/proffer.storage.istoragefactory.md b/docs/api/storage/proffer.storage.istoragefactory.md similarity index 100% rename from docs/storage/api/proffer.storage.istoragefactory.md rename to docs/api/storage/proffer.storage.istoragefactory.md diff --git a/docs/storage/api/proffer.storage.istorageprovider.md b/docs/api/storage/proffer.storage.istorageprovider.md similarity index 100% rename from docs/storage/api/proffer.storage.istorageprovider.md rename to docs/api/storage/proffer.storage.istorageprovider.md diff --git a/docs/storage/api/proffer.storage.istore-1.md b/docs/api/storage/proffer.storage.istore-1.md similarity index 100% rename from docs/storage/api/proffer.storage.istore-1.md rename to docs/api/storage/proffer.storage.istore-1.md diff --git a/docs/storage/api/proffer.storage.istore.md b/docs/api/storage/proffer.storage.istore.md similarity index 100% rename from docs/storage/api/proffer.storage.istore.md rename to docs/api/storage/proffer.storage.istore.md diff --git a/docs/storage/api/proffer.storage.istoreextensions.md b/docs/api/storage/proffer.storage.istoreextensions.md similarity index 100% rename from docs/storage/api/proffer.storage.istoreextensions.md rename to docs/api/storage/proffer.storage.istoreextensions.md diff --git a/docs/storage/api/proffer.storage.overwritepolicy.md b/docs/api/storage/proffer.storage.overwritepolicy.md similarity index 100% rename from docs/storage/api/proffer.storage.overwritepolicy.md rename to docs/api/storage/proffer.storage.overwritepolicy.md diff --git a/docs/storage/api/proffer.storage.sharedaccesspermissions.md b/docs/api/storage/proffer.storage.sharedaccesspermissions.md similarity index 100% rename from docs/storage/api/proffer.storage.sharedaccesspermissions.md rename to docs/api/storage/proffer.storage.sharedaccesspermissions.md diff --git a/docs/storage/api/proffer.storage.sharedaccesspolicy.md b/docs/api/storage/proffer.storage.sharedaccesspolicy.md similarity index 100% rename from docs/storage/api/proffer.storage.sharedaccesspolicy.md rename to docs/api/storage/proffer.storage.sharedaccesspolicy.md diff --git a/docs/storage/api/proffer.storage.storageservicecollectionextensions.md b/docs/api/storage/proffer.storage.storageservicecollectionextensions.md similarity index 100% rename from docs/storage/api/proffer.storage.storageservicecollectionextensions.md rename to docs/api/storage/proffer.storage.storageservicecollectionextensions.md diff --git a/docs/storage/api/proffer.storage.storebase.md b/docs/api/storage/proffer.storage.storebase.md similarity index 100% rename from docs/storage/api/proffer.storage.storebase.md rename to docs/api/storage/proffer.storage.storebase.md diff --git a/docs/templating/handlebars/api/index.md b/docs/api/templating/handlebars/index.md similarity index 100% rename from docs/templating/handlebars/api/index.md rename to docs/api/templating/handlebars/index.md diff --git a/docs/templating/handlebars/api/proffer.templating.handlebars.handlebarstemplate.md b/docs/api/templating/handlebars/proffer.templating.handlebars.handlebarstemplate.md similarity index 100% rename from docs/templating/handlebars/api/proffer.templating.handlebars.handlebarstemplate.md rename to docs/api/templating/handlebars/proffer.templating.handlebars.handlebarstemplate.md diff --git a/docs/templating/handlebars/api/proffer.templating.handlebars.handlebarstemplateprovider.md b/docs/api/templating/handlebars/proffer.templating.handlebars.handlebarstemplateprovider.md similarity index 100% rename from docs/templating/handlebars/api/proffer.templating.handlebars.handlebarstemplateprovider.md rename to docs/api/templating/handlebars/proffer.templating.handlebars.handlebarstemplateprovider.md diff --git a/docs/templating/handlebars/api/proffer.templating.handlebarsservicecollectionextensions.md b/docs/api/templating/handlebars/proffer.templating.handlebarsservicecollectionextensions.md similarity index 100% rename from docs/templating/handlebars/api/proffer.templating.handlebarsservicecollectionextensions.md rename to docs/api/templating/handlebars/proffer.templating.handlebarsservicecollectionextensions.md diff --git a/docs/templating/api/index.md b/docs/api/templating/index.md similarity index 100% rename from docs/templating/api/index.md rename to docs/api/templating/index.md diff --git a/docs/templating/mustache/api/index.md b/docs/api/templating/mustache/index.md similarity index 100% rename from docs/templating/mustache/api/index.md rename to docs/api/templating/mustache/index.md diff --git a/docs/templating/mustache/api/proffer.templating.mustache.mustachetemplate.md b/docs/api/templating/mustache/proffer.templating.mustache.mustachetemplate.md similarity index 100% rename from docs/templating/mustache/api/proffer.templating.mustache.mustachetemplate.md rename to docs/api/templating/mustache/proffer.templating.mustache.mustachetemplate.md diff --git a/docs/templating/mustache/api/proffer.templating.mustache.mustachetemplateprovider.md b/docs/api/templating/mustache/proffer.templating.mustache.mustachetemplateprovider.md similarity index 100% rename from docs/templating/mustache/api/proffer.templating.mustache.mustachetemplateprovider.md rename to docs/api/templating/mustache/proffer.templating.mustache.mustachetemplateprovider.md diff --git a/docs/templating/mustache/api/proffer.templating.mustacheservicecollectionextensions.md b/docs/api/templating/mustache/proffer.templating.mustacheservicecollectionextensions.md similarity index 100% rename from docs/templating/mustache/api/proffer.templating.mustacheservicecollectionextensions.md rename to docs/api/templating/mustache/proffer.templating.mustacheservicecollectionextensions.md diff --git a/docs/templating/api/proffer.templating.exceptions.providernotfoundexception.md b/docs/api/templating/proffer.templating.exceptions.providernotfoundexception.md similarity index 100% rename from docs/templating/api/proffer.templating.exceptions.providernotfoundexception.md rename to docs/api/templating/proffer.templating.exceptions.providernotfoundexception.md diff --git a/docs/templating/api/proffer.templating.exceptions.templatenotfoundexception.md b/docs/api/templating/proffer.templating.exceptions.templatenotfoundexception.md similarity index 100% rename from docs/templating/api/proffer.templating.exceptions.templatenotfoundexception.md rename to docs/api/templating/proffer.templating.exceptions.templatenotfoundexception.md diff --git a/docs/templating/api/proffer.templating.internal.templateloader.md b/docs/api/templating/proffer.templating.internal.templateloader.md similarity index 100% rename from docs/templating/api/proffer.templating.internal.templateloader.md rename to docs/api/templating/proffer.templating.internal.templateloader.md diff --git a/docs/templating/api/proffer.templating.internal.templateloaderfactory.md b/docs/api/templating/proffer.templating.internal.templateloaderfactory.md similarity index 100% rename from docs/templating/api/proffer.templating.internal.templateloaderfactory.md rename to docs/api/templating/proffer.templating.internal.templateloaderfactory.md diff --git a/docs/templating/api/proffer.templating.invalidcontextexception.md b/docs/api/templating/proffer.templating.invalidcontextexception.md similarity index 100% rename from docs/templating/api/proffer.templating.invalidcontextexception.md rename to docs/api/templating/proffer.templating.invalidcontextexception.md diff --git a/docs/templating/api/proffer.templating.itemplate.md b/docs/api/templating/proffer.templating.itemplate.md similarity index 100% rename from docs/templating/api/proffer.templating.itemplate.md rename to docs/api/templating/proffer.templating.itemplate.md diff --git a/docs/templating/api/proffer.templating.itemplateloader.md b/docs/api/templating/proffer.templating.itemplateloader.md similarity index 100% rename from docs/templating/api/proffer.templating.itemplateloader.md rename to docs/api/templating/proffer.templating.itemplateloader.md diff --git a/docs/templating/api/proffer.templating.itemplateloaderfactory.md b/docs/api/templating/proffer.templating.itemplateloaderfactory.md similarity index 100% rename from docs/templating/api/proffer.templating.itemplateloaderfactory.md rename to docs/api/templating/proffer.templating.itemplateloaderfactory.md diff --git a/docs/templating/api/proffer.templating.itemplateprovider.md b/docs/api/templating/proffer.templating.itemplateprovider.md similarity index 100% rename from docs/templating/api/proffer.templating.itemplateprovider.md rename to docs/api/templating/proffer.templating.itemplateprovider.md diff --git a/docs/templating/api/proffer.templating.itemplateproviderscope.md b/docs/api/templating/proffer.templating.itemplateproviderscope.md similarity index 100% rename from docs/templating/api/proffer.templating.itemplateproviderscope.md rename to docs/api/templating/proffer.templating.itemplateproviderscope.md diff --git a/docs/templating/api/proffer.templating.templatecollectionbase-1.md b/docs/api/templating/proffer.templating.templatecollectionbase-1.md similarity index 100% rename from docs/templating/api/proffer.templating.templatecollectionbase-1.md rename to docs/api/templating/proffer.templating.templatecollectionbase-1.md diff --git a/docs/templating/api/proffer.templating.templatecollectionbase.md b/docs/api/templating/proffer.templating.templatecollectionbase.md similarity index 100% rename from docs/templating/api/proffer.templating.templatecollectionbase.md rename to docs/api/templating/proffer.templating.templatecollectionbase.md diff --git a/docs/templating/api/proffer.templating.templatingservicecollectionextensions.md b/docs/api/templating/proffer.templating.templatingservicecollectionextensions.md similarity index 100% rename from docs/templating/api/proffer.templating.templatingservicecollectionextensions.md rename to docs/api/templating/proffer.templating.templatingservicecollectionextensions.md diff --git a/docs/assets/css/style.scss b/docs/assets/css/style.scss deleted file mode 100644 index 72d9eb0..0000000 --- a/docs/assets/css/style.scss +++ /dev/null @@ -1,5 +0,0 @@ ---- ---- - -@import "{{ site.theme }}"; -@import "custom.scss"; diff --git a/docs/assets/img/banner.png b/docs/assets/images/banner.png similarity index 100% rename from docs/assets/img/banner.png rename to docs/assets/images/banner.png diff --git a/docs/assets/img/logo.png b/docs/assets/images/logo.png similarity index 100% rename from docs/assets/img/logo.png rename to docs/assets/images/logo.png diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index c2ab510..0000000 --- a/docs/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "Proffer" ---- - -# Why Proffer? - - - -## Welcome to GitHub Pages - -You can use the [editor on GitHub](https://github.com/asiffermann/proffer/edit/topics/docs/docs/index.md) to maintain and preview the content for your website in Markdown files. - -Whenever you commit to this repository, GitHub Pages will run [Jekyll](https://jekyllrb.com/) to rebuild the pages in your site, from the content in your Markdown files. - -### Markdown - -Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for - -```markdown -Syntax highlighted code block - -# Header 1 -## Header 2 -### Header 3 - -- Bulleted -- List - -1. Numbered -2. List - -**Bold** and _Italic_ and `Code` text - -[Link](url) and ![Image](src) -``` - -https://github.com/asiffermann/proffer/blob/df566cf979c23afc71632136e04144fa30e1a0b4/tests/Proffer.Storage.Tests/StorageConfigurationTests.cs#L20-L33 - -For more details see [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/). - -### Jekyll Themes - -Your Pages site will use the layout and styles from the Jekyll theme you have selected in your [repository settings](https://github.com/asiffermann/proffer/settings/pages). The name of this theme is saved in the Jekyll `_config.yml` configuration file. - -### Support or Contact - -Having trouble with Pages? Check out our [documentation](https://docs.github.com/categories/github-pages-basics/) or [contact support](https://support.github.com/contact) and we’ll help you sort it out. diff --git a/docs/storage/azure/blobs/index.md b/docs/storage/azure/blobs/index.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/use-cases.md b/docs/use-cases.md deleted file mode 100644 index e69de29..0000000 diff --git a/src/Directory.Build.targets b/src/Directory.Build.targets index 1625a69..0890d95 100644 --- a/src/Directory.Build.targets +++ b/src/Directory.Build.targets @@ -1,6 +1,6 @@ - + \ No newline at end of file diff --git a/src/Proffer.Email/Proffer.Email.csproj b/src/Proffer.Email/Proffer.Email.csproj index fe68a2f..9d2ef0c 100644 --- a/src/Proffer.Email/Proffer.Email.csproj +++ b/src/Proffer.Email/Proffer.Email.csproj @@ -1,8 +1,6 @@ - Proffer.Email - Proffer.Email Templated email sending abstractions with providers. email @@ -14,7 +12,7 @@ - + From 9a83c10d54b7c27675edc76ddf2c029b0d82f436 Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Sat, 22 May 2021 04:38:23 +0200 Subject: [PATCH 34/45] API config --- docs/_config.yml | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/_config.yml b/docs/_config.yml index 9d1d705..e32dcab 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -245,3 +245,12 @@ defaults: values: layout: single author_profile: false + # api + - scope: + path: "api" + type: pages + values: + layout: single + author_profile: false + toc: true + toc_sticky: true From 5731c36420a7d8c13a7c9ed32755139db0f89d7a Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Sat, 22 May 2021 05:15:02 +0200 Subject: [PATCH 35/45] Navigation --- docs/_config.yml | 12 ++++++ docs/_data/navigation.yml | 51 ++++++++++++++++++++++--- docs/_docs/about.md | 4 ++ docs/{_pages => _docs}/core.azure.md | 6 +-- docs/{_pages => _docs}/core.md | 6 +-- docs/_docs/getting-started.md | 4 ++ docs/_pages/home.md | 11 +++--- docs/_pages/posts.md | 6 +++ docs/_posts/2021-05-22-hello-proffer.md | 4 +- docs/{_pages/api.md => api/index.md} | 4 -- 10 files changed, 85 insertions(+), 23 deletions(-) create mode 100644 docs/_docs/about.md rename docs/{_pages => _docs}/core.azure.md (77%) rename docs/{_pages => _docs}/core.md (72%) create mode 100644 docs/_docs/getting-started.md create mode 100644 docs/_pages/posts.md rename docs/{_pages/api.md => api/index.md} (96%) diff --git a/docs/_config.yml b/docs/_config.yml index e32dcab..476d3bd 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -254,3 +254,15 @@ defaults: author_profile: false toc: true toc_sticky: true + # _docs + - scope: + path: "" + type: docs + values: + layout: single + read_time: false + author_profile: false + share: false + comments: false + sidebar: + nav: "docs" diff --git a/docs/_data/navigation.yml b/docs/_data/navigation.yml index 89b4a53..3eb4d07 100644 --- a/docs/_data/navigation.yml +++ b/docs/_data/navigation.yml @@ -1,11 +1,52 @@ main: - title: "Getting started" - url: /getting-started/ + url: /docs/getting-started - title: "About" - url: /about/ + url: /docs/about - title: "Posts" - url: /year-archive/ + url: /posts - title: "Use cases" - url: /use-cases/ + url: /use-cases - title: "API documentation" - url: /api/ \ No newline at end of file + url: /api + +# documentation links +docs: + - title: About + url: /docs/about + - title: Getting Started + url: /docs/getting-started + - title: Core libraries + children: + - title: "Core" + url: /docs/core + - title: "Azure" + url: /docs/core/azure + - title: Storage + url: /docs/storage + children: + - title: "Provider FileSystem" + url: /docs/storage/filesystem + children: + - title: "Server" + url: /docs/storage/filesystem/server + - title: "Json Properties" + url: /docs/storage/filesystem/properties/json + - title: "Provider Azure Blobs" + url: /docs/storage/azure/blobs + - title: Templating + url: /docs/templating + children: + - title: "Provider HandleBars" + url: /docs/templating/handlebars + - title: "Provider Mustache" + url: /docs/templating/mustache + - title: Email + url: /docs/email + children: + - title: "Provider in memory" + url: /docs/email/in-memory + - title: "Provider SMTP" + url: /docs/email/smtp + - title: "Provider SendGrid" + url: /docs/email/SendGrid diff --git a/docs/_docs/about.md b/docs/_docs/about.md new file mode 100644 index 0000000..4c1580a --- /dev/null +++ b/docs/_docs/about.md @@ -0,0 +1,4 @@ +--- +title: About +permalink: /docs/about +--- \ No newline at end of file diff --git a/docs/_pages/core.azure.md b/docs/_docs/core.azure.md similarity index 77% rename from docs/_pages/core.azure.md rename to docs/_docs/core.azure.md index 85634b2..70af78c 100644 --- a/docs/_pages/core.azure.md +++ b/docs/_docs/core.azure.md @@ -1,9 +1,9 @@ --- -permalink: /core/azure/ +title: "Core Azure library" +permalink: /docs/core/azure/ +excerpt: "Proffer Azure common abstractions." --- -# Core Azure library - This library provides common abstractions for any Proffer provider connected to Azure Storage (like [Proffer.Storage.Azure.Blobs](../../storage/azure/blobs) or Proffer.Events.Azure.Queues). There is not much here until the configuration will be shared across all different projects. diff --git a/docs/_pages/core.md b/docs/_docs/core.md similarity index 72% rename from docs/_pages/core.md rename to docs/_docs/core.md index d44097c..3141911 100644 --- a/docs/_pages/core.md +++ b/docs/_docs/core.md @@ -1,9 +1,9 @@ --- -permalink: /core/ +title: "Core libraries" +permalink: /docs/core/ +excerpt: "Common abstractions for any Proffer project or provider." --- -# Core libraries - Those libraries provide common abstractions for any Proffer project or provider. There is not much here until the configuration will be shared across all different projects. diff --git a/docs/_docs/getting-started.md b/docs/_docs/getting-started.md new file mode 100644 index 0000000..dbab8a0 --- /dev/null +++ b/docs/_docs/getting-started.md @@ -0,0 +1,4 @@ +--- +title: Getting started +permalink: /docs/getting-started +--- \ No newline at end of file diff --git a/docs/_pages/home.md b/docs/_pages/home.md index 528ddf1..4d67510 100644 --- a/docs/_pages/home.md +++ b/docs/_pages/home.md @@ -4,10 +4,9 @@ permalink: / hidden: true header: overlay_color: "#5c2d91" - overlay_image: /assets/images/banner.png actions: - label: " Install now" - url: "/getting-started/" + url: "/docs/getting-started" - label: " View on GitHub" url: "https://github.com/asiffermann/proffer" excerpt: > @@ -18,28 +17,28 @@ feature_row: alt: "core" title: "Core libraries" excerpt: "Provide common abstractions for any Proffer project or provider." - url: "/core/" + url: "/docs/core" btn_class: "btn--primary" btn_label: "Learn more" - image_path: /assets/images/banner.png alt: "storage" title: "Storage" excerpt: "File Storage abstractions with providers." - url: "/storage/" + url: "/docs/storage" btn_class: "btn--primary" btn_label: "Learn more" - image_path: /assets/images/banner.png alt: "templating" title: "Templating" excerpt: "Templating abstractions with providers." - url: "/templating/" + url: "/docs/templating" btn_class: "btn--primary" btn_label: "Learn more" - image_path: /assets/images/banner.png alt: "email" title: "Email" excerpt: "Templated email sending abstractions with providers." - url: "/email/" + url: "/docs/email" btn_class: "btn--primary" btn_label: "Learn more" --- diff --git a/docs/_pages/posts.md b/docs/_pages/posts.md new file mode 100644 index 0000000..5256b28 --- /dev/null +++ b/docs/_pages/posts.md @@ -0,0 +1,6 @@ +--- +title: "Posts" +permalink: /posts/ +layout: posts +author_profile: false +--- \ No newline at end of file diff --git a/docs/_posts/2021-05-22-hello-proffer.md b/docs/_posts/2021-05-22-hello-proffer.md index ba4f6cc..4a6f946 100644 --- a/docs/_posts/2021-05-22-hello-proffer.md +++ b/docs/_posts/2021-05-22-hello-proffer.md @@ -1,4 +1,6 @@ --- +title: "Hello Proffer!" +date: 2021-05-22 categories: - News tags: @@ -8,6 +10,4 @@ tags: - Email --- -# Hello Proffer! - New release ... diff --git a/docs/_pages/api.md b/docs/api/index.md similarity index 96% rename from docs/_pages/api.md rename to docs/api/index.md index 29a5f94..529a3ef 100644 --- a/docs/_pages/api.md +++ b/docs/api/index.md @@ -1,7 +1,3 @@ ---- -permalink: /api/ ---- - # API documentation ## Core libraries From 4181ca0f90e10e75ce7adb924a8f407d4899e6ef Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Sat, 22 May 2021 05:18:26 +0200 Subject: [PATCH 36/45] Add missing collection --- docs/_config.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/_config.yml b/docs/_config.yml index 476d3bd..391bef4 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -225,6 +225,12 @@ titles_from_headings: enabled: true strip_title: true +# Collections +collections: + docs: + output: true + permalink: /:collection/:path/ + # Defaults defaults: # _posts From ca518f5b6934ea0337d6ad3710e29c0116bef550 Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Sat, 22 May 2021 05:47:31 +0200 Subject: [PATCH 37/45] Fixes --- docs/_config.yml | 9 ++++++++ docs/_data/navigation.yml | 23 +++++++++---------- docs/_docs/{about.md => 01-about.md} | 0 ...tting-started.md => 02-getting-started.md} | 0 docs/_docs/{core.md => 03-core.md} | 4 ++-- .../_docs/{core.azure.md => 04-core.azure.md} | 6 ++--- 6 files changed, 25 insertions(+), 17 deletions(-) rename docs/_docs/{about.md => 01-about.md} (100%) rename docs/_docs/{getting-started.md => 02-getting-started.md} (100%) rename docs/_docs/{core.md => 03-core.md} (83%) rename docs/_docs/{core.azure.md => 04-core.azure.md} (75%) diff --git a/docs/_config.yml b/docs/_config.yml index 391bef4..5d79eb4 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -233,6 +233,12 @@ collections: # Defaults defaults: + - scope: + path: "" + values: + header: + og_image: /assets/img/banner.png + # _posts - scope: path: "" @@ -244,6 +250,9 @@ defaults: comments: # true share: true related: true + classes: wide + header: + image: /assets/img/banner.png # _pages - scope: path: "_pages" diff --git a/docs/_data/navigation.yml b/docs/_data/navigation.yml index 3eb4d07..1b9003b 100644 --- a/docs/_data/navigation.yml +++ b/docs/_data/navigation.yml @@ -25,28 +25,27 @@ docs: - title: Storage url: /docs/storage children: - - title: "Provider FileSystem" + - title: "FileSystem" url: /docs/storage/filesystem - children: - - title: "Server" - url: /docs/storage/filesystem/server - - title: "Json Properties" - url: /docs/storage/filesystem/properties/json - - title: "Provider Azure Blobs" + - title: "FileSystem Server" + url: /docs/storage/filesystem/server + - title: "FileSystem Json Properties" + url: /docs/storage/filesystem/properties/json + - title: "Azure Blobs" url: /docs/storage/azure/blobs - title: Templating url: /docs/templating children: - - title: "Provider HandleBars" + - title: "HandleBars" url: /docs/templating/handlebars - - title: "Provider Mustache" + - title: "Mustache" url: /docs/templating/mustache - title: Email url: /docs/email children: - - title: "Provider in memory" + - title: "In memory" url: /docs/email/in-memory - - title: "Provider SMTP" + - title: "SMTP" url: /docs/email/smtp - - title: "Provider SendGrid" + - title: "SendGrid" url: /docs/email/SendGrid diff --git a/docs/_docs/about.md b/docs/_docs/01-about.md similarity index 100% rename from docs/_docs/about.md rename to docs/_docs/01-about.md diff --git a/docs/_docs/getting-started.md b/docs/_docs/02-getting-started.md similarity index 100% rename from docs/_docs/getting-started.md rename to docs/_docs/02-getting-started.md diff --git a/docs/_docs/core.md b/docs/_docs/03-core.md similarity index 83% rename from docs/_docs/core.md rename to docs/_docs/03-core.md index 3141911..c962f7e 100644 --- a/docs/_docs/core.md +++ b/docs/_docs/03-core.md @@ -1,11 +1,11 @@ --- title: "Core libraries" permalink: /docs/core/ -excerpt: "Common abstractions for any Proffer project or provider." +excerpt_separator: --- Those libraries provide common abstractions for any Proffer project or provider. - + There is not much here until the configuration will be shared across all different projects. ## Projects diff --git a/docs/_docs/core.azure.md b/docs/_docs/04-core.azure.md similarity index 75% rename from docs/_docs/core.azure.md rename to docs/_docs/04-core.azure.md index 70af78c..7bd0cf1 100644 --- a/docs/_docs/core.azure.md +++ b/docs/_docs/04-core.azure.md @@ -1,11 +1,11 @@ --- title: "Core Azure library" permalink: /docs/core/azure/ -excerpt: "Proffer Azure common abstractions." +excerpt_separator: --- -This library provides common abstractions for any Proffer provider connected to Azure Storage (like [Proffer.Storage.Azure.Blobs](../../storage/azure/blobs) or Proffer.Events.Azure.Queues). - +This library provides common abstractions for any Proffer provider connected to Azure Storage (like [Proffer.Storage.Azure.Blobs](/docs/storage/azure/blobs) or Proffer.Events.Azure.Queues). + There is not much here until the configuration will be shared across all different projects. ## API documentation From 6e004dd69e98df9c6e213e9a0cf975676ff239e4 Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Sat, 22 May 2021 05:49:53 +0200 Subject: [PATCH 38/45] Fix img --- docs/_config.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_config.yml b/docs/_config.yml index 5d79eb4..bef5c62 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -237,7 +237,7 @@ defaults: path: "" values: header: - og_image: /assets/img/banner.png + og_image: /assets/images/banner.png # _posts - scope: @@ -252,7 +252,7 @@ defaults: related: true classes: wide header: - image: /assets/img/banner.png + image: /assets/images/banner.png # _pages - scope: path: "_pages" From 51988bd2a528a19aac08815cc81f04a256ce592d Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Sat, 22 May 2021 05:50:55 +0200 Subject: [PATCH 39/45] Update banner --- docs/assets/images/banner.png | Bin 15019 -> 30384 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/docs/assets/images/banner.png b/docs/assets/images/banner.png index 1f517337227816eb2761c97c5c7b0c415c8accc4..019acd38b13e5a1690026c11e1f065adfa5bfad3 100644 GIT binary patch literal 30384 zcmeFYWmuKbwl+)%lA=gSNGaXjC=$}$CEYA~(F+BnL+KWf?(Pii^rK`jydKS_qb<>l7bXA1~CQ#0s^-5M{yMd1Qg&Wk{=opP{@4~ zy9A0?E)rTUsvvV0u#uA)!h2JYu^EN5osor^ikXqAhhv|a5CQ`77b`U_7cF@?0TYlN zi_v2p7I!-bpfv)5kf^(Zk%^6&3x%V%9p!VrF9#;N%zJ;-dKH zKPq52CsT6)6>-Ub4hH-sOl9ff;vm4v3I>B&z?>`~Cks|~etv#dHV#$}4rZVRv$Kc2 zi;+9Cy)*T{dJs2rHgU3YaIpf}Q#|%)WDIh35vBsB`j0i(ImpZZSI73w|CAIUGgfya z2Ud0#HdZ^k$A$f^?d+mr_Ww`g-_~|k^KdX@RWWl0xjLBu8)8oVuf~Az{_{YO6@l3Z zC^}gIyJBQ34l;4IGqZP*78j-h{)ffX%2a@d&zOUsm*13`-3=oXm_|Ku&5PknO+JK*j=D$1@jQErV;CbfjVAF@llVeBZ$u;|IRWa|wna)WS_?DHi?U z?Ia6R-ffY!r;mr+uP#RQ(PkhZAQJs8kl6kfPd@!E(AxhN&;1Y|O9}+!$Ko9V>SN)D zfc04X+mHVjz5Ne{_>aB)Ur+eI_x8_K{P&Lt|8Mz^Tl+uQn*a6g|Ia1-@3-cEtFHg- z?Z4~rzaQd1E&o5Ai2q4%|8M#KLk0Wy!u;Rv{{LEC|Jm?Asl@-plKj(HEz3!xBYfj! zsG;KP6y@u*d^SxosFSU2!)A33Ctfu?&mDkRUoa%eZNW+UHY!gl98;#OcI#@UFVxfQ zY)TI83ZP_;;i2_>P7O=~Z~6FXg+!>i1o-LL2I;(gSC0<6hL@ko+USE08zOsTmxiW< zO|sXEeE@+EnpUPblV@W1!2)7!utt;oT~A&a(R;k;WMrBaiX(5|B`OkLaXh$}wRkpt zRgK-KM^*ib$ojV~sVKaFQl^Pz}2n2N{Em?SR=RupFaR{Wir zZe^Txcbpp)gT!U?>~*+OCfbp(M`NB(u)$-;NNj)9O*up#-szhw4`xNYvO-Z7gR2$9 zam;Z+7$OwZ>#6vedhVq5Ke}qe)azcx;Z>hRcB1T$2Y3s9%iv9}87LcJPp)Q#?|lRX z1ww%y{a$_iM%Wt3fS~z}^NfI2&ucr?Y@zZcN7tlIju?H$CFG%@rKIJsQ zZb%`6EQizDl=ICs-0*WIYQjKSZn4iVkzM`@f>On{tqBwzf9r8Uyc{7RmLGXb<72a; zd!`CZk6Xlq^%<3hQh?tQ&TVzmjqbRc>C|BR6*8YS)fbniBXc<^XKk>P|MSNeGilVA zt-a+*q96LL%rF%z8!r=4vd5eG$)|VU$1$>|msBWz8g81RqAF59An1?n#U`IdM)sMG zHA|dG^BX~%LBXOnMdJk+IRxk}*F?+4 z>2Rw$12ztZQyB10!#gb-vH!8^U->ototx4N(4>Sa3I!+fWzwuDIV?Qf-6s$cu6a^C zBbNuC>=^$YexQ1y6%i7)UdVF3K|T9=a>`lPI?|g)G@TZi9Q8r$ z^O(SjV%Y67}1^?lE125T*wSA6r+z}_1 zggoCzM<$v8iiiqFtkK{H$?x?aHhAtD_Qej+p8POQG5fVkj;xSoEwz$b$y6@0Ta(aUYy{uB!BJrAnzr}3p^vcy(bPhKkA zZA%?wyKa(Azpq1OixTK99IhTq0P3?%u%Qzix2X|#H**&_YtVT0uFVFenFZ~`1Za7Q z8`eynFYoH_)&h!rSCXB{xXlh-Xb}<}^L(s5`WMRs!bgMa+oM0KzKiZyDV`wa(n-@{ zc{tjo>gm;|eztu*yD1ukYI`p{{n^0Aur8;jwC++*b3f3R;hhu`u>ORPjKMnPB159@ zw#mX&eScQmX-$~Y)>s!Gu*~Vkd?z%*s!t9Q#m3=(*5;AfeimX^%Ox%Ik_lE1jGT@Vb;k=QY9+m41N&zKXKIbkiH)gIU~UTQH40(iT~+O z+a^=+P%_Cn*=}9g!0p`#j(VzPYoj6I+J5Qw@E+D)Ajvo_TvwrYHbj5wNJv@c7RArX z6l13J-evi_EB|LoNt_Un_lhlO-cCod+ zDc}5!*__{Wn)cf!bDjIiD&3XL_A$M1cAZNu%ajbJno46zt zW0d?+pCEEHX9K!;2?C5NnX#A6J9Za7n^Gi-2c-lY<$}9cCd}L|AYlU)-DQ5Tyv$ar zWy$+{9LS)^L9;_;!$I~}RWBP_!Bql;cX$kG#sh@g#mgGUCqqSQk80g6ivNPV-r>X7 z<)0@zO=$1O%pLg-vJ)(FoEpT@p{0&9!An+EkysaVf+v60>Yt1B{d_+e3>o!M4p=1^{-g;w+|MfK<1KCj3YaV;Oyz1VXy z;@WWcd~vaQd;{V%1`bL#w!t5;vz$*x?>z-sL|+>hF{K{fy0Kwqn-8NMP2x*9b zQ;_()#2_yERiO%_ILPCNSN)bAtPjVAn8l4p^C}qEGw)mU!al3ZwBe5dg!b_0Xmal( z#pxiarz(g7$iP;zDWk^lu+!?%TO+(CAt|HZ=ew4am|Oh{X9=6kW<~gvtKCd}Q47_RMk2*NjWwn(|DUsa z;x8Q&jh{On+CX{WakBVyB-ILZkk^cWFt&8Eo-fc)&D<@ULcJWfGHv^_i?Z*1@zoHlFlM2=83L zckTsI7NQJ~_OgBqrXCu6jnJaZEMw!77LSw8uj-hU)ENq8Y}3}P=TpZeclBQ6UUQfa zl9H5^B;(0*{Vl@vsp{E0tf^$l&R?I|-);)or=+V`6(ObuSeA$gGy&t$n%R%NngX;T zi;G);gGPKMEKeuDFe+xi3@|nB`l}YU8d4TE5Q~L(&hlV8kKUXZvaWmT*k|qdOv~ww zyVEyne(8_%(-V$RFk`b4w<@fga5C168(RBOcr7mAPb0#u=Z=q`hyJkZ)F7a9Yr|Tt zFRDhdGmB{ z5oA$5Gp)AtL70-o`G?U>O;v!Vjme1Ak>-Id zR3LDvF%;~2o^e0>DX8Vfd&Llvc#xwk!T23B;b*cxmYN?N9grkF>ZhDGB1HE|ej3wH zd*~x>nkCk|Uz^|VJ1M@-_rBom)nyFn@JrD3@p7|O$xrMU;diq=>YjNmIHoPgHMim# z(bRucgH}e1A4Fg;ukH2Wy_n7u{2vKOfEyxH?OCHz;?PDGWar`@Tv3pS0r)b@r{VnF zR#KwP$DOQ^=XLDo2*(P5_3Da{pyJVj6x^Q#U2>(mUVTkFVV_w|C=AdXs|lG|;z__5 z)kFl0a2kT`a|@Zi7qEQSb_HQ}Gdzr&wVJuWFx6!b=*B{uFy|I&9*tjuwwIT^Qhu9O zNz0X3-s1N7G^?Mfk|M_&44M}6N^k*;Zy4o=@_WpQnm^OyMRA@-%DVPiH05O zwIaGlllZaUt5jyc_Pp$A#%GU3imo1gV&Z8~3_Gmmz7)D(4a!Fl#sF-`v8qj+H2>=7 zRVqCelGjcS$ZY0lkSb`A=t}igB&iJI$CW4_07)T{HCR zp|Q=u3vEq8R4ng`dAtOfOKMss2{@;d?W)R}>ih%{RK6ubp*t&?hzq;=5o&&|PyS?l zMUp`<{K1`1SgP1`Ih++u2YHcVSFn3%37GWn$6=sm182!Qbmj2(I!S|y7D_f)GS1~9 z6yhL^aaf8gV#n9fe7|Ui7#ZQAra8L|?Zq)Jhr0-!TfpbTQHK{E6M@N<3=LF{h{4ML z5QcZGO!mj&ki;qm4`}jayOMu>1h0l$-IOzOIoB)`wLjUKXvIyxUH?YqZx?4hPX|4n zk7AzgV%CWeKi^P7J(dKYtqyMHDORqGyfP$Co&Hp|q`{>H!x7TbY^3wIfZ(pP%C#un z158IEAB%a1K<$D9YTZNJ8KbmO2FNpyS3{@5A?ny zWsFU{rGTudf}{Js#-ruqFB3h~?4OeuMTCFdOAbRO#ZY!+0aZe~dir*%E62-vzA&HRkd(18&_S%_y!KCeqLjj@(wD#k{hH5f@`V@4(Oa9vTDrACpxy~J0>4MWD`!T>{ zKOr>zVI~`oH1V_CXJ}7b?N^aUNB98nJ@tK5w%*eU>)h zI#)O>F}h_8F3lUe-DmZQZfjh-e5!#GcIax4Q(p*NE=ge$jyDm(F|;fMk`{Xyep?c*T9)}q3)0T~Owpwzjg^FJ3O z=>mG2Aw5&po0neOs-~ZE$8HVNX}X3aZv}%25PZ713|8{#+$(2 zr*a+Qs+`di>>6(MnFmV#Hj5Goe%o3wN#C2mD;`LJ$$naxsWGHWt(r-grR--#ae@Fc zXAq>k=U&n?x#aI5?ypA*M;{}ZVgzq2c|VNT@D7E_W1bA1Gg^Xn1n(}pGkv#OJJsCp zHFMfvCoqM)-#ABc17^C=WLb~TuOv#qSM36Oq$E)C%*P|7*@OSdo5MNScW(M%b7uRA z)HTeB4Asld%aEnbr7@1>GrjY5H$!jv*_r6#4;6ZG+uBb?G7hPkdEaE;w#%);cUH#6 z05dCvbQ}UqOYwOMfzy&jXlX-3d+$V9&Wi7!sWYjS64Ht@v{!NkF`$`;)fKl87=m4( zN-Mn9+ZuC_)H7y&h@j`KFX$OQ0Lb@n#q`~Agc+B%f#Jy{7O#-2TlFv~&tJp-jHeTh zXg?)$!IEp~V%2Cl*|&kYnAt9<(oof zw|b)^*-hcY53xuSn{kGzOo9fC#{O{grNxL4Jc7qqcy%9(W@ug)!~S9TH2>GT!ZD4N zx~t98T-ha{$$kas@b%8iv(hDrea-@g$9T9a&kB1_f`n58!Z1Rbl}8N3U9xQgI*wT( zDxc=H8_7oCPHn;1<^;d2!sP!R_m(JNc4cCJ!L;yB{u)!`U6a zsdhPs^P1$)i3sDGTn)ysX?6_aztbvmBJ9z>O3G?iLe8moX}n0vc+FSQlzblcYO}$R z6xT6#;>+8`4V=FNNQY<}%`B?4`?Q&utmnY24R0^Ts)9&%@Dr_whc8n_RG2kvtQy8* z@&5MgES4o_W1k$y-#at%HR#q(YPr<=qGFv;RtIR1wCu4Lt0j-}ge1EPiH;rt;rN9d zA$$i8zT<+$FDnKX>cq#y6QCVVx$l;~%O|~mAvv<8xE~zNL&mcmY~tcQ z=zk{LXIgo3;z$XdXQJ-3nO!T_P2<@QJ|;eRWna2y1u`wvb&r}KhZ+@q0F45IFx8{@ zhalWJlk^B;h*L!b`#&T=nskF27f=^SZUs|NQDL@XSOgr$v-z@H6=6eS112Uc3(+5b zFT}rZa&3ni3s|_<#5Y1GNnfNdk>NoV*%2SZ#$~x8&9~-(`$ES%*>Dyc;8qy-shQfI zPhoLYwQg5MtZ$WyMX<$~RF(U?f4rQ@H6e3G7=e1fc%;%yrYshsAWE)VO8Vga=Mtzw zg(dG(Nx;Zou<>60mHH5p7&hS9ah&vsMnyFN&|veKxRt8<)hu0<8ln)n-+p&P$*q1Vc%(*HXza=U=ZGDsnHhS%yOY)tDkaMILw7G&5(bRggyu4rc#O$gg|JuOMb(t` z&aapOu`#Id;IP<8>p7chBDD)WiV@%%Q+~_+!In)w`iaf@TrxtZXxw_r7t-R`ba!w$ zFi}6t0-Cw(XkBf!mo-etDQPV`5mVHi`r&~3QJ6pAg&!s2XQQt_i`iamXIq!--~XAb z`f2!y!IfJ}+)652_2$z>Whix+M()OtB34-Qxc_KiBCWVco2VfzP83{p!VCv{mL=V8 z{z1oMF5SF9lbWj|k%yLpl9P#t{tX8Y8^te3v$(h5^&80?~L1w z;a)L|O_{(l|CVX-b2bSsNwev!{PQ{GKJ9PHCmj#Ag7;DjwJW_TwfsBei%gsx9P`to z6G~Isx?_$&v|IO4>a7DBHG*tP$4~SK9-9jWSh;il$n=6$61rhrV0WUbxkT{P{JX1T z0K%G1wXtwTR<-&iuvaela4K;$MUEbeK|W9Wv`}+7w&i?&kuifyE&vGp)l$umXJpO~ zD22MYyd=b|4b+^>O_lO{Es!*AV#m-aJ8hOju~tO`OLaBp3|vbu&N~_lP10G zH)oBX8-pQX;h5yz~zZMB6&?l*BoCwQ1NVT+^&}Xc<1KoxFVQ zx&9^kQ2U~N(s?#bz`y6-Z9^uBP*a*FK_3=)=PI~OBrlM0$bf#+A!~7RLCI!C3Y5-6kPpT z*lbE?Ag_q5bbFM3OGUD^gpB>KW*ZgE(3k$y54#Q=CGXR!C|G!yHzt?o{mV4v?sGl? zu}aBHi>attDMke@&2)RSL*$9hUD9l{45B;e9keiD(qTo})2TN$G+ztrXtL+jiK4&PFXji$ zliUu7SpRu~lE`B6pYp=Zu{$x8Z`HCqrHQaP^@-3BJF zY4L;0do`8OpT6uMqf`g@E$qmLFYZGyw@w@#;_N0al7pd{6($)%w0HFDliC~i3&g!9 zNMqqAqfneudDVKii6v*?Fnqk%U|$V@PnVVHKupH=6-foJ^JHpO|A011gIibAyH9W% zgz|Z*;cM#h|MSovS;1G=H$Fnpjz9uzqyvmG_<(Y=h zTwPt(JgZ`OG@UuUct3T0eTG918{V&K@;_t(8J23wmOVL}skzI7zIN*pm2ARQjPfA? zj?sa1%tQqpc1h>(NYAMmt&^%RZE*4#l&{w?9Sf~y;ft@VOiAc5C!S&|k{fm83ywQ2 zrxw0Wvpj!H7lK%IPj-vRGIVVL(*%BDJ|ug4g86Oa&S~YFW}$W_X(w8{3NC?(K?60o zZ%gh0p$=Le8jLe&_ak3Ox!>4z0 zcVK8WlJxz;?P7X$+DSt=i98r_da)@&E#@C0htThO%4)CY3%YJcHigdzBMdTpAE?-V zUB_kEHXddg=OjB5UB?6X&BJY{{PH*72jk7$yCb0%b+pT3!xf>&-FQ<%VZFa}7H``> zNi5C>i|xDXG#LVr*h+d2+&qmk+)b0H*#;ymxx7Do{&a^}x(Cb35wO>Dwiu%@g{Nqt zW1`2uaut`VGx`GM$IFa5A_@6U|{wxLDFC>t+ zm@lM-;bD{sgK)yIu7{86@`iEF=F|^t9#3a1UF@m0EUx`^KNTf%*h1w1w<``mS7LSN zz`a{)W_|IUc_watC|du!Obqy zCF-#TJaZoO;JBZ<#&u*kj&SeOHoKPcYIf%F2!`aWWU13Hv{kdw_fn7Ol8~o_Vll-G ztc`yd?4ZJ`aF~@kTtvo_%LtxDP@dnlBLD6}rm>XF4Uxz#BMnhI9T9D|22k1NYn{=b zba9~zP~DnMMrS&dW(V2~>)Q@a!S9^ZKBgWQk`d9LUt)@RTQkEZfvbdxogu=w&ov21 zo|32Reamw~-vyV0-7!j$X}1Gt&4bX{XYX@aR*(nrKYh9trww(EAJv?2k_hocB?dK~+r{!=e2HIP*1T`TS6W&2@xuKThN8lyU(j|5l07aqPwN|!gGrzo za=9E!6D*TkfIS_B`|Kvjx(&8*k%Z!Seh0A}x(MVIsrM6T7yPw};YWqs#JLriNNaOHgg;}R92`oxIwtvrF z*N44Ek_!t~i)ka8keDxyEcGl{Ms7ZhAB;VqGt^po&wl%qd<8cJPiCa;i>qLm+oEWc zz`MOH4rD0ArHEA#jr0YH%Td=%Fo)i^4@B_v@3`Kb1VrTJx2jd45}u1=qU%mK+y)1@ zr$40^IQhc71w$*4KqR~!NJmWifz#()6?7cX(Br-ZSzA`tzvcNvMB)~OmL9$nab1^HKw*KHnlc{n2)GFdLv2(P@ zn|@KYNg@KW=LGoAiH$Vq@@~B@Z9vJqvz&ME_3c@ScUfXD!>>de&8)}E$|Jzl=QX?+ zZZ#OXx9_}s9*+M64+$9Wy4LHltTvB5&mY@UN3Eg}8YU&MdlteL*!x7X8%41rH;t3l z2tb-M0JvwlG0SKBad#5|*XyEg$e>8q&Bfrt_ocIJHu ztVBKDo&Of5gm5-3J_ zL-$_`fV1F>6<;gwhq~@HiG62R%wZW2JNSTMp-X7$+Rh@1qsJMpaHEY5xGNQtHf7|% z{MIG-RMpIz zL7ixd)XQD0QIJiCMQrxBe4BS#M72hsQo&RZ<9SHD=4KiYsr>H*_2g6%rjVyh4P{b*6%0+b*- zx5=RurpS@wYyRHZ+3Onqf~-&qUjNz^s$&uIq~q{NA+bt(@L8$V_dxS$4uNH$L~*!5s=Kimw2!$vm&qPM~b3?C%`e+B`$& zu7lsR6j3Z&!lH&T$z+FPb(S^<{KsxLt)lw%r-1;C`_QDh=;s8sUP1aIOxYU&y2KQ{nD0=`mh*pBim#ndnIZEx4gGF)wJv5O?FwUC4X+)ybc?9-Eif@ zDj56^k-WkP6aqQk4VSTm$|Q%1C_6Uq9*U-(F6#A*tqtiDL57BI3aY5$tOK=%F5PsJ zi#!t%F%wzBX2Q+}+k27~#zum2-)Vh+xWj)Ha~tPOyPxiJtt1=B$7|1LXX2GnID0i1 z7*}VSOX$wg^8PSSG2Ok&o?#}fi=%NLXS0(LBEPsLxJ_f>X^oV4 zywl$FU^m6ucD#(o6q}OS^}&ZjfPJ? zw?Kx3dM$UYzy`o{E?d=D?shXT0ZI;m-ETU*Z*M#k2}PVW2Pnu;6A3yTzZQRSS59tp z&(#ja*8U)Ld(QrX6cfD>z zqe#74%!xJElJp}wZJ@3pyxvCATCq}*4M1{kW^wFIfSnt0;%a4rq+OHh-BaxZvNE4F zDOeLpu4Oue5>@oV|3lD9v%?I|v^Z@*@a*Z3p|+db3a9Z>S_h>q#^WvB$A)T|02>6DXff#j<7g=2jy6HJDL2x2d3Go+<$-Huw(c2Eo=ooG?kuMVrpu7 zelHr=d|C8;?Au9FIgetqw&tyG*K`>{Nt01zy=H_+?Y(o@$ZOk!{4EmQLA@=sr6tjN z$wiO2ppwXK-qF7 zWx(>3pat`MqS3RHgXS}Ut_PUJNTWR0(bq{tL@x;cz*&w?)h;j^bh1ZZaSQkhuq{5v zwZaJFCXsvH(9zQ5n!jh80{al>9Wb0f4J0JVALyIqh$9r<5^gqYxZR*CWU^|b9*{-c zA7ZDc#R~F`i*isZ&Atm5VZF=i+5$LkZd}h?>YU8^bFe<|byKCOyVT*Rk?qIop~N2z zauLy$93K{h+PIkS|mYukf+N^OE(!Supb4@AW7!3=iP>Pb?bST zlfKZWHdO0hy6yCeR9EgtlgWMe%-qNlD@0(U{eGXa>veC-+HRm+zDMiTQTI@ION6?< z;E{HrQt-UN7Vu=Ah056z!|8U5D4rY}y%$D4K*cN>t^$)bC z>GvdT9N$E+ZMrj)v6y&g=OMM81Kq21b8Jfi5LDoj1lWpFv?vm9o+N%b??l3YfXLmR zonv7hEhx>YdzEJ2>cR4Z$W0@n>~6g?4Sx2KD3TY%8KcA(k0k$&YJvA=m)))X#3OX* z<=uX3AsM=S0M%3!g{?=KA2g`ROV5Dq-B+OyU3Ilo8v6nIIb|E@ZzBpW^IY{hvytS4 zH^%<7mzwZPI8Ivat|(R8!*v7PeqVn@KTjout^Px{y8c7=&BINEu!`Zj0pt-Y`rs|O zdB&c8=y&0%P7G^+T}twDm5Z0DN3WjB>hknwcxPK0b%*HjDJ*wG zf=MgGz^C@``l))}<&;Yu2itO0=l45J+hM|@n)|Z!1U;0jDx@{lF42=-1Ni+audhBs zw|XjTcJPRB?7&C>Tf!kFr(9EuoqD7i|ChcG!81>^-bRWj#{}*qm>aPhV9~~JD>3;SXQrL zsTH)$x=lr?BudKiLQYFmkA%QtS$WT#0uLgOigB+rv<7}0etWvy=&r?~=;gafNDFIZ z%7D+yR7fgdgwrfVtmti^%tZb%vxi-BydVz~=2V>s;oT2M^a8bk;?OcBa%O=m`1^8n z3+&O5e~qSlXo57;unUI!vb_g5SOALL_2HQer4rpH;EM5|nGo6yejJVfl$WEy_Et1b zEFA!Q-prd;g{O*6yH6Ra|H?6Z{YtsoI*S@$3ag)NF=cDR?z)1KC>K8v=x6AZD^*u8 z1TB|D>!EZ~4JkWju;ty4;jn%LXT?Tjj6^BEIE&_*6}&FHaq&c=H%au@^)jjx!;tPx+` zen<@X?c>&mEQSpPT+!!(j?YrgCYO_woeyKhXqto&+&dc21zYQkw>1g#@Ws)M+-ZKU zv;_xa)?akw6x?WfkQiB3TU`t{19`?6;sCnTLIONmjEXtDpV=|NEN_-7D{fSZ2R?n(992Y5#du6}o}!{Jww?aw6{(g1!q2p4=;p2)`o8D5ScC&yOX#C} z>VX3>=B)BRpUSQ26;61bc3H#9CwljPOw(DPj4qqC(w?SsybV3B_rn)- zLjHiQdD2vs@OH>B!3}@LAlABjaf;q~=BG8bHP5RT^lGPG4?bya+SMR}XU#tLUxiSl z!~q|u4C*ywm9S@OE7(@6^eZVNh&eI?vUzdIfR5Aq=!@`X5S+<;gx_scqpbS2W0mh> zR{4u{d+cnTv=CZM`m{Yn+bmwBfLcIRp=<#TeT}3!^O$F0lYbY&7DU7+l@a?neYFc@ zkYBWOej)%k(u?O2Z)a8n+bq@lr_2Tl)Ra;a+qh2FrBi5G0N!~U-)fT*77y zZf`=q`zMIoC~Se3$RrLF+3qbeUo>)44Y_J+&cPQzzH}iu(89XryK5wx*Y65MaaRf8W)1H!p}wJY2Qk z*1umQ08qnDZkbs3aaBYgQJnXD-5CdF>={7jC63%?@k~q`k}zcv_Ct++t3-am`>MIP zft_>DU_~)D_T}psVvduHnH@Fsq)gAN9#_om6M*(^E0{HV-aR+7%%%7X6`=EiM7HcE zWS?DXXL#@Uxrnws?-Ng5wtZMI^GYu~PLA6z4;Q&y!bw$dZ1u&zR3HH{o+IZfDuo-w zuD%AyOgN%TOABu*oU69U`FDJ&fp}i*6@S2I1R?$q?Li-IBN8W2d-?_W-Zb5J6VzQ0&wDLk1+z4Ynu}5Xm`)-XjeT_I_I04~$v(A604G;n z@T_);Q&d2^Fneo~c=H#zJSnNsAB7bFTtFr7mnk1NSA1Fmt%K zrskjIL1%Fn$%|hTr*ZQ}U-@~T^uB66JLhpcg5ifpHKpI)h|JUv4D?@|f}%d&o|QE* z8)o8dYuznpDDb3S437z{o0R7H)+!d~Q861xA@rPU`N)=P&~~1j+(_X73=&-C&Ku;C zi-bj=TyrOlSpH6u^ai?%4@8JW1^}hM@2%@VQScz;Ei-t8Q70yAnl7gWm$nKiu=)UZ z9dDw$$GL{URvJF$%p1zLeP(#zwSUmvwR}l>w0Blw;l?db$&U+;0|W^X7p| zwcyc_!!;puDTmS;4;OB9&zKVp=@{xds7Bjg--V8Oe-Z}V>y@A)w9}fA9+)rY*nfqR8TS>J_=&E2#I=YoZJkO64ofn(xz7f9W z=U^DO)e7S^uN>*XO9AVvC?)nSY3TW~iZI-y-FzlwBy$5>WdBYh>HTX$cC1K@mlOja ze)hZ52X|}Yft^8(p^py~M0~md2_!Nsj)TDSw8>UpIzhI^;qFKFW-n8oTNQw3J}a}c;$@f@E?BO0*o_aZL)^l)f-eCS zc6ur9>e#E!zQHGxE-LUY$iU++yU@g-enRlLwwm@FL-v$#`^oU;RlkXpk7>*!p_sPy zLlctf56Ys%yc(lDAP=jJa$?WJAp-Th;q7hCrpS9XT|f5);%6`(brJtp^@Rbl`eB!X z#>11h+ks{CNrXVGf{B>|u-QMh8C96G?(X#_>)3eF!p{_XwdA#XmD+~Vc!9S|8fo?> zT@97d?&}dN2G_q!1?`)`+DiFPX@^+u^KTD(husYk0eD> z5<w1Kc9a0R8CH=5=tU_kvn)wmIPG<)4ITWDh-b4e(wrnuiGp3Ckh)D5`J#^ z^XNdOH--++pFRWTNso7W_ZFQIytNx)AW~BX`C-5M^*mOHwP8_s)<&?Ut+Z`GpkSqt zZ%)sna4PMpL|{Ur>+(X82x*GZzR&x(U-3(w|j21DY%~m0NZVrG9YK~cby4$1ABF|ZM;&7qN)Gan6t_MC1cYCOu31s%c zvN+mj1==w_H01!j?f4>;^XYzSBs=+v!53rff~u}{PO+Ecow(yvLOwZHN7%Zg4<{GA zO(aaq4LEfXvCW!~hpn7_N->;2@mcd`82DS-BG?Kboi2fB%lJxLLKlwN@E4k3SAwLz zD+`i?1_Beco<+LM0g|Zs*fM=SBl{?in4uc>Iab@7ZL>tIXK5~TsdP@<^m6GSkV>Na7he0E^*BZ{3T3sm-&+WA) z2-C${Z+PDZ$AePDF>4P+i35iTn@uc31HTqIkvSX6?$CQw)gK~kzleyfruTB4T|&B` z-W#8J0c5MiRYFf_Vxw9XCL5nh_2Ts(c3VeM&ztWVM{`$Bfpmy`)S{jV{C zh6wanW-@13Jhip0M;ZhLvmHXe3(y|ieb%sIt|xp17;vX&%zWU4K|!~NVLayUy~rRT zX0}PCYJr?J@rh4mLjwfN4D1dax7B{n{U-@cffp^EAzMDI35HBoZh2|LTc7J59QwyW ztjpiuK516G^T?Dv@Y!7qVvTL!{~W*V4XYp%sZ7Jzy&40x={t_51a-$}SjL`jYvylA zCsE10_ujIMnAi%lP$rx5m#@*UkcRr2C8fUFed_M(r8w*a_9|}vPE1_)4V)vg*B({xXqP<@XICZ@~|F{kr3nH8=rRDS@hxa~-; z)MZ03)N)-ZBf`#fe&UE4r`f|E6b5EB?}O@C9epH}3O$`Hidt^isnTyba8H9F^3e_A z;o0oiRo)`Lj;Z3($#%VBklm#`O8uNuQZX}hlu5OobM@xU-}`R)N1l)6jI+hpAX0#K zs4&z80v==mulQ`IU$iJwYX(Qx2jo+W^VMh+j1^$fL_mH#J>tP5&Vb14OwH9oHI9-t z>1ep!p~-5BQAp+I3(UxFK|{Oc5eB{vd1$8V>+6pY(eJSpvqS6Gwnaz4+fAdYV4ku+ zN^K=B5Ie6AD@h+N91AD`Z_T;fV8=YcKYoaRloOyIkLpdSI+wQ8lt!iXRafa8L@hqV z&nSjWF7VS`FjCGrn=FA$%SSxzAz>qzm*e-YBqDEn=ytMxQ_D~J`fVc}BfWrv`A#+B zGzs#GN>+vtNC}uL3Ur$vP3 z0LZDAKbH+iSOzFA91_2t2K1u*dh^s{?YsH>K|a9xTy_hC;W(tAs}W1w9$4Z`^>ah5 zOQE~=B)F$W;Qb%bpAWmJsV|iih~fa&V^6OhK<#oJ9b2&@BRiS=_;IxhvuvFqaI^qP z>^xZ%qDt}P2o7D1?D5USslrJ@Z(Ml#8ork@wB7QM68x38PxOq3{X@V_25YLllSjA0 z^`08pQT4MqY`6~Zf^`2g(NhNCn8j{fUM|ngAC+(tU%EDspnRZ`Bkg>L&?*Cju7CFN zrx9UWBSR4*#|LsB#k7Xf35%3|2U@yR{Oo?o&cQYrol5x4Ff~z`2p`uD7aY%;t({^( zqe_&>C_b z2D+%b`Stv~5%W;R@QL#4CC5w47S<~d$~#TX>fz*VXjQCC!53F6fJ@jt)GlU>6?uLYiEu!kFF*K<@XAVyI&v&@edwuS+3{MQq|p}Nx$n)( z6~RA(sxk%w)Q9ZLW7>$4F-^RMfNv`Uo`SiLl<}`@`65IHKRZSiqN$+xbsvPJCv;fD zD|qf!?}eh3qk$^93)2bW4=`GDzZ+ROG*hU#o58u9RCj3<60MXAo+|(KrdUNi56*qRWegA}5C9~B%P&*RF*n^mp9F<@9$f|doM+duh+Lh0cjNOSHA^m$Y z`Km9q1&;gS&kmn7Dy+k2im`)qmaKm%Eb-C45ZIs6$|&Mo3S^7HkY%@#JAi72Q}b{l zoG(VSa5l~lD_1Qxzkm}{w%A}>7nIp#YbPXjY z?ek_Riin7cfJ%w4pomD38Xy51ARVRGpi-rT9$E-RMY_^^l`6fr5IRyLARsMtkQO?j zCE4fw?T0;Q&wtPE*-!gnzvg+){hZu$&&)M*&CHEkE0bZz9ahL26PVQQ9R$req94&~ z{7Tfx1tBX9wA5~r!ot#lzpk8u!w@Ei18xzARVXGAIka0bHxS38L@taouiwj=#9aunSSkt5{skC&>sm)cb2f5Z z6QsXJP5<@zjdyucPB&yCRE(GJsnm>yj!uPH@(id6dOt2RD1*uMJlZDOn)-gaCWk#i zttKYUTBWTLp;WYU$0}onv#4{kP>XbWO&8Q^oZ?mJVRVRNDOi^*uh-Y|(UqQqm4PbQ&JQPIwO zqES&%@3K>}3YltB@~ur+J676lZu6C%uS>iw?GULLcFv=7oMB#%>`=KgC#a=rG4yvQ zb4DBo^)MrL-5EU|muBZZ8h!EBNqr%_O8oFIed)TxReA0gHf!`I{pPC{g*@4BPy0FK zZ_%vXwqaf_P(LUYrt)}n=XUUxH+jkIq1QgT`JlBnilqLm{L2n6(c zdDeDD0$WFndNL@5MHR%w@#V<<6GjHY zFt7RjRC6(nO}*(rUq?^t)iZLLKc1eV!2j^_JKDNTJ*(q*L{+n60M&8qcn*&W=)p0_ z_#sHNpt+59j<48RV}ypXk>ihVJwzBM#eKW+tMOe~PKmdj!@cm2LC>GrHN{D^((LdP zK^jbVL5g%i&ru~QkS$4XikZn_L19Q2jnEj^#3WR_b|2P9G&Hx)N`HP=uE9-AUtzfx zuZg1SPx#rZqNhY1AB}K_MX&R#g3{L2xg1b`y=6|lFT&A_dnxBH+1}jY;M9St?T6cTH?ONCVhjI(>UH8vAh@9PJ>w~+CzL%+pycVE!nm%TC;}WeO-}STfQ=N zXWtzd%JRHUe7TznQ0OJgb4q!Q$p9GiCTAqJ)S)#xN*(UkF6t9R<4#rmNdKu zw-O8jQXPdcF~LquJ3Pn0@%NNhRGIApZ_^VMOByW(`X@ZCX4Gv>h?!e%?Zz_4i+W3}UC^qL9zvP;E@Dc*1ts&oBSfxx6!f36l6M{AfHT7`GHK z?t!&RG-&yL3Vh+jYIlhl*Rl)sY^NKK?S~~ZaxI>CPQ6!*1b^VHG%<(Mw>;aNh>nex z1)QwlZn{x|fiQQ%DBp9^xB0i=4~r)GLc=5PGJM}LEX6mv@WXaN(1##OM5gs!(Z^BR zQ7t(+IS;9$*ZA#*U+D&PgokycopiRsNoH0r4sXv+vN5UC)sEYHX55pw!CuMB!Fk1! z7Q!uqYTa9SI`-|3w*|xHzWDxEO{w~JlTRb(;d2Mnj$T<a zMU0l4sogJFKU%?;qYM3M=P2yl47w#kvuEc$|0s+7F2sAye1}eD+44)!((C-Q&}~Xiw|c8#7(x;FhCP_ zcsFj@G=l^S+^tJX;%eEu;=;;evKzs2sI&DR`t1y;XSXsw&CS`3fADq8OZp55g=hB3c*F4-Rc(VwqOBeEQ8Wt;4(GaB8g(_Jh3q!LjB=76I;7 zlr+v%{~*_B{IRi4RFsIijE<%IWD-B?^pTz(OYF+UQA=+Zgo=GUfi^5L!?JW|>a>w@ z?8%*f^y$r@doXGF&TPa?`4OPo2K%{m!)9-shfg=+SJ*7%Nc%K&@FLDz8XM0$(~W#z zkHv25doBhE_6{;QUr)+qPAxu!H849S-TRhFTT4CoQ&p>LHZGCn=`&h0g%=Qxo_^&6 zu0stBX|VO{?aSz$B=?^}jF(zc(g-#F>!gAE%NL#rWZp(tb#}Taud;T~?CdjvOQuI4 zToQ3VdvFlM%qHWwkO^`iYjfIfT=`$4X*gRfM3rYFd{a#rL?^O{6j8!m;Q=WEdMe*G z1T66LRsSB)8_XPrFZmT5GUg$os?M|-QSp80`)v!)QmoTS({iUG+yUxYC+_>jr2_8; z4adO{D{Zm&SK$(f){uqc%FE|n^*c|iR(=*}raRHh9nd)Pl-|wc{3$9jGVJn(o22lO zY@mK^-^+{Ns3y@>yYgEL-gBXv!$8czN zc1|s(UWmN<6v6YG?e-PsX*xfVSR!aoOn4tlSol=8^lgis ze*k@P@UiXTMd8?T4~I0+IXitse)pjpJK5sAdA4$Y)0L50xHb4=)|8}9N!|A*pPsNG zSzYM+yd~8%rrm7sq^ov67!T|1uRv&KQfY!E--y(jO;%m(3{&Y-?&;}ME&JwFr}Izr z3&b^S@e+$=0S|4T#4D}IpRbC%(0yrE8h@yF`(Pr9yqs|}bxXGYHjBTiV1g{S(fwzj2d~=Oxf><*B)O168*3rq9YsvwWh18HT1D(`9Epf#g*KiAwS$tyhbeq4d} z8ZWgc3BjEDVeeZEAfvZhFpW7bmv#1ZTv#t^hOqvS5|*A!qV~YDv91>K05X0oal_lQ zFZlEN)tuw(HkzSS4IS{rj9Ci@gh8#l@do0%`QX9#A^1At`NLH9ryvLEiGrxG&sv87 zrd$vam3<1byeX!Ow42qQ!2kYn6Rp3T)-`~ISa0#qZT{xGde_#%G6!d5@;$-HV*f_T z3%ki4($=FMYwHqvGw0T@H^lQmQ2)bQTwI=OyYF$N^&LNJB3*OOhsGMH=8)#r8+wS! zH*zLn5ad8(+TalPu4_OY0zy_DUUfZLc(0uzJtTQk&9(k(f6;+~iiO!VzuOlushI*y zx^~_NU*0siqZ*zIov-hZ?W>ikc(Mv4{La+kN(8lfCiru$md(S0;%Q8^?0Ck;I9l%R zL{;a6&{GR%XJHD6yWU65=lxDO$FOfZzf>Z@Q>Po;^S(3}o<6^$aZxzbyr*#DQN43} zN(Xy^3_dq1EN!d{1__)JH~ z{_MALE3Q8xJp|Ft{YhJSI%z=3mDhrSc%fIgLOZWE|H{x1@mdc!ZnecPM8$~dZQccm zCPi$1s5`SYN>X?4QrJ8a6_65_5|vTo^n3c7>+j!fMzh&N20aiEC3V2O!5A0hNY7w_aZpUmQnlV=k9Kc8w%C<*mZt$nvS^X7 z?h?jG{O`wR>Tgenb%F({U{L7Z9<#U?clOrtJRr67#(a;X3hK`PEIBJ$x7-?{Ncf{u zjrDw_5u}b&#Vm!Zl=!Un7EQZis9$xIZxv%qXo71iHv{S|R@FLf7x*1aT*U;i!u)PF1ZV^9t0^sf+Qtuqhpn^AAMUUD_n=&NVvlwJzD zz~WQW=2?%#8>$MvmBN> zpZP6h%Z=!3yFr?rXtwGL9@HXfRbCZcU4jE>;Zvtn1MSx@CPszSHmiG*#YrDj-VVU9 zj=Osw_3nqMO`ZOHP5S!e+8Ve}inXNy30Ma`6ML9CARwc_%)du!v2y3VqD-jmoI;dZ zW;36p=VK`;n~6`Al1(-?h6*8MP)ao?R`&XB4&|oQ&FL^n^xptJod!v?*;du}m+S=v z4)(=_QKsAMbndh+wI|6A20s$+f?Te;Rvp-T?)>6}PoMuyZPeiS5T3V?`FH2H6lt?5 z%mXBtmRiaSvJx1Ub2Uc@t6YN+4S#%48uF;tm# zxqugNzclSHxB+~mac(z@q^$35qgH~$caE({`vv~xw6 zi!y{)?ZKv!@*zh+^>spG>|f=NFNWr=&`$bH=KU$tQ+WJvw1*5IUymfp9ODJZPl}lk z3E-#cLsvH_h;qDLa~`Py^}@}{)uOa4pzK7qp!dEBW*z3GV)Ha&bjBMJhyy5E(1oEb>1 z8F;Rp$WKgU*TY`}PLj>EI={T(eQycfMILL2bcL;o#ob^*@>}l>xan>r813V%x4EKW z_j9lZfbv#c(EPI}T{ZSluNgI}{@<_ERO*+pO@t}1x3Lmn%Y2M+jNxKwf5YT_&)}9_ z%r@#!`aCOh%pE^PeyVPEbtSbB@O|I9>9(SZ3!ida7*+&RrCg5k&vhG)dM^mcc^iW+ z4o*fB3D^~T+Z*sKiP-Ktx)CzCzz9mzGsm{r) zbX9-5pl0H{T(KO#EwlH$vJemigoO~<0ZuJ`kD3NBkjF*Sh8jBnZN-^DycG<5-@N&{ z#TL)jZ(!_dj(h<<@{aYd)I^r;|H4nkZUp=>f!a)_lRB#vYi60(Bh-5hNfTBjN-9iq zSr+?&XKv8J;CKlz>Wof^ab!;~kVOC^u(UN0*?)FLA>biZ5UG4@vhS)x&3+ zE1fmow@}I0Og33`j#y1H--38YQtUJ|)mUPeDBY#TGJHQ=mj(KCO~mAO-5X@iBq;}9 zO}nLb4{%p69)_NzTo6T&f8STWOfB40(@fZjqvPi~nU%4PNV#0IJi)*a+P4)%n}Ug# z9R1D7w3)pY^&`%NvW-hOzn>%}M;wcUbH38jIA2({w$?9QO!=D+hSY7CYZhacQSpzl zK5@WiT`3h{O?Edk+9Jvk&0XyE{00UMg)!foo_hMfgzjZ?Qq{QkDV7>K$xkfRt12m- z{?seQ4KkW-{U8jI!;uM;{`!LsjCbINNB6}~+9|+b!5nvUTB=)QMsDu%hTa;m?@1y^ z)Y0MDSkcMIDC?_^P$peE$fcCHxV`dHJj8a5CoyHuA6tLkG`j3BR=tLw`HYsTJwlX} zN{!vnwiQ+0lRFw42xq|?VseO-|}-(XS7KZ*vXH`r-6X%hhpVYJamV>C6b|>?BEF zt&?z(8EeQ$z$i6y7n-l*9f=%$}!(I-G2% z@M^`b6bqg%pte27gG}S&;<9jeK`%f+Ql@x%L=4K&Qf+DJZs>0MIf|OTQ07nl$vmdD z#y|qmwMy_no)oqP>x6_lBv67&F)(gXfv;n2nLkb7_@clkzINUjg*AoZz^6`u$%wnQ z<2?5@jy>CK68X@3iG9t-?L;AC%Wzv-vrFncP}g%a6)P3=f?DSYLcJLTR6pSnb_o0R z%QXWF1{c!LTD`}bod_@a+Snb8PRdK01@aHriN8#Q(xfNykWWg^52kQx3|`9QScCy- zZ3@w!mL}`e=RBbniY4#RIn*sjY13dYwOp%1AjOq)LiWmH*^2G-&@zJF{EVb=9TY!S{eQsn?NT> zVo)Hw2qGo5#)6TB2=fx!3d)H z+B*13)5NgUCwSdPT&<7Cz{`U6CWa95266WEWC~&6{;b~AA9N+#Is@sL!OQVV3$W%Z z>!4@#XMIAnbpktxP&nLoIZdv9H`_K^t7}Np@s0DFb3W8=ckApPaS{DzTKD~)=%Ti_ zJw*sz<|bySuAzaVD3+eK;qb7*pn!Nx$-#(R-EN;;v)h(MXx_xqC8}ErMvo-~pw}3` z7lajw)l$(syA8Az5nYmj6JRZtmKaNJW`ds}nMghIh(tLqb@#(+7xIz6(Simaxg)^- zq=1eHoDgN?JE-@*_O;9~%|tvn;TRn#Uv21n+I5 z%D1nbD>nP|RdlFxiyYCyR1lb`IMT}!dFB^I?Vm66$8&r<{d9-T;g#~8Se5pPeJh_m z+il2E>t{vZIv3nx_39Fbp7HCWK}y-%3xRMX3x>jws9;smp#_5`^_8E&iTJ`b%Y3T z4^8ylHW+KArmorYFZAqlZ$2b#C~jX<(Hl7VEx96gzFK1imMvRmQ+z%%^aN5`)gLpC zwOt$C*2j3rPdwzzDy}~R%VC_%{}f|YLH6P(q%Wx;61Cj*`m~x~P=}GlA8#h1w8;?kb;8Wt#b3GH92ZPvm@4D4-adN!!eJ^*7oa@B;(P+ydM$v z2+q!Si=3k7LZ5++)lz-QT08ueQW0w5FowWPYq%a{7nG73{{-{Loa?Sx`L{nv*~1R_ zY$E31Tq+w?6xLs*QUVnsAOC_grb32&ToI%pShynm1J|a^nQ%&6V#QKal*LAGT(JPW z$=O}^D4(JUxfS7iR?1}qozB@8EHpf)YO%dynTlj7?fEb^BYvX8%y~ls-;!T6au=ksOoWda-6f};j`BM z%}@L)Y2Ib`EZaD*lF;W@QKK!8XLfmX{nhMhtCKc zrl#hdPTukMmVSZZoW~#i`h_sz&&$nQVzF3ZwY+)Lf^DEz;8Bl2qA14v=m4;B@9UrY zib}wqk$Vv$ngrBZ+L|dEZ=Vb0{YY_{&2mnS0 zLY|o|8k9*ODs}$v+zx_LJbj#u@=|bkW_iAlR|c^JvErOMh_V~8kXGm;Beva69$PWkHZ(kAgr)g-W#cFv5z zocx3z+1a@qw@0V&V!OZ*N;94g$+=m|Cj#LiiO^SRANuS^W7oGT3TQ922rE-TZfF`&wU0&ZG)Ko0ypFA~wYS7CwK&EB z$=Jdp$w=B-^iTlHeFO=~mWEz4W_U-Hz1q|GsF_?2uMtOTw7M__-9wT|(X(d}00ZuTJrD-c&b&T08ungU~9|6 zTYp2&7rVh&5<>FO^+@A1n)8YxxXxvY4S%-Zl|5tXl^YXYyG>bF^qnvsf08rU0NBK- zbkAcWuxEejRa!wE`h<18udu*wrkcm~X1ZRMW{4n<1pz*xy1i8XcoWFk+)=}1w!O|- za*}O>Hv6UNeWDJ*vtgwMXY4t_uB)2-U9OgMQtK?cRF?Zx#6oAwj?_OO*SJi$DJKNQ=33r6&a*;**$UWsD#qon_Dlz)MQB>t!u6(} z<|E6nNJn9@n+)$dr1xX;_O++HT% z)Adh%mTH446`D&Y;Veujq?LxsAN~ly?^~Gj=%O-CeiA-c>j?tE7JU;5psW_8b`{A# zC@vlzOR=$6XcC=MV{Wns%U=w7zWaD`nvJQYI@X@|Y7G#FUD-Lw`~INR8175X*|!u( zkga?y2Y6MlF8*}(-NhsK&kMKf2>M3Lec?e!@t18c8kkdFDAq`z-);yAqPK@@DQllA z>gAb9uF~p<4h;z6B9i0Q?Fdh&d7W<452SN%U*9cz{@L9;_K=YM2Lqmr2TaXn1q*t! zQ}<8rf!Y&{EvpY;lppQ;@oba_xe;l=VTswiyN$v1stF~0gW2K_JXGy%H({nj&K`=S z2;Rs;*N-<4K7$Kc03QI<+6Q#5#*;TFwfSO_rd4iw0#K)XH(VSufW`q@;&J%pHsT%;2eOqP6qFRiU$g}{rhU+n>NRSk+Zc}uQ)|)G; ze_d>B{`wq!qtTc#xlRc8vH&36Cdb5#s?iP*fo%MkbmN88zT+-mCBW{Wja}Q%H}I8~ z%b)gnyVL^9Z4{5jVJJ#-JeTbCpGTX*!SXNKnJ6P^;mA!aA@D~DYBkAV`4jWTiQ>he zBl}X{qt*~o@&+aeFc?>_99(sn)t5r9^`G>G@}AZ&v6`DA`_{D>XJpa~xkAzgsBZvV zHf!-C)M|Pu9N4!J(nBQ`&l#im)g>$PK{Ae=?z7W7Vpq~}wyP4E9pAXV@B_!6rXwty zZso0li?HHPN6l$2z74(5me@H5=xL;!pzlTi|7`Pz!%l{-lkMYgKYx9LRm-FoPm&$0 z|AEt*LAoEg|1O<2)oXTDQ11OW%T-jyLmb04iKML)F`6!{XpAf2KoVuPbs=5|l8t4F z9QXm3+)f3XqJe~-d)2|(YhiW3N1Px05b6T|C`rT2H{`6sD>CZrjCtnAa!Ueb)CnF9 zg$ol3Ld-nx#!EH2z@D9ndKjydPw_&gRZWlYyK$KGSBWFRGjJ^NQ?!tr0rOhzyGyJ3 z!*se74IMwdVq-WtEz+dMe1ON`#o@A5!{xV%_+iJhrY4M|bSKAi69j-|ZYL zUr*uRZ1n3dD=rTYi!hUv8nN6W9By*+^)ZR@acQZ)HXvdUkzXvYdpZW-qKj>|tSQLW zlw%!dcZV*0u7*-x*K@~_Arzx`?QbAkx?^~*pls-@{@UxFK-iUTAWf?C6dn@FJI{zP zsM?G21aM=TEH`p9y#*iw>YKA`3J?GI=VEZbtGKogSylk@{PXTZ0q*6bWE>h0D2~5B zi8ha!o{6*ohWij&L;OX1vUblY_(*uoLeyTRtOLMcZIcfd-D2&%ZiW#<{g%FWvatvm zXf>F5_Dsun-Umn;%N#oIFXZN(g07OJLM>jVT8^oyHlEz{b=tgKdM zdS+;L20x1*o-!WM(He5lVusYN^Gh#A+KfChC8c*VIIk9`yq3V0mGK}?!&2H3>nG}O zCr+&GDjIry0015KYVEuuk2K_FI2Q1!{>`oact`ZC*||M_Vr+J3dfaea3;lhh!;;o4 zA>T{pg~m)HTEPb2IWCY!n^$QjzdOBeIhN`U8thd|$2LK@`31fOKDf^-U}AK1fMfcr zE<6vAVclTw+|frDRF(78k2=94xuXv+Xz5nmXxX+YS)24ArmY7GM9&$ExD1D`F6HH> z6HNF4Q^UqeSC(xy5%8Q7xQB!4)&sxyXGvVggGXJ9(Qp0Zepkg*ja+S!&#AvXK{d^( ztsj-mM)mL9LE3BV!JLz?DFB788X#c*zFdzhk55!)>tJLLY{zRNL=7@)a$*9~MnLW~ zg7-(1Ry5)q$rdY=_{2$L3CUJ;ve<(*=ZQOh_P#tpkQUV9@t*b;Sq%VALiW<`^1sSf~k+a z8U|pcgTYnB<$9}B|4wua&I1UFGi)U(*!$?vO|8s-V61`A#mt!}_oF_$ep~y6#zJ?o zj3u+#e^yQaTs&93%Xl_&>naa8A~8^COd_Sna12Pi0@Ue@Jxwr&81!1PPyOq3D&YSq z)n^=B)bShXcdJ&M0)z&nJ8v7<7}PJKG8b#Q@ZG)#&VYj0SUI!rJl!^P@@$>XvBDDc zI*%Hx2&G?YvvL2K;P_G;Ds}_c(#>z!IC(lUtX1JWyr|?cEjy})+@3hp)^T+_4kIu8 zAcE3sOCI~WTRBYw6f}_fcUy4W_*wQTg9?}>`Zi!=`zl!OkMn}2Et+WNW%)tZLE*0V z>cx$@&}t?WT2aI5?_;uq#@SP4!`?QQ&H^hBQTaf2YewzeHH& zd!b!M$t#X%F|I&S`0dN;%IZq8*(ju9`_EUKOY>TCq^^B6UKw1;r=N40wkAj@&_}GB z66Mvvf1zV!J1*!d%xks8u% z-E%I{fpjm1Ft}8Yr3e#1q&IAMf3p?Hjd5{(88p=NkVeYXN)jC!ytfyT+w@9U5GYJf z39L_&)1jjF5W26{$M-WVZx)D3_i{wzO8Am1J-QAOCw9@%F;LdGkZG`#=}^OdK_Rfd z9b!HBf)kwsP-zhmd%x7XuObv*2JyXDdNK>N>UTuedAl4A%`noSuK#-*57n*QuT^0& zw=4JdLMtkrhlfQ+0Htx>6Is}W@XB!`y>uMSeWJN16%b6u<}^&e$_z z!nf oKT^y8A=Uqz*Zq1nDVKyn?__K+&xoS=z=nX7`E;S^xk5 literal 15019 zcmeIZbx_+~*CPN*mz z9=@}+mY%bos*12V9L8z-rw^wa%mFtV4^LFW&B4^%7V6Ak2DP-d7kjx=*Z7jb8Y1>m z7pTgm>L3lZvR3eLf@*rGX_NW00#R**uQ!soHd~T1C9T(H$uzZ0SeH7BH%7g=C}p1VEkt= zj(Pw6M1MNsun|^wvc|27shtem+yw@;cUF`Udx`sp6JiY!<`*>M5fTuBa0r?4m~jX} z_;@)?1$nqREV#I!KyIKAl$Q_k51jvMyr86vAh$HPw3H-|G&i@bl#qZVmz<;&mjF;u zke7#7@Sm}Y_6TQFdvoYNb6ex){`Xj^|8}gfv=h|S8SbP7hui(L4c=M7o#6;8xB~+Z z4<{eP8(nLA2poxE`LjlUlPm*uvUY_+2$WBV&z#@l<-f;6{=YI0fI|xKXQ%v6JLjKQxb67o@jnCs_v1fA z32Kj%A19okWS!<#;^Fc4D9T7`xlL})5V}1bnLpXv%-+sEQ4(f~e!Ge}A$|Gj(>PJk zxTo|c`TOD^5GIHuhValH z|JCqrKgXRhxb_d2Ki~fc)W3N4|H!L<`1Iei{U0#@E!+S92F3N1I`K#OG=>)AYc%bh z>=&Ms78M+5V2$qINRsJIiVl)PbFzJ3JZu=g3~^cmuPiP<Tk&n>~nub$vm;vkF*o_5G;s=$w6I8nb7tRhY zM_OqUX|Cwoe?3Z7_Yz(>Pg%&AdTd)jrKgI=Kt|UbsrWYjLb+gN_VDM!7c8NB7yhL7 zdID*-R~x@PFN{%+bABe9ssn|u{~)Fm-qh4R_N!6tEmiA}`zb}|2pkXSe5GZc?TGOt z1MlLM&aqf!P;=K!Z2>|`EBViB!ZHe4v{BnrP1;*_fZFQ7v?pvtI4L61H!+o z)IANdy>0>CtnFkKJ}m^`MUcdO4SiEzw}Zd)^CZL&YCWTk0!8S9jNb!l-QKI+Eg;5Q zy;bGzdd#mpo06&3HHHqENpK!XBUiDo4JXxH?l04Xr&lP=&g~+!a-IoZj!B)enjA0)e4hnLJzsv-te6chyPL+>`+m z4cp_#t?H@MK4=ulJp{^jp?QP7C=c#sv%Ee(&8kB)`9fD>Wc=>T1#$4^!)*@lya11_ zy6_@(!Dx6>%q_9smCTvJRmp2fU)~+|Y+Mv+G6I>oq*EZ~^5GK}*$)`0Ti57@|bmM`?8$Tx}e>T>SOy3?1s`Z}MW0@i{g z7x2xGdwq>JqE{Mo0JdBF375J%ATX`EMdzR;IR%HecZoy;@BOcBT70Q;A)c$Jy zHa%Rr9^`>(P&`bBW>sit7WeeMd3N5A5Esnk)4hj{QrlMgOi4*GJ2N(6tPRqNauUDU z{L5K~a*|pAH4=$rc3FQU1AU8U7=69)GD+KKC4A+$2ooQp$1XkNEPT~D!_pi$;^)d% zAAXXtql!Fo$ozvskW}8P@K@i~W)hdlzSOA~hf3B0Z|P>_?{d1s@+Uh}yFTDm@}+nZ zx)IhYu-DJep{Kp>E^gX$dLt&mfP;59Hc&9-rwvmJ6=0{aazj;pixGj?WYbJ=(a>5& zqTF0#g*FL!7EpKAnZ2l270|8lMoGvx6Fu}jG#y$ml}zUiuT8jr&jw{B2Wn#FL|pPZ_qX^1(u(HcyG3%Nle(PNhApbIcP z{B@N!+jlyXM(^>+_8_jWF8j@5R%Ny*v)dTwIXlA%D0KJ)0Cd*rPm{ z8bJqEKvdYYR8)j*)4%qz_b&Ir##VEHlk+(3zv??^7y0C~5S=TtCp*7bSwYcWV_#&k z60ILZu>$B>PRodfh~gU>6D{s5&pCgtB2pT9Mo3D0LO$fzN19+)ugy1X{GI2PWW z@~@z8AC0xOdUDw^9Z0A|`TJX5p7nx2$0%BmWi$O--EIPw*FSvFU?7_ff5?pgm9&P? zL;+13k^?P=L?;CI^N_OE?Fk(EAcxQ`@O2g2-#f|mn}lJXBQ^Fr)Q^k3Z~Ux&U!{P? zhF#h4Z;yYg_Q*rS(6YfJBUY@+w$_}!2v<$))ux}kc*^E#Z%fu`@g9-q_(U*xU8H_t zzEaz9>t8Ha(!##=_X~czBnu=tQlYV6#{|kW)LQr`sH-R5{&*{+4G^TIJL+9_`PQ?5 z_?}5HkDJmnmNr)9jYJpd{hpEnL(?j7T(G=qT<*nm!+YX$O1r^X{+>?--ncgFknjIf_)l|`17-|mmPb1C-Hz(~1P@pujoh@=PzUr}vPrIBx4`j=*&dvwU2A89LWAK?Dv$NaB z_O||UX{Y@qiYxn*f2d6gfR`9{q+ZiCsBMdf6@hG!^vs?yurj*OHs_2*w8k_>qS_j> zZ%za8sX4z-0F~F*%;w5Wm#lG2W~pi;rWul58m||3)GGe1cp`HElJ{I7pNGIWeBwC7 zimGu8x>HhkDK+g8{ve$0@#BG+v8DkC;4?@t(cOlu?56Uaq|=ga-_Ffa%fbO2HJ`JT z083z5dHYT9<(N+l$*At5C zr-!F^#lQw)$ab--UoX5*iZBsApM{j;#$-~^7J)0TP(Qygk|I()Af&k~WVuBOzvE^t!TMETA|u_Xx!R}f9(_+B51KFXBE zSXCXjG!5vKhuBHa$7|y_PW=UydvS1+!0T)foiLnJTE6X@WmrLiGjCe*3;K)PPOIj< z@&FLeX~Qct#pXk7SHnp4&FRd4)u zWM&&q`6YP0xZT2*9ly(wfyyn)MeY0*DqqD^nnF1>86IZK7x_9qDCmB6&7Yo?iUeDX;m zLRZIVYkTRH0S|lE$|r4}f5H90jqp4TtnI$cN<4255QeF0w=8MaI0gy#-b zyi@YB$Ihk51iPOL59#2P5&V+M_i7DjWEn*s+D6cmON=)?_f?}o!GLjsnf(4#dXPlW zsMcs4g;w0NF@77DP%6+akjVP}U5(r0ErEChxJ8q4LxR&7bk~-UUMTwwl-m8h&h;v; zgwISGK{cMj1OJ+2RlLOau(===>+bO6$!&w|kIstHW)lU!=4C5>)6rdZ$onCWPKcb4 z2Tr9GS33?%2CC+Nt0?v!oo!F_nJcrbZK#&=B9Xb89pXOM>DwS5PCD^kI*=NvjmVri z%=`+w4%8nRv!$x2#nG+r=wkg|`#ne&0b%WZ8IL5a$r8Bn7?S>)-DHt7C5t zy1*__2H9f1?VwQK`eim8Eq(`ysWhR)ax8${WF-l0aix(VC7P;K{I^ zzI8)^Yn)z+kRemdP+QK9^|>GzdZEXYqEl=;9K2j0t?c=Oehbs0y19R3dvcTPAb4YN zL&f{zbU85K!ey7s-B3tyDy*Kx=EthqBjYRb2lyf395POQx8|BHuYDN-Y2Cu*9M}B- z#pYD|kS-+U{K<3{=FX;=gG#g# zEII(E$-L)oYF=sg4BR&Iw3upKVE-))xtLqE7r02jZed0uxu#R7=7@{UtKQD>E*uXY zf$79*#oO#|yb?|{g>Jk3eaju@-#ncdx>?iaO^a`+Z6kZEoUm;0&fuN58S;T=TwBy& zLX@CY)-CrtdGy9YVvAH`r4UAE+huW4ho7hR{FP2B;T(rj_Vt$I)zoIAC>Q5G8~dyB zTMIjzoQFCoMj=40WE5d|TX%LyeCqWM)H7(XXZu_Ed^B|Vg z{_HFx8Arm7v-71_R=+~Az4ZLWPYm-Y*9AE2&X5Ag^+&I!1oCONc2JJ{s(r+KQ50Mw zJ~oATm537e?G2$83mHY0Lf2BFo$aY+@-_A~IazI%aHv7U2Q_<*AnoYUpPKZxhD(EF z**GyzDp5UGyYCG>@)8P1k4qb3^+}Re8?`beEk)-p5Cp0b8 z&K`_f4ORNyKhbR2A;2jZ>cxrVqiA>CLAD@U!(HQJ)~VTymzmLp=vN;&z-|JHWAB6Z z7w`S1%fOdc-?45U)ho9f4?Q8)Oavp#u)AtxDACWv{O;$RKB&#zPB9fwRQi+JnNv5E zrgxq7i6*|p-I*-)-;pP;>)iNu_bTo0xf_RO=P!0`o5RprbrUsi z`Ipi&ULTF5h0pzvd+>>@ZjkTGZBNTz%w#)|3}8$hh+fFSSql-z%2uS-5FbSaW}x{_ zRL05{w0=F!m5ibBk~X@Mo_^_hN5**%;fS;wEl#O)cx$1tw-=h{gnX-tNu%QVK&ZCq ze6s)D^|r=0dw0Zdv-uxNfFb)!j>0r+*>N-DdH!i^x${3uYP;cFFz5_ zQ}7AL^~dDW>V-AyxCcC(02vAa~jKMgSK=ige{`53qbqpVuLw_@PagjYQ)kivn;9BJurCSy{x*<_2sc6 zzwz09Lxr;QhERi<&sU!b`8&YlNeDCvBky)!&vHnF4fleteBbt?8408LsdA}1v&XIR zi@bN45`a#XzPM$QCfGeq^5pdLkRhUA??s;QS5pi)pkanrQbf&3EPZ*vSNHN%!M<;V&Q7ZSi}*&{&8FBkPamZI<@HUotT&? z;MBkB|9;4xvcFJvzf`HJP~35MrIjK?!}(0%uidlu?H|=swL~bFG6J>4+OMcC|4WLH z`RJ#Hr$4H-=T*6jH%O2q7@vfY#pbFVZ2$Cw;aKZmWjv9`(KWRGv2g~qo$KSX%8iAh zI`IZfj`uM|Yr~bqb5AH1DpuFtKZX|z*W_-yIUb52VX?(0)`M5W5x2Zr@bN8Yry_$- z&k~l3*)OwdGTxKM_d7O4waj3$Kudz23@KivZqlz^ab~NK_}Dm*vVvhfUr0+EbaB;n z6^K%`QLDTfEwq#oA>FNkuDw}X+SuURxb}uz#H|<#y*0^@YlLY}7mYlFdpPxv>vKPb zixOR>ilouSIW1o-htZ;k*4cI6^ytBaf*ER#m~cNMI9GY_<&@xR?Me>&Tu!aAs|`~) z{Ou&p-o7c~a4=(_Y2vs6`UJL>xjo!m^V70#=ZymYIHUEX@XR_iP;FBUblC;@JhqfP zGmNYkJ-_m-aw1^C#~qYc#cI)l?TcBw3G`wOnEYIA<~z-!bv|vK)8&Jn;A9A!>797$ zZCWoo^Pn#Q4+WyGhD~nSS;7zc2{k=PNvtR4n^{_LDr&`MbA_{fMlexe_l(Zsf#6KgU(HkKwpgPECCsnRqlhOBKk5HbB}8+u4aXseG7KfwYSnrct+~e0v9XW=wi4TqiK* z+#J}vQ}ftMLQ;Ddhf%pg)%ZU9pV*6^j3DHaDGT`umXGR2B~ErG{z?aFboF_fjOW29 z_YXZM(Kuy#0lvzSwV3Ct$VPuYQ!+%+X0JqaPsF1oMOsE#Et#588ZXI4;>vO*y-its zw>Og_r`V1ZRvR6qVIzLzc%*^7JS~Ar{7S0NMY0W@0C3(oBnS1Bt=sBRu-Nfld1KBF z_I|hc?r1B&hu#|BPvkNzvbNE~d#DoLOI0VHo^su%_FmJtasE4p3%MM&;F&0o)O;w$ zcM9+v=zXK5t#xyZPu;Ej%DC%*#F-xDiDY~3Lga22A8q<0igVFxf1K1@g{pe4MRU)R zM>hD3(DOKr&LZz3&-8XRc3dHS3bIUXgma4~l945;d%xxkaW~)ks94qh++6BZ1Vpvq zyp=%7JUgho>I$~p6VG4_P}v$>4r8ICrHQK-mz_86kAi4(zz0bytCTh z;2>;44A--X5*A|)Ckdb)UU+?a(it3402-ety;Vu9wwf?q<~9A1IY6k6+BW+U65jFG zlOpj!j7DC>e)M#|HH`hkm2hqS;Zf)}UigjTSnkbP3nS0i?%~{`IdzEm{cNec_}Y@R z=*XC*3VN{`)m}Et%E{v8by=q8+u7?PUrTv|Cc$hh=Nw1O>jD6HYGRssFp25JsVyA~ z2%^}SWNsap>1{s7T`CT74Sy}ySFAbfhE=YRW+zEQht*uw(TPlsprFy}(cLtk^zDYn z1d5~^%TocQZ;S&kB&uw}0>gt__b)2j?~61h1Bb1s8okXMiNV7-89E|-a@vig-vl0u z^xtf(Aj6-nDBGO9=k?TUx>p-Y{ArVl!C>>W!LLk&C)7Bh2b^qU_jJv4YGQ&obzjD4506>vG&;Tu=z5x^+mS{Qeny8c&0!}2gy7jyQT4d{BAgKMWsr!@f)}l` zgXEgGo5dE-YHerU7OnED8Pg0-nw+AFy&WMk<%dHpgH@kN>V#k>d7RZ~0 zt^?H7f9}fStO{cf*NDM;1z7G0>+3miROwJqrd<=Gg{*$lSEDN}-2lI*h~HI2F`@u+9TCb$Sj`h>3t9|gm9>io{_2CF8*31m6V|I#-LF7=56qVdU2M2m6Q6Wl6VbU z*3S4n#Oyu|&DOF6{~^vnw0L7vF%(lAdqAx#Rwa$tYO**ft`qc<8&l&RtItQ6NY|H0 zEy3UTYs_tWL&Zgy$p~XI(1DFnNpX_`KYJv`XNr9T!yA*d*=AJ~Reu_u?Yf%R54>^m z%Ci={^2{a%FOts>OEz0+Qg-^YFbAvD@!~w(jvYe;;ZNK#GOGngbkCet<6f~n{}`3y zt;f62m$m5gj=lgIIyd9XV)iUTLa+9$VXPfoq3HwJSOS2ip}Rqtvmx|rqa#YiyKrpX zdqc~QbC}1yP)hSp9R+r?=2BV7Ut70p>_|lxzSDmGc8h&=vI_r}-5c-rz#tH+h_zU( zQGMGmNS|f?pyiyldC*W^>73HFB98Me`V?K`z55KaL z3+p}Rh<7wQpSkk$=$gn*_31T-+bAYkQ9B=1P~l=J<&sa8(v{QMI0`#e-b^-}heUt> zTF||L^)?yWO)w5r4Sx`F_%3hDZ?RXAW9DMR-+bx`$7Xeu7x&551%H=BQBN9YO6*!J zVg)omw(94-@?-K2LXTy|6$%`--J+GDtK4}w2fd5G#{KRx_1s^Rav#hTxvv!jj;O=2 zRqp<83Gai+hOWWdi4!ubiFxWqLC52_wUeD{n+#@09d-)3%c@j-HA4|B#+l6D`{lz| zx07BjJdwlMka@|8j`Ye_KYXbd7Dz3l7j?(RE-8QLnB6LTcw0}Qe|dE4M}XVh!g`*L z5a|Bz{C(kWk=10uh|{$vBC3NYS3^sh?)zTv10D7XySmwd>-`S~*IZQBKHp8rkj>^f z*!XRF7yo|P!$#>ZZlib9hbbVR$V8SFzm+1&2Zs47kFJJ4-D20fS=-Amt(ENyv)leC zE?HD1CbAym2lgu}iQb3G0)<$zq~6_6sT2XzQ9pcrbeY??dQS+yS|5IuIvKS;GesDT zfYRPYf6LT4)tjA@8_UI>ZVeop=I~i4;6@JCtaNlli zek~>1T(_9CtmN=*<#@Gi5_{8{|Q>~tMjk!xy>ya0C zCDYtkAkE1ci&923rs5 zzKb{H?7NHkG&`&DT1Z_q$yR*h4M)Q}rSB#7vvz&xvF~Z&s}vf>`nouK0X0Jf^g#PH z-LJo$GIj35Dvw7LcIoPV_6^(>oG6z0DXO3acaZ{-dFNC;9pUgN*KAo13eR>n)MZWH ziUkHJBsj@9Tr0He7H`gR4R}zgE{xKfrzISM8a$H#dCd!~c<)k? z=xsQkim^WGAluSnbZ2gXhKkD7vAKW1wF! ziI`%-%bdin0GvHneR$P5mUw-YpDbpuKWZnPa(p-&oj%ms5w1M9%3x@doV-2axS3pc!2?HKwNsNj8`S6k@c^CjlhT2Z9vEjwGwt!+l@3_wru zGTw_XAgoq|abjWw>iFGxf-xn@h=tfAg&3m*W~Qus)?b_-Y+2h*oJB;a`91OPl*lLT z++stMkGEHWKGY*q+qlu7>_L+1@ak(1PP&)u%fUHX=7LwmfCq3@Q7TjL%nDwd-fm3(Xmo?W0Wp}$hZ;=T%ne~-A*g3xyE(oQvq9pHi` z#lnY!YnVLvbdB0n|2|Pj#bAKB^O430o%NwR<9SFdpO}`uX@y#jCH-4l!Q9p~b?Xc< zlYV@AW{B{RXr&nUn%(RtedCPtyJrM-qhmI_kAvn(p)}LZc`=POO8YH#Lp$q8NWr5V z|GoQ8TfD4BN}YqZQ-6G<2|1w%eE+$3l$0egu{Fmi z^p<&Zv8s3+^HNOCk9*;UX_R|g)EA+HVU?rG67go{%+|z(-8oJZ`~6BD-chUCRxue9 zs`l{W$2+msz|cbMD9*F5RHO3I_0bQMbrX&Fm`L}KK+0^|>%Ei(#{-TBOFVH}ocD@k728xR!1RaPGGU64ZGp(bnbQ zG&tt0=nQ;=y!QoVk3Gw=18q&y`RGWla;c11Jbo22y`?ui*MEhEx`=pbMB?#h{_2*c zye~VLW4J2Bu66nfPA*G&Pf|E-CDIdsfZ(oPZz6n#0&=Y*8k?p;)7~ zF>mi`F0ADKqNFtBy#a}H&}+Fa+FK8QjAe`oz|QAeajrlC+q|Et*F9A1Lkz4+Hn`YL zY!4|~R~xjl&BR0Rn-n-fBDcE9O7|m6Ry4~B4`+pde2UOuS}r;w_xJ3smQGz~UI)c1 z#q_kmO%8{0LnzZc%aVmp%U+#FkZxZ2*PtWY2u;2L9tti~oE}0k>f`k5mn|+`V)}fn z=)(;`iJ$$qobX^w6s7T!6WO~0+BSJ8z%9nY472}ukMhJ0hQ=4J8`QZ|a?9&%ut=G? zw5QA-i*aFKO#ehe8W8EDIJi9g{+N)qNV+R3vSNg!CXP+75zV{@3s&>Kv}U_K&L!?) zXQ5e!hH>DpxET^gBc@EbfJm z8s|I!V-(V3)6{I(>7q2!wGOFXiRI25Sx%3Qm21=T@k%*Q z7qR6$y@=FD6F8fq)TA*w<$6}kjU~?kiNSdMqUnJpsF}8B%h#t(gB*kcAfBxQ{R4X1 zE`CC3*N-R49;2qGi`%`k*_(I5lcto*LmrX`jxv2$BguWApJEAI@scWxQh*J|W#Db$%~0QFkF&dm%U>G_D5(F6aWU-Wx1gtx#`{PA5Fad1=Dp zXH*4Wm~{I}ZW<%3m$!WV#kY@wg>pBSCB)rEG(A-`I#bO>WL!xea=4zqbMlUfb+OT7 zK7QpIdY^)Wf>)47aFUTX?DOP3lML5SN2>Rk5ybnT2;U5288Yk(%{t*2x%L{0xIaT`U*o)HlKKm%Wx%#9!Kb3s2`lI;ks{gt*}j-W_uO=c zfoJ23MxNej>!&e_qMSC!jEL1oih|++BhlE3^|KUuv17wB;U>C9g&b!Ln7ql$37R)!qBZr#pV>iq)+f6JZ?5njR7%b-B^HjN97D9N zUrjZ}d05ZkqG@;KJ>xSYA7srhuMl*o+_Tp$2*BeHK?L$NcwT&HZ5AaWX*oXvcN`A( z-k1@{P9Oey>u$5Oxm9vHqR4M{l5;nQl$nX9%TkO=ad5A>^&pa013pTwiyv!dm(|jNf-jkfb#SM_<~h84U!zBo3AeOL`;iE9}mX^-OKZZToXM zX@7|zMYYZ5zH-4|_=@?`hR*ICm4h#@tFz!LNZaC}$4`C`%yg+QD?E??+0`>OFxwQc z{PC9dGXbxgIiIy9d9_fV<&6Y7T4GcL$<6|1v(EkTkieeT@iL10eLT${_Q^52M03CJ z1)tgb96mQ!&4QZeB-d7tiBQ97`S|n2il5#dk6;b5bumb>;*QBk2`0=)YxxmYs4QN+ z_3>~&CBt`C4-tHe-itge{~(R_u=yDx%gDX5mItZ7mD9H!aeDaDfJGwD>0o_fu)D50 zkKPkLY77r~dY(s67=ZRY8lS4gRGh`SpOD1y2n9kj=q(gnMo3(MRF)!N&|SE!oHl7F zX@+@ov)9$&HR&TzdP=6aMX_sXz=9$8Nu+>DcE@C zwp4i;C+--w&9!Cc$aQsncHabN?az0!SLcR8xF>N5MgR~$bauXL z-1~DNKNBPs-tM44OL$70GMUx48&`$Fq~e=v7kBK?2;Wf?#)wJhj3|Re+1m@oKJ|;Yyp($BjdnZq$K$6G2G=^H`6X=-IM#JFitq9Me6Gj?>CvqJS`wlSATGvSP+`tn-!D z{cn$sDpe$<1m|=CT6+Y30;@CB^(?Wm#V@$f!u+EW zxx=pba>z&GBmk>2ji5o!l@-gFXBOJAi#j9P*1#j(ZO($^EgBk_*d>j(?~K=NV|-~b zDd96*{y_icoe~vXPFmK}4T**Ybv9DO2~j(PvnkfYVMdd_&wippTtGc1Ub30FSz+YK zAaX%IM_)DD=}e(%rP$8!vg;`|^#%ny=PM+n3U5wYxsr~|lu{3rm^l$!e>)lHjtyS^ z_?<_v=(BN~rL%d+ z_(PbO8!ngpZ8bQT5*5Ak*>Fo~wor7#_2jeurSmLi!HTZspVBwecdqe#hH7>|E@&pR7{%^H@zj&f}`81EuM6?TFLLQXYvx)orgFtGS1gzCH%ZWH+=+kvEPKG*9XVz z+DAUXc@;;!TushCy3{*D0!jg~7_OZh=|*rl&kUu3H0HP}O-{jhpGpQ|7{_56}F8Zb}P;29;21VzuN?97|uzn~LdD?7TtWVy%b7YNMu9=*l z%Qo%m;_^F?5#mg1J5P+|sN&a0`?>jJh=ljyMFQC&CCVI57^9No;o+^h+2EHpE1?mo z-@?jeNHP+dCh`4Z^|-rARCut_w@~xN8r6|J5`4bYl94r0u~oKr-=sxZGz#f#IR8~K zC9xtpuvinZa(`Qd-)!^>|FPPV7sd;2pMUC-IUwMghH?A4fdxs@xk#ThZw3MBX~Jd_ zeg&1;;UY|co%ZVnVf%J(??AQHY}ZnOStQWL#WL&_{B&N%!ia?f%da-zYAJ!)x!|sH zO)34FW{Cj3geT&|<zL%-B)G%3_fkwxt&ND$oX4y4J1n{NQqfeKr&BVY7^MUyGbgFa55W zKhp*<*LfyzudbX4t;r1V95_?5RRZ=GsD7=r>RY0(%H!MQGx0hU+a5G@;XYU`~LOH zIi(B7knV^&n3V+6htRg(S&Os21N`R2r1O)|y3w`{koV-4ypGzI7|-Q-@XqzwB?>gt z9b}v4hp%I$-uEfBp+VCA@7$>(x-eV<98Pi@15|8q=}$H;i3BiNeVC#oR8dm$3LbO|9F>U$lC* zTd|A8t+>O4tT?hTVdyu+hTfZ}5_&N&U;u)anwJ zI+VDSI|^Ku*0xBnfKJR<=dSUXhl$i!ZWIr(Z|Yxpw{Y3NuU5h#4XziHn~)5NWDNs{ zqrXTW@N^Zhwf5l!ImM?v$7R2DM@DJXUXFr8gm1p~qr^&&_O);FDh&`e;itN3(>;fu zaK$i&G%xPr9I{JM%vF}Jo>DHHz>Qqyg#nLXM&zDXZ3SH$uEn3tfww-`6=rxd4?HOC zRO6gD==KkaG$5mA)+MV*pG8QZULADDxf%nm3;52~pjYj(pd&DlBosc25eHzB$?xE@ z5}B0i^xm}Yo@MCEPQ-W^N0rs#ZqZt3V}5q&T-8nTH7*-KI0eLa0Z8lG+xoqZOHK*j zz1~c~4$Twk1MnD_3Ff)P8chTUQi0i&K&wW#*DjLOhhpXW4>YvHGbj`Q_UzGX$Z&AAPpX!+YcgHFb@9&bT z|GBK{pZcEvRGsyItI+y~vj0?_^}h<#hpcndZDKt2V_V62?Ep#~VR(wNYBEJqCLjMV Dg+or- From 531ae46b2da13d629cf51c4ed1258889078ab27b Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Sat, 22 May 2021 05:54:24 +0200 Subject: [PATCH 40/45] Overlay color for posts --- docs/_config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_config.yml b/docs/_config.yml index bef5c62..1b67459 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -252,7 +252,7 @@ defaults: related: true classes: wide header: - image: /assets/images/banner.png + overlay_color: "#5c2d91" # _pages - scope: path: "_pages" From 84cf891b0bf605eb5a79ad322e10cb2ae819b431 Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Sat, 22 May 2021 06:08:43 +0200 Subject: [PATCH 41/45] Add default pages --- docs/_data/navigation.yml | 4 ++-- docs/_pages/404.md | 8 ++++++++ docs/_pages/category-archive.md | 7 +++++++ docs/_pages/news.md | 6 ++++++ docs/_pages/posts.md | 3 ++- docs/_pages/tag-archive.md | 7 +++++++ docs/_posts/2021-05-22-hello-proffer.md | 1 + 7 files changed, 33 insertions(+), 3 deletions(-) create mode 100644 docs/_pages/404.md create mode 100644 docs/_pages/category-archive.md create mode 100644 docs/_pages/news.md create mode 100644 docs/_pages/tag-archive.md diff --git a/docs/_data/navigation.yml b/docs/_data/navigation.yml index 1b9003b..b196977 100644 --- a/docs/_data/navigation.yml +++ b/docs/_data/navigation.yml @@ -3,8 +3,8 @@ main: url: /docs/getting-started - title: "About" url: /docs/about - - title: "Posts" - url: /posts + - title: "News" + url: /categories/news - title: "Use cases" url: /use-cases - title: "API documentation" diff --git a/docs/_pages/404.md b/docs/_pages/404.md new file mode 100644 index 0000000..76736f1 --- /dev/null +++ b/docs/_pages/404.md @@ -0,0 +1,8 @@ +--- +title: "Page Not Found" +excerpt: "Page not found. Your pixels are in another canvas." +sitemap: false +permalink: /404.html +--- + +Sorry, but the page you were trying to view does not exist. \ No newline at end of file diff --git a/docs/_pages/category-archive.md b/docs/_pages/category-archive.md new file mode 100644 index 0000000..142ae23 --- /dev/null +++ b/docs/_pages/category-archive.md @@ -0,0 +1,7 @@ +--- +title: "Posts by Category" +permalink: /categories +layout: categories +author_profile: false +classes: wide +--- \ No newline at end of file diff --git a/docs/_pages/news.md b/docs/_pages/news.md new file mode 100644 index 0000000..94b2d34 --- /dev/null +++ b/docs/_pages/news.md @@ -0,0 +1,6 @@ +--- +title: News +layout: category +permalink: /categories/news +taxonomy: News +--- diff --git a/docs/_pages/posts.md b/docs/_pages/posts.md index 5256b28..0a0dab1 100644 --- a/docs/_pages/posts.md +++ b/docs/_pages/posts.md @@ -1,6 +1,7 @@ --- title: "Posts" -permalink: /posts/ +permalink: /posts layout: posts author_profile: false +classes: wide --- \ No newline at end of file diff --git a/docs/_pages/tag-archive.md b/docs/_pages/tag-archive.md new file mode 100644 index 0000000..15d520e --- /dev/null +++ b/docs/_pages/tag-archive.md @@ -0,0 +1,7 @@ +--- +title: "Posts by Tag" +permalink: /tags +layout: tags +author_profile: false +classes: wide +--- \ No newline at end of file diff --git a/docs/_posts/2021-05-22-hello-proffer.md b/docs/_posts/2021-05-22-hello-proffer.md index 4a6f946..fb1ba0c 100644 --- a/docs/_posts/2021-05-22-hello-proffer.md +++ b/docs/_posts/2021-05-22-hello-proffer.md @@ -1,5 +1,6 @@ --- title: "Hello Proffer!" +excerpt: "A fresh new start for GeekLearning libraries" date: 2021-05-22 categories: - News From 851db8a008f813c6b6e60262c6cbdd8bdb270632 Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Sat, 22 May 2021 06:34:13 +0200 Subject: [PATCH 42/45] Try with md extension --- docs/_config.yml | 16 +++-- docs/_docs/03-core.md | 3 +- docs/_docs/04-core.azure.md | 3 +- docs/{api/index.md => _pages/api.md} | 9 ++- docs/_pages/category-archive.md | 2 +- docs/_pages/tag-archive.md | 2 +- docs/api/core/azure/index.md | 2 +- docs/api/core/index.md | 12 ++-- .../proffer.configuration.iprovideroptions.md | 2 +- .../core/proffer.configuration.optionerror.md | 4 +- .../proffer.configuration.provideroptions.md | 4 +- .../core/proffer.equalitycomparerbase-1.md | 2 +- docs/api/email/in-memory/index.md | 12 ++-- ...email.inmemory.iinmemoryemailrepository.md | 2 +- .../proffer.email.inmemory.inmemoryemail.md | 2 +- ...er.email.inmemory.inmemoryemailprovider.md | 6 +- ...mail.inmemory.inmemoryemailprovidertype.md | 8 +-- ....email.inmemory.inmemoryemailrepository.md | 6 +- ...nmemoryemailservicecollectionextensions.md | 2 +- docs/api/email/index.md | 36 +++++----- docs/api/email/proffer.email.emailoptions.md | 8 +-- .../proffer.email.emailprovideroptions.md | 6 +- ....email.emailservicecollectionextensions.md | 2 +- .../email/proffer.email.emailtemplatetype.md | 2 +- .../api/email/proffer.email.iemailprovider.md | 8 +-- .../proffer.email.iemailprovideroptions.md | 2 +- .../email/proffer.email.iemailprovidertype.md | 4 +- docs/api/email/proffer.email.iemailsender.md | 64 ++++++++--------- .../proffer.email.internal.emailaddress.md | 8 +-- ...l.internal.emailaddressequalitycomparer.md | 6 +- ...rnal.emailaddressstrictequalitycomparer.md | 6 +- .../proffer.email.internal.emailattachment.md | 10 +-- ...nternal.emailattachmentequalitycomparer.md | 6 +- .../proffer.email.internal.emailsender.md | 72 +++++++++---------- .../proffer.email.mockupexceptionsoptions.md | 2 +- docs/api/email/proffer.email.mockupoptions.md | 4 +- docs/api/email/sendgrid/index.md | 6 +- ...er.email.sendgrid.sendgridemailprovider.md | 4 +- ...mail.sendgrid.sendgridemailprovidertype.md | 4 +- ...offer.email.servicecollectionextensions.md | 2 +- docs/api/email/smtp/index.md | 6 +- .../proffer.email.smtp.smtpemailprovider.md | 4 +- ...roffer.email.smtp.smtpemailprovidertype.md | 6 +- ...il.smtpemailservicecollectionextensions.md | 2 +- docs/api/storage/azure/blobs/index.md | 22 +++--- ...e.azure.blobs.azureblobsstorageprovider.md | 8 +-- ...fer.storage.azure.blobs.azureblobsstore.md | 8 +-- ...s.configuration.azureblobsparsedoptions.md | 8 +-- ...configuration.azureblobsprovideroptions.md | 4 +- ...figuration.azureblobsscopedstoreoptions.md | 4 +- ...bs.configuration.azureblobsstoreoptions.md | 4 +- ...blobs.internal.azureblobsfileproperties.md | 6 +- ....blobs.internal.azureblobsfilereference.md | 6 +- ...internal.azureblobslistdirectorywrapper.md | 8 +-- ...lobs.internal.azureblobslistfilewrapper.md | 10 +-- ...blobsstorageservicecollectionextensions.md | 2 +- docs/api/storage/filesystem/index.md | 26 +++---- ...m.configuration.filesystemparsedoptions.md | 8 +-- ...configuration.filesystemprovideroptions.md | 4 +- ...figuration.filesystemscopedstoreoptions.md | 4 +- ...em.configuration.filesystemstoreoptions.md | 4 +- ...ge.filesystem.filesystemstorageprovider.md | 12 ++-- ...ffer.storage.filesystem.filesystemstore.md | 12 ++-- ....filesystem.iextendedpropertiesprovider.md | 2 +- ...esystem.internal.fileextendedproperties.md | 4 +- ...ystem.internal.filesystemfileproperties.md | 6 +- ...system.internal.filesystemfilereference.md | 12 ++-- ...r.storage.filesystem.ipublicurlprovider.md | 2 +- ...filesystem.noextendedpropertiesprovider.md | 8 +-- ...ystemstorageservicecollectionextensions.md | 2 +- .../filesystem/properties/json/index.md | 6 +- ...es.json.filesystempropertiesjsonoptions.md | 4 +- ...son.internal.extendedpropertiesprovider.md | 4 +- ...opertiesjsonservicecollectionextensions.md | 2 +- docs/api/storage/filesystem/server/index.md | 8 +-- ...erver.filesystemstorageservermiddleware.md | 4 +- ...m.server.filesystemstorageserveroptions.md | 4 +- ...ystem.server.internal.publicurlprovider.md | 4 +- ...fer.storage.servicecollectionextensions.md | 4 +- docs/api/storage/index.md | 66 ++++++++--------- ...offer.storage.configuration.accesslevel.md | 2 +- ...e.configuration.configurationextensions.md | 12 ++-- ....storage.configuration.iparsedoptions-3.md | 2 +- ...orage.configuration.iscopedstoreoptions.md | 4 +- ...fer.storage.configuration.istoreoptions.md | 6 +- ...torage.configuration.scopedstoreoptions.md | 8 +-- ...er.storage.configuration.storageoptions.md | 8 +-- ...ffer.storage.configuration.storeoptions.md | 10 +-- ...age.exceptions.badproviderconfiguration.md | 4 +- ....exceptions.badscopedstoreconfiguration.md | 4 +- ...torage.exceptions.badstoreconfiguration.md | 6 +- ...e.exceptions.filealreadyexistsexception.md | 4 +- ...ge.exceptions.providernotfoundexception.md | 4 +- ...orage.exceptions.storenotfoundexception.md | 4 +- .../storage/proffer.storage.ifilereference.md | 6 +- ...age.internal.configureprovideroptions-4.md | 10 +-- ...er.storage.internal.genericstoreproxy-1.md | 36 +++++----- ...r.storage.internal.privatefilereference.md | 6 +- ...proffer.storage.internal.storagefactory.md | 62 ++++++++-------- ....storage.internal.storageproviderbase-4.md | 22 +++--- .../proffer.storage.isharedaccesspolicy.md | 2 +- .../proffer.storage.istoragefactory.md | 56 +++++++-------- .../proffer.storage.istorageprovider.md | 14 ++-- docs/api/storage/proffer.storage.istore-1.md | 4 +- docs/api/storage/proffer.storage.istore.md | 28 ++++---- .../proffer.storage.istoreextensions.md | 30 ++++---- .../proffer.storage.overwritepolicy.md | 2 +- ...proffer.storage.sharedaccesspermissions.md | 2 +- .../proffer.storage.sharedaccesspolicy.md | 6 +- ...rage.storageservicecollectionextensions.md | 2 +- docs/api/storage/proffer.storage.storebase.md | 8 +-- docs/api/templating/handlebars/index.md | 6 +- ...emplating.handlebars.handlebarstemplate.md | 6 +- ...g.handlebars.handlebarstemplateprovider.md | 4 +- ...g.handlebarsservicecollectionextensions.md | 2 +- docs/api/templating/index.md | 26 +++---- docs/api/templating/mustache/index.md | 6 +- ...er.templating.mustache.mustachetemplate.md | 4 +- ...ating.mustache.mustachetemplateprovider.md | 4 +- ...ing.mustacheservicecollectionextensions.md | 2 +- ...ng.exceptions.providernotfoundexception.md | 4 +- ...ng.exceptions.templatenotfoundexception.md | 4 +- ...ffer.templating.internal.templateloader.md | 6 +- ...mplating.internal.templateloaderfactory.md | 12 ++-- ...ffer.templating.invalidcontextexception.md | 4 +- .../proffer.templating.itemplate.md | 4 +- ...offer.templating.itemplateloaderfactory.md | 6 +- .../proffer.templating.itemplateprovider.md | 2 +- ...offer.templating.itemplateproviderscope.md | 2 +- ...fer.templating.templatecollectionbase-1.md | 8 +-- ...offer.templating.templatecollectionbase.md | 8 +-- ...g.templatingservicecollectionextensions.md | 2 +- src/Directory.Build.targets | 2 +- 133 files changed, 593 insertions(+), 586 deletions(-) rename docs/{api/index.md => _pages/api.md} (86%) diff --git a/docs/_config.yml b/docs/_config.yml index 1b67459..f2f5204 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -16,15 +16,14 @@ main_color: "#5c2d91" locale: "en-US" title: "Proffer" title_separator: "-" -subtitle: # site tagline that appears below site title in masthead +subtitle: "Version 0.1.0" name: &name "Adrien Siffermann" description: &description ".NET Core basic abstractions to configuration-driven providers" url: https://getproffer.net repository: asiffermann/proffer teaser: /assets/images/banner.png logo: /assets/images/logo.png -masthead_title: # overrides the website title displayed in the masthead, use " " for no title -# breadcrumbs : false # true, false (default) +breadcrumbs: true words_per_minute: 200 comments: provider: # false (default), "disqus", "discourse", "facebook", "staticman", "staticman_v2", "utterances", "custom" @@ -49,7 +48,7 @@ reCaptcha: atom_feed: path: # blank (default) uses feed.xml hide: # true, false (default) -search: # true, false (default) +search: true # true, false (default) search_full_content: # true, false (default) search_provider: # lunr (default), algolia, google algolia: @@ -198,10 +197,10 @@ whitelist: # - /my-awesome-category/index.html ~> path: / category_archive: type: liquid - path: /categories/ + path: /categories tag_archive: type: liquid - path: /tags/ + path: /tags # https://github.com/jekyll/jekyll-archives # jekyll-archives: # enabled: @@ -229,7 +228,7 @@ titles_from_headings: collections: docs: output: true - permalink: /:collection/:path/ + permalink: /:collection/:path # Defaults defaults: @@ -250,6 +249,7 @@ defaults: comments: # true share: true related: true + show_date: true classes: wide header: overlay_color: "#5c2d91" @@ -279,5 +279,7 @@ defaults: author_profile: false share: false comments: false + classes: wide + excerpt_separator: sidebar: nav: "docs" diff --git a/docs/_docs/03-core.md b/docs/_docs/03-core.md index c962f7e..4295975 100644 --- a/docs/_docs/03-core.md +++ b/docs/_docs/03-core.md @@ -1,7 +1,6 @@ --- title: "Core libraries" -permalink: /docs/core/ -excerpt_separator: +permalink: /docs/core --- Those libraries provide common abstractions for any Proffer project or provider. diff --git a/docs/_docs/04-core.azure.md b/docs/_docs/04-core.azure.md index 7bd0cf1..3e2b3bc 100644 --- a/docs/_docs/04-core.azure.md +++ b/docs/_docs/04-core.azure.md @@ -1,7 +1,6 @@ --- title: "Core Azure library" -permalink: /docs/core/azure/ -excerpt_separator: +permalink: /docs/core/azure --- This library provides common abstractions for any Proffer provider connected to Azure Storage (like [Proffer.Storage.Azure.Blobs](/docs/storage/azure/blobs) or Proffer.Events.Azure.Queues). diff --git a/docs/api/index.md b/docs/_pages/api.md similarity index 86% rename from docs/api/index.md rename to docs/_pages/api.md index 529a3ef..c967928 100644 --- a/docs/api/index.md +++ b/docs/_pages/api.md @@ -1,4 +1,11 @@ -# API documentation +--- +title: "API documentation" +permalink: /api +layout: single +author_profile: false +toc: true +toc_sticky: true +--- ## Core libraries diff --git a/docs/_pages/category-archive.md b/docs/_pages/category-archive.md index 142ae23..d960f0f 100644 --- a/docs/_pages/category-archive.md +++ b/docs/_pages/category-archive.md @@ -1,6 +1,6 @@ --- title: "Posts by Category" -permalink: /categories +permalink: /categories/ layout: categories author_profile: false classes: wide diff --git a/docs/_pages/tag-archive.md b/docs/_pages/tag-archive.md index 15d520e..043f387 100644 --- a/docs/_pages/tag-archive.md +++ b/docs/_pages/tag-archive.md @@ -1,6 +1,6 @@ --- title: "Posts by Tag" -permalink: /tags +permalink: /tags/ layout: tags author_profile: false classes: wide diff --git a/docs/api/core/azure/index.md b/docs/api/core/azure/index.md index 7d21032..b44ef9d 100644 --- a/docs/api/core/azure/index.md +++ b/docs/api/core/azure/index.md @@ -2,4 +2,4 @@ ## Proffer.Azure.Configuration -[IAzureStorageOptions](./proffer.azure.configuration.iazurestorageoptions) +[IAzureStorageOptions](./proffer.azure.configuration.iazurestorageoptions.md) diff --git a/docs/api/core/index.md b/docs/api/core/index.md index d464005..66d0662 100644 --- a/docs/api/core/index.md +++ b/docs/api/core/index.md @@ -2,16 +2,16 @@ ## Proffer -[EqualityComparerBase<T>](./proffer.equalitycomparerbase-1) +[EqualityComparerBase<T>](./proffer.equalitycomparerbase-1.md) ## Proffer.Configuration -[INamedElementOptions](./proffer.configuration.inamedelementoptions) +[INamedElementOptions](./proffer.configuration.inamedelementoptions.md) -[IOptionError](./proffer.configuration.ioptionerror) +[IOptionError](./proffer.configuration.ioptionerror.md) -[IProviderOptions](./proffer.configuration.iprovideroptions) +[IProviderOptions](./proffer.configuration.iprovideroptions.md) -[OptionError](./proffer.configuration.optionerror) +[OptionError](./proffer.configuration.optionerror.md) -[ProviderOptions](./proffer.configuration.provideroptions) +[ProviderOptions](./proffer.configuration.provideroptions.md) diff --git a/docs/api/core/proffer.configuration.iprovideroptions.md b/docs/api/core/proffer.configuration.iprovideroptions.md index 0d80f25..f87353d 100644 --- a/docs/api/core/proffer.configuration.iprovideroptions.md +++ b/docs/api/core/proffer.configuration.iprovideroptions.md @@ -8,7 +8,7 @@ Options of a provider. public interface IProviderOptions : INamedElementOptions ``` -Implements [INamedElementOptions](./proffer.configuration.inamedelementoptions) +Implements [INamedElementOptions](./proffer.configuration.inamedelementoptions.md) ## Properties diff --git a/docs/api/core/proffer.configuration.optionerror.md b/docs/api/core/proffer.configuration.optionerror.md index 1422375..2959b70 100644 --- a/docs/api/core/proffer.configuration.optionerror.md +++ b/docs/api/core/proffer.configuration.optionerror.md @@ -8,8 +8,8 @@ A generic error reported from the options validation. public class OptionError : IOptionError ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [OptionError](./proffer.configuration.optionerror)
    -Implements [IOptionError](./proffer.configuration.ioptionerror) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [OptionError](./proffer.configuration.optionerror.md)
    +Implements [IOptionError](./proffer.configuration.ioptionerror.md) ## Properties diff --git a/docs/api/core/proffer.configuration.provideroptions.md b/docs/api/core/proffer.configuration.provideroptions.md index 157af47..6c0a7c9 100644 --- a/docs/api/core/proffer.configuration.provideroptions.md +++ b/docs/api/core/proffer.configuration.provideroptions.md @@ -8,8 +8,8 @@ Standard options for a provider. public class ProviderOptions : IProviderOptions, INamedElementOptions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ProviderOptions](./proffer.configuration.provideroptions)
    -Implements [IProviderOptions](./proffer.configuration.iprovideroptions), [INamedElementOptions](./proffer.configuration.inamedelementoptions) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ProviderOptions](./proffer.configuration.provideroptions.md)
    +Implements [IProviderOptions](./proffer.configuration.iprovideroptions.md), [INamedElementOptions](./proffer.configuration.inamedelementoptions.md) ## Properties diff --git a/docs/api/core/proffer.equalitycomparerbase-1.md b/docs/api/core/proffer.equalitycomparerbase-1.md index a495316..53d3295 100644 --- a/docs/api/core/proffer.equalitycomparerbase-1.md +++ b/docs/api/core/proffer.equalitycomparerbase-1.md @@ -13,7 +13,7 @@ public abstract class EqualityComparerBase : , System.Collections.IEqualityCo `T`
    The type of objects to compare. -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → EqualityComparer<T> → [EqualityComparerBase<T>](./proffer.equalitycomparerbase-1)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → EqualityComparer<T> → [EqualityComparerBase<T>](./proffer.equalitycomparerbase-1.md)
    Implements [IEqualityComparer](https://docs.microsoft.com/en-us/dotnet/api/system.collections.iequalitycomparer), IEqualityComparer<T> ## Methods diff --git a/docs/api/email/in-memory/index.md b/docs/api/email/in-memory/index.md index 934357b..45579db 100644 --- a/docs/api/email/in-memory/index.md +++ b/docs/api/email/in-memory/index.md @@ -2,16 +2,16 @@ ## Proffer.Email -[InMemoryEmailServiceCollectionExtensions](./proffer.email.inmemoryemailservicecollectionextensions) +[InMemoryEmailServiceCollectionExtensions](./proffer.email.inmemoryemailservicecollectionextensions.md) ## Proffer.Email.InMemory -[IInMemoryEmailRepository](./proffer.email.inmemory.iinmemoryemailrepository) +[IInMemoryEmailRepository](./proffer.email.inmemory.iinmemoryemailrepository.md) -[InMemoryEmail](./proffer.email.inmemory.inmemoryemail) +[InMemoryEmail](./proffer.email.inmemory.inmemoryemail.md) -[InMemoryEmailProvider](./proffer.email.inmemory.inmemoryemailprovider) +[InMemoryEmailProvider](./proffer.email.inmemory.inmemoryemailprovider.md) -[InMemoryEmailProviderType](./proffer.email.inmemory.inmemoryemailprovidertype) +[InMemoryEmailProviderType](./proffer.email.inmemory.inmemoryemailprovidertype.md) -[InMemoryEmailRepository](./proffer.email.inmemory.inmemoryemailrepository) +[InMemoryEmailRepository](./proffer.email.inmemory.inmemoryemailrepository.md) diff --git a/docs/api/email/in-memory/proffer.email.inmemory.iinmemoryemailrepository.md b/docs/api/email/in-memory/proffer.email.inmemory.iinmemoryemailrepository.md index 35c7731..9a11b3b 100644 --- a/docs/api/email/in-memory/proffer.email.inmemory.iinmemoryemailrepository.md +++ b/docs/api/email/in-memory/proffer.email.inmemory.iinmemoryemailrepository.md @@ -34,5 +34,5 @@ void Save(InMemoryEmail email) #### Parameters -`email` [InMemoryEmail](./proffer.email.inmemory.inmemoryemail)
    +`email` [InMemoryEmail](./proffer.email.inmemory.inmemoryemail.md)
    The email. diff --git a/docs/api/email/in-memory/proffer.email.inmemory.inmemoryemail.md b/docs/api/email/in-memory/proffer.email.inmemory.inmemoryemail.md index 439e66b..82c56bf 100644 --- a/docs/api/email/in-memory/proffer.email.inmemory.inmemoryemail.md +++ b/docs/api/email/in-memory/proffer.email.inmemory.inmemoryemail.md @@ -8,7 +8,7 @@ An object to retain the values of the email that would have been sent. public class InMemoryEmail ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [InMemoryEmail](./proffer.email.inmemory.inmemoryemail) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [InMemoryEmail](./proffer.email.inmemory.inmemoryemail.md) ## Properties diff --git a/docs/api/email/in-memory/proffer.email.inmemory.inmemoryemailprovider.md b/docs/api/email/in-memory/proffer.email.inmemory.inmemoryemailprovider.md index 39b8ecd..c7f1a8f 100644 --- a/docs/api/email/in-memory/proffer.email.inmemory.inmemoryemailprovider.md +++ b/docs/api/email/in-memory/proffer.email.inmemory.inmemoryemailprovider.md @@ -8,14 +8,14 @@ A provider which does not send any email but holds it in a collection in memory. public class InMemoryEmailProvider : Proffer.Email.IEmailProvider ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [InMemoryEmailProvider](./proffer.email.inmemory.inmemoryemailprovider)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [InMemoryEmailProvider](./proffer.email.inmemory.inmemoryemailprovider.md)
    Implements IEmailProvider ## Constructors ### **InMemoryEmailProvider(IInMemoryEmailRepository)** -Initializes a new instance of the [InMemoryEmailProvider](./proffer.email.inmemory.inmemoryemailprovider) class. +Initializes a new instance of the [InMemoryEmailProvider](./proffer.email.inmemory.inmemoryemailprovider.md) class. ```csharp public InMemoryEmailProvider(IInMemoryEmailRepository inMemoryEmailRepository) @@ -23,7 +23,7 @@ public InMemoryEmailProvider(IInMemoryEmailRepository inMemoryEmailRepository) #### Parameters -`inMemoryEmailRepository` [IInMemoryEmailRepository](./proffer.email.inmemory.iinmemoryemailrepository)
    +`inMemoryEmailRepository` [IInMemoryEmailRepository](./proffer.email.inmemory.iinmemoryemailrepository.md)
    The in-memory email repository. ## Methods diff --git a/docs/api/email/in-memory/proffer.email.inmemory.inmemoryemailprovidertype.md b/docs/api/email/in-memory/proffer.email.inmemory.inmemoryemailprovidertype.md index be7d3aa..73ed52e 100644 --- a/docs/api/email/in-memory/proffer.email.inmemory.inmemoryemailprovidertype.md +++ b/docs/api/email/in-memory/proffer.email.inmemory.inmemoryemailprovidertype.md @@ -2,13 +2,13 @@ Namespace: Proffer.Email.InMemory -Builds [InMemoryEmailProvider](./proffer.email.inmemory.inmemoryemailprovider). +Builds [InMemoryEmailProvider](./proffer.email.inmemory.inmemoryemailprovider.md). ```csharp public class InMemoryEmailProviderType : Proffer.Email.IEmailProviderType ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [InMemoryEmailProviderType](./proffer.email.inmemory.inmemoryemailprovidertype)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [InMemoryEmailProviderType](./proffer.email.inmemory.inmemoryemailprovidertype.md)
    Implements IEmailProviderType ## Properties @@ -29,7 +29,7 @@ public string Name { get; } ### **InMemoryEmailProviderType(IInMemoryEmailRepository)** -Initializes a new instance of the [InMemoryEmailProviderType](./proffer.email.inmemory.inmemoryemailprovidertype) class. +Initializes a new instance of the [InMemoryEmailProviderType](./proffer.email.inmemory.inmemoryemailprovidertype.md) class. ```csharp public InMemoryEmailProviderType(IInMemoryEmailRepository inMemoryEmailRepository) @@ -37,7 +37,7 @@ public InMemoryEmailProviderType(IInMemoryEmailRepository inMemoryEmailRepositor #### Parameters -`inMemoryEmailRepository` [IInMemoryEmailRepository](./proffer.email.inmemory.iinmemoryemailrepository)
    +`inMemoryEmailRepository` [IInMemoryEmailRepository](./proffer.email.inmemory.iinmemoryemailrepository.md)
    The in-memory email repository. ## Methods diff --git a/docs/api/email/in-memory/proffer.email.inmemory.inmemoryemailrepository.md b/docs/api/email/in-memory/proffer.email.inmemory.inmemoryemailrepository.md index 8c964d6..b987344 100644 --- a/docs/api/email/in-memory/proffer.email.inmemory.inmemoryemailrepository.md +++ b/docs/api/email/in-memory/proffer.email.inmemory.inmemoryemailrepository.md @@ -8,8 +8,8 @@ A repository in memory to hold sent emails through the provider. public class InMemoryEmailRepository : IInMemoryEmailRepository ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [InMemoryEmailRepository](./proffer.email.inmemory.inmemoryemailrepository)
    -Implements [IInMemoryEmailRepository](./proffer.email.inmemory.iinmemoryemailrepository) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [InMemoryEmailRepository](./proffer.email.inmemory.inmemoryemailrepository.md)
    +Implements [IInMemoryEmailRepository](./proffer.email.inmemory.iinmemoryemailrepository.md) ## Properties @@ -47,5 +47,5 @@ public void Save(InMemoryEmail email) #### Parameters -`email` [InMemoryEmail](./proffer.email.inmemory.inmemoryemail)
    +`email` [InMemoryEmail](./proffer.email.inmemory.inmemoryemail.md)
    The email. diff --git a/docs/api/email/in-memory/proffer.email.inmemoryemailservicecollectionextensions.md b/docs/api/email/in-memory/proffer.email.inmemoryemailservicecollectionextensions.md index 855016c..2d8a6ab 100644 --- a/docs/api/email/in-memory/proffer.email.inmemoryemailservicecollectionextensions.md +++ b/docs/api/email/in-memory/proffer.email.inmemoryemailservicecollectionextensions.md @@ -8,7 +8,7 @@ Microsoft.Extensions.DependencyInjection.IServiceCollection extension methods. public static class InMemoryEmailServiceCollectionExtensions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [InMemoryEmailServiceCollectionExtensions](./proffer.email.inmemoryemailservicecollectionextensions) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [InMemoryEmailServiceCollectionExtensions](./proffer.email.inmemoryemailservicecollectionextensions.md) ## Methods diff --git a/docs/api/email/index.md b/docs/api/email/index.md index 15001e0..b78131e 100644 --- a/docs/api/email/index.md +++ b/docs/api/email/index.md @@ -2,40 +2,40 @@ ## Proffer.Email -[EmailOptions](./proffer.email.emailoptions) +[EmailOptions](./proffer.email.emailoptions.md) -[EmailProviderOptions](./proffer.email.emailprovideroptions) +[EmailProviderOptions](./proffer.email.emailprovideroptions.md) -[EmailServiceCollectionExtensions](./proffer.email.emailservicecollectionextensions) +[EmailServiceCollectionExtensions](./proffer.email.emailservicecollectionextensions.md) -[EmailTemplateType](./proffer.email.emailtemplatetype) +[EmailTemplateType](./proffer.email.emailtemplatetype.md) -[IEmailAddress](./proffer.email.iemailaddress) +[IEmailAddress](./proffer.email.iemailaddress.md) -[IEmailAttachment](./proffer.email.iemailattachment) +[IEmailAttachment](./proffer.email.iemailattachment.md) -[IEmailProvider](./proffer.email.iemailprovider) +[IEmailProvider](./proffer.email.iemailprovider.md) -[IEmailProviderOptions](./proffer.email.iemailprovideroptions) +[IEmailProviderOptions](./proffer.email.iemailprovideroptions.md) -[IEmailProviderType](./proffer.email.iemailprovidertype) +[IEmailProviderType](./proffer.email.iemailprovidertype.md) -[IEmailSender](./proffer.email.iemailsender) +[IEmailSender](./proffer.email.iemailsender.md) -[MockupExceptionsOptions](./proffer.email.mockupexceptionsoptions) +[MockupExceptionsOptions](./proffer.email.mockupexceptionsoptions.md) -[MockupOptions](./proffer.email.mockupoptions) +[MockupOptions](./proffer.email.mockupoptions.md) ## Proffer.Email.Internal -[EmailAddress](./proffer.email.internal.emailaddress) +[EmailAddress](./proffer.email.internal.emailaddress.md) -[EmailAddressEqualityComparer](./proffer.email.internal.emailaddressequalitycomparer) +[EmailAddressEqualityComparer](./proffer.email.internal.emailaddressequalitycomparer.md) -[EmailAddressStrictEqualityComparer](./proffer.email.internal.emailaddressstrictequalitycomparer) +[EmailAddressStrictEqualityComparer](./proffer.email.internal.emailaddressstrictequalitycomparer.md) -[EmailAttachment](./proffer.email.internal.emailattachment) +[EmailAttachment](./proffer.email.internal.emailattachment.md) -[EmailAttachmentEqualityComparer](./proffer.email.internal.emailattachmentequalitycomparer) +[EmailAttachmentEqualityComparer](./proffer.email.internal.emailattachmentequalitycomparer.md) -[EmailSender](./proffer.email.internal.emailsender) +[EmailSender](./proffer.email.internal.emailsender.md) diff --git a/docs/api/email/proffer.email.emailoptions.md b/docs/api/email/proffer.email.emailoptions.md index 10e3326..7e84ff1 100644 --- a/docs/api/email/proffer.email.emailoptions.md +++ b/docs/api/email/proffer.email.emailoptions.md @@ -8,7 +8,7 @@ The Proffer.Email options with providers. public class EmailOptions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EmailOptions](./proffer.email.emailoptions) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EmailOptions](./proffer.email.emailoptions.md) ## Fields @@ -32,7 +32,7 @@ public EmailProviderOptions Provider { get; set; } #### Property Value -[EmailProviderOptions](./proffer.email.emailprovideroptions)
    +[EmailProviderOptions](./proffer.email.emailprovideroptions.md)
    ### **DefaultSender** @@ -44,7 +44,7 @@ public EmailAddress DefaultSender { get; set; } #### Property Value -[EmailAddress](./proffer.email.internal.emailaddress)
    +[EmailAddress](./proffer.email.internal.emailaddress.md)
    ### **TemplateStorage** @@ -68,7 +68,7 @@ public MockupOptions Mockup { get; set; } #### Property Value -[MockupOptions](./proffer.email.mockupoptions)
    +[MockupOptions](./proffer.email.mockupoptions.md)
    ## Constructors diff --git a/docs/api/email/proffer.email.emailprovideroptions.md b/docs/api/email/proffer.email.emailprovideroptions.md index e42ad67..53dba5c 100644 --- a/docs/api/email/proffer.email.emailprovideroptions.md +++ b/docs/api/email/proffer.email.emailprovideroptions.md @@ -2,14 +2,14 @@ Namespace: Proffer.Email -Generic options for a [IEmailProvider](./proffer.email.iemailprovider). +Generic options for a [IEmailProvider](./proffer.email.iemailprovider.md). ```csharp public class EmailProviderOptions : IEmailProviderOptions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EmailProviderOptions](./proffer.email.emailprovideroptions)
    -Implements [IEmailProviderOptions](./proffer.email.iemailprovideroptions) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EmailProviderOptions](./proffer.email.emailprovideroptions.md)
    +Implements [IEmailProviderOptions](./proffer.email.iemailprovideroptions.md) ## Properties diff --git a/docs/api/email/proffer.email.emailservicecollectionextensions.md b/docs/api/email/proffer.email.emailservicecollectionextensions.md index 55256bc..019c7bf 100644 --- a/docs/api/email/proffer.email.emailservicecollectionextensions.md +++ b/docs/api/email/proffer.email.emailservicecollectionextensions.md @@ -8,7 +8,7 @@ Microsoft.Extensions.DependencyInjection.IServiceCollection extension methods. public static class EmailServiceCollectionExtensions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EmailServiceCollectionExtensions](./proffer.email.emailservicecollectionextensions) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EmailServiceCollectionExtensions](./proffer.email.emailservicecollectionextensions.md) ## Methods diff --git a/docs/api/email/proffer.email.emailtemplatetype.md b/docs/api/email/proffer.email.emailtemplatetype.md index b1235ed..9956405 100644 --- a/docs/api/email/proffer.email.emailtemplatetype.md +++ b/docs/api/email/proffer.email.emailtemplatetype.md @@ -8,7 +8,7 @@ Type of template for a templated email. public enum EmailTemplateType ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ValueType](https://docs.microsoft.com/en-us/dotnet/api/system.valuetype) → [Enum](https://docs.microsoft.com/en-us/dotnet/api/system.enum) → [EmailTemplateType](./proffer.email.emailtemplatetype)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ValueType](https://docs.microsoft.com/en-us/dotnet/api/system.valuetype) → [Enum](https://docs.microsoft.com/en-us/dotnet/api/system.enum) → [EmailTemplateType](./proffer.email.emailtemplatetype.md)
    Implements [IComparable](https://docs.microsoft.com/en-us/dotnet/api/system.icomparable), [IFormattable](https://docs.microsoft.com/en-us/dotnet/api/system.iformattable), [IConvertible](https://docs.microsoft.com/en-us/dotnet/api/system.iconvertible) ## Fields diff --git a/docs/api/email/proffer.email.iemailprovider.md b/docs/api/email/proffer.email.iemailprovider.md index 68e363c..5d618a2 100644 --- a/docs/api/email/proffer.email.iemailprovider.md +++ b/docs/api/email/proffer.email.iemailprovider.md @@ -20,7 +20,7 @@ Task SendEmailAsync(IEmailAddress from, IEnumerable recipients, s #### Parameters -`from` [IEmailAddress](./proffer.email.iemailaddress)
    +`from` [IEmailAddress](./proffer.email.iemailaddress.md)
    The sender email address. `recipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
    @@ -51,7 +51,7 @@ Task SendEmailAsync(IEmailAddress from, IEnumerable recipients, s #### Parameters -`from` [IEmailAddress](./proffer.email.iemailaddress)
    +`from` [IEmailAddress](./proffer.email.iemailaddress.md)
    The sender email address. `recipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
    @@ -85,7 +85,7 @@ Task SendEmailAsync(IEmailAddress from, IEnumerable recipients, I #### Parameters -`from` [IEmailAddress](./proffer.email.iemailaddress)
    +`from` [IEmailAddress](./proffer.email.iemailaddress.md)
    The sender email address. `recipients` [IEnumerable<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
    @@ -109,7 +109,7 @@ The body as HTML. `attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
    The file attachments. -`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
    +`replyTo` [IEmailAddress](./proffer.email.iemailaddress.md)
    The reply-to email address. #### Returns diff --git a/docs/api/email/proffer.email.iemailprovideroptions.md b/docs/api/email/proffer.email.iemailprovideroptions.md index 7f2b1be..d0908e4 100644 --- a/docs/api/email/proffer.email.iemailprovideroptions.md +++ b/docs/api/email/proffer.email.iemailprovideroptions.md @@ -2,7 +2,7 @@ Namespace: Proffer.Email -Options for a [IEmailProvider](./proffer.email.iemailprovider). +Options for a [IEmailProvider](./proffer.email.iemailprovider.md). ```csharp public interface IEmailProviderOptions diff --git a/docs/api/email/proffer.email.iemailprovidertype.md b/docs/api/email/proffer.email.iemailprovidertype.md index 6aacc8d..c7adcf5 100644 --- a/docs/api/email/proffer.email.iemailprovidertype.md +++ b/docs/api/email/proffer.email.iemailprovidertype.md @@ -34,10 +34,10 @@ IEmailProvider BuildProvider(IEmailProviderOptions providerOptions) #### Parameters -`providerOptions` [IEmailProviderOptions](./proffer.email.iemailprovideroptions)
    +`providerOptions` [IEmailProviderOptions](./proffer.email.iemailprovideroptions.md)
    The provider options. #### Returns -[IEmailProvider](./proffer.email.iemailprovider)
    +[IEmailProvider](./proffer.email.iemailprovider.md)
    A new . diff --git a/docs/api/email/proffer.email.iemailsender.md b/docs/api/email/proffer.email.iemailsender.md index 8e62c52..be861b5 100644 --- a/docs/api/email/proffer.email.iemailsender.md +++ b/docs/api/email/proffer.email.iemailsender.md @@ -26,7 +26,7 @@ The subject. `message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    The body as plain text. -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`to` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The email recipients. #### Returns @@ -45,7 +45,7 @@ Task SendEmailAsync(IEmailAddress from, string subject, string message, IEmailAd #### Parameters -`from` [IEmailAddress](./proffer.email.iemailaddress)
    +`from` [IEmailAddress](./proffer.email.iemailaddress.md)
    The sender email address. `subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    @@ -54,7 +54,7 @@ The subject. `message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    The body as plain text. -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`to` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The email recipients. #### Returns @@ -73,10 +73,10 @@ Task SendEmailAsync(IEmailAddress from, IEmailAddress replyTo, string subject, s #### Parameters -`from` [IEmailAddress](./proffer.email.iemailaddress)
    +`from` [IEmailAddress](./proffer.email.iemailaddress.md)
    The sender email address. -`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
    +`replyTo` [IEmailAddress](./proffer.email.iemailaddress.md)
    The reply-to email address. `subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    @@ -88,7 +88,7 @@ The body as plain text. `plainTextOnly` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
    If set to true the body shoud be sent as plain text only. -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`to` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The email recipients. #### Returns @@ -107,7 +107,7 @@ Task SendEmailAsync(IEmailAddress from, string subject, string message, IEnumera #### Parameters -`from` [IEmailAddress](./proffer.email.iemailaddress)
    +`from` [IEmailAddress](./proffer.email.iemailaddress.md)
    The sender email address. `subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    @@ -119,7 +119,7 @@ The body as plain text. `attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
    The file attachments. -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`to` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The email recipients. #### Returns @@ -138,10 +138,10 @@ Task SendEmailAsync(IEmailAddress from, IEmailAddress replyTo, string subject, s #### Parameters -`from` [IEmailAddress](./proffer.email.iemailaddress)
    +`from` [IEmailAddress](./proffer.email.iemailaddress.md)
    The sender email address. -`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
    +`replyTo` [IEmailAddress](./proffer.email.iemailaddress.md)
    The reply-to email address. `subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    @@ -156,7 +156,7 @@ If set to true the body shoud be sent as plain text only. `attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
    The file attachments. -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`to` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The email recipients. #### Returns @@ -175,7 +175,7 @@ Task SendEmailAsync(IEmailAddress from, string subject, string message, IEnumera #### Parameters -`from` [IEmailAddress](./proffer.email.iemailaddress)
    +`from` [IEmailAddress](./proffer.email.iemailaddress.md)
    The sender email address. `subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    @@ -187,16 +187,16 @@ The body as plain text. `attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
    The file attachments. -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`to` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The email recipients. -`cc` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`cc` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The CC email recipients. -`bcc` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`bcc` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The BCC email recipients. -`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
    +`replyTo` [IEmailAddress](./proffer.email.iemailaddress.md)
    The reply-to email address. `plainTextOnly` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
    @@ -229,7 +229,7 @@ The template key. `context` T
    The context to apply on the template. -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`to` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The email recipients. #### Returns @@ -253,7 +253,7 @@ The type of context to apply on the template. #### Parameters -`from` [IEmailAddress](./proffer.email.iemailaddress)
    +`from` [IEmailAddress](./proffer.email.iemailaddress.md)
    The sender email address. `templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    @@ -262,7 +262,7 @@ The template key. `context` T
    The context to apply on the template. -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`to` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The email recipients. #### Returns @@ -286,10 +286,10 @@ The type of context to apply on the template. #### Parameters -`from` [IEmailAddress](./proffer.email.iemailaddress)
    +`from` [IEmailAddress](./proffer.email.iemailaddress.md)
    The sender email address. -`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
    +`replyTo` [IEmailAddress](./proffer.email.iemailaddress.md)
    The reply-to email address. `templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    @@ -298,7 +298,7 @@ The template key. `context` T
    The context to apply on the template. -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`to` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The email recipients. #### Returns @@ -322,7 +322,7 @@ The type of context to apply on the template. #### Parameters -`from` [IEmailAddress](./proffer.email.iemailaddress)
    +`from` [IEmailAddress](./proffer.email.iemailaddress.md)
    The sender email address. `templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    @@ -334,7 +334,7 @@ The context to apply on the template. `attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
    The file attachments. -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`to` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The email recipients. #### Returns @@ -358,10 +358,10 @@ The type of context to apply on the template. #### Parameters -`from` [IEmailAddress](./proffer.email.iemailaddress)
    +`from` [IEmailAddress](./proffer.email.iemailaddress.md)
    The sender email address. -`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
    +`replyTo` [IEmailAddress](./proffer.email.iemailaddress.md)
    The reply-to email address. `templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    @@ -373,7 +373,7 @@ The context to apply on the template. `attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
    The file attachments. -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`to` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The email recipients. #### Returns @@ -397,7 +397,7 @@ The type of context to apply on the template. #### Parameters -`from` [IEmailAddress](./proffer.email.iemailaddress)
    +`from` [IEmailAddress](./proffer.email.iemailaddress.md)
    The sender email address. `templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    @@ -409,16 +409,16 @@ The context to apply on the template. `attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
    The file attachments. -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`to` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The email recipients. -`cc` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`cc` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The CC email recipients. -`bcc` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`bcc` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The BCC email recipients. -`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
    +`replyTo` [IEmailAddress](./proffer.email.iemailaddress.md)
    The reply-to email address. #### Returns diff --git a/docs/api/email/proffer.email.internal.emailaddress.md b/docs/api/email/proffer.email.internal.emailaddress.md index c0d24d5..bce0a26 100644 --- a/docs/api/email/proffer.email.internal.emailaddress.md +++ b/docs/api/email/proffer.email.internal.emailaddress.md @@ -8,8 +8,8 @@ A simple email address with its optional display name. public class EmailAddress : Proffer.Email.IEmailAddress ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EmailAddress](./proffer.email.internal.emailaddress)
    -Implements [IEmailAddress](./proffer.email.iemailaddress) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EmailAddress](./proffer.email.internal.emailaddress.md)
    +Implements [IEmailAddress](./proffer.email.iemailaddress.md) ## Properties @@ -41,7 +41,7 @@ public string DisplayName { get; set; } ### **EmailAddress()** -Initializes a new instance of the [EmailAddress](./proffer.email.internal.emailaddress) class. +Initializes a new instance of the [EmailAddress](./proffer.email.internal.emailaddress.md) class. ```csharp public EmailAddress() @@ -49,7 +49,7 @@ public EmailAddress() ### **EmailAddress(String, String)** -Initializes a new instance of the [EmailAddress](./proffer.email.internal.emailaddress) class. +Initializes a new instance of the [EmailAddress](./proffer.email.internal.emailaddress.md) class. ```csharp public EmailAddress(string email, string displayName) diff --git a/docs/api/email/proffer.email.internal.emailaddressequalitycomparer.md b/docs/api/email/proffer.email.internal.emailaddressequalitycomparer.md index 4e2f2eb..614a230 100644 --- a/docs/api/email/proffer.email.internal.emailaddressequalitycomparer.md +++ b/docs/api/email/proffer.email.internal.emailaddressequalitycomparer.md @@ -2,13 +2,13 @@ Namespace: Proffer.Email.Internal -Supports the comparison of [IEmailAddress](./proffer.email.iemailaddress) for equality when the email address only should match. +Supports the comparison of [IEmailAddress](./proffer.email.iemailaddress.md) for equality when the email address only should match. ```csharp public class EmailAddressEqualityComparer : Proffer.EqualityComparerBase`1[[Proffer.Email.IEmailAddress, Proffer.Email, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Collections.IEqualityComparer, System.Collections.Generic.IEqualityComparer`1[[Proffer.Email.IEmailAddress, Proffer.Email, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EqualityComparer<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.equalitycomparer-1) → EqualityComparerBase<IEmailAddress> → [EmailAddressEqualityComparer](./proffer.email.internal.emailaddressequalitycomparer)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EqualityComparer<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.equalitycomparer-1) → EqualityComparerBase<IEmailAddress> → [EmailAddressEqualityComparer](./proffer.email.internal.emailaddressequalitycomparer.md)
    Implements [IEqualityComparer](https://docs.microsoft.com/en-us/dotnet/api/system.collections.iequalitycomparer), [IEqualityComparer<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.iequalitycomparer-1) ## Constructors @@ -33,7 +33,7 @@ protected IEnumerable GetEqualityComponents(IEmailAddress obj) #### Parameters -`obj` [IEmailAddress](./proffer.email.iemailaddress)
    +`obj` [IEmailAddress](./proffer.email.iemailaddress.md)
    The object. #### Returns diff --git a/docs/api/email/proffer.email.internal.emailaddressstrictequalitycomparer.md b/docs/api/email/proffer.email.internal.emailaddressstrictequalitycomparer.md index fae43be..d6189a5 100644 --- a/docs/api/email/proffer.email.internal.emailaddressstrictequalitycomparer.md +++ b/docs/api/email/proffer.email.internal.emailaddressstrictequalitycomparer.md @@ -2,13 +2,13 @@ Namespace: Proffer.Email.Internal -Supports the comparison of [IEmailAddress](./proffer.email.iemailaddress) for equality when both the email address and the display name should match. +Supports the comparison of [IEmailAddress](./proffer.email.iemailaddress.md) for equality when both the email address and the display name should match. ```csharp public class EmailAddressStrictEqualityComparer : Proffer.EqualityComparerBase`1[[Proffer.Email.IEmailAddress, Proffer.Email, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Collections.IEqualityComparer, System.Collections.Generic.IEqualityComparer`1[[Proffer.Email.IEmailAddress, Proffer.Email, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EqualityComparer<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.equalitycomparer-1) → EqualityComparerBase<IEmailAddress> → [EmailAddressStrictEqualityComparer](./proffer.email.internal.emailaddressstrictequalitycomparer)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EqualityComparer<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.equalitycomparer-1) → EqualityComparerBase<IEmailAddress> → [EmailAddressStrictEqualityComparer](./proffer.email.internal.emailaddressstrictequalitycomparer.md)
    Implements [IEqualityComparer](https://docs.microsoft.com/en-us/dotnet/api/system.collections.iequalitycomparer), [IEqualityComparer<IEmailAddress>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.iequalitycomparer-1) ## Constructors @@ -33,7 +33,7 @@ protected IEnumerable GetEqualityComponents(IEmailAddress obj) #### Parameters -`obj` [IEmailAddress](./proffer.email.iemailaddress)
    +`obj` [IEmailAddress](./proffer.email.iemailaddress.md)
    The object. #### Returns diff --git a/docs/api/email/proffer.email.internal.emailattachment.md b/docs/api/email/proffer.email.internal.emailattachment.md index 9d76156..b0c14c6 100644 --- a/docs/api/email/proffer.email.internal.emailattachment.md +++ b/docs/api/email/proffer.email.internal.emailattachment.md @@ -8,8 +8,8 @@ A simpl email attachment file. public class EmailAttachment : Proffer.Email.IEmailAttachment ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EmailAttachment](./proffer.email.internal.emailattachment)
    -Implements [IEmailAttachment](./proffer.email.iemailattachment) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EmailAttachment](./proffer.email.internal.emailattachment.md)
    +Implements [IEmailAttachment](./proffer.email.iemailattachment.md) ## Properties @@ -77,7 +77,7 @@ public string ContentType { get; } ### **EmailAttachment()** -Initializes a new instance of the [EmailAttachment](./proffer.email.internal.emailattachment) class. +Initializes a new instance of the [EmailAttachment](./proffer.email.internal.emailattachment.md) class. ```csharp public EmailAttachment() @@ -85,7 +85,7 @@ public EmailAttachment() ### **EmailAttachment(String, Byte[], String)** -Initializes a new instance of the [EmailAttachment](./proffer.email.internal.emailattachment) class. +Initializes a new instance of the [EmailAttachment](./proffer.email.internal.emailattachment.md) class. ```csharp public EmailAttachment(string fileName, Byte[] data, string contentType) @@ -104,7 +104,7 @@ The content-type. ### **EmailAttachment(String, Byte[], String, String)** -Initializes a new instance of the [EmailAttachment](./proffer.email.internal.emailattachment) class. +Initializes a new instance of the [EmailAttachment](./proffer.email.internal.emailattachment.md) class. ```csharp public EmailAttachment(string fileName, Byte[] data, string mediaType, string mediaSubtype) diff --git a/docs/api/email/proffer.email.internal.emailattachmentequalitycomparer.md b/docs/api/email/proffer.email.internal.emailattachmentequalitycomparer.md index 09e9af6..637f4fd 100644 --- a/docs/api/email/proffer.email.internal.emailattachmentequalitycomparer.md +++ b/docs/api/email/proffer.email.internal.emailattachmentequalitycomparer.md @@ -2,13 +2,13 @@ Namespace: Proffer.Email.Internal -Supports the comparison of [IEmailAttachment](./proffer.email.iemailattachment) for equality. +Supports the comparison of [IEmailAttachment](./proffer.email.iemailattachment.md) for equality. ```csharp public class EmailAttachmentEqualityComparer : Proffer.EqualityComparerBase`1[[Proffer.Email.IEmailAttachment, Proffer.Email, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Collections.IEqualityComparer, System.Collections.Generic.IEqualityComparer`1[[Proffer.Email.IEmailAttachment, Proffer.Email, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EqualityComparer<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.equalitycomparer-1) → EqualityComparerBase<IEmailAttachment> → [EmailAttachmentEqualityComparer](./proffer.email.internal.emailattachmentequalitycomparer)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EqualityComparer<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.equalitycomparer-1) → EqualityComparerBase<IEmailAttachment> → [EmailAttachmentEqualityComparer](./proffer.email.internal.emailattachmentequalitycomparer.md)
    Implements [IEqualityComparer](https://docs.microsoft.com/en-us/dotnet/api/system.collections.iequalitycomparer), [IEqualityComparer<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.iequalitycomparer-1) ## Constructors @@ -33,7 +33,7 @@ protected IEnumerable GetEqualityComponents(IEmailAttachment obj) #### Parameters -`obj` [IEmailAttachment](./proffer.email.iemailattachment)
    +`obj` [IEmailAttachment](./proffer.email.iemailattachment.md)
    The object. #### Returns diff --git a/docs/api/email/proffer.email.internal.emailsender.md b/docs/api/email/proffer.email.internal.emailsender.md index 2b68cdd..9b5dc3e 100644 --- a/docs/api/email/proffer.email.internal.emailsender.md +++ b/docs/api/email/proffer.email.internal.emailsender.md @@ -8,14 +8,14 @@ Sends templated or raw emails using configured providers. public class EmailSender : Proffer.Email.IEmailSender ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EmailSender](./proffer.email.internal.emailsender)
    -Implements [IEmailSender](./proffer.email.iemailsender) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EmailSender](./proffer.email.internal.emailsender.md)
    +Implements [IEmailSender](./proffer.email.iemailsender.md) ## Constructors ### **EmailSender(IEnumerable<IEmailProviderType>, IOptions<EmailOptions>, IStorageFactory, ITemplateLoaderFactory)** -Initializes a new instance of the [EmailSender](./proffer.email.internal.emailsender) class. +Initializes a new instance of the [EmailSender](./proffer.email.internal.emailsender.md) class. ```csharp public EmailSender(IEnumerable emailProviderTypes, IOptions options, IStorageFactory storageFactory, ITemplateLoaderFactory templateLoaderFactory) @@ -57,7 +57,7 @@ The subject. `message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    The body as plain text. -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`to` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The email recipients. #### Returns @@ -76,7 +76,7 @@ public Task SendEmailAsync(IEmailAddress from, string subject, string message, I #### Parameters -`from` [IEmailAddress](./proffer.email.iemailaddress)
    +`from` [IEmailAddress](./proffer.email.iemailaddress.md)
    The sender email address. `subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    @@ -85,7 +85,7 @@ The subject. `message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    The body as plain text. -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`to` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The email recipients. #### Returns @@ -104,10 +104,10 @@ public Task SendEmailAsync(IEmailAddress from, IEmailAddress replyTo, string sub #### Parameters -`from` [IEmailAddress](./proffer.email.iemailaddress)
    +`from` [IEmailAddress](./proffer.email.iemailaddress.md)
    The sender email address. -`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
    +`replyTo` [IEmailAddress](./proffer.email.iemailaddress.md)
    The reply-to email address. `subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    @@ -119,7 +119,7 @@ The body as plain text. `plainTextOnly` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
    If set to true the body shoud be sent as plain text only. -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`to` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The email recipients. #### Returns @@ -138,7 +138,7 @@ public Task SendEmailAsync(IEmailAddress from, string subject, string message, I #### Parameters -`from` [IEmailAddress](./proffer.email.iemailaddress)
    +`from` [IEmailAddress](./proffer.email.iemailaddress.md)
    The sender email address. `subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    @@ -150,7 +150,7 @@ The body as plain text. `attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
    The file attachments. -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`to` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The email recipients. #### Returns @@ -169,10 +169,10 @@ public Task SendEmailAsync(IEmailAddress from, IEmailAddress replyTo, string sub #### Parameters -`from` [IEmailAddress](./proffer.email.iemailaddress)
    +`from` [IEmailAddress](./proffer.email.iemailaddress.md)
    The sender email address. -`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
    +`replyTo` [IEmailAddress](./proffer.email.iemailaddress.md)
    The reply-to email address. `subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    @@ -187,7 +187,7 @@ If set to true the body shoud be sent as plain text only. `attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
    The file attachments. -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`to` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The email recipients. #### Returns @@ -206,7 +206,7 @@ public Task SendEmailAsync(IEmailAddress from, string subject, string message, I #### Parameters -`from` [IEmailAddress](./proffer.email.iemailaddress)
    +`from` [IEmailAddress](./proffer.email.iemailaddress.md)
    The sender email address. `subject` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    @@ -218,16 +218,16 @@ The body as plain text. `attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
    The file attachments. -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`to` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The email recipients. -`cc` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`cc` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The CC email recipients. -`bcc` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`bcc` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The BCC email recipients. -`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
    +`replyTo` [IEmailAddress](./proffer.email.iemailaddress.md)
    The reply-to email address. `plainTextOnly` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
    @@ -260,7 +260,7 @@ The template key. `context` T
    The context to apply on the template. -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`to` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The email recipients. #### Returns @@ -284,7 +284,7 @@ The type of context to apply on the template. #### Parameters -`from` [IEmailAddress](./proffer.email.iemailaddress)
    +`from` [IEmailAddress](./proffer.email.iemailaddress.md)
    The sender email address. `templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    @@ -293,7 +293,7 @@ The template key. `context` T
    The context to apply on the template. -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`to` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The email recipients. #### Returns @@ -317,10 +317,10 @@ The type of context to apply on the template. #### Parameters -`from` [IEmailAddress](./proffer.email.iemailaddress)
    +`from` [IEmailAddress](./proffer.email.iemailaddress.md)
    The sender email address. -`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
    +`replyTo` [IEmailAddress](./proffer.email.iemailaddress.md)
    The reply-to email address. `templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    @@ -329,7 +329,7 @@ The template key. `context` T
    The context to apply on the template. -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`to` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The email recipients. #### Returns @@ -353,7 +353,7 @@ The type of context to apply on the template. #### Parameters -`from` [IEmailAddress](./proffer.email.iemailaddress)
    +`from` [IEmailAddress](./proffer.email.iemailaddress.md)
    The sender email address. `templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    @@ -365,7 +365,7 @@ The context to apply on the template. `attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
    The file attachments. -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`to` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The email recipients. #### Returns @@ -389,10 +389,10 @@ The type of context to apply on the template. #### Parameters -`from` [IEmailAddress](./proffer.email.iemailaddress)
    +`from` [IEmailAddress](./proffer.email.iemailaddress.md)
    The sender email address. -`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
    +`replyTo` [IEmailAddress](./proffer.email.iemailaddress.md)
    The reply-to email address. `templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    @@ -404,7 +404,7 @@ The context to apply on the template. `attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
    The file attachments. -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`to` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The email recipients. #### Returns @@ -428,7 +428,7 @@ The type of context to apply on the template. #### Parameters -`from` [IEmailAddress](./proffer.email.iemailaddress)
    +`from` [IEmailAddress](./proffer.email.iemailaddress.md)
    The sender email address. `templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    @@ -440,16 +440,16 @@ The context to apply on the template. `attachments` [IEnumerable<IEmailAttachment>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)
    The file attachments. -`to` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`to` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The email recipients. -`cc` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`cc` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The CC email recipients. -`bcc` [IEmailAddress[]](./proffer.email.iemailaddress)
    +`bcc` [IEmailAddress[]](./proffer.email.iemailaddress.md)
    The BCC email recipients. -`replyTo` [IEmailAddress](./proffer.email.iemailaddress)
    +`replyTo` [IEmailAddress](./proffer.email.iemailaddress.md)
    The reply-to email address. #### Returns @@ -469,7 +469,7 @@ protected Task GetTemplateAsync(string templateKey, EmailTemplateType `templateKey` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    The template key. -`templateType` [EmailTemplateType](./proffer.email.emailtemplatetype)
    +`templateType` [EmailTemplateType](./proffer.email.emailtemplatetype.md)
    Type of the template. #### Returns diff --git a/docs/api/email/proffer.email.mockupexceptionsoptions.md b/docs/api/email/proffer.email.mockupexceptionsoptions.md index 9f6dff4..5ec2387 100644 --- a/docs/api/email/proffer.email.mockupexceptionsoptions.md +++ b/docs/api/email/proffer.email.mockupexceptionsoptions.md @@ -8,7 +8,7 @@ Options to exclude some emails or domains from a mockup configuration. public class MockupExceptionsOptions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [MockupExceptionsOptions](./proffer.email.mockupexceptionsoptions) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [MockupExceptionsOptions](./proffer.email.mockupexceptionsoptions.md) ## Properties diff --git a/docs/api/email/proffer.email.mockupoptions.md b/docs/api/email/proffer.email.mockupoptions.md index 6105759..d7ee011 100644 --- a/docs/api/email/proffer.email.mockupoptions.md +++ b/docs/api/email/proffer.email.mockupoptions.md @@ -8,7 +8,7 @@ Options to mockup the email sender (all recipients would be redirect to the mock public class MockupOptions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [MockupOptions](./proffer.email.mockupoptions) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [MockupOptions](./proffer.email.mockupoptions.md) ## Properties @@ -34,7 +34,7 @@ public MockupExceptionsOptions Exceptions { get; set; } #### Property Value -[MockupExceptionsOptions](./proffer.email.mockupexceptionsoptions)
    +[MockupExceptionsOptions](./proffer.email.mockupexceptionsoptions.md)
    ### **Disclaimer** diff --git a/docs/api/email/sendgrid/index.md b/docs/api/email/sendgrid/index.md index 7e688ee..678c299 100644 --- a/docs/api/email/sendgrid/index.md +++ b/docs/api/email/sendgrid/index.md @@ -2,10 +2,10 @@ ## Proffer.Email -[ServiceCollectionExtensions](./proffer.email.servicecollectionextensions) +[ServiceCollectionExtensions](./proffer.email.servicecollectionextensions.md) ## Proffer.Email.SendGrid -[SendGridEmailProvider](./proffer.email.sendgrid.sendgridemailprovider) +[SendGridEmailProvider](./proffer.email.sendgrid.sendgridemailprovider.md) -[SendGridEmailProviderType](./proffer.email.sendgrid.sendgridemailprovidertype) +[SendGridEmailProviderType](./proffer.email.sendgrid.sendgridemailprovidertype.md) diff --git a/docs/api/email/sendgrid/proffer.email.sendgrid.sendgridemailprovider.md b/docs/api/email/sendgrid/proffer.email.sendgrid.sendgridemailprovider.md index c653a4f..22f98f8 100644 --- a/docs/api/email/sendgrid/proffer.email.sendgrid.sendgridemailprovider.md +++ b/docs/api/email/sendgrid/proffer.email.sendgrid.sendgridemailprovider.md @@ -8,14 +8,14 @@ A provider that sends email using N:SendGrid API. public class SendGridEmailProvider : Proffer.Email.IEmailProvider ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [SendGridEmailProvider](./proffer.email.sendgrid.sendgridemailprovider)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [SendGridEmailProvider](./proffer.email.sendgrid.sendgridemailprovider.md)
    Implements IEmailProvider ## Constructors ### **SendGridEmailProvider(IEmailProviderOptions)** -Initializes a new instance of the [SendGridEmailProvider](./proffer.email.sendgrid.sendgridemailprovider) class. +Initializes a new instance of the [SendGridEmailProvider](./proffer.email.sendgrid.sendgridemailprovider.md) class. ```csharp public SendGridEmailProvider(IEmailProviderOptions options) diff --git a/docs/api/email/sendgrid/proffer.email.sendgrid.sendgridemailprovidertype.md b/docs/api/email/sendgrid/proffer.email.sendgrid.sendgridemailprovidertype.md index 1f9a9d8..ea92792 100644 --- a/docs/api/email/sendgrid/proffer.email.sendgrid.sendgridemailprovidertype.md +++ b/docs/api/email/sendgrid/proffer.email.sendgrid.sendgridemailprovidertype.md @@ -2,13 +2,13 @@ Namespace: Proffer.Email.SendGrid -Builds [SendGridEmailProvider](./proffer.email.sendgrid.sendgridemailprovider). +Builds [SendGridEmailProvider](./proffer.email.sendgrid.sendgridemailprovider.md). ```csharp public class SendGridEmailProviderType : Proffer.Email.IEmailProviderType ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [SendGridEmailProviderType](./proffer.email.sendgrid.sendgridemailprovidertype)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [SendGridEmailProviderType](./proffer.email.sendgrid.sendgridemailprovidertype.md)
    Implements IEmailProviderType ## Properties diff --git a/docs/api/email/sendgrid/proffer.email.servicecollectionextensions.md b/docs/api/email/sendgrid/proffer.email.servicecollectionextensions.md index 8870099..a71fd64 100644 --- a/docs/api/email/sendgrid/proffer.email.servicecollectionextensions.md +++ b/docs/api/email/sendgrid/proffer.email.servicecollectionextensions.md @@ -8,7 +8,7 @@ Microsoft.Extensions.DependencyInjection.IServiceCollection extension methods. public static class ServiceCollectionExtensions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ServiceCollectionExtensions](./proffer.email.servicecollectionextensions) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ServiceCollectionExtensions](./proffer.email.servicecollectionextensions.md) ## Methods diff --git a/docs/api/email/smtp/index.md b/docs/api/email/smtp/index.md index 04c87e6..d3d3abc 100644 --- a/docs/api/email/smtp/index.md +++ b/docs/api/email/smtp/index.md @@ -2,10 +2,10 @@ ## Proffer.Email -[SmtpEmailServiceCollectionExtensions](./proffer.email.smtpemailservicecollectionextensions) +[SmtpEmailServiceCollectionExtensions](./proffer.email.smtpemailservicecollectionextensions.md) ## Proffer.Email.Smtp -[SmtpEmailProvider](./proffer.email.smtp.smtpemailprovider) +[SmtpEmailProvider](./proffer.email.smtp.smtpemailprovider.md) -[SmtpEmailProviderType](./proffer.email.smtp.smtpemailprovidertype) +[SmtpEmailProviderType](./proffer.email.smtp.smtpemailprovidertype.md) diff --git a/docs/api/email/smtp/proffer.email.smtp.smtpemailprovider.md b/docs/api/email/smtp/proffer.email.smtp.smtpemailprovider.md index f5c4bb9..23a7cad 100644 --- a/docs/api/email/smtp/proffer.email.smtp.smtpemailprovider.md +++ b/docs/api/email/smtp/proffer.email.smtp.smtpemailprovider.md @@ -8,14 +8,14 @@ A provider that sends email to a SMTP server with N:MailKit. public class SmtpEmailProvider : Proffer.Email.IEmailProvider ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [SmtpEmailProvider](./proffer.email.smtp.smtpemailprovider)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [SmtpEmailProvider](./proffer.email.smtp.smtpemailprovider.md)
    Implements IEmailProvider ## Constructors ### **SmtpEmailProvider(IServiceProvider, IEmailProviderOptions)** -Initializes a new instance of the [SmtpEmailProvider](./proffer.email.smtp.smtpemailprovider) class. +Initializes a new instance of the [SmtpEmailProvider](./proffer.email.smtp.smtpemailprovider.md) class. ```csharp public SmtpEmailProvider(IServiceProvider serviceProvider, IEmailProviderOptions options) diff --git a/docs/api/email/smtp/proffer.email.smtp.smtpemailprovidertype.md b/docs/api/email/smtp/proffer.email.smtp.smtpemailprovidertype.md index 2de00b0..2d7ccdc 100644 --- a/docs/api/email/smtp/proffer.email.smtp.smtpemailprovidertype.md +++ b/docs/api/email/smtp/proffer.email.smtp.smtpemailprovidertype.md @@ -2,13 +2,13 @@ Namespace: Proffer.Email.Smtp -Builds [SmtpEmailProvider](./proffer.email.smtp.smtpemailprovider). +Builds [SmtpEmailProvider](./proffer.email.smtp.smtpemailprovider.md). ```csharp public class SmtpEmailProviderType : Proffer.Email.IEmailProviderType ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [SmtpEmailProviderType](./proffer.email.smtp.smtpemailprovidertype)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [SmtpEmailProviderType](./proffer.email.smtp.smtpemailprovidertype.md)
    Implements IEmailProviderType ## Properties @@ -29,7 +29,7 @@ public string Name { get; } ### **SmtpEmailProviderType(IServiceProvider)** -Initializes a new instance of the [SmtpEmailProviderType](./proffer.email.smtp.smtpemailprovidertype) class. +Initializes a new instance of the [SmtpEmailProviderType](./proffer.email.smtp.smtpemailprovidertype.md) class. ```csharp public SmtpEmailProviderType(IServiceProvider serviceProvider) diff --git a/docs/api/email/smtp/proffer.email.smtpemailservicecollectionextensions.md b/docs/api/email/smtp/proffer.email.smtpemailservicecollectionextensions.md index 30af29e..b81d50f 100644 --- a/docs/api/email/smtp/proffer.email.smtpemailservicecollectionextensions.md +++ b/docs/api/email/smtp/proffer.email.smtpemailservicecollectionextensions.md @@ -8,7 +8,7 @@ Microsoft.Extensions.DependencyInjection.IServiceCollection extension methods. public static class SmtpEmailServiceCollectionExtensions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [SmtpEmailServiceCollectionExtensions](./proffer.email.smtpemailservicecollectionextensions) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [SmtpEmailServiceCollectionExtensions](./proffer.email.smtpemailservicecollectionextensions.md) ## Methods diff --git a/docs/api/storage/azure/blobs/index.md b/docs/api/storage/azure/blobs/index.md index 8795969..5283b11 100644 --- a/docs/api/storage/azure/blobs/index.md +++ b/docs/api/storage/azure/blobs/index.md @@ -2,30 +2,30 @@ ## Proffer.Storage -[AzureBlobsStorageServiceCollectionExtensions](./proffer.storage.azureblobsstorageservicecollectionextensions) +[AzureBlobsStorageServiceCollectionExtensions](./proffer.storage.azureblobsstorageservicecollectionextensions.md) ## Proffer.Storage.Azure.Blobs -[AzureBlobsStorageProvider](./proffer.storage.azure.blobs.azureblobsstorageprovider) +[AzureBlobsStorageProvider](./proffer.storage.azure.blobs.azureblobsstorageprovider.md) -[AzureBlobsStore](./proffer.storage.azure.blobs.azureblobsstore) +[AzureBlobsStore](./proffer.storage.azure.blobs.azureblobsstore.md) ## Proffer.Storage.Azure.Blobs.Configuration -[AzureBlobsParsedOptions](./proffer.storage.azure.blobs.configuration.azureblobsparsedoptions) +[AzureBlobsParsedOptions](./proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md) -[AzureBlobsProviderOptions](./proffer.storage.azure.blobs.configuration.azureblobsprovideroptions) +[AzureBlobsProviderOptions](./proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md) -[AzureBlobsScopedStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions) +[AzureBlobsScopedStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md) -[AzureBlobsStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsstoreoptions) +[AzureBlobsStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md) ## Proffer.Storage.Azure.Blobs.Internal -[AzureBlobsFileProperties](./proffer.storage.azure.blobs.internal.azureblobsfileproperties) +[AzureBlobsFileProperties](./proffer.storage.azure.blobs.internal.azureblobsfileproperties.md) -[AzureBlobsFileReference](./proffer.storage.azure.blobs.internal.azureblobsfilereference) +[AzureBlobsFileReference](./proffer.storage.azure.blobs.internal.azureblobsfilereference.md) -[AzureBlobsListDirectoryWrapper](./proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper) +[AzureBlobsListDirectoryWrapper](./proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md) -[AzureBlobsListFileWrapper](./proffer.storage.azure.blobs.internal.azureblobslistfilewrapper) +[AzureBlobsListFileWrapper](./proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md) diff --git a/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.azureblobsstorageprovider.md b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.azureblobsstorageprovider.md index ce17d81..4026da8 100644 --- a/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.azureblobsstorageprovider.md +++ b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.azureblobsstorageprovider.md @@ -8,14 +8,14 @@ A provider to handle and build file stores pointing on an Azure Storage account. public class AzureBlobsStorageProvider : Proffer.Storage.Internal.StorageProviderBase`4[[Proffer.Storage.Azure.Blobs.Configuration.AzureBlobsParsedOptions, Proffer.Storage.Azure.Blobs, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[Proffer.Storage.Azure.Blobs.Configuration.AzureBlobsProviderOptions, Proffer.Storage.Azure.Blobs, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[Proffer.Storage.Azure.Blobs.Configuration.AzureBlobsStoreOptions, Proffer.Storage.Azure.Blobs, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[Proffer.Storage.Azure.Blobs.Configuration.AzureBlobsScopedStoreOptions, Proffer.Storage.Azure.Blobs, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Proffer.Storage.IStorageProvider ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → StorageProviderBase<AzureBlobsParsedOptions, AzureBlobsProviderOptions, AzureBlobsStoreOptions, AzureBlobsScopedStoreOptions> → [AzureBlobsStorageProvider](./proffer.storage.azure.blobs.azureblobsstorageprovider)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → StorageProviderBase<AzureBlobsParsedOptions, AzureBlobsProviderOptions, AzureBlobsStoreOptions, AzureBlobsScopedStoreOptions> → [AzureBlobsStorageProvider](./proffer.storage.azure.blobs.azureblobsstorageprovider.md)
    Implements IStorageProvider ## Fields ### **ProviderName** -The [AzureBlobsStorageProvider](./proffer.storage.azure.blobs.azureblobsstorageprovider) name. +The [AzureBlobsStorageProvider](./proffer.storage.azure.blobs.azureblobsstorageprovider.md) name. ```csharp public static string ProviderName; @@ -39,7 +39,7 @@ public string Name { get; } ### **AzureBlobsStorageProvider(IOptions<AzureBlobsParsedOptions>)** -Initializes a new instance of the [AzureBlobsStorageProvider](./proffer.storage.azure.blobs.azureblobsstorageprovider) class. +Initializes a new instance of the [AzureBlobsStorageProvider](./proffer.storage.azure.blobs.azureblobsstorageprovider.md) class. ```csharp public AzureBlobsStorageProvider(IOptions options) @@ -65,7 +65,7 @@ protected IStore BuildStoreInternal(string storeName, AzureBlobsStoreOptions sto `storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    The name of the store. -`storeOptions` [AzureBlobsStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsstoreoptions)
    +`storeOptions` [AzureBlobsStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md)
    The store options. #### Returns diff --git a/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.azureblobsstore.md b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.azureblobsstore.md index bfb0608..a99c27f 100644 --- a/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.azureblobsstore.md +++ b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.azureblobsstore.md @@ -2,13 +2,13 @@ Namespace: Proffer.Storage.Azure.Blobs -An Azure store allows to save, list or read files on a container in its configured [AzureBlobsStorageProvider](./proffer.storage.azure.blobs.azureblobsstorageprovider). +An Azure store allows to save, list or read files on a container in its configured [AzureBlobsStorageProvider](./proffer.storage.azure.blobs.azureblobsstorageprovider.md). ```csharp public class AzureBlobsStore : Proffer.Storage.IStore ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [AzureBlobsStore](./proffer.storage.azure.blobs.azureblobsstore)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [AzureBlobsStore](./proffer.storage.azure.blobs.azureblobsstore.md)
    Implements IStore ## Properties @@ -29,7 +29,7 @@ public string Name { get; } ### **AzureBlobsStore(AzureBlobsStoreOptions)** -Initializes a new instance of the [AzureBlobsStore](./proffer.storage.azure.blobs.azureblobsstore) class. +Initializes a new instance of the [AzureBlobsStore](./proffer.storage.azure.blobs.azureblobsstore.md) class. ```csharp public AzureBlobsStore(AzureBlobsStoreOptions storeOptions) @@ -37,7 +37,7 @@ public AzureBlobsStore(AzureBlobsStoreOptions storeOptions) #### Parameters -`storeOptions` [AzureBlobsStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsstoreoptions)
    +`storeOptions` [AzureBlobsStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md)
    The store options. ## Methods diff --git a/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md index 96966de..8ebfb72 100644 --- a/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md +++ b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md @@ -8,7 +8,7 @@ Typed Azure Blobs options parsed from the dynamic configuration. public class AzureBlobsParsedOptions : Proffer.Storage.Configuration.IParsedOptions`3[[Proffer.Storage.Azure.Blobs.Configuration.AzureBlobsProviderOptions, Proffer.Storage.Azure.Blobs, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[Proffer.Storage.Azure.Blobs.Configuration.AzureBlobsStoreOptions, Proffer.Storage.Azure.Blobs, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[Proffer.Storage.Azure.Blobs.Configuration.AzureBlobsScopedStoreOptions, Proffer.Storage.Azure.Blobs, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [AzureBlobsParsedOptions](./proffer.storage.azure.blobs.configuration.azureblobsparsedoptions)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [AzureBlobsParsedOptions](./proffer.storage.azure.blobs.configuration.azureblobsparsedoptions.md)
    Implements IParsedOptions<AzureBlobsProviderOptions, AzureBlobsStoreOptions, AzureBlobsScopedStoreOptions> ## Properties @@ -95,7 +95,7 @@ public void BindProviderOptions(AzureBlobsProviderOptions providerInstanceOption #### Parameters -`providerInstanceOptions` [AzureBlobsProviderOptions](./proffer.storage.azure.blobs.configuration.azureblobsprovideroptions)
    +`providerInstanceOptions` [AzureBlobsProviderOptions](./proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md)
    The provider instance options. #### Exceptions @@ -112,10 +112,10 @@ public void BindStoreOptions(AzureBlobsStoreOptions storeOptions, AzureBlobsProv #### Parameters -`storeOptions` [AzureBlobsStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsstoreoptions)
    +`storeOptions` [AzureBlobsStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md)
    The store options. -`providerInstanceOptions` [AzureBlobsProviderOptions](./proffer.storage.azure.blobs.configuration.azureblobsprovideroptions)
    +`providerInstanceOptions` [AzureBlobsProviderOptions](./proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md)
    The provider instance options. #### Exceptions diff --git a/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md index cbc0fe8..8f9b937 100644 --- a/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md +++ b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md @@ -2,13 +2,13 @@ Namespace: Proffer.Storage.Azure.Blobs.Configuration -Options for an [AzureBlobsStorageProvider](./proffer.storage.azure.blobs.azureblobsstorageprovider). +Options for an [AzureBlobsStorageProvider](./proffer.storage.azure.blobs.azureblobsstorageprovider.md). ```csharp public class AzureBlobsProviderOptions : Proffer.Configuration.ProviderOptions, Proffer.Configuration.IProviderOptions, Proffer.Configuration.INamedElementOptions, Proffer.Azure.Configuration.IAzureStorageOptions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → ProviderOptions → [AzureBlobsProviderOptions](./proffer.storage.azure.blobs.configuration.azureblobsprovideroptions)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → ProviderOptions → [AzureBlobsProviderOptions](./proffer.storage.azure.blobs.configuration.azureblobsprovideroptions.md)
    Implements IProviderOptions, INamedElementOptions, IAzureStorageOptions ## Properties diff --git a/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md index 541da5e..b703c0c 100644 --- a/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md +++ b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md @@ -2,13 +2,13 @@ Namespace: Proffer.Storage.Azure.Blobs.Configuration -Options for a scoped [AzureBlobsStore](./proffer.storage.azure.blobs.azureblobsstore). +Options for a scoped [AzureBlobsStore](./proffer.storage.azure.blobs.azureblobsstore.md). ```csharp public class AzureBlobsScopedStoreOptions : AzureBlobsStoreOptions, Proffer.Storage.Configuration.IStoreOptions, Proffer.Configuration.INamedElementOptions, Proffer.Azure.Configuration.IAzureStorageOptions, Proffer.Storage.Configuration.IScopedStoreOptions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → StoreOptions → [AzureBlobsStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsstoreoptions) → [AzureBlobsScopedStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → StoreOptions → [AzureBlobsStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md) → [AzureBlobsScopedStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsscopedstoreoptions.md)
    Implements IStoreOptions, INamedElementOptions, IAzureStorageOptions, IScopedStoreOptions ## Properties diff --git a/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md index 3231659..968c53a 100644 --- a/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md +++ b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md @@ -2,13 +2,13 @@ Namespace: Proffer.Storage.Azure.Blobs.Configuration -Options for an [AzureBlobsStore](./proffer.storage.azure.blobs.azureblobsstore). +Options for an [AzureBlobsStore](./proffer.storage.azure.blobs.azureblobsstore.md). ```csharp public class AzureBlobsStoreOptions : Proffer.Storage.Configuration.StoreOptions, Proffer.Storage.Configuration.IStoreOptions, Proffer.Configuration.INamedElementOptions, Proffer.Azure.Configuration.IAzureStorageOptions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → StoreOptions → [AzureBlobsStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsstoreoptions)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → StoreOptions → [AzureBlobsStoreOptions](./proffer.storage.azure.blobs.configuration.azureblobsstoreoptions.md)
    Implements IStoreOptions, INamedElementOptions, IAzureStorageOptions ## Properties diff --git a/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md index c1062e7..c847c9f 100644 --- a/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md +++ b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobsfileproperties.md @@ -8,7 +8,7 @@ File common properties with metadata stored on Azure Blobs. public class AzureBlobsFileProperties : Proffer.Storage.IFileProperties ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [AzureBlobsFileProperties](./proffer.storage.azure.blobs.internal.azureblobsfileproperties)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [AzureBlobsFileProperties](./proffer.storage.azure.blobs.internal.azureblobsfileproperties.md)
    Implements IFileProperties ## Properties @@ -101,7 +101,7 @@ public IDictionary Metadata { get; } ### **AzureBlobsFileProperties(BlobClient, BlobProperties)** -Initializes a new instance of the [AzureBlobsFileProperties](./proffer.storage.azure.blobs.internal.azureblobsfileproperties) class. +Initializes a new instance of the [AzureBlobsFileProperties](./proffer.storage.azure.blobs.internal.azureblobsfileproperties.md) class. ```csharp public AzureBlobsFileProperties(BlobClient blobClient, BlobProperties blobProperties) @@ -117,7 +117,7 @@ The blob properties. ### **AzureBlobsFileProperties(BlobClient, BlobItem)** -Initializes a new instance of the [AzureBlobsFileProperties](./proffer.storage.azure.blobs.internal.azureblobsfileproperties) class. +Initializes a new instance of the [AzureBlobsFileProperties](./proffer.storage.azure.blobs.internal.azureblobsfileproperties.md) class. ```csharp public AzureBlobsFileProperties(BlobClient blobClient, BlobItem blobItem) diff --git a/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobsfilereference.md b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobsfilereference.md index 49155ce..bf9e5a5 100644 --- a/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobsfilereference.md +++ b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobsfilereference.md @@ -8,7 +8,7 @@ A reference of a stored file at a given path on Azure Blobs. public class AzureBlobsFileReference : Proffer.Storage.IFileReference, Proffer.Storage.IPrivateFileReference ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [AzureBlobsFileReference](./proffer.storage.azure.blobs.internal.azureblobsfilereference)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [AzureBlobsFileReference](./proffer.storage.azure.blobs.internal.azureblobsfilereference.md)
    Implements IFileReference, IPrivateFileReference ## Properties @@ -53,7 +53,7 @@ public string PublicUrl { get; } ### **AzureBlobsFileReference(BlobClient, AzureBlobsFileProperties)** -Initializes a new instance of the [AzureBlobsFileReference](./proffer.storage.azure.blobs.internal.azureblobsfilereference) class. +Initializes a new instance of the [AzureBlobsFileReference](./proffer.storage.azure.blobs.internal.azureblobsfilereference.md) class. ```csharp public AzureBlobsFileReference(BlobClient blobClient, AzureBlobsFileProperties properties) @@ -64,7 +64,7 @@ public AzureBlobsFileReference(BlobClient blobClient, AzureBlobsFileProperties p `blobClient` BlobClient
    The Azure Blobs client. -`properties` [AzureBlobsFileProperties](./proffer.storage.azure.blobs.internal.azureblobsfileproperties)
    +`properties` [AzureBlobsFileProperties](./proffer.storage.azure.blobs.internal.azureblobsfileproperties.md)
    The properties, if fetched. ## Methods diff --git a/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md index 3a6aebc..cf20419 100644 --- a/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md +++ b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md @@ -2,13 +2,13 @@ Namespace: Proffer.Storage.Azure.Blobs.Internal -Represents a directory in a being-listed [AzureBlobsStore](./proffer.storage.azure.blobs.azureblobsstore). +Represents a directory in a being-listed [AzureBlobsStore](./proffer.storage.azure.blobs.azureblobsstore.md). ```csharp public class AzureBlobsListDirectoryWrapper : Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → FileSystemInfoBase → DirectoryInfoBase → [AzureBlobsListDirectoryWrapper](./proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → FileSystemInfoBase → DirectoryInfoBase → [AzureBlobsListDirectoryWrapper](./proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md) ## Properties @@ -52,7 +52,7 @@ DirectoryInfoBase
    ### **AzureBlobsListDirectoryWrapper(FileSystemInfoBase)** -Initializes a new instance of the [AzureBlobsListDirectoryWrapper](./proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper) class. +Initializes a new instance of the [AzureBlobsListDirectoryWrapper](./proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md) class. ```csharp public AzureBlobsListDirectoryWrapper(FileSystemInfoBase childrens) @@ -65,7 +65,7 @@ The childrens. ### **AzureBlobsListDirectoryWrapper(String, Dictionary<String, AzureBlobsFileReference>)** -Initializes a new instance of the [AzureBlobsListDirectoryWrapper](./proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper) class. +Initializes a new instance of the [AzureBlobsListDirectoryWrapper](./proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md) class. ```csharp public AzureBlobsListDirectoryWrapper(string path, Dictionary files) diff --git a/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md index cb8da1a..7dc4996 100644 --- a/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md +++ b/docs/api/storage/azure/blobs/proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md @@ -2,13 +2,13 @@ Namespace: Proffer.Storage.Azure.Blobs.Internal -Represents a file in a being-listed [AzureBlobsStore](./proffer.storage.azure.blobs.azureblobsstore). +Represents a file in a being-listed [AzureBlobsStore](./proffer.storage.azure.blobs.azureblobsstore.md). ```csharp public class AzureBlobsListFileWrapper : Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoBase ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → FileSystemInfoBase → FileInfoBase → [AzureBlobsListFileWrapper](./proffer.storage.azure.blobs.internal.azureblobslistfilewrapper) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → FileSystemInfoBase → FileInfoBase → [AzureBlobsListFileWrapper](./proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md) ## Properties @@ -52,7 +52,7 @@ DirectoryInfoBase
    ### **AzureBlobsListFileWrapper(AzureBlobsFileReference, AzureBlobsListDirectoryWrapper)** -Initializes a new instance of the [AzureBlobsListFileWrapper](./proffer.storage.azure.blobs.internal.azureblobslistfilewrapper) class. +Initializes a new instance of the [AzureBlobsListFileWrapper](./proffer.storage.azure.blobs.internal.azureblobslistfilewrapper.md) class. ```csharp public AzureBlobsListFileWrapper(AzureBlobsFileReference file, AzureBlobsListDirectoryWrapper parent) @@ -60,8 +60,8 @@ public AzureBlobsListFileWrapper(AzureBlobsFileReference file, AzureBlobsListDir #### Parameters -`file` [AzureBlobsFileReference](./proffer.storage.azure.blobs.internal.azureblobsfilereference)
    +`file` [AzureBlobsFileReference](./proffer.storage.azure.blobs.internal.azureblobsfilereference.md)
    The file reference. -`parent` [AzureBlobsListDirectoryWrapper](./proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper)
    +`parent` [AzureBlobsListDirectoryWrapper](./proffer.storage.azure.blobs.internal.azureblobslistdirectorywrapper.md)
    The parent directory. diff --git a/docs/api/storage/azure/blobs/proffer.storage.azureblobsstorageservicecollectionextensions.md b/docs/api/storage/azure/blobs/proffer.storage.azureblobsstorageservicecollectionextensions.md index 987bd9b..186ab23 100644 --- a/docs/api/storage/azure/blobs/proffer.storage.azureblobsstorageservicecollectionextensions.md +++ b/docs/api/storage/azure/blobs/proffer.storage.azureblobsstorageservicecollectionextensions.md @@ -8,7 +8,7 @@ Microsoft.Extensions.DependencyInjection.IServiceCollection extension methods. public static class AzureBlobsStorageServiceCollectionExtensions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [AzureBlobsStorageServiceCollectionExtensions](./proffer.storage.azureblobsstorageservicecollectionextensions) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [AzureBlobsStorageServiceCollectionExtensions](./proffer.storage.azureblobsstorageservicecollectionextensions.md) ## Methods diff --git a/docs/api/storage/filesystem/index.md b/docs/api/storage/filesystem/index.md index 343ef6e..a8c121b 100644 --- a/docs/api/storage/filesystem/index.md +++ b/docs/api/storage/filesystem/index.md @@ -2,34 +2,34 @@ ## Proffer.Storage -[FileSystemStorageServiceCollectionExtensions](./proffer.storage.filesystemstorageservicecollectionextensions) +[FileSystemStorageServiceCollectionExtensions](./proffer.storage.filesystemstorageservicecollectionextensions.md) ## Proffer.Storage.FileSystem -[FileSystemStorageProvider](./proffer.storage.filesystem.filesystemstorageprovider) +[FileSystemStorageProvider](./proffer.storage.filesystem.filesystemstorageprovider.md) -[FileSystemStore](./proffer.storage.filesystem.filesystemstore) +[FileSystemStore](./proffer.storage.filesystem.filesystemstore.md) -[IExtendedPropertiesProvider](./proffer.storage.filesystem.iextendedpropertiesprovider) +[IExtendedPropertiesProvider](./proffer.storage.filesystem.iextendedpropertiesprovider.md) -[IPublicUrlProvider](./proffer.storage.filesystem.ipublicurlprovider) +[IPublicUrlProvider](./proffer.storage.filesystem.ipublicurlprovider.md) -[NoExtendedPropertiesProvider](./proffer.storage.filesystem.noextendedpropertiesprovider) +[NoExtendedPropertiesProvider](./proffer.storage.filesystem.noextendedpropertiesprovider.md) ## Proffer.Storage.FileSystem.Configuration -[FileSystemParsedOptions](./proffer.storage.filesystem.configuration.filesystemparsedoptions) +[FileSystemParsedOptions](./proffer.storage.filesystem.configuration.filesystemparsedoptions.md) -[FileSystemProviderOptions](./proffer.storage.filesystem.configuration.filesystemprovideroptions) +[FileSystemProviderOptions](./proffer.storage.filesystem.configuration.filesystemprovideroptions.md) -[FileSystemScopedStoreOptions](./proffer.storage.filesystem.configuration.filesystemscopedstoreoptions) +[FileSystemScopedStoreOptions](./proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md) -[FileSystemStoreOptions](./proffer.storage.filesystem.configuration.filesystemstoreoptions) +[FileSystemStoreOptions](./proffer.storage.filesystem.configuration.filesystemstoreoptions.md) ## Proffer.Storage.FileSystem.Internal -[FileExtendedProperties](./proffer.storage.filesystem.internal.fileextendedproperties) +[FileExtendedProperties](./proffer.storage.filesystem.internal.fileextendedproperties.md) -[FileSystemFileProperties](./proffer.storage.filesystem.internal.filesystemfileproperties) +[FileSystemFileProperties](./proffer.storage.filesystem.internal.filesystemfileproperties.md) -[FileSystemFileReference](./proffer.storage.filesystem.internal.filesystemfilereference) +[FileSystemFileReference](./proffer.storage.filesystem.internal.filesystemfilereference.md) diff --git a/docs/api/storage/filesystem/proffer.storage.filesystem.configuration.filesystemparsedoptions.md b/docs/api/storage/filesystem/proffer.storage.filesystem.configuration.filesystemparsedoptions.md index 0ad05b8..0c28beb 100644 --- a/docs/api/storage/filesystem/proffer.storage.filesystem.configuration.filesystemparsedoptions.md +++ b/docs/api/storage/filesystem/proffer.storage.filesystem.configuration.filesystemparsedoptions.md @@ -8,7 +8,7 @@ Typed File System options parsed from the dynamic configuration. public class FileSystemParsedOptions : Proffer.Storage.Configuration.IParsedOptions`3[[Proffer.Storage.FileSystem.Configuration.FileSystemProviderOptions, Proffer.Storage.FileSystem, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[Proffer.Storage.FileSystem.Configuration.FileSystemStoreOptions, Proffer.Storage.FileSystem, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[Proffer.Storage.FileSystem.Configuration.FileSystemScopedStoreOptions, Proffer.Storage.FileSystem, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemParsedOptions](./proffer.storage.filesystem.configuration.filesystemparsedoptions)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemParsedOptions](./proffer.storage.filesystem.configuration.filesystemparsedoptions.md)
    Implements IParsedOptions<FileSystemProviderOptions, FileSystemStoreOptions, FileSystemScopedStoreOptions> ## Properties @@ -107,7 +107,7 @@ public void BindProviderOptions(FileSystemProviderOptions providerInstanceOption #### Parameters -`providerInstanceOptions` [FileSystemProviderOptions](./proffer.storage.filesystem.configuration.filesystemprovideroptions)
    +`providerInstanceOptions` [FileSystemProviderOptions](./proffer.storage.filesystem.configuration.filesystemprovideroptions.md)
    The provider instance options. ### **BindStoreOptions(FileSystemStoreOptions, FileSystemProviderOptions)** @@ -120,8 +120,8 @@ public void BindStoreOptions(FileSystemStoreOptions storeOptions, FileSystemProv #### Parameters -`storeOptions` [FileSystemStoreOptions](./proffer.storage.filesystem.configuration.filesystemstoreoptions)
    +`storeOptions` [FileSystemStoreOptions](./proffer.storage.filesystem.configuration.filesystemstoreoptions.md)
    The store options. -`providerInstanceOptions` [FileSystemProviderOptions](./proffer.storage.filesystem.configuration.filesystemprovideroptions)
    +`providerInstanceOptions` [FileSystemProviderOptions](./proffer.storage.filesystem.configuration.filesystemprovideroptions.md)
    The provider instance options. diff --git a/docs/api/storage/filesystem/proffer.storage.filesystem.configuration.filesystemprovideroptions.md b/docs/api/storage/filesystem/proffer.storage.filesystem.configuration.filesystemprovideroptions.md index afefdcd..1ac5ad3 100644 --- a/docs/api/storage/filesystem/proffer.storage.filesystem.configuration.filesystemprovideroptions.md +++ b/docs/api/storage/filesystem/proffer.storage.filesystem.configuration.filesystemprovideroptions.md @@ -2,13 +2,13 @@ Namespace: Proffer.Storage.FileSystem.Configuration -Options for a [FileSystemStorageProvider](./proffer.storage.filesystem.filesystemstorageprovider). +Options for a [FileSystemStorageProvider](./proffer.storage.filesystem.filesystemstorageprovider.md). ```csharp public class FileSystemProviderOptions : Proffer.Configuration.ProviderOptions, Proffer.Configuration.IProviderOptions, Proffer.Configuration.INamedElementOptions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → ProviderOptions → [FileSystemProviderOptions](./proffer.storage.filesystem.configuration.filesystemprovideroptions)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → ProviderOptions → [FileSystemProviderOptions](./proffer.storage.filesystem.configuration.filesystemprovideroptions.md)
    Implements IProviderOptions, INamedElementOptions ## Properties diff --git a/docs/api/storage/filesystem/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md b/docs/api/storage/filesystem/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md index cbbc749..3b43e20 100644 --- a/docs/api/storage/filesystem/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md +++ b/docs/api/storage/filesystem/proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md @@ -2,13 +2,13 @@ Namespace: Proffer.Storage.FileSystem.Configuration -Options for a scoped [FileSystemStore](./proffer.storage.filesystem.filesystemstore). +Options for a scoped [FileSystemStore](./proffer.storage.filesystem.filesystemstore.md). ```csharp public class FileSystemScopedStoreOptions : FileSystemStoreOptions, Proffer.Storage.Configuration.IStoreOptions, Proffer.Configuration.INamedElementOptions, Proffer.Storage.Configuration.IScopedStoreOptions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → StoreOptions → [FileSystemStoreOptions](./proffer.storage.filesystem.configuration.filesystemstoreoptions) → [FileSystemScopedStoreOptions](./proffer.storage.filesystem.configuration.filesystemscopedstoreoptions)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → StoreOptions → [FileSystemStoreOptions](./proffer.storage.filesystem.configuration.filesystemstoreoptions.md) → [FileSystemScopedStoreOptions](./proffer.storage.filesystem.configuration.filesystemscopedstoreoptions.md)
    Implements IStoreOptions, INamedElementOptions, IScopedStoreOptions ## Properties diff --git a/docs/api/storage/filesystem/proffer.storage.filesystem.configuration.filesystemstoreoptions.md b/docs/api/storage/filesystem/proffer.storage.filesystem.configuration.filesystemstoreoptions.md index 5d71d1b..0f87cce 100644 --- a/docs/api/storage/filesystem/proffer.storage.filesystem.configuration.filesystemstoreoptions.md +++ b/docs/api/storage/filesystem/proffer.storage.filesystem.configuration.filesystemstoreoptions.md @@ -2,13 +2,13 @@ Namespace: Proffer.Storage.FileSystem.Configuration -Options for an [FileSystemStore](./proffer.storage.filesystem.filesystemstore). +Options for an [FileSystemStore](./proffer.storage.filesystem.filesystemstore.md). ```csharp public class FileSystemStoreOptions : Proffer.Storage.Configuration.StoreOptions, Proffer.Storage.Configuration.IStoreOptions, Proffer.Configuration.INamedElementOptions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → StoreOptions → [FileSystemStoreOptions](./proffer.storage.filesystem.configuration.filesystemstoreoptions)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → StoreOptions → [FileSystemStoreOptions](./proffer.storage.filesystem.configuration.filesystemstoreoptions.md)
    Implements IStoreOptions, INamedElementOptions ## Properties diff --git a/docs/api/storage/filesystem/proffer.storage.filesystem.filesystemstorageprovider.md b/docs/api/storage/filesystem/proffer.storage.filesystem.filesystemstorageprovider.md index 075f588..52aa92c 100644 --- a/docs/api/storage/filesystem/proffer.storage.filesystem.filesystemstorageprovider.md +++ b/docs/api/storage/filesystem/proffer.storage.filesystem.filesystemstorageprovider.md @@ -8,14 +8,14 @@ A provider to handle and build file stores pointing on a File System directory. public class FileSystemStorageProvider : Proffer.Storage.Internal.StorageProviderBase`4[[Proffer.Storage.FileSystem.Configuration.FileSystemParsedOptions, Proffer.Storage.FileSystem, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[Proffer.Storage.FileSystem.Configuration.FileSystemProviderOptions, Proffer.Storage.FileSystem, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[Proffer.Storage.FileSystem.Configuration.FileSystemStoreOptions, Proffer.Storage.FileSystem, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[Proffer.Storage.FileSystem.Configuration.FileSystemScopedStoreOptions, Proffer.Storage.FileSystem, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Proffer.Storage.IStorageProvider ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → StorageProviderBase<FileSystemParsedOptions, FileSystemProviderOptions, FileSystemStoreOptions, FileSystemScopedStoreOptions> → [FileSystemStorageProvider](./proffer.storage.filesystem.filesystemstorageprovider)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → StorageProviderBase<FileSystemParsedOptions, FileSystemProviderOptions, FileSystemStoreOptions, FileSystemScopedStoreOptions> → [FileSystemStorageProvider](./proffer.storage.filesystem.filesystemstorageprovider.md)
    Implements IStorageProvider ## Fields ### **ProviderName** -The [FileSystemStorageProvider](./proffer.storage.filesystem.filesystemstorageprovider) name. +The [FileSystemStorageProvider](./proffer.storage.filesystem.filesystemstorageprovider.md) name. ```csharp public static string ProviderName; @@ -39,7 +39,7 @@ public string Name { get; } ### **FileSystemStorageProvider(IOptions<FileSystemParsedOptions>, IPublicUrlProvider, IExtendedPropertiesProvider)** -Initializes a new instance of the [FileSystemStorageProvider](./proffer.storage.filesystem.filesystemstorageprovider) class. +Initializes a new instance of the [FileSystemStorageProvider](./proffer.storage.filesystem.filesystemstorageprovider.md) class. ```csharp public FileSystemStorageProvider(IOptions options, IPublicUrlProvider publicUrlProvider, IExtendedPropertiesProvider extendedPropertiesProvider) @@ -50,10 +50,10 @@ public FileSystemStorageProvider(IOptions options, IPub `options` IOptions<FileSystemParsedOptions>
    The options. -`publicUrlProvider` [IPublicUrlProvider](./proffer.storage.filesystem.ipublicurlprovider)
    +`publicUrlProvider` [IPublicUrlProvider](./proffer.storage.filesystem.ipublicurlprovider.md)
    The public URL provider. -`extendedPropertiesProvider` [IExtendedPropertiesProvider](./proffer.storage.filesystem.iextendedpropertiesprovider)
    +`extendedPropertiesProvider` [IExtendedPropertiesProvider](./proffer.storage.filesystem.iextendedpropertiesprovider.md)
    The extended properties provider. ## Methods @@ -71,7 +71,7 @@ protected IStore BuildStoreInternal(string storeName, FileSystemStoreOptions sto `storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    The name of the store. -`storeOptions` [FileSystemStoreOptions](./proffer.storage.filesystem.configuration.filesystemstoreoptions)
    +`storeOptions` [FileSystemStoreOptions](./proffer.storage.filesystem.configuration.filesystemstoreoptions.md)
    The store options. #### Returns diff --git a/docs/api/storage/filesystem/proffer.storage.filesystem.filesystemstore.md b/docs/api/storage/filesystem/proffer.storage.filesystem.filesystemstore.md index b745773..91f7cff 100644 --- a/docs/api/storage/filesystem/proffer.storage.filesystem.filesystemstore.md +++ b/docs/api/storage/filesystem/proffer.storage.filesystem.filesystemstore.md @@ -2,13 +2,13 @@ Namespace: Proffer.Storage.FileSystem -A File System store allows to save, list or read files on a container in its configured [FileSystemStorageProvider](./proffer.storage.filesystem.filesystemstorageprovider). +A File System store allows to save, list or read files on a container in its configured [FileSystemStorageProvider](./proffer.storage.filesystem.filesystemstorageprovider.md). ```csharp public class FileSystemStore : Proffer.Storage.IStore ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemStore](./proffer.storage.filesystem.filesystemstore)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemStore](./proffer.storage.filesystem.filesystemstore.md)
    Implements IStore ## Properties @@ -29,7 +29,7 @@ public string Name { get; } ### **FileSystemStore(FileSystemStoreOptions, IPublicUrlProvider, IExtendedPropertiesProvider)** -Initializes a new instance of the [FileSystemStore](./proffer.storage.filesystem.filesystemstore) class. +Initializes a new instance of the [FileSystemStore](./proffer.storage.filesystem.filesystemstore.md) class. ```csharp public FileSystemStore(FileSystemStoreOptions storeOptions, IPublicUrlProvider publicUrlProvider, IExtendedPropertiesProvider extendedPropertiesProvider) @@ -37,13 +37,13 @@ public FileSystemStore(FileSystemStoreOptions storeOptions, IPublicUrlProvider p #### Parameters -`storeOptions` [FileSystemStoreOptions](./proffer.storage.filesystem.configuration.filesystemstoreoptions)
    +`storeOptions` [FileSystemStoreOptions](./proffer.storage.filesystem.configuration.filesystemstoreoptions.md)
    The store options. -`publicUrlProvider` [IPublicUrlProvider](./proffer.storage.filesystem.ipublicurlprovider)
    +`publicUrlProvider` [IPublicUrlProvider](./proffer.storage.filesystem.ipublicurlprovider.md)
    The public URL provider. -`extendedPropertiesProvider` [IExtendedPropertiesProvider](./proffer.storage.filesystem.iextendedpropertiesprovider)
    +`extendedPropertiesProvider` [IExtendedPropertiesProvider](./proffer.storage.filesystem.iextendedpropertiesprovider.md)
    The extended properties provider. ## Methods diff --git a/docs/api/storage/filesystem/proffer.storage.filesystem.iextendedpropertiesprovider.md b/docs/api/storage/filesystem/proffer.storage.filesystem.iextendedpropertiesprovider.md index 8401cb9..42e6841 100644 --- a/docs/api/storage/filesystem/proffer.storage.filesystem.iextendedpropertiesprovider.md +++ b/docs/api/storage/filesystem/proffer.storage.filesystem.iextendedpropertiesprovider.md @@ -47,7 +47,7 @@ The store absolute path. `file` IPrivateFileReference
    The reference holding the file path. -`extendedProperties` [FileExtendedProperties](./proffer.storage.filesystem.internal.fileextendedproperties)
    +`extendedProperties` [FileExtendedProperties](./proffer.storage.filesystem.internal.fileextendedproperties.md)
    The extended properties. #### Returns diff --git a/docs/api/storage/filesystem/proffer.storage.filesystem.internal.fileextendedproperties.md b/docs/api/storage/filesystem/proffer.storage.filesystem.internal.fileextendedproperties.md index 375879f..e07c5aa 100644 --- a/docs/api/storage/filesystem/proffer.storage.filesystem.internal.fileextendedproperties.md +++ b/docs/api/storage/filesystem/proffer.storage.filesystem.internal.fileextendedproperties.md @@ -8,7 +8,7 @@ Extends standard file properties to match the requirements of Proffer.Storage.IF public class FileExtendedProperties ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileExtendedProperties](./proffer.storage.filesystem.internal.fileextendedproperties) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileExtendedProperties](./proffer.storage.filesystem.internal.fileextendedproperties.md) ## Properties @@ -76,7 +76,7 @@ public IDictionary Metadata { get; set; } ### **FileExtendedProperties()** -Initializes a new instance of the [FileExtendedProperties](./proffer.storage.filesystem.internal.fileextendedproperties) class. +Initializes a new instance of the [FileExtendedProperties](./proffer.storage.filesystem.internal.fileextendedproperties.md) class. ```csharp public FileExtendedProperties() diff --git a/docs/api/storage/filesystem/proffer.storage.filesystem.internal.filesystemfileproperties.md b/docs/api/storage/filesystem/proffer.storage.filesystem.internal.filesystemfileproperties.md index 536b229..040824a 100644 --- a/docs/api/storage/filesystem/proffer.storage.filesystem.internal.filesystemfileproperties.md +++ b/docs/api/storage/filesystem/proffer.storage.filesystem.internal.filesystemfileproperties.md @@ -8,7 +8,7 @@ File common properties with metadata stored on a File System. public class FileSystemFileProperties : Proffer.Storage.IFileProperties ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemFileProperties](./proffer.storage.filesystem.internal.filesystemfileproperties)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemFileProperties](./proffer.storage.filesystem.internal.filesystemfileproperties.md)
    Implements IFileProperties ## Properties @@ -101,7 +101,7 @@ public IDictionary Metadata { get; } ### **FileSystemFileProperties(String, FileExtendedProperties)** -Initializes a new instance of the [FileSystemFileProperties](./proffer.storage.filesystem.internal.filesystemfileproperties) class. +Initializes a new instance of the [FileSystemFileProperties](./proffer.storage.filesystem.internal.filesystemfileproperties.md) class. ```csharp public FileSystemFileProperties(string fileSystemPath, FileExtendedProperties extendedProperties) @@ -112,5 +112,5 @@ public FileSystemFileProperties(string fileSystemPath, FileExtendedProperties ex `fileSystemPath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    The file system path. -`extendedProperties` [FileExtendedProperties](./proffer.storage.filesystem.internal.fileextendedproperties)
    +`extendedProperties` [FileExtendedProperties](./proffer.storage.filesystem.internal.fileextendedproperties.md)
    The extended properties. diff --git a/docs/api/storage/filesystem/proffer.storage.filesystem.internal.filesystemfilereference.md b/docs/api/storage/filesystem/proffer.storage.filesystem.internal.filesystemfilereference.md index ade0371..c13923b 100644 --- a/docs/api/storage/filesystem/proffer.storage.filesystem.internal.filesystemfilereference.md +++ b/docs/api/storage/filesystem/proffer.storage.filesystem.internal.filesystemfilereference.md @@ -8,7 +8,7 @@ A reference of a stored file at a given path on a File System. public class FileSystemFileReference : Proffer.Storage.IFileReference, Proffer.Storage.IPrivateFileReference ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemFileReference](./proffer.storage.filesystem.internal.filesystemfilereference)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemFileReference](./proffer.storage.filesystem.internal.filesystemfilereference.md)
    Implements IFileReference, IPrivateFileReference ## Properties @@ -65,7 +65,7 @@ IFileProperties
    ### **FileSystemFileReference(String, String, FileSystemStore, Boolean, FileExtendedProperties, IPublicUrlProvider, IExtendedPropertiesProvider)** -Initializes a new instance of the [FileSystemFileReference](./proffer.storage.filesystem.internal.filesystemfilereference) class. +Initializes a new instance of the [FileSystemFileReference](./proffer.storage.filesystem.internal.filesystemfilereference.md) class. ```csharp public FileSystemFileReference(string filePath, string path, FileSystemStore store, bool withMetadata, FileExtendedProperties extendedProperties, IPublicUrlProvider publicUrlProvider, IExtendedPropertiesProvider extendedPropertiesProvider) @@ -79,19 +79,19 @@ The file system path. `path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    The path. -`store` [FileSystemStore](./proffer.storage.filesystem.filesystemstore)
    +`store` [FileSystemStore](./proffer.storage.filesystem.filesystemstore.md)
    The store. `withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
    If set to true, the metadata for the file have been fetched. -`extendedProperties` [FileExtendedProperties](./proffer.storage.filesystem.internal.fileextendedproperties)
    +`extendedProperties` [FileExtendedProperties](./proffer.storage.filesystem.internal.fileextendedproperties.md)
    The extended properties. -`publicUrlProvider` [IPublicUrlProvider](./proffer.storage.filesystem.ipublicurlprovider)
    +`publicUrlProvider` [IPublicUrlProvider](./proffer.storage.filesystem.ipublicurlprovider.md)
    The public URL provider. -`extendedPropertiesProvider` [IExtendedPropertiesProvider](./proffer.storage.filesystem.iextendedpropertiesprovider)
    +`extendedPropertiesProvider` [IExtendedPropertiesProvider](./proffer.storage.filesystem.iextendedpropertiesprovider.md)
    The extended properties provider. ## Methods diff --git a/docs/api/storage/filesystem/proffer.storage.filesystem.ipublicurlprovider.md b/docs/api/storage/filesystem/proffer.storage.filesystem.ipublicurlprovider.md index 5bb5cec..1c54441 100644 --- a/docs/api/storage/filesystem/proffer.storage.filesystem.ipublicurlprovider.md +++ b/docs/api/storage/filesystem/proffer.storage.filesystem.ipublicurlprovider.md @@ -23,7 +23,7 @@ string GetPublicUrl(string storeName, FileSystemFileReference file) `storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    The name of the store. -`file` [FileSystemFileReference](./proffer.storage.filesystem.internal.filesystemfilereference)
    +`file` [FileSystemFileReference](./proffer.storage.filesystem.internal.filesystemfilereference.md)
    The reference holding the file path. #### Returns diff --git a/docs/api/storage/filesystem/proffer.storage.filesystem.noextendedpropertiesprovider.md b/docs/api/storage/filesystem/proffer.storage.filesystem.noextendedpropertiesprovider.md index 948091b..7f31152 100644 --- a/docs/api/storage/filesystem/proffer.storage.filesystem.noextendedpropertiesprovider.md +++ b/docs/api/storage/filesystem/proffer.storage.filesystem.noextendedpropertiesprovider.md @@ -2,14 +2,14 @@ Namespace: Proffer.Storage.FileSystem -Default [IExtendedPropertiesProvider](./proffer.storage.filesystem.iextendedpropertiesprovider) without property storage capacity. +Default [IExtendedPropertiesProvider](./proffer.storage.filesystem.iextendedpropertiesprovider.md) without property storage capacity. ```csharp public class NoExtendedPropertiesProvider : IExtendedPropertiesProvider ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [NoExtendedPropertiesProvider](./proffer.storage.filesystem.noextendedpropertiesprovider)
    -Implements [IExtendedPropertiesProvider](./proffer.storage.filesystem.iextendedpropertiesprovider) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [NoExtendedPropertiesProvider](./proffer.storage.filesystem.noextendedpropertiesprovider.md)
    +Implements [IExtendedPropertiesProvider](./proffer.storage.filesystem.iextendedpropertiesprovider.md) ## Constructors @@ -60,7 +60,7 @@ The store absolute path. `file` IPrivateFileReference
    The reference holding the file path. -`extendedProperties` [FileExtendedProperties](./proffer.storage.filesystem.internal.fileextendedproperties)
    +`extendedProperties` [FileExtendedProperties](./proffer.storage.filesystem.internal.fileextendedproperties.md)
    The extended properties. #### Returns diff --git a/docs/api/storage/filesystem/proffer.storage.filesystemstorageservicecollectionextensions.md b/docs/api/storage/filesystem/proffer.storage.filesystemstorageservicecollectionextensions.md index 2281204..14606a9 100644 --- a/docs/api/storage/filesystem/proffer.storage.filesystemstorageservicecollectionextensions.md +++ b/docs/api/storage/filesystem/proffer.storage.filesystemstorageservicecollectionextensions.md @@ -8,7 +8,7 @@ Microsoft.Extensions.DependencyInjection.IServiceCollection extension methods. public static class FileSystemStorageServiceCollectionExtensions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemStorageServiceCollectionExtensions](./proffer.storage.filesystemstorageservicecollectionextensions) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemStorageServiceCollectionExtensions](./proffer.storage.filesystemstorageservicecollectionextensions.md) ## Methods diff --git a/docs/api/storage/filesystem/properties/json/index.md b/docs/api/storage/filesystem/properties/json/index.md index 740780c..74bdd83 100644 --- a/docs/api/storage/filesystem/properties/json/index.md +++ b/docs/api/storage/filesystem/properties/json/index.md @@ -2,12 +2,12 @@ ## Proffer.Storage -[FileSystemPropertiesJsonServiceCollectionExtensions](./proffer.storage.filesystempropertiesjsonservicecollectionextensions) +[FileSystemPropertiesJsonServiceCollectionExtensions](./proffer.storage.filesystempropertiesjsonservicecollectionextensions.md) ## Proffer.Storage.FileSystem.Properties.Json -[FileSystemPropertiesJsonOptions](./proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions) +[FileSystemPropertiesJsonOptions](./proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md) ## Proffer.Storage.FileSystem.Properties.Json.Internal -[ExtendedPropertiesProvider](./proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider) +[ExtendedPropertiesProvider](./proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md) diff --git a/docs/api/storage/filesystem/properties/json/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md b/docs/api/storage/filesystem/properties/json/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md index b0c4fb4..6dbc89f 100644 --- a/docs/api/storage/filesystem/properties/json/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md +++ b/docs/api/storage/filesystem/properties/json/proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md @@ -2,13 +2,13 @@ Namespace: Proffer.Storage.FileSystem.Properties.Json -Options for an [ExtendedPropertiesProvider](./proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider). +Options for an [ExtendedPropertiesProvider](./proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md). ```csharp public class FileSystemPropertiesJsonOptions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemPropertiesJsonOptions](./proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemPropertiesJsonOptions](./proffer.storage.filesystem.properties.json.filesystempropertiesjsonoptions.md) ## Properties diff --git a/docs/api/storage/filesystem/properties/json/proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md b/docs/api/storage/filesystem/properties/json/proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md index e5530fd..da37b76 100644 --- a/docs/api/storage/filesystem/properties/json/proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md +++ b/docs/api/storage/filesystem/properties/json/proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md @@ -8,14 +8,14 @@ Provides a way to store and retrieve extended file properties to match the requi public class ExtendedPropertiesProvider : Proffer.Storage.FileSystem.IExtendedPropertiesProvider ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ExtendedPropertiesProvider](./proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ExtendedPropertiesProvider](./proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md)
    Implements IExtendedPropertiesProvider ## Constructors ### **ExtendedPropertiesProvider(IOptions<FileSystemPropertiesJsonOptions>)** -Initializes a new instance of the [ExtendedPropertiesProvider](./proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider) class. +Initializes a new instance of the [ExtendedPropertiesProvider](./proffer.storage.filesystem.properties.json.internal.extendedpropertiesprovider.md) class. ```csharp public ExtendedPropertiesProvider(IOptions options) diff --git a/docs/api/storage/filesystem/properties/json/proffer.storage.filesystempropertiesjsonservicecollectionextensions.md b/docs/api/storage/filesystem/properties/json/proffer.storage.filesystempropertiesjsonservicecollectionextensions.md index d93ec18..0e74fb4 100644 --- a/docs/api/storage/filesystem/properties/json/proffer.storage.filesystempropertiesjsonservicecollectionextensions.md +++ b/docs/api/storage/filesystem/properties/json/proffer.storage.filesystempropertiesjsonservicecollectionextensions.md @@ -8,7 +8,7 @@ Microsoft.Extensions.DependencyInjection.IServiceCollection extension methods. public static class FileSystemPropertiesJsonServiceCollectionExtensions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemPropertiesJsonServiceCollectionExtensions](./proffer.storage.filesystempropertiesjsonservicecollectionextensions) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemPropertiesJsonServiceCollectionExtensions](./proffer.storage.filesystempropertiesjsonservicecollectionextensions.md) ## Methods diff --git a/docs/api/storage/filesystem/server/index.md b/docs/api/storage/filesystem/server/index.md index e005d4b..8767d1f 100644 --- a/docs/api/storage/filesystem/server/index.md +++ b/docs/api/storage/filesystem/server/index.md @@ -2,14 +2,14 @@ ## Proffer.Storage -[ServiceCollectionExtensions](./proffer.storage.servicecollectionextensions) +[ServiceCollectionExtensions](./proffer.storage.servicecollectionextensions.md) ## Proffer.Storage.FileSystem.Server -[FileSystemStorageServerMiddleware](./proffer.storage.filesystem.server.filesystemstorageservermiddleware) +[FileSystemStorageServerMiddleware](./proffer.storage.filesystem.server.filesystemstorageservermiddleware.md) -[FileSystemStorageServerOptions](./proffer.storage.filesystem.server.filesystemstorageserveroptions) +[FileSystemStorageServerOptions](./proffer.storage.filesystem.server.filesystemstorageserveroptions.md) ## Proffer.Storage.FileSystem.Server.Internal -[PublicUrlProvider](./proffer.storage.filesystem.server.internal.publicurlprovider) +[PublicUrlProvider](./proffer.storage.filesystem.server.internal.publicurlprovider.md) diff --git a/docs/api/storage/filesystem/server/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md b/docs/api/storage/filesystem/server/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md index e093922..70f3377 100644 --- a/docs/api/storage/filesystem/server/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md +++ b/docs/api/storage/filesystem/server/proffer.storage.filesystem.server.filesystemstorageservermiddleware.md @@ -8,13 +8,13 @@ ASP.NET Core middleware to serve over HTTP files stored in a Storage store. public class FileSystemStorageServerMiddleware ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemStorageServerMiddleware](./proffer.storage.filesystem.server.filesystemstorageservermiddleware) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemStorageServerMiddleware](./proffer.storage.filesystem.server.filesystemstorageservermiddleware.md) ## Constructors ### **FileSystemStorageServerMiddleware(RequestDelegate, IOptions<FileSystemStorageServerOptions>, ILogger<FileSystemStorageServerMiddleware>, IOptions<FileSystemParsedOptions>)** -Initializes a new instance of the [FileSystemStorageServerMiddleware](./proffer.storage.filesystem.server.filesystemstorageservermiddleware) class. +Initializes a new instance of the [FileSystemStorageServerMiddleware](./proffer.storage.filesystem.server.filesystemstorageservermiddleware.md) class. ```csharp public FileSystemStorageServerMiddleware(RequestDelegate next, IOptions serverOptions, ILogger logger, IOptions fileSystemParsedOptions) diff --git a/docs/api/storage/filesystem/server/proffer.storage.filesystem.server.filesystemstorageserveroptions.md b/docs/api/storage/filesystem/server/proffer.storage.filesystem.server.filesystemstorageserveroptions.md index f899ee7..9cc3702 100644 --- a/docs/api/storage/filesystem/server/proffer.storage.filesystem.server.filesystemstorageserveroptions.md +++ b/docs/api/storage/filesystem/server/proffer.storage.filesystem.server.filesystemstorageserveroptions.md @@ -2,13 +2,13 @@ Namespace: Proffer.Storage.FileSystem.Server -Options for a [FileSystemStorageServerMiddleware](./proffer.storage.filesystem.server.filesystemstorageservermiddleware). +Options for a [FileSystemStorageServerMiddleware](./proffer.storage.filesystem.server.filesystemstorageservermiddleware.md). ```csharp public class FileSystemStorageServerOptions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemStorageServerOptions](./proffer.storage.filesystem.server.filesystemstorageserveroptions) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FileSystemStorageServerOptions](./proffer.storage.filesystem.server.filesystemstorageserveroptions.md) ## Properties diff --git a/docs/api/storage/filesystem/server/proffer.storage.filesystem.server.internal.publicurlprovider.md b/docs/api/storage/filesystem/server/proffer.storage.filesystem.server.internal.publicurlprovider.md index 377e013..13e50dd 100644 --- a/docs/api/storage/filesystem/server/proffer.storage.filesystem.server.internal.publicurlprovider.md +++ b/docs/api/storage/filesystem/server/proffer.storage.filesystem.server.internal.publicurlprovider.md @@ -8,14 +8,14 @@ Provides a way to serve files from an HTTP URL on a File System using an ASP.NET public class PublicUrlProvider : Proffer.Storage.FileSystem.IPublicUrlProvider ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [PublicUrlProvider](./proffer.storage.filesystem.server.internal.publicurlprovider)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [PublicUrlProvider](./proffer.storage.filesystem.server.internal.publicurlprovider.md)
    Implements IPublicUrlProvider ## Constructors ### **PublicUrlProvider(IOptions<FileSystemStorageServerOptions>)** -Initializes a new instance of the [PublicUrlProvider](./proffer.storage.filesystem.server.internal.publicurlprovider) class. +Initializes a new instance of the [PublicUrlProvider](./proffer.storage.filesystem.server.internal.publicurlprovider.md) class. ```csharp public PublicUrlProvider(IOptions options) diff --git a/docs/api/storage/filesystem/server/proffer.storage.servicecollectionextensions.md b/docs/api/storage/filesystem/server/proffer.storage.servicecollectionextensions.md index 8809932..4033719 100644 --- a/docs/api/storage/filesystem/server/proffer.storage.servicecollectionextensions.md +++ b/docs/api/storage/filesystem/server/proffer.storage.servicecollectionextensions.md @@ -8,7 +8,7 @@ Microsoft.Extensions.DependencyInjection.IServiceCollection extension methods. public static class ServiceCollectionExtensions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ServiceCollectionExtensions](./proffer.storage.servicecollectionextensions) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ServiceCollectionExtensions](./proffer.storage.servicecollectionextensions.md) ## Methods @@ -35,7 +35,7 @@ The service collection. ### **UseFileSystemStorageServer(IApplicationBuilder)** -Adds a [FileSystemStorageServerMiddleware](./proffer.storage.filesystem.server.filesystemstorageservermiddleware) to the application's request pipeline. +Adds a [FileSystemStorageServerMiddleware](./proffer.storage.filesystem.server.filesystemstorageservermiddleware.md) to the application's request pipeline. ```csharp public static IApplicationBuilder UseFileSystemStorageServer(IApplicationBuilder app) diff --git a/docs/api/storage/index.md b/docs/api/storage/index.md index a94ec68..e76a3ea 100644 --- a/docs/api/storage/index.md +++ b/docs/api/storage/index.md @@ -2,74 +2,74 @@ ## Proffer.Storage -[IFileProperties](./proffer.storage.ifileproperties) +[IFileProperties](./proffer.storage.ifileproperties.md) -[IFileReference](./proffer.storage.ifilereference) +[IFileReference](./proffer.storage.ifilereference.md) -[IPrivateFileReference](./proffer.storage.iprivatefilereference) +[IPrivateFileReference](./proffer.storage.iprivatefilereference.md) -[ISharedAccessPolicy](./proffer.storage.isharedaccesspolicy) +[ISharedAccessPolicy](./proffer.storage.isharedaccesspolicy.md) -[IStorageFactory](./proffer.storage.istoragefactory) +[IStorageFactory](./proffer.storage.istoragefactory.md) -[IStorageProvider](./proffer.storage.istorageprovider) +[IStorageProvider](./proffer.storage.istorageprovider.md) -[IStore](./proffer.storage.istore) +[IStore](./proffer.storage.istore.md) -[IStore<TOptions>](./proffer.storage.istore-1) +[IStore<TOptions>](./proffer.storage.istore-1.md) -[IStoreExtensions](./proffer.storage.istoreextensions) +[IStoreExtensions](./proffer.storage.istoreextensions.md) -[OverwritePolicy](./proffer.storage.overwritepolicy) +[OverwritePolicy](./proffer.storage.overwritepolicy.md) -[SharedAccessPermissions](./proffer.storage.sharedaccesspermissions) +[SharedAccessPermissions](./proffer.storage.sharedaccesspermissions.md) -[SharedAccessPolicy](./proffer.storage.sharedaccesspolicy) +[SharedAccessPolicy](./proffer.storage.sharedaccesspolicy.md) -[StorageServiceCollectionExtensions](./proffer.storage.storageservicecollectionextensions) +[StorageServiceCollectionExtensions](./proffer.storage.storageservicecollectionextensions.md) -[StoreBase](./proffer.storage.storebase) +[StoreBase](./proffer.storage.storebase.md) ## Proffer.Storage.Configuration -[AccessLevel](./proffer.storage.configuration.accesslevel) +[AccessLevel](./proffer.storage.configuration.accesslevel.md) -[ConfigurationExtensions](./proffer.storage.configuration.configurationextensions) +[ConfigurationExtensions](./proffer.storage.configuration.configurationextensions.md) -[IParsedOptions<TProviderOptions, TStoreOptions, TScopedStoreOptions>](./proffer.storage.configuration.iparsedoptions-3) +[IParsedOptions<TProviderOptions, TStoreOptions, TScopedStoreOptions>](./proffer.storage.configuration.iparsedoptions-3.md) -[IScopedStoreOptions](./proffer.storage.configuration.iscopedstoreoptions) +[IScopedStoreOptions](./proffer.storage.configuration.iscopedstoreoptions.md) -[IStoreOptions](./proffer.storage.configuration.istoreoptions) +[IStoreOptions](./proffer.storage.configuration.istoreoptions.md) -[ScopedStoreOptions](./proffer.storage.configuration.scopedstoreoptions) +[ScopedStoreOptions](./proffer.storage.configuration.scopedstoreoptions.md) -[StorageOptions](./proffer.storage.configuration.storageoptions) +[StorageOptions](./proffer.storage.configuration.storageoptions.md) -[StoreOptions](./proffer.storage.configuration.storeoptions) +[StoreOptions](./proffer.storage.configuration.storeoptions.md) ## Proffer.Storage.Exceptions -[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration) +[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration.md) -[BadScopedStoreConfiguration](./proffer.storage.exceptions.badscopedstoreconfiguration) +[BadScopedStoreConfiguration](./proffer.storage.exceptions.badscopedstoreconfiguration.md) -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration) +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration.md) -[FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception) +[FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception.md) -[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception) +[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception.md) -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception) +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception.md) ## Proffer.Storage.Internal -[ConfigureProviderOptions<TParsedOptions, TProviderOptions, TStoreOptions, TScopedStoreOptions>](./proffer.storage.internal.configureprovideroptions-4) +[ConfigureProviderOptions<TParsedOptions, TProviderOptions, TStoreOptions, TScopedStoreOptions>](./proffer.storage.internal.configureprovideroptions-4.md) -[GenericStoreProxy<TOptions>](./proffer.storage.internal.genericstoreproxy-1) +[GenericStoreProxy<TOptions>](./proffer.storage.internal.genericstoreproxy-1.md) -[PrivateFileReference](./proffer.storage.internal.privatefilereference) +[PrivateFileReference](./proffer.storage.internal.privatefilereference.md) -[StorageFactory](./proffer.storage.internal.storagefactory) +[StorageFactory](./proffer.storage.internal.storagefactory.md) -[StorageProviderBase<TParsedOptions, TInstanceOptions, TStoreOptions, TScopedStoreOptions>](./proffer.storage.internal.storageproviderbase-4) +[StorageProviderBase<TParsedOptions, TInstanceOptions, TStoreOptions, TScopedStoreOptions>](./proffer.storage.internal.storageproviderbase-4.md) diff --git a/docs/api/storage/proffer.storage.configuration.accesslevel.md b/docs/api/storage/proffer.storage.configuration.accesslevel.md index 74f7a34..d04f23a 100644 --- a/docs/api/storage/proffer.storage.configuration.accesslevel.md +++ b/docs/api/storage/proffer.storage.configuration.accesslevel.md @@ -8,7 +8,7 @@ Defines a store access level. public enum AccessLevel ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ValueType](https://docs.microsoft.com/en-us/dotnet/api/system.valuetype) → [Enum](https://docs.microsoft.com/en-us/dotnet/api/system.enum) → [AccessLevel](./proffer.storage.configuration.accesslevel)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ValueType](https://docs.microsoft.com/en-us/dotnet/api/system.valuetype) → [Enum](https://docs.microsoft.com/en-us/dotnet/api/system.enum) → [AccessLevel](./proffer.storage.configuration.accesslevel.md)
    Implements [IComparable](https://docs.microsoft.com/en-us/dotnet/api/system.icomparable), [IFormattable](https://docs.microsoft.com/en-us/dotnet/api/system.iformattable), [IConvertible](https://docs.microsoft.com/en-us/dotnet/api/system.iconvertible) ## Fields diff --git a/docs/api/storage/proffer.storage.configuration.configurationextensions.md b/docs/api/storage/proffer.storage.configuration.configurationextensions.md index 41d2c3c..ba7323c 100644 --- a/docs/api/storage/proffer.storage.configuration.configurationextensions.md +++ b/docs/api/storage/proffer.storage.configuration.configurationextensions.md @@ -8,7 +8,7 @@ Extensions methods to parse and bind options. public static class ConfigurationExtensions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ConfigurationExtensions](./proffer.storage.configuration.configurationextensions) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ConfigurationExtensions](./proffer.storage.configuration.configurationextensions.md) ## Methods @@ -72,7 +72,7 @@ The typed store configuration. #### Exceptions -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
    +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception.md)
    ### **GetScopedStoreConfiguration<TInstanceOptions, TStoreOptions, TScopedStoreOptions>(IParsedOptions<TInstanceOptions, TStoreOptions, TScopedStoreOptions>, String, Boolean)** @@ -111,7 +111,7 @@ The typed scoped store configuration. #### Exceptions -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
    +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception.md)
    ### **Compute<TParsedOptions, TProviderOptions, TStoreOptions, TScopedStoreOptions>(TProviderOptions, TParsedOptions)** @@ -145,7 +145,7 @@ The options. #### Exceptions -[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
    +[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration.md)
    ### **Compute<TParsedOptions, TInstanceOptions, TStoreOptions, TScopedStoreOptions>(TStoreOptions, TParsedOptions)** @@ -179,7 +179,7 @@ The options. #### Exceptions -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
    +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration.md)
    ### **ParseStoreOptions<TParsedOptions, TInstanceOptions, TStoreOptions, TScopedStoreOptions>(IStoreOptions, TParsedOptions)** @@ -205,7 +205,7 @@ The type of the scoped store options. #### Parameters -`storeOptions` [IStoreOptions](./proffer.storage.configuration.istoreoptions)
    +`storeOptions` [IStoreOptions](./proffer.storage.configuration.istoreoptions.md)
    The store options. `options` TParsedOptions
    diff --git a/docs/api/storage/proffer.storage.configuration.iparsedoptions-3.md b/docs/api/storage/proffer.storage.configuration.iparsedoptions-3.md index 358d370..5547e64 100644 --- a/docs/api/storage/proffer.storage.configuration.iparsedoptions-3.md +++ b/docs/api/storage/proffer.storage.configuration.iparsedoptions-3.md @@ -114,4 +114,4 @@ The provider instance options. #### Exceptions -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
    +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration.md)
    diff --git a/docs/api/storage/proffer.storage.configuration.iscopedstoreoptions.md b/docs/api/storage/proffer.storage.configuration.iscopedstoreoptions.md index 4046127..35026cf 100644 --- a/docs/api/storage/proffer.storage.configuration.iscopedstoreoptions.md +++ b/docs/api/storage/proffer.storage.configuration.iscopedstoreoptions.md @@ -2,13 +2,13 @@ Namespace: Proffer.Storage.Configuration -Options for a scoped [IStore](./proffer.storage.istore). +Options for a scoped [IStore](./proffer.storage.istore.md). ```csharp public interface IScopedStoreOptions : IStoreOptions, Proffer.Configuration.INamedElementOptions ``` -Implements [IStoreOptions](./proffer.storage.configuration.istoreoptions), INamedElementOptions +Implements [IStoreOptions](./proffer.storage.configuration.istoreoptions.md), INamedElementOptions ## Properties diff --git a/docs/api/storage/proffer.storage.configuration.istoreoptions.md b/docs/api/storage/proffer.storage.configuration.istoreoptions.md index e9f2573..e699c3d 100644 --- a/docs/api/storage/proffer.storage.configuration.istoreoptions.md +++ b/docs/api/storage/proffer.storage.configuration.istoreoptions.md @@ -2,7 +2,7 @@ Namespace: Proffer.Storage.Configuration -Options for an [IStore](./proffer.storage.istore). +Options for an [IStore](./proffer.storage.istore.md). ```csharp public interface IStoreOptions : Proffer.Configuration.INamedElementOptions @@ -46,7 +46,7 @@ public abstract AccessLevel AccessLevel { get; set; } #### Property Value -[AccessLevel](./proffer.storage.configuration.accesslevel)
    +[AccessLevel](./proffer.storage.configuration.accesslevel.md)
    ### **FolderName** @@ -82,4 +82,4 @@ The returned by the validation, if any. #### Exceptions -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
    +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration.md)
    diff --git a/docs/api/storage/proffer.storage.configuration.scopedstoreoptions.md b/docs/api/storage/proffer.storage.configuration.scopedstoreoptions.md index 9ebd49f..f3b11fd 100644 --- a/docs/api/storage/proffer.storage.configuration.scopedstoreoptions.md +++ b/docs/api/storage/proffer.storage.configuration.scopedstoreoptions.md @@ -2,14 +2,14 @@ Namespace: Proffer.Storage.Configuration -Generic options for a scoped [IStore](./proffer.storage.istore). +Generic options for a scoped [IStore](./proffer.storage.istore.md). ```csharp public class ScopedStoreOptions : StoreOptions, IStoreOptions, Proffer.Configuration.INamedElementOptions, IScopedStoreOptions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [StoreOptions](./proffer.storage.configuration.storeoptions) → [ScopedStoreOptions](./proffer.storage.configuration.scopedstoreoptions)
    -Implements [IStoreOptions](./proffer.storage.configuration.istoreoptions), INamedElementOptions, [IScopedStoreOptions](./proffer.storage.configuration.iscopedstoreoptions) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [StoreOptions](./proffer.storage.configuration.storeoptions.md) → [ScopedStoreOptions](./proffer.storage.configuration.scopedstoreoptions.md)
    +Implements [IStoreOptions](./proffer.storage.configuration.istoreoptions.md), INamedElementOptions, [IScopedStoreOptions](./proffer.storage.configuration.iscopedstoreoptions.md) ## Properties @@ -71,7 +71,7 @@ public AccessLevel AccessLevel { get; set; } #### Property Value -[AccessLevel](./proffer.storage.configuration.accesslevel)
    +[AccessLevel](./proffer.storage.configuration.accesslevel.md)
    ### **FolderName** diff --git a/docs/api/storage/proffer.storage.configuration.storageoptions.md b/docs/api/storage/proffer.storage.configuration.storageoptions.md index abbe887..2f7a85b 100644 --- a/docs/api/storage/proffer.storage.configuration.storageoptions.md +++ b/docs/api/storage/proffer.storage.configuration.storageoptions.md @@ -8,8 +8,8 @@ The Proffer.Storage options with providers and stores. public class StorageOptions : IParsedOptions`3 ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [StorageOptions](./proffer.storage.configuration.storageoptions)
    -Implements [IParsedOptions<ProviderOptions, StoreOptions, ScopedStoreOptions>](./proffer.storage.configuration.iparsedoptions-3) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [StorageOptions](./proffer.storage.configuration.storageoptions.md)
    +Implements [IParsedOptions<ProviderOptions, StoreOptions, ScopedStoreOptions>](./proffer.storage.configuration.iparsedoptions-3.md) ## Fields @@ -123,7 +123,7 @@ public IReadOnlyDictionary ParsedScopedStores { get; ### **StorageOptions()** -Initializes a new instance of the [StorageOptions](./proffer.storage.configuration.storageoptions) class. +Initializes a new instance of the [StorageOptions](./proffer.storage.configuration.storageoptions.md) class. ```csharp public StorageOptions() @@ -154,7 +154,7 @@ public void BindStoreOptions(StoreOptions storeOptions, ProviderOptions provider #### Parameters -`storeOptions` [StoreOptions](./proffer.storage.configuration.storeoptions)
    +`storeOptions` [StoreOptions](./proffer.storage.configuration.storeoptions.md)
    The store options. `providerInstanceOptions` ProviderOptions
    diff --git a/docs/api/storage/proffer.storage.configuration.storeoptions.md b/docs/api/storage/proffer.storage.configuration.storeoptions.md index c9985f1..fd70a2c 100644 --- a/docs/api/storage/proffer.storage.configuration.storeoptions.md +++ b/docs/api/storage/proffer.storage.configuration.storeoptions.md @@ -2,14 +2,14 @@ Namespace: Proffer.Storage.Configuration -Generic options for an [IStore](./proffer.storage.istore). +Generic options for an [IStore](./proffer.storage.istore.md). ```csharp public class StoreOptions : IStoreOptions, Proffer.Configuration.INamedElementOptions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [StoreOptions](./proffer.storage.configuration.storeoptions)
    -Implements [IStoreOptions](./proffer.storage.configuration.istoreoptions), INamedElementOptions +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [StoreOptions](./proffer.storage.configuration.storeoptions.md)
    +Implements [IStoreOptions](./proffer.storage.configuration.istoreoptions.md), INamedElementOptions ## Properties @@ -59,7 +59,7 @@ public AccessLevel AccessLevel { get; set; } #### Property Value -[AccessLevel](./proffer.storage.configuration.accesslevel)
    +[AccessLevel](./proffer.storage.configuration.accesslevel.md)
    ### **FolderName** @@ -106,7 +106,7 @@ If set to true, throws an exception when the validation fails with any . #### Exceptions -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
    +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration.md)
    ### **PushMissingPropertyError(List<OptionError>, String)** diff --git a/docs/api/storage/proffer.storage.exceptions.badproviderconfiguration.md b/docs/api/storage/proffer.storage.exceptions.badproviderconfiguration.md index a340fcb..d2131a9 100644 --- a/docs/api/storage/proffer.storage.exceptions.badproviderconfiguration.md +++ b/docs/api/storage/proffer.storage.exceptions.badproviderconfiguration.md @@ -8,7 +8,7 @@ Thrown when a provider was not properly configured. public class BadProviderConfiguration : System.Exception, System.Runtime.Serialization.ISerializable ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration.md)
    Implements [ISerializable](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.serialization.iserializable) ## Properties @@ -113,7 +113,7 @@ public int HResult { get; set; } ### **BadProviderConfiguration(String, String)** -Initializes a new instance of the [BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration) class. +Initializes a new instance of the [BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration.md) class. ```csharp public BadProviderConfiguration(string providerName, string details) diff --git a/docs/api/storage/proffer.storage.exceptions.badscopedstoreconfiguration.md b/docs/api/storage/proffer.storage.exceptions.badscopedstoreconfiguration.md index 42dbe05..94b675c 100644 --- a/docs/api/storage/proffer.storage.exceptions.badscopedstoreconfiguration.md +++ b/docs/api/storage/proffer.storage.exceptions.badscopedstoreconfiguration.md @@ -8,7 +8,7 @@ Thrown when a scoped store was not properly configured. public class BadScopedStoreConfiguration : System.Exception, System.Runtime.Serialization.ISerializable ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [BadScopedStoreConfiguration](./proffer.storage.exceptions.badscopedstoreconfiguration)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [BadScopedStoreConfiguration](./proffer.storage.exceptions.badscopedstoreconfiguration.md)
    Implements [ISerializable](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.serialization.iserializable) ## Properties @@ -113,7 +113,7 @@ public int HResult { get; set; } ### **BadScopedStoreConfiguration(String, String, Exception)** -Initializes a new instance of the [BadScopedStoreConfiguration](./proffer.storage.exceptions.badscopedstoreconfiguration) class. +Initializes a new instance of the [BadScopedStoreConfiguration](./proffer.storage.exceptions.badscopedstoreconfiguration.md) class. ```csharp public BadScopedStoreConfiguration(string storeName, string details, Exception innerException) diff --git a/docs/api/storage/proffer.storage.exceptions.badstoreconfiguration.md b/docs/api/storage/proffer.storage.exceptions.badstoreconfiguration.md index 3ba48e2..bbfd57b 100644 --- a/docs/api/storage/proffer.storage.exceptions.badstoreconfiguration.md +++ b/docs/api/storage/proffer.storage.exceptions.badstoreconfiguration.md @@ -8,7 +8,7 @@ Thrown when a store was not properly configured. public class BadStoreConfiguration : System.Exception, System.Runtime.Serialization.ISerializable ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration.md)
    Implements [ISerializable](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.serialization.iserializable) ## Properties @@ -125,7 +125,7 @@ public int HResult { get; set; } ### **BadStoreConfiguration(String, String)** -Initializes a new instance of the [BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration) class. +Initializes a new instance of the [BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration.md) class. ```csharp public BadStoreConfiguration(string storeName, string details) @@ -141,7 +141,7 @@ The details. ### **BadStoreConfiguration(String, IEnumerable<IOptionError>)** -Initializes a new instance of the [BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration) class. +Initializes a new instance of the [BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration.md) class. ```csharp public BadStoreConfiguration(string storeName, IEnumerable errors) diff --git a/docs/api/storage/proffer.storage.exceptions.filealreadyexistsexception.md b/docs/api/storage/proffer.storage.exceptions.filealreadyexistsexception.md index 36ce657..a228670 100644 --- a/docs/api/storage/proffer.storage.exceptions.filealreadyexistsexception.md +++ b/docs/api/storage/proffer.storage.exceptions.filealreadyexistsexception.md @@ -8,7 +8,7 @@ Thrown when trying to create a file that already exists in a store. public class FileAlreadyExistsException : System.Exception, System.Runtime.Serialization.ISerializable ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception.md)
    Implements [ISerializable](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.serialization.iserializable) ## Properties @@ -113,7 +113,7 @@ public int HResult { get; set; } ### **FileAlreadyExistsException(String, String)** -Initializes a new instance of the [FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception) class. +Initializes a new instance of the [FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception.md) class. ```csharp public FileAlreadyExistsException(string storeName, string filePath) diff --git a/docs/api/storage/proffer.storage.exceptions.providernotfoundexception.md b/docs/api/storage/proffer.storage.exceptions.providernotfoundexception.md index 4599e72..91b7c05 100644 --- a/docs/api/storage/proffer.storage.exceptions.providernotfoundexception.md +++ b/docs/api/storage/proffer.storage.exceptions.providernotfoundexception.md @@ -8,7 +8,7 @@ Thrown when a configured provider cannot be resolved through dependency injectio public class ProviderNotFoundException : System.Exception, System.Runtime.Serialization.ISerializable ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception.md)
    Implements [ISerializable](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.serialization.iserializable) ## Properties @@ -113,7 +113,7 @@ public int HResult { get; set; } ### **ProviderNotFoundException(String)** -Initializes a new instance of the [ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception) class. +Initializes a new instance of the [ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception.md) class. ```csharp public ProviderNotFoundException(string providerName) diff --git a/docs/api/storage/proffer.storage.exceptions.storenotfoundexception.md b/docs/api/storage/proffer.storage.exceptions.storenotfoundexception.md index 76784bd..5313235 100644 --- a/docs/api/storage/proffer.storage.exceptions.storenotfoundexception.md +++ b/docs/api/storage/proffer.storage.exceptions.storenotfoundexception.md @@ -8,7 +8,7 @@ Thrown when a store was not found in the configuration. public class StoreNotFoundException : System.Exception, System.Runtime.Serialization.ISerializable ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception.md)
    Implements [ISerializable](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.serialization.iserializable) ## Properties @@ -113,7 +113,7 @@ public int HResult { get; set; } ### **StoreNotFoundException(String)** -Initializes a new instance of the [StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception) class. +Initializes a new instance of the [StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception.md) class. ```csharp public StoreNotFoundException(string storeName) diff --git a/docs/api/storage/proffer.storage.ifilereference.md b/docs/api/storage/proffer.storage.ifilereference.md index 374663e..791d3dc 100644 --- a/docs/api/storage/proffer.storage.ifilereference.md +++ b/docs/api/storage/proffer.storage.ifilereference.md @@ -8,7 +8,7 @@ A reference of a stored file at a given path. public interface IFileReference : IPrivateFileReference ``` -Implements [IPrivateFileReference](./proffer.storage.iprivatefilereference) +Implements [IPrivateFileReference](./proffer.storage.iprivatefilereference.md) ## Properties @@ -34,7 +34,7 @@ public abstract IFileProperties Properties { get; } #### Property Value -[IFileProperties](./proffer.storage.ifileproperties)
    +[IFileProperties](./proffer.storage.ifileproperties.md)
    ## Methods @@ -149,7 +149,7 @@ ValueTask GetSharedAccessSignature(ISharedAccessPolicy policy) #### Parameters -`policy` [ISharedAccessPolicy](./proffer.storage.isharedaccesspolicy)
    +`policy` [ISharedAccessPolicy](./proffer.storage.isharedaccesspolicy.md)
    The policy. #### Returns diff --git a/docs/api/storage/proffer.storage.internal.configureprovideroptions-4.md b/docs/api/storage/proffer.storage.internal.configureprovideroptions-4.md index b7f1613..ddec75d 100644 --- a/docs/api/storage/proffer.storage.internal.configureprovideroptions-4.md +++ b/docs/api/storage/proffer.storage.internal.configureprovideroptions-4.md @@ -2,7 +2,7 @@ Namespace: Proffer.Storage.Internal -Configures a provider from generic [StorageOptions](./proffer.storage.configuration.storageoptions). +Configures a provider from generic [StorageOptions](./proffer.storage.configuration.storageoptions.md). ```csharp public class ConfigureProviderOptions : @@ -22,14 +22,14 @@ The type of the store options. `TScopedStoreOptions`
    The type of the scoped store options. -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ConfigureProviderOptions<TParsedOptions, TProviderOptions, TStoreOptions, TScopedStoreOptions>](./proffer.storage.internal.configureprovideroptions-4)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ConfigureProviderOptions<TParsedOptions, TProviderOptions, TStoreOptions, TScopedStoreOptions>](./proffer.storage.internal.configureprovideroptions-4.md)
    Implements IConfigureOptions<TParsedOptions> ## Constructors ### **ConfigureProviderOptions(IOptions<StorageOptions>)** -Initializes a new instance of the [ConfigureProviderOptions<TParsedOptions, TProviderOptions, TStoreOptions, TScopedStoreOptions>](./proffer.storage.internal.configureprovideroptions-4) class. +Initializes a new instance of the [ConfigureProviderOptions<TParsedOptions, TProviderOptions, TStoreOptions, TScopedStoreOptions>](./proffer.storage.internal.configureprovideroptions-4.md) class. ```csharp public ConfigureProviderOptions(IOptions storageOptions) @@ -57,6 +57,6 @@ The options instance to configure. #### Exceptions -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
    +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration.md)
    -[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
    +[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration.md)
    diff --git a/docs/api/storage/proffer.storage.internal.genericstoreproxy-1.md b/docs/api/storage/proffer.storage.internal.genericstoreproxy-1.md index 0213c13..f056469 100644 --- a/docs/api/storage/proffer.storage.internal.genericstoreproxy-1.md +++ b/docs/api/storage/proffer.storage.internal.genericstoreproxy-1.md @@ -2,7 +2,7 @@ Namespace: Proffer.Storage.Internal -Generic [IStore](./proffer.storage.istore) proxy to allow direct dependency injection of a [IStore<TOptions>](./proffer.storage.istore-1). +Generic [IStore](./proffer.storage.istore.md) proxy to allow direct dependency injection of a [IStore<TOptions>](./proffer.storage.istore-1.md). ```csharp public class GenericStoreProxy : Proffer.Storage.IStore, @@ -13,8 +13,8 @@ public class GenericStoreProxy : Proffer.Storage.IStore, `TOptions`
    The type of the store options. -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [GenericStoreProxy<TOptions>](./proffer.storage.internal.genericstoreproxy-1)
    -Implements [IStore](./proffer.storage.istore), IStore<TOptions> +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [GenericStoreProxy<TOptions>](./proffer.storage.internal.genericstoreproxy-1.md)
    +Implements [IStore](./proffer.storage.istore.md), IStore<TOptions> ## Properties @@ -34,7 +34,7 @@ public string Name { get; } ### **GenericStoreProxy(IStorageFactory, IOptions<TOptions>)** -Initializes a new instance of the [GenericStoreProxy<TOptions>](./proffer.storage.internal.genericstoreproxy-1) class. +Initializes a new instance of the [GenericStoreProxy<TOptions>](./proffer.storage.internal.genericstoreproxy-1.md) class. ```csharp public GenericStoreProxy(IStorageFactory factory, IOptions options) @@ -42,7 +42,7 @@ public GenericStoreProxy(IStorageFactory factory, IOptions options) #### Parameters -`factory` [IStorageFactory](./proffer.storage.istoragefactory)
    +`factory` [IStorageFactory](./proffer.storage.istoragefactory.md)
    The storage factory. `options` IOptions<TOptions>
    @@ -56,7 +56,7 @@ The options. ### **InitAsync(CancellationToken)** -Initializes the store by creating a container in its [IStorageProvider](./proffer.storage.istorageprovider). +Initializes the store by creating a container in its [IStorageProvider](./proffer.storage.istorageprovider.md). ```csharp public Task InitAsync(CancellationToken cancellationToken) @@ -82,7 +82,7 @@ public Task DeleteAsync(IPrivateFileReference file) #### Parameters -`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
    +`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference.md)
    The reference holding the file path. #### Returns @@ -127,7 +127,7 @@ public ValueTask GetAsync(IPrivateFileReference file, bool withM #### Parameters -`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
    +`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference.md)
    The reference holding the file path. `withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
    @@ -202,7 +202,7 @@ public ValueTask ReadAllBytesAsync(IPrivateFileReference file) #### Parameters -`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
    +`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference.md)
    The reference holding the file path. #### Returns @@ -221,7 +221,7 @@ public ValueTask ReadAllTextAsync(IPrivateFileReference file) #### Parameters -`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
    +`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference.md)
    The reference holding the file path. #### Returns @@ -240,7 +240,7 @@ public ValueTask ReadAsync(IPrivateFileReference file) #### Parameters -`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
    +`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference.md)
    The reference holding the file path. #### Returns @@ -262,13 +262,13 @@ public ValueTask SaveAsync(Stream data, IPrivateFileReference fi `data` [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream)
    The file content. -`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
    +`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference.md)
    The reference holding the file path. `contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    The content-type of the file. -`overwritePolicy` [OverwritePolicy](./proffer.storage.overwritepolicy)
    +`overwritePolicy` [OverwritePolicy](./proffer.storage.overwritepolicy.md)
    The overwrite policy. `metadata` [IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
    @@ -282,7 +282,7 @@ ValueTask<IFileReference>
    #### Exceptions -[FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception)
    +[FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception.md)
    ### **SaveAsync(Byte[], IPrivateFileReference, String, OverwritePolicy, IDictionary<String, String>)** @@ -297,13 +297,13 @@ public ValueTask SaveAsync(Byte[] data, IPrivateFileReference fi `data` [Byte[]](https://docs.microsoft.com/en-us/dotnet/api/system.byte)
    The file content. -`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
    +`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference.md)
    The reference holding the file path. `contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    The content-type of the file. -`overwritePolicy` [OverwritePolicy](./proffer.storage.overwritepolicy)
    +`overwritePolicy` [OverwritePolicy](./proffer.storage.overwritepolicy.md)
    The overwrite policy. `metadata` [IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
    @@ -317,7 +317,7 @@ ValueTask<IFileReference>
    #### Exceptions -[FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception)
    +[FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception.md)
    ### **GetSharedAccessSignatureAsync(ISharedAccessPolicy)** @@ -329,7 +329,7 @@ public ValueTask GetSharedAccessSignatureAsync(ISharedAccessPolicy polic #### Parameters -`policy` [ISharedAccessPolicy](./proffer.storage.isharedaccesspolicy)
    +`policy` [ISharedAccessPolicy](./proffer.storage.isharedaccesspolicy.md)
    The policy. #### Returns diff --git a/docs/api/storage/proffer.storage.internal.privatefilereference.md b/docs/api/storage/proffer.storage.internal.privatefilereference.md index 7b8dd38..94153b4 100644 --- a/docs/api/storage/proffer.storage.internal.privatefilereference.md +++ b/docs/api/storage/proffer.storage.internal.privatefilereference.md @@ -8,8 +8,8 @@ A simple reference of a stored file at a given path. public class PrivateFileReference : Proffer.Storage.IPrivateFileReference ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [PrivateFileReference](./proffer.storage.internal.privatefilereference)
    -Implements [IPrivateFileReference](./proffer.storage.iprivatefilereference) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [PrivateFileReference](./proffer.storage.internal.privatefilereference.md)
    +Implements [IPrivateFileReference](./proffer.storage.iprivatefilereference.md) ## Properties @@ -29,7 +29,7 @@ public string Path { get; } ### **PrivateFileReference(String)** -Initializes a new instance of the [PrivateFileReference](./proffer.storage.internal.privatefilereference) class. +Initializes a new instance of the [PrivateFileReference](./proffer.storage.internal.privatefilereference.md) class. ```csharp public PrivateFileReference(string path) diff --git a/docs/api/storage/proffer.storage.internal.storagefactory.md b/docs/api/storage/proffer.storage.internal.storagefactory.md index 63a03a9..b14cede 100644 --- a/docs/api/storage/proffer.storage.internal.storagefactory.md +++ b/docs/api/storage/proffer.storage.internal.storagefactory.md @@ -2,20 +2,20 @@ Namespace: Proffer.Storage.Internal -Default storage factory to build [IStore](./proffer.storage.istore) from configured [IStorageProvider](./proffer.storage.istorageprovider). +Default storage factory to build [IStore](./proffer.storage.istore.md) from configured [IStorageProvider](./proffer.storage.istorageprovider.md). ```csharp public class StorageFactory : Proffer.Storage.IStorageFactory ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [StorageFactory](./proffer.storage.internal.storagefactory)
    -Implements [IStorageFactory](./proffer.storage.istoragefactory) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [StorageFactory](./proffer.storage.internal.storagefactory.md)
    +Implements [IStorageFactory](./proffer.storage.istoragefactory.md) ## Constructors ### **StorageFactory(IEnumerable<IStorageProvider>, IOptions<StorageOptions>)** -Initializes a new instance of the [StorageFactory](./proffer.storage.internal.storagefactory) class. +Initializes a new instance of the [StorageFactory](./proffer.storage.internal.storagefactory.md) class. ```csharp public StorageFactory(IEnumerable storageProviders, IOptions options) @@ -44,24 +44,24 @@ public IStore GetStore(string storeName, IStoreOptions configuration) `storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    The name of the store. -`configuration` [IStoreOptions](./proffer.storage.configuration.istoreoptions)
    +`configuration` [IStoreOptions](./proffer.storage.configuration.istoreoptions.md)
    The store options. #### Returns -[IStore](./proffer.storage.istore)
    +[IStore](./proffer.storage.istore.md)
    A configured . #### Exceptions -[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
    +[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration.md)
    -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
    +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration.md)
    -[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
    +[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception.md)
    -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
    +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception.md)
    ### **GetStore(String)** @@ -78,19 +78,19 @@ The name of the store. #### Returns -[IStore](./proffer.storage.istore)
    +[IStore](./proffer.storage.istore.md)
    A configured . #### Exceptions -[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
    +[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration.md)
    -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
    +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration.md)
    -[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
    +[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception.md)
    -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
    +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception.md)
    ### **GetScopedStore(String, Object[])** @@ -110,21 +110,21 @@ The arguments to apply to the scoped store name format. #### Returns -[IStore](./proffer.storage.istore)
    +[IStore](./proffer.storage.istore.md)
    A configured . #### Exceptions -[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
    +[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration.md)
    -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
    +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration.md)
    -[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
    +[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception.md)
    -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
    +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception.md)
    -[BadScopedStoreConfiguration](./proffer.storage.exceptions.badscopedstoreconfiguration)
    +[BadScopedStoreConfiguration](./proffer.storage.exceptions.badscopedstoreconfiguration.md)
    ### **TryGetStore(String, IStore&)** @@ -139,7 +139,7 @@ public bool TryGetStore(string storeName, IStore& store) `storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    The name of the store. -`store` [IStore&](./proffer.storage.istore&)
    +`store` [IStore&](./proffer.storage.istore&.md)
    When this method returns, contains the store associated with the specified name, if it is found in the ; otherwise, null. This parameter is passed uninitialized. #### Returns @@ -149,13 +149,13 @@ true if the store was configured and built from its provider; otherwise, false. #### Exceptions -[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
    +[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration.md)
    -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
    +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration.md)
    -[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
    +[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception.md)
    -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
    +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception.md)
    ### **TryGetStore(String, IStore&, String)** @@ -170,7 +170,7 @@ public bool TryGetStore(string storeName, IStore& store, string providerName) `storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    The name of the store. -`store` [IStore&](./proffer.storage.istore&)
    +`store` [IStore&](./proffer.storage.istore&.md)
    When this method returns, contains the store associated with the specified name, if it is found in the ; otherwise, null. This parameter is passed uninitialized. `providerName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    @@ -183,10 +183,10 @@ true if the store was configured and built from its provider; otherwise, false. #### Exceptions -[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
    +[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration.md)
    -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
    +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration.md)
    -[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
    +[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception.md)
    -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
    +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception.md)
    diff --git a/docs/api/storage/proffer.storage.internal.storageproviderbase-4.md b/docs/api/storage/proffer.storage.internal.storageproviderbase-4.md index bc3f53b..29d748e 100644 --- a/docs/api/storage/proffer.storage.internal.storageproviderbase-4.md +++ b/docs/api/storage/proffer.storage.internal.storageproviderbase-4.md @@ -22,8 +22,8 @@ The type of the store options. `TScopedStoreOptions`
    The type of the scoped store options. -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [StorageProviderBase<TParsedOptions, TInstanceOptions, TStoreOptions, TScopedStoreOptions>](./proffer.storage.internal.storageproviderbase-4)
    -Implements [IStorageProvider](./proffer.storage.istorageprovider) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [StorageProviderBase<TParsedOptions, TInstanceOptions, TStoreOptions, TScopedStoreOptions>](./proffer.storage.internal.storageproviderbase-4.md)
    +Implements [IStorageProvider](./proffer.storage.istorageprovider.md) ## Properties @@ -43,7 +43,7 @@ public abstract string Name { get; } ### **StorageProviderBase(IOptions<TParsedOptions>)** -Initializes a new instance of the [StorageProviderBase<TParsedOptions, TInstanceOptions, TStoreOptions, TScopedStoreOptions>](./proffer.storage.internal.storageproviderbase-4) class. +Initializes a new instance of the [StorageProviderBase<TParsedOptions, TInstanceOptions, TStoreOptions, TScopedStoreOptions>](./proffer.storage.internal.storageproviderbase-4.md) class. ```csharp public StorageProviderBase(IOptions options) @@ -71,13 +71,13 @@ The name of the store. #### Returns -[IStore](./proffer.storage.istore)
    +[IStore](./proffer.storage.istore.md)
    A configured . #### Exceptions -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
    +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception.md)
    ### **BuildStore(String, IStoreOptions)** @@ -92,12 +92,12 @@ public IStore BuildStore(string storeName, IStoreOptions storeOptions) `storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    The name of the store. -`storeOptions` [IStoreOptions](./proffer.storage.configuration.istoreoptions)
    +`storeOptions` [IStoreOptions](./proffer.storage.configuration.istoreoptions.md)
    The store options. #### Returns -[IStore](./proffer.storage.istore)
    +[IStore](./proffer.storage.istore.md)
    A configured . @@ -119,15 +119,15 @@ The arguments to apply to the scoped store name format. #### Returns -[IStore](./proffer.storage.istore)
    +[IStore](./proffer.storage.istore.md)
    A configured . #### Exceptions -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
    +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception.md)
    -[BadScopedStoreConfiguration](./proffer.storage.exceptions.badscopedstoreconfiguration)
    +[BadScopedStoreConfiguration](./proffer.storage.exceptions.badscopedstoreconfiguration.md)
    ### **BuildStoreInternal(String, TStoreOptions)** @@ -147,6 +147,6 @@ The store options. #### Returns -[IStore](./proffer.storage.istore)
    +[IStore](./proffer.storage.istore.md)
    A configured . diff --git a/docs/api/storage/proffer.storage.isharedaccesspolicy.md b/docs/api/storage/proffer.storage.isharedaccesspolicy.md index 143e7de..0936049 100644 --- a/docs/api/storage/proffer.storage.isharedaccesspolicy.md +++ b/docs/api/storage/proffer.storage.isharedaccesspolicy.md @@ -44,4 +44,4 @@ public abstract SharedAccessPermissions Permissions { get; } #### Property Value -[SharedAccessPermissions](./proffer.storage.sharedaccesspermissions)
    +[SharedAccessPermissions](./proffer.storage.sharedaccesspermissions.md)
    diff --git a/docs/api/storage/proffer.storage.istoragefactory.md b/docs/api/storage/proffer.storage.istoragefactory.md index 5bdc99d..c505f61 100644 --- a/docs/api/storage/proffer.storage.istoragefactory.md +++ b/docs/api/storage/proffer.storage.istoragefactory.md @@ -2,7 +2,7 @@ Namespace: Proffer.Storage -Builds [IStore](./proffer.storage.istore) from configured [IStorageProvider](./proffer.storage.istorageprovider). +Builds [IStore](./proffer.storage.istore.md) from configured [IStorageProvider](./proffer.storage.istorageprovider.md). ```csharp public interface IStorageFactory @@ -23,24 +23,24 @@ IStore GetStore(string storeName, IStoreOptions configuration) `storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    The name of the store. -`configuration` [IStoreOptions](./proffer.storage.configuration.istoreoptions)
    +`configuration` [IStoreOptions](./proffer.storage.configuration.istoreoptions.md)
    The store options. #### Returns -[IStore](./proffer.storage.istore)
    +[IStore](./proffer.storage.istore.md)
    A configured . #### Exceptions -[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
    +[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration.md)
    -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
    +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration.md)
    -[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
    +[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception.md)
    -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
    +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception.md)
    ### **GetStore(String)** @@ -57,19 +57,19 @@ The name of the store. #### Returns -[IStore](./proffer.storage.istore)
    +[IStore](./proffer.storage.istore.md)
    A configured . #### Exceptions -[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
    +[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration.md)
    -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
    +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration.md)
    -[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
    +[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception.md)
    -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
    +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception.md)
    ### **GetScopedStore(String, Object[])** @@ -89,21 +89,21 @@ The arguments to apply to the scoped store name format. #### Returns -[IStore](./proffer.storage.istore)
    +[IStore](./proffer.storage.istore.md)
    A configured . #### Exceptions -[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
    +[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration.md)
    -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
    +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration.md)
    -[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
    +[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception.md)
    -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
    +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception.md)
    -[BadScopedStoreConfiguration](./proffer.storage.exceptions.badscopedstoreconfiguration)
    +[BadScopedStoreConfiguration](./proffer.storage.exceptions.badscopedstoreconfiguration.md)
    ### **TryGetStore(String, IStore&)** @@ -118,7 +118,7 @@ bool TryGetStore(string storeName, IStore& store) `storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    The name of the store. -`store` [IStore&](./proffer.storage.istore&)
    +`store` [IStore&](./proffer.storage.istore&.md)
    When this method returns, contains the store associated with the specified name, if it is found in the ; otherwise, null. This parameter is passed uninitialized. #### Returns @@ -128,13 +128,13 @@ true if the store was configured and built from its provider; otherwise, false. #### Exceptions -[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
    +[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration.md)
    -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
    +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration.md)
    -[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
    +[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception.md)
    -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
    +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception.md)
    ### **TryGetStore(String, IStore&, String)** @@ -149,7 +149,7 @@ bool TryGetStore(string storeName, IStore& store, string providerName) `storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    The name of the store. -`store` [IStore&](./proffer.storage.istore&)
    +`store` [IStore&](./proffer.storage.istore&.md)
    When this method returns, contains the store associated with the specified name, if it is found in the ; otherwise, null. This parameter is passed uninitialized. `providerName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    @@ -162,10 +162,10 @@ true if the store was configured and built from its provider; otherwise, false. #### Exceptions -[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration)
    +[BadProviderConfiguration](./proffer.storage.exceptions.badproviderconfiguration.md)
    -[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration)
    +[BadStoreConfiguration](./proffer.storage.exceptions.badstoreconfiguration.md)
    -[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception)
    +[ProviderNotFoundException](./proffer.storage.exceptions.providernotfoundexception.md)
    -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
    +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception.md)
    diff --git a/docs/api/storage/proffer.storage.istorageprovider.md b/docs/api/storage/proffer.storage.istorageprovider.md index 7423d04..830c46a 100644 --- a/docs/api/storage/proffer.storage.istorageprovider.md +++ b/docs/api/storage/proffer.storage.istorageprovider.md @@ -39,13 +39,13 @@ The name of the store. #### Returns -[IStore](./proffer.storage.istore)
    +[IStore](./proffer.storage.istore.md)
    A configured . #### Exceptions -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
    +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception.md)
    ### **BuildStore(String, IStoreOptions)** @@ -60,12 +60,12 @@ IStore BuildStore(string storeName, IStoreOptions storeOptions) `storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    The name of the store. -`storeOptions` [IStoreOptions](./proffer.storage.configuration.istoreoptions)
    +`storeOptions` [IStoreOptions](./proffer.storage.configuration.istoreoptions.md)
    The store options. #### Returns -[IStore](./proffer.storage.istore)
    +[IStore](./proffer.storage.istore.md)
    A configured . @@ -87,12 +87,12 @@ The arguments to apply to the scoped store name format. #### Returns -[IStore](./proffer.storage.istore)
    +[IStore](./proffer.storage.istore.md)
    A configured . #### Exceptions -[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception)
    +[StoreNotFoundException](./proffer.storage.exceptions.storenotfoundexception.md)
    -[BadScopedStoreConfiguration](./proffer.storage.exceptions.badscopedstoreconfiguration)
    +[BadScopedStoreConfiguration](./proffer.storage.exceptions.badscopedstoreconfiguration.md)
    diff --git a/docs/api/storage/proffer.storage.istore-1.md b/docs/api/storage/proffer.storage.istore-1.md index ed0bf81..74a0d2a 100644 --- a/docs/api/storage/proffer.storage.istore-1.md +++ b/docs/api/storage/proffer.storage.istore-1.md @@ -2,7 +2,7 @@ Namespace: Proffer.Storage -Injectable typed store, which allows to save, list or read files on a container in its configured [IStorageProvider](./proffer.storage.istorageprovider). +Injectable typed store, which allows to save, list or read files on a container in its configured [IStorageProvider](./proffer.storage.istorageprovider.md). ```csharp public interface IStore : IStore @@ -13,4 +13,4 @@ public interface IStore : IStore `TOptions`
    The type of the store options. -Implements [IStore](./proffer.storage.istore) +Implements [IStore](./proffer.storage.istore.md) diff --git a/docs/api/storage/proffer.storage.istore.md b/docs/api/storage/proffer.storage.istore.md index 7826d8a..e345d1e 100644 --- a/docs/api/storage/proffer.storage.istore.md +++ b/docs/api/storage/proffer.storage.istore.md @@ -2,7 +2,7 @@ Namespace: Proffer.Storage -A store allows to save, list or read files on a container in its configured [IStorageProvider](./proffer.storage.istorageprovider). +A store allows to save, list or read files on a container in its configured [IStorageProvider](./proffer.storage.istorageprovider.md). ```csharp public interface IStore @@ -26,7 +26,7 @@ public abstract string Name { get; } ### **InitAsync(CancellationToken)** -Initializes the store by creating a container in its [IStorageProvider](./proffer.storage.istorageprovider). +Initializes the store by creating a container in its [IStorageProvider](./proffer.storage.istorageprovider.md). ```csharp Task InitAsync(CancellationToken cancellationToken) @@ -102,7 +102,7 @@ ValueTask GetAsync(IPrivateFileReference file, bool withMetadata #### Parameters -`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
    +`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference.md)
    The reference holding the file path. `withMetadata` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
    @@ -148,7 +148,7 @@ Task DeleteAsync(IPrivateFileReference file) #### Parameters -`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
    +`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference.md)
    The reference holding the file path. #### Returns @@ -166,7 +166,7 @@ ValueTask ReadAsync(IPrivateFileReference file) #### Parameters -`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
    +`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference.md)
    The reference holding the file path. #### Returns @@ -184,7 +184,7 @@ ValueTask ReadAllBytesAsync(IPrivateFileReference file) #### Parameters -`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
    +`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference.md)
    The reference holding the file path. #### Returns @@ -202,7 +202,7 @@ ValueTask ReadAllTextAsync(IPrivateFileReference file) #### Parameters -`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
    +`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference.md)
    The reference holding the file path. #### Returns @@ -223,13 +223,13 @@ ValueTask SaveAsync(Byte[] data, IPrivateFileReference file, str `data` [Byte[]](https://docs.microsoft.com/en-us/dotnet/api/system.byte)
    The file content. -`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
    +`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference.md)
    The reference holding the file path. `contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    The content-type of the file. -`overwritePolicy` [OverwritePolicy](./proffer.storage.overwritepolicy)
    +`overwritePolicy` [OverwritePolicy](./proffer.storage.overwritepolicy.md)
    The overwrite policy. `metadata` [IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
    @@ -242,7 +242,7 @@ The saved . #### Exceptions -[FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception)
    +[FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception.md)
    ### **SaveAsync(Stream, IPrivateFileReference, String, OverwritePolicy, IDictionary<String, String>)** @@ -257,13 +257,13 @@ ValueTask SaveAsync(Stream data, IPrivateFileReference file, str `data` [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream)
    The file content. -`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference)
    +`file` [IPrivateFileReference](./proffer.storage.iprivatefilereference.md)
    The reference holding the file path. `contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    The content-type of the file. -`overwritePolicy` [OverwritePolicy](./proffer.storage.overwritepolicy)
    +`overwritePolicy` [OverwritePolicy](./proffer.storage.overwritepolicy.md)
    The overwrite policy. `metadata` [IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
    @@ -276,7 +276,7 @@ The saved . #### Exceptions -[FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception)
    +[FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception.md)
    ### **GetSharedAccessSignatureAsync(ISharedAccessPolicy)** @@ -288,7 +288,7 @@ ValueTask GetSharedAccessSignatureAsync(ISharedAccessPolicy policy) #### Parameters -`policy` [ISharedAccessPolicy](./proffer.storage.isharedaccesspolicy)
    +`policy` [ISharedAccessPolicy](./proffer.storage.isharedaccesspolicy.md)
    The policy. #### Returns diff --git a/docs/api/storage/proffer.storage.istoreextensions.md b/docs/api/storage/proffer.storage.istoreextensions.md index c051a6e..2b9a3bb 100644 --- a/docs/api/storage/proffer.storage.istoreextensions.md +++ b/docs/api/storage/proffer.storage.istoreextensions.md @@ -2,13 +2,13 @@ Namespace: Proffer.Storage -[IStore](./proffer.storage.istore) extension methods. +[IStore](./proffer.storage.istore.md) extension methods. ```csharp public static class IStoreExtensions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [IStoreExtensions](./proffer.storage.istoreextensions) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [IStoreExtensions](./proffer.storage.istoreextensions.md) ## Methods @@ -22,7 +22,7 @@ public static ValueTask ListAsync(IStore store, string path, b #### Parameters -`store` [IStore](./proffer.storage.istore)
    +`store` [IStore](./proffer.storage.istore.md)
    The store. `path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    @@ -50,7 +50,7 @@ public static ValueTask ListAsync(IStore store, string path, s #### Parameters -`store` [IStore](./proffer.storage.istore)
    +`store` [IStore](./proffer.storage.istore.md)
    The store. `path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    @@ -81,7 +81,7 @@ public static Task DeleteAsync(IStore store, string path) #### Parameters -`store` [IStore](./proffer.storage.istore)
    +`store` [IStore](./proffer.storage.istore.md)
    The store. `path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    @@ -103,7 +103,7 @@ public static ValueTask GetAsync(IStore store, string path, bool #### Parameters -`store` [IStore](./proffer.storage.istore)
    +`store` [IStore](./proffer.storage.istore.md)
    The store. `path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    @@ -128,7 +128,7 @@ public static ValueTask ReadAsync(IStore store, string path) #### Parameters -`store` [IStore](./proffer.storage.istore)
    +`store` [IStore](./proffer.storage.istore.md)
    The store. `path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    @@ -150,7 +150,7 @@ public static ValueTask ReadAllBytesAsync(IStore store, string path) #### Parameters -`store` [IStore](./proffer.storage.istore)
    +`store` [IStore](./proffer.storage.istore.md)
    The store. `path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    @@ -172,7 +172,7 @@ public static ValueTask ReadAllTextAsync(IStore store, string path) #### Parameters -`store` [IStore](./proffer.storage.istore)
    +`store` [IStore](./proffer.storage.istore.md)
    The store. `path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    @@ -194,7 +194,7 @@ public static ValueTask SaveAsync(IStore store, Byte[] data, str #### Parameters -`store` [IStore](./proffer.storage.istore)
    +`store` [IStore](./proffer.storage.istore.md)
    The store. `data` [Byte[]](https://docs.microsoft.com/en-us/dotnet/api/system.byte)
    @@ -206,7 +206,7 @@ The file path. `contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    The content-type of the file. -`overwritePolicy` [OverwritePolicy](./proffer.storage.overwritepolicy)
    +`overwritePolicy` [OverwritePolicy](./proffer.storage.overwritepolicy.md)
    The overwrite policy. `metadata` [IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
    @@ -220,7 +220,7 @@ ValueTask<IFileReference>
    #### Exceptions -[FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception)
    +[FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception.md)
    ### **SaveAsync(IStore, Stream, String, String, OverwritePolicy, IDictionary<String, String>)** @@ -232,7 +232,7 @@ public static ValueTask SaveAsync(IStore store, Stream data, str #### Parameters -`store` [IStore](./proffer.storage.istore)
    +`store` [IStore](./proffer.storage.istore.md)
    The store. `data` [Stream](https://docs.microsoft.com/en-us/dotnet/api/system.io.stream)
    @@ -244,7 +244,7 @@ The file path. `contentType` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    The content-type of the file. -`overwritePolicy` [OverwritePolicy](./proffer.storage.overwritepolicy)
    +`overwritePolicy` [OverwritePolicy](./proffer.storage.overwritepolicy.md)
    The overwrite policy. `metadata` [IDictionary<String, String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2)
    @@ -258,4 +258,4 @@ ValueTask<IFileReference>
    #### Exceptions -[FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception)
    +[FileAlreadyExistsException](./proffer.storage.exceptions.filealreadyexistsexception.md)
    diff --git a/docs/api/storage/proffer.storage.overwritepolicy.md b/docs/api/storage/proffer.storage.overwritepolicy.md index a68b80c..24a66ba 100644 --- a/docs/api/storage/proffer.storage.overwritepolicy.md +++ b/docs/api/storage/proffer.storage.overwritepolicy.md @@ -8,7 +8,7 @@ Defines an overwrite policy when saving a file to a store. public enum OverwritePolicy ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ValueType](https://docs.microsoft.com/en-us/dotnet/api/system.valuetype) → [Enum](https://docs.microsoft.com/en-us/dotnet/api/system.enum) → [OverwritePolicy](./proffer.storage.overwritepolicy)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ValueType](https://docs.microsoft.com/en-us/dotnet/api/system.valuetype) → [Enum](https://docs.microsoft.com/en-us/dotnet/api/system.enum) → [OverwritePolicy](./proffer.storage.overwritepolicy.md)
    Implements [IComparable](https://docs.microsoft.com/en-us/dotnet/api/system.icomparable), [IFormattable](https://docs.microsoft.com/en-us/dotnet/api/system.iformattable), [IConvertible](https://docs.microsoft.com/en-us/dotnet/api/system.iconvertible) ## Fields diff --git a/docs/api/storage/proffer.storage.sharedaccesspermissions.md b/docs/api/storage/proffer.storage.sharedaccesspermissions.md index 78eac58..a177ac2 100644 --- a/docs/api/storage/proffer.storage.sharedaccesspermissions.md +++ b/docs/api/storage/proffer.storage.sharedaccesspermissions.md @@ -8,7 +8,7 @@ Specifies the set of possible permissions for a shared access policy. public enum SharedAccessPermissions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ValueType](https://docs.microsoft.com/en-us/dotnet/api/system.valuetype) → [Enum](https://docs.microsoft.com/en-us/dotnet/api/system.enum) → [SharedAccessPermissions](./proffer.storage.sharedaccesspermissions)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ValueType](https://docs.microsoft.com/en-us/dotnet/api/system.valuetype) → [Enum](https://docs.microsoft.com/en-us/dotnet/api/system.enum) → [SharedAccessPermissions](./proffer.storage.sharedaccesspermissions.md)
    Implements [IComparable](https://docs.microsoft.com/en-us/dotnet/api/system.icomparable), [IFormattable](https://docs.microsoft.com/en-us/dotnet/api/system.iformattable), [IConvertible](https://docs.microsoft.com/en-us/dotnet/api/system.iconvertible) ## Fields diff --git a/docs/api/storage/proffer.storage.sharedaccesspolicy.md b/docs/api/storage/proffer.storage.sharedaccesspolicy.md index fd74e22..29f7871 100644 --- a/docs/api/storage/proffer.storage.sharedaccesspolicy.md +++ b/docs/api/storage/proffer.storage.sharedaccesspolicy.md @@ -8,8 +8,8 @@ Represents a simple shared access policy, which specifies the start time, expiry public class SharedAccessPolicy : ISharedAccessPolicy ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [SharedAccessPolicy](./proffer.storage.sharedaccesspolicy)
    -Implements [ISharedAccessPolicy](./proffer.storage.isharedaccesspolicy) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [SharedAccessPolicy](./proffer.storage.sharedaccesspolicy.md)
    +Implements [ISharedAccessPolicy](./proffer.storage.isharedaccesspolicy.md) ## Properties @@ -47,7 +47,7 @@ public SharedAccessPermissions Permissions { get; set; } #### Property Value -[SharedAccessPermissions](./proffer.storage.sharedaccesspermissions)
    +[SharedAccessPermissions](./proffer.storage.sharedaccesspermissions.md)
    ## Constructors diff --git a/docs/api/storage/proffer.storage.storageservicecollectionextensions.md b/docs/api/storage/proffer.storage.storageservicecollectionextensions.md index 1b4de1c..7b54f90 100644 --- a/docs/api/storage/proffer.storage.storageservicecollectionextensions.md +++ b/docs/api/storage/proffer.storage.storageservicecollectionextensions.md @@ -8,7 +8,7 @@ Microsoft.Extensions.DependencyInjection.IServiceCollection extension methods. public static class StorageServiceCollectionExtensions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [StorageServiceCollectionExtensions](./proffer.storage.storageservicecollectionextensions) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [StorageServiceCollectionExtensions](./proffer.storage.storageservicecollectionextensions.md) ## Methods diff --git a/docs/api/storage/proffer.storage.storebase.md b/docs/api/storage/proffer.storage.storebase.md index 4d299ef..abddb8a 100644 --- a/docs/api/storage/proffer.storage.storebase.md +++ b/docs/api/storage/proffer.storage.storebase.md @@ -8,7 +8,7 @@ Abstract base typed store. public abstract class StoreBase ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [StoreBase](./proffer.storage.storebase) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [StoreBase](./proffer.storage.storebase.md) ## Properties @@ -22,13 +22,13 @@ public IStore Store { get; } #### Property Value -[IStore](./proffer.storage.istore)
    +[IStore](./proffer.storage.istore.md)
    ## Constructors ### **StoreBase(String, IStorageFactory)** -Initializes a new instance of the [StoreBase](./proffer.storage.storebase) class. +Initializes a new instance of the [StoreBase](./proffer.storage.storebase.md) class. ```csharp public StoreBase(string storeName, IStorageFactory storageFactory) @@ -39,5 +39,5 @@ public StoreBase(string storeName, IStorageFactory storageFactory) `storeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
    The name of the store. -`storageFactory` [IStorageFactory](./proffer.storage.istoragefactory)
    +`storageFactory` [IStorageFactory](./proffer.storage.istoragefactory.md)
    The storage factory. diff --git a/docs/api/templating/handlebars/index.md b/docs/api/templating/handlebars/index.md index 88b5fa0..3501ebf 100644 --- a/docs/api/templating/handlebars/index.md +++ b/docs/api/templating/handlebars/index.md @@ -2,10 +2,10 @@ ## Proffer.Templating -[HandlebarsServiceCollectionExtensions](./proffer.templating.handlebarsservicecollectionextensions) +[HandlebarsServiceCollectionExtensions](./proffer.templating.handlebarsservicecollectionextensions.md) ## Proffer.Templating.Handlebars -[HandlebarsTemplate](./proffer.templating.handlebars.handlebarstemplate) +[HandlebarsTemplate](./proffer.templating.handlebars.handlebarstemplate.md) -[HandlebarsTemplateProvider](./proffer.templating.handlebars.handlebarstemplateprovider) +[HandlebarsTemplateProvider](./proffer.templating.handlebars.handlebarstemplateprovider.md) diff --git a/docs/api/templating/handlebars/proffer.templating.handlebars.handlebarstemplate.md b/docs/api/templating/handlebars/proffer.templating.handlebars.handlebarstemplate.md index eb6c540..acdcde0 100644 --- a/docs/api/templating/handlebars/proffer.templating.handlebars.handlebarstemplate.md +++ b/docs/api/templating/handlebars/proffer.templating.handlebars.handlebarstemplate.md @@ -8,14 +8,14 @@ A template reference can be executed on a specific context using N:HandlebarsDot public class HandlebarsTemplate : Proffer.Templating.ITemplate ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [HandlebarsTemplate](./proffer.templating.handlebars.handlebarstemplate)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [HandlebarsTemplate](./proffer.templating.handlebars.handlebarstemplate.md)
    Implements ITemplate ## Constructors ### **HandlebarsTemplate(String)** -Initializes a new instance of the [HandlebarsTemplate](./proffer.templating.handlebars.handlebarstemplate) class. +Initializes a new instance of the [HandlebarsTemplate](./proffer.templating.handlebars.handlebarstemplate.md) class. ```csharp public HandlebarsTemplate(string templateContent) @@ -28,7 +28,7 @@ Content of the template. ### **HandlebarsTemplate(IHandlebars, String)** -Initializes a new instance of the [HandlebarsTemplate](./proffer.templating.handlebars.handlebarstemplate) class. +Initializes a new instance of the [HandlebarsTemplate](./proffer.templating.handlebars.handlebarstemplate.md) class. ```csharp public HandlebarsTemplate(IHandlebars handlebars, string templateContent) diff --git a/docs/api/templating/handlebars/proffer.templating.handlebars.handlebarstemplateprovider.md b/docs/api/templating/handlebars/proffer.templating.handlebars.handlebarstemplateprovider.md index 8447132..8f75ff2 100644 --- a/docs/api/templating/handlebars/proffer.templating.handlebars.handlebarstemplateprovider.md +++ b/docs/api/templating/handlebars/proffer.templating.handlebars.handlebarstemplateprovider.md @@ -8,7 +8,7 @@ A provider handles and compiles templates using N:HandlebarsDotNet. public class HandlebarsTemplateProvider : Proffer.Templating.ITemplateProvider ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [HandlebarsTemplateProvider](./proffer.templating.handlebars.handlebarstemplateprovider)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [HandlebarsTemplateProvider](./proffer.templating.handlebars.handlebarstemplateprovider.md)
    Implements ITemplateProvider ## Properties @@ -41,7 +41,7 @@ public ISet Extensions { get; } ### **HandlebarsTemplateProvider()** -Initializes a new instance of the [HandlebarsTemplateProvider](./proffer.templating.handlebars.handlebarstemplateprovider) class. +Initializes a new instance of the [HandlebarsTemplateProvider](./proffer.templating.handlebars.handlebarstemplateprovider.md) class. ```csharp public HandlebarsTemplateProvider() diff --git a/docs/api/templating/handlebars/proffer.templating.handlebarsservicecollectionextensions.md b/docs/api/templating/handlebars/proffer.templating.handlebarsservicecollectionextensions.md index 4e5e4ba..8111758 100644 --- a/docs/api/templating/handlebars/proffer.templating.handlebarsservicecollectionextensions.md +++ b/docs/api/templating/handlebars/proffer.templating.handlebarsservicecollectionextensions.md @@ -8,7 +8,7 @@ Microsoft.Extensions.DependencyInjection.IServiceCollection extension methods. public static class HandlebarsServiceCollectionExtensions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [HandlebarsServiceCollectionExtensions](./proffer.templating.handlebarsservicecollectionextensions) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [HandlebarsServiceCollectionExtensions](./proffer.templating.handlebarsservicecollectionextensions.md) ## Methods diff --git a/docs/api/templating/index.md b/docs/api/templating/index.md index 028a4b4..16121e9 100644 --- a/docs/api/templating/index.md +++ b/docs/api/templating/index.md @@ -2,32 +2,32 @@ ## Proffer.Templating -[InvalidContextException](./proffer.templating.invalidcontextexception) +[InvalidContextException](./proffer.templating.invalidcontextexception.md) -[ITemplate](./proffer.templating.itemplate) +[ITemplate](./proffer.templating.itemplate.md) -[ITemplateLoader](./proffer.templating.itemplateloader) +[ITemplateLoader](./proffer.templating.itemplateloader.md) -[ITemplateLoaderFactory](./proffer.templating.itemplateloaderfactory) +[ITemplateLoaderFactory](./proffer.templating.itemplateloaderfactory.md) -[ITemplateProvider](./proffer.templating.itemplateprovider) +[ITemplateProvider](./proffer.templating.itemplateprovider.md) -[ITemplateProviderScope](./proffer.templating.itemplateproviderscope) +[ITemplateProviderScope](./proffer.templating.itemplateproviderscope.md) -[TemplateCollectionBase](./proffer.templating.templatecollectionbase) +[TemplateCollectionBase](./proffer.templating.templatecollectionbase.md) -[TemplateCollectionBase<TStore>](./proffer.templating.templatecollectionbase-1) +[TemplateCollectionBase<TStore>](./proffer.templating.templatecollectionbase-1.md) -[TemplatingServiceCollectionExtensions](./proffer.templating.templatingservicecollectionextensions) +[TemplatingServiceCollectionExtensions](./proffer.templating.templatingservicecollectionextensions.md) ## Proffer.Templating.Exceptions -[ProviderNotFoundException](./proffer.templating.exceptions.providernotfoundexception) +[ProviderNotFoundException](./proffer.templating.exceptions.providernotfoundexception.md) -[TemplateNotFoundException](./proffer.templating.exceptions.templatenotfoundexception) +[TemplateNotFoundException](./proffer.templating.exceptions.templatenotfoundexception.md) ## Proffer.Templating.Internal -[TemplateLoader](./proffer.templating.internal.templateloader) +[TemplateLoader](./proffer.templating.internal.templateloader.md) -[TemplateLoaderFactory](./proffer.templating.internal.templateloaderfactory) +[TemplateLoaderFactory](./proffer.templating.internal.templateloaderfactory.md) diff --git a/docs/api/templating/mustache/index.md b/docs/api/templating/mustache/index.md index deac3e4..6c2873a 100644 --- a/docs/api/templating/mustache/index.md +++ b/docs/api/templating/mustache/index.md @@ -2,10 +2,10 @@ ## Proffer.Templating -[MustacheServiceCollectionExtensions](./proffer.templating.mustacheservicecollectionextensions) +[MustacheServiceCollectionExtensions](./proffer.templating.mustacheservicecollectionextensions.md) ## Proffer.Templating.Mustache -[MustacheTemplate](./proffer.templating.mustache.mustachetemplate) +[MustacheTemplate](./proffer.templating.mustache.mustachetemplate.md) -[MustacheTemplateProvider](./proffer.templating.mustache.mustachetemplateprovider) +[MustacheTemplateProvider](./proffer.templating.mustache.mustachetemplateprovider.md) diff --git a/docs/api/templating/mustache/proffer.templating.mustache.mustachetemplate.md b/docs/api/templating/mustache/proffer.templating.mustache.mustachetemplate.md index dfab2b8..a0fc662 100644 --- a/docs/api/templating/mustache/proffer.templating.mustache.mustachetemplate.md +++ b/docs/api/templating/mustache/proffer.templating.mustache.mustachetemplate.md @@ -8,14 +8,14 @@ A template reference can be executed on a specific context using N:Mustache. public class MustacheTemplate : Proffer.Templating.ITemplate ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [MustacheTemplate](./proffer.templating.mustache.mustachetemplate)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [MustacheTemplate](./proffer.templating.mustache.mustachetemplate.md)
    Implements ITemplate ## Constructors ### **MustacheTemplate(String)** -Initializes a new instance of the [MustacheTemplate](./proffer.templating.mustache.mustachetemplate) class. +Initializes a new instance of the [MustacheTemplate](./proffer.templating.mustache.mustachetemplate.md) class. ```csharp public MustacheTemplate(string templateContent) diff --git a/docs/api/templating/mustache/proffer.templating.mustache.mustachetemplateprovider.md b/docs/api/templating/mustache/proffer.templating.mustache.mustachetemplateprovider.md index dc24e61..195f4cc 100644 --- a/docs/api/templating/mustache/proffer.templating.mustache.mustachetemplateprovider.md +++ b/docs/api/templating/mustache/proffer.templating.mustache.mustachetemplateprovider.md @@ -8,7 +8,7 @@ A provider handles and compiles templates using N:Mustache. public class MustacheTemplateProvider : Proffer.Templating.ITemplateProvider, Proffer.Templating.ITemplateProviderScope ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [MustacheTemplateProvider](./proffer.templating.mustache.mustachetemplateprovider)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [MustacheTemplateProvider](./proffer.templating.mustache.mustachetemplateprovider.md)
    Implements ITemplateProvider, ITemplateProviderScope ## Properties @@ -41,7 +41,7 @@ public ISet Extensions { get; } ### **MustacheTemplateProvider()** -Initializes a new instance of the [MustacheTemplateProvider](./proffer.templating.mustache.mustachetemplateprovider) class. +Initializes a new instance of the [MustacheTemplateProvider](./proffer.templating.mustache.mustachetemplateprovider.md) class. ```csharp public MustacheTemplateProvider() diff --git a/docs/api/templating/mustache/proffer.templating.mustacheservicecollectionextensions.md b/docs/api/templating/mustache/proffer.templating.mustacheservicecollectionextensions.md index e6abe28..0f846a1 100644 --- a/docs/api/templating/mustache/proffer.templating.mustacheservicecollectionextensions.md +++ b/docs/api/templating/mustache/proffer.templating.mustacheservicecollectionextensions.md @@ -8,7 +8,7 @@ Microsoft.Extensions.DependencyInjection.IServiceCollection extension methods. public static class MustacheServiceCollectionExtensions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [MustacheServiceCollectionExtensions](./proffer.templating.mustacheservicecollectionextensions) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [MustacheServiceCollectionExtensions](./proffer.templating.mustacheservicecollectionextensions.md) ## Methods diff --git a/docs/api/templating/proffer.templating.exceptions.providernotfoundexception.md b/docs/api/templating/proffer.templating.exceptions.providernotfoundexception.md index 11ba9e3..60914c1 100644 --- a/docs/api/templating/proffer.templating.exceptions.providernotfoundexception.md +++ b/docs/api/templating/proffer.templating.exceptions.providernotfoundexception.md @@ -8,7 +8,7 @@ Thrown when a matching provider was not found for a given template. public class ProviderNotFoundException : System.Exception, System.Runtime.Serialization.ISerializable ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [ProviderNotFoundException](./proffer.templating.exceptions.providernotfoundexception)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [ProviderNotFoundException](./proffer.templating.exceptions.providernotfoundexception.md)
    Implements [ISerializable](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.serialization.iserializable) ## Properties @@ -113,7 +113,7 @@ public int HResult { get; set; } ### **ProviderNotFoundException(String, String, String)** -Initializes a new instance of the [ProviderNotFoundException](./proffer.templating.exceptions.providernotfoundexception) class. +Initializes a new instance of the [ProviderNotFoundException](./proffer.templating.exceptions.providernotfoundexception.md) class. ```csharp public ProviderNotFoundException(string templateName, string extension, string contentType) diff --git a/docs/api/templating/proffer.templating.exceptions.templatenotfoundexception.md b/docs/api/templating/proffer.templating.exceptions.templatenotfoundexception.md index 4ffffe5..6435c4e 100644 --- a/docs/api/templating/proffer.templating.exceptions.templatenotfoundexception.md +++ b/docs/api/templating/proffer.templating.exceptions.templatenotfoundexception.md @@ -8,7 +8,7 @@ Thrown when a template was not found in the store. public class TemplateNotFoundException : System.Exception, System.Runtime.Serialization.ISerializable ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [TemplateNotFoundException](./proffer.templating.exceptions.templatenotfoundexception)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [TemplateNotFoundException](./proffer.templating.exceptions.templatenotfoundexception.md)
    Implements [ISerializable](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.serialization.iserializable) ## Properties @@ -113,7 +113,7 @@ public int HResult { get; set; } ### **TemplateNotFoundException(String)** -Initializes a new instance of the [TemplateNotFoundException](./proffer.templating.exceptions.templatenotfoundexception) class. +Initializes a new instance of the [TemplateNotFoundException](./proffer.templating.exceptions.templatenotfoundexception.md) class. ```csharp public TemplateNotFoundException(string templateName) diff --git a/docs/api/templating/proffer.templating.internal.templateloader.md b/docs/api/templating/proffer.templating.internal.templateloader.md index fb9230b..61b29a0 100644 --- a/docs/api/templating/proffer.templating.internal.templateloader.md +++ b/docs/api/templating/proffer.templating.internal.templateloader.md @@ -8,14 +8,14 @@ Loads template references from an Proffer.Storage.IStore and cache results. public class TemplateLoader : Proffer.Templating.ITemplateLoader ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [TemplateLoader](./proffer.templating.internal.templateloader)
    -Implements [ITemplateLoader](./proffer.templating.itemplateloader) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [TemplateLoader](./proffer.templating.internal.templateloader.md)
    +Implements [ITemplateLoader](./proffer.templating.itemplateloader.md) ## Constructors ### **TemplateLoader(IStore, IEnumerable<ITemplateProvider>, IMemoryCache)** -Initializes a new instance of the [TemplateLoader](./proffer.templating.internal.templateloader) class. +Initializes a new instance of the [TemplateLoader](./proffer.templating.internal.templateloader.md) class. ```csharp public TemplateLoader(IStore store, IEnumerable providers, IMemoryCache memoryCache) diff --git a/docs/api/templating/proffer.templating.internal.templateloaderfactory.md b/docs/api/templating/proffer.templating.internal.templateloaderfactory.md index 3232679..598f7f1 100644 --- a/docs/api/templating/proffer.templating.internal.templateloaderfactory.md +++ b/docs/api/templating/proffer.templating.internal.templateloaderfactory.md @@ -2,20 +2,20 @@ Namespace: Proffer.Templating.Internal -Creates [ITemplateLoader](./proffer.templating.itemplateloader) from Proffer.Storage.IStore. +Creates [ITemplateLoader](./proffer.templating.itemplateloader.md) from Proffer.Storage.IStore. ```csharp public class TemplateLoaderFactory : Proffer.Templating.ITemplateLoaderFactory ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [TemplateLoaderFactory](./proffer.templating.internal.templateloaderfactory)
    -Implements [ITemplateLoaderFactory](./proffer.templating.itemplateloaderfactory) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [TemplateLoaderFactory](./proffer.templating.internal.templateloaderfactory.md)
    +Implements [ITemplateLoaderFactory](./proffer.templating.itemplateloaderfactory.md) ## Constructors ### **TemplateLoaderFactory(IEnumerable<ITemplateProvider>, IMemoryCache)** -Initializes a new instance of the [TemplateLoaderFactory](./proffer.templating.internal.templateloaderfactory) class. +Initializes a new instance of the [TemplateLoaderFactory](./proffer.templating.internal.templateloaderfactory.md) class. ```csharp public TemplateLoaderFactory(IEnumerable providers, IMemoryCache memoryCache) @@ -46,7 +46,7 @@ The store. #### Returns -[ITemplateLoader](./proffer.templating.itemplateloader)
    +[ITemplateLoader](./proffer.templating.itemplateloader.md)
    A that loads templates from the given . @@ -68,6 +68,6 @@ The scope. #### Returns -[ITemplateLoader](./proffer.templating.itemplateloader)
    +[ITemplateLoader](./proffer.templating.itemplateloader.md)
    A that loads templates from the given . diff --git a/docs/api/templating/proffer.templating.invalidcontextexception.md b/docs/api/templating/proffer.templating.invalidcontextexception.md index c272aec..c183535 100644 --- a/docs/api/templating/proffer.templating.invalidcontextexception.md +++ b/docs/api/templating/proffer.templating.invalidcontextexception.md @@ -8,7 +8,7 @@ Thrown when the generation context is invalid for a template. public class InvalidContextException : System.Exception, System.Runtime.Serialization.ISerializable ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [InvalidContextException](./proffer.templating.invalidcontextexception)
    +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception) → [InvalidContextException](./proffer.templating.invalidcontextexception.md)
    Implements [ISerializable](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.serialization.iserializable) ## Properties @@ -113,7 +113,7 @@ public int HResult { get; set; } ### **InvalidContextException(Exception)** -Initializes a new instance of the [InvalidContextException](./proffer.templating.invalidcontextexception) class. +Initializes a new instance of the [InvalidContextException](./proffer.templating.invalidcontextexception.md) class. ```csharp public InvalidContextException(Exception innerException) diff --git a/docs/api/templating/proffer.templating.itemplate.md b/docs/api/templating/proffer.templating.itemplate.md index 52e80c2..e209e4e 100644 --- a/docs/api/templating/proffer.templating.itemplate.md +++ b/docs/api/templating/proffer.templating.itemplate.md @@ -30,7 +30,7 @@ The templated result. #### Exceptions -[InvalidContextException](./proffer.templating.invalidcontextexception)
    +[InvalidContextException](./proffer.templating.invalidcontextexception.md)
    ### **Apply(Object, IFormatProvider)** @@ -56,4 +56,4 @@ The format provider. #### Exceptions -[InvalidContextException](./proffer.templating.invalidcontextexception)
    +[InvalidContextException](./proffer.templating.invalidcontextexception.md)
    diff --git a/docs/api/templating/proffer.templating.itemplateloaderfactory.md b/docs/api/templating/proffer.templating.itemplateloaderfactory.md index 8a50631..22a36df 100644 --- a/docs/api/templating/proffer.templating.itemplateloaderfactory.md +++ b/docs/api/templating/proffer.templating.itemplateloaderfactory.md @@ -2,7 +2,7 @@ Namespace: Proffer.Templating -Creates [ITemplateLoader](./proffer.templating.itemplateloader) from Proffer.Storage.IStore. +Creates [ITemplateLoader](./proffer.templating.itemplateloader.md) from Proffer.Storage.IStore. ```csharp public interface ITemplateLoaderFactory @@ -25,7 +25,7 @@ The store. #### Returns -[ITemplateLoader](./proffer.templating.itemplateloader)
    +[ITemplateLoader](./proffer.templating.itemplateloader.md)
    A that loads templates from the given . ### **Create(IStore, String)** @@ -46,5 +46,5 @@ The cache scope. #### Returns -[ITemplateLoader](./proffer.templating.itemplateloader)
    +[ITemplateLoader](./proffer.templating.itemplateloader.md)
    A that loads templates from the given . diff --git a/docs/api/templating/proffer.templating.itemplateprovider.md b/docs/api/templating/proffer.templating.itemplateprovider.md index 2bb75c1..8b82644 100644 --- a/docs/api/templating/proffer.templating.itemplateprovider.md +++ b/docs/api/templating/proffer.templating.itemplateprovider.md @@ -46,5 +46,5 @@ ITemplateProviderScope CreateScope() #### Returns -[ITemplateProviderScope](./proffer.templating.itemplateproviderscope)
    +[ITemplateProviderScope](./proffer.templating.itemplateproviderscope.md)
    A new templating provider scope. diff --git a/docs/api/templating/proffer.templating.itemplateproviderscope.md b/docs/api/templating/proffer.templating.itemplateproviderscope.md index 306c2d1..aac7214 100644 --- a/docs/api/templating/proffer.templating.itemplateproviderscope.md +++ b/docs/api/templating/proffer.templating.itemplateproviderscope.md @@ -25,7 +25,7 @@ Content of the template. #### Returns -[ITemplate](./proffer.templating.itemplate)
    +[ITemplate](./proffer.templating.itemplate.md)
    A new compiled from the content. ### **RegisterPartial(String, String)** diff --git a/docs/api/templating/proffer.templating.templatecollectionbase-1.md b/docs/api/templating/proffer.templating.templatecollectionbase-1.md index d8b0d0b..4659acf 100644 --- a/docs/api/templating/proffer.templating.templatecollectionbase-1.md +++ b/docs/api/templating/proffer.templating.templatecollectionbase-1.md @@ -13,7 +13,7 @@ public abstract class TemplateCollectionBase : TemplateCollectionBase `TStore`
    The type of the store. -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [TemplateCollectionBase](./proffer.templating.templatecollectionbase) → [TemplateCollectionBase<TStore>](./proffer.templating.templatecollectionbase-1) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [TemplateCollectionBase](./proffer.templating.templatecollectionbase.md) → [TemplateCollectionBase<TStore>](./proffer.templating.templatecollectionbase-1.md) ## Properties @@ -27,13 +27,13 @@ public ITemplateLoader Loader { get; } #### Property Value -[ITemplateLoader](./proffer.templating.itemplateloader)
    +[ITemplateLoader](./proffer.templating.itemplateloader.md)
    ## Constructors ### **TemplateCollectionBase(TStore, ITemplateLoaderFactory)** -Initializes a new instance of the [TemplateCollectionBase<TStore>](./proffer.templating.templatecollectionbase-1) class. +Initializes a new instance of the [TemplateCollectionBase<TStore>](./proffer.templating.templatecollectionbase-1.md) class. ```csharp public TemplateCollectionBase(TStore store, ITemplateLoaderFactory templateLoaderFactory) @@ -44,5 +44,5 @@ public TemplateCollectionBase(TStore store, ITemplateLoaderFactory templateLoade `store` TStore
    The typed store. -`templateLoaderFactory` [ITemplateLoaderFactory](./proffer.templating.itemplateloaderfactory)
    +`templateLoaderFactory` [ITemplateLoaderFactory](./proffer.templating.itemplateloaderfactory.md)
    The template loader factory. diff --git a/docs/api/templating/proffer.templating.templatecollectionbase.md b/docs/api/templating/proffer.templating.templatecollectionbase.md index 8dd1cc1..d6e237d 100644 --- a/docs/api/templating/proffer.templating.templatecollectionbase.md +++ b/docs/api/templating/proffer.templating.templatecollectionbase.md @@ -8,7 +8,7 @@ Abstract base class to load and apply templates from a named Proffer.Storage.ISt public abstract class TemplateCollectionBase ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [TemplateCollectionBase](./proffer.templating.templatecollectionbase) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [TemplateCollectionBase](./proffer.templating.templatecollectionbase.md) ## Properties @@ -22,13 +22,13 @@ public ITemplateLoader Loader { get; } #### Property Value -[ITemplateLoader](./proffer.templating.itemplateloader)
    +[ITemplateLoader](./proffer.templating.itemplateloader.md)
    ## Constructors ### **TemplateCollectionBase(String, IStorageFactory, ITemplateLoaderFactory)** -Initializes a new instance of the [TemplateCollectionBase](./proffer.templating.templatecollectionbase) class. +Initializes a new instance of the [TemplateCollectionBase](./proffer.templating.templatecollectionbase.md) class. ```csharp public TemplateCollectionBase(string storeName, IStorageFactory storageFactory, ITemplateLoaderFactory templateLoaderFactory) @@ -42,7 +42,7 @@ The name of the store. `storageFactory` IStorageFactory
    The storage factory. -`templateLoaderFactory` [ITemplateLoaderFactory](./proffer.templating.itemplateloaderfactory)
    +`templateLoaderFactory` [ITemplateLoaderFactory](./proffer.templating.itemplateloaderfactory.md)
    The template loader factory. ## Methods diff --git a/docs/api/templating/proffer.templating.templatingservicecollectionextensions.md b/docs/api/templating/proffer.templating.templatingservicecollectionextensions.md index 13d4662..0e34ef9 100644 --- a/docs/api/templating/proffer.templating.templatingservicecollectionextensions.md +++ b/docs/api/templating/proffer.templating.templatingservicecollectionextensions.md @@ -8,7 +8,7 @@ Microsoft.Extensions.DependencyInjection.IServiceCollection extension methods. public static class TemplatingServiceCollectionExtensions ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [TemplatingServiceCollectionExtensions](./proffer.templating.templatingservicecollectionextensions) +Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [TemplatingServiceCollectionExtensions](./proffer.templating.templatingservicecollectionextensions.md) ## Methods diff --git a/src/Directory.Build.targets b/src/Directory.Build.targets index 0890d95..f58e5ff 100644 --- a/src/Directory.Build.targets +++ b/src/Directory.Build.targets @@ -1,6 +1,6 @@ - + \ No newline at end of file From 3604ddb4dc27ae2cc684408c81b5d5b895a6b92d Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Sat, 22 May 2021 06:39:38 +0200 Subject: [PATCH 43/45] Fix API --- docs/{_pages/api.md => api/index.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{_pages/api.md => api/index.md} (100%) diff --git a/docs/_pages/api.md b/docs/api/index.md similarity index 100% rename from docs/_pages/api.md rename to docs/api/index.md From f2a88c9beb63c62e409a6e0a40ed3e7e39b64cd4 Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Sat, 22 May 2021 06:51:47 +0200 Subject: [PATCH 44/45] API navigation --- docs/_config.yml | 4 +++- docs/_data/navigation.yml | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 40 insertions(+), 1 deletion(-) diff --git a/docs/_config.yml b/docs/_config.yml index f2f5204..3adab49 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -23,7 +23,7 @@ url: https://getproffer.net repository: asiffermann/proffer teaser: /assets/images/banner.png logo: /assets/images/logo.png -breadcrumbs: true +breadcrumbs: false words_per_minute: 200 comments: provider: # false (default), "disqus", "discourse", "facebook", "staticman", "staticman_v2", "utterances", "custom" @@ -269,6 +269,8 @@ defaults: author_profile: false toc: true toc_sticky: true + sidebar: + nav: "api" # _docs - scope: path: "" diff --git a/docs/_data/navigation.yml b/docs/_data/navigation.yml index b196977..485e814 100644 --- a/docs/_data/navigation.yml +++ b/docs/_data/navigation.yml @@ -49,3 +49,40 @@ docs: url: /docs/email/smtp - title: "SendGrid" url: /docs/email/SendGrid + +# api documentation links +api: + - title: Home + url: /api + - title: Core libraries + url: /api/core + children: + - title: "Azure" + url: /api/core/azure + - title: Storage + url: /api/storage + children: + - title: "FileSystem" + url: /api/storage/filesystem + - title: "FileSystem Server" + url: /api/storage/filesystem/server + - title: "FileSystem Json Properties" + url: /api/storage/filesystem/properties/json + - title: "Azure Blobs" + url: /api/storage/azure/blobs + - title: Templating + url: /api/templating + children: + - title: "HandleBars" + url: /api/templating/handlebars + - title: "Mustache" + url: /api/templating/mustache + - title: Email + url: /api/email + children: + - title: "In memory" + url: /api/email/in-memory + - title: "SMTP" + url: /api/email/smtp + - title: "SendGrid" + url: /api/email/SendGrid From 7a10eaf998b71ceee49dbe6f887bd927f3080889 Mon Sep 17 00:00:00 2001 From: Adrien Siffermann Date: Sat, 22 May 2021 06:55:43 +0200 Subject: [PATCH 45/45] API --- docs/_config.yml | 1 - docs/_data/navigation.yml | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/_config.yml b/docs/_config.yml index 3adab49..80dac8e 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -268,7 +268,6 @@ defaults: layout: single author_profile: false toc: true - toc_sticky: true sidebar: nav: "api" # _docs diff --git a/docs/_data/navigation.yml b/docs/_data/navigation.yml index 485e814..cd5fd5c 100644 --- a/docs/_data/navigation.yml +++ b/docs/_data/navigation.yml @@ -52,7 +52,7 @@ docs: # api documentation links api: - - title: Home + - title: API url: /api - title: Core libraries url: /api/core