Helper Methods

Note: Current version does not support the full Scribd API.

static void Initialize (string apiKey)
  Initializes the Scribd helper with the Scribd API key.
static IList<Document> GetFeaturedDocuments ([int limit], [int offset], [string scope])
  Retrieves the list of featured Scribd documents (for all users).
static IList<Document> GetUserDocuments ([int limit], [int offset])
  Retrieves a list of the user's documents.
static string GetThumbnailUrl (int documentId, [int width], [int height])
  Retrieves a URL to the thumbnail of a document, in a given size.
@helper GetFeaturedDocumentsWidget ([int limit], [int offset], [string scope], [int pageSize])
  Displays a widget that lists the Scribd featured documents. It allows the user to view the document by using the Scribd reader.
@helper GetUserDocumentsWidget ([int limit], [int offset], [int pageSize])
  Displays a widget that lists the user's documents. It allows the user to view the document by using the Scribd reader.

Document Information

int DocId The document id. Every document on Scribd has a unique document ID.
string AccessKey Every document on Scribd has a unique, secure access key. You must know the access key of a document to embed it.
string Title The document title.
string Description The document description.
string DescriptionSummary The document description, limited to 35 words.
string ThumbnailUrl Link to a JPG that contains a thumbnail of the document. This can be used to make search results more presentable. Do not cache thumbnail URLs - they are subject to change.
string[] Tags Comma separated list of tags for the document.
string License See Wikipedia:Creative_Commons_License. "c" is traditional copyright. "pd" is public domain.
int PageCount The number of pages in the document.
string[] DownloadFormats List of downloadable extensions.
int Reads Number of reads.
string UploadedBy The username of the user who uploaded this document.
DateTime WhenUploaded The date the document was originally uploaded.
DateTime WhenUpdated The date this document was last updated.

Last edited Jan 10, 2011 at 2:17 PM by jsenior, version 6

Comments

No comments yet.