SharePoint Cross-Domain Library Part 1: Getting To Know The Library
We have attempted to have an in-depth understanding of how permissions work in SharePoint add-ins in a blog post here and have mentioned a thing or two about the need for the cross-domain library when doing cross-domain calls.
When you have for example built an app where you would like to make calls to the host web, where the app is installed and which is outside the scope of your app, one thing to remember is that you will be subjected to cross-domain call and there are certain restrictions in place. This is basically due to security reasons. Browser protects any event of cross-site scripting and strictly dictates that client code will only be able to access data from within the same URL domain. Lucky for us SharePoint developers, to allow these domain calls, we can use SharePoint’s cross-domain library.
If you notice, every time an app is installed, a dynamic endpoint is also created which has its own domain. This dynamic endpoint is what we refer to as the app web and usually contains artifacts deployed to SharePoint such as a page, a list, etc.. The cross-domain library then creates a hidden iframe. The app page includes the cross-domain library, SP.RequestExecutor.js, that wires the remote page with a proxy page on the app web. The library loads the proxy page and uses the postMessage method to relay calls on the client side which in turn allows to make secure calls to SharePoint.
For SharePoint, cross-domain calls are supported on SharePoint-hosted, Provider-hosted and AutoHosted apps. SharePoint determines if it can trust the external domain via the AppManifest.xml in SharePoint-hosted apps. Through this file, domains that needs to be trusted through the internal app principal. While on Provider-hosted apps, SharePoint trust the domain that has been registered as part of the OAuth registration. Registration of the dynamically provisioned Azure website are automatically taken care of on autohosted apps so the library can be used without extra steps.
We basically just covered when we can use the cross-domain library as well as the reason why we need to use it. We will be tackling the actual usage of the cross-domain library and coding it in action on the next blog post.
Send us your questions on SharePoint
Related Blog Post
This blog has been quiet for over a year. Of course, I have to write my first post after a long time while experiencing flaky internet. Such has been the last few months for us - a lot of changes sometimes wanted and some surprises. Two of our For Dummies books...
Now available on "modern" SharePoint lists, column formatting is one way of applying custom formats to columns. Pretty much similar with the conditional formatting in Excel, column formatting makes it possible to apply styles to columns like CSS or modify the way data...
Information management policies are a set of rules that allows organizations to control content, such as setting retention period or defining actions that can be taken for a specific content. This helps organizations in enforcing regulations within their internal...