TypePad/Applications.pm

filter: Statementstmt 25.0% 17 / 68 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 27.7% 5 / 18 Podpod 53.8% 7 / 13 totaltotal 29.2% 29 / 99 CC 1 SCAR 5.4
CC
1
Cov
25%
applications
2.0
get
2.0
get_badges
2.0
CRAP 1.7
« TypePad/Assets.pm ↑ Summary TypePad/ExternalFeedSubscriptions.pm »
1 package WWW::TypePad::Applications;
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::applications { __PACKAGE__->new( base => $_[0] ) }
Subroutine applications: 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::Applications - Applications 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->applications->get($id);
39  
40 Get basic information about the selected application.
41  
42 Returns Application which contains following properties.
43  
44 =over 8
45  
46 =item name
47  
48 (string) The name of the application as provided by its developer.
49  
50 =item id
51  
52 (string) A string containing the canonical identifier that can be used to identify this application in URLs.
53  
54 =item objectTypes
55  
56 (setE<lt>stringE<gt>) BE<lt>DeprecatedE<gt> The object types for this object. This set will contain the string CE<lt>tag:api.typepad.com,2009:ApplicationE<gt> for an Application object.
57  
58 =item objectType
59  
60 (string) The keyword identifying the type of object this is. For an Application object, ME<lt>objectTypeE<gt> will be CE<lt>ApplicationE<gt>.
61  
62 =item oauthRequestTokenUrl
63  
64 (string) The URL of the OAuth request token endpoint for this application.
65  
66 =item oauthAuthorizationUrl
67  
68 (string) The URL to send the user's browser to for the user authorization step.
69  
70 =item oauthAccessTokenUrl
71  
72 (string) The URL of the OAuth access token endpoint for this application.
73  
74 =item oauthIdentificationUrl
75  
76 (string) The URL to send the user's browser to in order to identify who is logged in (that is, the "sign in" link).
77  
78 =item sessionSyncScriptUrl
79  
80 (string) The URL of the session sync script.
81  
82 =item signoutUrl
83  
84 (string) The URL to send the user's browser to in order to sign them out of TypePad.
85  
86 =item userFlyoutsScriptUrl
87  
88 (string) The URL of a script to embed to enable the user flyouts functionality.
89  
90 =item id
91  
92 (string) A URI that serves as a globally unique identifier for the object.
93  
94 =item urlId
95  
96 (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.
97  
98  
99 =back
100  
101 =cut
102  
103 0 ▶sub get {
Subroutine get: not called CC=1 SCAR=6.9
Pod documented
104 0 my $api = shift;
105 0 my @args;
106 0 push @args, shift; # id
107 0 my $uri = sprintf '/applications/%s.json', @args;
108 0 $api->base->call("GET", $uri, @_);
109 }
110  
111  
112 =pod
113  
114  
115  
116 =item get_badges
117  
118 my $res = $tp->applications->get_badges($id);
119  
120 Get a list of badges defined by this application.
121  
122 Returns ListE<lt>BadgeE<gt> which contains following properties.
123  
124 =over 8
125  
126 =item totalResults
127  
128 (integer) The total number of items in the whole list of which this list object is a paginated view.
129  
130 =item entries
131  
132 (arrayE<lt>BadgeE<gt>) The items within the selected slice of the list.
133  
134  
135 =back
136  
137 =cut
138  
139 0 ▶sub get_badges {
Subroutine get_badges: not called CC=1 SCAR=6.9
Pod documented
140 0 my $api = shift;
141 0 my @args;
142 0 push @args, shift; # id
143 0 my $uri = sprintf '/applications/%s/badges.json', @args;
144 0 $api->base->call("GET", $uri, @_);
145 }
146  
147  
148 0 ▶sub badges {
Subroutine badges: not called CC=1 SCAR=6.9
Pod undocumented
149 0 my $self = shift;
150 0 Carp::carp("'badges' is deprecated. Use 'get_badges' instead.");
151 0 $self->get_badges(@_);
152 }
153  
154 =pod
155  
156  
157  
158 =item get_learning_badges
159  
160 my $res = $tp->applications->get_learning_badges($id);
161  
162 Get a list of all learning badges defined by this application.
163  
164 Returns ListE<lt>BadgeE<gt> which contains following properties.
165  
166 =over 8
167  
168 =item totalResults
169  
170 (integer) The total number of items in the whole list of which this list object is a paginated view.
171  
172 =item entries
173  
174 (arrayE<lt>BadgeE<gt>) The items within the selected slice of the list.
175  
176  
177 =back
178  
179 =cut
180  
181 0 ▶sub get_learning_badges {
Subroutine get_learning_badges: not called CC=1 SCAR=6.9
Pod documented
182 0 my $api = shift;
183 0 my @args;
184 0 push @args, shift; # id
185 0 my $uri = sprintf '/applications/%s/badges/@learning.json', @args;
186 0 $api->base->call("GET", $uri, @_);
187 }
188  
189  
190 0 ▶sub learning_badges {
Subroutine learning_badges: not called CC=1 SCAR=6.9
Pod undocumented
191 0 my $self = shift;
192 0 Carp::carp("'learning_badges' is deprecated. Use 'get_learning_badges' instead.");
193 0 $self->get_learning_badges(@_);
194 }
195  
196 =pod
197  
198  
199  
200 =item get_public_badges
201  
202 my $res = $tp->applications->get_public_badges($id);
203  
204 Get a list of all public badges defined by this application.
205  
206 Returns ListE<lt>BadgeE<gt> which contains following properties.
207  
208 =over 8
209  
210 =item totalResults
211  
212 (integer) The total number of items in the whole list of which this list object is a paginated view.
213  
214 =item entries
215  
216 (arrayE<lt>BadgeE<gt>) The items within the selected slice of the list.
217  
218  
219 =back
220  
221 =cut
222  
223 0 ▶sub get_public_badges {
Subroutine get_public_badges: not called CC=1 SCAR=6.9
Pod documented
224 0 my $api = shift;
225 0 my @args;
226 0 push @args, shift; # id
227 0 my $uri = sprintf '/applications/%s/badges/@public.json', @args;
228 0 $api->base->call("GET", $uri, @_);
229 }
230  
231  
232 0 ▶sub public_badges {
Subroutine public_badges: not called CC=1 SCAR=6.9
Pod undocumented
233 0 my $self = shift;
234 0 Carp::carp("'public_badges' is deprecated. Use 'get_public_badges' instead.");
235 0 $self->get_public_badges(@_);
236 }
237  
238 =pod
239  
240  
241  
242 =item create_external_feed_subscription
243  
244 my $res = $tp->applications->create_external_feed_subscription($id);
245  
246 Subscribe the application to one or more external feeds.
247  
248 Returns hash reference which contains following properties.
249  
250 =over 8
251  
252 =item subscription
253  
254 (ExternalFeedSubscription) The subscription object that was created.
255  
256  
257 =back
258  
259 =cut
260  
261 0 ▶sub create_external_feed_subscription {
Subroutine create_external_feed_subscription: not called CC=1 SCAR=6.9
Pod documented
262 0 my $api = shift;
263 0 my @args;
264 0 push @args, shift; # id
265 0 my $uri = sprintf '/applications/%s/create-external-feed-subscription.json', @args;
266 0 $api->base->call("POST", $uri, @_);
267 }
268  
269  
270 =pod
271  
272  
273  
274 =item get_external_feed_subscriptions
275  
276 my $res = $tp->applications->get_external_feed_subscriptions($id);
277  
278 Get a list of the application's active external feed subscriptions.
279  
280 Returns ListE<lt>ExternalFeedSubscriptionE<gt> which contains following properties.
281  
282 =over 8
283  
284 =item totalResults
285  
286 (integer) The total number of items in the whole list of which this list object is a paginated view.
287  
288 =item entries
289  
290 (arrayE<lt>ExternalFeedSubscriptionE<gt>) The items within the selected slice of the list.
291  
292  
293 =back
294  
295 =cut
296  
297 0 ▶sub get_external_feed_subscriptions {
Subroutine get_external_feed_subscriptions: not called CC=1 SCAR=6.9
Pod documented
298 0 my $api = shift;
299 0 my @args;
300 0 push @args, shift; # id
301 0 my $uri = sprintf '/applications/%s/external-feed-subscriptions.json', @args;
302 0 $api->base->call("GET", $uri, @_);
303 }
304  
305  
306 0 ▶sub external_feed_subscriptions {
Subroutine external_feed_subscriptions: not called CC=1 SCAR=6.9
Pod undocumented
307 0 my $self = shift;
308 0 Carp::carp("'external_feed_subscriptions' is deprecated. Use 'get_external_feed_subscriptions' instead.");
309 0 $self->get_external_feed_subscriptions(@_);
310 }
311  
312 =pod
313  
314  
315  
316 =item get_groups
317  
318 my $res = $tp->applications->get_groups($id);
319  
320 Get a list of groups in which a client using a CE<lt>app_fullE<gt> access auth token from this application can act.
321  
322 Returns ListE<lt>GroupE<gt> which contains following properties.
323  
324 =over 8
325  
326 =item totalResults
327  
328 (integer) The total number of items in the whole list of which this list object is a paginated view.
329  
330 =item entries
331  
332 (arrayE<lt>GroupE<gt>) The items within the selected slice of the list.
333  
334  
335 =back
336  
337 =cut
338  
339 0 ▶sub get_groups {
Subroutine get_groups: not called CC=1 SCAR=6.9
Pod documented
340 0 my $api = shift;
341 0 my @args;
342 0 push @args, shift; # id
343 0 my $uri = sprintf '/applications/%s/groups.json', @args;
344 0 $api->base->call("GET", $uri, @_);
345 }
346  
347  
348 0 ▶sub groups {
Subroutine groups: not called CC=1 SCAR=6.9
Pod undocumented
349 0 my $self = shift;
350 0 Carp::carp("'groups' is deprecated. Use 'get_groups' instead.");
351 0 $self->get_groups(@_);
352 }
353  
354 =pod
355  
356 =back
357  
358 =cut
359  
360 ### END auto-generated
361  
362 1 1;
« TypePad/Assets.pm ↑ Summary TypePad/ExternalFeedSubscriptions.pm »