Skip to main content

JSOM List Operations in SharePoint Apps in a proper way (Provider Hosted and SharePoint Hosted) – Search

In my previous post (JSOM List Operations in SharePoint Apps in a proper way (Provider Hosted and SharePoint Hosted)–CRUD) I have explained how to work with basic list operations. 

Here I’m explaining the CAML and search options that we can perform.

(function (spa, $, undefined) {
window._sa = spa;
_sa.ctx = null;
_sa.web = null;

// this should be initialised

_sa.configs = {
SPHostUrl: "",
SPAppWebtUrl: "",
isCrossDomain: false
};

// init();

utils.log(_sa.configs.SPHostUrl);
utils.log(_sa.configs.SPWebtUrl);


function init() {

if (!_sa.configs.SPAppWebtUrl) {
alert("Please initialize _sa.configs");
}

if (_sa.configs.isCrossDomain) {

_sa.ctx = new SP.ClientContext(_sa.configs.SPAppWebtUrl);
var factory = new SP.ProxyWebRequestExecutorFactory(_sa.configs.SPAppWebtUrl);
_sa.ctx.set_webRequestExecutorFactory(factory);

} else {

_sa.ctx = new SP.ClientContext.get_current();
}

_sa.web = _sa.ctx.get_web();

}

// execute context or load and execute
_sa.executeCtxAsync = function (object) {
var def = $.Deferred();

if (object) { _sa.ctx.load(object); };

_sa.ctx.executeQueryAsync(function () {

if (object) { def.resolve(object); }
else { def.resolve(); };
},
function (a, b) {
def.reject(b);
});
return def.promise();
};

_sa.Operations = function () {
init();
};

_sa.Operations.prototype = {

getListItemByIdAsync: function (listName, id) {

var def = $.Deferred();
var olist = _sa.web.get_lists().getByTitle(listName);
var oitem = olist.getItemById(id);

_sa.ctx.load(oitem);
_sa.ctx.executeQueryAsync(function () {
def.resolve(oitem);
},
function (a, b) {
def.reject(b);
});
return def.promise();
},

// Get by Caml (Name, Query, 'Include(Title,Type,ID,Modified)' )
getListItemsByCAMLAsync: function (listName, query, fieldsFilter) {
var def = $.Deferred();
var ol = _sa.web.get_lists().getByTitle(listName);
var qry = new SP.CamlQuery();
qry.set_viewXml(query);
var items = ol.getItems(qry);

_sa.ctx.load(items, fieldsFilter);
_sa.ctx.executeQueryAsync(function () {
def.resolve(items);
},
function (a, b) {
def.reject(b);
});
return def.promise();
}

var def = $.Deferred();
var olist = _sa.web.get_lists().getByTitle(listName);

$.each(ids, function (i, ele) {
olist.getItemById(ele).deleteObject();
});


_sa.ctx.executeQueryAsync(function () {
def.resolve();
},
function (a, b) {
def.reject(b);
});
return def.promise();
}
};
}(window.spa = window.spa || {}, jQuery));



First you need to initialize the context for work with apps (refer first part of the article).


getListItemByIdAsync


This method helps to get a single item by providing Item Id.


var op = new spa.Operations();
var itmId = 4 ; // List Item Id
op.getListItemByIdAsync("ListName", itmId).done(function (itm) {
// access Item columns
var v = itm.get_item('ColumnName'); // Provide the column Name here
alert(v);
}).fail(function () { alert("Error"); });


getListItemsByCAMLAsync


This method will helps to retrieve multiple items in a List.


var operations = new spa.Operations();

var qr = '<View><Query><OrderBy><FieldRef Name="ID"/></OrderBy><Where><Eq><FieldRef Name="Author"/><Value Type="Integer"><UserID Type="Integer"/></Value></Eq></Where></Query></View>';
var include = 'Include(Title,Type,ID,Modified)' ; // this will only load these columns to the object
operations.getListItemByCAMLAsync("ListName", qr, 'Include(Title,ID)').done(function (items) {
var listEnumerator = items.getEnumerator();
var i = 0;
while (listEnumerator.moveNext()) {

var current = listEnumerator.get_current();
alert (current.get_item("ID"));
alert (current.get_item("Title"));

}
}).fail(function () { alert("Error") });


When your are developing you need to give close attention to CAML query and include section. it will have high probability to get wrong syntax.

Comments

Popular posts from this blog

Complete guide to Install SharePoint in a Three Server Farm using AutpSPInstaller

This article will be divided to three sections Setting up the Environment and Service Accounts Getting Ready with AutoSPInstaller Online Configuring the XML using Online Editor and Installation Setting up the Environment and Service Accounts AutoSPInstaller Online is one of a great project that facilitate Automated SharePoint installation including Sharepoint 2010, 2013 and 2016. Auto SP Installer provides a powerful way to deploy and configure a single-server development environment to multiple-server SharePoint farm. Reference: https://autospinstaller.com/ Before doing anything we will set up the environment for SharePoint three server Farm. Will name these servers as SPWFE - Share Point Front End Server SPAPP - Share Point App server SPDB - DB server Please find the reference for SharePoint minimum requirement and practices from https://docs.microsoft.com/en-us/SharePoint/install/install-sharepoint-server-2016-across-multiple-servers For the the medium segregation, we have to create...

How to Customize New Item Form to take parameters from Query String in the SharePoint 2010

In here I'm going to explain how to customize the SharePoint Item From to take parameters from Query String and set them as default values using SharePoint designer. Using this you can open a new Item From by providing parameters as query string. For an example you can customize one item Display form and taking query String Parameter from that and view New Item view for another list by providing default values using the Query String.     Steps Open the SharePoint designer and go to list and libraries and open the list that you want. Click the New and create a New Insert View by providing the name of the view.   Then created one will come to the list. then click and open the view. Then default New Item Screen will be loaded as follows. Then Delete the default list view and make that empty. You can delete the controls by selecting the area in the design view, If it fully cleared you can view the following message from the designer. Then go to SharePoint...

Motion Eye Docker compose File

Docker compose files are comes in handy when considering container orchestration. Below example shows my docker compose files and folder structure. ---- Your Folder (motioneye)   -- etc   -- lib   -- docker-compose.yaml You can run the docker compose file using docker-compose -d , and etc and lib folder will be automatically populated in the initiation. --- Below shows the content of the docker-compose.yaml file. version: '3' services:   nodered:    image: "ccrisan/motioneye:master-amd64"    container_name: motioneye    restart: always    user: root    ports:      - 8765:8765    volumes:      - "/etc/localtime:/etc/localtime:ro"      - "./etc:/etc/motioneye"      - "./lib:/var/lib/motioneye"