Skip to content

Commit 2d34eab

Browse files
committed
readme
1 parent b2564ac commit 2d34eab

File tree

3 files changed

+26
-41
lines changed

3 files changed

+26
-41
lines changed

README.md

+5-20
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![Maintainability](https://api.codeclimate.com/v1/badges/369f0a7ff28279088d9c/maintainability)](https://codeclimate.com/github/petrsvihlik/WopiHost/maintainability)
66
[![CodeFactor](https://www.codefactor.io/repository/github/petrsvihlik/wopihost/badge/master)](https://www.codefactor.io/repository/github/petrsvihlik/wopihost/overview/master)
77
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fpetrsvihlik%2FWopiHost.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fpetrsvihlik%2FWopiHost?ref=badge_shield)
8-
[![.NET Core](https://img.shields.io/badge/net-8-692079.svg)](https://dotnet.microsoft.com/download/dotnet/8.0)
8+
[![.NET Core](https://img.shields.io/badge/net-9-692079.svg)](https://dotnet.microsoft.com/download/dotnet/9.0)
99

1010
| Package | Version | Downloads |
1111
| ------------- | :-------------: | :-------------: |
@@ -15,20 +15,6 @@
1515
| `WopiHost.FileSystemProvider` | [![NuGet](https://img.shields.io/nuget/v/WopiHost.FileSystemProvider.svg)](https://www.nuget.org/packages/WopiHost.FileSystemProvider) | [![NuGet](https://img.shields.io/nuget/dt/WopiHost.FileSystemProvider.svg)](https://www.nuget.org/packages/WopiHost.FileSystemProvider) |
1616
| `WopiHost.Url` | [![NuGet](https://img.shields.io/nuget/v/WopiHost.Url.svg)](https://www.nuget.org/packages/WopiHost.Url) | [![NuGet](https://img.shields.io/nuget/dt/WopiHost.Url.svg)](https://www.nuget.org/packages/WopiHost.Url) |
1717

18-
Supporters
19-
==========
20-
21-
Sponsors
22-
---------
23-
<a href="https://github.com/scottgal"><img src="https://github.com/scottgal.png" width="80" alt="scottgal" /></a>
24-
25-
<!-- sponsors --><!-- sponsors -->
26-
27-
Contributors
28-
---------
29-
[![Contributors](https://contrib.rocks/image?repo=petrsvihlik/wopihost)](https://github.com/petrsvihlik/wopihost/graphs/contributors)
30-
31-
3218

3319
Introduction
3420
==========
@@ -53,12 +39,12 @@ Usage
5339

5440
Prerequisites
5541
-------------
56-
- [.NET 8 SDK](https://dotnet.microsoft.com/download/dotnet/8.0)
42+
- [.NET 9 SDK](https://dotnet.microsoft.com/download/dotnet/9.0)
5743
- Recommended: [VS Code](https://code.visualstudio.com/) or [Visual Studio 2022](https://visualstudio.microsoft.com/vs/)
5844

5945
Building the app
6046
----------------
61-
The WopiHost app targets `net8.0` exclusively.
47+
The WopiHost app targets `net9.0` exclusively.
6248

6349
If you need a version that's targeting an older version of .NET, check out the releases:
6450
- [.NET 6](TBD)
@@ -146,7 +132,7 @@ https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines/
146132
License
147133
=======
148134
- [LICENSE.txt](https://github.com/petrsvihlik/WopiHost/blob/master/LICENSE.txt) - License for my part of the project
149-
- [ORIGINAL_WORK_LICENSE.txt](https://github.com/petrsvihlik/WopiHost/blob/master/WopiHost.Cobalt/ORIGINAL_WORK_LICENSE.txt) - License for Marx Yu's part of the project. This project is based on [Marx Yu's project](https://github.com/marx-yu/WopiHost).
135+
- [ORIGINAL_WORK_LICENSE.txt](https://github.com/petrsvihlik/WopiHost/blob/master/src/WopiHost.Cobalt/ORIGINAL_WORK_LICENSE.txt) - License for Marx Yu's part of the project. This project is based on [Marx Yu's project](https://github.com/marx-yu/WopiHost).
150136
- [NOTICE.txt](https://github.com/petrsvihlik/WopiHost/blob/master/NOTICE.txt) - additional notes to how the licenses are applied
151137

152138

@@ -156,13 +142,12 @@ Building WOPI Host
156142
-----------------------
157143
- [Official WOPI Documentation](https://learn.microsoft.com/microsoft-365/cloud-storage-partner-program/rest/)
158144
- [Official WOPI REST API Reference](https://learn.microsoft.com/openspecs/office_protocols/ms-wopi/6a8bb410-68ad-47e4-9dc3-6cf29c6b046b)
159-
- [Building an Office Web Apps (OWA) WOPI Host by Shawn Cicoria](https://code.msdn.microsoft.com/office/Building-an-Office-Web-f98650d6) + [WOPI Host and url paths](https://www.cicoria.com/office-web-appswopi-host-and-url-paths/)
145+
- [WOPI Host and url paths](https://www.cicoria.com/office-web-appswopi-host-and-url-paths/)
160146
- [Office Online integration via WOPI Host by Richard diZerega](https://github.com/OfficeDev/PnP-WOPI) + [video](https://www.youtube.com/watch?v=9lGonu0eoGA)
161147

162148
MS-FSSHTTP (Cobalt)
163149
-------
164150
- https://docs.microsoft.com/en-us/openspecs/sharepoint_protocols/ms-fsshttp/6d078cbe-2651-43a0-b460-685ac3f14c45
165-
- https://channel9.msdn.com/Events/Open-Specifications-Plugfests/Redmond-Interoperability-Protocols-Plugfest-2015/FSSHTTP-File-Synchronization-over-HTTP
166151

167152
Building WOPI Client
168153
-------------------------

src/WopiHost.Core/Models/CheckContainerInfo.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ public class CheckContainerInfo
2020
/// <summary>
2121
/// A URI to a webpage for the container.
2222
/// </summary>
23-
public string HostUrl { get; set; }
23+
public Uri HostUrl { get; set; }
2424

2525
/// <summary>
2626
/// A Boolean value indicating whether the user is an education user or not. This should match the IsEduUser value returned in CheckFileInfo.
@@ -35,7 +35,7 @@ public class CheckContainerInfo
3535
/// <summary>
3636
/// A URI to a webpage to allow the user to control sharing of the container. This is analogous to the FileSharingUrl in CheckFileInfo.
3737
/// </summary>
38-
public string SharingUrl { get; set; }
38+
public Uri SharingUrl { get; set; }
3939

4040
/// <summary>
4141
/// A Boolean value that indicates the user has permission to create a new container in the container.

src/WopiHost.Core/Models/CheckFileInfo.cs

+19-19
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ public class CheckFileInfo
6060
/// <summary>
6161
/// A URI to a web page that the WOPI client should navigate to when the user clicks on UI that displays <see cref="BreadcrumbBrandName"/>.
6262
/// </summary>
63-
public string BreadcrumbBrandUrl { get; set; }
63+
public Uri BreadcrumbBrandUrl { get; set; }
6464

6565
/// <summary>
6666
/// A string that indicates the name of the file. If this is not provided, WOPI clients may use the <see cref="BaseFileName"/> value.
@@ -70,7 +70,7 @@ public class CheckFileInfo
7070
/// <summary>
7171
/// MAY specifies a URI to a web page that the WOPI client navigates to when the user clicks on UI that displays <see cref="BreadcrumbDocName"/>.
7272
/// </summary>
73-
public string BreadcrumbDocUrl { get; set; }
73+
public Uri BreadcrumbDocUrl { get; set; }
7474

7575
/// <summary>
7676
/// A string that indicates the name of the container that contains the file.
@@ -80,12 +80,12 @@ public class CheckFileInfo
8080
/// <summary>
8181
/// A URI to a web page that the WOPI client should navigate to when the user clicks on UI that displays <see cref="BreadcrumbFolderName"/>.
8282
/// </summary>
83-
public string BreadcrumbFolderUrl { get; set; }
83+
public Uri BreadcrumbFolderUrl { get; set; }
8484

8585
/// <summary>
8686
/// A user-accessible URI directly to the file intended for opening the file through a client.
8787
/// </summary>
88-
public string ClientUrl { get; set; }
88+
public Uri ClientUrl { get; set; }
8989

9090
/// <summary>
9191
/// A Boolean value that indicates the WOPI client should close the window or tab when the user activates any <c>Close</c> UI in the WOPI client.
@@ -95,7 +95,7 @@ public class CheckFileInfo
9595
/// <summary>
9696
/// A URI to a web page that the WOPI client should navigate to when the application closes, or in the event of an unrecoverable error.
9797
/// </summary>
98-
public string CloseUrl { get; set; }
98+
public Uri CloseUrl { get; set; }
9999

100100
/// <summary>
101101
/// A Boolean value that indicates that the WOPI client should disable caching of file contents in the browser cache. Note that this has important performance implications for web browser-based WOPI clients.
@@ -130,27 +130,27 @@ public class CheckFileInfo
130130
/// <summary>
131131
/// A user-accessible URI to the file intended to allow the user to download a copy of the file. This URI should directly download the file and it should always provide the most recent version of the file.
132132
/// </summary>
133-
public string DownloadUrl { get; set; }
133+
public Uri DownloadUrl { get; set; }
134134

135135
/// <summary>
136136
/// A URI to a location that allows the user to create an embeddable URI to the file.
137137
/// </summary>
138-
public string FileEmbedCommandUrl { get; set; }
138+
public Uri FileEmbedCommandUrl { get; set; }
139139

140140
/// <summary>
141141
/// A URI to a location that allows the user to share the file.
142142
/// </summary>
143-
public string FileSharingUrl { get; set; }
143+
public Uri FileSharingUrl { get; set; }
144144

145145
/// <summary>
146146
/// A URI to the file location that the WOPI client uses to get the file.
147147
/// </summary>
148-
public string FileUrl { get; set; }
148+
public Uri FileUrl { get; set; }
149149

150150
/// <summary>
151151
/// A URI to a location that allows the user to view the version history for the file.
152152
/// </summary>
153-
public string FileVersionUrl { get; set; }
153+
public Uri FileVersionUrl { get; set; }
154154

155155
/// <summary>
156156
/// A string value uniquely identifying the user currently accessing the file.
@@ -160,17 +160,17 @@ public class CheckFileInfo
160160
/// <summary>
161161
/// A URI to a <see href="https://learn.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/glossary#host-page">host page</see> that loads the <c>edit</c> WOPI action.
162162
/// </summary>
163-
public string HostEditUrl { get; set; }
163+
public Uri HostEditUrl { get; set; }
164164

165165
/// <summary>
166166
/// A URI to a web page that provides access to an editing experience for the file that can be embedded in another HTML page.
167167
/// </summary>
168-
public string HostEmbeddedEditUrl { get; set; }
168+
public Uri HostEmbeddedEditUrl { get; set; }
169169

170170
/// <summary>
171171
/// A URI to a web page that provides access to a viewing experience for the file that can be embedded in another HTML page. This is typically a URI to a <see href="https://learn.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/glossary#host-page">host page</see> that loads the <c>embedview</c> WOPI action.
172172
/// </summary>
173-
public string HostEmbeddedViewUrl { get; set; }
173+
public Uri HostEmbeddedViewUrl { get; set; }
174174

175175
/// <summary>
176176
/// A string that is the name provided by the WOPI server used to identify it for logging and other informational purposes.
@@ -185,12 +185,12 @@ public class CheckFileInfo
185185
/// <summary>
186186
/// A URI that is the base URI for REST operations for the file.
187187
/// </summary>
188-
public string HostRestUrl { get; set; }
188+
public Uri HostRestUrl { get; set; }
189189

190190
/// <summary>
191191
/// A URI to a <see href="https://learn.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/glossary#host-page">host page</see> that loads the <c>view</c> WOPI action. This URL is used by Office Online to navigate between view and edit mode.
192192
/// </summary>
193-
public string HostViewUrl { get; set; }
193+
public Uri HostViewUrl { get; set; }
194194

195195
/// <summary>
196196
/// A string that the WOPI client should display to the user indicating the IRM policy for the file. This value should be combined with <see cref="IrmPolicyTitle"/>.
@@ -215,7 +215,7 @@ public class CheckFileInfo
215215
/// <summary>
216216
/// A URI to a webpage that explains the privacy policy of the WOPI server.
217217
/// </summary>
218-
public string PrivacyUrl { get; set; }
218+
public Uri PrivacyUrl { get; set; }
219219

220220
/// <summary>
221221
/// A Boolean value that indicates that the WOPI client should take measures to prevent copying and printing of the file.
@@ -226,7 +226,7 @@ public class CheckFileInfo
226226
/// A URI that will allow the user to sign in using the host’s authentication system. This property can be used when supporting anonymous users. If this property is not provided, no sign in UI will be shown in Office Online.
227227
/// <para>See also <seealso cref="SignoutUrl"/></para>
228228
/// </summary>
229-
public string SignInUrl { get; set; }
229+
public Uri SignInUrl { get; set; }
230230

231231
/// <summary>
232232
/// A Boolean value that indicates that, for this user, the file cannot be changed.
@@ -251,7 +251,7 @@ public class CheckFileInfo
251251
/// <summary>
252252
/// A URI that will sign the current user out of the host’s authentication system.
253253
/// </summary>
254-
public string SignoutUrl { get; set; }
254+
public Uri SignoutUrl { get; set; }
255255

256256
/// <summary>
257257
/// A Boolean value that indicates that the WOPI server supports multiple users making changes to this file simultaneously.
@@ -454,7 +454,7 @@ public bool SupportsFolders
454454
/// <summary>
455455
/// A URI to a webpage that explains the terms of use policy of the WOPI server.
456456
/// </summary>
457-
public string TermsOfUseUrl { get; set; }
457+
public Uri TermsOfUseUrl { get; set; }
458458

459459
/// <summary>
460460
/// A string that is used to pass time zone information to a WOPI client. The format of this value is determined by the host.

0 commit comments

Comments
 (0)