Activity Paging

From OpenSocial

Jump to: navigation, search

Contents

Summary

We can expect that Social Network users will generate a huge number of Activities and for a variety of reasons, that clients of the OpenSocial APIs will not wish to retrieve all of these activities at once. OpenSocial must provide a way for clients to retrieve partial Activity data in pages and this proposal outlines the changes needed to the various OpenSocial specifications.

Prototype

Issues found in spec:

The proposal adds the first/max parameters as used in the people requests. This may conflict with the Portable contacts alignment, where I suspect that these will be renamed 'startIndex' and 'count'.

If we're going to add pagination for activities we should also add support for fields, sortOrder, fitlerBy, filterOp and filterValue. This consolidates much of the fetch logic for the different types of objects and seems to be the best way forward.

Suggested Modification

Refactor sort/pagination/filtering into it's own definition and apply this to fetching all forms of objects if possible. ... Or simply align with fetchPerson semantics and syntax.

Prototype discussion thread

Updates to Specs

Updated draft spec at http://sites.google.com/site/opensocialdraft/Home/opensocial-javascript-api-reference/datarequest.

Resources

Detailed Proposal

Discussion Thread

Personal tools