Wednesday, March 25, 2015

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();


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);

} 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) {
return def.promise();

_sa.Operations = function () {

_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.executeQueryAsync(function () {
function (a, 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();
var items = ol.getItems(qry);

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

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

$.each(ids, function (i, ele) {

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

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


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
}).fail(function () { alert("Error"); });


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.

Monday, March 16, 2015

Tool for multi Lingual SharePoint Administration

I recently engaged with a Multi lingual SharePoint site. but for me other than the English , it was very hard to understand the SharePoint Site Settings menus and other admin links.

Then I tried Google Translation Plugin in Chrome which helped me lot.




Translate the page using plugin


After Page Translation


Monday, March 2, 2015

FormsAuthentication.SetAuthCookie() not working


Quick Tip:

I have configured the membership provider to work with ASP.NET application which is going to deploy in to the SharePoint.

But when I used FormsAuthentication.SetAuthCookie() to set the Authentication Token it doesn’t work for me.

I have tried disabling anonymous authentication but still didn’t work.

Then I changed the FormsAuthentication.SetAuthCookie() method to following set of lines and ultimately worked.

FormsAuthenticationTicket ticket = new FormsAuthenticationTicket(txtUserName.Value, false, 60);
string encTicket = FormsAuthentication.Encrypt(ticket);
Response.Cookies.Add(new HttpCookie(FormsAuthentication.FormsCookieName, encTicket));

Monday, February 23, 2015

How to Send Email in SharePoint Provider Hosted Apps

There are few methods that we can use to send Emails in SharePoint Provider Hosted apps.

  • Using general Email Sending method
  • Using SharePoint Client Object Model (CSOM)
  • Using SharePoint JavaScript Model (JSOM)

Using general Email Sending method

This is the general method we are using for sending email for This is method has advantages over other two methods. this method has few advantages over other methods,

  • Send attachments to the recipients
  • Send emails to external users (SharePoint 2013 email function can not be used to send emails to external users) 

There are many articles in available for this , I’m describing a sample code below.

MailMessage mail = new MailMessage("", "");
SmtpClient client = new SmtpClient();
client.Port = 25;
client.DeliveryMethod = SmtpDeliveryMethod.Network;
client.UseDefaultCredentials = false;
client.Host = "";
mail.Subject = "this is a test email.";
mail.Body = "this is my test email body";

For this you need to either have a smtp server setup by your self or valid authentication for the existing server.

Using SharePoint Client Object Model (CSOM)

This has been a most famous method for a sending email. You can use SharePoint Utility class to send a Email. But you can not send to external users. If you are sending to external users they should be added to your mail exchange but it will take some time to reflect the change.

var spContext = SharePointContextProvider.Current.GetSharePointContext(Context);
using (var clientContext = spContext.CreateUserClientContextForSPHost())
    var emailp = new EmailProperties();
    emailp.BCC = new List<string>{""};
    emailp.To = new List<string>{""};
    emailp= "";
    emailp.Body = "<b>html</b>";
    emailp.Subject = "subject";
    Utility.SendEmail(_clientContext, properties);

You can use the same method with remote event receivers only by changing SharePoint client context initiation. 

Using SharePoint JavaScript Model (JSOM)

This is very similar to the CSOM but it will use only JavaScript for sending emails.

var mail = {
        properties: {
            __metadata: { 'type': 'SP.Utilities.EmailProperties' },
            From: '',
            To: { 'results': ['',''] },
            Body: 'some body',
            Subject: 'subject'
var getAppWebUrlUrl = decodeURIComponent(utils.getQueryStringParameter("SPAppWebUrl").replace("#", ""));
var urlTemplate = getAppWebUrlUrl + "/_api/SP.Utilities.Utility.SendEmail";
            contentType: 'application/json',
            url: urlTemplate,
            type: "POST",
            data: JSON.stringify(mail),
            headers: {
                "Accept": "application/json;odata=verbose",
                "content-type": "application/json;odata=verbose",
                "X-RequestDigest": $("#__REQUESTDIGEST").val()
            success: function (data) {
                // code
            error: function (err) {
                // code