How to access a remote site using SP.RemoteWeb and Javascript

In this post, we will see how to access a different site/web objects from the Personal / PointPublishing site. Office 365 and SharePoint 2016 now has a new api !SP.RemoteWeb! which will allow us to access another site / web objects from a different site context.

Get the Current Web:

var context = SP.ClientContext.get_current();
var sourceWeb = context.get_web();context.load(sourceWeb);
var targetSite = context.get_site();

context.load(targetSite);

context.executeQueryAsync(function(){},function(){});

• The above script gets the current context and web for the PointPublishing Personal site.
• The host context web should be a Personal / Point Publishing site.
  • ex: http://<<>>.sharepoint.com/portals/personal/<username>

Get the Remote Web:

var remoteWeb = new SP.RemoteWeb(context,"https://domain.sharepoint.com");
context.load(remoteWeb);
context.executeQueryAsync(function(){},function(){});

• The above script retrieves the remoteWeb of the root web of the main site collection.
  • ex: https://domain.sharepoint.com

Get the Remote Web Folder:

var rFolder = remoteWeb.getFolderByServerRelativeUrl("sitepages");
context.load(rFolder);

context.executeQueryAsync(function(){alert(rFolder.Name)},function(){});

• The above script retrieves the “sitepages” document library root folder using the remote web from the different site collection.

The equivalent CSOM API is also available on Microsoft.SharePoint.Client.RemoteWeb and it has the following methods.

• GetFileByServerRelativeUrl
• GetFolderByServerRelativeUrl
• GetGroupById
• GetListById
• GetListByServerRelativeUrl