Skip to content

Commit f7e0402

Browse files
committed
Fixup MSDOCS rule issues from recent update.
1 parent 34c17f9 commit f7e0402

File tree

50 files changed

+2247
-2214
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+2247
-2214
lines changed

docs/apis/alm-api-for-spfx-add-ins.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ ALM APIs can be used to perform exactly the same operations that are available f
2828
ALM APIs are supported for the tenant-scoped site collections and [site collection app catalog](../general-development/site-collection-app-catalog.md). Use the corresponding app catalog's URL to target a specific app catalog. You must first enabled a site collection app catalog before targeting it with the actions documented on this page.
2929

3030
> [!IMPORTANT]
31-
> Tenant-scoped permissions which require [tenant administrative approval](https://docs.microsoft.com/sharepoint/dev/solution-guidance/how-to-provide-add-in-app-only-tenant-administrative-permissions-in-sharepoint-online) are not supported with the ALM APIs.
31+
> Tenant-scoped permissions which require [tenant administrative permissions](../solution-guidance/how-to-provide-add-in-app-only-tenant-administrative-permissions-in-sharepoint-online.md) are not supported with the ALM APIs.
3232
3333
## Options for working with ALM APIs
3434

@@ -42,12 +42,12 @@ The app catalog must be included in all HTTP requests when using the REST API as
4242

4343
For example:
4444

45-
| Scope | Endpoint |
46-
| :-------------- | :--------------------------------------------------------------------------------------------- |
47-
| tenant | **https://contoso.sharepoint.com/sites/AppCatalog/_api/web/tenantappcatalog/{command}** |
48-
| site collection | **https://contoso.sharepoint.com/sites/Marketing/_api/web/sitecollectionappcatalog/{command}** |
45+
| Scope | Endpoint |
46+
| :-------------- | :------------------------------------------------------------------------------------------- |
47+
| tenant | `https://contoso.sharepoint.com/sites/AppCatalog/_api/web/tenantappcatalog/{command}` |
48+
| site collection | `https://contoso.sharepoint.com/sites/Marketing/_api/web/sitecollectionappcatalog/{command}` |
4949

50-
- when targeting the tenant app catalog located at **https://contoso.sharepoint.com/sites/AppCatalog**, the endpoint would be **
50+
- when targeting the tenant app catalog located at `https://contoso.sharepoint.com/sites/AppCatalog`, the endpoint would be **
5151

5252
Learn more here: [SharePoint REST API](../sp-add-ins/get-to-know-the-sharepoint-rest-service.md)
5353

Lines changed: 108 additions & 106 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Build mobile apps for other platforms using SharePoint
3+
description: Learn how to use Representational State Transfer (REST) to create a SharePoint mobile app for any platform.
34
ms.date: 09/25/2017
45
ms.prod: sharepoint
56
ms.assetid: 017df869-44fb-4ffe-82fb-4654e01329ad
@@ -9,94 +10,95 @@ localization_priority: Priority
910

1011
# Build mobile apps for other platforms using SharePoint
1112
Learn how to use Representational State Transfer (REST) to create a SharePoint mobile app for any platform.
13+
1214
Mobile devices have become more powerful and easy to use nowadays. Laptops, netbooks, tablet PCs, and mobile phones provide workers access to the information and applications that they need to do their jobs. And developing applications for mobile devices is now easier than ever. As a result, more and more business scenarios demand integrating client applications together with their business processes. This article describes how to integrate mobile client apps together with SharePoint. You can create a mobile app to browse SharePoint content from any ___location and connect with SharePoint lists and libraries to access data.
13-
14-
15-
15+
16+
17+
1618

1719
To develop a mobile app that interacts with SharePoint, you can use common services that can be accessed using open protocols. SharePoint Foundation 2010 introduced the client object models, which enabled developers to perform remote communication with SharePoint by using the web programming technology of their choice: .NET Framework, Microsoft Silverlight, or JavaScript. SharePoint introduces a Representational State Transfer (REST) service that is fully comparable to the client object models. In SharePoint, nearly every API in the client object models will have a corresponding REST endpoint. Now, developers can interact remotely with the SharePoint object model by using any technology that supports REST web requests. REST can be consumed by any programming language that you want to use for your mobile application development.
1820
You can perform basic create, read, update, and delete (CRUD) operations by using the REST interface provided by SharePoint. REST exposes all of the SharePoint entities and operations that are available in the other SharePoint client APIs. One advantage of using REST is that you don't have to add references to any SharePoint libraries or client assemblies. Instead, you make HTTP requests to the appropriate endpoints to retrieve or update SharePoint entities, such as webs, lists, and list items. For a thorough introduction to the SharePoint REST interface and its architecture, see [Use OData query operations in SharePoint REST requests](https://msdn.microsoft.com/library/d4b5c277-ed50-420c-8a9b-860342284b72%28Office.15%29.aspx).
19-
20-
21-
21+
22+
23+
2224

2325

2426
## REST endpoints in SharePoint
2527
<a name="BuildMobileAppsInSharePoint2013ForNonWindowsPhone_REST_EndpointsInSharePoint2013"> </a>
2628

2729
To use the REST capabilities that are built into SharePoint, you can construct a RESTful HTTP request using the Open Data Protocol (OData) standard that corresponds to the desired client object model API. The client.svc web service handles the HTTP request and serves the appropriate response, in either Atom or JavaScript Object Notation (JSON) format. The client application must then parse that response. Figure 1 shows a high-level view of the SharePoint REST architecture.
28-
29-
30-
30+
31+
32+
3133

3234
**Figure 1. SharePoint REST architecture**
3335

34-
35-
36-
3736

38-
39-
40-
37+
38+
39+
40+
41+
42+
4143
![SharePoint REST architecture](../images/SP15Con_BuildSharePointAppsForMobileDevices_Fig2.png)
42-
43-
44-
44+
45+
46+
4547
The endpoints in the SharePoint REST service correspond to the types and members in the SharePoint client object models. By using HTTP requests, you can use these REST endpoints to perform typical CRUD operations against SharePoint artifacts, such as lists and sites.
46-
47-
48-
48+
49+
50+
4951
In general:
50-
51-
52-
52+
53+
54+
5355

5456
- Endpoints that represent read operations map to HTTP **GET** commands.
55-
56-
57+
58+
5759
- Endpoints that represent update operations map to HTTP **POST** commands.
58-
59-
60+
61+
6062
- Endpoints that represent update or insert operations map to HTTP **PUT** commands.
61-
62-
63+
64+
6365
In choosing an HTTP request to use, you should also consider the following:
64-
65-
66-
66+
67+
68+
6769

6870
- Use **POST** to create artifacts such as lists and sites. The SharePoint REST service supports sending **POST** commands that include object definitions to endpoints that represent collections.
69-
70-
71+
72+
7173
- For **POST** operations, any properties that are not required are set to their default values. If you try to set a read-only property as part of a **POST** operation, the service returns an exception.
72-
73-
74+
75+
7476
- Use **PUT**, **PATCH**, and **MERGE** operations to update existing SharePoint objects. Any service endpoint that represents an object property **set** operation supports both **PUT** requests and **MERGE** requests. For **MERGE** requests, setting properties is optional; any properties that you do not explicitly set retain their current property. But for **PUT** commands, any properties you do not explicitly set are set to their default properties. In addition, if you do not specify all settable properties in object updates when you use HTTP **PUT** commands, the REST service returns an exception.
75-
76-
77+
78+
7779
- Use the HTTP **DELETE** command against the specific endpoint URL to delete the SharePoint object represented by that endpoint. For recyclable objects, such as lists, files, and list items, this results in a **Recycle** operation. For more information, see [Get to know the SharePoint REST service](https://msdn.microsoft.com/library/2de035a0-ac75-43bd-9665-5c5a59c4c590%28Office.15%29.aspx).
78-
79-
80+
81+
8082

8183
## Authenticate users to SharePoint
8284
<a name="BuildMobileAppsInSharePoint2013ForNonWindowsPhone_AuthenticatingNonWindowsAppForSharePoint"> </a>
8385

8486
To authenticate your mobile app with SharePoint, you can use the MS-OFBA protocol. For more information, see [[MS-OFBA]: Office Forms Based Authentication Protocol Specification](https://msdn.microsoft.com/library/30c7bbe9-b284-421f-b866-4e7ed4866027%28Office.15%29.aspx). The protocol client is configured to store and transmit cookies. The protocol client relies on the remote protocol server to set the user's identity as one or more HTTP cookies. After the user's identity is established, the client then sends each cookie with each subsequent HHT request.
85-
86-
87-
87+
88+
89+
8890
When a user signs in to SharePoint, the user's token is validated and then used to sign in to SharePoint. The user's token is a security token that is issued by an identity provider. SharePoint supports several kinds of authentication. For more information, see [Authentication, authorization, and security in SharePoint](authentication-authorization-and-security-in-sharepoint.md). To authenticate a user, you can use the REST interface. The authorization process verifies that an authenticated subject (an app or a user the app is acting on behalf of.md) has permission to perform certain operations or to access specific resources (for example, a list or a SharePoint document folder.md).
89-
90-
91-
91+
92+
93+
9294
OData lets you access a data source, such as a database, by browsing to a specially constructed URL. This allows for a simplified approach for connecting to, and working with, data sources that are hosted within an organization. OData is a protocol that uses HTTP, Atom, and JavaScript Object Notation (JSON) to enable developers to write applications that communicate with an ever-growing number of data sources. Microsoft supports the creation of this standard as a way to enable the exchange of data between applications and data stores that can be accessed from the web. The new OData connector enables SharePoint to communicate with OData providers. For more information, see [Open Data Protocol](http://www.odata.org).
93-
94-
95-
95+
96+
97+
9698
The following code demonstrates how to authenticate your app to SharePoint using REST endpoints for basic or forms-based authentication. The following code example is written in C#, but any other programming language can be used to create the Http request, as per the requirement of the platform.
97-
98-
99-
99+
100+
101+
100102

101103

102104

@@ -118,7 +120,7 @@ void odataAt_AuthenticationCompleted(object sender, AuthenticationCompletedEvent
118120
endpointRequest.Method = "GET";
119121
endpointRequest.Accept = "application/json;odata=verbose";
120122
endpointRequest.CookieContainer = (sender as ODataAuthenticator).CookieContainer;
121-
123+
122124
endpointRequest.BeginGetResponse(new AsyncCallback((IAsyncResult res) =>
123125
{
124126
HttpWebRequest webReq = res.AsyncState as HttpWebRequest;
@@ -136,21 +138,21 @@ void odataAt_AuthenticationCompleted(object sender, AuthenticationCompletedEvent
136138
```
137139

138140
To authenticate an **HttpWebrequest** to the endpoint, you should first authenticate to SharePoint with the **ODataAuthenticator** class. Before calling the **Authenticate** method, register the **ODataAuthenticator** object to the **AuthenticationCompleted** event.
139-
140-
141-
141+
142+
143+
142144
After authentication is done inside the **OnAuthenticationCompleted** event, you can use the **CookieContainer** property on the **ODataAuthenticator** object, which can be attached to the **HttpWebRequest** object to authenticate the REST calls to SharePoint.
143-
144-
145-
145+
146+
147+
146148

147149
## Work with SharePoint list items using REST
148150
<a name="BuildMobileAppsInSharePoint2013ForNonWindowsPhone_WorkingWithTheSharePointListItemUsingREST"> </a>
149151

150152
The following example shows how to **retrieve** all of a list's items.
151-
152-
153-
153+
154+
155+
154156

155157
```
156158
@@ -166,9 +168,9 @@ headers:
166168
```
167169

168170
The following example shows how to **retrieve** a specific list item.
169-
170-
171-
171+
172+
173+
172174

173175

174176

@@ -177,17 +179,17 @@ The following example shows how to **retrieve** a specific list item.
177179
url: http://site url/_api/web/lists/GetByTitle('Test')/items(item id)
178180
method: GET
179181
headers:
180-
182+
181183
// MS-OFBA protocol return a cookie.
182184
Cookie: cookie
183185
accept: "application/json;odata=verbose" or "application/atom+xml"
184186
185187
```
186188

187189
The following XML shows an example of the list item properties that are returned when you request the XML content type.
188-
189-
190-
190+
191+
192+
191193

192194

193195

@@ -212,13 +214,13 @@ The following XML shows an example of the list item properties that are returned
212214
```
213215

214216
The following example shows how to **create** a list item.
215-
217+
216218
> [!NOTE]
217-
>
219+
>
218220
> To do this operation, you must know the **ListItemEntityTypeFullName** property of the list and pass that as the value of **type** in the HTTP request body.
219-
220-
221-
221+
222+
223+
222224

223225

224226

@@ -229,7 +231,7 @@ url: http://site url/_api/web/lists/GetByTitle('Test')/items
229231
method: POST
230232
body: { '__metadata': { 'type': 'SP.Data.TestListItem' }, 'Title': 'Test'}
231233
headers:
232-
234+
233235
// MS-OFBA protocol returns a cookie.
234236
Cookie: cookie
235237
X-RequestDigest = form digest value
@@ -239,12 +241,12 @@ headers:
239241
```
240242

241243
The following example shows how to **update** a list item.
242-
244+
243245
> [!NOTE]
244246
> To do this operation, you must know the **ListItemEntityTypeFullName** property of the list and pass that as the value of **type** in the HTTP request body.
245-
246-
247-
247+
248+
249+
248250

249251

250252

@@ -266,9 +268,9 @@ headers:
266268
```
267269

268270
The following example shows how to **delete** a list item.
269-
270-
271-
271+
272+
273+
272274

273275

274276

@@ -286,42 +288,42 @@ headers:
286288
```
287289

288290
For more information, see [Complete basic operations using SharePoint REST endpoints](https://msdn.microsoft.com/library/e3000415-50a0-426e-b304-b7de18f2f7d9%28Office.15%29.aspx).
289-
290-
291-
291+
292+
293+
292294

293295
## See also
294296
<a name="bk_addresources"> </a>
295297

296298

297299
- [Build Windows Phone apps that access SharePoint](build-windows-phone-apps-that-access-sharepoint.md)
298-
299-
300+
301+
300302
- [Using the SharePoint REST service](https://docs.microsoft.com/sharepoint/dev/sp-add-ins/get-to-know-the-sharepoint-rest-service)
301-
302-
303+
304+
303305
- [Build Windows Phone apps that access SharePoint](build-windows-phone-apps-that-access-sharepoint.md)
304-
305-
306+
307+
306308
- [Choose the right API set in SharePoint](choose-the-right-api-set-in-sharepoint.md)
307-
308-
309+
310+
309311
- [Use OData query operations in SharePoint REST requests](https://msdn.microsoft.com/library/d4b5c277-ed50-420c-8a9b-860342284b72%28Office.15%29.aspx)
310-
311-
312+
313+
312314
- [Get to know the SharePoint REST service](https://msdn.microsoft.com/library/2de035a0-ac75-43bd-9665-5c5a59c4c590%28Office.15%29.aspx)
313-
314-
315+
316+
315317
- [Open Data Protocol](http://www.odata.org/)
316-
317-
318+
319+
318320
- [Authorization and authentication of SharePoint Add-ins](https://msdn.microsoft.com/library/bde5647a-fff1-4b51-b67b-2139de79ce4a%28Office.15%29.aspx)
319-
320-
321+
322+
321323
- [Windows Phone SDK 8.0](https://www.microsoft.com/download/details.aspx?id=35471)
322-
323-
324+
325+
324326
- [Microsoft SharePoint SDK for Windows Phone 8](https://www.microsoft.com/download/details.aspx?id=36818)
325-
326-
327+
328+
327329

docs/general-development/create-a-map-view-for-the-geolocation-field-in-sharepoint.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Create a map view for the Geolocation field in SharePoint
3+
description: Learn how to display ___location information by using a map view in SharePoint lists.
34
ms.date: 05/09/2020
45
ms.prod: sharepoint
56
ms.assetid: 0cd8ba27-3326-4b60-a2d0-d289a94f11bb

0 commit comments

Comments
 (0)