• Obtain a Profile
• Obtaining a Friends List
• Specify Profile Items
• Specifying Data Items
• Specifying Filter Criteria
• Specifying Sort Criteria
• Specifying Paging Criteria
• HTML Unescape

opensocial-0.8 is required for datatype="data" in jQuery.ajax

<ModulePrefs title="opensocial-jquery">
<Require feature="opensocial-0.8" />
</ModulePrefs>

Obtain a Profile

It is possible to obtain a VIEWER profile using jQuery.ajax

  $.ajax({
    url: '/people/@viewer/@self',
    data: {},
    dataType: 'data',
    success: function(people) {
      var person = people[0];
      console.info(person.id);
      console.info(person.nickname);
      console.info(person.name.unstructured);
    },
    error: function(xhr, status, e) {
      console.info(xhr, status, e);
    }
  });

This can also be done using jQuery.get

  $.get('/people/@viewer/@self', {}, function(people) {}, 'data');

The same can be done using jQuery.getData

  $.getData('/people/@viewer/@self', {}, function(people) {});

It is possible to obtain an OWNER profile using jQuery.ajax

  $.ajax({
    url: '/people/@owner/@self',
    data: {},
    dataType: 'data',
    success: function(people) {
      var person = people[0];
      console.info(person.id);
      console.info(person.nickname);
      console.info(person.name.unstructured);
    },
    error: function(xhr, status, e) {
      console.info(xhr, status, e);
    }
  });

This can also be done using jQuery.get

  $.get('/people/@owner/@self', {}, function(people) {}, 'data');

The same can be done using jQuery.getData

  $.getData('/people/@owner/@self', {}, function(people) {});

Obtaining a Friends List

It is possible to obtain a VIEWER's friends list using jQuery.ajax

  $.ajax({
    url: '/people/@viewer/@friends',
    data: {},
    dataType: 'data',
    success: function(people) {
      $.each(people, function(i, person) {
	console.info(person.id);
	console.info(person.nickname);
      });
    },
    error: function(xhr, status, e) {
      console.info(xhr, status, e);
    }
  });

This can also be done using jQuery.get

  $.get('/people/@viewer/@friends', {}, function(people) {}, 'data');

The same can be done using jQuery.getData

  $.getData('/people/@viewer/@friends', {}, function(people) {});

It is possible to obtain an OWNER's friends list using jQuery.ajax

  $.ajax({
    url: '/people/@owner/@friends',
    data: {},
    dataType: 'data',
    success: function(people) {
      $.each(people, function(i, person) {
	console.info(person.id);
	console.info(person.nickname);
      });
    },
    error: function(xhr, status, e) {
      console.info(xhr, status, e);
    }
  });

This can also be done using jQuery.get

  $.get('/people/@owner/@friends', {}, function(people) {}, 'data');

The same can be done using jQuery.getData

  $.getData('/people/@owner/@friends', {}, function(people) {});

Specify Profile Items

fields parameters can be used to specify Profile Items. Profile items can be specified by comma-delimiting.

  $.ajax({
    url: '/people/@viewer/@self',
    data: { fields: 'profileUrl,addresses' },
    dataType: 'data',
    success: function(people) {
      var person = people[0];
      console.info(person.profileUrl);
      console.info(person.addresses[0].country);
      console.info(person.addresses[0].region);
    },
    error: function(xhr, status, e) {
      console.info(xhr, status, e);
    }
  });

Moreover, the fields parameters can also define the URL

  $.ajax({
    url: '/people/@viewer/@self?fields=profileUrl,addresses',
    data: {},
    dataType: 'data',
    success: function(people) {},
    error: function(xhr, status, e) {}
  });

Specifying Data Items

appData parameters can be used to specify application data items. Data items can be specified by comma-delimiting.

  $.ajax({
    url: '/people/@viewer/@self',
    data: { appData: 'comment,feeling' },
    dataType: 'data',
    success: function(people) {
      var person = people[0];
      console.info(person.appData.comment);
      console.info(person.appData.feeling);
    },
    error: function(xhr, status, e) {
      console.error(xhr, status, e);
    }
  });

Moreover, the appData parameters can also define the URL

  $.ajax({
    url: '/people/@viewer/@self?appData=comment,feeling',
    data: {},
    dataType: 'data',
    success: function(people) {},
    error: function(xhr, status, e) {}
  });

Furthermore, if the appData parameter data items are abbreviated, all data items can be displayed

  $.ajax({
    url: '/people/@viewer/@self?appData',
    data: {},
    dataType: 'data',
    success: function(people) {
      var person = people[0];
      console.info(person.appData.comment);
      console.info(person.appData.feeling);
      console.info(person.appData.footprint);
    },
    error: function(xhr, status, e) {}
  });

Specifying Filter Criteria

Filter criteria can be specified using the URL path. Either @all or @app can be specified. The choice is @all when abbreviated.

• If @all is specified, all friends lists can be obtained
• If @app is selected, all friends lists using the same application can be obtained

  $.ajax({
    url: '/people/@viewer/@friends/@app',
    data: {},
    dataType: 'data',
    success: function(people) {
      $.each(people, function(i, person) {
	console.info(person.id);
	console.info(person.nickname);
      });
    },
    error: function(xhr, status, e) {
      console.info(xhr, status, e);
    }
  });

Filter criteria can be specified using filterBy parameters. Either all, hasApp, topFriends, or isFriendsWith can be specified. The choice is all when abbreviated.

• If all is specified, all friends lists can be obtained
• If hasApp is selected, all friends lists using the same application can be obtained
• If topFriends is selected, the user can obtain friends lists for those friends he/she has the most interaction with
• If isFriendsWith is selected... I was not able to understand the OpenSocial specifications here. Can someone help me out here?

  $.ajax({
    url: '/people/@viewer/@friends',
    data: { filterBy: 'hasApp' },
    dataType: 'data',
    success: function(people) {},
    error: function(xhr, status, e) {}
  });

Moreover, filterBy parameters can also be used to specify the URL

  $.ajax({
    url: '/people/@viewer/@friends?filterBy=hasApp',
    data: {},
    dataType: 'data',
    success: function(people) {},
    error: function(xhr, status, e) {}
  });

Specifying Sort Criteria

Sort criteria can be specified using sortBy parameters. Either topFriends or name can be specified. The choice is topFriends when abbreviated.

• If topFriends is selected, the user can obtain friends lists sorted in the order of those friends he/she has the most interaction with
• If name is selected, friends lists can be obtained according to the friends' names

  $.ajax({
    url: '/people/@viewer/@friends',
    data: { sortBy: 'name' },
    dataType: 'data',
    success: function(people) {},
    error: function(xhr, status, e) {}
  });

Moreover, sortBy parameters can also be used to specify the URL

  $.ajax({
    url: '/people/@viewer/@friends?sortBy=name',
    data: {},
    dataType: 'data',
    success: function(people) {},
    error: function(xhr, status, e) {}
  });

Specifying Paging Criteria

The paging criteria can be specified by using startIndex and count parameters. startIndex can be used with location to specify the position and with count to specify the number obtained. startIndex uses "0" to indicate item number 1. When abbreviated, numbers are used through to 20 items.

  $.ajax({
    url: '/people/@viewer/@friends',
    data: { startIndex: 0, count: 10 },
    dataType: 'data',
    success: function(people) {},
    error: function(xhr, status, e) {}
  });

Furthermore, the startIndex and count parameters can also define the URL

  $.ajax({
    url: '/people/@viewer/@friends?startIndex=0&count=10',
    data: {},
    dataType: 'data',
    success: function(people) {},
    error: function(xhr, status, e) {}
  });

Moreover, it is possible to retrieve location, the number of items per page, and the total number of items from a friends list.

  $.ajax({
    url: '/people/@viewer/@friends',
    data: {},
    dataType: 'data',
    success: function(people) {
      console.info(people.startIndex);
      console.info(people.itemsPerPage);
      console.info(people.totalResults);
    },
    error: function(xhr, status, e) {}
  });

HTML Unescape

Profiles are HTML unescapes with jQuery.ajax, jQuery.get, and jQuery.getData