TypePad/Groups.pm

filter: Statementstmt 10.1% 17 / 167 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 12.2% 5 / 41 Podpod 61.1% 22 / 36 totaltotal 18.0% 44 / 244 CC 1 SCAR 6.3
CC
1
Cov
10%
groups
2.0
get
2.0
add_member
2.0
CRAP 1.9
« TypePad/Blogs.pm ↑ Summary TypePad/Assets.pm »
1 package WWW::TypePad::Groups;
2  
3 1 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
5  
6 # Install an accessor into WWW::TypePad to access an instance of this class
7 # bound to the WWW::TypePad instance.
8 0 ▶sub WWW::TypePad::groups { __PACKAGE__->new( base => $_[0] ) }
Subroutine groups: not called CC=1 SCAR=6.9
Pod undocumented
9  
10 ### BEGIN auto-generated
11 ### This is an automatically generated code, do not edit!
12 ### Scroll down to look for END to add additional methods
13  
14 =pod
15  
16 =head1 NAME
17  
18 WWW::TypePad::Groups - Groups API methods
19  
20 =head1 METHODS
21  
22 =cut
23  
24 1 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
25 1 ▶use Any::Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
26 1 extends 'WWW::TypePad::Noun';
27  
28 1 ▶use Carp ();
Subroutine BEGIN: called CC=1 SCAR=0.0
29  
30  
31 =pod
32  
33 =over 4
34  
35  
36 =item get
37  
38 my $res = $tp->groups->get($id);
39  
40 Get basic information about the selected group.
41  
42 Returns Group which contains following properties.
43  
44 =over 8
45  
46 =item displayName
47  
48 (string) The display name set by the group's owner.
49  
50 =item tagline
51  
52 (string) A tagline describing the group, as set by the group's owner.
53  
54 =item objectTypes
55  
56 (setE<lt>stringE<gt>) BE<lt>DeprecatedE<gt> An array of object type identifier URIs.
57  
58 =item objectType
59  
60 (string) A keyword describing the type of this object. For a group object, ME<lt>objectTypeE<gt> will be CE<lt>GroupE<gt>.
61  
62 =item avatarLink
63  
64 (ImageLink) A link to an image representing this group.
65  
66 =item siteUrl
67  
68 (string) The URL to the front page of the group website.
69  
70 =item id
71  
72 (string) A URI that serves as a globally unique identifier for the object.
73  
74 =item urlId
75  
76 (string) A string containing the canonical identifier that can be used to identify this object in URLs. This can be used to recognise where the same user is returned in response to different requests, and as a mapping key for an application's local data store.
77  
78  
79 =back
80  
81 =cut
82  
83 0 ▶sub get {
Subroutine get: not called CC=1 SCAR=6.9
Pod documented
84 0 my $api = shift;
85 0 my @args;
86 0 push @args, shift; # id
87 0 my $uri = sprintf '/groups/%s.json', @args;
88 0 $api->base->call("GET", $uri, @_);
89 }
90  
91  
92 =pod
93  
94  
95  
96 =item add_member
97  
98 my $res = $tp->groups->add_member($id);
99  
100 Add a given user as a member of the selected group.
101  
102 Returns hash reference which contains following properties.
103  
104 =over 8
105  
106  
107 =back
108  
109 =cut
110  
111 0 ▶sub add_member {
Subroutine add_member: not called CC=1 SCAR=6.9
Pod documented
112 0 my $api = shift;
113 0 my @args;
114 0 push @args, shift; # id
115 0 my $uri = sprintf '/groups/%s/add-member.json', @args;
116 0 $api->base->call("POST", $uri, @_);
117 }
118  
119  
120 =pod
121  
122  
123  
124 =item post_to_audio_assets
125  
126 my $res = $tp->groups->post_to_audio_assets($id);
127  
128 Create a new Audio asset within the selected group.
129  
130 Returns Audio which contains following properties.
131  
132 =over 8
133  
134 =item audioLink
135  
136 (AudioLink) BE<lt>Read OnlyE<gt> A link to the audio stream that is this Audio asset's content.
137  
138 =item suppressEvents
139  
140 (boolean) BE<lt>Write OnlyE<gt> An optional, write-only flag indicating that asset creation should not trigger notification events such as emails or dashboard entries. Not available to all applications.
141  
142 =item id
143  
144 (string) BE<lt>Read OnlyE<gt> A URI that serves as a globally unique identifier for the user.
145  
146 =item urlId
147  
148 (string) BE<lt>Read OnlyE<gt> A string containing the canonical identifier that can be used to identify this object in URLs. This can be used to recognise where the same user is returned in response to different requests, and as a mapping key for an application's local data store.
149  
150 =item permalinkUrl
151  
152 (string) BE<lt>Read OnlyE<gt> The URL that is this asset's permalink. This will be omitted if the asset does not have a permalink of its own (for example, if it's embedded in another asset) or if TypePad does not know its permalink.
153  
154 =item shortUrl
155  
156 (string) BE<lt>Read OnlyE<gt> The short version of the URL that is this asset's permalink. This is currently available only for OE<lt>PostE<gt> assetes.
157  
158 =item author
159  
160 (User) BE<lt>Read OnlyE<gt> The user who created the selected asset.
161  
162 =item published
163  
164 (datetime) BE<lt>Read OnlyE<gt> The time at which the asset was created, as a W3CDTF timestamp.
165  
166 =item content
167  
168 (string) The raw asset content. The ME<lt>textFormatE<gt> property describes how to format this data. Use this property to set the asset content in write operations. An asset posted in a group may have a ME<lt>contentE<gt> value up to 10,000 bytes long, while a OE<lt>PostE<gt> asset in a blog may have up to 65,000 bytes of content.
169  
170 =item renderedContent
171  
172 (string) BE<lt>Read OnlyE<gt> The content of this asset rendered to HTML. This is currently available only for OE<lt>PostE<gt> and OE<lt>PageE<gt> assets.
173  
174 =item excerpt
175  
176 (string) BE<lt>Read OnlyE<gt> A short, plain-text excerpt of the entry content. This is currently available only for OE<lt>PostE<gt> assets.
177  
178 =item textFormat
179  
180 (string) A keyword that indicates what formatting mode to use for the content of this asset. This can be CE<lt>htmlE<gt> for assets the content of which is HTML, CE<lt>html_convert_linebreaksE<gt> for assets the content of which is HTML but where paragraph tags should be added automatically, or CE<lt>markdownE<gt> for assets the content of which is Markdown source. Other formatting modes may be added in future. Applications that present assets for editing should use this property to present an appropriate editor.
181  
182 =item groups
183  
184 (arrayE<lt>stringE<gt>) BE<lt>Read OnlyE<gt> BE<lt>DeprecatedE<gt> An array of strings containing the ME<lt>idE<gt> URI of the OE<lt>GroupE<gt> object that this asset is mapped into, if any. This property has been superseded by the ME<lt>containerE<gt> property.
185  
186 =item source
187  
188 (AssetSource) BE<lt>Read OnlyE<gt> An object describing the site from which this asset was retrieved, if the asset was obtained from an external source.
189  
190 =item objectTypes
191  
192 (setE<lt>stringE<gt>) BE<lt>Read OnlyE<gt> BE<lt>DeprecatedE<gt> An array of object type identifier URIs identifying the type of this asset. Only the one object type URI for the particular type of asset this asset is will be present.
193  
194 =item objectType
195  
196 (string) BE<lt>Read OnlyE<gt> The keyword identifying the type of asset this is.
197  
198 =item isFavoriteForCurrentUser
199  
200 (boolean) BE<lt>Read OnlyE<gt> CE<lt>trueE<gt> if this asset is a favorite for the currently authenticated user, or CE<lt>falseE<gt> otherwise. This property is omitted from responses to anonymous requests.
201  
202 =item favoriteCount
203  
204 (integer) BE<lt>Read OnlyE<gt> The number of distinct users who have added this asset as a favorite.
205  
206 =item commentCount
207  
208 (integer) BE<lt>Read OnlyE<gt> The number of comments that have been posted in reply to this asset. This number includes comments that have been posted in response to other comments.
209  
210 =item title
211  
212 (string) The title of the asset.
213  
214 =item description
215  
216 (string) The description of the asset.
217  
218 =item container
219  
220 (ContainerRef) BE<lt>Read OnlyE<gt> An object describing the group or blog to which this asset belongs.
221  
222 =item publicationStatus
223  
224 (PublicationStatus) An object describing the visibility status and publication date for this asset. Only visibility status is editable.
225  
226 =item crosspostAccounts
227  
228 (setE<lt>stringE<gt>) BE<lt>Write OnlyE<gt> A set of identifiers for OE<lt>AccountE<gt> objects to which to crosspost this asset when it's posted. This property is omitted when retrieving existing assets.
229  
230 =item isConversationsAnswer
231  
232 (boolean) BE<lt>Read OnlyE<gt> BE<lt>DeprecatedE<gt> CE<lt>trueE<gt> if this asset is an answer to a TypePad Conversations question, or absent otherwise. This property is deprecated and will be replaced with something more useful in future.
233  
234 =item reblogOf
235  
236 (AssetRef) BE<lt>Read OnlyE<gt> BE<lt>DeprecatedE<gt> If this asset was created by 'reblogging' another asset, this property describes the original asset.
237  
238 =item reblogOfUrl
239  
240 (string) BE<lt>Read OnlyE<gt> BE<lt>DeprecatedE<gt> If this asset was created by 'reblogging' another asset or some other arbitrary web page, this property contains the URL of the item that was reblogged.
241  
242 =item positiveVoteCount
243  
244 (integer) BE<lt>Read OnlyE<gt> The total number of positive votes this asset has received via the NE<lt>/assets/{id}/cast-positive-voteE<gt> endpoint.
245  
246 =item negativeVoteCount
247  
248 (integer) BE<lt>Read OnlyE<gt> The total number of negative votes this asset has received via the NE<lt>/assets/{id}/cast-negative-voteE<gt> endpoint.
249  
250 =item hasExtendedContent
251  
252 (boolean) BE<lt>Read OnlyE<gt> CE<lt>trueE<gt> if this asset has the extended content. This is currently supported only for OE<lt>PostE<gt> assets that are posted within a blog.
253  
254  
255 =back
256  
257 =cut
258  
259 0 ▶sub post_to_audio_assets {
Subroutine post_to_audio_assets: not called CC=1 SCAR=6.9
Pod documented
260 0 my $api = shift;
261 0 my @args;
262 0 push @args, shift; # id
263 0 my $uri = sprintf '/groups/%s/audio-assets.json', @args;
264 0 $api->base->call("POST", $uri, @_);
265 }
266  
267  
268 =pod
269  
270  
271  
272 =item get_audio_assets
273  
274 my $res = $tp->groups->get_audio_assets($id);
275  
276 Get a list of recently created Audio assets from the selected group.
277  
278 Returns ListE<lt>AudioE<gt> which contains following properties.
279  
280 =over 8
281  
282 =item totalResults
283  
284 (integer) The total number of items in the whole list of which this list object is a paginated view.
285  
286 =item entries
287  
288 (arrayE<lt>AudioE<gt>) The items within the selected slice of the list.
289  
290  
291 =back
292  
293 =cut
294  
295 0 ▶sub get_audio_assets {
Subroutine get_audio_assets: not called CC=1 SCAR=6.9
Pod documented
296 0 my $api = shift;
297 0 my @args;
298 0 push @args, shift; # id
299 0 my $uri = sprintf '/groups/%s/audio-assets.json', @args;
300 0 $api->base->call("GET", $uri, @_);
301 }
302  
303  
304 0 ▶sub audio_assets {
Subroutine audio_assets: not called CC=1 SCAR=6.9
Pod undocumented
305 0 my $self = shift;
306 0 Carp::carp("'audio_assets' is deprecated. Use 'get_audio_assets' instead.");
307 0 $self->get_audio_assets(@_);
308 }
309  
310 =pod
311  
312  
313  
314 =item block_user
315  
316 my $res = $tp->groups->block_user($id);
317  
318 Block the given user from joining the selected group, removing that user as a member in the process.
319  
320 Returns hash reference which contains following properties.
321  
322 =over 8
323  
324  
325 =back
326  
327 =cut
328  
329 0 ▶sub block_user {
Subroutine block_user: not called CC=1 SCAR=6.9
Pod documented
330 0 my $api = shift;
331 0 my @args;
332 0 push @args, shift; # id
333 0 my $uri = sprintf '/groups/%s/block-user.json', @args;
334 0 $api->base->call("POST", $uri, @_);
335 }
336  
337  
338 =pod
339  
340  
341  
342 =item create_external_feed_subscription
343  
344 my $res = $tp->groups->create_external_feed_subscription($id);
345  
346 Subscribe the group to one or more external feeds.
347  
348 Returns hash reference which contains following properties.
349  
350 =over 8
351  
352 =item subscription
353  
354 (ExternalFeedSubscription) The subscription object that was created.
355  
356  
357 =back
358  
359 =cut
360  
361 0 ▶sub create_external_feed_subscription {
Subroutine create_external_feed_subscription: not called CC=1 SCAR=6.9
Pod documented
362 0 my $api = shift;
363 0 my @args;
364 0 push @args, shift; # id
365 0 my $uri = sprintf '/groups/%s/create-external-feed-subscription.json', @args;
366 0 $api->base->call("POST", $uri, @_);
367 }
368  
369  
370 =pod
371  
372  
373  
374 =item get_events
375  
376 my $res = $tp->groups->get_events($id);
377  
378 Get a list of events describing actions performed in the selected group.
379  
380 Returns ListE<lt>EventE<gt> which contains following properties.
381  
382 =over 8
383  
384 =item totalResults
385  
386 (integer) The total number of items in the whole list of which this list object is a paginated view.
387  
388 =item entries
389  
390 (arrayE<lt>EventE<gt>) The items within the selected slice of the list.
391  
392  
393 =back
394  
395 =cut
396  
397 0 ▶sub get_events {
Subroutine get_events: not called CC=1 SCAR=6.9
Pod documented
398 0 my $api = shift;
399 0 my @args;
400 0 push @args, shift; # id
401 0 my $uri = sprintf '/groups/%s/events.json', @args;
402 0 $api->base->call("GET", $uri, @_);
403 }
404  
405  
406 0 ▶sub events {
Subroutine events: not called CC=1 SCAR=6.9
Pod undocumented
407 0 my $self = shift;
408 0 Carp::carp("'events' is deprecated. Use 'get_events' instead.");
409 0 $self->get_events(@_);
410 }
411  
412 =pod
413  
414  
415  
416 =item get_external_feed_subscriptions
417  
418 my $res = $tp->groups->get_external_feed_subscriptions($id);
419  
420 Get a list of the group's active external feed subscriptions.
421  
422 Returns ListE<lt>ExternalFeedSubscriptionE<gt> which contains following properties.
423  
424 =over 8
425  
426 =item totalResults
427  
428 (integer) The total number of items in the whole list of which this list object is a paginated view.
429  
430 =item entries
431  
432 (arrayE<lt>ExternalFeedSubscriptionE<gt>) The items within the selected slice of the list.
433  
434  
435 =back
436  
437 =cut
438  
439 0 ▶sub get_external_feed_subscriptions {
Subroutine get_external_feed_subscriptions: not called CC=1 SCAR=6.9
Pod documented
440 0 my $api = shift;
441 0 my @args;
442 0 push @args, shift; # id
443 0 my $uri = sprintf '/groups/%s/external-feed-subscriptions.json', @args;
444 0 $api->base->call("GET", $uri, @_);
445 }
446  
447  
448 0 ▶sub external_feed_subscriptions {
Subroutine external_feed_subscriptions: not called CC=1 SCAR=6.9
Pod undocumented
449 0 my $self = shift;
450 0 Carp::carp("'external_feed_subscriptions' is deprecated. Use 'get_external_feed_subscriptions' instead.");
451 0 $self->get_external_feed_subscriptions(@_);
452 }
453  
454 =pod
455  
456  
457  
458 =item post_to_link_assets
459  
460 my $res = $tp->groups->post_to_link_assets($id);
461  
462 Create a new Link asset within the selected group.
463  
464 Returns Link which contains following properties.
465  
466 =over 8
467  
468 =item targetUrl
469  
470 (string) The URL that is the target of this link.
471  
472 =item suppressEvents
473  
474 (boolean) BE<lt>Write OnlyE<gt> An optional, write-only flag indicating that asset creation should not trigger notification events such as emails or dashboard entries. Not available to all applications.
475  
476 =item id
477  
478 (string) BE<lt>Read OnlyE<gt> A URI that serves as a globally unique identifier for the user.
479  
480 =item urlId
481  
482 (string) BE<lt>Read OnlyE<gt> A string containing the canonical identifier that can be used to identify this object in URLs. This can be used to recognise where the same user is returned in response to different requests, and as a mapping key for an application's local data store.
483  
484 =item permalinkUrl
485  
486 (string) BE<lt>Read OnlyE<gt> The URL that is this asset's permalink. This will be omitted if the asset does not have a permalink of its own (for example, if it's embedded in another asset) or if TypePad does not know its permalink.
487  
488 =item shortUrl
489  
490 (string) BE<lt>Read OnlyE<gt> The short version of the URL that is this asset's permalink. This is currently available only for OE<lt>PostE<gt> assetes.
491  
492 =item author
493  
494 (User) BE<lt>Read OnlyE<gt> The user who created the selected asset.
495  
496 =item published
497  
498 (datetime) BE<lt>Read OnlyE<gt> The time at which the asset was created, as a W3CDTF timestamp.
499  
500 =item content
501  
502 (string) The raw asset content. The ME<lt>textFormatE<gt> property describes how to format this data. Use this property to set the asset content in write operations. An asset posted in a group may have a ME<lt>contentE<gt> value up to 10,000 bytes long, while a OE<lt>PostE<gt> asset in a blog may have up to 65,000 bytes of content.
503  
504 =item renderedContent
505  
506 (string) BE<lt>Read OnlyE<gt> The content of this asset rendered to HTML. This is currently available only for OE<lt>PostE<gt> and OE<lt>PageE<gt> assets.
507  
508 =item excerpt
509  
510 (string) BE<lt>Read OnlyE<gt> A short, plain-text excerpt of the entry content. This is currently available only for OE<lt>PostE<gt> assets.
511  
512 =item textFormat
513  
514 (string) A keyword that indicates what formatting mode to use for the content of this asset. This can be CE<lt>htmlE<gt> for assets the content of which is HTML, CE<lt>html_convert_linebreaksE<gt> for assets the content of which is HTML but where paragraph tags should be added automatically, or CE<lt>markdownE<gt> for assets the content of which is Markdown source. Other formatting modes may be added in future. Applications that present assets for editing should use this property to present an appropriate editor.
515  
516 =item groups
517  
518 (arrayE<lt>stringE<gt>) BE<lt>Read OnlyE<gt> BE<lt>DeprecatedE<gt> An array of strings containing the ME<lt>idE<gt> URI of the OE<lt>GroupE<gt> object that this asset is mapped into, if any. This property has been superseded by the ME<lt>containerE<gt> property.
519  
520 =item source
521  
522 (AssetSource) BE<lt>Read OnlyE<gt> An object describing the site from which this asset was retrieved, if the asset was obtained from an external source.
523  
524 =item objectTypes
525  
526 (setE<lt>stringE<gt>) BE<lt>Read OnlyE<gt> BE<lt>DeprecatedE<gt> An array of object type identifier URIs identifying the type of this asset. Only the one object type URI for the particular type of asset this asset is will be present.
527  
528 =item objectType
529  
530 (string) BE<lt>Read OnlyE<gt> The keyword identifying the type of asset this is.
531  
532 =item isFavoriteForCurrentUser
533  
534 (boolean) BE<lt>Read OnlyE<gt> CE<lt>trueE<gt> if this asset is a favorite for the currently authenticated user, or CE<lt>falseE<gt> otherwise. This property is omitted from responses to anonymous requests.
535  
536 =item favoriteCount
537  
538 (integer) BE<lt>Read OnlyE<gt> The number of distinct users who have added this asset as a favorite.
539  
540 =item commentCount
541  
542 (integer) BE<lt>Read OnlyE<gt> The number of comments that have been posted in reply to this asset. This number includes comments that have been posted in response to other comments.
543  
544 =item title
545  
546 (string) The title of the asset.
547  
548 =item description
549  
550 (string) The description of the asset.
551  
552 =item container
553  
554 (ContainerRef) BE<lt>Read OnlyE<gt> An object describing the group or blog to which this asset belongs.
555  
556 =item publicationStatus
557  
558 (PublicationStatus) An object describing the visibility status and publication date for this asset. Only visibility status is editable.
559  
560 =item crosspostAccounts
561  
562 (setE<lt>stringE<gt>) BE<lt>Write OnlyE<gt> A set of identifiers for OE<lt>AccountE<gt> objects to which to crosspost this asset when it's posted. This property is omitted when retrieving existing assets.
563  
564 =item isConversationsAnswer
565  
566 (boolean) BE<lt>Read OnlyE<gt> BE<lt>DeprecatedE<gt> CE<lt>trueE<gt> if this asset is an answer to a TypePad Conversations question, or absent otherwise. This property is deprecated and will be replaced with something more useful in future.
567  
568 =item reblogOf
569  
570 (AssetRef) BE<lt>Read OnlyE<gt> BE<lt>DeprecatedE<gt> If this asset was created by 'reblogging' another asset, this property describes the original asset.
571  
572 =item reblogOfUrl
573  
574 (string) BE<lt>Read OnlyE<gt> BE<lt>DeprecatedE<gt> If this asset was created by 'reblogging' another asset or some other arbitrary web page, this property contains the URL of the item that was reblogged.
575  
576 =item positiveVoteCount
577  
578 (integer) BE<lt>Read OnlyE<gt> The total number of positive votes this asset has received via the NE<lt>/assets/{id}/cast-positive-voteE<gt> endpoint.
579  
580 =item negativeVoteCount
581  
582 (integer) BE<lt>Read OnlyE<gt> The total number of negative votes this asset has received via the NE<lt>/assets/{id}/cast-negative-voteE<gt> endpoint.
583  
584 =item hasExtendedContent
585  
586 (boolean) BE<lt>Read OnlyE<gt> CE<lt>trueE<gt> if this asset has the extended content. This is currently supported only for OE<lt>PostE<gt> assets that are posted within a blog.
587  
588  
589 =back
590  
591 =cut
592  
593 0 ▶sub post_to_link_assets {
Subroutine post_to_link_assets: not called CC=1 SCAR=6.9
Pod documented
594 0 my $api = shift;
595 0 my @args;
596 0 push @args, shift; # id
597 0 my $uri = sprintf '/groups/%s/link-assets.json', @args;
598 0 $api->base->call("POST", $uri, @_);
599 }
600  
601  
602 =pod
603  
604  
605  
606 =item get_link_assets
607  
608 my $res = $tp->groups->get_link_assets($id);
609  
610 Returns a list of recently created Link assets from the selected group.
611  
612 Returns ListE<lt>LinkE<gt> which contains following properties.
613  
614 =over 8
615  
616 =item totalResults
617  
618 (integer) The total number of items in the whole list of which this list object is a paginated view.
619  
620 =item entries
621  
622 (arrayE<lt>LinkE<gt>) The items within the selected slice of the list.
623  
624  
625 =back
626  
627 =cut
628  
629 0 ▶sub get_link_assets {
Subroutine get_link_assets: not called CC=1 SCAR=6.9
Pod documented
630 0 my $api = shift;
631 0 my @args;
632 0 push @args, shift; # id
633 0 my $uri = sprintf '/groups/%s/link-assets.json', @args;
634 0 $api->base->call("GET", $uri, @_);
635 }
636  
637  
638 0 ▶sub link_assets {
Subroutine link_assets: not called CC=1 SCAR=6.9
Pod undocumented
639 0 my $self = shift;
640 0 Carp::carp("'link_assets' is deprecated. Use 'get_link_assets' instead.");
641 0 $self->get_link_assets(@_);
642 }
643  
644 =pod
645  
646  
647  
648 =item get_memberships
649  
650 my $res = $tp->groups->get_memberships($id);
651  
652 Get a list of relationships between users and the selected group.
653  
654 Returns ListE<lt>RelationshipE<gt> which contains following properties.
655  
656 =over 8
657  
658 =item totalResults
659  
660 (integer) The total number of items in the whole list of which this list object is a paginated view.
661  
662 =item entries
663  
664 (arrayE<lt>RelationshipE<gt>) The items within the selected slice of the list.
665  
666  
667 =back
668  
669 =cut
670  
671 0 ▶sub get_memberships {
Subroutine get_memberships: not called CC=1 SCAR=6.9
Pod documented
672 0 my $api = shift;
673 0 my @args;
674 0 push @args, shift; # id
675 0 my $uri = sprintf '/groups/%s/memberships.json', @args;
676 0 $api->base->call("GET", $uri, @_);
677 }
678  
679  
680 0 ▶sub memberships {
Subroutine memberships: not called CC=1 SCAR=6.9
Pod undocumented
681 0 my $self = shift;
682 0 Carp::carp("'memberships' is deprecated. Use 'get_memberships' instead.");
683 0 $self->get_memberships(@_);
684 }
685  
686 =pod
687  
688  
689  
690 =item get_admin_memberships
691  
692 my $res = $tp->groups->get_admin_memberships($id);
693  
694 Get a list of relationships that have the Admin type between users and the selected group.
695  
696 Returns ListE<lt>RelationshipE<gt> which contains following properties.
697  
698 =over 8
699  
700 =item totalResults
701  
702 (integer) The total number of items in the whole list of which this list object is a paginated view.
703  
704 =item entries
705  
706 (arrayE<lt>RelationshipE<gt>) The items within the selected slice of the list.
707  
708  
709 =back
710  
711 =cut
712  
713 0 ▶sub get_admin_memberships {
Subroutine get_admin_memberships: not called CC=1 SCAR=6.9
Pod documented
714 0 my $api = shift;
715 0 my @args;
716 0 push @args, shift; # id
717 0 my $uri = sprintf '/groups/%s/memberships/@admin.json', @args;
718 0 $api->base->call("GET", $uri, @_);
719 }
720  
721  
722 0 ▶sub admin_memberships {
Subroutine admin_memberships: not called CC=1 SCAR=6.9
Pod undocumented
723 0 my $self = shift;
724 0 Carp::carp("'admin_memberships' is deprecated. Use 'get_admin_memberships' instead.");
725 0 $self->get_admin_memberships(@_);
726 }
727  
728 =pod
729  
730  
731  
732 =item get_blocked_memberships
733  
734 my $res = $tp->groups->get_blocked_memberships($id);
735  
736 Get a list of relationships that have the Blocked type between users and the selected groups. (Restricted to group admin.)
737  
738 Returns ListE<lt>RelationshipE<gt> which contains following properties.
739  
740 =over 8
741  
742 =item totalResults
743  
744 (integer) The total number of items in the whole list of which this list object is a paginated view.
745  
746 =item entries
747  
748 (arrayE<lt>RelationshipE<gt>) The items within the selected slice of the list.
749  
750  
751 =back
752  
753 =cut
754  
755 0 ▶sub get_blocked_memberships {
Subroutine get_blocked_memberships: not called CC=1 SCAR=6.9
Pod documented
756 0 my $api = shift;
757 0 my @args;
758 0 push @args, shift; # id
759 0 my $uri = sprintf '/groups/%s/memberships/@blocked.json', @args;
760 0 $api->base->call("GET", $uri, @_);
761 }
762  
763  
764 0 ▶sub blocked_memberships {
Subroutine blocked_memberships: not called CC=1 SCAR=6.9
Pod undocumented
765 0 my $self = shift;
766 0 Carp::carp("'blocked_memberships' is deprecated. Use 'get_blocked_memberships' instead.");
767 0 $self->get_blocked_memberships(@_);
768 }
769  
770 =pod
771  
772  
773  
774 =item get_member_memberships
775  
776 my $res = $tp->groups->get_member_memberships($id);
777  
778 Get a list of relationships that have the Member type between users and the selected group.
779  
780 Returns ListE<lt>RelationshipE<gt> which contains following properties.
781  
782 =over 8
783  
784 =item totalResults
785  
786 (integer) The total number of items in the whole list of which this list object is a paginated view.
787  
788 =item entries
789  
790 (arrayE<lt>RelationshipE<gt>) The items within the selected slice of the list.
791  
792  
793 =back
794  
795 =cut
796  
797 0 ▶sub get_member_memberships {
Subroutine get_member_memberships: not called CC=1 SCAR=6.9
Pod documented
798 0 my $api = shift;
799 0 my @args;
800 0 push @args, shift; # id
801 0 my $uri = sprintf '/groups/%s/memberships/@member.json', @args;
802 0 $api->base->call("GET", $uri, @_);
803 }
804  
805  
806 0 ▶sub member_memberships {
Subroutine member_memberships: not called CC=1 SCAR=6.9
Pod undocumented
807 0 my $self = shift;
808 0 Carp::carp("'member_memberships' is deprecated. Use 'get_member_memberships' instead.");
809 0 $self->get_member_memberships(@_);
810 }
811  
812 =pod
813  
814  
815  
816 =item post_to_photo_assets
817  
818 my $res = $tp->groups->post_to_photo_assets($id);
819  
820 Create a new Photo asset within the selected group.
821  
822 Returns Photo which contains following properties.
823  
824 =over 8
825  
826 =item imageLink
827  
828 (ImageLink) BE<lt>Read OnlyE<gt> A link to the image that is this Photo asset's content.
829  
830 =item suppressEvents
831  
832 (boolean) BE<lt>Write OnlyE<gt> An optional, write-only flag indicating that asset creation should not trigger notification events such as emails or dashboard entries. Not available to all applications.
833  
834 =item id
835  
836 (string) BE<lt>Read OnlyE<gt> A URI that serves as a globally unique identifier for the user.
837  
838 =item urlId
839  
840 (string) BE<lt>Read OnlyE<gt> A string containing the canonical identifier that can be used to identify this object in URLs. This can be used to recognise where the same user is returned in response to different requests, and as a mapping key for an application's local data store.
841  
842 =item permalinkUrl
843  
844 (string) BE<lt>Read OnlyE<gt> The URL that is this asset's permalink. This will be omitted if the asset does not have a permalink of its own (for example, if it's embedded in another asset) or if TypePad does not know its permalink.
845  
846 =item shortUrl
847  
848 (string) BE<lt>Read OnlyE<gt> The short version of the URL that is this asset's permalink. This is currently available only for OE<lt>PostE<gt> assetes.
849  
850 =item author
851  
852 (User) BE<lt>Read OnlyE<gt> The user who created the selected asset.
853  
854 =item published
855  
856 (datetime) BE<lt>Read OnlyE<gt> The time at which the asset was created, as a W3CDTF timestamp.
857  
858 =item content
859  
860 (string) The raw asset content. The ME<lt>textFormatE<gt> property describes how to format this data. Use this property to set the asset content in write operations. An asset posted in a group may have a ME<lt>contentE<gt> value up to 10,000 bytes long, while a OE<lt>PostE<gt> asset in a blog may have up to 65,000 bytes of content.
861  
862 =item renderedContent
863  
864 (string) BE<lt>Read OnlyE<gt> The content of this asset rendered to HTML. This is currently available only for OE<lt>PostE<gt> and OE<lt>PageE<gt> assets.
865  
866 =item excerpt
867  
868 (string) BE<lt>Read OnlyE<gt> A short, plain-text excerpt of the entry content. This is currently available only for OE<lt>PostE<gt> assets.
869  
870 =item textFormat
871  
872 (string) A keyword that indicates what formatting mode to use for the content of this asset. This can be CE<lt>htmlE<gt> for assets the content of which is HTML, CE<lt>html_convert_linebreaksE<gt> for assets the content of which is HTML but where paragraph tags should be added automatically, or CE<lt>markdownE<gt> for assets the content of which is Markdown source. Other formatting modes may be added in future. Applications that present assets for editing should use this property to present an appropriate editor.
873  
874 =item groups
875  
876 (arrayE<lt>stringE<gt>) BE<lt>Read OnlyE<gt> BE<lt>DeprecatedE<gt> An array of strings containing the ME<lt>idE<gt> URI of the OE<lt>GroupE<gt> object that this asset is mapped into, if any. This property has been superseded by the ME<lt>containerE<gt> property.
877  
878 =item source
879  
880 (AssetSource) BE<lt>Read OnlyE<gt> An object describing the site from which this asset was retrieved, if the asset was obtained from an external source.
881  
882 =item objectTypes
883  
884 (setE<lt>stringE<gt>) BE<lt>Read OnlyE<gt> BE<lt>DeprecatedE<gt> An array of object type identifier URIs identifying the type of this asset. Only the one object type URI for the particular type of asset this asset is will be present.
885  
886 =item objectType
887  
888 (string) BE<lt>Read OnlyE<gt> The keyword identifying the type of asset this is.
889  
890 =item isFavoriteForCurrentUser
891  
892 (boolean) BE<lt>Read OnlyE<gt> CE<lt>trueE<gt> if this asset is a favorite for the currently authenticated user, or CE<lt>falseE<gt> otherwise. This property is omitted from responses to anonymous requests.
893  
894 =item favoriteCount
895  
896 (integer) BE<lt>Read OnlyE<gt> The number of distinct users who have added this asset as a favorite.
897  
898 =item commentCount
899  
900 (integer) BE<lt>Read OnlyE<gt> The number of comments that have been posted in reply to this asset. This number includes comments that have been posted in response to other comments.
901  
902 =item title
903  
904 (string) The title of the asset.
905  
906 =item description
907  
908 (string) The description of the asset.
909  
910 =item container
911  
912 (ContainerRef) BE<lt>Read OnlyE<gt> An object describing the group or blog to which this asset belongs.
913  
914 =item publicationStatus
915  
916 (PublicationStatus) An object describing the visibility status and publication date for this asset. Only visibility status is editable.
917  
918 =item crosspostAccounts
919  
920 (setE<lt>stringE<gt>) BE<lt>Write OnlyE<gt> A set of identifiers for OE<lt>AccountE<gt> objects to which to crosspost this asset when it's posted. This property is omitted when retrieving existing assets.
921  
922 =item isConversationsAnswer
923  
924 (boolean) BE<lt>Read OnlyE<gt> BE<lt>DeprecatedE<gt> CE<lt>trueE<gt> if this asset is an answer to a TypePad Conversations question, or absent otherwise. This property is deprecated and will be replaced with something more useful in future.
925  
926 =item reblogOf
927  
928 (AssetRef) BE<lt>Read OnlyE<gt> BE<lt>DeprecatedE<gt> If this asset was created by 'reblogging' another asset, this property describes the original asset.
929  
930 =item reblogOfUrl
931  
932 (string) BE<lt>Read OnlyE<gt> BE<lt>DeprecatedE<gt> If this asset was created by 'reblogging' another asset or some other arbitrary web page, this property contains the URL of the item that was reblogged.
933  
934 =item positiveVoteCount
935  
936 (integer) BE<lt>Read OnlyE<gt> The total number of positive votes this asset has received via the NE<lt>/assets/{id}/cast-positive-voteE<gt> endpoint.
937  
938 =item negativeVoteCount
939  
940 (integer) BE<lt>Read OnlyE<gt> The total number of negative votes this asset has received via the NE<lt>/assets/{id}/cast-negative-voteE<gt> endpoint.
941  
942 =item hasExtendedContent
943  
944 (boolean) BE<lt>Read OnlyE<gt> CE<lt>trueE<gt> if this asset has the extended content. This is currently supported only for OE<lt>PostE<gt> assets that are posted within a blog.
945  
946  
947 =back
948  
949 =cut
950  
951 0 ▶sub post_to_photo_assets {
Subroutine post_to_photo_assets: not called CC=1 SCAR=6.9
Pod documented
952 0 my $api = shift;
953 0 my @args;
954 0 push @args, shift; # id
955 0 my $uri = sprintf '/groups/%s/photo-assets.json', @args;
956 0 $api->base->call("POST", $uri, @_);
957 }
958  
959  
960 =pod
961  
962  
963  
964 =item get_photo_assets
965  
966 my $res = $tp->groups->get_photo_assets($id);
967  
968 Get a list of recently created Photo assets from the selected group.
969  
970 Returns ListE<lt>PhotoE<gt> which contains following properties.
971  
972 =over 8
973  
974 =item totalResults
975  
976 (integer) The total number of items in the whole list of which this list object is a paginated view.
977  
978 =item entries
979  
980 (arrayE<lt>PhotoE<gt>) The items within the selected slice of the list.
981  
982  
983 =back
984  
985 =cut
986  
987 0 ▶sub get_photo_assets {
Subroutine get_photo_assets: not called CC=1 SCAR=6.9
Pod documented
988 0 my $api = shift;
989 0 my @args;
990 0 push @args, shift; # id
991 0 my $uri = sprintf '/groups/%s/photo-assets.json', @args;
992 0 $api->base->call("GET", $uri, @_);
993 }
994  
995  
996 0 ▶sub photo_assets {
Subroutine photo_assets: not called CC=1 SCAR=6.9
Pod undocumented
997 0 my $self = shift;
998 0 Carp::carp("'photo_assets' is deprecated. Use 'get_photo_assets' instead.");
999 0 $self->get_photo_assets(@_);
1000 }
1001  
1002 =pod
1003  
1004  
1005  
1006 =item post_to_post_assets
1007  
1008 my $res = $tp->groups->post_to_post_assets($id);
1009  
1010 Create a new Post asset within the selected group.
1011  
1012 Returns Post which contains following properties.
1013  
1014 =over 8
1015  
1016 =item categories
1017  
1018 (arrayE<lt>stringE<gt>) A list of categories associated with the post.
1019  
1020 =item embeddedImageLinks
1021  
1022 (arrayE<lt>ImageLinkE<gt>) BE<lt>Read OnlyE<gt> A list of links to the images that are embedded within the content of this post.
1023  
1024 =item embeddedVideoLinks
1025  
1026 (arrayE<lt>VideoLinkE<gt>) BE<lt>Read OnlyE<gt> A list of links to the videos that are embedded within the content of this post.
1027  
1028 =item embeddedAudioLinks
1029  
1030 (arrayE<lt>AudioLinkE<gt>) BE<lt>Read OnlyE<gt> A list of links to the audio streams that are embedded within the content of this post.
1031  
1032 =item title
1033  
1034 (string) The title of the post.
1035  
1036 =item description
1037  
1038 (string) The description of the post.
1039  
1040 =item filename
1041  
1042 (string) The base name of the post to use when creating its ME<lt>permalinkUrlE<gt>.
1043  
1044 =item content
1045  
1046 (string) The raw post content. The ME<lt>textFormatE<gt> property defines what format this data is in.
1047  
1048 =item textFormat
1049  
1050 (string) A keyword that indicates what formatting mode to use for the content of this post. This can be CE<lt>htmlE<gt> for assets the content of which is HTML, CE<lt>html_convert_linebreaksE<gt> for assets the content of which is HTML but where paragraph tags should be added automatically, or CE<lt>markdownE<gt> for assets the content of which is Markdown source. Other formatting modes may be added in future. Applications that present assets for editing should use this property to present an appropriate editor.
1051  
1052 =item publicationStatus
1053  
1054 (PublicationStatus) An object describing the draft status and publication date for this post.
1055  
1056 =item feedbackStatus
1057  
1058 (FeedbackStatus) An object describing the comment and trackback behavior for this post.
1059  
1060 =item reblogCount
1061  
1062 (integer) BE<lt>Read OnlyE<gt> The number of times this post has been reblogged by other people.
1063  
1064 =item reblogOf
1065  
1066 (AssetRef) BE<lt>Fixed After CreationE<gt> A reference to a post of which this post is a reblog.
1067  
1068 =item suppressEvents
1069  
1070 (boolean) BE<lt>Write OnlyE<gt> An optional, write-only flag indicating that asset creation should not trigger notification events such as emails or dashboard entries. Not available to all applications.
1071  
1072 =item createConversation
1073  
1074 (boolean) BE<lt>Write OnlyE<gt> An optional, write-only flag indicating that the asset is starting a new conversation.
1075  
1076 =item conversationId
1077  
1078 (string) BE<lt>Read OnlyE<gt> Identifies the OE<lt>ConversationE<gt> object this asset belongs to, if any. Omitted if the asset is not part of a conversation.
1079  
1080 =item id
1081  
1082 (string) BE<lt>Read OnlyE<gt> A URI that serves as a globally unique identifier for the user.
1083  
1084 =item urlId
1085  
1086 (string) BE<lt>Read OnlyE<gt> A string containing the canonical identifier that can be used to identify this object in URLs. This can be used to recognise where the same user is returned in response to different requests, and as a mapping key for an application's local data store.
1087  
1088 =item permalinkUrl
1089  
1090 (string) BE<lt>Read OnlyE<gt> The URL that is this asset's permalink. This will be omitted if the asset does not have a permalink of its own (for example, if it's embedded in another asset) or if TypePad does not know its permalink.
1091  
1092 =item shortUrl
1093  
1094 (string) BE<lt>Read OnlyE<gt> The short version of the URL that is this asset's permalink. This is currently available only for OE<lt>PostE<gt> assetes.
1095  
1096 =item author
1097  
1098 (User) BE<lt>Read OnlyE<gt> The user who created the selected asset.
1099  
1100 =item published
1101  
1102 (datetime) BE<lt>Read OnlyE<gt> The time at which the asset was created, as a W3CDTF timestamp.
1103  
1104 =item content
1105  
1106 (string) The raw asset content. The ME<lt>textFormatE<gt> property describes how to format this data. Use this property to set the asset content in write operations. An asset posted in a group may have a ME<lt>contentE<gt> value up to 10,000 bytes long, while a OE<lt>PostE<gt> asset in a blog may have up to 65,000 bytes of content.
1107  
1108 =item renderedContent
1109  
1110 (string) BE<lt>Read OnlyE<gt> The content of this asset rendered to HTML. This is currently available only for OE<lt>PostE<gt> and OE<lt>PageE<gt> assets.
1111  
1112 =item excerpt
1113  
1114 (string) BE<lt>Read OnlyE<gt> A short, plain-text excerpt of the entry content. This is currently available only for OE<lt>PostE<gt> assets.
1115  
1116 =item textFormat
1117  
1118 (string) A keyword that indicates what formatting mode to use for the content of this asset. This can be CE<lt>htmlE<gt> for assets the content of which is HTML, CE<lt>html_convert_linebreaksE<gt> for assets the content of which is HTML but where paragraph tags should be added automatically, or CE<lt>markdownE<gt> for assets the content of which is Markdown source. Other formatting modes may be added in future. Applications that present assets for editing should use this property to present an appropriate editor.
1119  
1120 =item groups
1121  
1122 (arrayE<lt>stringE<gt>) BE<lt>Read OnlyE<gt> BE<lt>DeprecatedE<gt> An array of strings containing the ME<lt>idE<gt> URI of the OE<lt>GroupE<gt> object that this asset is mapped into, if any. This property has been superseded by the ME<lt>containerE<gt> property.
1123  
1124 =item source
1125  
1126 (AssetSource) BE<lt>Read OnlyE<gt> An object describing the site from which this asset was retrieved, if the asset was obtained from an external source.
1127  
1128 =item objectTypes
1129  
1130 (setE<lt>stringE<gt>) BE<lt>Read OnlyE<gt> BE<lt>DeprecatedE<gt> An array of object type identifier URIs identifying the type of this asset. Only the one object type URI for the particular type of asset this asset is will be present.
1131  
1132 =item objectType
1133  
1134 (string) BE<lt>Read OnlyE<gt> The keyword identifying the type of asset this is.
1135  
1136 =item isFavoriteForCurrentUser
1137  
1138 (boolean) BE<lt>Read OnlyE<gt> CE<lt>trueE<gt> if this asset is a favorite for the currently authenticated user, or CE<lt>falseE<gt> otherwise. This property is omitted from responses to anonymous requests.
1139  
1140 =item favoriteCount
1141  
1142 (integer) BE<lt>Read OnlyE<gt> The number of distinct users who have added this asset as a favorite.
1143  
1144 =item commentCount
1145  
1146 (integer) BE<lt>Read OnlyE<gt> The number of comments that have been posted in reply to this asset. This number includes comments that have been posted in response to other comments.
1147  
1148 =item title
1149  
1150 (string) The title of the asset.
1151  
1152 =item description
1153  
1154 (string) The description of the asset.
1155  
1156 =item container
1157  
1158 (ContainerRef) BE<lt>Read OnlyE<gt> An object describing the group or blog to which this asset belongs.
1159  
1160 =item publicationStatus
1161  
1162 (PublicationStatus) An object describing the visibility status and publication date for this asset. Only visibility status is editable.
1163  
1164 =item crosspostAccounts
1165  
1166 (setE<lt>stringE<gt>) BE<lt>Write OnlyE<gt> A set of identifiers for OE<lt>AccountE<gt> objects to which to crosspost this asset when it's posted. This property is omitted when retrieving existing assets.
1167  
1168 =item isConversationsAnswer
1169  
1170 (boolean) BE<lt>Read OnlyE<gt> BE<lt>DeprecatedE<gt> CE<lt>trueE<gt> if this asset is an answer to a TypePad Conversations question, or absent otherwise. This property is deprecated and will be replaced with something more useful in future.
1171  
1172 =item reblogOf
1173  
1174 (AssetRef) BE<lt>Read OnlyE<gt> BE<lt>DeprecatedE<gt> If this asset was created by 'reblogging' another asset, this property describes the original asset.
1175  
1176 =item reblogOfUrl
1177  
1178 (string) BE<lt>Read OnlyE<gt> BE<lt>DeprecatedE<gt> If this asset was created by 'reblogging' another asset or some other arbitrary web page, this property contains the URL of the item that was reblogged.
1179  
1180 =item positiveVoteCount
1181  
1182 (integer) BE<lt>Read OnlyE<gt> The total number of positive votes this asset has received via the NE<lt>/assets/{id}/cast-positive-voteE<gt> endpoint.
1183  
1184 =item negativeVoteCount
1185  
1186 (integer) BE<lt>Read OnlyE<gt> The total number of negative votes this asset has received via the NE<lt>/assets/{id}/cast-negative-voteE<gt> endpoint.
1187  
1188 =item hasExtendedContent
1189  
1190 (boolean) BE<lt>Read OnlyE<gt> CE<lt>trueE<gt> if this asset has the extended content. This is currently supported only for OE<lt>PostE<gt> assets that are posted within a blog.
1191  
1192  
1193 =back
1194  
1195 =cut
1196  
1197 0 ▶sub post_to_post_assets {
Subroutine post_to_post_assets: not called CC=1 SCAR=6.9
Pod documented
1198 0 my $api = shift;
1199 0 my @args;
1200 0 push @args, shift; # id
1201 0 my $uri = sprintf '/groups/%s/post-assets.json', @args;
1202 0 $api->base->call("POST", $uri, @_);
1203 }
1204  
1205  
1206 =pod
1207  
1208  
1209  
1210 =item get_post_assets
1211  
1212 my $res = $tp->groups->get_post_assets($id);
1213  
1214 Get a list of recently created Post assets from the selected group.
1215  
1216 Returns ListE<lt>PostE<gt> which contains following properties.
1217  
1218 =over 8
1219  
1220 =item totalResults
1221  
1222 (integer) The total number of items in the whole list of which this list object is a paginated view.
1223  
1224 =item entries
1225  
1226 (arrayE<lt>PostE<gt>) The items within the selected slice of the list.
1227  
1228  
1229 =back
1230  
1231 =cut
1232  
1233 0 ▶sub get_post_assets {
Subroutine get_post_assets: not called CC=1 SCAR=6.9
Pod documented
1234 0 my $api = shift;
1235 0 my @args;
1236 0 push @args, shift; # id
1237 0 my $uri = sprintf '/groups/%s/post-assets.json', @args;
1238 0 $api->base->call("GET", $uri, @_);
1239 }
1240  
1241  
1242 0 ▶sub post_assets {
Subroutine post_assets: not called CC=1 SCAR=6.9
Pod undocumented
1243 0 my $self = shift;
1244 0 Carp::carp("'post_assets' is deprecated. Use 'get_post_assets' instead.");
1245 0 $self->get_post_assets(@_);
1246 }
1247  
1248 =pod
1249  
1250  
1251  
1252 =item remove_member
1253  
1254 my $res = $tp->groups->remove_member($id);
1255  
1256 Remove a given user as a member of the selected group.
1257  
1258 Returns hash reference which contains following properties.
1259  
1260 =over 8
1261  
1262  
1263 =back
1264  
1265 =cut
1266  
1267 0 ▶sub remove_member {
Subroutine remove_member: not called CC=1 SCAR=6.9
Pod documented
1268 0 my $api = shift;
1269 0 my @args;
1270 0 push @args, shift; # id
1271 0 my $uri = sprintf '/groups/%s/remove-member.json', @args;
1272 0 $api->base->call("POST", $uri, @_);
1273 }
1274  
1275  
1276 =pod
1277  
1278  
1279  
1280 =item unblock_user
1281  
1282 my $res = $tp->groups->unblock_user($id);
1283  
1284 Remove the block preventing the given user from joining the selected group.
1285  
1286 Returns hash reference which contains following properties.
1287  
1288 =over 8
1289  
1290  
1291 =back
1292  
1293 =cut
1294  
1295 0 ▶sub unblock_user {
Subroutine unblock_user: not called CC=1 SCAR=6.9
Pod documented
1296 0 my $api = shift;
1297 0 my @args;
1298 0 push @args, shift; # id
1299 0 my $uri = sprintf '/groups/%s/unblock-user.json', @args;
1300 0 $api->base->call("POST", $uri, @_);
1301 }
1302  
1303  
1304 =pod
1305  
1306  
1307  
1308 =item post_to_video_assets
1309  
1310 my $res = $tp->groups->post_to_video_assets($id);
1311  
1312 Create a new Video asset within the selected group.
1313  
1314 Returns Video which contains following properties.
1315  
1316 =over 8
1317  
1318 =item videoLink
1319  
1320 (VideoLink) BE<lt>Fixed After CreationE<gt> A link to the video that is this Video asset's content.
1321  
1322 =item previewImageLink
1323  
1324 (ImageLink) BE<lt>Read OnlyE<gt> A link to a preview image or poster frame for this video. This property is omitted if no such image is available.
1325  
1326 =item suppressEvents
1327  
1328 (boolean) BE<lt>Write OnlyE<gt> An optional, write-only flag indicating that asset creation should not trigger notification events such
1329 as emails or dashboard entries. Not available to all applications.
1330  
1331 =item id
1332  
1333 (string) BE<lt>Read OnlyE<gt> A URI that serves as a globally unique identifier for the user.
1334  
1335 =item urlId
1336  
1337 (string) BE<lt>Read OnlyE<gt> A string containing the canonical identifier that can be used to identify this object in URLs. This can be used to recognise where the same user is returned in response to different requests, and as a mapping key for an application's local data store.
1338  
1339 =item permalinkUrl
1340  
1341 (string) BE<lt>Read OnlyE<gt> The URL that is this asset's permalink. This will be omitted if the asset does not have a permalink of its own (for example, if it's embedded in another asset) or if TypePad does not know its permalink.
1342  
1343 =item shortUrl
1344  
1345 (string) BE<lt>Read OnlyE<gt> The short version of the URL that is this asset's permalink. This is currently available only for OE<lt>PostE<gt> assetes.
1346  
1347 =item author
1348  
1349 (User) BE<lt>Read OnlyE<gt> The user who created the selected asset.
1350  
1351 =item published
1352  
1353 (datetime) BE<lt>Read OnlyE<gt> The time at which the asset was created, as a W3CDTF timestamp.
1354  
1355 =item content
1356  
1357 (string) The raw asset content. The ME<lt>textFormatE<gt> property describes how to format this data. Use this property to set the asset content in write operations. An asset posted in a group may have a ME<lt>contentE<gt> value up to 10,000 bytes long, while a OE<lt>PostE<gt> asset in a blog may have up to 65,000 bytes of content.
1358  
1359 =item renderedContent
1360  
1361 (string) BE<lt>Read OnlyE<gt> The content of this asset rendered to HTML. This is currently available only for OE<lt>PostE<gt> and OE<lt>PageE<gt> assets.
1362  
1363 =item excerpt
1364  
1365 (string) BE<lt>Read OnlyE<gt> A short, plain-text excerpt of the entry content. This is currently available only for OE<lt>PostE<gt> assets.
1366  
1367 =item textFormat
1368  
1369 (string) A keyword that indicates what formatting mode to use for the content of this asset. This can be CE<lt>htmlE<gt> for assets the content of which is HTML, CE<lt>html_convert_linebreaksE<gt> for assets the content of which is HTML but where paragraph tags should be added automatically, or CE<lt>markdownE<gt> for assets the content of which is Markdown source. Other formatting modes may be added in future. Applications that present assets for editing should use this property to present an appropriate editor.
1370  
1371 =item groups
1372  
1373 (arrayE<lt>stringE<gt>) BE<lt>Read OnlyE<gt> BE<lt>DeprecatedE<gt> An array of strings containing the ME<lt>idE<gt> URI of the OE<lt>GroupE<gt> object that this asset is mapped into, if any. This property has been superseded by the ME<lt>containerE<gt> property.
1374  
1375 =item source
1376  
1377 (AssetSource) BE<lt>Read OnlyE<gt> An object describing the site from which this asset was retrieved, if the asset was obtained from an external source.
1378  
1379 =item objectTypes
1380  
1381 (setE<lt>stringE<gt>) BE<lt>Read OnlyE<gt> BE<lt>DeprecatedE<gt> An array of object type identifier URIs identifying the type of this asset. Only the one object type URI for the particular type of asset this asset is will be present.
1382  
1383 =item objectType
1384  
1385 (string) BE<lt>Read OnlyE<gt> The keyword identifying the type of asset this is.
1386  
1387 =item isFavoriteForCurrentUser
1388  
1389 (boolean) BE<lt>Read OnlyE<gt> CE<lt>trueE<gt> if this asset is a favorite for the currently authenticated user, or CE<lt>falseE<gt> otherwise. This property is omitted from responses to anonymous requests.
1390  
1391 =item favoriteCount
1392  
1393 (integer) BE<lt>Read OnlyE<gt> The number of distinct users who have added this asset as a favorite.
1394  
1395 =item commentCount
1396  
1397 (integer) BE<lt>Read OnlyE<gt> The number of comments that have been posted in reply to this asset. This number includes comments that have been posted in response to other comments.
1398  
1399 =item title
1400  
1401 (string) The title of the asset.
1402  
1403 =item description
1404  
1405 (string) The description of the asset.
1406  
1407 =item container
1408  
1409 (ContainerRef) BE<lt>Read OnlyE<gt> An object describing the group or blog to which this asset belongs.
1410  
1411 =item publicationStatus
1412  
1413 (PublicationStatus) An object describing the visibility status and publication date for this asset. Only visibility status is editable.
1414  
1415 =item crosspostAccounts
1416  
1417 (setE<lt>stringE<gt>) BE<lt>Write OnlyE<gt> A set of identifiers for OE<lt>AccountE<gt> objects to which to crosspost this asset when it's posted. This property is omitted when retrieving existing assets.
1418  
1419 =item isConversationsAnswer
1420  
1421 (boolean) BE<lt>Read OnlyE<gt> BE<lt>DeprecatedE<gt> CE<lt>trueE<gt> if this asset is an answer to a TypePad Conversations question, or absent otherwise. This property is deprecated and will be replaced with something more useful in future.
1422  
1423 =item reblogOf
1424  
1425 (AssetRef) BE<lt>Read OnlyE<gt> BE<lt>DeprecatedE<gt> If this asset was created by 'reblogging' another asset, this property describes the original asset.
1426  
1427 =item reblogOfUrl
1428  
1429 (string) BE<lt>Read OnlyE<gt> BE<lt>DeprecatedE<gt> If this asset was created by 'reblogging' another asset or some other arbitrary web page, this property contains the URL of the item that was reblogged.
1430  
1431 =item positiveVoteCount
1432  
1433 (integer) BE<lt>Read OnlyE<gt> The total number of positive votes this asset has received via the NE<lt>/assets/{id}/cast-positive-voteE<gt> endpoint.
1434  
1435 =item negativeVoteCount
1436  
1437 (integer) BE<lt>Read OnlyE<gt> The total number of negative votes this asset has received via the NE<lt>/assets/{id}/cast-negative-voteE<gt> endpoint.
1438  
1439 =item hasExtendedContent
1440  
1441 (boolean) BE<lt>Read OnlyE<gt> CE<lt>trueE<gt> if this asset has the extended content. This is currently supported only for OE<lt>PostE<gt> assets that are posted within a blog.
1442  
1443  
1444 =back
1445  
1446 =cut
1447  
1448 0 ▶sub post_to_video_assets {
Subroutine post_to_video_assets: not called CC=1 SCAR=6.9
Pod documented
1449 0 my $api = shift;
1450 0 my @args;
1451 0 push @args, shift; # id
1452 0 my $uri = sprintf '/groups/%s/video-assets.json', @args;
1453 0 $api->base->call("POST", $uri, @_);
1454 }
1455  
1456  
1457 =pod
1458  
1459  
1460  
1461 =item get_video_assets
1462  
1463 my $res = $tp->groups->get_video_assets($id);
1464  
1465 Get a list of recently created Video assets from the selected group.
1466  
1467 Returns ListE<lt>VideoE<gt> which contains following properties.
1468  
1469 =over 8
1470  
1471 =item totalResults
1472  
1473 (integer) The total number of items in the whole list of which this list object is a paginated view.
1474  
1475 =item entries
1476  
1477 (arrayE<lt>VideoE<gt>) The items within the selected slice of the list.
1478  
1479  
1480 =back
1481  
1482 =cut
1483  
1484 0 ▶sub get_video_assets {
Subroutine get_video_assets: not called CC=1 SCAR=6.9
Pod documented
1485 0 my $api = shift;
1486 0 my @args;
1487 0 push @args, shift; # id
1488 0 my $uri = sprintf '/groups/%s/video-assets.json', @args;
1489 0 $api->base->call("GET", $uri, @_);
1490 }
1491  
1492  
1493 0 ▶sub video_assets {
Subroutine video_assets: not called CC=1 SCAR=6.9
Pod undocumented
1494 0 my $self = shift;
1495 0 Carp::carp("'video_assets' is deprecated. Use 'get_video_assets' instead.");
1496 0 $self->get_video_assets(@_);
1497 }
1498  
1499 =pod
1500  
1501 =back
1502  
1503 =cut
1504  
1505 ### END auto-generated
1506  
1507  
1508 0 ▶sub upload_photo {
Subroutine upload_photo: not called CC=1 SCAR=6.9
Pod undocumented
1509 0 my $api = shift;
1510 0 my( $id, $asset, $filename ) = @_;
1511 0 return $api->base->call_upload( {
1512 # No extension on this!
1513 target_url => '/groups/' . $id . '/photo-assets',
1514 asset => $asset,
1515 filename => $filename,
1516 } );
1517 }
1518  
1519 0 ▶sub upload_audio {
Subroutine upload_audio: not called CC=1 SCAR=6.9
Pod undocumented
1520 0 my $api = shift;
1521 0 my( $id, $asset, $filename ) = @_;
1522 0 return $api->base->call_upload( {
1523 # No extension on this!
1524 target_url => '/groups/' . $id . '/audio-assets',
1525 asset => $asset,
1526 filename => $filename,
1527 } );
1528 }
1529  
1530  
1531 1 1;
« TypePad/Blogs.pm ↑ Summary TypePad/Assets.pm »