/* Copyright (c) 2008, Yahoo! Inc. All rights reserved. Code licensed under the BSD License: http://developer.yahoo.net/yui/license.txt version: 2.6.0 */ if(typeof YAHOO=="undefined"||!YAHOO){var YAHOO={};}YAHOO.namespace=function(){var A=arguments,E=null,C,B,D;for(C=0;C0)?A.dump(D[F],I-1):L);}else{K.push(D[F]);}K.push(J);}if(K.length>1){K.pop();}K.push("]");}else{K.push("{");for(F in D){if(A.hasOwnProperty(D,F)){K.push(F+G);if(A.isObject(D[F])){K.push((I>0)?A.dump(D[F],I-1):L);}else{K.push(D[F]);}K.push(J);}}if(K.length>1){K.pop();}K.push("}");}return K.join("");},substitute:function(S,E,L){var I,H,G,O,P,R,N=[],F,J="dump",M=" ",D="{",Q="}";for(;;){I=S.lastIndexOf(D);if(I<0){break;}H=S.indexOf(Q,I);if(I+1>=H){break;}F=S.substring(I+1,H);O=F;R=null;G=O.indexOf(M);if(G>-1){R=O.substring(G+1);O=O.substring(0,G);}P=E[O];if(L){P=L(O,P,R);}if(A.isObject(P)){if(A.isArray(P)){P=A.dump(P,parseInt(R,10));}else{R=R||"";var K=R.indexOf(J);if(K>-1){R=R.substring(4);}if(P.toString===Object.prototype.toString||K>-1){P=A.dump(P,parseInt(R,10));}else{P=P.toString();}}}else{if(!A.isString(P)&&!A.isNumber(P)){P="~-"+N.length+"-~";N[N.length]=F;}}S=S.substring(0,I)+P+S.substring(H+1);}for(I=N.length-1;I>=0;I=I-1){S=S.replace(new RegExp("~-"+I+"-~"),"{"+N[I]+"}","g");}return S;},trim:function(D){try{return D.replace(/^\s+|\s+$/g,"");}catch(E){return D;}},merge:function(){var G={},E=arguments;for(var F=0,D=E.length;F=0;--i){if(pstack[i]===o){return"null";}}pstack[pstack.length]=o;a=[];isArray=l.isArray(o);if(d>0){if(isArray){for(i=o.length-1;i>=0;--i){a[i]=_stringify(o,i,d-1,w,pstack)||"null";}}else{j=0;if(l.isArray(w)){for(i=0,len=w.length;i=0?d:1/0;return _stringify({"":o},"",d,w,[]);}return undefined;},dateToString:function(d){function _zeroPad(v){return v<10?"0"+v:v;}return d.getUTCFullYear()+"-"+_zeroPad(d.getUTCMonth()+1)+"-"+_zeroPad(d.getUTCDate())+"T"+_zeroPad(d.getUTCHours())+":"+_zeroPad(d.getUTCMinutes())+":"+_zeroPad(d.getUTCSeconds())+"Z";},stringToDate:function(str){if(/^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})Z$/.test(str)){var d=new Date();d.setUTCFullYear(RegExp.$1,(RegExp.$2|0)-1,RegExp.$3);d.setUTCHours(RegExp.$4,RegExp.$5,RegExp.$6);return d;}return str;}};})();YAHOO.register("json",YAHOO.lang.JSON,{version:"2.6.0",build:"1321"}); /******************************************************************************* * Copyright (c) Demand Media Corporation 2010. This software code and related * intellectual property are the property of Demand Media Corporation and are * licensed for use solely on designated websites. Any distribution, copying, or * other use of this intellectual property other than pursuant to a written * agreement with Demand Media Corporation is strictly prohibited. * All Rights Reserved. * * THIS FILE IS AUTOGENERATED - DO NOT EDIT DIRECTLY * *******************************************************************************/ var PluckSDK = (function(){ var extend = function(obj, options) { for (var v in options) { obj[v] = options[v]; } return obj; }; function trim(s) { return (s||'').replace( /^(\s|\u00A0)+|(\s|\u00A0)+$/g,''); } function isString(obj) { var s = (obj != null) ? Object.prototype.toString.call(obj) : null; return s === "[object String]"; } function isArray(obj) { var s = (obj != null) ? Object.prototype.toString.call(obj) : null; return s === "[object Array]"; } function isObject(obj) { var s = (obj != null) ? Object.prototype.toString.call(obj) : null; return s === "[object Object]"; } function isDate(obj) { var s = (obj != null) ? Object.prototype.toString.call(obj) : null; return s === "[object Date]"; } function verifyNewUsed(obj, constructor) { if (!(obj instanceof constructor)) { throw "The 'new' keyword must be used when creating a new sdk object"; } } var sdk = { /******************************************************************************* * AbuseKey [BaseKey] * A key that uniquely identifies an abuse item. * Properties: * Key *******************************************************************************/ AbuseKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Abuse.AbuseKey'; return extend(this, options); }, /******************************************************************************* * EditorCommentOnUserKey [BaseKey] * Uniquely identifies an admin's comments on a specified User. * Properties: * Key *******************************************************************************/ EditorCommentOnUserKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Abuse.EditorCommentOnUserKey'; return extend(this, options); }, /******************************************************************************* * KeywordWatchListKey [BaseKey] * Key that identifies a listener, or group of terms, that triggers content to be filtered to the Moderation Manager. * Properties: * Key *******************************************************************************/ KeywordWatchListKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Moderation.KeywordWatchListKey'; return extend(this, options); }, /******************************************************************************* * CommunityGroupBannedUserKey [BaseKey] * A combination of CommunityGroupKey and UserKey that uniquely identifies a user's banishment from a Community Group. * Properties: * CommunityGroupKey * UserKey *******************************************************************************/ CommunityGroupBannedUserKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.CommunityGroups.CommunityGroupBannedUserKey'; return extend(this, options); }, /******************************************************************************* * CommunityGroupInvitationKey [BaseKey] * Uniquely identifies an invitation to a user to join a Community Group. * Properties: * CommunityGroupKey * UserKey *******************************************************************************/ CommunityGroupInvitationKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.CommunityGroups.CommunityGroupInvitationKey'; return extend(this, options); }, /******************************************************************************* * CommunityGroupKey [BaseKey] * The key that uniquely identifies a Community Group. * Properties: * Key *******************************************************************************/ CommunityGroupKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.CommunityGroups.CommunityGroupKey'; return extend(this, options); }, /******************************************************************************* * CommunityGroupMembershipKey [BaseKey] * Uniquely identifies a user's membership to a Community Group. * Properties: * CommunityGroupKey * MemberKey *******************************************************************************/ CommunityGroupMembershipKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.CommunityGroups.CommunityGroupMembershipKey'; return extend(this, options); }, /******************************************************************************* * CommunityGroupRegistrantKey [BaseKey] * Uniquely identifies a Community Group membership request. * Properties: * CommunityGroupKey * UserKey *******************************************************************************/ CommunityGroupRegistrantKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.CommunityGroups.CommunityGroupRegistrantKey'; return extend(this, options); }, /******************************************************************************* * CommunityGroupUserPrefsKey [BaseKey] * This object contains the key to your community group preferences. * Properties: * CommunityGroupKey * UserKey *******************************************************************************/ CommunityGroupUserPrefsKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.CommunityGroups.CommunityGroupUserPrefsKey'; return extend(this, options); }, /******************************************************************************* * CustomCollectionKey [BaseKey] * Uniquely identifies a CustomCollection. * Properties: * Key *******************************************************************************/ CustomCollectionKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Custom.CustomCollectionKey'; return extend(this, options); }, /******************************************************************************* * CustomItemKey [BaseKey] * Uniquely identifies a CustomItem. * Properties: * Key *******************************************************************************/ CustomItemKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Custom.CustomItemKey'; return extend(this, options); }, /******************************************************************************* * EventKey [BaseKey] * Uniquely identifies an event in a CommunityGroup. * Properties: * Key *******************************************************************************/ EventKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Events.EventKey'; return extend(this, options); }, /******************************************************************************* * EventSetKey [BaseKey] * Identifies the set of community group events to be fetched. * Properties: * Key *******************************************************************************/ EventSetKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Events.EventSetKey'; return extend(this, options); }, /******************************************************************************* * FeedActivityKey [BaseKey] * Identifies a feed activity entry. * Properties: * Key *******************************************************************************/ FeedActivityKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Forums.FeedActivityKey'; return extend(this, options); }, /******************************************************************************* * BadgeFamilyKey [BaseKey] * Indicates the badge family key (defined in the CMW as Badge Key). * Properties: * Key *******************************************************************************/ BadgeFamilyKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.PointsAndBadging.BadgeFamilyKey'; return extend(this, options); }, /******************************************************************************* * LeaderboardKey [BaseKey] * Uniquely identifies a Leaderboard. * Properties: * Key *******************************************************************************/ LeaderboardKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.PointsAndBadging.LeaderboardKey'; return extend(this, options); }, /******************************************************************************* * PollKey [BaseKey] * Uniquely identifies a poll. * Properties: * Key *******************************************************************************/ PollKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Polls.PollKey'; return extend(this, options); }, /******************************************************************************* * ReviewRatingAttributeKey [BaseKey] * Uniquely identifies a ReviewRatingAttribute. * Properties: * Key *******************************************************************************/ ReviewRatingAttributeKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Reactions.ReviewRatingAttributeKey'; return extend(this, options); }, /******************************************************************************* * ReviewRatingAttributeSetKey [BaseKey] * Uniquely identifies a ReviewRatingAttributeSet. * Properties: * Key *******************************************************************************/ ReviewRatingAttributeSetKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Reactions.ReviewRatingAttributeSetKey'; return extend(this, options); }, /******************************************************************************* * BlogRollEntry [IDaapiModel] * A blog roll entry. * Properties: * Name * Url * Local *******************************************************************************/ BlogRollEntry: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Blogs.BlogRollEntry'; return extend(this, options); }, /******************************************************************************* * BlogKey [BaseKey] * A key that identifies a blog. * Properties: * Key *******************************************************************************/ BlogKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Blogs.BlogKey'; return extend(this, options); }, /******************************************************************************* * BlogPostKey [BaseKey] * A key that identifies the blog post. * Properties: * Key *******************************************************************************/ BlogPostKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Blogs.BlogPostKey'; return extend(this, options); }, /******************************************************************************* * CommentKey [BaseKey] * A key that identifies a comment. * Properties: * Key *******************************************************************************/ CommentKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Reactions.CommentKey'; return extend(this, options); }, /******************************************************************************* * DiscoveryCategory [IDaapiModel] * A special named label used in discovery. Content items that support them may have zero to many DiscoveryCategories assigned. * Remarks:
* DiscoveryCategory names are stored as lower case, and comparisons on it are case insensitive. DiscoveryCategory names can be any valid string up to 254 characters. DiscoveryCategories and "tags" are synonymous. You can use DiscoveryCategory to subtype or further classify Articles to meet your site's informational model. In discovery requests that specify multiple categories, each discovered item will match all categories, as distinct from DiscoverySections. Please see the explanation of Pluck Discovery for more. * Properties: * Name *******************************************************************************/ DiscoveryCategory: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Discovery.DiscoveryCategory'; return extend(this, options); }, /******************************************************************************* * DiscoverySection [IDaapiModel] * A special named label used in discovery. Content items that support them may have at most one DiscoverySection. * Properties: * Name *******************************************************************************/ DiscoverySection: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Discovery.DiscoverySection'; return extend(this, options); }, /******************************************************************************* * ExternalResourceKey [BaseKey] * Uniquely identifies Articles (content external to Pluck). * Properties: * Key *******************************************************************************/ ExternalResourceKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.External.ExternalResourceKey'; return extend(this, options); }, /******************************************************************************* * MemberSiteKey [BaseKey] * Identifies the Pluck site from which the content originated or was contributed. Only applies to Pluck Portfolio instances (multi-site). * Properties: * Key *******************************************************************************/ MemberSiteKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Common.MemberSiteKey'; return extend(this, options); }, /******************************************************************************* * TrashAuditItemKey [BaseKey] * Refers to a specific TrashAuditItem. * Properties: * Key *******************************************************************************/ TrashAuditItemKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Polls.TrashAuditItemKey'; return extend(this, options); }, /******************************************************************************* * CategoryKey [BaseKey] * Uniquely identifies a forum category. * Remarks:
* Not to be confused with DiscoveryCategory, which is unrelated. * Properties: * Key *******************************************************************************/ CategoryKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Forums.CategoryKey'; return extend(this, options); }, /******************************************************************************* * DiscussionKey [BaseKey] * Uniquely identifies a forum discussion. * Properties: * Key *******************************************************************************/ DiscussionKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Forums.DiscussionKey'; return extend(this, options); }, /******************************************************************************* * ForumKey [BaseKey] * Uniquely identifies a Forum. * Properties: * Key *******************************************************************************/ ForumKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Forums.ForumKey'; return extend(this, options); }, /******************************************************************************* * ForumPostKey [BaseKey] * Uniquely identifies a ForumPost. * Properties: * Key *******************************************************************************/ ForumPostKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Forums.ForumPostKey'; return extend(this, options); }, /******************************************************************************* * MessageKey [BaseKey] * Uniquely identifies the message. * Properties: * Key *******************************************************************************/ MessageKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Users.MessageKey'; return extend(this, options); }, /******************************************************************************* * GalleryKey [BaseKey] * Uniquely identifies a photo or video gallery. * Properties: * Key *******************************************************************************/ GalleryKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Media.GalleryKey'; return extend(this, options); }, /******************************************************************************* * PhotoKey [BaseKey] * Uniquely identifies an individual photo. * Properties: * Key *******************************************************************************/ PhotoKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Media.PhotoKey'; return extend(this, options); }, /******************************************************************************* * RatingKey [BaseKey] * Combination of user and content idenfitiers that uniquely identifies a rating on a piece of content. * Properties: * RatedBy * RatedKey *******************************************************************************/ RatingKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Reactions.RatingKey'; return extend(this, options); }, /******************************************************************************* * ReviewKey [BaseKey] * Uniquely identifies a review. * Properties: * Key *******************************************************************************/ ReviewKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Reactions.ReviewKey'; return extend(this, options); }, /******************************************************************************* * UserKey [BaseKey] * Uniquely identifies a user. * Properties: * Key *******************************************************************************/ UserKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Users.UserKey'; return extend(this, options); }, /******************************************************************************* * WatchItemKey [BaseKey] * Identifies an item in a user's watch list. * Remarks:
* Watch list items are essentially bookmarks. (Deprecated: not displayed in Pluck 4 widgets.) * Properties: * Key *******************************************************************************/ WatchItemKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Users.WatchItemKey'; return extend(this, options); }, /******************************************************************************* * VideoKey [BaseKey] * Uniquely identifies a user-uploaded video. * Properties: * Key *******************************************************************************/ VideoKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Media.VideoKey'; return extend(this, options); }, /******************************************************************************* * BlogPostSEOKey [IDaapiModel] * Used to idenfify a blog post by its search engine friendly identifier. * Properties: * BlogPostSEOToken *******************************************************************************/ BlogPostSEOKey: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Blogs.BlogPostSEOKey'; return extend(this, options); }, /******************************************************************************* * ContentPolicyTraceEntry [IDaapiModel] * This object contains information about a content policy trace. * Properties: * Type * BaseKey * Section * Category * Action * UserTier * Policy *******************************************************************************/ ContentPolicyTraceEntry: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Common.ContentPolicyTraceEntry'; return extend(this, options); }, /******************************************************************************* * SiteLifeCookie [IDaapiModel] * Properties: * Name * Value * Expires * IsSessionCookie *******************************************************************************/ SiteLifeCookie: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Common.SiteLifeCookie'; return extend(this, options); }, /******************************************************************************* * ViewTrackingCounts [IDaapiModel] * Counts of tracked page views. Tracking occurs only via ArticleRequest. * Properties: * TotalViews * StartDate * EndDate *******************************************************************************/ ViewTrackingCounts: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Common.ViewTrackingCounts'; return extend(this, options); }, /******************************************************************************* * CommunityGroupUserPrefs [IDaapiModel] * This object contains information about your community group preferences. * Properties: * CommunityGroupKey * UserKey * EnableGroupManagerMessages * EnableGroupDigestMessages * PreferredForumPostSortOrder * GroupDigestActivityTypes * SubscriptionActivityTypes * GroupDigestRunDays * SubscribeReplies *******************************************************************************/ CommunityGroupUserPrefs: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.CommunityGroups.CommunityGroupUserPrefs'; return extend(this, options); }, /******************************************************************************* * MiniFeedActivity [IDaapiModel] * Metadata about a user activity in a CommunityGroup feature. * Remarks:
* Applies to several content types in CommunityGroups. * Properties: * ActivityType * ActivityAction * TargetKey * Title * AbstractText * ActivityDate * SiteOfOrigin * User * Image *******************************************************************************/ MiniFeedActivity: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.CommunityGroups.MiniFeedActivity'; return extend(this, options); }, /******************************************************************************* * Blog [IDaapiModel] * A set of metadata describing a blog, such as its title. * Properties: * BlogKey * Title * Tagline * Abstract * AvatarUrl * Url * FeedUrl * BlogTags * BlogRollEntries * BlogType * RecommendationCounts * AssociatedCommunityGroupKey * AssociatedOwnerKey * CommentApproval * AllowComments *******************************************************************************/ Blog: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Blogs.Blog'; return extend(this, options); }, /******************************************************************************* * BlogPost [IDaapiModel] * Content and metadata for a single post in a blog. * Properties: * BlogPostKey * BlogKey * Title * Body * BodyAbstract * Tags * PostDate * IsPublished * NumberOfComments * AbuseCounts * RecommendationCounts * Url * Owner * SiteOfOrigin * AssociatedCommunityGroupKey * AssociatedOwnerKey *******************************************************************************/ BlogPost: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Blogs.BlogPost'; return extend(this, options); }, /******************************************************************************* * BlogPostMonthYearCount [IDaapiModel] * This object represents a count of BlogPost objects, for a single Blog, based on the month and year provided. * Properties: * BlogKey * Month * Year * NumericalYear * BlogPostCount *******************************************************************************/ BlogPostMonthYearCount: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Blogs.BlogPostMonthYearCount'; return extend(this, options); }, /******************************************************************************* * Bookmark [IDaapiModel] * This object represents one entry on a list of bookmarks. * Properties: * Title * Link * IsLocal *******************************************************************************/ Bookmark: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Common.Bookmark'; return extend(this, options); }, /******************************************************************************* * ArticleReviews [IDaapiModel] * This object is similar to ArticleComments, but includes metadata about reviews posted to an article. * Properties: * UserHasReviewed * NumberOfReviews * AverageReviewRating *******************************************************************************/ ArticleReviews: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.External.ArticleReviews'; return extend(this, options); }, /******************************************************************************* * CustomActivity [IDaapiModel] * A custom activity used in user activity feeds. * Properties: * DisplayText * Owner * TimeStamp * FacebookConnectKey * SiteOfOrigin *******************************************************************************/ CustomActivity: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.FriendFeed.CustomActivity'; return extend(this, options); }, /******************************************************************************* * TwitterConnect [IDaapiModel] * Specifies details of a user's Twitter account. Typically only for internal use. * Properties: * Url * ScreenName * Owner * TimeStamp * TwitterConnectKey * SiteOfOrigin *******************************************************************************/ TwitterConnect: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.FriendFeed.TwitterConnect'; return extend(this, options); }, /******************************************************************************* * UserStatus [IDaapiModel] * User-specified value. Similar to Facebook's What's On Your Mind input. Displayed in the Pluck 4 widget. * Properties: * Body * Owner * TimeStamp * UserStatusKey * SiteOfOrigin *******************************************************************************/ UserStatus: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.FriendFeed.UserStatus'; return extend(this, options); }, /******************************************************************************* * WallPost [IDaapiModel] * Content posted to a wall. * Properties: * Body * Owner * WallOwner * TimeStamp * WallPostKey * SiteOfOrigin *******************************************************************************/ WallPost: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.FriendFeed.WallPost'; return extend(this, options); }, /******************************************************************************* * FeedActivityReaction [IDaapiModel] * A user's reaction to a Friend Feed activity. * Properties: * FeedReactionKey * FeedActivityKey * Owner * CreatedOn * Body *******************************************************************************/ FeedActivityReaction: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.FriendFeed.FeedActivityReaction'; return extend(this, options); }, /******************************************************************************* * GallerySubmitted [IDaapiModel] * Gallery that has had a submission made to it. * Properties: * Gallery * LastSubmissionDate *******************************************************************************/ GallerySubmitted: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Media.GallerySubmitted'; return extend(this, options); }, /******************************************************************************* * AbuseCount [IDaapiModel] * A summary of information on abuse reports made against a given item. * Properties: * AbuseReportCount * CurrentUserHasReportedAbuse * ContentIsStandardAbuse * ContentExceedsAbuseThreshold *******************************************************************************/ AbuseCount: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Moderation.AbuseCount'; return extend(this, options); }, /******************************************************************************* * AbuseItem [IDaapiModel] * A piece of content that has had abuse reported on it. * Properties: * AbuseKey * Item * Supplementals * AbuseReports * NumberOfAbuseReports * MaxAbuseReports * CurrentState * FlaggedForReview * FlaggedReason * FlaggedBy * FlaggedDate * ExceedsAbuseThreshold * AbuseWeight *******************************************************************************/ AbuseItem: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Moderation.AbuseItem'; return extend(this, options); }, /******************************************************************************* * AbuseReported [IDaapiModel] * Contains abuse summary, including values entered by the user when an abuse report is made. * Properties: * ReportedBy * Classification * Reason * Details * ReportedDate *******************************************************************************/ AbuseReported: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Moderation.AbuseReported'; return extend(this, options); }, /******************************************************************************* * AssignedModeratorQueues [IDaapiModel] * A list of queues assigned to a specific moderator. * Properties: * Moderator * AssignedQueueIds * CanEditModerationContent *******************************************************************************/ AssignedModeratorQueues: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Moderations.AssignedModeratorQueues'; return extend(this, options); }, /******************************************************************************* * FlaggedRoute [IDaapiModel] * Properties: * Name * AssignedQueues *******************************************************************************/ FlaggedRoute: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Moderation.FlaggedRoute'; return extend(this, options); }, /******************************************************************************* * FlaggedRouteHistory [IDaapiModel] * Shows the history of when and why a moderation item was flagged. * Properties: * FlaggedBy * Date * Reason * FlaggedRoute *******************************************************************************/ FlaggedRouteHistory: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Moderation.FlaggedRouteHistory'; return extend(this, options); }, /******************************************************************************* * KeywordWatchList [IDaapiModel] * Group of terms that triggers content to be filtered to the Moderation Manager. * Properties: * Key * Name * Words * FilteredUserTiers * AssignedQueues *******************************************************************************/ KeywordWatchList: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Moderation.KeywordWatchList'; return extend(this, options); }, /******************************************************************************* * KeywordWatchMatch [IDaapiModel] * The Listener a moderation item matched, and the word(s) in that Listener that caused the match. * Properties: * Name * Matches *******************************************************************************/ KeywordWatchMatch: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Moderation.KeywordWatchMatch'; return extend(this, options); }, /******************************************************************************* * ModerationItem [IDaapiModel] * The item that was reported as abusive. * Properties: * Key * Date * Subject * Supplementals * LockOwner * LockExpires * FlaggedForReview * FlaggedReason * FlaggedBy * FlaggedDate * FlaggedRoute * KeywordWatchMatches * FlaggedRouteHistory * IsSpam * FilteredMetadata * ParentKey * SubjectSiteOfOrigin *******************************************************************************/ ModerationItem: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Moderation.ModerationItem'; return extend(this, options); }, /******************************************************************************* * ModerationQueue [IDaapiModel] * A queue of items waiting to be moderated. * Properties: * Configuration * Moderators * QueueCount *******************************************************************************/ ModerationQueue: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Moderation.ModerationQueue'; return extend(this, options); }, /******************************************************************************* * ModerationQueueConfiguration [IDaapiModel] * Configuration options of a Queue, such as the type of items allowed in the queue. * Properties: * Id * Name * Type * Priority * SortOrder * Filters * FlaggedItemsOnly * FlaggedRoute * KeywordWatchList * RequiredNoteActions *******************************************************************************/ ModerationQueueConfiguration: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Moderation.ModerationQueueConfiguration'; return extend(this, options); }, /******************************************************************************* * ModerationQueueFilter [IDaapiModel] * Specifies the way items in a Moderation Queue are filtered. * Properties: * Name * Values *******************************************************************************/ ModerationQueueFilter: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Moderation.ModerationQueueFilter'; return extend(this, options); }, /******************************************************************************* * LeaderboardUserRank [IDaapiModel] * An unordered list of user Leaderboard rankings for any Leaderboard that the user is ranked in. * Properties: * LeaderboardKey * LeaderboardName * LeaderboardAvatarUrl * Rank * Points * IsVisible *******************************************************************************/ LeaderboardUserRank: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.PointsAndBadging.LeaderboardUserRank'; return extend(this, options); }, /******************************************************************************* * PollStatusInfo [IDaapiModel] * Current user status for a poll. * Properties: * CurrentUserHasVoted * CurrentUserAnswerIndex *******************************************************************************/ PollStatusInfo: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Polls.PollStatusInfo'; return extend(this, options); }, /******************************************************************************* * ItemScore [IDaapiModel] * Aggregation of "thumbs up" and "thumbs down" activity against an item. * Properties: * TargetKey * ScoreId * ParentKey * ScoreCount * AbsoluteScore * DeltaScore * PositiveScore * PositiveCount * NegativeScore * NegativeCount * CurrentUserHasScored * CurrentUserScore *******************************************************************************/ ItemScore: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Reactions.ItemScore'; return extend(this, options); }, /******************************************************************************* * CategoryRollup [IDaapiModel] * A collection of review data for a specific DiscoveryCategory. * Properties: * Category * Rating * TotalRatings *******************************************************************************/ CategoryRollup: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Reactions.Reviews.CategoryRollup'; return extend(this, options); }, /******************************************************************************* * Review [IDaapiModel] * Contains multiple properties allowing users to rate and provide opinions in several discrete fields on an article, such as a product or movie. Can be applied to any content. * Properties: * ReviewKey * Owner * DatePosted * Title * Body * Pros * Cons * OnPageTitle * OnPageUrl * ReviewedBy * ReviewedKey * Rating * SiteOfOrigin * AssociatedOwnerKey * AbuseCounts * LastUpdated * IsRecommended * AttributeRatings * ItemScore * ContentBlockingState * PhotoKeys * VideoKeys * IsFeatured * Url * Section * Categories * LastEditedBy * LastEditTimeStamp *******************************************************************************/ Review: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Reactions.Reviews.Review'; return extend(this, options); }, /******************************************************************************* * ReviewRatingAttribute [IDaapiModel] * An administrator-defined attribute used as a review rating. * Properties: * Key * Name * Description *******************************************************************************/ ReviewRatingAttribute: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Reactions.ReviewRatingAttribute'; return extend(this, options); }, /******************************************************************************* * ReviewRatingAttributeRollup [IDaapiModel] * A summary of a set of attribute ratings for a specific item. * Properties: * Rating * TotalRatings * Key * Name * Description *******************************************************************************/ ReviewRatingAttributeRollup: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Reactions.Reviews.ReviewRatingAttributeRollup'; return extend(this, options); }, /******************************************************************************* * ReviewRatingAttributeSet [IDaapiModel] * A collection of attributes that can be assigned to an item. * Remarks:
* An Attribute can be used in multiple AttributeSets. Pluck 4 widgets supports up to 5 attributes in a set. A default AttributeSet containing no attributes will always be listed first in the paginated list of active AttributeSets. * Properties: * Key * Name * Description * Attributes * Active * Notes *******************************************************************************/ ReviewRatingAttributeSet: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Reactions.Reviews.ReviewRatingAttributeSet'; return extend(this, options); }, /******************************************************************************* * ReviewRatingAttributeValue [IDaapiModel] * An administrator-defined attribute and the user's rating. * Remarks:
* String entered by administrator when the attribute was created. Provides more detailed information about the attribute to the user. Displays in the Reviews widget. * Properties: * Value * Key * Name * Description *******************************************************************************/ ReviewRatingAttributeValue: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Reactions.ReviewRatingAttributeValue'; return extend(this, options); }, /******************************************************************************* * ReviewRatingCount [IDaapiModel] * Summary of ratings on a Review or CategoryRollup. * Properties: * RatingIndex * TotalRatings *******************************************************************************/ ReviewRatingCount: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Reactions.Reviews.ReviewRatingCount'; return extend(this, options); }, /******************************************************************************* * ReviewRollup [IDaapiModel] * A summary of review data for a specific item. * Properties: * ReviewedKey * TotalReviews * Rating * UserHasReviewed * AttributeRatings * RatingCounts *******************************************************************************/ ReviewRollup: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Reactions.ReviewRollup'; return extend(this, options); }, /******************************************************************************* * BadgeFilter [IFilterType, IDaapiModel] * Limits responses to content authored by users holding a given badge. * Properties: * BadgeFamilyKey * BadgeKey *******************************************************************************/ BadgeFilter: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.System.Filtering.BadgeFilter'; return extend(this, options); }, /******************************************************************************* * FriendsFilter [IFilterType, IDaapiModel] * Limits responses to content authored by the current user's friends. * Properties: * ExecutingUserKey *******************************************************************************/ FriendsFilter: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.System.Filtering.FriendsFilter'; return extend(this, options); }, /******************************************************************************* * ReviewRatingFilter [IFilterType, IDaapiModel] * Limits responses to reviews matching a given rating. * Properties: * Rating *******************************************************************************/ ReviewRatingFilter: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.System.Filtering.ReviewRatingFilter'; return extend(this, options); }, /******************************************************************************* * TagFilter [IFilterType, IDaapiModel] * Specifies tags to be used in filtering comments returned. * Properties: * Tags * TagFilterType *******************************************************************************/ TagFilter: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.System.Filtering.TagFilter'; return extend(this, options); }, /******************************************************************************* * ThreadFilter [IFilterType, IDaapiModel] * Allows comments to be filtered by thread path. * Properties: * ThreadPath *******************************************************************************/ ThreadFilter: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.System.Filtering.ThreadFilter'; return extend(this, options); }, /******************************************************************************* * TimeFilter [IFilterType, IDaapiModel] * Properties: *******************************************************************************/ TimeFilter: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.System.Filtering.TimeFilter'; return extend(this, options); }, /******************************************************************************* * AlphabeticalSort [ISortType, IDaapiModel] * Specifies the direction of a sort using the content's name. The field used may vary among content types. * Properties: * SortOrder *******************************************************************************/ AlphabeticalSort: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.System.Sorting.AlphabeticalSort'; return extend(this, options); }, /******************************************************************************* * DefaultSort [ISortType, IDaapiModel] * Special sort that displays featured reviews above non-featured reviews. Within each group, reviews are sorted by timestamp descending. * Properties: * SortOrder *******************************************************************************/ DefaultSort: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.System.Sorting.DefaultSort'; return extend(this, options); }, /******************************************************************************* * RecommendationSort [ISortType, IDaapiModel] * Used for sorting based on recommendation count for comments not using scoring. * Properties: * SortOrder *******************************************************************************/ RecommendationSort: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.System.Sorting.RecommendationSort'; return extend(this, options); }, /******************************************************************************* * ReviewRatingSort [ISortType, IDaapiModel] * Specifies the direction of a sort using a review's rating. * Properties: * SortOrder *******************************************************************************/ ReviewRatingSort: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.System.Sorting.ReviewRatingSort'; return extend(this, options); }, /******************************************************************************* * ScoreSort [ISortType, IDaapiModel] * Specifies how content is sorted by ItemScore. * Properties: * SortOrder * ScoreId * ScoreSortColumn *******************************************************************************/ ScoreSort: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.System.Sorting.ScoreSort'; return extend(this, options); }, /******************************************************************************* * TimestampSort [ISortType, IDaapiModel] * Specifies the direction of a sort using the content's create date. * Properties: * SortOrder *******************************************************************************/ TimestampSort: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.System.Sorting.TimestampSort'; return extend(this, options); }, /******************************************************************************* * FeedActivity [IDaapiModel] * Metadata about an item in a User's feed (recent activity). * Properties: * Url * Title * Activity * Owner * CommunityGroup * SiteOfOrigin * Action * BadgeAcquisitionMethod * Reactions * TimeStamp * PointsAwarded * UserStatus * FeedActivityKey *******************************************************************************/ FeedActivity: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.FriendFeed.FeedActivity'; return extend(this, options); }, /******************************************************************************* * TrashAuditItem [IDaapiModel] * Properties: * DeletedObjectKey * TextInfo * DeletedByUser * Timestamp * Source *******************************************************************************/ TrashAuditItem: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.TrashAudit.TrashAuditItem'; return extend(this, options); }, /******************************************************************************* * UserAdministrativeMetaData [IDaapiModel] * Whether or not the user is an admin for the current site in portfolio. * Properties: * IsSiteAdmin * AdministrativeTier *******************************************************************************/ UserAdministrativeMetaData: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Users.UserAdministrativeMetaData'; return extend(this, options); }, /******************************************************************************* * LiteUser [IDaapiModel] * A reduced set of metadata about a User. * Remarks:
* Returned when a only basic User information is needed. * Properties: * AvatarPhotoUrl * AvatarPhotoID * UserKey * DisplayName * Email * UserTier * AdministrativeTier * IsSiteAdmin * PersonaUrl * IsBlocked * IsUnderReview * ExternalUserIds * CreatedOn * LastUpdated * FriendshipStatus * UserStatus *******************************************************************************/ LiteUser: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Users.LiteUser'; return extend(this, options); }, /******************************************************************************* * UserExtendedPrefs [IDaapiModel] * Arbitrary user preferences as key-value pairs. Set internally when a user connects through Pluck Social Bridging. Can also store anything you define. * Properties: * ExtendedPrefs * AvatarPhotoUrl * AvatarPhotoID * UserKey * DisplayName * Email * UserTier * AdministrativeTier * IsSiteAdmin * PersonaUrl * IsBlocked * IsUnderReview * ExternalUserIds * CreatedOn * LastUpdated * FriendshipStatus * UserStatus *******************************************************************************/ UserExtendedPrefs: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Users.UserExtendedPrefs'; return extend(this, options); }, /******************************************************************************* * FriendshipStatus [IDaapiModel] * Indicates the friend/enemy relationships between the requested user is a friend of the executing user. * Properties: * IsEnemy * IsFriend * IsPendingFriend * ExecutingUserIsEnemy * ExecutingUserIsFriend * ExecutingUserIsPendingFriend *******************************************************************************/ FriendshipStatus: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Users.FriendshipStatus'; return extend(this, options); }, /******************************************************************************* * MemberSite [IDaapiModel] * Represents a site configured as a member on your Pluck server. Only applies to Pluck Portfolio instances (multi-site). * Properties: * MemberSiteKey * MemberSiteName * MemberSiteUrl * MemberSiteState *******************************************************************************/ MemberSite: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Common.MemberSite'; return extend(this, options); }, /******************************************************************************* * SearchResults [IDaapiModel] * The objects found by a search. * Properties: * ItemsPerPage * OneBasedOnPage * TotalItems * Items * SearchType * SearchString * AssociatedCommunityGroups *******************************************************************************/ SearchResults: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Common.SearchResults'; return extend(this, options); }, /******************************************************************************* * SiteLifeKeyValuePair [IDaapiModel] * An arbitrary key and its assigned value. * Properties: * Key * Value *******************************************************************************/ SiteLifeKeyValuePair: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Common.SiteLifeKeyValuePair'; return extend(this, options); }, /******************************************************************************* * LiteCommunityGroup [IDaapiModel] * A reduced set of metadata about a CommunityGroup. * Remarks:
* Returned when only basic CommunityGroup information is needed. * Properties: * CommunityGroupKey * Title * Description * CommunityGroupVisibility * AvatarUrl * Url *******************************************************************************/ LiteCommunityGroup: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.CommunityGroups.LiteCommunityGroup'; return extend(this, options); }, /******************************************************************************* * CommunityGroup [IDaapiModel] * Metadata about a specific Community Group. * Remarks:
* A Community Group represents an organized collection of users that share a common interest. Community groups can be either public or private; private group content is not available outside the context of the group, and membership in private groups is invitation-only. In contrast, users can freely join public groups and public group content is available outside of the group context through mechanisms such as discovery.
Each Community Group is assigned its own blog, bookmark list, Forum, event set, photo gallery, and video gallery. * Properties: * Categories * AvatarPhotoKey * BlogKey * ForumKey * PhotoGalleryKey * VideoGalleryKey * EventSetKey * GroupBookmarks * CreatedDate * Section * RequestingUsersMembershipTier * CommunityGroupStats * SiteOfOrigin * HasPendingMembership * AssociatedOwnerKey * Owner * AbuseCounts * RecommendationCounts * SubscriptionInfo * CommunityGroupKey * Title * Description * CommunityGroupVisibility * AvatarUrl * Url *******************************************************************************/ CommunityGroup: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.CommunityGroups.CommunityGroup'; return extend(this, options); }, /******************************************************************************* * BannedCommunityGroupUser [IDaapiModel] * Information on a user's banishment from a Community Group. * Properties: * CommunityGroupBannedUserKey * CommunityGroupKey * User * Note *******************************************************************************/ BannedCommunityGroupUser: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.CommunityGroups.BannedCommunityGroupUser'; return extend(this, options); }, /******************************************************************************* * InvitedCommunityGroupUser [IDaapiModel] * Represents a user's invitation to join a particular CommunityGroup. * Properties: * User * CommunityGroupKey *******************************************************************************/ InvitedCommunityGroupUser: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.CommunityGroups.InvitedCommunityGroupUser'; return extend(this, options); }, /******************************************************************************* * CommunityGroupMembership [IDaapiModel] * Represents a user's membership within a Community Group, including that user's membership level within the group. * Properties: * CommunityGroup * User * MembershipTier * CreatedOn *******************************************************************************/ CommunityGroupMembership: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.CommunityGroups.CommunityGroupMembership'; return extend(this, options); }, /******************************************************************************* * CommunityGroupRegistrant [IDaapiModel] * Represents an individual user's desire to receive an invitation to join a specified Community Group. * Properties: * CommunityGroupRegistrantKey * CommunityGroupKey * User * Note *******************************************************************************/ CommunityGroupRegistrant: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.CommunityGroups.CommunityGroupRegistrant'; return extend(this, options); }, /******************************************************************************* * CommunityGroupStats [IDaapiModel] * Represents statistics about Community Group usage (i.e. number of blog posts, forum discussions, etc. * Remarks:
* These stats are calculated out of process and may not represent the latest information. * Properties: * CommunityGroupKey * BlogPostCount * ForumDiscussionCount * PhotoCount * VideoCount * MemberCount * PendingMemberCount * UpcomingEventCount * BannedUserCount *******************************************************************************/ CommunityGroupStats: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.CommunityGroups.CommunityGroupStats'; return extend(this, options); }, /******************************************************************************* * CustomCollection [IDaapiModel] * Metadata about a collection. CustomCollections store references to Pluck data. * Properties: * CustomCollectionKey * Name * LastUpdated * SiteOfOrigin *******************************************************************************/ CustomCollection: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Custom.CustomCollection'; return extend(this, options); }, /******************************************************************************* * CustomItem [IDaapiModel] * Strings of arbitrary data associted to a user. Can contain raw data and/or information for display. * Remarks:
* A CustomItem is a bundle of several free-text fields that can contain any data you want to associate with a user. * They may display in Persona recent activity depending on how it is created, but otherwise do not display in widgets. *

* CustomItems can have abuse reported against them but are not surfaced in moderation manager until abuse is reported. *

* Note that MimeType is a misleading name. This property becomes a CSS class used in recent activity streams when you have chosen to surface the * item in the contributing user's feed. Be aware if you do that certain fields are displayed in the Persona widget according to their intended purpose. * Properties: * CustomItemKey * Name * MimeType * DisplayText * Content * Owner * LastUpdated * NumberOfRatings * AverageRating * AbuseCounts * RecommendationCounts * SiteOfOrigin * CssClassName *******************************************************************************/ CustomItem: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Custom.CustomItem'; return extend(this, options); }, /******************************************************************************* * Event [IDaapiModel] * Represents a scheduled event for a CommunityGroup. * Properties: * EventKey * Title * Description * Location * BookmarkName * BookmarkUrl * StartDate * EndDate * UtcOffset * Owner * AbuseCounts * RecommendationCounts * AssociatedCommunityGroupKey * Url *******************************************************************************/ Event: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Events.Event'; return extend(this, options); }, /******************************************************************************* * Article [IDaapiModel] * A container for reactions against any data not stored in Pluck. An article is a composite of multiple types of metadata, including metadata about user reactions such a reviews and comments. * Remarks:
* Articles are conceptually equivalent to ExternalResources. They can be created programmatically, but are also created automatically by Pluck the first time a reaction is recorded. When the reaction is originating in a browser (from a widget), some Article properties are defaulted via JavaScript, such as Title (document.title) and Url (location.href). * Properties: * ArticleKey * Section * Categories * Comments * Ratings * Recommendations * Reviews * Url * Title * SiteOfOrigin * AssociatedOwnerKey * ViewTrackingCounts * ReviewRatingAttributeSetKey * ReviewItemState * StringExtensions *******************************************************************************/ Article: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.External.Article'; return extend(this, options); }, /******************************************************************************* * ArticleComments [IDaapiModel] * Retrieves metadata about a single article's comments. This does not contain paginated lists of comments, but overview data about all comments on an article. * Properties: * NumberOfComments * NumberOfTopLevelComments * ArticleKey *******************************************************************************/ ArticleComments: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.External.ArticleComments'; return extend(this, options); }, /******************************************************************************* * ArticleRatings [IDaapiModel] * A rating includes multiple rating data points for an article, including the average rating, the total number of ratings, and the current user's rating if available. * Properties: * NumberOfRatings * AverageRating * CurrentUserRating *******************************************************************************/ ArticleRatings: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.External.ArticleRatings'; return extend(this, options); }, /******************************************************************************* * Forum [IDaapiModel] * Metadata for a forum as defined in the CMW or a CommunityGroup. * Remarks:
* A specific Forum belongs to a Category (which typically contains other Forums). * Properties: * ForumKey * Title * Description * Url * DefaultUrl * MemberCount * AvatarUrl * SiteOfOrigin * AssociatedCommunityGroupKey * ForumViewCount *******************************************************************************/ Forum: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Forums.Forum'; return extend(this, options); }, /******************************************************************************* * ForumCategory [IDaapiModel] * The Category to which a Forum belongs, as defined in the CMW. * Properties: * Title * YOrder * ForumCategoryKey *******************************************************************************/ ForumCategory: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Forums.ForumCategory'; return extend(this, options); }, /******************************************************************************* * ForumDiscussion [IDaapiModel] * Metadata about a discussion (thread) and its initial post. * Properties: * Owner * ForumCategoryKey * ForumKey * ForumDiscussionKey * Title * Body * Url * DefaultUrl * LastUpdated * PostCount * SiteOfOrigin * IsQuestion * IsPoll * IsSticky * IsClosed * LastPostBy * FirstPostDate * LastPostDate * LastRead * ContainsNewPosts * SubscriptionInfo * AssociatedCommunityGroupKey * AssociatedOwnerKey * DiscussionViewCount * AbuseCounts *******************************************************************************/ ForumDiscussion: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Forums.ForumDiscussion'; return extend(this, options); }, /******************************************************************************* * SubscriptionInfo [IDaapiModel] * Information on a user's subscription state to a given forum discussion. * Properties: * IsCurrentUserSubscribed *******************************************************************************/ SubscriptionInfo: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Common.SubscriptionInfo'; return extend(this, options); }, /******************************************************************************* * ForumPost [IDaapiModel] * A single post by a user to a forum Discussion. * Properties: * Owner * ForumCategoryKey * ForumKey * ForumDiscussionKey * ForumPostKey * Title * Body * Url * DefaultUrl * LastUpdated * CreatedOn * SiteOfOrigin * IsQuestion * FriendshipStatus * UserFirstPostDate * UserLastPostDate * UserTotalPosts * AssociatedCommunityGroupKey * AbuseCounts * RecommendationCounts *******************************************************************************/ ForumPost: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Forums.ForumPost'; return extend(this, options); }, /******************************************************************************* * Gallery [IDaapiModel] * Metadata about a collection of photos or videos as defined in the CMW. * Properties: * GalleryKey * GalleryType * Title * Description * Tags * Section * RecommendationCounts * NumberOfComments * GalleryPromo * Url * CreatedOn * LastUploadedToDate * MediaType * GalleryViewState * AssociatedCommunityGroupKey * AssociatedOwnerKey * PrimaryImageUrl * TotalVisibleChildren * LinkedMemberSites *******************************************************************************/ Gallery: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Media.Gallery'; return extend(this, options); }, /******************************************************************************* * GalleryPromo [IDaapiModel] * Contains information useful for showing a small preview of the gallery. * Properties: * Image * Title * Body * PhotoKey *******************************************************************************/ GalleryPromo: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Media.GalleryPromo'; return extend(this, options); }, /******************************************************************************* * GallerySubmissionCount [IDaapiModel] * Maps an individual gallery to a corresponding number of gallery submissions. * Remarks:
* An array of these objects is returned via UserMediaSubmissionsCountPageRequest to indicate the number of submissions the specified user has made to an individual gallery. * Properties: * Gallery * SubmissionCount *******************************************************************************/ GallerySubmissionCount: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Media.GallerySubmissionCount'; return extend(this, options); }, /******************************************************************************* * Image [IDaapiModel] * URLs to an image in a number of different sizes. * Properties: * ImageId * Tiny * Small * Medium * Large * Full * P4Avatar * P4Persona * P4Photo * RecentSlide * TinyPendingApproval * SmallPendingApproval * MediumPendingApproval * LargePendingApproval * FullPendingApproval * P4AvatarPendingApproval * P4PersonaPendingApproval * P4PhotoPendingApproval * RecentSlidePendingApproval *******************************************************************************/ Image: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Media.Image'; return extend(this, options); }, /******************************************************************************* * Photo [IDaapiModel] * Metadata about an image uploaded by a user. * Properties: * PhotoKey * GalleryKey * GalleryTitle * GalleryTitles * ParentKey * Owner * Url * Title * Description * Tags * Image * NumberOfComments * IsPendingApproval * CreatedOn * Section * SiteOfOrigin * AssociatedCommunityGroupKey * AssociatedOwnerKey * AbuseCounts * RecommendationCounts * ExcludeInDiscoveryResults * ExcludeInDiscoveryResultsSiteList * Visible *******************************************************************************/ Photo: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Media.Photo'; return extend(this, options); }, /******************************************************************************* * Video [IDaapiModel] * Metadata about a user-uploaded video. * Properties: * VideoKey * GalleryKey * GalleryTitle * GalleryTitles * ParentKey * Owner * Title * Description * Tags * Section * Url * PlayUrl * ThumbnailUrl * EmbedCode * NumberOfComments * IsPendingApproval * CreatedOn * MediaID * SiteOfOrigin * AssociatedCommunityGroupKey * AssociatedOwnerKey * AbuseCounts * RecommendationCounts * ExcludeInDiscoveryResults * ExcludeInDiscoveryResultsSiteList * VideoState *******************************************************************************/ Video: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Media.Video'; return extend(this, options); }, /******************************************************************************* * AwardStatus [IDaapiModel] * All relevant Rewards information, including badge status. * Properties: * Badges * LeaderboardRankings * Activities *******************************************************************************/ AwardStatus: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.PointsAndBadging.AwardStatus'; return extend(this, options); }, /******************************************************************************* * Badge [IDaapiModel] * Contains details of a particular badge. * Properties: * BadgeKey * Name * Description * BadgeAvatarUrl * BadgeFamilyKey * BadgeFamilyName * BadgeFamilyAvatarUrl *******************************************************************************/ Badge: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.PointsAndBadging.Badge'; return extend(this, options); }, /******************************************************************************* * BadgeFamily [IDaapiModel] * The BadgeFamily response object contains information relating to a BadgeFamily object. This includes the following:
    *
  • BadgeFamily name
    • *
  • BadgeFamily description
    • *
  • BadgeFamily state (inactive/active)
    • *
  • BadgeFamily type (assigned/earned)
    • *
  • The list of badges contained within the BadgeFamily object (a list of badge response objects)
    • *
* Properties: * BadgeFamilyKey * Name * Description * Rank * State * Type * FilterBySection * BadgeFamilyAvatarUrl * Badges *******************************************************************************/ BadgeFamily: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.PointsAndBadging.BadgeFamily'; return extend(this, options); }, /******************************************************************************* * Leaderboard [IDaapiModel] * Metadata about a Leaderboard as defined in the CMW. * Properties: * LeaderboardKey * Name * Description * Rank * State * CurrencyType * LeaderboardAvatarUrl * IsPrimary *******************************************************************************/ Leaderboard: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.PointsAndBadging.Leaderboard'; return extend(this, options); }, /******************************************************************************* * LeaderboardRank [IDaapiModel] * The rank and number of points for a specified user on a single Leaderboard. * Properties: * User * Rank * Points *******************************************************************************/ LeaderboardRank: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.PointsAndBadging.LeaderboardRank'; return extend(this, options); }, /******************************************************************************* * PointsAndBadgingActivity [IDaapiModel] * Metadata about a user activity that caused the Rewards module to award points. * Properties: * ActivityName * ActivityDate * ActivityTags * UserTags * CurrencyType * Points *******************************************************************************/ PointsAndBadgingActivity: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.PointsAndBadging.PointsAndBadgingActivity'; return extend(this, options); }, /******************************************************************************* * Poll [IDaapiModel] * A one-question survey with a given list of possible answers. * Properties: * PollKey * Owner * Question * Answers * IsClosed * PollOnKey * ParentKey * StatusInfo * SiteOfOrigin * AssociatedCommunityGroupKey * Visible * AbuseCounts * RecommendationCounts *******************************************************************************/ Poll: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Polls.Poll'; return extend(this, options); }, /******************************************************************************* * PollAnswer [IDaapiModel] * One possible answer to a given poll. * Properties: * Answer * NumberOfVotes *******************************************************************************/ PollAnswer: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Polls.PollAnswer'; return extend(this, options); }, /******************************************************************************* * PrivateMessageHeader [IDaapiModel] * Summary information about a private message. * Remarks:
* Does not contain the message body. Used in widgets to present a list of messages in a given folder. * Properties: * FolderID * MessageID * From * To * MessageRead * DateSent * Subject *******************************************************************************/ PrivateMessageHeader: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.PrivateMessaging.PrivateMessageHeader'; return extend(this, options); }, /******************************************************************************* * PrivateMessage [IDaapiModel] * A textual message sent privately from one user to another. * Properties: * Body * FolderID * MessageID * From * To * MessageRead * DateSent * Subject *******************************************************************************/ PrivateMessage: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.PrivateMessaging.PrivateMessage'; return extend(this, options); }, /******************************************************************************* * PrivateMessageFolderMeta [IDaapiModel] * Metadata about a folder of private messages, such as the user's inbox, sent items, etc. * Properties: * FolderID * UnreadMessageCount * TotalMessageCount * IsSystemFolder *******************************************************************************/ PrivateMessageFolderMeta: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.PrivateMessaging.PrivateMessageFolderMeta'; return extend(this, options); }, /******************************************************************************* * Comment [IDaapiModel] * A single user-generated post attached to an item in the system such as an article, a photo, a video, a review, or a blog post. Comments can be threaded be applying a ThreadPath. * Properties: * CommentKey * Owner * PostedAtTime * Body * CommentedOnKey * Parent * Score * ContentBlockingState * DisplayStatus * Url * SiteOfOrigin * AssociatedCommunityGroupKey * AbuseCounts * RecommendationCounts * ThreadPath * NumberOfReplies * ThreadDepth * InResponseTo * Section * Categories * Tags * LastEditedBy * LastEditTimeStamp * ScoreData *******************************************************************************/ Comment: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Reactions.Comment'; return extend(this, options); }, /******************************************************************************* * RecommendationCount [IDaapiModel] * Summary information about a content item's recommendations. * Properties: * NumberOfRecommendations * CurrentUserHasRecommended *******************************************************************************/ RecommendationCount: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Reactions.RecommendationCount'; return extend(this, options); }, /******************************************************************************* * KeyAction [IDaapiModel] * Describes the action taken and the object affected. * Properties: * Key * ActionType *******************************************************************************/ KeyAction: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.System.KeyAction'; return extend(this, options); }, /******************************************************************************* * PersonaMessage [IDaapiModel] * Simple text message left to one user by another user. (Deprecated: not displayed in the Pluck 4 Persona.) * Remarks:
* PersonaMessages are owned by the recipient of the message. * Properties: * CreatedOn * Body * From * To * MessageKey * Url * AbuseCounts *******************************************************************************/ PersonaMessage: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Users.PersonaMessage'; return extend(this, options); }, /******************************************************************************* * Tag [IDaapiModel] * A string used to categorize a piece of content such as a blog post or photo. * Remarks:
* Tag is equivalent to DiscoveryCategory for discovery purposes. * Properties: * Name * Frequency *******************************************************************************/ Tag: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Users.Tag'; return extend(this, options); }, /******************************************************************************* * User [IDaapiModel] * Metadata attached to a user, such as the avatar, display name, and moderation status. * Properties: * Age * Sex * AboutMe * Location * ExtendedProfile * CustomAnswers * NumberOfMessages * NumberOfFriends * NumberOfPendingFriends * NumberOfComments * NumberOfForumPosts * MessagesOpenToEveryone * PersonaPrivacyMode * DateOfBirth * CommentsTabVisible * PhotosTabVisible * IsEmailNotificationsEnabled * SelectedStyleId * Signature * AwardStatus * AbuseCounts * RecommendationCounts * ImageId * IsAnonymous * AvatarPhotoUrl * AvatarPhotoID * UserKey * DisplayName * Email * UserTier * AdministrativeTier * IsSiteAdmin * PersonaUrl * IsBlocked * IsUnderReview * ExternalUserIds * CreatedOn * LastUpdated * FriendshipStatus * UserStatus *******************************************************************************/ User: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Users.User'; return extend(this, options); }, /******************************************************************************* * UserActivity [IDaapiModel] * An entry in a user's recent activity stream. * Properties: * Url * Title * Activity * SiteOfOrigin * PointsAwarded * Visible *******************************************************************************/ UserActivity: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Users.UserActivity'; return extend(this, options); }, /******************************************************************************* * UserSnapshot [IDaapiModel] * A CMW-specific summary view of a user. * Properties: * UserSummary * AdminTier * Tags * BozoBit * User * Blog * UserAdministrativeMetaData * DemeritCount * UserAbusableContentCount * CreatedOn * Status * ProfileUrl *******************************************************************************/ UserSnapshot: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Users.UserSnapshot'; return extend(this, options); }, /******************************************************************************* * WatchItem [IDaapiModel] * A bookmark associated with a specific user. * Remarks:
* Can point to any web page. (Deprecated: not displayed in Pluck 4 widgets.) * Properties: * WatchItemKey * UserKey * WatchTargetKey * Title * Url * SiteOfOrigin *******************************************************************************/ WatchItem: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.Users.WatchItem'; return extend(this, options); }, /******************************************************************************* * ExecApplicationActionRequest [IRequest] * Executes a Pluck 4 application request and returns the response. * * When executing this request, the following exceptions may be encountered. * Properties: * ApplicationPath * Arguments * returns: * ExecApplicationActionResponse *******************************************************************************/ ExecApplicationActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Applications.ExecApplicationActionRequest'; return extend(this, options); }, /******************************************************************************* * ContentPolicyTraceRequest [IRequest] * Current content policies in use for specified keyed object. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * *
Execution Exception CodesDescription
@link BaseKeyTypeNotSupportedAn action was attempted against a content item that does not allow that action.

* * Properties: * UserTier * ActionType * TargetKey * returns: * ContentPolicyTraceResponse *******************************************************************************/ ContentPolicyTraceRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Common.ContentPolicyTraceRequest'; return extend(this, options); }, /******************************************************************************* * DiscoveryContentPolicyTraceRequest [IRequest] * All content policies in use for specified discovery category. * * When executing this request, the following exceptions may be encountered. * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * UserTier * ActionType * Section * Categories * returns: * DiscoveryContentPolicyTraceResponse *******************************************************************************/ DiscoveryContentPolicyTraceRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Common.DiscoveryContentPolicyTraceRequest'; return extend(this, options); }, /******************************************************************************* * ResolveSEOTokenRequest [IRequest] * Takes an SEO tokenized url and returns the key that item points to. "Readable" forum or blog URLs must be enabled) * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * SEOToken * returns: * ResolveSEOTokenResponse *******************************************************************************/ ResolveSEOTokenRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Common.ResolveSEOTokenRequest'; return extend(this, options); }, /******************************************************************************* * SetStringExtensionsActionRequest [IRequest] * Associates an attribute set to the reviewed item. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissing

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentials

* * * * * * *
Execution Exception CodesDescription
@link DirtyWordFilterTriggered
@link ObjectNotFoundInStorage
@link UnhandledException

* * Properties: * BaseKey * StringExtensions * returns: * ActionResponse *******************************************************************************/ SetStringExtensionsActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Common.SetStringExtensionsActionRequest'; return extend(this, options); }, /******************************************************************************* * UserAccountSettingsRequest [IRequest] * Retrieves preferences for login and logout URLs, etc. * * When executing this request, the following exceptions may be encountered. * Properties: * returns: * UserAccountSettingsResponse *******************************************************************************/ UserAccountSettingsRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Common.UserAccountSettingsRequest'; return extend(this, options); }, /******************************************************************************* * SetSectionContentPolicyActionRequest [IRequest] * Specifies the content policy used for the desginated section. * Remarks:
* The content policy setting of "All" overrides content policy settings against individual user tiers. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * Section * ActionType * UserTier * ContentPolicy * returns: * ActionResponse *******************************************************************************/ SetSectionContentPolicyActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Common.SetSectionContentPolicyActionRequest'; return extend(this, options); }, /******************************************************************************* * SetCategoryContentPolicyActionRequest [IRequest] * Specifies the content policy used for the desginated category. * Remarks:
* The content policy setting of "All" overrides content policy settings against individual user tiers. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * Category * ActionType * UserTier * ContentPolicy * returns: * ActionResponse *******************************************************************************/ SetCategoryContentPolicyActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Common.SetCategoryContentPolicyActionRequest'; return extend(this, options); }, /******************************************************************************* * DiscoveryContentPolicyRequest [IRequest] * Current content policy applied to specified discovery category. * Remarks:
* The content policy setting of "All" overrides content policy settings against individual user tiers. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * UserTier * ActionType * Section * Categories * returns: * ContentPolicyResponse *******************************************************************************/ DiscoveryContentPolicyRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Common.DiscoveryContentPolicyRequest'; return extend(this, options); }, /******************************************************************************* * UserTiersRequest [IRequest] * List of user tiers allowed by the current user in moderation. * * When executing this request, the following exceptions may be encountered. * Properties: * returns: * UserTiersResponse *******************************************************************************/ UserTiersRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Common.UserTiersRequest'; return extend(this, options); }, /******************************************************************************* * MemberSitesRequest [IRequest] * Retrieves a list of MemberSites. Only applies to Pluck Portfolio instances (multi-site). * * When executing this request, the following exceptions may be encountered. * Properties: * returns: * MemberSitesResponse *******************************************************************************/ MemberSitesRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Common.MemberSitesRequest'; return extend(this, options); }, /******************************************************************************* * UpdateApprovalActionRequest [IRequest] * Sets the approval state for specified content items. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * BaseKeys * State * returns: * ActionResponse *******************************************************************************/ UpdateApprovalActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Common.UpdateApprovalActionRequest'; return extend(this, options); }, /******************************************************************************* * CommunityGroupUserPrefsRequest [IRequest] * Retrieves a user’s group-specific preferences. * * When executing this request, the following exceptions may be encountered. * * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.
@link MembershipTierBelowThresholdThe user does not have permission in a given CommunityGroup to perform the request.

* * Properties: * CommunityGroupKey * UserKey * returns: * CommunityGroupUserPrefsResponse *******************************************************************************/ CommunityGroupUserPrefsRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.CommunityGroups.CommunityGroupUserPrefsRequest'; return extend(this, options); }, /******************************************************************************* * UpdateCommunityGroupUserPrefsActionRequest [IRequest] * Sets your community group preferences. * * When executing this request, the following exceptions may be encountered. * * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.
@link MembershipTierBelowThresholdThe user does not have permission in a given CommunityGroup to perform the request.

* * Properties: * CommunityGroupKey * UserKey * EnableGroupManagerMessages * EnableGroupDigestMessages * GroupDigestActivityTypes * PreferredForumPostSortOrder * SubscriptionActivityTypes * GroupDigestRunDays * SubscribeReplies * returns: * ActionResponse *******************************************************************************/ UpdateCommunityGroupUserPrefsActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.CommunityGroups.UpdateCommunityGroupUserPrefsActionRequest'; return extend(this, options); }, /******************************************************************************* * UpdateDiscoveryFilterFlagActionRequest [IRequest] * Changes the discoverability of a content item. * Remarks:
* See the Discovery documentation for more detail. * * When executing this request, the following exceptions may be encountered. * * * * * *
Validation Exception CodesDescription
@link BaseKeyTypeNotSupportedAn action was attempted against a content item that does not allow that action.
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * BaseKey * ExcludeFromDiscovery * ExcludeSites * returns: * ActionResponse *******************************************************************************/ UpdateDiscoveryFilterFlagActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Discovery.UpdateDiscoveryFilterFlagActionRequest'; return extend(this, options); }, /******************************************************************************* * ForumDiscussionUnreadPostCountRequest [IRequest] * Retrieves the number of posts in a discussion that have not been read by the executing user. * Remarks:
* The "has been read" state is set by the Forum widget as the user reads, and can also be explicitly set by the user or programmatically. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * ForumDiscussionKey * returns: * ForumDiscussionUnreadPostCountResponse *******************************************************************************/ ForumDiscussionUnreadPostCountRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Forums.ForumDiscussionUnreadPostCountRequest'; return extend(this, options); }, /******************************************************************************* * ForumHasUnreadPostsRequest [IRequest] * Determines whether a ForumDiscussion has unread posts. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link InvalidValueA property contained an invalid value.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * Properties: * ForumKey * MaxDiscussionsToCheck * BypassCachePut * returns: * ForumHasUnreadPostsResponse *******************************************************************************/ ForumHasUnreadPostsRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Forums.ForumHasUnreadPostsRequest'; return extend(this, options); }, /******************************************************************************* * CommunityFeedRequest [IRequest] * Recent activity of desginated content types from across the site. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.
@link ValueOutOfRangeA parameter exceeds its range of valid values.

* * Properties: * NumberOfItems * FeedActivityTypes * returns: * CommunityFeedResponse *******************************************************************************/ CommunityFeedRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.FriendFeed.CommunityFeedRequest'; return extend(this, options); }, /******************************************************************************* * FeedReactionPageRequest [IRequest] * Retrieves a page of feed reactions. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * FeedActivityKey * ItemsPerPage * OneBasedOnPage * FeedReactionKey * ForceLastReactionPage * returns: * FeedReactionPageResponse *******************************************************************************/ FeedReactionPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.FriendFeed.FeedReactionPageRequest'; return extend(this, options); }, /******************************************************************************* * HiddenFriendsRequest [IRequest] * Retrieves hidden friends for the specified user. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * UserKey * returns: * HiddenFriendsResponse *******************************************************************************/ HiddenFriendsRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.FriendFeed.HiddenFriendsRequest'; return extend(this, options); }, /******************************************************************************* * UpdateHiddenFriendActionRequest [IRequest] * Changes the visibility state of a user's friend. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * UserKey * FriendKey * Status * returns: * ActionResponse *******************************************************************************/ UpdateHiddenFriendActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.FriendFeed.UpdateHiddenFriendActionRequest'; return extend(this, options); }, /******************************************************************************* * MoveVideoToGalleryActionRequest [IRequest] * * When executing this request, the following exceptions may be encountered. * Properties: * VideoKey * GalleryKey * returns: * ActionResponse *******************************************************************************/ MoveVideoToGalleryActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Media.MoveVideoToGalleryActionRequest'; return extend(this, options); }, /******************************************************************************* * CopyVideoToGalleryActionRequest [IRequest] * * When executing this request, the following exceptions may be encountered. * Properties: * VideoKey * GalleryKey * returns: * ActionResponse *******************************************************************************/ CopyVideoToGalleryActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Media.CopyVideoToGalleryActionRequest'; return extend(this, options); }, /******************************************************************************* * CopyPhotoToGalleryActionRequest [IRequest] * * When executing this request, the following exceptions may be encountered. * Properties: * PhotoKey * GalleryKey * returns: * ActionResponse *******************************************************************************/ CopyPhotoToGalleryActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Media.CopyPhotoToGalleryActionRequest'; return extend(this, options); }, /******************************************************************************* * CreateAvatarPhotoActionRequest [IRequest] * Uploads a new avatar photo for the executing user. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * UserKey * ImageId * Title * returns: * ActionResponse *******************************************************************************/ CreateAvatarPhotoActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Media.CreateAvatarPhotoActionRequest'; return extend(this, options); }, /******************************************************************************* * CreatePhotoActionRequest [IRequest] * Uploads a new photo. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.
@link ValueNullOrMissingA required parameter was not specified.

* * * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * Properties: * GalleryKey * ImageId * Title * Description * Tags * returns: * ActionResponse *******************************************************************************/ CreatePhotoActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Media.CreatePhotoActionRequest'; return extend(this, options); }, /******************************************************************************* * DeleteImageRequest [IRequest] * Deletes an image. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * ImageId * returns: * ActionResponse *******************************************************************************/ DeleteImageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Media.DeleteImageRequest'; return extend(this, options); }, /******************************************************************************* * PhotoSlideShowRequest [IRequest] * Retrieves a photo slide show. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * GalleryKey * PhotoKey * returns: * PhotoSlideShowResponse *******************************************************************************/ PhotoSlideShowRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Media.PhotoSlideShowRequest'; return extend(this, options); }, /******************************************************************************* * RecentPublicGallerySubmissionsPageRequest [IRequest] * Retrieves a page of a user's recent photo submissions to public galleries. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * UserKey * ItemsPerPage * OneBasedOnPage * returns: * RecentPublicGallerySubmissionsPageResponse *******************************************************************************/ RecentPublicGallerySubmissionsPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Media.RecentPublicGallerySubmissionsPageRequest'; return extend(this, options); }, /******************************************************************************* * MovePhotoToGalleryActionRequest [IRequest] * * When executing this request, the following exceptions may be encountered. * Properties: * PhotoKey * GalleryKey * returns: * ActionResponse *******************************************************************************/ MovePhotoToGalleryActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Media.MovePhotoToGalleryActionRequest'; return extend(this, options); }, /******************************************************************************* * VideoOriginalUrlRequest [IRequest] * URL of uploaded video file in its original format. * * When executing this request, the following exceptions may be encountered. * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * VideoKey * returns: * VideoOriginalUrlResponse *******************************************************************************/ VideoOriginalUrlRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Media.VideoOriginalUrlRequest'; return extend(this, options); }, /******************************************************************************* * BlockUserRequest [IRequest] * Blocks user content from appearing across the site. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * UserKey * BlockState * BlockReason * returns: * ActionResponse *******************************************************************************/ BlockUserRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.BlockUserRequest'; return extend(this, options); }, /******************************************************************************* * AddEditorCommentRequest [IRequest] * Adds a comment from a moderator, admin or editor to a user in the CMW or Moderation Manager. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * UserKey * Comment * returns: * ActionResponse *******************************************************************************/ AddEditorCommentRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.AddEditorCommentRequest'; return extend(this, options); }, /******************************************************************************* * ClearDemeritRequest [IRequest] * Resets the current demerit count for a user. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * UserKey * Comment * returns: * ActionResponse *******************************************************************************/ ClearDemeritRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.ClearDemeritRequest'; return extend(this, options); }, /******************************************************************************* * DeleteKeywordWatchListActionRequest [IRequest] * Deletes a Listener in the Moderation Manager. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * Key * returns: * ActionResponse *******************************************************************************/ DeleteKeywordWatchListActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.DeleteKeywordWatchListActionRequest'; return extend(this, options); }, /******************************************************************************* * FlaggedRoutesRequest [IRequest] * Retrives a list of all the Flag Routes defined in the Moderation Manager. * * When executing this request, the following exceptions may be encountered. * Properties: * returns: * FlaggedRoutesResponse *******************************************************************************/ FlaggedRoutesRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.FlaggedRoutesRequest'; return extend(this, options); }, /******************************************************************************* * KeywordWatchListRequest [IRequest] * Retrieves info about a specific Listener, like what tiers the Listener applies to and what words the Listener matches. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * Key * returns: * KeywordWatchListResponse *******************************************************************************/ KeywordWatchListRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.KeywordWatchListRequest'; return extend(this, options); }, /******************************************************************************* * KeywordWatchListsPageRequest [IRequest] * Retrieves all the Listeners that are currently defined in the Moderation Manager. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueOutOfRangeA parameter exceeds its range of valid values.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * ItemsPerPage * OneBasedOnPage * SortType * returns: * KeywordWatchListsPageResponse *******************************************************************************/ KeywordWatchListsPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.KeywordWatchListsPageRequest'; return extend(this, options); }, /******************************************************************************* * SetFlaggedRoutesActionRequest [IRequest] * Sets all the available Flag Routes. To add or delete a flag route, call FlaggedRoutesRequest to get the whole list, add or remove flag routes, and send the resulting list through SetFlaggedRoutesActionRequest. * * When executing this request, the following exceptions may be encountered. * * * *
Execution Exception CodesDescription
@link UnhandledExceptionAn unexpected error occurred in the request.

* * Properties: * Routes * returns: * ActionResponse *******************************************************************************/ SetFlaggedRoutesActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.SetFlaggedRoutesActionRequest'; return extend(this, options); }, /******************************************************************************* * UpdateKeywordWatchListActionRequest [IRequest] * Changes the tiers a Listener applies to and/or the words a Listener matches. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * Key * Name * Words * FilteredUserTiers * returns: * ActionResponse *******************************************************************************/ UpdateKeywordWatchListActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.UpdateKeywordWatchListActionRequest'; return extend(this, options); }, /******************************************************************************* * UpdateLockTimeoutActionRequest [IRequest] * Resets the lock on a given item in moderation so it is not sent to a different moderator. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * ModerationItemKey * ForEdit * returns: * ModerationLockTimeoutResponse *******************************************************************************/ UpdateLockTimeoutActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.UpdateLockTimeoutActionRequest'; return extend(this, options); }, /******************************************************************************* * SetReviewBlockingStateActionRequest [IRequest] * Sets Review blocking state. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * State * ReviewKey * ForModeration * ModeratorsComment * returns: * ActionResponse *******************************************************************************/ SetReviewBlockingStateActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.SetReviewBlockingStateActionRequest'; return extend(this, options); }, /******************************************************************************* * ModerationChangeUserTierRequest [IRequest] * Updates the tier of the specified user to a new tier. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * UserKey * NewTier * returns: * ActionResponse *******************************************************************************/ ModerationChangeUserTierRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.ModerationChangeUserTierRequest'; return extend(this, options); }, /******************************************************************************* * ModerationRecentUserActivityRequest [IRequest] * List of recent activity performed by the user for context in moderation. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * UserKey * returns: * RecentUserActivityResponse *******************************************************************************/ ModerationRecentUserActivityRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.ModerationRecentUserActivityRequest'; return extend(this, options); }, /******************************************************************************* * RemoveUserAvatarRequest [IRequest] * Removes the avatar from a user profile when being moderated. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * UserKey * returns: * ActionResponse *******************************************************************************/ RemoveUserAvatarRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.RemoveUserAvatarRequest'; return extend(this, options); }, /******************************************************************************* * ModerationEditorCommentsRequest [IRequest] * Adds internal notes to the user profile for use by moderators, editors and admins. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * *
Execution Exception CodesDescription
@link UnhandledExceptionAn unexpected error occurred in the request.

* * Properties: * UserKey * returns: * ModerationEditorCommentsResponse *******************************************************************************/ ModerationEditorCommentsRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.ModerationEditorCommentsRequest'; return extend(this, options); }, /******************************************************************************* * ModerationUserRequest [IRequest] * Retrieves a user with extra metadata that is specifically used in the Moderation Manager, like editor comments. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.
@link UnhandledExceptionAn unexpected error occurred in the request.

* * Properties: * UserKey * returns: * ModerationUserResponse *******************************************************************************/ ModerationUserRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.ModerationUserRequest'; return extend(this, options); }, /******************************************************************************* * SetCommentBlockingStateActionRequest [IRequest] * Sets comment blocking state. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * State * CommentKey * ForModeration * ModeratorsComment * returns: * ActionResponse *******************************************************************************/ SetCommentBlockingStateActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.SetCommentBlockingStateActionRequest'; return extend(this, options); }, /******************************************************************************* * BlogsPageRequest [IRequest] * Retrieves a page of blogs having the specified type. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link InvalidValueA property contained an invalid value.

* * Properties: * BlogType * ItemsPerPage * OneBasedOnPage * returns: * BlogsPageResponse *******************************************************************************/ BlogsPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Blogs.BlogsPageRequest'; return extend(this, options); }, /******************************************************************************* * SetDiscoveryCategoriesActionRequest [IRequest] * Sets the DiscoveryCategories on a content item. Executing user must be an admin. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.
@link UnhandledExceptionAn unexpected error occurred in the request.

* * Properties: * BaseKey * DiscoveryCategories * returns: * ActionResponse *******************************************************************************/ SetDiscoveryCategoriesActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Common.SetDiscoveryCategoriesActionRequest'; return extend(this, options); }, /******************************************************************************* * SetDiscoverySectionActionRequest [IRequest] * Request to set the DiscoverySection for a moderation queue. * Remarks:
* One of several settings that determine which content appears in a given queue. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.
@link UnhandledExceptionAn unexpected error occurred in the request.

* * Properties: * BaseKey * DiscoverySectionName * returns: * ActionResponse *******************************************************************************/ SetDiscoverySectionActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Common.SetDiscoverySectionActionRequest'; return extend(this, options); }, /******************************************************************************* * ShortenUrlRequest [IRequest] * Shortens a long URL, using bit.ly or a similar service. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * LongUrl * returns: * ShortenUrlResponse *******************************************************************************/ ShortenUrlRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Common.ShortenUrlRequest'; return extend(this, options); }, /******************************************************************************* * RecentCommunityGroupActivitiesPageRequest [IRequest] * Retrieves a page of recent CommunityGroupActivities. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * CommunityGroupKey * ItemsPerPage * OneBasedOnPage * returns: * RecentCommunityGroupActivitiesPageResponse *******************************************************************************/ RecentCommunityGroupActivitiesPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.CommunityGroups.RecentCommunityGroupActivitiesPageRequest'; return extend(this, options); }, /******************************************************************************* * BlogPostArchiveContentsPageRequest [IRequest] * Retrieves posts in the specified Blog for a given month. Archived blog posts are organized by month and year. * * When executing this request, the following exceptions may be encountered. * * * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.
@link ValueOutOfRangeA parameter exceeds its range of valid values.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.
@link UnhandledExceptionAn unexpected error occurred in the request.

* * Properties: * BlogKey * Month * Year * ItemsPerPage * SortType * OneBasedOnPage * returns: * BlogPostArchiveContentsPageResponse *******************************************************************************/ BlogPostArchiveContentsPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Blogs.BlogPostArchiveContentsPageRequest'; return extend(this, options); }, /******************************************************************************* * BlogPostArchiveCountRequest [IRequest] * Retrieves the number of posts in a given blog, grouped by month and year. Used in the widget to display links to the blog's archive. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * Properties: * BlogKey * returns: * BlogPostArchiveCountResponse *******************************************************************************/ BlogPostArchiveCountRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Blogs.BlogPostArchiveCountRequest'; return extend(this, options); }, /******************************************************************************* * BlogPostsPageRequest [IRequest] * Retrieves a page of blog posts. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.
@link UnhandledExceptionAn unexpected error occurred in the request.

* * Properties: * BlogKey * BlogPostState * RestrictToOwner * IncludeFuturePosts * ItemsPerPage * SortType * OneBasedOnPage * returns: * BlogPostsPageResponse *******************************************************************************/ BlogPostsPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Blogs.BlogPostsPageRequest'; return extend(this, options); }, /******************************************************************************* * BlogPostRequest [IRequest] * Retrieves a blog post. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link InvalidValueA property contained an invalid value.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.
@link UnhandledExceptionAn unexpected error occurred in the request.

* * Properties: * BlogPostKey * BlogPostSEOKey * returns: * BlogPostResponse *******************************************************************************/ BlogPostRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Blogs.BlogPostRequest'; return extend(this, options); }, /******************************************************************************* * BlogPostsByTagPageRequest [IRequest] * Retrieves a page of posts having the specified tag, within the specified blog. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * BlogKey * Tag * ItemsPerPage * SortType * OneBasedOnPage * returns: * BlogPostsPageResponse *******************************************************************************/ BlogPostsByTagPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Blogs.BlogPostsByTagPageRequest'; return extend(this, options); }, /******************************************************************************* * BlogRequest [IRequest] * Retrieves a blog. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.
@link ObjectPopulationErrorA requested content item (or the target of an action) exists, but could not be retrieved from the database.

* * Properties: * BlogKey * returns: * BlogResponse *******************************************************************************/ BlogRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Blogs.BlogRequest'; return extend(this, options); }, /******************************************************************************* * RecentBlogTagRequest [IRequest] * Retrieves tags that have been recently entered in the posts of the specified blog. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * Properties: * BlogKey * returns: * RecentBlogTagResponse *******************************************************************************/ RecentBlogTagRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Blogs.RecentBlogTagRequest'; return extend(this, options); }, /******************************************************************************* * UpdateBlogActionRequest [IRequest] * Updates metadata on a Blog. * Remarks:
* Note that to update a single field you must first request the existing object and echo the current * state back on the update request, changing only the fields you want to update. Properties not set on the action request will clear existing values. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.
@link ValueOutOfRangeA parameter exceeds its range of valid values.

* * * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.
@link UserBannedFromGroupThe executing user has been banned from activity in the target CommunityGroup.

* * * * *
Execution Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.

* * Properties: * BlogKey * BlogType * Title * Tagline * BlogRollEntries * CommentApproval * AllowComments * returns: * ActionResponse *******************************************************************************/ UpdateBlogActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Blogs.UpdateBlogActionRequest'; return extend(this, options); }, /******************************************************************************* * UpdateBlogPostActionRequest [IRequest] * Creates or updates a blog post. * Remarks:
* New content is associated with the executing user. Note that to update a single field you must first request the existing object and echo the current * state back on the update request, changing only the fields you want to update. Properties not set on the action request will clear existing values. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link BaseKeyTypeNotSupportedAn action was attempted against a content item that does not allow that action.
@link ValueNullOrMissingA required parameter was not specified.

* * * * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.
@link MembershipTierBelowThresholdThe user does not have permission in a given CommunityGroup to perform the request.
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * Properties: * Key * Title * Body * Tags * PublishDate * IsPublished * returns: * ActionResponse *******************************************************************************/ UpdateBlogPostActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Blogs.UpdateBlogPostActionRequest'; return extend(this, options); }, /******************************************************************************* * CheckFilteredWordsRequest [IRequest] * Checks textual content against the word filter defined in the CMW. The response indicates which words are disallowed, if any. * Remarks:
* The key of each entry in the CheckStrings property is an arbitrary identifier and the value is the string to be checked. The response pairs the same identifiers against a comma-delimited list of words that didn't pass the filter. In this manner, multiple fields of a single entry can be checked against the word filter with a single request. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * CheckStrings * returns: * CheckFilteredWordsResponse *******************************************************************************/ CheckFilteredWordsRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Common.CheckFilteredWordsRequest'; return extend(this, options); }, /******************************************************************************* * DeleteContentActionRequest [IRequest] * Deletes content. The executing user must be an editor or the content's author. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link BaseKeyTypeNotSupportedAn action was attempted against a content item that does not allow that action.
@link ValueNullOrMissingA required parameter was not specified.

* * * * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.
@link NotSupportedThe request or operation is not supported by the system.
@link UserBannedFromGroupThe executing user has been banned from activity in the target CommunityGroup.

* * * * * * * * *
Execution Exception CodesDescription
@link DirtyWordFilterTriggeredOne or more words in the content submitted appear on the list of stop words configured in the CMW.
@link InvalidCredentialsThe user is not allowed to perform the requested operation.
@link NotSupportedThe request or operation is not supported by the system.
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.
@link UserBannedFromGroupThe executing user has been banned from activity in the target CommunityGroup.

* * Properties: * BaseKey * returns: * ActionResponse *******************************************************************************/ DeleteContentActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Common.DeleteContentActionRequest'; return extend(this, options); }, /******************************************************************************* * EditorMessageRequest [IRequest] * Retrieves the editorial message specified in the CMW. Deprecated in the Pluck 4 Persona widget. * * When executing this request, the following exceptions may be encountered. * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * returns: * EditorMessageResponse *******************************************************************************/ EditorMessageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Common.EditorMessageRequest'; return extend(this, options); }, /******************************************************************************* * EmailContentActionRequest [IRequest] * Sends an email through the Pluck server. Allows any email address as a recipient. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.

* * Properties: * ToAddress * Subject * Body * returns: * ActionResponse *******************************************************************************/ EmailContentActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Common.EmailContentActionRequest'; return extend(this, options); }, /******************************************************************************* * EmailContentWithUserIDActionRequest [IRequest] * Sends email to a user, using the address provided to Pluck by your registration system. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link InvalidOrMissingEmailAddressThe user does not have an email address in the system. Used by EmailContentWithUserIdActionRequest.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.

* * Properties: * ToUserKey * Subject * Body * returns: * ActionResponse *******************************************************************************/ EmailContentWithUserIDActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Common.EmailContentWithUserIDActionRequest'; return extend(this, options); }, /******************************************************************************* * ContentPolicyRequest [IRequest] * Retrieves the moderation policy that is applied to a specific piece of content, for the given action and user tier. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link BaseKeyTypeNotSupportedAn action was attempted against a content item that does not allow that action.

* * Properties: * UserTier * ActionType * TargetKey * returns: * ContentPolicyResponse *******************************************************************************/ ContentPolicyRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Common.ContentPolicyRequest'; return extend(this, options); }, /******************************************************************************* * ReportAbuseActionRequest [IRequest] * Records an abuse report against a content item. * Remarks:
* The report is attributed to the executing user. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link BaseKeyTypeNotSupportedAn action was attempted against a content item that does not allow that action.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * AbuseOnKey * Reason * Description * returns: * ActionResponse *******************************************************************************/ ReportAbuseActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.ReportAbuseActionRequest'; return extend(this, options); }, /******************************************************************************* * SearchActionRequest [IRequest] * Performs a textual search for content within the specified content type. * Remarks:
* Pluck uses Lucene for full-text indexing. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link UnhandledExceptionAn unexpected error occurred in the request.

* * @see SDK Search Options * Properties: * SearchType * SearchString * ItemsPerPage * OneBasedOnPage * returns: * SearchResponse *******************************************************************************/ SearchActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Common.SearchActionRequest'; return extend(this, options); }, /******************************************************************************* * SetContentPolicyActionRequest [IRequest] * Applies a moderation policy that to a specific piece of content, for the given action and user tier. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link BaseKeyTypeNotSupportedAn action was attempted against a content item that does not allow that action.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * TargetKey * ActionType * UserTier * ContentPolicy * returns: * ActionResponse *******************************************************************************/ SetContentPolicyActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Common.SetContentPolicyActionRequest'; return extend(this, options); }, /******************************************************************************* * SystemTimeInfoRequest [IRequest] * Retrieves system time information from the Pluck server. * Remarks:
* Can be used to compare timestamps on content to local time. * * When executing this request, the following exceptions may be encountered. * Properties: * returns: * SystemTimeInfoResponse *******************************************************************************/ SystemTimeInfoRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Common.SystemTimeInfoRequest'; return extend(this, options); }, /******************************************************************************* * BannedCommunityGroupUsersPageRequest [IRequest] * Retrieves a page of users banned from the specified CommunityGroup. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.
@link UserBannedFromGroupThe executing user has been banned from activity in the target CommunityGroup.

* * Properties: * CommunityGroupKey * ItemsPerPage * SortType * OneBasedOnPage * returns: * BannedCommunityGroupUsersPageResponse *******************************************************************************/ BannedCommunityGroupUsersPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.CommunityGroups.BannedCommunityGroupUsersPageRequest'; return extend(this, options); }, /******************************************************************************* * InvitedCommunityGroupUsersPageRequest [IRequest] * Retrieves a page of users who have been invited to a community group. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * CommunityGroupKey * ItemsPerPage * SortType * OneBasedOnPage * returns: * InvitedCommunityGroupUsersPageResponse *******************************************************************************/ InvitedCommunityGroupUsersPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.CommunityGroups.InvitedCommunityGroupUsersPageRequest'; return extend(this, options); }, /******************************************************************************* * CommunityGroupMembershipsPageRequest [IRequest] * Retrieves a page of CommunityGroupMemberships. * * When executing this request, the following exceptions may be encountered. * * * * * * *
Validation Exception CodesDescription
@link AnonymousNotSupportedThe user isn't authenticated and the action isn't allowed for anonymous users.
@link BaseKeyTypeNotSupportedAn action was attempted against a content item that does not allow that action.
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * Key * MembershipFilter * ItemsPerPage * SortType * OneBasedOnPage * returns: * CommunityGroupMembershipsPageResponse *******************************************************************************/ CommunityGroupMembershipsPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.CommunityGroups.CommunityGroupMembershipsPageRequest'; return extend(this, options); }, /******************************************************************************* * CommunityGroupMembershipRequest [IRequest] * Retrieves a CommunityGroupMembership object. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link AnonymousNotSupportedThe user isn't authenticated and the action isn't allowed for anonymous users.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * CommunityGroupKey * UserKey * returns: * CommunityGroupMembershipResponse *******************************************************************************/ CommunityGroupMembershipRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.CommunityGroups.CommunityGroupMembershipRequest'; return extend(this, options); }, /******************************************************************************* * MostActiveCommunityGroupMembersRequest [IRequest] * Retrieves the most active CommunityGroup members. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.
@link ValueOutOfRangeA parameter exceeds its range of valid values.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * CommunityGroupKey * Age * MaximumNumberOfMembers * returns: * MostActiveCommunityGroupMembersResponse *******************************************************************************/ MostActiveCommunityGroupMembersRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.CommunityGroups.MostActiveCommunityGroupMembersRequest'; return extend(this, options); }, /******************************************************************************* * CommunityGroupsPageRequest [IRequest] * Retrieves a page of CommunityGroups. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * Section * ItemsPerPage * SortType * OneBasedOnPage * returns: * CommunityGroupsPageResponse *******************************************************************************/ CommunityGroupsPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.CommunityGroups.CommunityGroupsPageRequest'; return extend(this, options); }, /******************************************************************************* * CommunityGroupRegistrantsPageRequest [IRequest] * Retrieves a page of CommunityGroupRegistrants. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.
@link UserBannedFromGroupThe executing user has been banned from activity in the target CommunityGroup.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * CommunityGroupKey * ItemsPerPage * SortType * OneBasedOnPage * returns: * CommunityGroupRegistrantsPageResponse *******************************************************************************/ CommunityGroupRegistrantsPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.CommunityGroups.CommunityGroupRegistrantsPageRequest'; return extend(this, options); }, /******************************************************************************* * CommunityGroupRequest [IRequest] * Retrieves a CommunityGroup. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * CommunityGroupKey * returns: * CommunityGroupResponse *******************************************************************************/ CommunityGroupRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.CommunityGroups.CommunityGroupRequest'; return extend(this, options); }, /******************************************************************************* * CommunityGroupSearchActionRequest [IRequest] * Performs a textual search of content in the specified CommunityGroup. * Remarks:
* Pluck uses Lucene for full-text indexing. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * @see Search Options * Properties: * CommunityGroupKey * SearchType * SearchString * ItemsPerPage * OneBasedOnPage * returns: * CommunityGroupSearchResponse *******************************************************************************/ CommunityGroupSearchActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.CommunityGroups.CommunityGroupSearchActionRequest'; return extend(this, options); }, /******************************************************************************* * RequestCommunityGroupMembershipActionRequest [IRequest] * Sends a membership request to the admin(s) of a CommunityGroup for the specified user. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link UserBannedFromGroupThe executing user has been banned from activity in the target CommunityGroup.

* * * * *
Execution Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * CommunityGroupKey * UserKey * Message * returns: * ActionResponse *******************************************************************************/ RequestCommunityGroupMembershipActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.CommunityGroups.RequestCommunityGroupMembershipActionRequest'; return extend(this, options); }, /******************************************************************************* * RequestDeleteCommunityGroupActionRequest [IRequest] * Sends site administrators a request to delete a community group. Does not actually delete content. Executing user must be a designated admin of the specified group. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.
@link UserBannedFromGroupThe executing user has been banned from activity in the target CommunityGroup.

* * Properties: * CommunityGroupKey * DeleteReason * returns: * ActionResponse *******************************************************************************/ RequestDeleteCommunityGroupActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.CommunityGroups.RequestDeleteCommunityGroupActionRequest'; return extend(this, options); }, /******************************************************************************* * UpdateCommunityGroupActionRequest [IRequest] * Update metadata for a CommunityGroup. * Remarks:
* Note that to update a single field you must first request the existing object and echo the current * state back on the update request, changing only the fields you want to update. Properties not set on the action request will clear existing values. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.
@link UserBannedFromGroupThe executing user has been banned from activity in the target CommunityGroup.

* * Properties: * CommunityGroupKey * Title * Description * Categories * Visibility * Bookmarks * Section * AvatarPhotoKey * returns: * ActionResponse *******************************************************************************/ UpdateCommunityGroupActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.CommunityGroups.UpdateCommunityGroupActionRequest'; return extend(this, options); }, /******************************************************************************* * UpdateCommunityGroupBookmarksActionRequest [IRequest] * Creates or updates a CommunityGroup's Bookmarks. * Remarks:
* Note that to update a single field you must first request the existing object and echo the current * state back on the update request, changing only the fields you want to update. Properties not set on the action request will clear existing values. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.
@link UserBannedFromGroupThe executing user has been banned from activity in the target CommunityGroup.

* * Properties: * CommunityGroupKey * Bookmarks * returns: * ActionResponse *******************************************************************************/ UpdateCommunityGroupBookmarksActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.CommunityGroups.UpdateCommunityGroupBookmarksActionRequest'; return extend(this, options); }, /******************************************************************************* * UpdateCommunityGroupMembershipActionRequest [IRequest] * Adds a new member to a CommunityGroup, modifies the MembershipTier of an existing member, or bans a user from the group. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link AnonymousNotSupportedThe user isn't authenticated and the action isn't allowed for anonymous users.
@link ValueNullOrMissingA required parameter was not specified.

* * * * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.
@link NotSupportedThe request or operation is not supported by the system.
@link UserBannedFromGroupThe executing user has been banned from activity in the target CommunityGroup.

* * Properties: * CommunityGroupKey * UserKey * MembershipTier * IsBanned * BanMessage * returns: * ActionResponse *******************************************************************************/ UpdateCommunityGroupMembershipActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.CommunityGroups.UpdateCommunityGroupMembershipActionRequest'; return extend(this, options); }, /******************************************************************************* * AddCustomCollectionActionRequest [IRequest] * Creates or updates a CustomCollection. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * @see Search Options * Properties: * CustomCollectionKey * CustomCollectionName * returns: * ActionResponse *******************************************************************************/ AddCustomCollectionActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Custom.AddCustomCollectionActionRequest'; return extend(this, options); }, /******************************************************************************* * CustomCollectionsPageRequest [IRequest] * Retrieves a page of items stored in the specified CustomCollection. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * CustomCollectionKey * ItemsPerPage * SortType * OneBasedOnPage * returns: * CustomCollectionsPageResponse *******************************************************************************/ CustomCollectionsPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Custom.CustomCollectionsPageRequest'; return extend(this, options); }, /******************************************************************************* * CustomCollectionRequest [IRequest] * Retrieves a CustomCollection, which contains metadata about the collection. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * CustomCollectionKey * returns: * CustomCollectionResponse *******************************************************************************/ CustomCollectionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Custom.CustomCollectionRequest'; return extend(this, options); }, /******************************************************************************* * CustomItemRequest [IRequest] * Retrieves a custom item. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * CustomItemKey * returns: * CustomItemResponse *******************************************************************************/ CustomItemRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Custom.CustomItemRequest'; return extend(this, options); }, /******************************************************************************* * InsertIntoCollectionActionRequest [IRequest] * Inserts an item into a CustomCollection. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * CustomCollectionKey * TargetKey * Position * Timestamp * returns: * ActionResponse *******************************************************************************/ InsertIntoCollectionActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Custom.InsertIntoCollectionActionRequest'; return extend(this, options); }, /******************************************************************************* * RemoveFromCollectionActionRequest [IRequest] * Removes an item from a CustomCollection. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * CustomCollectionKey * TargetKey * Position * RemoveAtSpecifiedPositionOnly * returns: * ActionResponse *******************************************************************************/ RemoveFromCollectionActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Custom.RemoveFromCollectionActionRequest'; return extend(this, options); }, /******************************************************************************* * UpdateCustomItemActionRequest [IRequest] * Creates or updates a custom item. * Remarks:
* Note that to update a single field you must first request the existing object and echo the current * state back on the update request, changing only the fields you want to update. Properties not set on the action request will clear existing values. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.
@link ValueOutOfRangeA parameter exceeds its range of valid values.

* * Properties: * CustomItemKey * Name * MimeType * DisplayText * Content * IncludeInRecentActivity * SubjectToSubmissionQuota * returns: * ActionResponse *******************************************************************************/ UpdateCustomItemActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Custom.UpdateCustomItemActionRequest'; return extend(this, options); }, /******************************************************************************* * DiscoverContentActionRequest [IRequest] * Retrieves the most recent or active content. Gets content for the specified activity and content types, but additional criteria can be included. * Remarks:
* Pluck Discovery allows you to highlight content that is either new or actively generating reactions from users, for example: new blog posts, or most commented articles. You can also discover content with the highest tracked views (see ArticleRequest). || Discovery is based on a rolling window -- only reactions made within the specified number of days are counted. Thus, hot content will not monopolize results indefinitely. || Queries can be further refined with several optional parameters, including section and category. (For blogs, photos and videos, category is equivalent to tag.) Specifying multiple sections will return content from ANY of those sections (OR). If multiple categories are specified, content must match ALL of them (AND). (Note that sections applied to galleries do not cascade down to individual photos or videos.) || A wide variety of content type and activity permutations is supported. See the Discovery Permutations grid for more detail. * * When executing this request, the following exceptions may be encountered. * * * * * *
Validation Exception CodesDescription
@link InvalidValueA property contained an invalid value.
@link ValueNullOrMissingA required parameter was not specified.
@link ValueOutOfRangeA parameter exceeds its range of valid values.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * Sections * Categories * LimitToContributors * Activity * Age * MaximumNumberOfDiscoveries * Type * FilterBySiteOfOrigin * ParentKeys * returns: * DiscoverContentResponse *******************************************************************************/ DiscoverContentActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Discovery.DiscoverContentActionRequest'; return extend(this, options); }, /******************************************************************************* * EventRequest [IRequest] * Retrieves a community group event record. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * EventKey * returns: * EventResponse *******************************************************************************/ EventRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Events.EventRequest'; return extend(this, options); }, /******************************************************************************* * EventsPageRequest [IRequest] * Retrieves a page of community group events. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * Properties: * EventSetKey * StartDate * EndDate * ItemsPerPage * SortType * OneBasedOnPage * returns: * EventsPageResponse *******************************************************************************/ EventsPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Events.EventsPageRequest'; return extend(this, options); }, /******************************************************************************* * UpdateEventActionRequest [IRequest] * Updates an event in a CommunityGroup. * Remarks:
* Note that to update a single field you must first request the existing object and echo the current * state back on the update request, changing only the fields you want to update. Properties not set on the action request will clear existing values. * * When executing this request, the following exceptions may be encountered. * * * * * *
Validation Exception CodesDescription
@link InvalidValueA property contained an invalid value.
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * Properties: * EventKey * Key * Title * Description * Location * BookmarkName * BookmarkUrl * StartDate * EndDate * UtcOffset * returns: * ActionResponse *******************************************************************************/ UpdateEventActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Events.UpdateEventActionRequest'; return extend(this, options); }, /******************************************************************************* * ArticleRequest [IRequest] * Retrieves an Article, which contains metadata about any resource external to Pluck. Also used to trigger a tracked view for discovery purposes. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * ArticleKey * ViewTrackRequest * returns: * ArticleResponse *******************************************************************************/ ArticleRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.External.ArticleRequest'; return extend(this, options); }, /******************************************************************************* * UpdateArticleActionRequest [IRequest] * Updates metadata on an Article. * Remarks:
* Creates the Article if it doesn't already exist. Note that to update a single field you must first request the existing object and echo the current * state back on the update request, changing only the fields you want to update. Properties not set on the action request will clear existing values. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectPopulationErrorA requested content item (or the target of an action) exists, but could not be retrieved from the database.

* * Properties: * ArticleKey * OnPageUrl * OnPageTitle * Section * Categories * ReviewItemState * returns: * ActionResponse *******************************************************************************/ UpdateArticleActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.External.UpdateArticleActionRequest'; return extend(this, options); }, /******************************************************************************* * FirstUnreadForumPostRequest [IRequest] * Retrieves a page starting with the first unread post in a given discussion. * Remarks:
* The "has been read" state is set by the Forum widget as the user reads, and can also be explicitly set by the user or programmatically. * * When executing this request, the following exceptions may be encountered. * * * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.
@link ValueOutOfRangeA parameter exceeds its range of valid values.

* * * * *
Execution Exception CodesDescription
@link ObjectPopulationErrorA requested content item (or the target of an action) exists, but could not be retrieved from the database.

* * Properties: * ForumDiscussionKey * ItemsPerPage * SortType * returns: * ForumPostOnPageResponse *******************************************************************************/ FirstUnreadForumPostRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Forums.FirstUnreadForumPostRequest'; return extend(this, options); }, /******************************************************************************* * ForumCategoriesPageRequest [IRequest] * Retrieves a page of ForumCategories. * * When executing this request, the following exceptions may be encountered. * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * ItemsPerPage * OneBasedOnPage * returns: * ForumCategoriesPageResponse *******************************************************************************/ ForumCategoriesPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Forums.ForumCategoriesPageRequest'; return extend(this, options); }, /******************************************************************************* * ForumCategoryRequest [IRequest] * Retrieves a ForumCategory (metadata on a given category). * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * ForumCategoryKey * returns: * ForumCategoryResponse *******************************************************************************/ ForumCategoryRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Forums.ForumCategoryRequest'; return extend(this, options); }, /******************************************************************************* * ForumDiscussionRequest [IRequest] * Retrieves a ForumDiscussion. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * ForumDiscussionKey * returns: * ForumDiscussionResponse *******************************************************************************/ ForumDiscussionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Forums.ForumDiscussionRequest'; return extend(this, options); }, /******************************************************************************* * ForumDiscussionsPageRequest [IRequest] * Retrieves a page of ForumDiscussions. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * ForumKey * ItemsPerPage * OneBasedOnPage * returns: * ForumDiscussionsPageResponse *******************************************************************************/ ForumDiscussionsPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Forums.ForumDiscussionsPageRequest'; return extend(this, options); }, /******************************************************************************* * ForumPostRequest [IRequest] * Retrieves a ForumPost. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * ForumPostKey * returns: * ForumPostResponse *******************************************************************************/ ForumPostRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Forums.ForumPostRequest'; return extend(this, options); }, /******************************************************************************* * ForumPostsPageRequest [IRequest] * Retrieves a page of ForumPosts. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * ForumDiscussionKey * FindForumPostKey * ItemsPerPage * SortType * OneBasedOnPage * returns: * ForumPostsPageResponse *******************************************************************************/ ForumPostsPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Forums.ForumPostsPageRequest'; return extend(this, options); }, /******************************************************************************* * ForumRequest [IRequest] * Retrieves metadata about a Forum. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * ForumKey * returns: * ForumResponse *******************************************************************************/ ForumRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Forums.ForumRequest'; return extend(this, options); }, /******************************************************************************* * ForumSearchActionRequest [IRequest] * Performs a textual search of content in forum posts and discussions. Can be limited to a specific forum or category. * Remarks:
* Pluck uses Lucene for full-text indexing. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link BaseKeyTypeNotSupportedAn action was attempted against a content item that does not allow that action.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * @see Search Options * Properties: * SearchKey * SearchString * ItemsPerPage * OneBasedOnPage * returns: * ForumSearchResponse *******************************************************************************/ ForumSearchActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Forums.ForumSearchActionRequest'; return extend(this, options); }, /******************************************************************************* * ForumsPageRequest [IRequest] * Retrieves a page of Forums, which contain metadata about a forum. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * ForumCategoryKey * ItemsPerPage * OneBasedOnPage * returns: * ForumsPageResponse *******************************************************************************/ ForumsPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Forums.ForumsPageRequest'; return extend(this, options); }, /******************************************************************************* * ToggleForumDiscussionClosedActionRequest [IRequest] * Toggles a discussion between open and closed states. Users cannot add new posts to closed discussions. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.
@link UserBannedFromGroupThe executing user has been banned from activity in the target CommunityGroup.

* * Properties: * ForumDiscussionKey * returns: * ActionResponse *******************************************************************************/ ToggleForumDiscussionClosedActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Forums.ToggleForumDiscussionClosedActionRequest'; return extend(this, options); }, /******************************************************************************* * ToggleForumDiscussionStickyActionRequest [IRequest] * Sets/un-sets the sticky state of a discussion. * Remarks:
* Sticky discussions appear above others in a forum's discussion list. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.
@link UserBannedFromGroupThe executing user has been banned from activity in the target CommunityGroup.

* * Properties: * ForumDiscussionKey * returns: * ActionResponse *******************************************************************************/ ToggleForumDiscussionStickyActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Forums.ToggleForumDiscussionStickyActionRequest'; return extend(this, options); }, /******************************************************************************* * LatestForumPostRequest [IRequest] * Retrieves the latest ForumPost for a given discussion. * * When executing this request, the following exceptions may be encountered. * * * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.
@link ValueOutOfRangeA parameter exceeds its range of valid values.

* * * * *
Execution Exception CodesDescription
@link ObjectPopulationErrorA requested content item (or the target of an action) exists, but could not be retrieved from the database.

* * Properties: * ForumDiscussionKey * ItemsPerPage * SortType * returns: * ForumPostOnPageResponse *******************************************************************************/ LatestForumPostRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Forums.LatestForumPostRequest'; return extend(this, options); }, /******************************************************************************* * RecentForumDiscussionsPageRequest [IRequest] * Retrieves a page of recent Discussions. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * UserKey * ItemsPerPage * OneBasedOnPage * returns: * RecentForumDiscussionsPageResponse *******************************************************************************/ RecentForumDiscussionsPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Forums.RecentForumDiscussionsPageRequest'; return extend(this, options); }, /******************************************************************************* * UpdateForumDiscussionLastReadActionRequest [IRequest] * Selects a given post as the one the user read most recently. Affects behavior in the forum widgets. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * ForumDiscussionKey * ForumPostKey * ForceUpdate * returns: * ActionResponse *******************************************************************************/ UpdateForumDiscussionLastReadActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Forums.UpdateForumDiscussionLastReadActionRequest'; return extend(this, options); }, /******************************************************************************* * UpdateForumActionRequest [IRequest] * Updates the metadata on a Forum. * Remarks:
* Note that to update a single field you must first request the existing object and echo the current * state back on the update request, changing only the fields you want to update. Properties not set on the action request will clear existing values. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * ForumKey * Title * Description * returns: * ActionResponse *******************************************************************************/ UpdateForumActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Forums.UpdateForumActionRequest'; return extend(this, options); }, /******************************************************************************* * UpdateForumDiscussionActionRequest [IRequest] * Creates or updates a forum Discussion. * Remarks:
* Note that to update a single field you must first request the existing object and echo the current * state back on the update request, changing only the fields you want to update. Properties not set on the action request will clear existing values. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link BaseKeyTypeNotSupportedAn action was attempted against a content item that does not allow that action.
@link ValueNullOrMissingA required parameter was not specified.

* * * * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.
@link MembershipTierBelowThresholdThe user does not have permission in a given CommunityGroup to perform the request.
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * Properties: * Key * Title * Body * IsQuestion * IsPoll * returns: * ActionResponse *******************************************************************************/ UpdateForumDiscussionActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Forums.UpdateForumDiscussionActionRequest'; return extend(this, options); }, /******************************************************************************* * UpdateForumPostActionRequest [IRequest] * Creates or updates a forum Post. * Remarks:
* Note that to update a single field you must first request the existing object and echo the current * state back on the update request, changing only the fields you want to update. Properties not set on the action request will clear existing values. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link BaseKeyTypeNotSupportedAn action was attempted against a content item that does not allow that action.
@link ValueNullOrMissingA required parameter was not specified.

* * * * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.
@link MembershipTierBelowThresholdThe user does not have permission in a given CommunityGroup to perform the request.
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * Properties: * Key * Title * Body * IsQuestion * returns: * ActionResponse *******************************************************************************/ UpdateForumPostActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Forums.UpdateForumPostActionRequest'; return extend(this, options); }, /******************************************************************************* * UserGroupForumsPageRequest [IRequest] * Retrieves member-only forums a user belongs to. Does not relate to CommunityGroups. * Remarks:
* In this context, "group" refers to the Forums module (not CommunityGroups). Forums can be set up so that they require membership. Only members can contribute. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * UserKey * ItemsPerPage * OneBasedOnPage * returns: * UserGroupForumsPageResponse *******************************************************************************/ UserGroupForumsPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Forums.UserGroupForumsPageRequest'; return extend(this, options); }, /******************************************************************************* * AddFeedReactionActionRequest [IRequest] * Posts a comment-like reaction to an item of activity on your own or a friend's wall. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * ActivityKey * Body * returns: * ActionResponse *******************************************************************************/ AddFeedReactionActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.FriendFeed.AddFeedReactionActionRequest'; return extend(this, options); }, /******************************************************************************* * AddWallPostActionRequest [IRequest] * Adds a wall post. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * UserKey * Body * returns: * ActionResponse *******************************************************************************/ AddWallPostActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.FriendFeed.AddWallPostActionRequest'; return extend(this, options); }, /******************************************************************************* * UpdateUserStatusActionRequest [IRequest] * Update the user's status. * Remarks:
* Status is similar to Facebook's What's On Your Mind input. Displayed in the Pluck 4 widget. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * UserKey * Status * returns: * ActionResponse *******************************************************************************/ UpdateUserStatusActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.FriendFeed.UpdateUserStatusActionRequest'; return extend(this, options); }, /******************************************************************************* * FriendFeedPageRequest [IRequest] * Retrieves a page of content items that were contributed by the specified user's friends. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * *
Execution Exception CodesDescription
@link ValueOutOfRangeA parameter exceeds its range of valid values.

* * Properties: * UserKey * ItemsPerPage * OneBasedOnPage * IncludeTypes * IncludeReactions * returns: * FriendFeedPageResponse *******************************************************************************/ FriendFeedPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.FriendFeed.FriendFeedPageRequest'; return extend(this, options); }, /******************************************************************************* * DeleteFeedReactionActionRequest [IRequest] * Deletes a reaction to a user's wall item. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * ActivityKey * ReactionId * returns: * ActionResponse *******************************************************************************/ DeleteFeedReactionActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.FriendFeed.DeleteFeedReactionActionRequest'; return extend(this, options); }, /******************************************************************************* * DeleteWallPostActionRequest [IRequest] * Deletes a wall post. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * ActivityKey * returns: * ActionResponse *******************************************************************************/ DeleteWallPostActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.FriendFeed.DeleteWallPostActionRequest'; return extend(this, options); }, /******************************************************************************* * UserFeedPageRequest [IRequest] * Retrieves a user's recent activity stream. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * *
Execution Exception CodesDescription
@link ValueOutOfRangeA parameter exceeds its range of valid values.

* * Properties: * UserKey * ItemsPerPage * OneBasedOnPage * IncludeTypes * IncludeReactions * returns: * UserFeedPageResponse *******************************************************************************/ UserFeedPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.FriendFeed.UserFeedPageRequest'; return extend(this, options); }, /******************************************************************************* * ImageRequest [IRequest] * Retrieves URLs for an image corresponding to an avatar or photo, based on the image's ID. * Remarks:
* Image IDs come from other objects such as Photo. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * ImageId * returns: * Image *******************************************************************************/ ImageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Media.ImageRequest'; return extend(this, options); }, /******************************************************************************* * GalleryRequest [IRequest] * Retrieves metadata about a photo or video gallery. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * GalleryKey * returns: * GalleryResponse *******************************************************************************/ GalleryRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Media.GalleryRequest'; return extend(this, options); }, /******************************************************************************* * PhotosPageRequest [IRequest] * Request a page of Photos. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * GalleryKey * ItemsPerPage * SortType * OneBasedOnPage * returns: * PhotosPageResponse *******************************************************************************/ PhotosPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Media.PhotosPageRequest'; return extend(this, options); }, /******************************************************************************* * PhotoRequest [IRequest] * Retrieves a Photo. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * PhotoKey * returns: * Photo *******************************************************************************/ PhotoRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Media.PhotoRequest'; return extend(this, options); }, /******************************************************************************* * PublicGalleriesPageRequest [IRequest] * Retrieves a page of PublicGalleries, which contain metadata about a media gallery. * * When executing this request, the following exceptions may be encountered. * Properties: * MediaType * ItemsPerPage * OneBasedOnPage * returns: * PublicGalleriesPageResponse *******************************************************************************/ PublicGalleriesPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Media.PublicGalleriesPageRequest'; return extend(this, options); }, /******************************************************************************* * RecentPublicGalleriesPageRequest [IRequest] * Retrieves a page of public galleries the user has recently submitted photos to. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * UserKey * ItemsPerPage * OneBasedOnPage * returns: * RecentPublicGalleriesPageResponse *******************************************************************************/ RecentPublicGalleriesPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Media.RecentPublicGalleriesPageRequest'; return extend(this, options); }, /******************************************************************************* * RecentUserPhotosPageRequest [IRequest] * Retrieves a page of photos recently uploaded by the specified user. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * UserKey * ItemsPerPage * OneBasedOnPage * returns: * RecentUserPhotosPageResponse *******************************************************************************/ RecentUserPhotosPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Media.RecentUserPhotosPageRequest'; return extend(this, options); }, /******************************************************************************* * RecentUserVideosPageRequest [IRequest] * Retrieves a page of videos recently uploaded by the specified user. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * UserKey * ItemsPerPage * OneBasedOnPage * returns: * RecentUserVideosPageResponse *******************************************************************************/ RecentUserVideosPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Media.RecentUserVideosPageRequest'; return extend(this, options); }, /******************************************************************************* * UpdateGalleryActionRequest [IRequest] * Updates the metadata on a photo or video gallery. * Remarks:
* Creates the gallery if it doesn't already exist. Note that to update a single field you must first request the existing object and echo the current * state back on the update request, changing only the fields you want to update. Properties not set on the action request will clear existing values. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link InvalidValueA property contained an invalid value.
@link ValueNullOrMissingA required parameter was not specified.

* * * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.
@link UserBannedFromGroupThe executing user has been banned from activity in the target CommunityGroup.

* * Properties: * GalleryKey * GalleryType * MediaType * Title * Description * Tags * Section * GalleryPromo * GalleryViewState * MemberSitesToLink * returns: * ActionResponse *******************************************************************************/ UpdateGalleryActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Media.UpdateGalleryActionRequest'; return extend(this, options); }, /******************************************************************************* * UpdatePhotoActionRequest [IRequest] * Updates metadata on a photo, such as its title. * Remarks:
* Note that to update a single field you must first request the existing object and echo the current * state back on the update request, changing only the fields you want to update. Properties not set on the action request will clear existing values. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.
@link MembershipTierBelowThresholdThe user does not have permission in a given CommunityGroup to perform the request.
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * Properties: * PhotoKey * Title * Description * Tags * Section * returns: * ActionResponse *******************************************************************************/ UpdatePhotoActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Media.UpdatePhotoActionRequest'; return extend(this, options); }, /******************************************************************************* * UpdateVideoActionRequest [IRequest] * Updates metadata on a video, such as its title. * Remarks:
* Note that to update a single field you must first request the existing object and echo the current * state back on the update request, changing only the fields you want to update. Properties not set on the action request will clear existing values. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.
@link MembershipTierBelowThresholdThe user does not have permission in a given CommunityGroup to perform the request.
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * Properties: * VideoKey * Title * Description * Tags * Section * returns: * ActionResponse *******************************************************************************/ UpdateVideoActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Media.UpdateVideoActionRequest'; return extend(this, options); }, /******************************************************************************* * UserGalleriesPageRequest [IRequest] * Retrieves a user's galleries. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * UserKey * MediaType * ItemsPerPage * OneBasedOnPage * returns: * UserGalleriesPageResponse *******************************************************************************/ UserGalleriesPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Media.UserGalleriesPageRequest'; return extend(this, options); }, /******************************************************************************* * UserMediaSubmissionsCountPageRequest [IRequest] * Retrieves a user's photo or video submission counts. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * UserKey * MediaType * ItemsPerPage * OneBasedOnPage * returns: * UserMediaSubmissionsCountPageResponse *******************************************************************************/ UserMediaSubmissionsCountPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Media.UserMediaSubmissionsCountPageRequest'; return extend(this, options); }, /******************************************************************************* * VideosPageRequest [IRequest] * Retrieves a page of videos from a specific gallery. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * GalleryKey * ItemsPerPage * SortType * OneBasedOnPage * returns: * VideosPageResponse *******************************************************************************/ VideosPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Media.VideosPageRequest'; return extend(this, options); }, /******************************************************************************* * VideoRequest [IRequest] * Retrieves metadata for a video, including the URL used for playback. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * VideoKey * returns: * VideoResponse *******************************************************************************/ VideoRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Media.VideoRequest'; return extend(this, options); }, /******************************************************************************* * AssignUserToModerationQueueActionRequest [IRequest] * Assigns a user to a moderation queue. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link AnonymousNotSupportedThe user isn't authenticated and the action isn't allowed for anonymous users.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * *
Execution Exception CodesDescription
@link UnhandledExceptionAn unexpected error occurred in the request.

* * Properties: * ModeratorKey * QueueId * returns: * ActionResponse *******************************************************************************/ AssignUserToModerationQueueActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.AssignUserToModerationQueueActionRequest'; return extend(this, options); }, /******************************************************************************* * FlagModerationItemActionRequest [IRequest] * Flags an item in a moderation queue for further review. * Remarks:
* Only used for administrative purposes. Does not delete or block content. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * ModerationItemKey * Reason * FlaggedRoute * returns: * ActionResponse *******************************************************************************/ FlagModerationItemActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.FlagModerationItemActionRequest'; return extend(this, options); }, /******************************************************************************* * ModerationItemsPageRequest [IRequest] * Retrieves a paginated list of items awaiting moderation. * * When executing this request, the following exceptions may be encountered. * * * * * *
Validation Exception CodesDescription
@link InvalidValueA property contained an invalid value.
@link ValueNullOrMissingA required parameter was not specified.
@link ValueOutOfRangeA parameter exceeds its range of valid values.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * *
Execution Exception CodesDescription
@link ValueOutOfRangeA parameter exceeds its range of valid values.

* * Properties: * QueueId * SortOrder * ItemsPerPage * OneBasedOnPage * IncludeLockedItems * LockFetchedItems * returns: * ModerationItemsPageResponse *******************************************************************************/ ModerationItemsPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.ModerationItemsPageRequest'; return extend(this, options); }, /******************************************************************************* * ModeratorsRequest [IRequest] * Retrieves a list of queues and their assigned moderators. * * When executing this request, the following exceptions may be encountered. * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * *
Execution Exception CodesDescription
@link UnhandledExceptionAn unexpected error occurred in the request.

* * Properties: * returns: * ModeratorsResponse *******************************************************************************/ ModeratorsRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.ModeratorsRequest'; return extend(this, options); }, /******************************************************************************* * ReloadModerationQueuesActionRequest [IRequest] * Reloads the moderation queues. * * When executing this request, the following exceptions may be encountered. * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * *
Execution Exception CodesDescription
@link UnhandledExceptionAn unexpected error occurred in the request.

* * Properties: * returns: * ActionResponse *******************************************************************************/ ReloadModerationQueuesActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.ReloadModerationQueuesActionRequest'; return extend(this, options); }, /******************************************************************************* * UnassignUserFromModerationQueueActionRequest [IRequest] * Revokes the specified User's access to a given moderation queue. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * *
Execution Exception CodesDescription
@link UnhandledExceptionAn unexpected error occurred in the request.

* * Properties: * ModeratorKey * QueueId * returns: * ActionResponse *******************************************************************************/ UnassignUserFromModerationQueueActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.UnassignUserFromModerationQueueActionRequest'; return extend(this, options); }, /******************************************************************************* * DeleteModerationQueueActionRequest [IRequest] * Deletes a moderation queue. The executing user must be an editor. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * *
Execution Exception CodesDescription
@link UnhandledExceptionAn unexpected error occurred in the request.

* * Properties: * QueueId * returns: * ActionResponse *******************************************************************************/ DeleteModerationQueueActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.DeleteModerationQueueActionRequest'; return extend(this, options); }, /******************************************************************************* * ModerateItemActionRequest [IRequest] * Sets whether an item in a moderation queue is accepted or rejected. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * ModerationItemKey * Accepted * ModeratorsComment * returns: * ActionResponse *******************************************************************************/ ModerateItemActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.ModerateItemActionRequest'; return extend(this, options); }, /******************************************************************************* * ModerationItemRequest [IRequest] * Retrieves an item waiting to be moderated. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * *
Execution Exception CodesDescription
@link InvalidValueA property contained an invalid value.

* * Properties: * QueueId * returns: * ModerationItemResponse *******************************************************************************/ ModerationItemRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.ModerationItemRequest'; return extend(this, options); }, /******************************************************************************* * ModerationQueuesRequest [IRequest] * Retrieves a set of ModerationQueues, which contain metadata about the queue as it appears in the moderation manager. * * When executing this request, the following exceptions may be encountered. * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * ModeratorKey * IncludeLockedItemsInCount * GetModerators * returns: * ModerationQueuesResponse *******************************************************************************/ ModerationQueuesRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.ModerationQueuesRequest'; return extend(this, options); }, /******************************************************************************* * UpdateModerationQueueActionRequest [IRequest] * Changes the Queue's configuration. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.
@link ValueOutOfRangeA parameter exceeds its range of valid values.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * * *
Execution Exception CodesDescription
@link InvalidValueA property contained an invalid value.
@link UnhandledExceptionAn unexpected error occurred in the request.

* * Properties: * Configuration * returns: * ActionResponse *******************************************************************************/ UpdateModerationQueueActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.UpdateModerationQueueActionRequest'; return extend(this, options); }, /******************************************************************************* * UpdateModeratorEditAbilityActionRequest [IRequest] * Add or remove ability to edit content from desginated moderator. * * When executing this request, the following exceptions may be encountered. * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * UserKey * CanEditModerationContent * returns: * ActionResponse *******************************************************************************/ UpdateModeratorEditAbilityActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.UpdateModeratorEditAbilityActionRequest'; return extend(this, options); }, /******************************************************************************* * UpdateQueuePrioritiesActionRequest [IRequest] * Allows the caller to set the priority of multiple moderation queues at once. * Remarks:
* Intentionally removes gaps in priority and handles duplicate priorities to ensure that all queue priorities are consecutive. * * When executing this request, the following exceptions may be encountered. * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * QueuePriorities * returns: * ActionResponse *******************************************************************************/ UpdateQueuePrioritiesActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Moderation.UpdateQueuePrioritiesActionRequest'; return extend(this, options); }, /******************************************************************************* * AwardPointsActionRequest [IRequest] * Awards points of a given currency defined in the CMW. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * UserKey * Points * CurrencyType * returns: * ActionResponse *******************************************************************************/ AwardPointsActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.PointsAndBadging.AwardPointsActionRequest'; return extend(this, options); }, /******************************************************************************* * BadgeFamiliesRequest [IRequest] * Retrieves all badge families defined in the CMW. * Remarks:
* Retrieves assigned and earned badges. * * When executing this request, the following exceptions may be encountered. * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * returns: * BadgeFamiliesResponse *******************************************************************************/ BadgeFamiliesRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.PointsAndBadging.BadgeFamiliesRequest'; return extend(this, options); }, /******************************************************************************* * BadgeFamilyRequest [IRequest] * Retrieves a badge family. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * BadgeFamilyKey * returns: * BadgeFamilyResponse *******************************************************************************/ BadgeFamilyRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.PointsAndBadging.BadgeFamilyRequest'; return extend(this, options); }, /******************************************************************************* * BadgingEventActionRequest [IRequest] * Triggers a custom event as defined in the CMW. Allows point to accrue and badges to be granted for non-Pluck actions, according to the rules in the CMW. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * ActivityName * ActivityTags * UserTags * returns: * ActionResponse *******************************************************************************/ BadgingEventActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.PointsAndBadging.BadgingEventActionRequest'; return extend(this, options); }, /******************************************************************************* * GrantBadgeActionRequest [IRequest] * Grants an assigned badge. The executing user must be an editor. * Remarks:
* Editors must set up assigned badges in the CMW. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * *
Execution Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.

* * Properties: * UserKey * BadgeFamilyKey * BadgeKey * returns: * ActionResponse *******************************************************************************/ GrantBadgeActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.PointsAndBadging.GrantBadgeActionRequest'; return extend(this, options); }, /******************************************************************************* * LeaderboardRankingsPageRequest [IRequest] * Retrieves a page of Leaderboard rankings. * Remarks:
* If OneBasedOnPage is set to zero, you get an empty response for page zero. This happens because the leaderboard results are generated by a scheduled task and saved to disk on a periodic basis. The LeaderboardRankingsPageRequest checks whether the results are on disk and tou get an empty response since the scheduled task never generates a result for page zero. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * LeaderboardKey * OneBasedOnPage * returns: * LeaderboardRankingsPageResponse *******************************************************************************/ LeaderboardRankingsPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.PointsAndBadging.LeaderboardRankingsPageRequest'; return extend(this, options); }, /******************************************************************************* * LeaderboardRequest [IRequest] * Retrieves metadata about a leaderboard. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * LeaderboardKey * returns: * LeaderboardResponse *******************************************************************************/ LeaderboardRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.PointsAndBadging.LeaderboardRequest'; return extend(this, options); }, /******************************************************************************* * PointsAndBadgingRuleValidationRequest [IRequest] * Checks the validity of rules for a leaderboard or earned badge. * Remarks:
* Rules are written using the Pluck Rewards Grammar. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * @see Pluck Rewards Grammar * Properties: * Rules * returns: * PointsAndBadgingRuleValidationResponse *******************************************************************************/ PointsAndBadgingRuleValidationRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.PointsAndBadging.PointsAndBadgingRuleValidationRequest'; return extend(this, options); }, /******************************************************************************* * RevokeBadgeActionRequest [IRequest] * Revokes a badge. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * *
Execution Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.

* * Properties: * UserKey * BadgeFamilyKey * BadgeKey * returns: * ActionResponse *******************************************************************************/ RevokeBadgeActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.PointsAndBadging.RevokeBadgeActionRequest'; return extend(this, options); }, /******************************************************************************* * PollsPageRequest [IRequest] * Retrieves a page of Polls. * * When executing this request, the following exceptions may be encountered. * * * * * *
Validation Exception CodesDescription
@link BaseKeyTypeNotSupportedAn action was attempted against a content item that does not allow that action.
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * Properties: * PollOnKey * ItemsPerPage * SortType * OneBasedOnPage * returns: * PollsPageResponse *******************************************************************************/ PollsPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Polls.PollsPageRequest'; return extend(this, options); }, /******************************************************************************* * PollRequest [IRequest] * Retrieves a Poll. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * PollKey * returns: * PollResponse *******************************************************************************/ PollRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Polls.PollRequest'; return extend(this, options); }, /******************************************************************************* * PostPollAnswerActionRequest [IRequest] * Records an answer to a poll question. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link InvalidValueA property contained an invalid value.
@link ValueNullOrMissingA required parameter was not specified.

* * * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * Properties: * PollKey * IndexOfAnswer * returns: * ActionResponse *******************************************************************************/ PostPollAnswerActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Polls.PostPollAnswerActionRequest'; return extend(this, options); }, /******************************************************************************* * TogglePollIsClosedActionRequest [IRequest] * Toggles a poll between open and closed states. Users cannot respond to closed polls. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.
@link UserBannedFromGroupThe executing user has been banned from activity in the target CommunityGroup.

* * Properties: * PollKey * returns: * ActionResponse *******************************************************************************/ TogglePollIsClosedActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Polls.TogglePollIsClosedActionRequest'; return extend(this, options); }, /******************************************************************************* * UpdatePollActionRequest [IRequest] * Creates a poll or changes its text and options. * Remarks:
* Note that to update a single field you must first request the existing object and echo the current * state back on the update request, changing only the fields you want to update. Properties not set on the action request will clear existing values. * * When executing this request, the following exceptions may be encountered. * * * * * *
Validation Exception CodesDescription
@link BaseKeyTypeNotSupportedAn action was attempted against a content item that does not allow that action.
@link InvalidValueA property contained an invalid value.
@link ValueNullOrMissingA required parameter was not specified.

* * * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.
@link UserBannedFromGroupThe executing user has been banned from activity in the target CommunityGroup.

* * Properties: * PollOnKey * Question * Answers * returns: * ActionResponse *******************************************************************************/ UpdatePollActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Polls.UpdatePollActionRequest'; return extend(this, options); }, /******************************************************************************* * DeletePrivateMessageActionRequest [IRequest] * Deletes a private message. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * SourceFolderID * MessageList * returns: * ActionResponse *******************************************************************************/ DeletePrivateMessageActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.PrivateMessaging.DeletePrivateMessageActionRequest'; return extend(this, options); }, /******************************************************************************* * EmptyPrivateMessageTrashActionRequest [IRequest] * Deletes the executing user's private message trash folder. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * returns: * ActionResponse *******************************************************************************/ EmptyPrivateMessageTrashActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.PrivateMessaging.EmptyPrivateMessageTrashActionRequest'; return extend(this, options); }, /******************************************************************************* * PrivateMessageFolderListRequest [IRequest] * Retrieves metadata about the private messaging system's private message folders. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * returns: * PrivateMessageFolderListResponse *******************************************************************************/ PrivateMessageFolderListRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.PrivateMessaging.PrivateMessageFolderListRequest'; return extend(this, options); }, /******************************************************************************* * MovePrivateMessageActionRequest [IRequest] * Moves a private message from one folder to another. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * SourceFolderID * DestinationFolderID * MessageList * returns: * ActionResponse *******************************************************************************/ MovePrivateMessageActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.PrivateMessaging.MovePrivateMessageActionRequest'; return extend(this, options); }, /******************************************************************************* * PrivateMessagesPageRequest [IRequest] * Retrieves a page of private messages. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * FolderID * MessageReadState * ItemsPerPage * OneBasedOnPage * returns: * PrivateMessagesPageResponse *******************************************************************************/ PrivateMessagesPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.PrivateMessaging.PrivateMessagesPageRequest'; return extend(this, options); }, /******************************************************************************* * PrivateMessageRequest [IRequest] * Retrieves a private message. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * FolderID * MessageID * returns: * PrivateMessageResponse *******************************************************************************/ PrivateMessageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.PrivateMessaging.PrivateMessageRequest'; return extend(this, options); }, /******************************************************************************* * SendPrivateMessageActionRequest [IRequest] * Send a private message from the executing user to one or more other users. * * When executing this request, the following exceptions may be encountered. * * * * * *
Validation Exception CodesDescription
@link InvalidValueA property contained an invalid value.
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * *
Execution Exception CodesDescription
@link DirtyWordFilterTriggeredOne or more words in the content submitted appear on the list of stop words configured in the CMW.

* * Properties: * RecipientList * Subject * Body * ForModeration * returns: * ActionResponse *******************************************************************************/ SendPrivateMessageActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.PrivateMessaging.SendPrivateMessageActionRequest'; return extend(this, options); }, /******************************************************************************* * CommentActionRequest [IRequest] * Creates a comment. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.
@link ValueNullOrMissingA required parameter was not specified.

* * * * * *
Authentication Exception CodesDescription
@link FloodControlTriggeredThe user submission occurred within time limit configured on your server.
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * Properties: * CommentedOnKey * OnPageUrl * OnPageTitle * Body * InResponseTo * Section * Categories * Tags * returns: * ActionResponse *******************************************************************************/ CommentActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.CommentActionRequest'; return extend(this, options); }, /******************************************************************************* * CommentsPageRequest [IRequest] * Retrieves a page of Comments. * * When executing this request, the following exceptions may be encountered. * * * * * *
Validation Exception CodesDescription
@link BaseKeyTypeNotSupportedAn action was attempted against a content item that does not allow that action.
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * Properties: * CommentedOnKey * FindCommentKey * ItemsPerPage * SortType * OneBasedOnPage * FilterType * GetScores * returns: * CommentsPageResponse *******************************************************************************/ CommentsPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.CommentsPageRequest'; return extend(this, options); }, /******************************************************************************* * CommentRequest [IRequest] * Retrieves a single comment. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * CommentKey * returns: * CommentResponse *******************************************************************************/ CommentRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.CommentRequest'; return extend(this, options); }, /******************************************************************************* * EditCommentActionRequest [IRequest] * Edits a comment. * Remarks:
* This can only be used by a moderator. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * CommentKey * Body * returns: * ActionResponse *******************************************************************************/ EditCommentActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.EditCommentActionRequest'; return extend(this, options); }, /******************************************************************************* * PendingCommentsPageRequest [IRequest] * Retrieves a page of comments pending approval by the author of a blog post. * * When executing this request, the following exceptions may be encountered. * * * * * *
Validation Exception CodesDescription
@link BaseKeyTypeNotSupportedAn action was attempted against a content item that does not allow that action.
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * Properties: * CommentedOnKey * ItemsPerPage * OneBasedOnPage * SortType * returns: * CommentsPageResponse *******************************************************************************/ PendingCommentsPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.PendingCommentsPageRequest'; return extend(this, options); }, /******************************************************************************* * RateActionRequest [IRequest] * Assigns an integer value to a content item indicating the user's assessment. Used in discovery. * Remarks:
* "Ratings" are distinct from "review ratings" and "attribute ratings" (which apply to the Reviews module). They are also distinct from Scores. The Ratings widget displays a choice of 1-5 stars, with 1 indicating low sentiment. Aggregate ratings are stored against the item, and content can be discovered based on rating activity. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link BaseKeyTypeNotSupportedAn action was attempted against a content item that does not allow that action.
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * RateOnKey * Rating * MultiRating * returns: * ActionResponse *******************************************************************************/ RateActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.RateActionRequest'; return extend(this, options); }, /******************************************************************************* * RecommendActionRequest [IRequest] * Recommends a content item. Used in discovery. * Remarks:
* Recommendations are simply "true or null" inputs of user sentiment about a piece of content. The widget displays a "thumbs-up" icon. Aggregate recommendations are stored against the item, and content can be discovered based on recommendation activity. * * When executing this request, the following exceptions may be encountered. * * * * * *
Validation Exception CodesDescription
@link AnonymousNotSupportedThe user isn't authenticated and the action isn't allowed for anonymous users.
@link BaseKeyTypeNotSupportedAn action was attempted against a content item that does not allow that action.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * Properties: * RecommendedKey * Title * returns: * ActionResponse *******************************************************************************/ RecommendActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.RecommendActionRequest'; return extend(this, options); }, /******************************************************************************* * ItemScoresRequest [IRequest] * Retrieves the scores for a list of items. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * TargetKeys * ParentKey * ScoreId * returns: * ItemScoresResponse *******************************************************************************/ ItemScoresRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.ItemScoresRequest'; return extend(this, options); }, /******************************************************************************* * AddReviewPhotoActionRequest [IRequest] * Adds a photo to a review. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * ReviewKey * Title * Description * ImageID * returns: * ActionResponse *******************************************************************************/ AddReviewPhotoActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.Reviews.AddReviewPhotoActionRequest'; return extend(this, options); }, /******************************************************************************* * ReviewsPageByDateRequest [IRequest] * Retrieves a paginated list of reviews for the specified date. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * StartDate * ItemsPerPage * SortType * OneBasedOnPage * FilterType * returns: * ReviewsPageByDateResponse *******************************************************************************/ ReviewsPageByDateRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.Reviews.ReviewsPageByDateRequest'; return extend(this, options); }, /******************************************************************************* * ReviewRatingAttributeRequest [IRequest] * Retrieves a ReviewRatingAttribute. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * ReviewRatingAttributeKey * returns: * ReviewRatingAttributeResponse *******************************************************************************/ ReviewRatingAttributeRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.Reviews.ReviewRatingAttributeRequest'; return extend(this, options); }, /******************************************************************************* * ReviewRatingAttributeSetRequest [IRequest] * Retrieves a ReviewRatingAttributeSet. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * ReviewRatingAttributeSetKey * returns: * ReviewRatingAttributeSetResponse *******************************************************************************/ ReviewRatingAttributeSetRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.Reviews.ReviewRatingAttributeSetRequest'; return extend(this, options); }, /******************************************************************************* * UpdateReviewVideoActionRequest [IRequest] * Updates metadata such as title for a video attached to a review. * Remarks:
* Note that to update a single field you must first request the existing object and echo the current * state back on the update request, changing only the fields you want to update. Properties not set on the action request will clear existing values. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * ReviewKey * Title * Description * VideoKey * returns: * ActionResponse *******************************************************************************/ UpdateReviewVideoActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.Reviews.UpdateReviewVideoActionRequest'; return extend(this, options); }, /******************************************************************************* * DeleteReviewVideoActionRequest [IRequest] * Deletes a specific video from a review. The executing user must be an admin or the author of the review. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * ReviewKey * VideoKey * returns: * ActionResponse *******************************************************************************/ DeleteReviewVideoActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.Reviews.DeleteReviewVideoActionRequest'; return extend(this, options); }, /******************************************************************************* * DeleteReviewPhotoActionRequest [IRequest] * Deletes a specific photo from a review. The executing user must be an editor or the author of the review. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * ReviewKey * PhotoKey * returns: * ActionResponse *******************************************************************************/ DeleteReviewPhotoActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.Reviews.DeleteReviewPhotoActionRequest'; return extend(this, options); }, /******************************************************************************* * UpdateReviewPhotoActionRequest [IRequest] * Updates metadata such as title for a photo attached to a review. * Remarks:
* Note that to update a single field you must first request the existing object and echo the current * state back on the update request, changing only the fields you want to update. Properties not set on the action request will clear existing values. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * ReviewKey * Title * Description * PhotoKey * returns: * ActionResponse *******************************************************************************/ UpdateReviewPhotoActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.Reviews.UpdateReviewPhotoActionRequest'; return extend(this, options); }, /******************************************************************************* * ReviewCategoryRollupRequest [IRequest] * Retrieves a rollup of reviews for specified categories. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * Categories * returns: * ReviewCategoryRollupResponse *******************************************************************************/ ReviewCategoryRollupRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.Reviews.ReviewCategoryRollupRequest'; return extend(this, options); }, /******************************************************************************* * RecentReviewsByCategoryRequest [IRequest] * Retrieves the most recently submitted reviews in a single discovery category. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * Category * ItemsPerPage * returns: * RecentReviewsByCategoryResponse *******************************************************************************/ RecentReviewsByCategoryRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.Reviews.RecentReviewsByCategoryRequest'; return extend(this, options); }, /******************************************************************************* * MostHelpfulReviewsRequest [IRequest] * Retrieves the Reviews with the most favorable ratings. * Remarks:
* Gets the reviews considered most helpful calculated based on positively recommended reviews combined with preference settings indicating threshold, inclusion of negative reviews and maximum rating. You can specify a threshold and whether you want thumb up or down reviews. The defaults are 5 and thumbs up. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * ReviewedKey * ItemsPerPage * returns: * MostHelpfulReviewsResponse *******************************************************************************/ MostHelpfulReviewsRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.Reviews.MostHelpfulReviewsRequest'; return extend(this, options); }, /******************************************************************************* * DeleteReviewRatingAttributeActionRequest [IRequest] * Deletes an Attribute for a specific Review. Only editors or admins can execute this request. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * *
Execution Exception CodesDescription
@link UnhandledExceptionAn unexpected error occurred in the request.

* * Properties: * Key * returns: * ActionResponse *******************************************************************************/ DeleteReviewRatingAttributeActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.Reviews.DeleteReviewRatingAttributeActionRequest'; return extend(this, options); }, /******************************************************************************* * DeleteReviewRatingAttributeSetActionRequest [IRequest] * Delete an AttributeSet for a specific Review. Only editors or admins can execute this request. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * *
Execution Exception CodesDescription
@link UnhandledExceptionAn unexpected error occurred in the request.

* * Properties: * Key * returns: * ActionResponse *******************************************************************************/ DeleteReviewRatingAttributeSetActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.Reviews.DeleteReviewRatingAttributeSetActionRequest'; return extend(this, options); }, /******************************************************************************* * ReviewActionRequest [IRequest] * Creates or updates a review. * Remarks:
* Null fields are erased on update. Attributes are case-sensitive. * * When executing this request, the following exceptions may be encountered. * * * * * *
Validation Exception CodesDescription
@link InvalidValueA property contained an invalid value.
@link ValueNullOrMissingA required parameter was not specified.
@link ValueOutOfRangeA parameter exceeds its range of valid values.

* * * * * *
Authentication Exception CodesDescription
@link DuplicateSubmissionOne or more values in a request group are duplicates, or the user is submitting a second Review on a given Article and Pluck is not configured to allow multiple reviews from the same user.
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * ReviewedKey * OnPageUrl * OnPageTitle * ReviewTitle * ReviewRating * ReviewBody * ReviewPros * ReviewCons * ReviewKey * ReviewPhotoKeys * ReviewVideoKeys * AttributeRatings * ReviewIsRecommended * Section * Categories * ReviewRatingAttributeSetKey * returns: * ActionResponse *******************************************************************************/ ReviewActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.Reviews.ReviewActionRequest'; return extend(this, options); }, /******************************************************************************* * ReviewRatingAttributeSetsPageRequest [IRequest] * Retrieves a paginated list of all review attribute sets sorted alphabetically by name. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueOutOfRangeA parameter exceeds its range of valid values.

* * Properties: * ItemsPerPage * OneBasedOnPage * State * returns: * ReviewRatingAttributeSetsPageResponse *******************************************************************************/ ReviewRatingAttributeSetsPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.Reviews.ReviewRatingAttributeSetsPageRequest'; return extend(this, options); }, /******************************************************************************* * ReviewRatingAttributesPageRequest [IRequest] * Retrieves a paginated list of all review attributes sorted alphabetically by name. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueOutOfRangeA parameter exceeds its range of valid values.

* * Properties: * ItemsPerPage * OneBasedOnPage * returns: * ReviewRatingAttributesPageResponse *******************************************************************************/ ReviewRatingAttributesPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.Reviews.ReviewRatingAttributesPageRequest'; return extend(this, options); }, /******************************************************************************* * ReviewRequest [IRequest] * Retrieves the specified review. Does not return pending and deleted reviews. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * ReviewKey * returns: * ReviewResponse *******************************************************************************/ ReviewRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.Reviews.ReviewRequest'; return extend(this, options); }, /******************************************************************************* * ReviewRollupRequest [IRequest] * Retrieves aggregated data of all reviews for the reviewed item requested. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * ReviewedKey * returns: * ReviewRollupResponse *******************************************************************************/ ReviewRollupRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.Reviews.ReviewRollupRequest'; return extend(this, options); }, /******************************************************************************* * ReviewsPageRequest [IRequest] * Retrieves a page of reviews for a specified content items. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * ReviewedKey * ItemsPerPage * SortType * OneBasedOnPage * FindReviewKey * FilterType * returns: * ReviewsPageResponse *******************************************************************************/ ReviewsPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.Reviews.ReviewsPageRequest'; return extend(this, options); }, /******************************************************************************* * SetFeaturedReviewActionRequest [IRequest] * Marks a specific review as featured. * Remarks:
* Featured reviews appear above others in the list widget. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * *
Execution Exception CodesDescription
@link UnhandledExceptionAn unexpected error occurred in the request.

* * Properties: * ReviewKey * ReviewIsFeatured * returns: * ActionResponse *******************************************************************************/ SetFeaturedReviewActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.Reviews.SetFeaturedReviewActionRequest'; return extend(this, options); }, /******************************************************************************* * SetReviewRatingAttributeSetActionRequest [IRequest] * Sets the AttributeSet for an Article (ExternalResource). * Remarks:
* Each Article can only be assigned one AttributeSet. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * * * *
Execution Exception CodesDescription
@link DirtyWordFilterTriggeredOne or more words in the content submitted appear on the list of stop words configured in the CMW.
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.
@link UnhandledExceptionAn unexpected error occurred in the request.

* * Properties: * ReviewedKey * ReviewRatingAttributeSetKey * returns: * ActionResponse *******************************************************************************/ SetReviewRatingAttributeSetActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.Reviews.SetReviewRatingAttributeSetActionRequest'; return extend(this, options); }, /******************************************************************************* * TopRatedItemsByCategoryRequest [IRequest] * Retrieves a list of the top ten rated items in one specified Category. * Remarks:
* Items are listed from highest rated to lowest. When the items have the same rating, those items are listed from most recently updated to lowest. * The Title from the product along with the average rating will be displayed. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link UnhandledExceptionAn unexpected error occurred in the request.

* * Properties: * Category * ItemsPerPage * OneBasedOnPage * returns: * TopRatedItemsByCategoryResponse *******************************************************************************/ TopRatedItemsByCategoryRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.Reviews.TopRatedItemsByCategoryRequest'; return extend(this, options); }, /******************************************************************************* * UpdateReviewRatingAttributeActionRequest [IRequest] * Creates or updates a review rating attribute. * Remarks:
* Note that to update a single field you must first request the existing object and echo the current * state back on the update request, changing only the fields you want to update. Properties not set on the action request will clear existing values. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * *
Execution Exception CodesDescription
@link UnhandledExceptionAn unexpected error occurred in the request.

* * Properties: * Key * Name * Description * returns: * ActionResponse *******************************************************************************/ UpdateReviewRatingAttributeActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.Reviews.UpdateReviewRatingAttributeActionRequest'; return extend(this, options); }, /******************************************************************************* * UpdateReviewRatingAttributeSetActionRequest [IRequest] * Creates or updates the specified review rating set. * Remarks:
* Note that to update a single field you must first request the existing object and echo the current * state back on the update request, changing only the fields you want to update. Properties not set on the action request will clear existing values. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * *
Execution Exception CodesDescription
@link UnhandledExceptionAn unexpected error occurred in the request.

* * Properties: * Key * Name * Description * AttributeKeys * IsActive * Notes * returns: * ActionResponse *******************************************************************************/ UpdateReviewRatingAttributeSetActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.Reviews.UpdateReviewRatingAttributeSetActionRequest'; return extend(this, options); }, /******************************************************************************* * SetItemScoreActionRequest [IRequest] * Records the user's score on the specified ScoreId for a given content item. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.
@link ValueOutOfRangeA parameter exceeds its range of valid values.

* * * * *
Authentication Exception CodesDescription
@link UserTierBelowThresholdThe user does not have permission to perform the request.

* * Properties: * ScoreId * ParentKey * TargetKey * Score * returns: * ItemScoresResponse *******************************************************************************/ SetItemScoreActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.SetItemScoreActionRequest'; return extend(this, options); }, /******************************************************************************* * TagCommentRequest [IRequest] * Adds tag data to comments for use in filtering retrieved results. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link UserTierBelowThresholdThe user does not have permission to perform the request.

* * Properties: * ReplaceExistingTags * CommentKey * Tags * returns: * ActionResponse *******************************************************************************/ TagCommentRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Reactions.TagCommentRequest'; return extend(this, options); }, /******************************************************************************* * AuthenticateSlauthUserRequest [IRequest] * * When executing this request, the following exceptions may be encountered. * Properties: * Email * Password * returns: * UpdateSlauthUserActionResponse *******************************************************************************/ AuthenticateSlauthUserRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Slauth.AuthenticateSlauthUserRequest'; return extend(this, options); }, /******************************************************************************* * ChangeSlauthUserDisplayNameActionRequest [IRequest] * * When executing this request, the following exceptions may be encountered. * Properties: * UserKey * DisplayName * returns: * UpdateSlauthUserActionResponse *******************************************************************************/ ChangeSlauthUserDisplayNameActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Slauth.ChangeSlauthUserDisplayNameActionRequest'; return extend(this, options); }, /******************************************************************************* * ChangeSlauthUserEmailActionRequest [IRequest] * * When executing this request, the following exceptions may be encountered. * Properties: * UserKey * Email * returns: * UpdateSlauthUserActionResponse *******************************************************************************/ ChangeSlauthUserEmailActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Slauth.ChangeSlauthUserEmailActionRequest'; return extend(this, options); }, /******************************************************************************* * ChangeSlauthUserPasswordActionRequest [IRequest] * * When executing this request, the following exceptions may be encountered. * Properties: * OldPassword * NewPassword * UserKey * returns: * ActionResponse *******************************************************************************/ ChangeSlauthUserPasswordActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Slauth.ChangeSlauthUserPasswordActionRequest'; return extend(this, options); }, /******************************************************************************* * CreateSlauthUserActionRequest [IRequest] * * When executing this request, the following exceptions may be encountered. * Properties: * DisplayName * Password * Email * returns: * ActionResponse *******************************************************************************/ CreateSlauthUserActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Slauth.CreateSlauthUserActionRequest'; return extend(this, options); }, /******************************************************************************* * FindSlauthUserRequest [IRequest] * * When executing this request, the following exceptions may be encountered. * Properties: * UserKey * Email * DisplayName * returns: * UserResponse *******************************************************************************/ FindSlauthUserRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Slauth.FindSlauthUserRequest'; return extend(this, options); }, /******************************************************************************* * ResetSlauthUserPasswordActionRequest [IRequest] * * When executing this request, the following exceptions may be encountered. * Properties: * Email * returns: * ActionResponse *******************************************************************************/ ResetSlauthUserPasswordActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Slauth.ResetSlauthUserPasswordActionRequest'; return extend(this, options); }, /******************************************************************************* * LinkedInAccessTokenActionRequest [IRequest] * Retrieves a LinkedIn access token. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectPopulationErrorA requested content item (or the target of an action) exists, but could not be retrieved from the database.

* * Properties: * AuthToken * AuthVerifier * returns: * ActionResponse *******************************************************************************/ LinkedInAccessTokenActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Social.LinkedInAccessTokenActionRequest'; return extend(this, options); }, /******************************************************************************* * LinkedInAuthUrlRequest [IRequest] * Retrieves a LinkedIn authorization URL. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * UserKey * returns: * LinkedInAuthUrlResponse *******************************************************************************/ LinkedInAuthUrlRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Social.LinkedInAuthUrlRequest'; return extend(this, options); }, /******************************************************************************* * LinkedInProfileNameRequest [IRequest] * Retrieves a user's LinkedIn profile name. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * UserKey * returns: * LinkedInProfileNameResponse *******************************************************************************/ LinkedInProfileNameRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Social.LinkedInProfileNameRequest'; return extend(this, options); }, /******************************************************************************* * SendLinkedInMessageActionRequest [IRequest] * Sends a message to the executing user's LinkedIn feed. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * Message * Url * Template * returns: * ActionResponse *******************************************************************************/ SendLinkedInMessageActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Social.SendLinkedInMessageActionRequest'; return extend(this, options); }, /******************************************************************************* * SendTwitterMessageActionRequest [IRequest] * Sends a tweet as the executing user. * Remarks:
* If Url is provided, make sure the message allows the shortened URL to be added without exceeding the 140-character limit, else the tweet will be truncated. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * Message * Url * Template * returns: * ActionResponse *******************************************************************************/ SendTwitterMessageActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Social.SendTwitterMessageActionRequest'; return extend(this, options); }, /******************************************************************************* * TwitterAuthUrlRequest [IRequest] * Retrieves a Twitter authorization URL. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * UserKey * returns: * TwitterAuthUrlResponse *******************************************************************************/ TwitterAuthUrlRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Social.TwitterAuthUrlRequest'; return extend(this, options); }, /******************************************************************************* * TwitterLastTweetRequest [IRequest] * Retrieves a user's last tweet on Twitter. * Remarks:
* Valid if the user is connected to Twitter and allows their tweets to be retrieved. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * UserKey * returns: * TwitterLastTweetResponse *******************************************************************************/ TwitterLastTweetRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Social.TwitterLastTweetRequest'; return extend(this, options); }, /******************************************************************************* * TwitterScreenNameRequest [IRequest] * Retrieves a user's screen name on Twitter. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * UserKey * returns: * TwitterScreenNameResponse *******************************************************************************/ TwitterScreenNameRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Social.TwitterScreenNameRequest'; return extend(this, options); }, /******************************************************************************* * TrashAuditItemsPageRequest [IRequest] * Gets a page of items that have been deleted. * Remarks:
* Only returns trash one day at a time. * * When executing this request, the following exceptions may be encountered. * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * ForDate * ItemsPerPage * OneBasedOnPage * returns: * TrashAuditItemsPageResponse *******************************************************************************/ TrashAuditItemsPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.TrashAudit.TrashAuditItemsPageRequest'; return extend(this, options); }, /******************************************************************************* * AddEnemyActionRequest [IRequest] * Sets the specified user as an enemy (ignored user) of the executing user. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link AnonymousNotSupportedThe user isn't authenticated and the action isn't allowed for anonymous users.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * * *
Execution Exception CodesDescription
@link ActionProcessedInfoValid response information returned outside of the KeyAction structure. Currently used to return the friendship status from AddFriendActionRequest, and the enemy status from AddEnemyActionRequest.
@link NotSupportedThe request or operation is not supported by the system.

* * Properties: * EnemyUserKey * returns: * ActionResponse *******************************************************************************/ AddEnemyActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Users.AddEnemyActionRequest'; return extend(this, options); }, /******************************************************************************* * AddFriendActionRequest [IRequest] * Sets the specified user as a friend of the executing user. * Remarks:
* If Pluck's reciprocal friendship mode is enabled, the target user has to approve the action. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link AnonymousNotSupportedThe user isn't authenticated and the action isn't allowed for anonymous users.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * * *
Execution Exception CodesDescription
@link ActionProcessedInfoValid response information returned outside of the KeyAction structure. Currently used to return the friendship status from AddFriendActionRequest, and the enemy status from AddEnemyActionRequest.
@link NotSupportedThe request or operation is not supported by the system.

* * Properties: * FriendUserKey * returns: * ActionResponse *******************************************************************************/ AddFriendActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Users.AddFriendActionRequest'; return extend(this, options); }, /******************************************************************************* * AddPersonaMessageActionRequest [IRequest] * Adds a public Persona message. Deprecated: not displayed in the Pluck 4 widget. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * * * * *
Authentication Exception CodesDescription
@link FloodControlTriggeredThe user submission occurred within time limit configured on your server.
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * * * *
Execution Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.

* * Properties: * MessageToUserKey * Body * returns: * ActionResponse *******************************************************************************/ AddPersonaMessageActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Users.AddPersonaMessageActionRequest'; return extend(this, options); }, /******************************************************************************* * AddUserStatusActionRequest [IRequest] * Sets the user's status message, a user-specified value similar to Facebook's What's On Your Mind input. Displayed in the Persona widget. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * Status * returns: * ActionResponse *******************************************************************************/ AddUserStatusActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Users.AddUserStatusActionRequest'; return extend(this, options); }, /******************************************************************************* * AddWatchItemActionRequest [IRequest] * Adds a web page to the specified user's watch list. * Remarks:
* Watch list items are essentially bookmarks. (Deprecated: not displayed in Pluck 4 widgets.) * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link BaseKeyTypeNotSupportedAn action was attempted against a content item that does not allow that action.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link NoMembershipAccessToContentThe user is not a member of the CommunityGroup specified by the request.

* * Properties: * WatchOnKey * UserKey * returns: * ActionResponse *******************************************************************************/ AddWatchItemActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Users.AddWatchItemActionRequest'; return extend(this, options); }, /******************************************************************************* * ApproveFriendActionRequest [IRequest] * Approves or denies a pending friendship request. Applies when reciprocal friendship mode is enabled in the Pluck server configurations and the specified user has requested friendship. On approval, the specified user becomes a friend of the executing user. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link AnonymousNotSupportedThe user isn't authenticated and the action isn't allowed for anonymous users.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * FriendUserKey * IsApproved * returns: * ActionResponse *******************************************************************************/ ApproveFriendActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Users.ApproveFriendActionRequest'; return extend(this, options); }, /******************************************************************************* * FetchAvatarFromUrlActionRequest [IRequest] * Changes the user's avatar to the image at the specified URL. Executing user must be an admin or the target user. * Remarks:
* Pluck will retrieve the image and save it on the server, as if the user had explicitly uploaded it as their avatar. Therefore, the user's avatar URL will point to an image on the Pluck server. * * When executing this request, the following exceptions may be encountered. * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * UserKey * Url * returns: * ActionResponse *******************************************************************************/ FetchAvatarFromUrlActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Users.FetchAvatarFromUrlActionRequest'; return extend(this, options); }, /******************************************************************************* * UpdateUserExternalIdActionRequest [IRequest] * Adds or updates an item in a user's external ID list. * Remarks:
* The external ID list is used to associate the Pluck account with external services such as Twitter, but can also be used for any custom association you wish to track. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * UserKey * ExternalSiteName * ExternalSiteUserId * returns: * ActionResponse *******************************************************************************/ UpdateUserExternalIdActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Users.UpdateUserExternalIdActionRequest'; return extend(this, options); }, /******************************************************************************* * UpdateUserExtendedPrefActionRequest [IRequest] * Adds to or changes a user's custom-defined preferences. * Remarks:
* Extended Preferences include some system-set values but can also be used to track options you define. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * UserKey * Key * Value * returns: * ActionResponse *******************************************************************************/ UpdateUserExtendedPrefActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Users.UpdateUserExtendedPrefActionRequest'; return extend(this, options); }, /******************************************************************************* * FollowersPageRequest [IRequest] * Retrieves a page of users following the specified user. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * UserKey * ItemsPerPage * OneBasedOnPage * SortType * returns: * FollowersPageResponse *******************************************************************************/ FollowersPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Users.FollowersPageRequest'; return extend(this, options); }, /******************************************************************************* * UserByExternalSiteIdRequest [IRequest] * Retrieves a list of Users sorted by external site IDs. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.

* * Properties: * ExternalSiteName * ExternalSiteUserId * returns: * UserResponse *******************************************************************************/ UserByExternalSiteIdRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Users.UserByExternalSiteIdRequest'; return extend(this, options); }, /******************************************************************************* * UserExtendedPrefsRequest [IRequest] * Retrieves a user's extended preferences. * Remarks:
* Extended Preferences include some system-set values but can also be used to track options you define. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.
@link ObjectPopulationErrorA requested content item (or the target of an action) exists, but could not be retrieved from the database.

* * Properties: * UserKey * returns: * UserExtendedPrefsResponse *******************************************************************************/ UserExtendedPrefsRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Users.UserExtendedPrefsRequest'; return extend(this, options); }, /******************************************************************************* * DeleteWatchItemActionRequest [IRequest] * Deletes a WatchItem. * Remarks:
* Watch list items are essentially bookmarks. (Deprecated: not displayed in Pluck 4 widgets.) * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * WatchOnKey * UserKey * returns: * ActionResponse *******************************************************************************/ DeleteWatchItemActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Users.DeleteWatchItemActionRequest'; return extend(this, options); }, /******************************************************************************* * EnemiesPageRequest [IRequest] * Retrieves a page of enemies (users ignored by the specified user). * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * UserKey * ItemsPerPage * SortType * OneBasedOnPage * returns: * EnemiesPageResponse *******************************************************************************/ EnemiesPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Users.EnemiesPageRequest'; return extend(this, options); }, /******************************************************************************* * FriendsPageRequest [IRequest] * Retrieves a page of the specified user's friends. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * UserKey * IsPendingList * IsPendingByOthers * FilterKey * FilterValue * ItemsPerPage * OneBasedOnPage * SortType * returns: * FriendsPageResponse *******************************************************************************/ FriendsPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Users.FriendsPageRequest'; return extend(this, options); }, /******************************************************************************* * IsFriendRequest [IRequest] * Retrieves a user's friend state. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * UserKey * FriendUserKey * returns: * IsFriendResponse *******************************************************************************/ IsFriendRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Users.IsFriendRequest'; return extend(this, options); }, /******************************************************************************* * PersonaMessagesPageRequest [IRequest] * Retrieves a page of Persona public messages. Not displayed in the Pluck 4 widget. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * UserKey * ItemsPerPage * OneBasedOnPage * returns: * PersonaMessagesPageResponse *******************************************************************************/ PersonaMessagesPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Users.PersonaMessagesPageRequest'; return extend(this, options); }, /******************************************************************************* * RecentUserActivityRequest [IRequest] * Retrieves a user's recent activity. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * UserKey * returns: * RecentUserActivityResponse *******************************************************************************/ RecentUserActivityRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Users.RecentUserActivityRequest'; return extend(this, options); }, /******************************************************************************* * RemoveEnemyActionRequest [IRequest] * Removes the specified user from the executing user's enemy (ignored user) list. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link AnonymousNotSupportedThe user isn't authenticated and the action isn't allowed for anonymous users.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * EnemyUserKey * returns: * ActionResponse *******************************************************************************/ RemoveEnemyActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Users.RemoveEnemyActionRequest'; return extend(this, options); }, /******************************************************************************* * RemoveFriendActionRequest [IRequest] * Removes the specified user from the executing user's friend list. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link AnonymousNotSupportedThe user isn't authenticated and the action isn't allowed for anonymous users.
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * FriendUserKey * returns: * ActionResponse *******************************************************************************/ RemoveFriendActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Users.RemoveFriendActionRequest'; return extend(this, options); }, /******************************************************************************* * RemovePersonaMessageActionRequest [IRequest] * Deletes a Persona public message. Deprecated: not displayed in the Pluck 4 widget. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * MessageKey * returns: * ActionResponse *******************************************************************************/ RemovePersonaMessageActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Users.RemovePersonaMessageActionRequest'; return extend(this, options); }, /******************************************************************************* * UpdateSubscriptionActionRequest [IRequest] * Subscribes or unsubscribes the user to e-mails when a forum discussion has new posts. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * BaseKey * Subscribe * returns: * ActionResponse *******************************************************************************/ UpdateSubscriptionActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Users.UpdateSubscriptionActionRequest'; return extend(this, options); }, /******************************************************************************* * UpdateUserBozoSettingActionRequest [IRequest] * Blocks or unblocks a user. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * UserKey * IsBozod * returns: * ActionResponse *******************************************************************************/ UpdateUserBozoSettingActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Users.UpdateUserBozoSettingActionRequest'; return extend(this, options); }, /******************************************************************************* * UpdateUserProfileActionRequest [IRequest] * Updates a user's profile. * Remarks:
* Note that to update a single field you must first request the existing object (see UserRequest) and echo the current state back on the update request, changing only the fields you want to update. Properties not set on the action request will clear existing values. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * *
Authentication Exception CodesDescription
@link InvalidCredentialsThe user is not allowed to perform the requested operation.

* * Properties: * UserKey * AboutMe * Location * Signature * DateOfBirth * Sex * PersonaPrivacyMode * CommentsTabVisible * PhotosTabVisible * MessagesOpenToEveryone * IsEmailNotificationsEnabled * SelectedStyleId * CustomAnswers * ExtendedProfile * ImageId * IsBlocked * LastUpdated * returns: * ActionResponse *******************************************************************************/ UpdateUserProfileActionRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Users.UpdateUserProfileActionRequest'; return extend(this, options); }, /******************************************************************************* * UserCommentsPageRequest [IRequest] * Retrieves a page of contributions by a given user. Can be restricted to Comments. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * UserKey * CommentsOnly * ItemsPerPage * SortType * OneBasedOnPage * returns: * UserCommentsPageResponse *******************************************************************************/ UserCommentsPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Users.UserCommentsPageRequest'; return extend(this, options); }, /******************************************************************************* * UserRequest [IRequest] * Retrieves a User record (a collection of metadata about a user). * Remarks:
* To retrieve the executing user's information, pass the request without setting its Key property. For unauthenticated users, this will retrieve a "placeholder" User with the same structure. * * When executing this request, the following exceptions may be encountered. * * * *
Validation Exception CodesDescription
@link ValueNullOrMissingA required parameter was not specified.

* * * * * *
Execution Exception CodesDescription
@link ObjectNotFoundInStorageA requested content item (or the target of an action) does not exist in the database.
@link ObjectPopulationErrorA requested content item (or the target of an action) exists, but could not be retrieved from the database.

* * Properties: * UserKey * returns: * UserResponse *******************************************************************************/ UserRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Users.UserRequest'; return extend(this, options); }, /******************************************************************************* * UserReviewsPageRequest [IRequest] * Retrieves a page of reviews contributed by the specified user. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * UserKey * ItemsPerPage * SortType * OneBasedOnPage * returns: * UserReviewsPageResponse *******************************************************************************/ UserReviewsPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Users.UserReviewsPageRequest'; return extend(this, options); }, /******************************************************************************* * UserTagsRequest [IRequest] * Retrieves tags associated with the user's contributions. * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * UserKey * ContentType * returns: * UserTagsResponse *******************************************************************************/ UserTagsRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Users.UserTagsRequest'; return extend(this, options); }, /******************************************************************************* * WatchItemsPageRequest [IRequest] * Retrieves a page of WatchItems. * Remarks:
* Watch list items are essentially bookmarks. (Deprecated: not displayed in Pluck 4 widgets.) * * When executing this request, the following exceptions may be encountered. * * * * *
Validation Exception CodesDescription
@link NotSupportedThe request or operation is not supported by the system.
@link ValueNullOrMissingA required parameter was not specified.

* * Properties: * UserKey * ItemsPerPage * SortType * OneBasedOnPage * returns: * WatchItemsPageResponse *******************************************************************************/ WatchItemsPageRequest: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Requests.Users.WatchItemsPageRequest'; return extend(this, options); }, /******************************************************************************* * BlogsPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * BlogType * Items * TotalItems * ItemsPerPage * OneBasedOnPage * MemberSiteKeys * IsCachedResponse * ResponseStatus *******************************************************************************/ BlogsPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Blogs.BlogsPageResponse'; return extend(this, options); }, /******************************************************************************* * ExecApplicationActionResponse [IResponse] * Executes a Pluck 4 application request and returns the response. * Properties: * IsCachedResponse * Content * ResponseStatus *******************************************************************************/ ExecApplicationActionResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Applications.ExecApplicationActionResponse'; return extend(this, options); }, /******************************************************************************* * ContentPolicyTraceResponse [IResponse] * Current content policies in use for specified keyed object. * Properties: * TargetKey * UserTier * ActionType * Trace * IsCachedResponse * ResponseStatus *******************************************************************************/ ContentPolicyTraceResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Common.ContentPolicyTraceResponse'; return extend(this, options); }, /******************************************************************************* * DiscoveryContentPolicyTraceResponse [IResponse] * All content policies in use for specified discovery category. * Properties: * Section * Categories * UserTier * ActionType * Trace * IsCachedResponse * ResponseStatus *******************************************************************************/ DiscoveryContentPolicyTraceResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Common.DiscoveryContentPolicyTraceResponse'; return extend(this, options); }, /******************************************************************************* * ResolveSEOTokenResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * SEOToken * Item * OneBasedOnPage * ArchiveMonth * Tag * IsCachedResponse * ResponseStatus *******************************************************************************/ ResolveSEOTokenResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Common.ResolveSEOTokenResponse'; return extend(this, options); }, /******************************************************************************* * UserAccountSettingsResponse [IResponse] * Encapsulates preferences for login and logout URLs, etc. * Properties: * CookieName * LoginUrl * LogoutUrl * RegisterUrl * ForgotPasswordUrl * AccountSettingsUrl * IsCachedResponse * ResponseStatus *******************************************************************************/ UserAccountSettingsResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Common.UserAccountSettingsResponse'; return extend(this, options); }, /******************************************************************************* * UserTiersResponse [IResponse] * List of user tiers allowed by the current user in moderation. * Properties: * Tiers * IsCachedResponse * ResponseStatus *******************************************************************************/ UserTiersResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Common.UserTiersResponse'; return extend(this, options); }, /******************************************************************************* * MemberSitesResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * Sites * IsCachedResponse * ResponseStatus *******************************************************************************/ MemberSitesResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Common.MemberSitesResponse'; return extend(this, options); }, /******************************************************************************* * ShortenUrlResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * LongUrl * ShortUrl * IsCachedResponse * ResponseStatus *******************************************************************************/ ShortenUrlResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Common.ShortenUrlResponse'; return extend(this, options); }, /******************************************************************************* * CommunityGroupUserPrefsResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * CommunityGroupUserPrefs * IsCachedResponse * ResponseStatus *******************************************************************************/ CommunityGroupUserPrefsResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.CommunityGroups.CommunityGroupUserPrefsResponse'; return extend(this, options); }, /******************************************************************************* * RecentCommunityGroupActivitiesPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * CommunityGroupKey * ItemsPerPage * OneBasedOnPage * TotalItems * Items * MemberSiteKeys * IsCachedResponse * ResponseStatus *******************************************************************************/ RecentCommunityGroupActivitiesPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.CommunityGroups.RecentCommunityGroupActivitiesPageResponse'; return extend(this, options); }, /******************************************************************************* * BlogResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * Blog * IsCachedResponse * ResponseStatus *******************************************************************************/ BlogResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Blogs.BlogResponse'; return extend(this, options); }, /******************************************************************************* * BlogPostResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * BlogPost * IsCachedResponse * ResponseStatus *******************************************************************************/ BlogPostResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Blogs.BlogPostResponse'; return extend(this, options); }, /******************************************************************************* * BlogPostArchiveContentsPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * BlogKey * Month * Year * ItemsPerPage * OneBasedOnPage * SortType * TotalItems * Items * IsCachedResponse * ResponseStatus *******************************************************************************/ BlogPostArchiveContentsPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Blogs.BlogPostArchiveContentsPageResponse'; return extend(this, options); }, /******************************************************************************* * BlogPostArchiveCountResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * BlogKey * BlogPostMonthYearCounts * IsCachedResponse * ResponseStatus *******************************************************************************/ BlogPostArchiveCountResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Blogs.BlogPostArchiveCountResponse'; return extend(this, options); }, /******************************************************************************* * BlogPostsPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * BlogKey * BlogPostState * RestrictToOwner * IncludeFuturePosts * ItemsPerPage * OneBasedOnPage * SortType * TotalItems * Items * MemberSiteKeys * IsCachedResponse * ResponseStatus *******************************************************************************/ BlogPostsPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Blogs.BlogPostsPageResponse'; return extend(this, options); }, /******************************************************************************* * RecentBlogTagResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * BlogKey * BlogTags * IsCachedResponse * ResponseStatus *******************************************************************************/ RecentBlogTagResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Blogs.RecentBlogTagResponse'; return extend(this, options); }, /******************************************************************************* * CheckFilteredWordsResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * Results * IsCachedResponse * ResponseStatus *******************************************************************************/ CheckFilteredWordsResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Common.CheckFilteredWordsResponse'; return extend(this, options); }, /******************************************************************************* * ContentPolicyResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * ContentPolicy * IsCachedResponse * ResponseStatus *******************************************************************************/ ContentPolicyResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Common.ContentPolicyResponse'; return extend(this, options); }, /******************************************************************************* * EditorMessageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * Message * IsCachedResponse * ResponseStatus *******************************************************************************/ EditorMessageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Common.EditorMessageResponse'; return extend(this, options); }, /******************************************************************************* * SearchResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * SearchResults * IsCachedResponse * SearchType * ResponseStatus *******************************************************************************/ SearchResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Common.SearchResponse'; return extend(this, options); }, /******************************************************************************* * SystemTimeInfoResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * ServerTime * UTCTime * ServerUTCOffset * ServerTimeZone * IsCachedResponse * ResponseStatus *******************************************************************************/ SystemTimeInfoResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Common.SystemTimeInfoResponse'; return extend(this, options); }, /******************************************************************************* * BannedCommunityGroupUsersPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * CommunityGroupKey * ItemsPerPage * OneBasedOnPage * TotalItems * Items * SortType * IsCachedResponse * ResponseStatus *******************************************************************************/ BannedCommunityGroupUsersPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.CommunityGroups.BannedCommunityGroupUsersPageResponse'; return extend(this, options); }, /******************************************************************************* * InvitedCommunityGroupUsersPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * CommunityGroupKey * ItemsPerPage * OneBasedOnPage * SortType * TotalItems * Items * IsCachedResponse * ResponseStatus *******************************************************************************/ InvitedCommunityGroupUsersPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.CommunityGroups.InvitedCommunityGroupUsersPageResponse'; return extend(this, options); }, /******************************************************************************* * CommunityGroupMembershipsPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * Key * ItemsPerPage * OneBasedOnPage * SortType * TotalItems * Items * MembershipFilter * IsCachedResponse * ResponseStatus *******************************************************************************/ CommunityGroupMembershipsPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.CommunityGroups.CommunityGroupMembershipsPageResponse'; return extend(this, options); }, /******************************************************************************* * CommunityGroupMembershipResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * CommunityGroupMembership * IsCachedResponse * ResponseStatus *******************************************************************************/ CommunityGroupMembershipResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.CommunityGroups.CommunityGroupMembershipResponse'; return extend(this, options); }, /******************************************************************************* * MostActiveCommunityGroupMembersResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * Members * IsCachedResponse * ResponseStatus *******************************************************************************/ MostActiveCommunityGroupMembersResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.CommunityGroups.MostActiveCommunityGroupMembersResponse'; return extend(this, options); }, /******************************************************************************* * CommunityGroupsPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * Section * ItemsPerPage * OneBasedOnPage * SortType * TotalItems * Items * MemberSiteKeys * IsCachedResponse * ResponseStatus *******************************************************************************/ CommunityGroupsPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.CommunityGroups.CommunityGroupsPageResponse'; return extend(this, options); }, /******************************************************************************* * CommunityGroupRegistrantsPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * CommunityGroupKey * ItemsPerPage * OneBasedOnPage * SortType * TotalItems * Items * IsCachedResponse * ResponseStatus *******************************************************************************/ CommunityGroupRegistrantsPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.CommunityGroups.CommunityGroupRegistrantsPageResponse'; return extend(this, options); }, /******************************************************************************* * CommunityGroupResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * CommunityGroup * MemberSiteKeys * IsCachedResponse * ResponseStatus *******************************************************************************/ CommunityGroupResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.CommunityGroups.CommunityGroupResponse'; return extend(this, options); }, /******************************************************************************* * CommunityGroupSearchResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * SearchResults * IsCachedResponse * ResponseStatus *******************************************************************************/ CommunityGroupSearchResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Common.CommunityGroupSearchResponse'; return extend(this, options); }, /******************************************************************************* * CustomCollectionsPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * CustomCollectionKey * ItemsPerPage * OneBasedOnPage * SortType * TotalItems * Items * MemberSiteKeys * IsCachedResponse * ResponseStatus *******************************************************************************/ CustomCollectionsPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Custom.CustomCollectionsPageResponse'; return extend(this, options); }, /******************************************************************************* * CustomCollectionResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * CustomCollection * IsCachedResponse * ResponseStatus *******************************************************************************/ CustomCollectionResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Custom.CustomCollectionResponse'; return extend(this, options); }, /******************************************************************************* * CustomItemResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * CustomItem * IsCachedResponse * ResponseStatus *******************************************************************************/ CustomItemResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Custom.CustomItemResponse'; return extend(this, options); }, /******************************************************************************* * DiscoverContentResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * Sections * Categories * LimitToContributors * Activity * Age * MaximumNumberOfDiscoveries * DiscoveredContent * AssociatedCommunityGroups * AssociatedOwners * IsCachedResponse * ResponseStatus *******************************************************************************/ DiscoverContentResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Discovery.DiscoverContentResponse'; return extend(this, options); }, /******************************************************************************* * EventResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * Event * IsCachedResponse * ResponseStatus *******************************************************************************/ EventResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Events.EventResponse'; return extend(this, options); }, /******************************************************************************* * EventsPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * EventSetKey * ItemsPerPage * OneBasedOnPage * SortType * TotalItems * Items * IsCachedResponse * ResponseStatus *******************************************************************************/ EventsPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Events.EventsPageResponse'; return extend(this, options); }, /******************************************************************************* * ForumDiscussionUnreadPostCountResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * ForumDiscussionKey * UnreadPostCount * IsCachedResponse * ResponseStatus *******************************************************************************/ ForumDiscussionUnreadPostCountResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Forums.ForumDiscussionUnreadPostCountResponse'; return extend(this, options); }, /******************************************************************************* * ForumHasUnreadPostsResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * ForumKey * HasUnreadPosts * ResponseStatus * IsCachedResponse *******************************************************************************/ ForumHasUnreadPostsResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Forums.ForumHasUnreadPostsResponse'; return extend(this, options); }, /******************************************************************************* * CommunityFeedResponse [IResponse] * Recent activity of desginated content types from across the site. * Properties: * NumberOfItems * FeedActivityTypes * Items * IsCachedResponse * ResponseStatus *******************************************************************************/ CommunityFeedResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.FriendFeed.CommunityFeedResponse'; return extend(this, options); }, /******************************************************************************* * FeedReactionPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * FeedActivityKey * ItemsPerPage * OneBasedOnPage * TotalItems * Items * IsCachedResponse * ResponseStatus *******************************************************************************/ FeedReactionPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.FriendFeed.FeedReactionPageResponse'; return extend(this, options); }, /******************************************************************************* * FriendFeedPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * UserKey * ItemsPerPage * OneBasedOnPage * TotalItems * Items * IsCachedResponse * ResponseStatus *******************************************************************************/ FriendFeedPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.FriendFeed.FriendFeedPageResponse'; return extend(this, options); }, /******************************************************************************* * HiddenFriendsResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * UserKey * HiddenFriendKeys * IsCachedResponse * ResponseStatus *******************************************************************************/ HiddenFriendsResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.FriendFeed.HiddenFriendsResponse'; return extend(this, options); }, /******************************************************************************* * UserFeedPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * UserKey * ItemsPerPage * OneBasedOnPage * TotalItems * Items * IsCachedResponse * ResponseStatus *******************************************************************************/ UserFeedPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.FriendFeed.UserFeedPageResponse'; return extend(this, options); }, /******************************************************************************* * PhotoSlideShowResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * Gallery * Current * Previous * Next * CurrentPosition * TotalItems * IsCachedResponse * ResponseStatus *******************************************************************************/ PhotoSlideShowResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Media.PhotoSlideShowResponse'; return extend(this, options); }, /******************************************************************************* * RecentPublicGallerySubmissionsPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * UserKey * ItemsPerPage * OneBasedOnPage * TotalItems * Items * IsCachedResponse * ResponseStatus *******************************************************************************/ RecentPublicGallerySubmissionsPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Media.RecentPublicGallerySubmissionsPageResponse'; return extend(this, options); }, /******************************************************************************* * ImageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * Image * IsCachedResponse * ResponseStatus *******************************************************************************/ ImageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Media.ImageResponse'; return extend(this, options); }, /******************************************************************************* * VideoOriginalUrlResponse [IResponse] * URL of uploaded video file in its original format. * Properties: * OriginalVideoUrl * ResponseStatus * IsCachedResponse *******************************************************************************/ VideoOriginalUrlResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Media.VideoOriginalUrlResponse'; return extend(this, options); }, /******************************************************************************* * FlaggedRoutesResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * Routes * IsCachedResponse * ResponseStatus *******************************************************************************/ FlaggedRoutesResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Moderation.FlaggedRoutesResponse'; return extend(this, options); }, /******************************************************************************* * KeywordWatchListResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * WatchList * IsCachedResponse * ResponseStatus *******************************************************************************/ KeywordWatchListResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Moderation.KeywordWatchListResponse'; return extend(this, options); }, /******************************************************************************* * KeywordWatchListsPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * ItemsPerPage * OneBasedOnPage * TotalItems * Items * IsCachedResponse * ResponseStatus *******************************************************************************/ KeywordWatchListsPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Moderation.KeywordWatchListsPageResponse'; return extend(this, options); }, /******************************************************************************* * ModerationLockTimeoutResponse [IResponse] * Returns the new timeout that results from an UpdateLockTimeoutActionRequest. * Properties: * LockExpires * ResponseStatus * IsCachedResponse *******************************************************************************/ ModerationLockTimeoutResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Moderation.ModerationLockTimeoutResponse'; return extend(this, options); }, /******************************************************************************* * ModerationEditorCommentsResponse [IResponse] * Adds internal notes to the user profile for use by moderators, editors and admins. * Properties: * MemberSiteKeys * EditorComments * IsCachedResponse * ResponseStatus *******************************************************************************/ ModerationEditorCommentsResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Moderation.ModerationEditorCommentsResponse'; return extend(this, options); }, /******************************************************************************* * ModerationItemResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * Items * Queue * IsCachedResponse * ResponseStatus *******************************************************************************/ ModerationItemResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Moderation.ModerationItemResponse'; return extend(this, options); }, /******************************************************************************* * ModerationItemsPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * ItemsPerPage * OneBasedOnPage * SortOrder * Items * TotalItems * Queue * IsCachedResponse * ResponseStatus *******************************************************************************/ ModerationItemsPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Moderation.ModerationItemsPageResponse'; return extend(this, options); }, /******************************************************************************* * ModerationQueuesResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * Queues * CanEditModerationContent * IsCachedResponse * ModerationItemBatchCount * ResponseStatus *******************************************************************************/ ModerationQueuesResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Moderation.ModerationQueuesResponse'; return extend(this, options); }, /******************************************************************************* * ModerationUserResponse [IResponse] * Encapsulates the user with extra metadata that is specifically used in the Moderation Manager, like editor comments. * Properties: * UserDetails * UserActivities * MemberSiteKeys * SnapShot * IsOnAbusiveUserList * IsCachedResponse * CanEditModerationContent * ResponseStatus *******************************************************************************/ ModerationUserResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Moderation.ModerationUserResponse'; return extend(this, options); }, /******************************************************************************* * ModeratorsResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * ModeratorAssignments * Queues * IsCachedResponse * ResponseStatus *******************************************************************************/ ModeratorsResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Moderation.ModeratorsResponse'; return extend(this, options); }, /******************************************************************************* * ItemScoresResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * ItemScores * IsCachedResponse * ResponseStatus *******************************************************************************/ ItemScoresResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Reactions.ItemScoresResponse'; return extend(this, options); }, /******************************************************************************* * ReviewsPageByDateResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * StartDate * ItemsPerPage * OneBasedOnPage * SortType * TotalItems * Items * MemberSiteKeys * FilterType * IsCachedResponse * ResponseStatus *******************************************************************************/ ReviewsPageByDateResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Reactions.Reviews.ReviewsPageByDateResponse'; return extend(this, options); }, /******************************************************************************* * ReviewRatingAttributeResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * Attribute * IsCachedResponse * ResponseStatus *******************************************************************************/ ReviewRatingAttributeResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Reactions.Reviews.ReviewRatingAttributeResponse'; return extend(this, options); }, /******************************************************************************* * ReviewRatingAttributeSetResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * AttributeSet * IsCachedResponse * ResponseStatus *******************************************************************************/ ReviewRatingAttributeSetResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Reactions.Reviews.ReviewRatingAttributeSetResponse'; return extend(this, options); }, /******************************************************************************* * ReviewCategoryRollupResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * CategoryRollups * IsCachedResponse * ResponseStatus *******************************************************************************/ ReviewCategoryRollupResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Reactions.Reviews.ReviewCategoryRollupResponse'; return extend(this, options); }, /******************************************************************************* * RecentReviewsByCategoryResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * RecentReviews * IsCachedResponse * ResponseStatus *******************************************************************************/ RecentReviewsByCategoryResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Reactions.Reviews.RecentReviewsByCategoryResponse'; return extend(this, options); }, /******************************************************************************* * MostHelpfulReviewsResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * ReviewOnKey * ItemsPerPage * FavorableItems * CriticalItems * MemberSiteKeys * IsCachedResponse * ResponseStatus *******************************************************************************/ MostHelpfulReviewsResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Reactions.Reviews.MostHelpfulReviewsResponse'; return extend(this, options); }, /******************************************************************************* * ReviewRatingAttributeSetsPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * Items * ItemsPerPage * OneBasedOnPage * SortType * TotalItems * FilterType * IsCachedResponse * ResponseStatus *******************************************************************************/ ReviewRatingAttributeSetsPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Reactions.Reviews.ReviewRatingAttributeSetsPageResponse'; return extend(this, options); }, /******************************************************************************* * ReviewRatingAttributesPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * Items * ItemsPerPage * OneBasedOnPage * SortType * TotalItems * FilterType * IsCachedResponse * ResponseStatus *******************************************************************************/ ReviewRatingAttributesPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Reactions.Reviews.ReviewRatingAttributesPageResponse'; return extend(this, options); }, /******************************************************************************* * ReviewResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * Review * IsCachedResponse * ResponseStatus *******************************************************************************/ ReviewResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Reactions.Reviews.ReviewResponse'; return extend(this, options); }, /******************************************************************************* * ReviewRollupResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * ReviewRollup * IsCachedResponse * ResponseStatus *******************************************************************************/ ReviewRollupResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Reactions.Reviews.ReviewRollupResponse'; return extend(this, options); }, /******************************************************************************* * ReviewsPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * ReviewOnKey * ItemsPerPage * OneBasedOnPage * SortType * TotalItems * Items * MemberSiteKeys * FilterType * IsCachedResponse * ResponseStatus *******************************************************************************/ ReviewsPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Reactions.Reviews.ReviewsPageResponse'; return extend(this, options); }, /******************************************************************************* * TopRatedItemsByCategoryResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * Items * TotalItems * ItemsPerPage * OneBasedOnPage * IsCachedResponse * ResponseStatus *******************************************************************************/ TopRatedItemsByCategoryResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Reactions.Reviews.TopRatedItemsByCategoryResponse'; return extend(this, options); }, /******************************************************************************* * ActionResponse [IResponse] * Encapsulates the server's response an action request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the information on Pluck objects affected by the action. There is no need to set properties on this object. * Properties: * KeyActions * IsCachedResponse * ResponseStatus *******************************************************************************/ ActionResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.System.ActionResponse'; return extend(this, options); }, /******************************************************************************* * UpdateSlauthUserActionResponse [IResponse] * Properties: * LiteUser * Cookies * KeyActions * IsCachedResponse * ResponseStatus *******************************************************************************/ UpdateSlauthUserActionResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Slauth.UpdateSlauthUserActionResponse'; return extend(this, options); }, /******************************************************************************* * LinkedInAuthUrlResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * LinkedInUrl * IsCachedResponse * ResponseStatus *******************************************************************************/ LinkedInAuthUrlResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Social.LinkedInAuthUrlResponse'; return extend(this, options); }, /******************************************************************************* * LinkedInProfileNameResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * IsAuthorized * ProfileName * PublicUrl * IsCachedResponse * ResponseStatus *******************************************************************************/ LinkedInProfileNameResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Social.LinkedInProfileNameResponse'; return extend(this, options); }, /******************************************************************************* * TwitterAuthUrlResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * TwitterUrl * IsCachedResponse * ResponseStatus *******************************************************************************/ TwitterAuthUrlResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Social.TwitterAuthUrlResponse'; return extend(this, options); }, /******************************************************************************* * TwitterLastTweetResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * ScreenName * LastTweet * PostDate * IsCachedResponse * ResponseStatus *******************************************************************************/ TwitterLastTweetResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Social.TwitterLastTweetResponse'; return extend(this, options); }, /******************************************************************************* * TwitterScreenNameResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * IsAuthorized * ScreenName * IsCachedResponse * ResponseStatus *******************************************************************************/ TwitterScreenNameResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Social.TwitterScreenNameResponse'; return extend(this, options); }, /******************************************************************************* * ArticleResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * Article * MemberSiteKeys * IsCachedResponse * ResponseStatus *******************************************************************************/ ArticleResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.External.ArticleResponse'; return extend(this, options); }, /******************************************************************************* * ForumCategoriesPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * ItemsPerPage * OneBasedOnPage * TotalItems * Items * IsCachedResponse * ResponseStatus *******************************************************************************/ ForumCategoriesPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Forums.ForumCategoriesPageResponse'; return extend(this, options); }, /******************************************************************************* * ForumCategoryResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * ForumCategory * IsCachedResponse * ResponseStatus *******************************************************************************/ ForumCategoryResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Forums.ForumCategoryResponse'; return extend(this, options); }, /******************************************************************************* * ForumDiscussionResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * ForumDiscussion * IsCachedResponse * ResponseStatus *******************************************************************************/ ForumDiscussionResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Forums.ForumDiscussionResponse'; return extend(this, options); }, /******************************************************************************* * ForumDiscussionsPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * ForumKey * ItemsPerPage * OneBasedOnPage * TotalItems * Items * MemberSiteKeys * IsCachedResponse * ResponseStatus *******************************************************************************/ ForumDiscussionsPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Forums.ForumDiscussionsPageResponse'; return extend(this, options); }, /******************************************************************************* * ForumPostOnPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * ForumPostKey * OneBasedOnPage * SortType * IsCachedResponse * ResponseStatus *******************************************************************************/ ForumPostOnPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Forums.ForumPostOnPageResponse'; return extend(this, options); }, /******************************************************************************* * ForumPostResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * ForumPost * IsCachedResponse * ResponseStatus *******************************************************************************/ ForumPostResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Forums.ForumPostResponse'; return extend(this, options); }, /******************************************************************************* * ForumPostsPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * ForumDiscussionKey * ItemsPerPage * OneBasedOnPage * SortType * TotalItems * Items * MemberSiteKeys * IsCachedResponse * ResponseStatus *******************************************************************************/ ForumPostsPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Forums.ForumPostsPageResponse'; return extend(this, options); }, /******************************************************************************* * ForumResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * Forum * IsCachedResponse * ResponseStatus *******************************************************************************/ ForumResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Forums.ForumResponse'; return extend(this, options); }, /******************************************************************************* * ForumSearchResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * SearchResults * IsCachedResponse * ResponseStatus *******************************************************************************/ ForumSearchResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Forums.ForumSearchResponse'; return extend(this, options); }, /******************************************************************************* * ForumsPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * ItemsPerPage * OneBasedOnPage * TotalItems * Items * IsCachedResponse * ResponseStatus *******************************************************************************/ ForumsPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Forums.ForumsPageResponse'; return extend(this, options); }, /******************************************************************************* * RecentForumDiscussionsPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * UserKey * ItemsPerPage * OneBasedOnPage * TotalItems * Items * MemberSiteKeys * IsCachedResponse * ResponseStatus *******************************************************************************/ RecentForumDiscussionsPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Forums.RecentForumDiscussionsPageResponse'; return extend(this, options); }, /******************************************************************************* * UserGroupForumsPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * UserKey * ItemsPerPage * OneBasedOnPage * TotalItems * Items * IsCachedResponse * ResponseStatus *******************************************************************************/ UserGroupForumsPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Forums.UserGroupForumsPageResponse'; return extend(this, options); }, /******************************************************************************* * GalleryResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * Gallery * IsCachedResponse * ResponseStatus *******************************************************************************/ GalleryResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Media.GalleryResponse'; return extend(this, options); }, /******************************************************************************* * PhotosPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * GalleryKey * ItemsPerPage * OneBasedOnPage * SortType * TotalItems * Items * IsCachedResponse * ResponseStatus *******************************************************************************/ PhotosPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Media.PhotosPageResponse'; return extend(this, options); }, /******************************************************************************* * PhotoResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * Photo * IsCachedResponse * ResponseStatus *******************************************************************************/ PhotoResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Media.PhotoResponse'; return extend(this, options); }, /******************************************************************************* * PublicGalleriesPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * MediaType * ItemsPerPage * OneBasedOnPage * TotalItems * Items * IsCachedResponse * ResponseStatus *******************************************************************************/ PublicGalleriesPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Media.PublicGalleriesPageResponse'; return extend(this, options); }, /******************************************************************************* * RecentPublicGalleriesPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * UserKey * ItemsPerPage * OneBasedOnPage * TotalItems * Items * IsCachedResponse * ResponseStatus *******************************************************************************/ RecentPublicGalleriesPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Media.RecentPublicGalleriesPageResponse'; return extend(this, options); }, /******************************************************************************* * RecentUserPhotosPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * UserKey * ItemsPerPage * OneBasedOnPage * TotalItems * Items * MemberSiteKeys * IsCachedResponse * ResponseStatus *******************************************************************************/ RecentUserPhotosPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Media.RecentUserPhotosPageResponse'; return extend(this, options); }, /******************************************************************************* * RecentUserVideosPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * UserKey * ItemsPerPage * OneBasedOnPage * TotalItems * Items * MemberSiteKeys * IsCachedResponse * ResponseStatus *******************************************************************************/ RecentUserVideosPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Media.RecentUserVideosPageResponse'; return extend(this, options); }, /******************************************************************************* * UserGalleriesPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * UserKey * MediaType * ItemsPerPage * OneBasedOnPage * TotalItems * Items * IsCachedResponse * ResponseStatus *******************************************************************************/ UserGalleriesPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Media.UserGalleriesPageResponse'; return extend(this, options); }, /******************************************************************************* * UserMediaSubmissionsCountPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * UserKey * MediaType * ItemsPerPage * OneBasedOnPage * TotalItems * Items * IsCachedResponse * ResponseStatus *******************************************************************************/ UserMediaSubmissionsCountPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Media.UserMediaSubmissionsCountPageResponse'; return extend(this, options); }, /******************************************************************************* * VideosPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * GalleryKey * ItemsPerPage * OneBasedOnPage * SortType * TotalItems * Items * MemberSiteKeys * IsCachedResponse * ResponseStatus *******************************************************************************/ VideosPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Media.VideosPageResponse'; return extend(this, options); }, /******************************************************************************* * VideoResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * Video * IsCachedResponse * ResponseStatus *******************************************************************************/ VideoResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Media.VideoResponse'; return extend(this, options); }, /******************************************************************************* * BadgeFamiliesResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * Families * IsCachedResponse * ResponseStatus *******************************************************************************/ BadgeFamiliesResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.PointsAndBadging.BadgeFamiliesResponse'; return extend(this, options); }, /******************************************************************************* * BadgeFamilyResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * BadgeFamily * IsCachedResponse * ResponseStatus *******************************************************************************/ BadgeFamilyResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.PointsAndBadging.BadgeFamilyResponse'; return extend(this, options); }, /******************************************************************************* * LeaderboardRankingsPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * LeaderboardKey * LeaderboardName * LeaderboardAvatarUrl * ItemsPerPage * OneBasedOnPage * TotalItems * Items * IsCachedResponse * ResponseStatus *******************************************************************************/ LeaderboardRankingsPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.PointsAndBadging.LeaderboardRankingsPageResponse'; return extend(this, options); }, /******************************************************************************* * LeaderboardResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * Leaderboard * IsCachedResponse * ResponseStatus *******************************************************************************/ LeaderboardResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.PointsAndBadging.LeaderboardResponse'; return extend(this, options); }, /******************************************************************************* * LeaderboardsResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * Boards * IsCachedResponse * ResponseStatus *******************************************************************************/ LeaderboardsResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.PointsAndBadging.LeaderboardsResponse'; return extend(this, options); }, /******************************************************************************* * PointsAndBadgingRuleValidationResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * IsValid * ErrorMessage * Rules * IsCachedResponse * ResponseStatus *******************************************************************************/ PointsAndBadgingRuleValidationResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.PointsAndBadging.PointsAndBadgingRuleValidationResponse'; return extend(this, options); }, /******************************************************************************* * PollsPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * PollOnKey * ItemsPerPage * OneBasedOnPage * SortType * TotalItems * Items * MemberSiteKeys * IsCachedResponse * ResponseStatus *******************************************************************************/ PollsPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Polls.PollsPageResponse'; return extend(this, options); }, /******************************************************************************* * PollResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * Poll * IsCachedResponse * ResponseStatus *******************************************************************************/ PollResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Polls.PollResponse'; return extend(this, options); }, /******************************************************************************* * PrivateMessageFolderListResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * UserKey * FolderList * IsCachedResponse * ResponseStatus *******************************************************************************/ PrivateMessageFolderListResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.PrivateMessaging.PrivateMessageFolderListResponse'; return extend(this, options); }, /******************************************************************************* * PrivateMessagesPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * UserKey * FolderID * MessageReadState * ItemsPerPage * OneBasedOnPage * TotalItems * Items * IsCachedResponse * ResponseStatus *******************************************************************************/ PrivateMessagesPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.PrivateMessaging.PrivateMessagesPageResponse'; return extend(this, options); }, /******************************************************************************* * PrivateMessageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * PrivateMessage * IsCachedResponse * ResponseStatus *******************************************************************************/ PrivateMessageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.PrivateMessaging.PrivateMessageResponse'; return extend(this, options); }, /******************************************************************************* * CommentsPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * CommentedOnKey * ItemsPerPage * OneBasedOnPage * SortType * TotalItems * Items * MemberSiteKeys * FilterType * IsCachedResponse * ResponseStatus *******************************************************************************/ CommentsPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Reactions.CommentsPageResponse'; return extend(this, options); }, /******************************************************************************* * CommentResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * Comment * IsCachedResponse * ResponseStatus *******************************************************************************/ CommentResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Reactions.CommentResponse'; return extend(this, options); }, /******************************************************************************* * ResponseException [IDaapiModel] * An exception returned by the server. In addition to warnings and informational messages, an exception may be a warning or debugging message, or a fatal error. Some errors should be presented to the user, such as when a contribution trips Pluck's flood control. * Properties: * Name * Value * ExceptionCode * ExceptionLevel * ExceptionMessage *******************************************************************************/ ResponseException: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.System.Exceptions.ResponseException'; return extend(this, options); }, /******************************************************************************* * ResponseStatus [IDaapiModel] * Indicates the success or failure of a request and contains any exception information. * Properties: * StatusCode * Exceptions *******************************************************************************/ ResponseStatus: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Models.System.ResponseStatus'; return extend(this, options); }, /******************************************************************************* * InvalidRequestExceptionResponse [IResponse] * The server was unable to deserialize the request. This happens if malformed JSON is passed on the request, or if bogus properties are passed on the request. For example, the Javascript SDK doesn’t do any client side validation to make sure you spelled all the property names right. * Properties: * IsCachedResponse * ResponseStatus *******************************************************************************/ InvalidRequestExceptionResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.System.InvalidRequestExceptionResponse'; return extend(this, options); }, /******************************************************************************* * TrashAuditItemsPageResponse [IResponse] * Gets a page of items that have been deleted. * Remarks:
* Only returns trash one day at a time. * Properties: * IsCachedResponse * ResponseStatus * Items * TotalItems * ItemsPerPage * OneBasedOnPage *******************************************************************************/ TrashAuditItemsPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.TrashAudit.TrashAuditItemsPageResponse'; return extend(this, options); }, /******************************************************************************* * FollowersPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * UserKey * ItemsPerPage * OneBasedOnPage * TotalItems * Items * IsCachedResponse * ResponseStatus *******************************************************************************/ FollowersPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Users.FollowersPageResponse'; return extend(this, options); }, /******************************************************************************* * UserExtendedPrefsResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * UserExtendedPrefs * IsCachedResponse * ResponseStatus *******************************************************************************/ UserExtendedPrefsResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Users.UserExtendedPrefsResponse'; return extend(this, options); }, /******************************************************************************* * EnemiesPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * UserKey * ItemsPerPage * OneBasedOnPage * SortType * TotalItems * Items * IsCachedResponse * ResponseStatus *******************************************************************************/ EnemiesPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Users.EnemiesPageResponse'; return extend(this, options); }, /******************************************************************************* * FriendsPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * UserKey * IsPendingList * IsPendingByOthers * ItemsPerPage * OneBasedOnPage * TotalItems * Items * IsCachedResponse * ResponseStatus *******************************************************************************/ FriendsPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Users.FriendsPageResponse'; return extend(this, options); }, /******************************************************************************* * IsFriendResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * FriendshipState * IsCachedResponse * ResponseStatus *******************************************************************************/ IsFriendResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Users.IsFriendResponse'; return extend(this, options); }, /******************************************************************************* * PersonaMessagesPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * UserKey * ItemsPerPage * OneBasedOnPage * TotalItems * Items * IsCachedResponse * ResponseStatus *******************************************************************************/ PersonaMessagesPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Users.PersonaMessagesPageResponse'; return extend(this, options); }, /******************************************************************************* * RecentUserActivityResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * UserKey * UserActivities * MemberSiteKeys * IsCachedResponse * ResponseStatus *******************************************************************************/ RecentUserActivityResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Users.RecentUserActivityResponse'; return extend(this, options); }, /******************************************************************************* * UserCommentsPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * UserKey * ItemsPerPage * OneBasedOnPage * SortType * TotalItems * Items * MemberSiteKeys * IsCachedResponse * ResponseStatus *******************************************************************************/ UserCommentsPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Users.UserCommentsPageResponse'; return extend(this, options); }, /******************************************************************************* * UserResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * User * IsCachedResponse * ResponseStatus *******************************************************************************/ UserResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Users.UserResponse'; return extend(this, options); }, /******************************************************************************* * UserReviewsPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * UserKey * ItemsPerPage * OneBasedOnPage * SortType * TotalItems * Items * MemberSiteKeys * IsCachedResponse * ResponseStatus *******************************************************************************/ UserReviewsPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Users.UserReviewsPageResponse'; return extend(this, options); }, /******************************************************************************* * UserTagsResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. * Properties: * UserKey * Tags * ContentType * IsCachedResponse * ResponseStatus *******************************************************************************/ UserTagsResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Users.UserTagsResponse'; return extend(this, options); }, /******************************************************************************* * WatchItemsPageResponse [IResponse] * Encapsulates the server's response to the corresponding request. * Remarks:
* Should not be instantiated. Echoes back parameters of the request, in addition to returning the requested information. Retrieve the returned data using properties; there is no need to set properties on this object. Watch list items are essentially bookmarks. (Deprecated: not displayed in Pluck 4 widgets.) * Properties: * UserKey * ItemsPerPage * OneBasedOnPage * SortType * TotalItems * Items * MemberSiteKeys * IsCachedResponse * ResponseStatus *******************************************************************************/ WatchItemsPageResponse: function(options){ verifyNewUsed(this, arguments.callee); this.ObjectType = 'Responses.Users.WatchItemsPageResponse'; return extend(this, options); }, /******************************************************************************* * AbuseClassificationEnum * Enumerates the classifications of abuse report reasons. * * Remarks:
*******************************************************************************/ AbuseClassificationEnum: { /** * Set to True if the current content is standard abuse, otherwise False. */ StandardAbuse: 'StandardAbuse', /** */ WordFilterAbuse: 'WordFilterAbuse', /** */ SpamAbuse: 'SpamAbuse', /** */ KeywordWatchList: 'KeywordWatchList', /** */ None: 'None' }, /******************************************************************************* * ContentBlockingEnum * Enumerates whether or how an item has been blocked. * * Remarks:
*******************************************************************************/ ContentBlockingEnum: { /** */ Unblocked: 'Unblocked', /** */ BlockedByAdmin: 'BlockedByAdmin' }, /******************************************************************************* * ActivityAction * Enumerates moderation actions. * * Remarks:
*******************************************************************************/ ActivityAction: { /** */ None: 'None', /** */ Added: 'Added', /** */ Updated: 'Updated', /** */ Deleted: 'Deleted', /** */ Open: 'Open', /** */ Close: 'Close', /** */ Move: 'Move', /** */ NotApproved: 'NotApproved', /** */ AddedToGallery: 'AddedToGallery', /** */ Cleared: 'Cleared', /** */ Accepted: 'Accepted' }, /******************************************************************************* * ActivityType * Enumerates types of user activity. * * Remarks:
*******************************************************************************/ ActivityType: { /** */ AbuseReport: 'AbuseReport', /** */ Comment: 'Comment', /** */ CustomItem: 'CustomItem', /** */ Blog: 'Blog', /** */ BlogPost: 'BlogPost', /** */ Forum: 'Forum', /** */ ForumDiscussion: 'ForumDiscussion', /** */ ForumPost: 'ForumPost', /** */ PhotoGallery: 'PhotoGallery', /** */ VideoGallery: 'VideoGallery', /** */ Photo: 'Photo', /** */ Video: 'Video', /** */ Event: 'Event', /** */ CommunityGroup: 'CommunityGroup', /** */ CommunityGroupInvitation: 'CommunityGroupInvitation', /** */ CommunityGroupUserBan: 'CommunityGroupUserBan', /** */ CommunityGroupRegistration: 'CommunityGroupRegistration', /** */ CommunityGroupMembership: 'CommunityGroupMembership', /** */ Rating: 'Rating', /** */ Recommendation: 'Recommendation', /** */ Review: 'Review', /** */ Message: 'Message', /** */ Watch: 'Watch', /** */ UserProfile: 'UserProfile', /** */ PrivateMessage: 'PrivateMessage', /** */ Friend: 'Friend', /** */ Image: 'Image', /** */ Poll: 'Poll', /** */ UserPollAnswer: 'UserPollAnswer', /** */ Badging: 'Badging' }, /******************************************************************************* * ApprovalStateEnum * Enumerates the approval states of target items. * * Remarks:
*******************************************************************************/ ApprovalStateEnum: { /** */ PendingApproval: 'PendingApproval', /** */ Approved: 'Approved', /** */ Rejected: 'Rejected', /** */ Deleted: 'Deleted' }, /******************************************************************************* * BlogPostStateSearchTypeEnum * Enumerates the states of blog post, as used in requests that return blog post pages. * * Remarks:
* Used for filtering rather than search. *******************************************************************************/ BlogPostStateSearchTypeEnum: { /** */ Published: 'Published', /** */ Draft: 'Draft', /** */ All: 'All' }, /******************************************************************************* * ContentPolicyActionEnum * Enumerates content policy actions. * * Remarks:
*******************************************************************************/ ContentPolicyActionEnum: { /** */ Comment: 'Comment', /** */ SubmitContent: 'SubmitContent', /** */ ReportAbuse: 'ReportAbuse', /** */ Create: 'Create', /** */ Update: 'Update', /** */ Delete: 'Delete', /** */ Review: 'Review', /** */ All: 'All' }, /******************************************************************************* * ContentPolicyEnum * Enumerates content policy levels of permission. * * Remarks:
*******************************************************************************/ ContentPolicyEnum: { /** */ Undefined: 'Undefined', /** */ Disallowed: 'Disallowed', /** */ Allowed: 'Allowed', /** */ ApprovalRequired: 'ApprovalRequired' }, /******************************************************************************* * DaysOfWeek * Enumerates the days of the week. * * Remarks:
* Supports multiple values (i.e. if you want a group digest to send on Sunday and Tuesday, set the run days to DaysOfWeek.Sunday | DaysOfWeek.Tuesday) *******************************************************************************/ DaysOfWeek: { /** */ None: 'None', /** */ Sunday: 'Sunday', /** */ Monday: 'Monday', /** */ Tuesday: 'Tuesday', /** */ Wednesday: 'Wednesday', /** */ Thursday: 'Thursday', /** */ Friday: 'Friday', /** */ Saturday: 'Saturday', /** */ All: 'All', /* parse string value to integer value */ fromString: function(s) { return enumSetFromString('DaysOfWeek', s); }, /* convert integer value to string value */ toString: function(v) { return enumSetToString('DaysOfWeek',v); } }, /******************************************************************************* * CommunityGroupVisibility * Indicates whether or not the CommunityGroup's content will be accessible to non-members. * * Remarks:
* Private groups are not hidden altogether, but all content associated with a private group groups, other than their title and description, is unavailable to non-members. *******************************************************************************/ CommunityGroupVisibility: { /** */ Private: 'Private', /** */ Public: 'Public' }, /******************************************************************************* * MembershipTier * Enumerates the membership levels for users within Community Groups. * * Remarks:
*******************************************************************************/ MembershipTier: { /** */ NonMember: 'NonMember', /** */ Invited: 'Invited', /** */ Pending: 'Pending', /** */ Member: 'Member', /** */ Manager: 'Manager', /** */ GroupAdmin: 'GroupAdmin', /** */ All: 'All', /** */ Banned: 'Banned' }, /******************************************************************************* * SexEnum * Enumerates gender choices for a user. * * Remarks:
*******************************************************************************/ SexEnum: { /** */ Female: 'Female', /** */ Male: 'Male', /** */ None: 'None' }, /******************************************************************************* * FeedActivityTypes * Enumerates the content types for a feed activity entry. * * Remarks:
*******************************************************************************/ FeedActivityTypes: { /** */ Comment: 'Comment', /** */ Review: 'Review', /** */ BlogPost: 'BlogPost', /** */ ForumPost: 'ForumPost', /** */ Photo: 'Photo', /** */ Video: 'Video', /** */ Discussions: 'Discussions', /** */ AllCommunity: 'AllCommunity', /** */ CustomItem: 'CustomItem', /** */ WallPost: 'WallPost', /** */ Badge: 'Badge', /** */ CommunityGroupMembership: 'CommunityGroupMembership', /** */ CustomActivity: 'CustomActivity', /** */ Event: 'Event', /** */ UserStatus: 'UserStatus', /** */ Message: 'Message', /** */ All: 'All', /* parse string value to integer value */ fromString: function(s) { return enumSetFromString('FeedActivityTypes', s); }, /* convert integer value to string value */ toString: function(v) { return enumSetToString('FeedActivityTypes',v); } }, /******************************************************************************* * FeedActivityAction * Enumerates the activities that can occur in a feed. * * Remarks:
*******************************************************************************/ FeedActivityAction: { /** */ Create: 'Create', /** */ Update: 'Update', /** */ Delete: 'Delete' }, /******************************************************************************* * CopyMediaTypeEnum * Enumerates the states of Gallery photos. * * Remarks:
* Use for display filtering. *******************************************************************************/ CopyMediaTypeEnum: { /** */ KeepOriginalMedia: 'KeepOriginalMedia', /** */ CreateNewMedia: 'CreateNewMedia' }, /******************************************************************************* * GalleryViewState * Enumerates the states of a media gallery. * * Remarks:
*******************************************************************************/ GalleryViewState: { /** * Allow submissions. */ Open: 'Open', /** * Disallows submissions, except from users in the Editor tier. (All users can still view and comment.) */ ViewOnly: 'ViewOnly', /** * Disallows submissions for all users. */ Closed: 'Closed' }, /******************************************************************************* * PointsAndBadgingState * Indicates whether a PointsAndBadging object is active. * * Remarks:
*******************************************************************************/ PointsAndBadgingState: { /** */ Active: 'Active', /** */ Inactive: 'Inactive' }, /******************************************************************************* * BadgeFamilyType * Enumerates the fundamental type of a badge object. * * Remarks:
*******************************************************************************/ BadgeFamilyType: { /** */ Assigned: 'Assigned', /** */ Earned: 'Earned' }, /******************************************************************************* * MessageReadState * Enumerates valid message read/unread states. * * Remarks:
*******************************************************************************/ MessageReadState: { /** */ Unread: 'Unread', /** */ Read: 'Read', /** * Used to request both read and unread messages. */ All: 'All' }, /******************************************************************************* * ReviewItemState * Enumerates the discoverability states of a reviewed item, and whether it displays as linked in recent activity. In terms of discovery, only affects RecentReviewsByCategoryRequest and RecentReviewsRequest, not DiscoverContentActionRequest. * * Remarks:
*******************************************************************************/ ReviewItemState: { /** */ Active: 'Active', /** */ Inactive: 'Inactive', /** */ NotDiscoverable: 'NotDiscoverable' }, /******************************************************************************* * ApprovalSetting * Indicates which users can approve content. * * Remarks:
*******************************************************************************/ ApprovalSetting: { /** */ Everyone: 'Everyone', /** */ Nobody: 'Nobody', /** */ NoChange: 'NoChange' }, /******************************************************************************* * BlogType * Indicates the type of blog. * * Remarks:
*******************************************************************************/ BlogType: { /** */ Personal: 'Personal', /** */ Group: 'Group', /** */ Public: 'Public' }, /******************************************************************************* * SearchTypeEnum * Enumerates the types of objects to returned in a search. * * Remarks:
*******************************************************************************/ SearchTypeEnum: { /** */ User: 'User', /** */ Comment: 'Comment', /** */ Blog: 'Blog', /** */ BlogPost: 'BlogPost', /** */ ForumPost: 'ForumPost', /** */ Gallery: 'Gallery', /** */ Photo: 'Photo', /** */ Video: 'Video', /** */ CommunityGroup: 'CommunityGroup', /** */ Event: 'Event', /** * Only available for searching Community Groups. */ All: 'All', /** */ Poll: 'Poll', /** */ Review: 'Review' }, /******************************************************************************* * ContentType * Enumerates the types of content that can be stored in Pluck. * * Remarks:
*******************************************************************************/ ContentType: { /** */ Article: 'Article', /** */ UserPhoto: 'UserPhoto', /** */ PublicPhoto: 'PublicPhoto', /** */ UserVideo: 'UserVideo', /** */ PublicVideo: 'PublicVideo', /** */ UserPhotoGallery: 'UserPhotoGallery', /** */ PublicPhotoGallery: 'PublicPhotoGallery', /** */ PublicVideoGallery: 'PublicVideoGallery', /** */ PublicBlog: 'PublicBlog', /** */ GroupBlog: 'GroupBlog', /** */ UserBlog: 'UserBlog', /** */ BlogPost: 'BlogPost', /** */ Discussion: 'Discussion', /** */ Persona: 'Persona', /** */ CommunityGroup: 'CommunityGroup', /** */ Review: 'Review' }, /******************************************************************************* * DiscoveryActivity * Enumerates the kinds of user actions that are used as criteria for discovery. * * Remarks:
*******************************************************************************/ DiscoveryActivity: { /** */ Commented: 'Commented', /** */ Rated: 'Rated', /** */ Recent: 'Recent', /** */ Recommended: 'Recommended', /** */ Reviewed: 'Reviewed', /** */ MostActive: 'MostActive', /** */ MostViewed: 'MostViewed', /** */ LeastViewed: 'LeastViewed', /** */ Created: 'Created', /* parse string value to integer value */ fromString: function(s) { return enumSetFromString('DiscoveryActivity', s); }, /* convert integer value to string value */ toString: function(v) { return enumSetToString('DiscoveryActivity',v); } }, /******************************************************************************* * SortEnum * Enumerates valid sort orders for item lists. * * Remarks:
*******************************************************************************/ SortEnum: { /** */ TimeStampDescending: 'TimeStampDescending', /** */ TimeStampAscending: 'TimeStampAscending', /** */ RecommendationsDescending: 'RecommendationsDescending', /** */ RecommendationsAscending: 'RecommendationsAscending', /** */ RatingDescending: 'RatingDescending', /** */ RatingAscending: 'RatingAscending', /** */ PositionDescending: 'PositionDescending', /** */ PositionAscending: 'PositionAscending', /** */ AlphabeticalAscending: 'AlphabeticalAscending', /** */ AlphabeticalDescending: 'AlphabeticalDescending', /** */ None: 'None' }, /******************************************************************************* * UserTier * The user's access level, as assigned in administrative tools. * * Remarks:
* Feature access can be configured differently by user tier. For instance, photos can require approval when submitted by users in the Standard tier, but immediately visible when submitted other tiers. The typical tier order is Standard, Trusted, Featured, Staff, and Editor, but the configurations don't have to follow this pattern (for instance, a Featured user can have with fewer priviliges than Standard, but we recommend against this).

Note that Editors have some priviliges that can not be revoked, so this tier should always be reserved for administrators.

Anonymous is a special tier for unauthenticated users. Features must be individually configured to allow anonymous contributions. *******************************************************************************/ UserTier: { /** * Applies to users who are not authenticated. */ Anonymous: 'Anonymous', /** */ All: 'All', /** */ Standard: 'Standard', /** */ Trusted: 'Trusted', /** */ Featured: 'Featured', /** */ Staff: 'Staff', /** * A super-user who has special moderation and administration priviliges. Many such priviliges are not configurable. */ Editor: 'Editor' }, /******************************************************************************* * MediaTypeEnum * Enumerates the types of media a gallery can contain. * * Remarks:
*******************************************************************************/ MediaTypeEnum: { /** */ Photo: 'Photo', /** */ Video: 'Video' }, /******************************************************************************* * PersonaPrivacyModesEnum * Enumerates the privacy choices for a Persona. * * Remarks:
*******************************************************************************/ PersonaPrivacyModesEnum: { /** */ Public: 'Public', /** */ Private: 'Private', /** */ SharedWithFriends: 'SharedWithFriends' }, /******************************************************************************* * SiteStateEnum * Enumerates the states of a MemberSite object. Applies only to Portfolio (multi-site) instances. * * Remarks:
*******************************************************************************/ SiteStateEnum: { /** */ Active: 'Active', /** */ Inactive: 'Inactive' }, /******************************************************************************* * AdministrativeTierEnum * Enumerates the levels of administrative tiers. Applies only to Portfolio (multi-site) instances. * * Remarks:
*******************************************************************************/ AdministrativeTierEnum: { /** */ None: 'None', /** */ SiteManager: 'SiteManager', /** */ Administrator: 'Administrator', /** */ SiteAdministrator: 'SiteAdministrator' }, /******************************************************************************* * GalleryTypeEnum * Enumerates the types of a photo or video gallery. * * Remarks:
*******************************************************************************/ GalleryTypeEnum: { /** */ Editor: 'Editor', /** */ User: 'User' }, /******************************************************************************* * PhotoStateEnum * Enumerates the states for Photos. * * Remarks:
*******************************************************************************/ PhotoStateEnum: { /** */ Submitted: 'Submitted', /** */ Abusive: 'Abusive' }, /******************************************************************************* * VideoStateEnum * Enumerates the transcoding (processing) state of a video. * * Remarks:
*******************************************************************************/ VideoStateEnum: { /** */ Error: 'Error', /** */ Processing: 'Processing', /** */ Completed: 'Completed' }, /******************************************************************************* * ContentPolicyTraceEntryType * Specifies the type of content policy trace entry. * * Remarks:
*******************************************************************************/ ContentPolicyTraceEntryType: { /** * Currently not used. */ System: 'System', /** * Content policy trace entry is discovery category specific. */ Category: 'Category', /** * Content policy trace entry is discovery section specific. */ Section: 'Section', /** * Content policy trace entry is specific to a single keyed object (external resource). */ KeyedObject: 'KeyedObject' }, /******************************************************************************* * ReviewRatingAttributeState * Indicates the attribute states of an item. This is a flag only and does not change item functionality, reporting or have any other repercussions. * * Remarks:
*******************************************************************************/ ReviewRatingAttributeState: { /** */ All: 'All', /** */ Active: 'Active', /** */ Inactive: 'Inactive' }, /******************************************************************************* * TagFilterType * Indicates whether all or any matching tags should be used in filtering results. * * Remarks:
*******************************************************************************/ TagFilterType: { /** */ All: 'All', /** */ One: 'One' }, /******************************************************************************* * ScoreSortColumn * Specifies the field in ItemScore used for sorting. * * Remarks:
*******************************************************************************/ ScoreSortColumn: { /** */ DeltaScore: 'DeltaScore', /** */ AbsoluteScore: 'AbsoluteScore', /** */ ScoreCount: 'ScoreCount', /** */ PositiveScore: 'PositiveScore', /** */ PositiveCount: 'PositiveCount', /** */ NegativeScore: 'NegativeScore', /** */ NegativeCount: 'NegativeCount' }, /******************************************************************************* * SortOrder * Specifies the order in which items are displayed. * * Remarks:
*******************************************************************************/ SortOrder: { /** * If chronological, lists oldest first. If alphabetic, lists 9→A. If by column, higher-scored items returned first. */ Ascending: 'Ascending', /** * If chronological, lists newest first. If alphabetic, lists A→9. If by column, lower-scored items returned first. */ Descending: 'Descending' }, /******************************************************************************* * KeyActionType * The type of action taken on a content item. * * Remarks:
*******************************************************************************/ KeyActionType: { /** */ Created: 'Created', /** */ Updated: 'Updated', /** */ Deleted: 'Deleted', /** */ PendingApproval: 'PendingApproval' }, /******************************************************************************* * FriendshipState * Enumerates the friendship state between two Users. * * Remarks:
*******************************************************************************/ FriendshipState: { /** */ Self: 'Self', /** */ Pending: 'Pending', /** */ Friend: 'Friend', /** */ NotFriend: 'NotFriend' }, /******************************************************************************* * ResponseExceptionLevel * The severity of the exception. Error-level exceptions stop processing. * * Remarks:
*******************************************************************************/ ResponseExceptionLevel: { /** * The exception is of the highest severity and has stopped processing. Some errors should be presented to the user, such as when a contribution trips Pluck's flood control. */ Error: 'Error', /** * The exception may indicate a programming problem that could have negative side-effects. */ Warning: 'Warning', /** * The exception is of the lowest severity. */ Info: 'Info' }, /******************************************************************************* * ResponseExceptionCode * Enumerates codes that identify the kind of exception encountered. * * Remarks:
* Includes OK, which indicates that no exception was encountered. *******************************************************************************/ ResponseExceptionCode: { /** * No exception has been encountered. */ OK: 'OK', /** * A required parameter was not specified. */ ValueNullOrMissing: 'ValueNullOrMissing', /** * An action was attempted against a content item that does not allow that action. */ BaseKeyTypeNotSupported: 'BaseKeyTypeNotSupported', /** * The user isn't authenticated and the action isn't allowed for anonymous users. */ AnonymousNotSupported: 'AnonymousNotSupported', /** * A parameter exceeds its range of valid values. */ ValueOutOfRange: 'ValueOutOfRange', /** * The user does not have an email address in the system. Used by EmailContentWithUserIdActionRequest. */ InvalidOrMissingEmailAddress: 'InvalidOrMissingEmailAddress', /** * A property contained an invalid value. */ InvalidValue: 'InvalidValue', /** * The user does not have permission to perform the request. */ UserTierBelowThreshold: 'UserTierBelowThreshold', /** * The request could not be deserialized or reconstructed. */ InvalidOrMalformedRequest: 'InvalidOrMalformedRequest', /** * One or more values in a request group are duplicates, or the user is submitting a second Review on a given Article and Pluck is not configured to allow multiple reviews from the same user. */ DuplicateSubmission: 'DuplicateSubmission', /** * The user is not allowed to perform the requested operation. */ InvalidCredentials: 'InvalidCredentials', /** * The user is not a member of the CommunityGroup specified by the request */ NoMembershipAccessToContent: 'NoMembershipAccessToContent', /** * The executing user has been banned from activity in the target CommunityGroup. */ UserBannedFromGroup: 'UserBannedFromGroup', /** * The user does not have permission in a given CommunityGroup to perform the request. */ MembershipTierBelowThreshold: 'MembershipTierBelowThreshold', /** * The user submission occurred within time limit configured on your server. */ FloodControlTriggered: 'FloodControlTriggered', /** */ LargeActionThresholdTriggered: 'LargeActionThresholdTriggered', /** */ SmallActionThresholdTriggered: 'SmallActionThresholdTriggered', /** */ MetadataFilterTriggered: 'MetadataFilterTriggered', /** * An unexpected error occurred in the request. */ UnhandledException: 'UnhandledException', /** * A requested content item (or the target of an action) exists, but could not be retrieved from the database. */ ObjectPopulationError: 'ObjectPopulationError', /** * A requested content item (or the target of an action) does not exist in the database. */ ObjectNotFoundInStorage: 'ObjectNotFoundInStorage', /** * The requested moderation Queue is empty. */ QueueEmpty: 'QueueEmpty', /** * The request or operation is not supported by the system. */ NotSupported: 'NotSupported', /** * The request was successful but nothing changed. Used by GrantBadgeActionRequest to indicate that the user already has the badge being granted. */ NoOp: 'NoOp', /** * Valid response information returned outside of the KeyAction structure. Currently used to return the friendship status from AddFriendActionRequest, and the enemy status from AddEnemyActionRequest. */ ActionProcessedInfo: 'ActionProcessedInfo', /** * One or more words in the content submitted appear on the list of stop words configured in the CMW. */ DirtyWordFilterTriggered: 'DirtyWordFilterTriggered', /** */ FunctionalityDisabled: 'FunctionalityDisabled' }, /******************************************************************************* * ResponseStatusCode * OK if the request succeeded. Otherwise, indicates where in the processing cycle the error occurred. * * Remarks:
*******************************************************************************/ ResponseStatusCode: { /** * Success. */ OK: 'OK', /** * A request was invalid or incomplete. */ ValidationException: 'ValidationException', /** * An error due to insufficient user priviliges stopped processing. */ SecurityException: 'SecurityException', /** * An error stopped processing in the final phase. */ ProcessingException: 'ProcessingException' }, /******************************************************************************* * ModerationSortOrder * Determines the sort order of items requested from a moderation queue. * * Remarks:
*******************************************************************************/ ModerationSortOrder: { /** */ TimeStampDescending: 'TimeStampDescending', /** */ TimeStampAscending: 'TimeStampAscending', /** */ Weight: 'Weight' }, /******************************************************************************* * ModerationQueueType * Enumerates the types of moderation queues. * * Remarks:
*******************************************************************************/ ModerationQueueType: { /** */ Abuse: 'Abuse', /** */ PreModeration: 'PreModeration', /** */ Spam: 'Spam', /* parse string value to integer value */ fromString: function(s) { return enumSetFromString('ModerationQueueType', s); }, /* convert integer value to string value */ toString: function(v) { return enumSetToString('ModerationQueueType',v); } }, /******************************************************************************* * ModerationNotesActionType * * Remarks:
*******************************************************************************/ ModerationNotesActionType: { /** */ None: 'None', /** */ Approve: 'Approve', /** */ Block: 'Block', /** */ Delete: 'Delete', /** */ All: 'All', /* parse string value to integer value */ fromString: function(s) { return enumSetFromString('ModerationNotesActionType', s); }, /* convert integer value to string value */ toString: function(v) { return enumSetToString('ModerationNotesActionType',v); } }, CURRENT_VERSION: "VersionUnspecified_RevisionUnspecified" }; var enumSetProperties = { 'CommunityGroupUserPrefs': { GroupDigestRunDays: 'DaysOfWeek' }, 'ModerationQueueConfiguration': { Type: 'ModerationQueueType', RequiredNoteActions: 'ModerationNotesActionType' }, 'UpdateCommunityGroupUserPrefsActionRequest': { GroupDigestRunDays: 'DaysOfWeek' }, 'CommunityFeedRequest': { FeedActivityTypes: 'FeedActivityTypes' }, 'DiscoverContentActionRequest': { Activity: 'DiscoveryActivity' }, 'FriendFeedPageRequest': { IncludeTypes: 'FeedActivityTypes' }, 'UserFeedPageRequest': { IncludeTypes: 'FeedActivityTypes' }, 'DiscoverContentResponse': { Activity: 'DiscoveryActivity' }, 'CommunityFeedResponse': { FeedActivityTypes: 'FeedActivityTypes' }, '_': {} }; function isEnumSetProperty(classname, propname) { classname = classname.split('.').pop() if (enumSetProperties.hasOwnProperty(classname)) { if (enumSetProperties[classname].hasOwnProperty(propname)) { return enumSetProperties[classname][propname]; } } return null; } function enumSetToString(enumType, value) { if (enumType && value) { enumType = enumType.split('.').pop() if (isString(value)) { if (parseInt(value).toString() == value) { value = parseInt(value); } } if (enumType == 'DaysOfWeek') { if (0 == value) return 'None'; if (1 == value) return 'Sunday'; if (2 == value) return 'Monday'; if (4 == value) return 'Tuesday'; if (8 == value) return 'Wednesday'; if (16 == value) return 'Thursday'; if (32 == value) return 'Friday'; if (64 == value) return 'Saturday'; if (127 == value) return 'All'; var v = []; if (0 == (0 & value)) v.push('None'); if (1 == (1 & value)) v.push('Sunday'); if (2 == (2 & value)) v.push('Monday'); if (4 == (4 & value)) v.push('Tuesday'); if (8 == (8 & value)) v.push('Wednesday'); if (16 == (16 & value)) v.push('Thursday'); if (32 == (32 & value)) v.push('Friday'); if (64 == (64 & value)) v.push('Saturday'); if (127 == (127 & value)) v.push('All'); return v.join(","); } if (enumType == 'FeedActivityTypes') { if (1 == value) return 'Comment'; if (2 == value) return 'Review'; if (4 == value) return 'BlogPost'; if (8 == value) return 'ForumPost'; if (16 == value) return 'Photo'; if (32 == value) return 'Video'; if (64 == value) return 'Discussions'; if (127 == value) return 'AllCommunity'; if (128 == value) return 'CustomItem'; if (256 == value) return 'WallPost'; if (512 == value) return 'Badge'; if (1024 == value) return 'CommunityGroupMembership'; if (2048 == value) return 'CustomActivity'; if (4096 == value) return 'Event'; if (8192 == value) return 'UserStatus'; if (16384 == value) return 'Message'; if (32767 == value) return 'All'; var v = []; if (1 == (1 & value)) v.push('Comment'); if (2 == (2 & value)) v.push('Review'); if (4 == (4 & value)) v.push('BlogPost'); if (8 == (8 & value)) v.push('ForumPost'); if (16 == (16 & value)) v.push('Photo'); if (32 == (32 & value)) v.push('Video'); if (64 == (64 & value)) v.push('Discussions'); if (127 == (127 & value)) v.push('AllCommunity'); if (128 == (128 & value)) v.push('CustomItem'); if (256 == (256 & value)) v.push('WallPost'); if (512 == (512 & value)) v.push('Badge'); if (1024 == (1024 & value)) v.push('CommunityGroupMembership'); if (2048 == (2048 & value)) v.push('CustomActivity'); if (4096 == (4096 & value)) v.push('Event'); if (8192 == (8192 & value)) v.push('UserStatus'); if (16384 == (16384 & value)) v.push('Message'); if (32767 == (32767 & value)) v.push('All'); return v.join(","); } if (enumType == 'DiscoveryActivity') { if (1 == value) return 'Commented'; if (2 == value) return 'Rated'; if (4 == value) return 'Recent'; if (8 == value) return 'Recommended'; if (16 == value) return 'Reviewed'; if (32 == value) return 'MostActive'; if (64 == value) return 'MostViewed'; if (128 == value) return 'LeastViewed'; if (256 == value) return 'Created'; var v = []; if (1 == (1 & value)) v.push('Commented'); if (2 == (2 & value)) v.push('Rated'); if (4 == (4 & value)) v.push('Recent'); if (8 == (8 & value)) v.push('Recommended'); if (16 == (16 & value)) v.push('Reviewed'); if (32 == (32 & value)) v.push('MostActive'); if (64 == (64 & value)) v.push('MostViewed'); if (128 == (128 & value)) v.push('LeastViewed'); if (256 == (256 & value)) v.push('Created'); return v.join(","); } if (enumType == 'ModerationQueueType') { if (1 == value) return 'Abuse'; if (2 == value) return 'PreModeration'; if (4 == value) return 'Spam'; var v = []; if (1 == (1 & value)) v.push('Abuse'); if (2 == (2 & value)) v.push('PreModeration'); if (4 == (4 & value)) v.push('Spam'); return v.join(","); } if (enumType == 'ModerationNotesActionType') { if (0 == value) return 'None'; if (1 == value) return 'Approve'; if (2 == value) return 'Block'; if (4 == value) return 'Delete'; if (7 == value) return 'All'; var v = []; if (0 == (0 & value)) v.push('None'); if (1 == (1 & value)) v.push('Approve'); if (2 == (2 & value)) v.push('Block'); if (4 == (4 & value)) v.push('Delete'); if (7 == (7 & value)) v.push('All'); return v.join(","); } } return null; } function enumSetFromString(enumType, value) { if (enumType && value) { enumType = enumType.split('.').pop() if (!isString(value)) { return value; } if (enumType == 'DaysOfWeek') { var v = 0; var values = value.split(','); for (var i=0; i= 1.05 && document.location.toString().toLowerCase().indexOf('firebug=false') < 0) { firebug = console.group && console.groupEnd && console.dir; } } catch (e) { } } debugging = true; return function(data) { if (window.opera) { opera.postError(data); } else if (window.console && window.console.log) { console.log(data); } }; } return function(data){}; })(); var flashProxy = null; var flashReady = false; var isIE = (navigator.userAgent.indexOf('MSIE')!= -1 && navigator.userAgent.indexOf('Opera') == -1); var jsonpmax = isIE ? 2000 : 4000; jsonpmax = typeof PLUCKSDK_JSONPMAX !== 'undefined' ? PLUCKSDK_JSONPMAX : jsonpmax; var m = document.location.toString().match(/PLUCKSDK_JSONPMAX=([0-9]+)/); if (m && m.length > 0) { jsonpmax = m[1]; } var flashVersion = (function() { var versionNumber = 0; try { // do ie compatible check if (isIE) { try { activeXObject = new ActiveXObject('ShockwaveFlash.ShockwaveFlash'); versionVariable = activeXObject.GetVariable('$version'); versionNumber = versionVariable.match(/win[^\d]+?(\d+)[^\d].*/i)[1]; } catch(e) { } } // Check browsers that use navigator. They will look something like this: "Shockwave Flash 10.0 r12" for (var i=0; i versionNumber) { versionNumber = version; } } } } catch(e) { } return versionNumber; })(); var flashInstalled = flashVersion >= 9; function addUrlParam(url, param) { return url + (url.indexOf('?') > 0 ? '&' : '?') + param; } function getSafeEmbedSWFHTML(swfId, swfUrl, width, height, flashvars, version) { var ie=(navigator.userAgent.indexOf('MSIE')!= -1 && navigator.userAgent.indexOf('Opera') == -1); if (ie) { return ' '; } else { return ''; } } // this function is here because using swfobject caused a crash in IE on successive refreshes and ctrl-refreshes during page unload - this doesn't function safeEmbedSWF(hostObj, swfId, swfUrl, width, height, flashvars, version) { hostObj.innerHTML = getSafeEmbedSWFHTML(swfId, swfUrl, width, height, flashvars, version); } var flashRequestQueue = []; function flashProcessQueue() { if (flashRequestQueue.length > 0) { if (loadFlashTunnel()) { while (flashRequestQueue.length > 0) { var context = flashRequestQueue.shift(); flashProxy.CallDAPI(context.url, context.request, 'PluckSDKflcb', context.asyncToken, document.location.toString()); } } } } function flashReadyCallback(){ var proxy = document.getElementById('PluckSDKflashProxy'); if (proxy != null && typeof(proxy.CallDAPI) !== 'undefined') { flashProxy = proxy; flashReady = true; flashProcessQueue(); } } function flashStatusCallback(status){ debug('pluck flash proxy status: '+status); } function addLoadEvent(func) { if (window.addEventListener) window.addEventListener('load', func, false); else if (window.attachEvent) window.attachEvent('onload', func); else { debug('pluck addLoadEvent failure'); } } var flashTunnelRequested = 0; function __loadFlashTunnel() { // create a placeholder for the flash tunnel on the page var flashObject = document.body.appendChild(document.createElement('div')); flashObject.id = 'PluckSDKflashProxyDIV'; // load the flash tunnel var swfUrl = flashTunnelUrl; var swfId = 'PluckSDKflashProxy'; var swfWidth = '0'; var swfHeight = '0'; var swfVersion = '9.0.0'; var params = { autostart: 'true', width: swfWidth, height: swfHeight, allowFullScreen: 'true', allowScriptAccess: 'always' }; var attributes = {}; // register us as an instance so we are ready when flash tries to call us back window['PluckSDKflashready'] = function() { flashReadyCallback(); }; window['PluckSDKflashstatus'] = function(status) { flashStatusCallback(status); }; var fvars = 'onLoadCallbackName=PluckSDKflashready&onStatusCallbackName=PluckSDKflashstatus&podRevisionNumber=0'; safeEmbedSWF(flashObject, swfId, swfUrl, swfWidth, swfHeight, fvars, swfVersion); return false; } function loadFlashTunnel() { if (!flashReady && flashInstalled) { flashTunnelRequested++; if (flashTunnelRequested <= 1) { if (document.body && ((typeof document.readyState == 'undefined') || /loaded|complete/.test(document.readyState))) { // setup the proxy __loadFlashTunnel(); } else { addLoadEvent(__loadFlashTunnel); } } } return flashReady; } var callbackContexts = {}; var callbackContextCount = 0; function registerCallbackContext(context){ var asyncToken = 'request_' + callbackContextCount++; callbackContexts[asyncToken] = context; return asyncToken; } var datetimePrefix = "@datetime|"; function fixupStringDatesToDateObjects(obj) { for (var p in obj) { if (obj.hasOwnProperty(p)) { if (typeof obj[p] === "string") { if (0 == obj[p].indexOf(datetimePrefix)) { try { obj[p] = new Date(obj[p].substr(datetimePrefix.length)); } catch(e) {} } } else if (isObject(obj[p])) { fixupStringDatesToDateObjects(obj[p]); } else if (isArray(obj[p])) { for (var i=0; i jsonpChunkingRequestMax) { // if no flash, show debug message of failure if (!flashInstalled) { debug('pluck jsonp request size exceeded '+jsonpChunkingRequestMax+' limit'); } return false; } // jsonp chunking is needed - if flash is installed and ready, fail over to flash for better performance if (flashInstalled) { if (flashReady) { return false; } // installed but not ready - load async and continue with jsonp chunking until ready loadFlashTunnel(); } // doing jsonp junking context.bypassBrowserCaching = true; var chunks = []; while (jsonRequest.length > 0) { var chunk = ""; var chunkEncoded = ""; var chunk = jsonRequest.substr(0, maxRequest); var chunkEncoded = encodeURIComponent(chunk); while (chunkEncoded.length > maxRequest) { // Chunk is too big after encoding. var chunkDiff = chunkEncoded.length - maxRequest; chunk = jsonRequest.substr(0, chunk.length - chunkDiff); chunkEncoded = encodeURIComponent(chunk); } chunks.push(chunkEncoded); jsonRequest = jsonRequest.substr(chunk.length); } context["chunking"] = { "chunkToken": "i", "chunks": chunks }; transmitJsonp(context); return true; } function sendRequests(requests, callback, options) { if (requests == null) { callback(null, 'PluckSDK.SendRequests received an empty array of requests'); return null; } if (requests.constructor != Array) { // handle single requests gracefully requests = [requests]; } if (requests.length == 0) { callback(null, 'PluckSDK.SendRequests received an empty array of requests'); return null; } for (var i=0; i