line |
stmt |
bran |
cond |
sub |
pod |
time |
code |
1
|
|
|
|
|
|
|
package WWW::TypePad::Assets; |
2
|
|
|
|
|
|
|
|
3
|
1
|
|
|
1
|
|
5
|
use strict; |
|
1
|
|
|
|
|
2
|
|
|
1
|
|
|
|
|
118
|
|
4
|
1
|
|
|
1
|
|
6
|
use warnings; |
|
1
|
|
|
|
|
18
|
|
|
1
|
|
|
|
|
121
|
|
5
|
|
|
|
|
|
|
|
6
|
|
|
|
|
|
|
# Install an accessor into WWW::TypePad to access an instance of this class |
7
|
|
|
|
|
|
|
# bound to the WWW::TypePad instance. |
8
|
0
|
|
|
0
|
0
|
|
sub WWW::TypePad::assets { __PACKAGE__->new( base => $_[0] ) } |
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::Assets - Assets API methods |
19
|
|
|
|
|
|
|
|
20
|
|
|
|
|
|
|
=head1 METHODS |
21
|
|
|
|
|
|
|
|
22
|
|
|
|
|
|
|
=cut |
23
|
|
|
|
|
|
|
|
24
|
1
|
|
|
1
|
|
4
|
use strict; |
|
1
|
|
|
|
|
1
|
|
|
1
|
|
|
|
|
32
|
|
25
|
1
|
|
|
1
|
|
4
|
use Any::Moose; |
|
1
|
|
|
|
|
1
|
|
|
1
|
|
|
|
|
7
|
|
26
|
|
|
|
|
|
|
extends 'WWW::TypePad::Noun'; |
27
|
|
|
|
|
|
|
|
28
|
1
|
|
|
1
|
|
654
|
use Carp (); |
|
1
|
|
|
|
|
2
|
|
|
1
|
|
|
|
|
4354
|
|
29
|
|
|
|
|
|
|
|
30
|
|
|
|
|
|
|
|
31
|
|
|
|
|
|
|
=pod |
32
|
|
|
|
|
|
|
|
33
|
|
|
|
|
|
|
=over 4 |
34
|
|
|
|
|
|
|
|
35
|
|
|
|
|
|
|
|
36
|
|
|
|
|
|
|
=item search |
37
|
|
|
|
|
|
|
|
38
|
|
|
|
|
|
|
my $res = $tp->assets->search(); |
39
|
|
|
|
|
|
|
|
40
|
|
|
|
|
|
|
Search for user-created content across the whole of TypePad. |
41
|
|
|
|
|
|
|
|
42
|
|
|
|
|
|
|
Returns StreamEAssetE which contains following properties. |
43
|
|
|
|
|
|
|
|
44
|
|
|
|
|
|
|
=over 8 |
45
|
|
|
|
|
|
|
|
46
|
|
|
|
|
|
|
=item totalResults |
47
|
|
|
|
|
|
|
|
48
|
|
|
|
|
|
|
(integer) The total number of items in the whole stream of which this response contains a subset. CEnullE if an exact count cannot be determined. |
49
|
|
|
|
|
|
|
|
50
|
|
|
|
|
|
|
=item estimatedTotalResults |
51
|
|
|
|
|
|
|
|
52
|
|
|
|
|
|
|
(integer) An estimate of the total number of items in the whole list of which this response contains a subset. CEnullE if a count cannot be determined at all, or if an exact count is returned in CEtotalResultsE. |
53
|
|
|
|
|
|
|
|
54
|
|
|
|
|
|
|
=item moreResultsToken |
55
|
|
|
|
|
|
|
|
56
|
|
|
|
|
|
|
(string) An opaque token that can be used as the CEstart-tokenE parameter of a followup request to retrieve additional results. CEnullE if there are no more results to retrieve, but the presence of this token does not guarantee that the response to a followup request will actually contain results. |
57
|
|
|
|
|
|
|
|
58
|
|
|
|
|
|
|
=item entries |
59
|
|
|
|
|
|
|
|
60
|
|
|
|
|
|
|
(arrayEAssetE) A selection of items from the underlying stream. |
61
|
|
|
|
|
|
|
|
62
|
|
|
|
|
|
|
|
63
|
|
|
|
|
|
|
=back |
64
|
|
|
|
|
|
|
|
65
|
|
|
|
|
|
|
=cut |
66
|
|
|
|
|
|
|
|
67
|
|
|
|
|
|
|
sub search { |
68
|
0
|
|
|
0
|
1
|
|
my $api = shift; |
69
|
0
|
|
|
|
|
|
my @args; |
70
|
0
|
|
|
|
|
|
my $uri = sprintf '/assets.json', @args; |
71
|
0
|
|
|
|
|
|
$api->base->call("GET", $uri, @_); |
72
|
|
|
|
|
|
|
} |
73
|
|
|
|
|
|
|
|
74
|
|
|
|
|
|
|
|
75
|
|
|
|
|
|
|
=pod |
76
|
|
|
|
|
|
|
|
77
|
|
|
|
|
|
|
|
78
|
|
|
|
|
|
|
|
79
|
|
|
|
|
|
|
=item delete |
80
|
|
|
|
|
|
|
|
81
|
|
|
|
|
|
|
my $res = $tp->assets->delete($id); |
82
|
|
|
|
|
|
|
|
83
|
|
|
|
|
|
|
Delete the selected asset and its associated events, comments and favorites. |
84
|
|
|
|
|
|
|
|
85
|
|
|
|
|
|
|
Returns Asset which contains following properties. |
86
|
|
|
|
|
|
|
|
87
|
|
|
|
|
|
|
=over 8 |
88
|
|
|
|
|
|
|
|
89
|
|
|
|
|
|
|
=item id |
90
|
|
|
|
|
|
|
|
91
|
|
|
|
|
|
|
(string) BERead OnlyE A URI that serves as a globally unique identifier for the user. |
92
|
|
|
|
|
|
|
|
93
|
|
|
|
|
|
|
=item urlId |
94
|
|
|
|
|
|
|
|
95
|
|
|
|
|
|
|
(string) BERead OnlyE 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. |
96
|
|
|
|
|
|
|
|
97
|
|
|
|
|
|
|
=item permalinkUrl |
98
|
|
|
|
|
|
|
|
99
|
|
|
|
|
|
|
(string) BERead OnlyE 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. |
100
|
|
|
|
|
|
|
|
101
|
|
|
|
|
|
|
=item shortUrl |
102
|
|
|
|
|
|
|
|
103
|
|
|
|
|
|
|
(string) BERead OnlyE The short version of the URL that is this asset's permalink. This is currently available only for OEPostE assetes. |
104
|
|
|
|
|
|
|
|
105
|
|
|
|
|
|
|
=item author |
106
|
|
|
|
|
|
|
|
107
|
|
|
|
|
|
|
(User) BERead OnlyE The user who created the selected asset. |
108
|
|
|
|
|
|
|
|
109
|
|
|
|
|
|
|
=item published |
110
|
|
|
|
|
|
|
|
111
|
|
|
|
|
|
|
(datetime) BERead OnlyE The time at which the asset was created, as a W3CDTF timestamp. |
112
|
|
|
|
|
|
|
|
113
|
|
|
|
|
|
|
=item content |
114
|
|
|
|
|
|
|
|
115
|
|
|
|
|
|
|
(string) The raw asset content. The MEtextFormatE 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 MEcontentE value up to 10,000 bytes long, while a OEPostE asset in a blog may have up to 65,000 bytes of content. |
116
|
|
|
|
|
|
|
|
117
|
|
|
|
|
|
|
=item renderedContent |
118
|
|
|
|
|
|
|
|
119
|
|
|
|
|
|
|
(string) BERead OnlyE The content of this asset rendered to HTML. This is currently available only for OEPostE and OEPageE assets. |
120
|
|
|
|
|
|
|
|
121
|
|
|
|
|
|
|
=item excerpt |
122
|
|
|
|
|
|
|
|
123
|
|
|
|
|
|
|
(string) BERead OnlyE A short, plain-text excerpt of the entry content. This is currently available only for OEPostE assets. |
124
|
|
|
|
|
|
|
|
125
|
|
|
|
|
|
|
=item textFormat |
126
|
|
|
|
|
|
|
|
127
|
|
|
|
|
|
|
(string) A keyword that indicates what formatting mode to use for the content of this asset. This can be CEhtmlE for assets the content of which is HTML, CEhtml_convert_linebreaksE for assets the content of which is HTML but where paragraph tags should be added automatically, or CEmarkdownE 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. |
128
|
|
|
|
|
|
|
|
129
|
|
|
|
|
|
|
=item groups |
130
|
|
|
|
|
|
|
|
131
|
|
|
|
|
|
|
(arrayEstringE) BERead OnlyE BEDeprecatedE An array of strings containing the MEidE URI of the OEGroupE object that this asset is mapped into, if any. This property has been superseded by the MEcontainerE property. |
132
|
|
|
|
|
|
|
|
133
|
|
|
|
|
|
|
=item source |
134
|
|
|
|
|
|
|
|
135
|
|
|
|
|
|
|
(AssetSource) BERead OnlyE An object describing the site from which this asset was retrieved, if the asset was obtained from an external source. |
136
|
|
|
|
|
|
|
|
137
|
|
|
|
|
|
|
=item objectTypes |
138
|
|
|
|
|
|
|
|
139
|
|
|
|
|
|
|
(setEstringE) BERead OnlyE BEDeprecatedE 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. |
140
|
|
|
|
|
|
|
|
141
|
|
|
|
|
|
|
=item objectType |
142
|
|
|
|
|
|
|
|
143
|
|
|
|
|
|
|
(string) BERead OnlyE The keyword identifying the type of asset this is. |
144
|
|
|
|
|
|
|
|
145
|
|
|
|
|
|
|
=item isFavoriteForCurrentUser |
146
|
|
|
|
|
|
|
|
147
|
|
|
|
|
|
|
(boolean) BERead OnlyE CEtrueE if this asset is a favorite for the currently authenticated user, or CEfalseE otherwise. This property is omitted from responses to anonymous requests. |
148
|
|
|
|
|
|
|
|
149
|
|
|
|
|
|
|
=item favoriteCount |
150
|
|
|
|
|
|
|
|
151
|
|
|
|
|
|
|
(integer) BERead OnlyE The number of distinct users who have added this asset as a favorite. |
152
|
|
|
|
|
|
|
|
153
|
|
|
|
|
|
|
=item commentCount |
154
|
|
|
|
|
|
|
|
155
|
|
|
|
|
|
|
(integer) BERead OnlyE 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. |
156
|
|
|
|
|
|
|
|
157
|
|
|
|
|
|
|
=item title |
158
|
|
|
|
|
|
|
|
159
|
|
|
|
|
|
|
(string) The title of the asset. |
160
|
|
|
|
|
|
|
|
161
|
|
|
|
|
|
|
=item description |
162
|
|
|
|
|
|
|
|
163
|
|
|
|
|
|
|
(string) The description of the asset. |
164
|
|
|
|
|
|
|
|
165
|
|
|
|
|
|
|
=item container |
166
|
|
|
|
|
|
|
|
167
|
|
|
|
|
|
|
(ContainerRef) BERead OnlyE An object describing the group or blog to which this asset belongs. |
168
|
|
|
|
|
|
|
|
169
|
|
|
|
|
|
|
=item publicationStatus |
170
|
|
|
|
|
|
|
|
171
|
|
|
|
|
|
|
(PublicationStatus) An object describing the visibility status and publication date for this asset. Only visibility status is editable. |
172
|
|
|
|
|
|
|
|
173
|
|
|
|
|
|
|
=item crosspostAccounts |
174
|
|
|
|
|
|
|
|
175
|
|
|
|
|
|
|
(setEstringE) BEWrite OnlyE A set of identifiers for OEAccountE objects to which to crosspost this asset when it's posted. This property is omitted when retrieving existing assets. |
176
|
|
|
|
|
|
|
|
177
|
|
|
|
|
|
|
=item isConversationsAnswer |
178
|
|
|
|
|
|
|
|
179
|
|
|
|
|
|
|
(boolean) BERead OnlyE BEDeprecatedE CEtrueE 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. |
180
|
|
|
|
|
|
|
|
181
|
|
|
|
|
|
|
=item reblogOf |
182
|
|
|
|
|
|
|
|
183
|
|
|
|
|
|
|
(AssetRef) BERead OnlyE BEDeprecatedE If this asset was created by 'reblogging' another asset, this property describes the original asset. |
184
|
|
|
|
|
|
|
|
185
|
|
|
|
|
|
|
=item reblogOfUrl |
186
|
|
|
|
|
|
|
|
187
|
|
|
|
|
|
|
(string) BERead OnlyE BEDeprecatedE 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. |
188
|
|
|
|
|
|
|
|
189
|
|
|
|
|
|
|
=item positiveVoteCount |
190
|
|
|
|
|
|
|
|
191
|
|
|
|
|
|
|
(integer) BERead OnlyE The total number of positive votes this asset has received via the NE/assets/{id}/cast-positive-voteE endpoint. |
192
|
|
|
|
|
|
|
|
193
|
|
|
|
|
|
|
=item negativeVoteCount |
194
|
|
|
|
|
|
|
|
195
|
|
|
|
|
|
|
(integer) BERead OnlyE The total number of negative votes this asset has received via the NE/assets/{id}/cast-negative-voteE endpoint. |
196
|
|
|
|
|
|
|
|
197
|
|
|
|
|
|
|
=item hasExtendedContent |
198
|
|
|
|
|
|
|
|
199
|
|
|
|
|
|
|
(boolean) BERead OnlyE CEtrueE if this asset has the extended content. This is currently supported only for OEPostE assets that are posted within a blog. |
200
|
|
|
|
|
|
|
|
201
|
|
|
|
|
|
|
|
202
|
|
|
|
|
|
|
=back |
203
|
|
|
|
|
|
|
|
204
|
|
|
|
|
|
|
=cut |
205
|
|
|
|
|
|
|
|
206
|
|
|
|
|
|
|
sub delete { |
207
|
0
|
|
|
0
|
1
|
|
my $api = shift; |
208
|
0
|
|
|
|
|
|
my @args; |
209
|
0
|
|
|
|
|
|
push @args, shift; # id |
210
|
0
|
|
|
|
|
|
my $uri = sprintf '/assets/%s.json', @args; |
211
|
0
|
|
|
|
|
|
$api->base->call("DELETE", $uri, @_); |
212
|
|
|
|
|
|
|
} |
213
|
|
|
|
|
|
|
|
214
|
|
|
|
|
|
|
|
215
|
|
|
|
|
|
|
=pod |
216
|
|
|
|
|
|
|
|
217
|
|
|
|
|
|
|
|
218
|
|
|
|
|
|
|
|
219
|
|
|
|
|
|
|
=item get |
220
|
|
|
|
|
|
|
|
221
|
|
|
|
|
|
|
my $res = $tp->assets->get($id); |
222
|
|
|
|
|
|
|
|
223
|
|
|
|
|
|
|
Get basic information about the selected asset. |
224
|
|
|
|
|
|
|
|
225
|
|
|
|
|
|
|
Returns Asset which contains following properties. |
226
|
|
|
|
|
|
|
|
227
|
|
|
|
|
|
|
=over 8 |
228
|
|
|
|
|
|
|
|
229
|
|
|
|
|
|
|
=item id |
230
|
|
|
|
|
|
|
|
231
|
|
|
|
|
|
|
(string) BERead OnlyE A URI that serves as a globally unique identifier for the user. |
232
|
|
|
|
|
|
|
|
233
|
|
|
|
|
|
|
=item urlId |
234
|
|
|
|
|
|
|
|
235
|
|
|
|
|
|
|
(string) BERead OnlyE 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. |
236
|
|
|
|
|
|
|
|
237
|
|
|
|
|
|
|
=item permalinkUrl |
238
|
|
|
|
|
|
|
|
239
|
|
|
|
|
|
|
(string) BERead OnlyE 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. |
240
|
|
|
|
|
|
|
|
241
|
|
|
|
|
|
|
=item shortUrl |
242
|
|
|
|
|
|
|
|
243
|
|
|
|
|
|
|
(string) BERead OnlyE The short version of the URL that is this asset's permalink. This is currently available only for OEPostE assetes. |
244
|
|
|
|
|
|
|
|
245
|
|
|
|
|
|
|
=item author |
246
|
|
|
|
|
|
|
|
247
|
|
|
|
|
|
|
(User) BERead OnlyE The user who created the selected asset. |
248
|
|
|
|
|
|
|
|
249
|
|
|
|
|
|
|
=item published |
250
|
|
|
|
|
|
|
|
251
|
|
|
|
|
|
|
(datetime) BERead OnlyE The time at which the asset was created, as a W3CDTF timestamp. |
252
|
|
|
|
|
|
|
|
253
|
|
|
|
|
|
|
=item content |
254
|
|
|
|
|
|
|
|
255
|
|
|
|
|
|
|
(string) The raw asset content. The MEtextFormatE 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 MEcontentE value up to 10,000 bytes long, while a OEPostE asset in a blog may have up to 65,000 bytes of content. |
256
|
|
|
|
|
|
|
|
257
|
|
|
|
|
|
|
=item renderedContent |
258
|
|
|
|
|
|
|
|
259
|
|
|
|
|
|
|
(string) BERead OnlyE The content of this asset rendered to HTML. This is currently available only for OEPostE and OEPageE assets. |
260
|
|
|
|
|
|
|
|
261
|
|
|
|
|
|
|
=item excerpt |
262
|
|
|
|
|
|
|
|
263
|
|
|
|
|
|
|
(string) BERead OnlyE A short, plain-text excerpt of the entry content. This is currently available only for OEPostE assets. |
264
|
|
|
|
|
|
|
|
265
|
|
|
|
|
|
|
=item textFormat |
266
|
|
|
|
|
|
|
|
267
|
|
|
|
|
|
|
(string) A keyword that indicates what formatting mode to use for the content of this asset. This can be CEhtmlE for assets the content of which is HTML, CEhtml_convert_linebreaksE for assets the content of which is HTML but where paragraph tags should be added automatically, or CEmarkdownE 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. |
268
|
|
|
|
|
|
|
|
269
|
|
|
|
|
|
|
=item groups |
270
|
|
|
|
|
|
|
|
271
|
|
|
|
|
|
|
(arrayEstringE) BERead OnlyE BEDeprecatedE An array of strings containing the MEidE URI of the OEGroupE object that this asset is mapped into, if any. This property has been superseded by the MEcontainerE property. |
272
|
|
|
|
|
|
|
|
273
|
|
|
|
|
|
|
=item source |
274
|
|
|
|
|
|
|
|
275
|
|
|
|
|
|
|
(AssetSource) BERead OnlyE An object describing the site from which this asset was retrieved, if the asset was obtained from an external source. |
276
|
|
|
|
|
|
|
|
277
|
|
|
|
|
|
|
=item objectTypes |
278
|
|
|
|
|
|
|
|
279
|
|
|
|
|
|
|
(setEstringE) BERead OnlyE BEDeprecatedE 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. |
280
|
|
|
|
|
|
|
|
281
|
|
|
|
|
|
|
=item objectType |
282
|
|
|
|
|
|
|
|
283
|
|
|
|
|
|
|
(string) BERead OnlyE The keyword identifying the type of asset this is. |
284
|
|
|
|
|
|
|
|
285
|
|
|
|
|
|
|
=item isFavoriteForCurrentUser |
286
|
|
|
|
|
|
|
|
287
|
|
|
|
|
|
|
(boolean) BERead OnlyE CEtrueE if this asset is a favorite for the currently authenticated user, or CEfalseE otherwise. This property is omitted from responses to anonymous requests. |
288
|
|
|
|
|
|
|
|
289
|
|
|
|
|
|
|
=item favoriteCount |
290
|
|
|
|
|
|
|
|
291
|
|
|
|
|
|
|
(integer) BERead OnlyE The number of distinct users who have added this asset as a favorite. |
292
|
|
|
|
|
|
|
|
293
|
|
|
|
|
|
|
=item commentCount |
294
|
|
|
|
|
|
|
|
295
|
|
|
|
|
|
|
(integer) BERead OnlyE 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. |
296
|
|
|
|
|
|
|
|
297
|
|
|
|
|
|
|
=item title |
298
|
|
|
|
|
|
|
|
299
|
|
|
|
|
|
|
(string) The title of the asset. |
300
|
|
|
|
|
|
|
|
301
|
|
|
|
|
|
|
=item description |
302
|
|
|
|
|
|
|
|
303
|
|
|
|
|
|
|
(string) The description of the asset. |
304
|
|
|
|
|
|
|
|
305
|
|
|
|
|
|
|
=item container |
306
|
|
|
|
|
|
|
|
307
|
|
|
|
|
|
|
(ContainerRef) BERead OnlyE An object describing the group or blog to which this asset belongs. |
308
|
|
|
|
|
|
|
|
309
|
|
|
|
|
|
|
=item publicationStatus |
310
|
|
|
|
|
|
|
|
311
|
|
|
|
|
|
|
(PublicationStatus) An object describing the visibility status and publication date for this asset. Only visibility status is editable. |
312
|
|
|
|
|
|
|
|
313
|
|
|
|
|
|
|
=item crosspostAccounts |
314
|
|
|
|
|
|
|
|
315
|
|
|
|
|
|
|
(setEstringE) BEWrite OnlyE A set of identifiers for OEAccountE objects to which to crosspost this asset when it's posted. This property is omitted when retrieving existing assets. |
316
|
|
|
|
|
|
|
|
317
|
|
|
|
|
|
|
=item isConversationsAnswer |
318
|
|
|
|
|
|
|
|
319
|
|
|
|
|
|
|
(boolean) BERead OnlyE BEDeprecatedE CEtrueE 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. |
320
|
|
|
|
|
|
|
|
321
|
|
|
|
|
|
|
=item reblogOf |
322
|
|
|
|
|
|
|
|
323
|
|
|
|
|
|
|
(AssetRef) BERead OnlyE BEDeprecatedE If this asset was created by 'reblogging' another asset, this property describes the original asset. |
324
|
|
|
|
|
|
|
|
325
|
|
|
|
|
|
|
=item reblogOfUrl |
326
|
|
|
|
|
|
|
|
327
|
|
|
|
|
|
|
(string) BERead OnlyE BEDeprecatedE 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. |
328
|
|
|
|
|
|
|
|
329
|
|
|
|
|
|
|
=item positiveVoteCount |
330
|
|
|
|
|
|
|
|
331
|
|
|
|
|
|
|
(integer) BERead OnlyE The total number of positive votes this asset has received via the NE/assets/{id}/cast-positive-voteE endpoint. |
332
|
|
|
|
|
|
|
|
333
|
|
|
|
|
|
|
=item negativeVoteCount |
334
|
|
|
|
|
|
|
|
335
|
|
|
|
|
|
|
(integer) BERead OnlyE The total number of negative votes this asset has received via the NE/assets/{id}/cast-negative-voteE endpoint. |
336
|
|
|
|
|
|
|
|
337
|
|
|
|
|
|
|
=item hasExtendedContent |
338
|
|
|
|
|
|
|
|
339
|
|
|
|
|
|
|
(boolean) BERead OnlyE CEtrueE if this asset has the extended content. This is currently supported only for OEPostE assets that are posted within a blog. |
340
|
|
|
|
|
|
|
|
341
|
|
|
|
|
|
|
|
342
|
|
|
|
|
|
|
=back |
343
|
|
|
|
|
|
|
|
344
|
|
|
|
|
|
|
=cut |
345
|
|
|
|
|
|
|
|
346
|
|
|
|
|
|
|
sub get { |
347
|
0
|
|
|
0
|
1
|
|
my $api = shift; |
348
|
0
|
|
|
|
|
|
my @args; |
349
|
0
|
|
|
|
|
|
push @args, shift; # id |
350
|
0
|
|
|
|
|
|
my $uri = sprintf '/assets/%s.json', @args; |
351
|
0
|
|
|
|
|
|
$api->base->call("GET", $uri, @_); |
352
|
|
|
|
|
|
|
} |
353
|
|
|
|
|
|
|
|
354
|
|
|
|
|
|
|
|
355
|
|
|
|
|
|
|
=pod |
356
|
|
|
|
|
|
|
|
357
|
|
|
|
|
|
|
|
358
|
|
|
|
|
|
|
|
359
|
|
|
|
|
|
|
=item put |
360
|
|
|
|
|
|
|
|
361
|
|
|
|
|
|
|
my $res = $tp->assets->put($id); |
362
|
|
|
|
|
|
|
|
363
|
|
|
|
|
|
|
Update the selected asset. |
364
|
|
|
|
|
|
|
|
365
|
|
|
|
|
|
|
Returns Asset which contains following properties. |
366
|
|
|
|
|
|
|
|
367
|
|
|
|
|
|
|
=over 8 |
368
|
|
|
|
|
|
|
|
369
|
|
|
|
|
|
|
=item id |
370
|
|
|
|
|
|
|
|
371
|
|
|
|
|
|
|
(string) BERead OnlyE A URI that serves as a globally unique identifier for the user. |
372
|
|
|
|
|
|
|
|
373
|
|
|
|
|
|
|
=item urlId |
374
|
|
|
|
|
|
|
|
375
|
|
|
|
|
|
|
(string) BERead OnlyE 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. |
376
|
|
|
|
|
|
|
|
377
|
|
|
|
|
|
|
=item permalinkUrl |
378
|
|
|
|
|
|
|
|
379
|
|
|
|
|
|
|
(string) BERead OnlyE 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. |
380
|
|
|
|
|
|
|
|
381
|
|
|
|
|
|
|
=item shortUrl |
382
|
|
|
|
|
|
|
|
383
|
|
|
|
|
|
|
(string) BERead OnlyE The short version of the URL that is this asset's permalink. This is currently available only for OEPostE assetes. |
384
|
|
|
|
|
|
|
|
385
|
|
|
|
|
|
|
=item author |
386
|
|
|
|
|
|
|
|
387
|
|
|
|
|
|
|
(User) BERead OnlyE The user who created the selected asset. |
388
|
|
|
|
|
|
|
|
389
|
|
|
|
|
|
|
=item published |
390
|
|
|
|
|
|
|
|
391
|
|
|
|
|
|
|
(datetime) BERead OnlyE The time at which the asset was created, as a W3CDTF timestamp. |
392
|
|
|
|
|
|
|
|
393
|
|
|
|
|
|
|
=item content |
394
|
|
|
|
|
|
|
|
395
|
|
|
|
|
|
|
(string) The raw asset content. The MEtextFormatE 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 MEcontentE value up to 10,000 bytes long, while a OEPostE asset in a blog may have up to 65,000 bytes of content. |
396
|
|
|
|
|
|
|
|
397
|
|
|
|
|
|
|
=item renderedContent |
398
|
|
|
|
|
|
|
|
399
|
|
|
|
|
|
|
(string) BERead OnlyE The content of this asset rendered to HTML. This is currently available only for OEPostE and OEPageE assets. |
400
|
|
|
|
|
|
|
|
401
|
|
|
|
|
|
|
=item excerpt |
402
|
|
|
|
|
|
|
|
403
|
|
|
|
|
|
|
(string) BERead OnlyE A short, plain-text excerpt of the entry content. This is currently available only for OEPostE assets. |
404
|
|
|
|
|
|
|
|
405
|
|
|
|
|
|
|
=item textFormat |
406
|
|
|
|
|
|
|
|
407
|
|
|
|
|
|
|
(string) A keyword that indicates what formatting mode to use for the content of this asset. This can be CEhtmlE for assets the content of which is HTML, CEhtml_convert_linebreaksE for assets the content of which is HTML but where paragraph tags should be added automatically, or CEmarkdownE 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. |
408
|
|
|
|
|
|
|
|
409
|
|
|
|
|
|
|
=item groups |
410
|
|
|
|
|
|
|
|
411
|
|
|
|
|
|
|
(arrayEstringE) BERead OnlyE BEDeprecatedE An array of strings containing the MEidE URI of the OEGroupE object that this asset is mapped into, if any. This property has been superseded by the MEcontainerE property. |
412
|
|
|
|
|
|
|
|
413
|
|
|
|
|
|
|
=item source |
414
|
|
|
|
|
|
|
|
415
|
|
|
|
|
|
|
(AssetSource) BERead OnlyE An object describing the site from which this asset was retrieved, if the asset was obtained from an external source. |
416
|
|
|
|
|
|
|
|
417
|
|
|
|
|
|
|
=item objectTypes |
418
|
|
|
|
|
|
|
|
419
|
|
|
|
|
|
|
(setEstringE) BERead OnlyE BEDeprecatedE 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. |
420
|
|
|
|
|
|
|
|
421
|
|
|
|
|
|
|
=item objectType |
422
|
|
|
|
|
|
|
|
423
|
|
|
|
|
|
|
(string) BERead OnlyE The keyword identifying the type of asset this is. |
424
|
|
|
|
|
|
|
|
425
|
|
|
|
|
|
|
=item isFavoriteForCurrentUser |
426
|
|
|
|
|
|
|
|
427
|
|
|
|
|
|
|
(boolean) BERead OnlyE CEtrueE if this asset is a favorite for the currently authenticated user, or CEfalseE otherwise. This property is omitted from responses to anonymous requests. |
428
|
|
|
|
|
|
|
|
429
|
|
|
|
|
|
|
=item favoriteCount |
430
|
|
|
|
|
|
|
|
431
|
|
|
|
|
|
|
(integer) BERead OnlyE The number of distinct users who have added this asset as a favorite. |
432
|
|
|
|
|
|
|
|
433
|
|
|
|
|
|
|
=item commentCount |
434
|
|
|
|
|
|
|
|
435
|
|
|
|
|
|
|
(integer) BERead OnlyE 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. |
436
|
|
|
|
|
|
|
|
437
|
|
|
|
|
|
|
=item title |
438
|
|
|
|
|
|
|
|
439
|
|
|
|
|
|
|
(string) The title of the asset. |
440
|
|
|
|
|
|
|
|
441
|
|
|
|
|
|
|
=item description |
442
|
|
|
|
|
|
|
|
443
|
|
|
|
|
|
|
(string) The description of the asset. |
444
|
|
|
|
|
|
|
|
445
|
|
|
|
|
|
|
=item container |
446
|
|
|
|
|
|
|
|
447
|
|
|
|
|
|
|
(ContainerRef) BERead OnlyE An object describing the group or blog to which this asset belongs. |
448
|
|
|
|
|
|
|
|
449
|
|
|
|
|
|
|
=item publicationStatus |
450
|
|
|
|
|
|
|
|
451
|
|
|
|
|
|
|
(PublicationStatus) An object describing the visibility status and publication date for this asset. Only visibility status is editable. |
452
|
|
|
|
|
|
|
|
453
|
|
|
|
|
|
|
=item crosspostAccounts |
454
|
|
|
|
|
|
|
|
455
|
|
|
|
|
|
|
(setEstringE) BEWrite OnlyE A set of identifiers for OEAccountE objects to which to crosspost this asset when it's posted. This property is omitted when retrieving existing assets. |
456
|
|
|
|
|
|
|
|
457
|
|
|
|
|
|
|
=item isConversationsAnswer |
458
|
|
|
|
|
|
|
|
459
|
|
|
|
|
|
|
(boolean) BERead OnlyE BEDeprecatedE CEtrueE 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. |
460
|
|
|
|
|
|
|
|
461
|
|
|
|
|
|
|
=item reblogOf |
462
|
|
|
|
|
|
|
|
463
|
|
|
|
|
|
|
(AssetRef) BERead OnlyE BEDeprecatedE If this asset was created by 'reblogging' another asset, this property describes the original asset. |
464
|
|
|
|
|
|
|
|
465
|
|
|
|
|
|
|
=item reblogOfUrl |
466
|
|
|
|
|
|
|
|
467
|
|
|
|
|
|
|
(string) BERead OnlyE BEDeprecatedE 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. |
468
|
|
|
|
|
|
|
|
469
|
|
|
|
|
|
|
=item positiveVoteCount |
470
|
|
|
|
|
|
|
|
471
|
|
|
|
|
|
|
(integer) BERead OnlyE The total number of positive votes this asset has received via the NE/assets/{id}/cast-positive-voteE endpoint. |
472
|
|
|
|
|
|
|
|
473
|
|
|
|
|
|
|
=item negativeVoteCount |
474
|
|
|
|
|
|
|
|
475
|
|
|
|
|
|
|
(integer) BERead OnlyE The total number of negative votes this asset has received via the NE/assets/{id}/cast-negative-voteE endpoint. |
476
|
|
|
|
|
|
|
|
477
|
|
|
|
|
|
|
=item hasExtendedContent |
478
|
|
|
|
|
|
|
|
479
|
|
|
|
|
|
|
(boolean) BERead OnlyE CEtrueE if this asset has the extended content. This is currently supported only for OEPostE assets that are posted within a blog. |
480
|
|
|
|
|
|
|
|
481
|
|
|
|
|
|
|
|
482
|
|
|
|
|
|
|
=back |
483
|
|
|
|
|
|
|
|
484
|
|
|
|
|
|
|
=cut |
485
|
|
|
|
|
|
|
|
486
|
|
|
|
|
|
|
sub put { |
487
|
0
|
|
|
0
|
1
|
|
my $api = shift; |
488
|
0
|
|
|
|
|
|
my @args; |
489
|
0
|
|
|
|
|
|
push @args, shift; # id |
490
|
0
|
|
|
|
|
|
my $uri = sprintf '/assets/%s.json', @args; |
491
|
0
|
|
|
|
|
|
$api->base->call("PUT", $uri, @_); |
492
|
|
|
|
|
|
|
} |
493
|
|
|
|
|
|
|
|
494
|
|
|
|
|
|
|
|
495
|
|
|
|
|
|
|
=pod |
496
|
|
|
|
|
|
|
|
497
|
|
|
|
|
|
|
|
498
|
|
|
|
|
|
|
|
499
|
|
|
|
|
|
|
=item add_category |
500
|
|
|
|
|
|
|
|
501
|
|
|
|
|
|
|
my $res = $tp->assets->add_category($id); |
502
|
|
|
|
|
|
|
|
503
|
|
|
|
|
|
|
Send label argument to add a category to an asset |
504
|
|
|
|
|
|
|
|
505
|
|
|
|
|
|
|
Returns hash reference which contains following properties. |
506
|
|
|
|
|
|
|
|
507
|
|
|
|
|
|
|
=over 8 |
508
|
|
|
|
|
|
|
|
509
|
|
|
|
|
|
|
|
510
|
|
|
|
|
|
|
=back |
511
|
|
|
|
|
|
|
|
512
|
|
|
|
|
|
|
=cut |
513
|
|
|
|
|
|
|
|
514
|
|
|
|
|
|
|
sub add_category { |
515
|
0
|
|
|
0
|
1
|
|
my $api = shift; |
516
|
0
|
|
|
|
|
|
my @args; |
517
|
0
|
|
|
|
|
|
push @args, shift; # id |
518
|
0
|
|
|
|
|
|
my $uri = sprintf '/assets/%s/add-category.json', @args; |
519
|
0
|
|
|
|
|
|
$api->base->call("POST", $uri, @_); |
520
|
|
|
|
|
|
|
} |
521
|
|
|
|
|
|
|
|
522
|
|
|
|
|
|
|
|
523
|
|
|
|
|
|
|
=pod |
524
|
|
|
|
|
|
|
|
525
|
|
|
|
|
|
|
|
526
|
|
|
|
|
|
|
|
527
|
|
|
|
|
|
|
=item cast_negative_vote |
528
|
|
|
|
|
|
|
|
529
|
|
|
|
|
|
|
my $res = $tp->assets->cast_negative_vote($id); |
530
|
|
|
|
|
|
|
|
531
|
|
|
|
|
|
|
Send a negative vote/thumbs up for an asset. |
532
|
|
|
|
|
|
|
|
533
|
|
|
|
|
|
|
Returns hash reference which contains following properties. |
534
|
|
|
|
|
|
|
|
535
|
|
|
|
|
|
|
=over 8 |
536
|
|
|
|
|
|
|
|
537
|
|
|
|
|
|
|
=item negativeVoteCount |
538
|
|
|
|
|
|
|
|
539
|
|
|
|
|
|
|
(integer) The new sum of negative votes for the asset. |
540
|
|
|
|
|
|
|
|
541
|
|
|
|
|
|
|
|
542
|
|
|
|
|
|
|
=back |
543
|
|
|
|
|
|
|
|
544
|
|
|
|
|
|
|
=cut |
545
|
|
|
|
|
|
|
|
546
|
|
|
|
|
|
|
sub cast_negative_vote { |
547
|
0
|
|
|
0
|
1
|
|
my $api = shift; |
548
|
0
|
|
|
|
|
|
my @args; |
549
|
0
|
|
|
|
|
|
push @args, shift; # id |
550
|
0
|
|
|
|
|
|
my $uri = sprintf '/assets/%s/cast-negative-vote.json', @args; |
551
|
0
|
|
|
|
|
|
$api->base->call("POST", $uri, @_); |
552
|
|
|
|
|
|
|
} |
553
|
|
|
|
|
|
|
|
554
|
|
|
|
|
|
|
|
555
|
|
|
|
|
|
|
=pod |
556
|
|
|
|
|
|
|
|
557
|
|
|
|
|
|
|
|
558
|
|
|
|
|
|
|
|
559
|
|
|
|
|
|
|
=item cast_positive_vote |
560
|
|
|
|
|
|
|
|
561
|
|
|
|
|
|
|
my $res = $tp->assets->cast_positive_vote($id); |
562
|
|
|
|
|
|
|
|
563
|
|
|
|
|
|
|
Send a positive vote/thumbs up for an asset. |
564
|
|
|
|
|
|
|
|
565
|
|
|
|
|
|
|
Returns hash reference which contains following properties. |
566
|
|
|
|
|
|
|
|
567
|
|
|
|
|
|
|
=over 8 |
568
|
|
|
|
|
|
|
|
569
|
|
|
|
|
|
|
=item positiveVoteCount |
570
|
|
|
|
|
|
|
|
571
|
|
|
|
|
|
|
(integer) The new sum of positive votes for the asset. |
572
|
|
|
|
|
|
|
|
573
|
|
|
|
|
|
|
|
574
|
|
|
|
|
|
|
=back |
575
|
|
|
|
|
|
|
|
576
|
|
|
|
|
|
|
=cut |
577
|
|
|
|
|
|
|
|
578
|
|
|
|
|
|
|
sub cast_positive_vote { |
579
|
0
|
|
|
0
|
1
|
|
my $api = shift; |
580
|
0
|
|
|
|
|
|
my @args; |
581
|
0
|
|
|
|
|
|
push @args, shift; # id |
582
|
0
|
|
|
|
|
|
my $uri = sprintf '/assets/%s/cast-positive-vote.json', @args; |
583
|
0
|
|
|
|
|
|
$api->base->call("POST", $uri, @_); |
584
|
|
|
|
|
|
|
} |
585
|
|
|
|
|
|
|
|
586
|
|
|
|
|
|
|
|
587
|
|
|
|
|
|
|
=pod |
588
|
|
|
|
|
|
|
|
589
|
|
|
|
|
|
|
|
590
|
|
|
|
|
|
|
|
591
|
|
|
|
|
|
|
=item get_categories |
592
|
|
|
|
|
|
|
|
593
|
|
|
|
|
|
|
my $res = $tp->assets->get_categories($id); |
594
|
|
|
|
|
|
|
|
595
|
|
|
|
|
|
|
Get a list of categories into which this asset has been placed within its blog. Currently supported only for OEPostE assets that are posted within a blog. |
596
|
|
|
|
|
|
|
|
597
|
|
|
|
|
|
|
Returns ListEstringE which contains following properties. |
598
|
|
|
|
|
|
|
|
599
|
|
|
|
|
|
|
=over 8 |
600
|
|
|
|
|
|
|
|
601
|
|
|
|
|
|
|
=item totalResults |
602
|
|
|
|
|
|
|
|
603
|
|
|
|
|
|
|
(integer) The total number of items in the whole list of which this list object is a paginated view. |
604
|
|
|
|
|
|
|
|
605
|
|
|
|
|
|
|
=item entries |
606
|
|
|
|
|
|
|
|
607
|
|
|
|
|
|
|
(arrayEstringE) The items within the selected slice of the list. |
608
|
|
|
|
|
|
|
|
609
|
|
|
|
|
|
|
|
610
|
|
|
|
|
|
|
=back |
611
|
|
|
|
|
|
|
|
612
|
|
|
|
|
|
|
=cut |
613
|
|
|
|
|
|
|
|
614
|
|
|
|
|
|
|
sub get_categories { |
615
|
0
|
|
|
0
|
1
|
|
my $api = shift; |
616
|
0
|
|
|
|
|
|
my @args; |
617
|
0
|
|
|
|
|
|
push @args, shift; # id |
618
|
0
|
|
|
|
|
|
my $uri = sprintf '/assets/%s/categories.json', @args; |
619
|
0
|
|
|
|
|
|
$api->base->call("GET", $uri, @_); |
620
|
|
|
|
|
|
|
} |
621
|
|
|
|
|
|
|
|
622
|
|
|
|
|
|
|
|
623
|
|
|
|
|
|
|
sub categories { |
624
|
0
|
|
|
0
|
0
|
|
my $self = shift; |
625
|
0
|
|
|
|
|
|
Carp::carp("'categories' is deprecated. Use 'get_categories' instead."); |
626
|
0
|
|
|
|
|
|
$self->get_categories(@_); |
627
|
|
|
|
|
|
|
} |
628
|
|
|
|
|
|
|
|
629
|
|
|
|
|
|
|
=pod |
630
|
|
|
|
|
|
|
|
631
|
|
|
|
|
|
|
|
632
|
|
|
|
|
|
|
|
633
|
|
|
|
|
|
|
=item get_comment_tree |
634
|
|
|
|
|
|
|
|
635
|
|
|
|
|
|
|
my $res = $tp->assets->get_comment_tree($id); |
636
|
|
|
|
|
|
|
|
637
|
|
|
|
|
|
|
Get a list of assets that were posted in response to the selected asset and their depth in the response tree |
638
|
|
|
|
|
|
|
|
639
|
|
|
|
|
|
|
Returns ListECommentTreeItemE which contains following properties. |
640
|
|
|
|
|
|
|
|
641
|
|
|
|
|
|
|
=over 8 |
642
|
|
|
|
|
|
|
|
643
|
|
|
|
|
|
|
=item totalResults |
644
|
|
|
|
|
|
|
|
645
|
|
|
|
|
|
|
(integer) The total number of items in the whole list of which this list object is a paginated view. |
646
|
|
|
|
|
|
|
|
647
|
|
|
|
|
|
|
=item entries |
648
|
|
|
|
|
|
|
|
649
|
|
|
|
|
|
|
(arrayECommentTreeItemE) The items within the selected slice of the list. |
650
|
|
|
|
|
|
|
|
651
|
|
|
|
|
|
|
|
652
|
|
|
|
|
|
|
=back |
653
|
|
|
|
|
|
|
|
654
|
|
|
|
|
|
|
=cut |
655
|
|
|
|
|
|
|
|
656
|
|
|
|
|
|
|
sub get_comment_tree { |
657
|
0
|
|
|
0
|
1
|
|
my $api = shift; |
658
|
0
|
|
|
|
|
|
my @args; |
659
|
0
|
|
|
|
|
|
push @args, shift; # id |
660
|
0
|
|
|
|
|
|
my $uri = sprintf '/assets/%s/comment-tree.json', @args; |
661
|
0
|
|
|
|
|
|
$api->base->call("GET", $uri, @_); |
662
|
|
|
|
|
|
|
} |
663
|
|
|
|
|
|
|
|
664
|
|
|
|
|
|
|
|
665
|
|
|
|
|
|
|
sub comment_tree { |
666
|
0
|
|
|
0
|
0
|
|
my $self = shift; |
667
|
0
|
|
|
|
|
|
Carp::carp("'comment_tree' is deprecated. Use 'get_comment_tree' instead."); |
668
|
0
|
|
|
|
|
|
$self->get_comment_tree(@_); |
669
|
|
|
|
|
|
|
} |
670
|
|
|
|
|
|
|
|
671
|
|
|
|
|
|
|
=pod |
672
|
|
|
|
|
|
|
|
673
|
|
|
|
|
|
|
|
674
|
|
|
|
|
|
|
|
675
|
|
|
|
|
|
|
=item post_to_comments |
676
|
|
|
|
|
|
|
|
677
|
|
|
|
|
|
|
my $res = $tp->assets->post_to_comments($id); |
678
|
|
|
|
|
|
|
|
679
|
|
|
|
|
|
|
Create a new Comment asset as a response to the selected asset. |
680
|
|
|
|
|
|
|
|
681
|
|
|
|
|
|
|
Returns Comment which contains following properties. |
682
|
|
|
|
|
|
|
|
683
|
|
|
|
|
|
|
=over 8 |
684
|
|
|
|
|
|
|
|
685
|
|
|
|
|
|
|
=item inReplyTo |
686
|
|
|
|
|
|
|
|
687
|
|
|
|
|
|
|
(AssetRef) BERead OnlyE A reference to the asset that this comment is in reply to. |
688
|
|
|
|
|
|
|
|
689
|
|
|
|
|
|
|
=item root |
690
|
|
|
|
|
|
|
|
691
|
|
|
|
|
|
|
(AssetRef) BERead OnlyE A reference to the root asset that this comment is descended from. This will be the same as MEinReplyToE unless this comment is a reply to another comment. |
692
|
|
|
|
|
|
|
|
693
|
|
|
|
|
|
|
=item publicationStatus |
694
|
|
|
|
|
|
|
|
695
|
|
|
|
|
|
|
(PublicationStatus) An object describing the visibility status and publication date for this page. Only visibility status is editable. |
696
|
|
|
|
|
|
|
|
697
|
|
|
|
|
|
|
=item suppressEvents |
698
|
|
|
|
|
|
|
|
699
|
|
|
|
|
|
|
(boolean) BEWrite OnlyE 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. |
700
|
|
|
|
|
|
|
|
701
|
|
|
|
|
|
|
=item commenter |
702
|
|
|
|
|
|
|
|
703
|
|
|
|
|
|
|
(CommenterInfo) BERead OnlyE A structure containing information about the author of this comment, which may be either an authenticated user or an unauthenticated user. |
704
|
|
|
|
|
|
|
|
705
|
|
|
|
|
|
|
=item id |
706
|
|
|
|
|
|
|
|
707
|
|
|
|
|
|
|
(string) BERead OnlyE A URI that serves as a globally unique identifier for the user. |
708
|
|
|
|
|
|
|
|
709
|
|
|
|
|
|
|
=item urlId |
710
|
|
|
|
|
|
|
|
711
|
|
|
|
|
|
|
(string) BERead OnlyE 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. |
712
|
|
|
|
|
|
|
|
713
|
|
|
|
|
|
|
=item permalinkUrl |
714
|
|
|
|
|
|
|
|
715
|
|
|
|
|
|
|
(string) BERead OnlyE 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. |
716
|
|
|
|
|
|
|
|
717
|
|
|
|
|
|
|
=item shortUrl |
718
|
|
|
|
|
|
|
|
719
|
|
|
|
|
|
|
(string) BERead OnlyE The short version of the URL that is this asset's permalink. This is currently available only for OEPostE assetes. |
720
|
|
|
|
|
|
|
|
721
|
|
|
|
|
|
|
=item author |
722
|
|
|
|
|
|
|
|
723
|
|
|
|
|
|
|
(User) BERead OnlyE The user who created the selected asset. |
724
|
|
|
|
|
|
|
|
725
|
|
|
|
|
|
|
=item published |
726
|
|
|
|
|
|
|
|
727
|
|
|
|
|
|
|
(datetime) BERead OnlyE The time at which the asset was created, as a W3CDTF timestamp. |
728
|
|
|
|
|
|
|
|
729
|
|
|
|
|
|
|
=item content |
730
|
|
|
|
|
|
|
|
731
|
|
|
|
|
|
|
(string) The raw asset content. The MEtextFormatE 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 MEcontentE value up to 10,000 bytes long, while a OEPostE asset in a blog may have up to 65,000 bytes of content. |
732
|
|
|
|
|
|
|
|
733
|
|
|
|
|
|
|
=item renderedContent |
734
|
|
|
|
|
|
|
|
735
|
|
|
|
|
|
|
(string) BERead OnlyE The content of this asset rendered to HTML. This is currently available only for OEPostE and OEPageE assets. |
736
|
|
|
|
|
|
|
|
737
|
|
|
|
|
|
|
=item excerpt |
738
|
|
|
|
|
|
|
|
739
|
|
|
|
|
|
|
(string) BERead OnlyE A short, plain-text excerpt of the entry content. This is currently available only for OEPostE assets. |
740
|
|
|
|
|
|
|
|
741
|
|
|
|
|
|
|
=item textFormat |
742
|
|
|
|
|
|
|
|
743
|
|
|
|
|
|
|
(string) A keyword that indicates what formatting mode to use for the content of this asset. This can be CEhtmlE for assets the content of which is HTML, CEhtml_convert_linebreaksE for assets the content of which is HTML but where paragraph tags should be added automatically, or CEmarkdownE 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. |
744
|
|
|
|
|
|
|
|
745
|
|
|
|
|
|
|
=item groups |
746
|
|
|
|
|
|
|
|
747
|
|
|
|
|
|
|
(arrayEstringE) BERead OnlyE BEDeprecatedE An array of strings containing the MEidE URI of the OEGroupE object that this asset is mapped into, if any. This property has been superseded by the MEcontainerE property. |
748
|
|
|
|
|
|
|
|
749
|
|
|
|
|
|
|
=item source |
750
|
|
|
|
|
|
|
|
751
|
|
|
|
|
|
|
(AssetSource) BERead OnlyE An object describing the site from which this asset was retrieved, if the asset was obtained from an external source. |
752
|
|
|
|
|
|
|
|
753
|
|
|
|
|
|
|
=item objectTypes |
754
|
|
|
|
|
|
|
|
755
|
|
|
|
|
|
|
(setEstringE) BERead OnlyE BEDeprecatedE 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. |
756
|
|
|
|
|
|
|
|
757
|
|
|
|
|
|
|
=item objectType |
758
|
|
|
|
|
|
|
|
759
|
|
|
|
|
|
|
(string) BERead OnlyE The keyword identifying the type of asset this is. |
760
|
|
|
|
|
|
|
|
761
|
|
|
|
|
|
|
=item isFavoriteForCurrentUser |
762
|
|
|
|
|
|
|
|
763
|
|
|
|
|
|
|
(boolean) BERead OnlyE CEtrueE if this asset is a favorite for the currently authenticated user, or CEfalseE otherwise. This property is omitted from responses to anonymous requests. |
764
|
|
|
|
|
|
|
|
765
|
|
|
|
|
|
|
=item favoriteCount |
766
|
|
|
|
|
|
|
|
767
|
|
|
|
|
|
|
(integer) BERead OnlyE The number of distinct users who have added this asset as a favorite. |
768
|
|
|
|
|
|
|
|
769
|
|
|
|
|
|
|
=item commentCount |
770
|
|
|
|
|
|
|
|
771
|
|
|
|
|
|
|
(integer) BERead OnlyE 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. |
772
|
|
|
|
|
|
|
|
773
|
|
|
|
|
|
|
=item title |
774
|
|
|
|
|
|
|
|
775
|
|
|
|
|
|
|
(string) The title of the asset. |
776
|
|
|
|
|
|
|
|
777
|
|
|
|
|
|
|
=item description |
778
|
|
|
|
|
|
|
|
779
|
|
|
|
|
|
|
(string) The description of the asset. |
780
|
|
|
|
|
|
|
|
781
|
|
|
|
|
|
|
=item container |
782
|
|
|
|
|
|
|
|
783
|
|
|
|
|
|
|
(ContainerRef) BERead OnlyE An object describing the group or blog to which this asset belongs. |
784
|
|
|
|
|
|
|
|
785
|
|
|
|
|
|
|
=item publicationStatus |
786
|
|
|
|
|
|
|
|
787
|
|
|
|
|
|
|
(PublicationStatus) An object describing the visibility status and publication date for this asset. Only visibility status is editable. |
788
|
|
|
|
|
|
|
|
789
|
|
|
|
|
|
|
=item crosspostAccounts |
790
|
|
|
|
|
|
|
|
791
|
|
|
|
|
|
|
(setEstringE) BEWrite OnlyE A set of identifiers for OEAccountE objects to which to crosspost this asset when it's posted. This property is omitted when retrieving existing assets. |
792
|
|
|
|
|
|
|
|
793
|
|
|
|
|
|
|
=item isConversationsAnswer |
794
|
|
|
|
|
|
|
|
795
|
|
|
|
|
|
|
(boolean) BERead OnlyE BEDeprecatedE CEtrueE 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. |
796
|
|
|
|
|
|
|
|
797
|
|
|
|
|
|
|
=item reblogOf |
798
|
|
|
|
|
|
|
|
799
|
|
|
|
|
|
|
(AssetRef) BERead OnlyE BEDeprecatedE If this asset was created by 'reblogging' another asset, this property describes the original asset. |
800
|
|
|
|
|
|
|
|
801
|
|
|
|
|
|
|
=item reblogOfUrl |
802
|
|
|
|
|
|
|
|
803
|
|
|
|
|
|
|
(string) BERead OnlyE BEDeprecatedE 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. |
804
|
|
|
|
|
|
|
|
805
|
|
|
|
|
|
|
=item positiveVoteCount |
806
|
|
|
|
|
|
|
|
807
|
|
|
|
|
|
|
(integer) BERead OnlyE The total number of positive votes this asset has received via the NE/assets/{id}/cast-positive-voteE endpoint. |
808
|
|
|
|
|
|
|
|
809
|
|
|
|
|
|
|
=item negativeVoteCount |
810
|
|
|
|
|
|
|
|
811
|
|
|
|
|
|
|
(integer) BERead OnlyE The total number of negative votes this asset has received via the NE/assets/{id}/cast-negative-voteE endpoint. |
812
|
|
|
|
|
|
|
|
813
|
|
|
|
|
|
|
=item hasExtendedContent |
814
|
|
|
|
|
|
|
|
815
|
|
|
|
|
|
|
(boolean) BERead OnlyE CEtrueE if this asset has the extended content. This is currently supported only for OEPostE assets that are posted within a blog. |
816
|
|
|
|
|
|
|
|
817
|
|
|
|
|
|
|
|
818
|
|
|
|
|
|
|
=back |
819
|
|
|
|
|
|
|
|
820
|
|
|
|
|
|
|
=cut |
821
|
|
|
|
|
|
|
|
822
|
|
|
|
|
|
|
sub post_to_comments { |
823
|
0
|
|
|
0
|
1
|
|
my $api = shift; |
824
|
0
|
|
|
|
|
|
my @args; |
825
|
0
|
|
|
|
|
|
push @args, shift; # id |
826
|
0
|
|
|
|
|
|
my $uri = sprintf '/assets/%s/comments.json', @args; |
827
|
0
|
|
|
|
|
|
$api->base->call("POST", $uri, @_); |
828
|
|
|
|
|
|
|
} |
829
|
|
|
|
|
|
|
|
830
|
|
|
|
|
|
|
|
831
|
|
|
|
|
|
|
=pod |
832
|
|
|
|
|
|
|
|
833
|
|
|
|
|
|
|
|
834
|
|
|
|
|
|
|
|
835
|
|
|
|
|
|
|
=item get_comments |
836
|
|
|
|
|
|
|
|
837
|
|
|
|
|
|
|
my $res = $tp->assets->get_comments($id); |
838
|
|
|
|
|
|
|
|
839
|
|
|
|
|
|
|
Get a list of assets that were posted in response to the selected asset. |
840
|
|
|
|
|
|
|
|
841
|
|
|
|
|
|
|
Returns ListECommentE which contains following properties. |
842
|
|
|
|
|
|
|
|
843
|
|
|
|
|
|
|
=over 8 |
844
|
|
|
|
|
|
|
|
845
|
|
|
|
|
|
|
=item totalResults |
846
|
|
|
|
|
|
|
|
847
|
|
|
|
|
|
|
(integer) The total number of items in the whole list of which this list object is a paginated view. |
848
|
|
|
|
|
|
|
|
849
|
|
|
|
|
|
|
=item entries |
850
|
|
|
|
|
|
|
|
851
|
|
|
|
|
|
|
(arrayECommentE) The items within the selected slice of the list. |
852
|
|
|
|
|
|
|
|
853
|
|
|
|
|
|
|
|
854
|
|
|
|
|
|
|
=back |
855
|
|
|
|
|
|
|
|
856
|
|
|
|
|
|
|
=cut |
857
|
|
|
|
|
|
|
|
858
|
|
|
|
|
|
|
sub get_comments { |
859
|
0
|
|
|
0
|
1
|
|
my $api = shift; |
860
|
0
|
|
|
|
|
|
my @args; |
861
|
0
|
|
|
|
|
|
push @args, shift; # id |
862
|
0
|
|
|
|
|
|
my $uri = sprintf '/assets/%s/comments.json', @args; |
863
|
0
|
|
|
|
|
|
$api->base->call("GET", $uri, @_); |
864
|
|
|
|
|
|
|
} |
865
|
|
|
|
|
|
|
|
866
|
|
|
|
|
|
|
|
867
|
|
|
|
|
|
|
sub comments { |
868
|
0
|
|
|
0
|
0
|
|
my $self = shift; |
869
|
0
|
|
|
|
|
|
Carp::carp("'comments' is deprecated. Use 'get_comments' instead."); |
870
|
0
|
|
|
|
|
|
$self->get_comments(@_); |
871
|
|
|
|
|
|
|
} |
872
|
|
|
|
|
|
|
|
873
|
|
|
|
|
|
|
=pod |
874
|
|
|
|
|
|
|
|
875
|
|
|
|
|
|
|
|
876
|
|
|
|
|
|
|
|
877
|
|
|
|
|
|
|
=item get_extended_content |
878
|
|
|
|
|
|
|
|
879
|
|
|
|
|
|
|
my $res = $tp->assets->get_extended_content($id); |
880
|
|
|
|
|
|
|
|
881
|
|
|
|
|
|
|
Get the extended content for the asset, if any. Currently supported only for OEPostE assets that are posted within a blog. |
882
|
|
|
|
|
|
|
|
883
|
|
|
|
|
|
|
Returns AssetExtendedContent which contains following properties. |
884
|
|
|
|
|
|
|
|
885
|
|
|
|
|
|
|
=over 8 |
886
|
|
|
|
|
|
|
|
887
|
|
|
|
|
|
|
=item renderedExtendedContent |
888
|
|
|
|
|
|
|
|
889
|
|
|
|
|
|
|
(string) The HTML rendered version of this asset's extended content, if it has any. Otherwise, this property is omitted. |
890
|
|
|
|
|
|
|
|
891
|
|
|
|
|
|
|
|
892
|
|
|
|
|
|
|
=back |
893
|
|
|
|
|
|
|
|
894
|
|
|
|
|
|
|
=cut |
895
|
|
|
|
|
|
|
|
896
|
|
|
|
|
|
|
sub get_extended_content { |
897
|
0
|
|
|
0
|
1
|
|
my $api = shift; |
898
|
0
|
|
|
|
|
|
my @args; |
899
|
0
|
|
|
|
|
|
push @args, shift; # id |
900
|
0
|
|
|
|
|
|
my $uri = sprintf '/assets/%s/extended-content.json', @args; |
901
|
0
|
|
|
|
|
|
$api->base->call("GET", $uri, @_); |
902
|
|
|
|
|
|
|
} |
903
|
|
|
|
|
|
|
|
904
|
|
|
|
|
|
|
|
905
|
|
|
|
|
|
|
sub extended_content { |
906
|
0
|
|
|
0
|
0
|
|
my $self = shift; |
907
|
0
|
|
|
|
|
|
Carp::carp("'extended_content' is deprecated. Use 'get_extended_content' instead."); |
908
|
0
|
|
|
|
|
|
$self->get_extended_content(@_); |
909
|
|
|
|
|
|
|
} |
910
|
|
|
|
|
|
|
|
911
|
|
|
|
|
|
|
=pod |
912
|
|
|
|
|
|
|
|
913
|
|
|
|
|
|
|
|
914
|
|
|
|
|
|
|
|
915
|
|
|
|
|
|
|
=item get_favorites |
916
|
|
|
|
|
|
|
|
917
|
|
|
|
|
|
|
my $res = $tp->assets->get_favorites($id); |
918
|
|
|
|
|
|
|
|
919
|
|
|
|
|
|
|
Get a list of favorites that have been created for the selected asset. |
920
|
|
|
|
|
|
|
|
921
|
|
|
|
|
|
|
Returns ListEFavoriteE which contains following properties. |
922
|
|
|
|
|
|
|
|
923
|
|
|
|
|
|
|
=over 8 |
924
|
|
|
|
|
|
|
|
925
|
|
|
|
|
|
|
=item totalResults |
926
|
|
|
|
|
|
|
|
927
|
|
|
|
|
|
|
(integer) The total number of items in the whole list of which this list object is a paginated view. |
928
|
|
|
|
|
|
|
|
929
|
|
|
|
|
|
|
=item entries |
930
|
|
|
|
|
|
|
|
931
|
|
|
|
|
|
|
(arrayEFavoriteE) The items within the selected slice of the list. |
932
|
|
|
|
|
|
|
|
933
|
|
|
|
|
|
|
|
934
|
|
|
|
|
|
|
=back |
935
|
|
|
|
|
|
|
|
936
|
|
|
|
|
|
|
=cut |
937
|
|
|
|
|
|
|
|
938
|
|
|
|
|
|
|
sub get_favorites { |
939
|
0
|
|
|
0
|
1
|
|
my $api = shift; |
940
|
0
|
|
|
|
|
|
my @args; |
941
|
0
|
|
|
|
|
|
push @args, shift; # id |
942
|
0
|
|
|
|
|
|
my $uri = sprintf '/assets/%s/favorites.json', @args; |
943
|
0
|
|
|
|
|
|
$api->base->call("GET", $uri, @_); |
944
|
|
|
|
|
|
|
} |
945
|
|
|
|
|
|
|
|
946
|
|
|
|
|
|
|
|
947
|
|
|
|
|
|
|
sub favorites { |
948
|
0
|
|
|
0
|
0
|
|
my $self = shift; |
949
|
0
|
|
|
|
|
|
Carp::carp("'favorites' is deprecated. Use 'get_favorites' instead."); |
950
|
0
|
|
|
|
|
|
$self->get_favorites(@_); |
951
|
|
|
|
|
|
|
} |
952
|
|
|
|
|
|
|
|
953
|
|
|
|
|
|
|
=pod |
954
|
|
|
|
|
|
|
|
955
|
|
|
|
|
|
|
|
956
|
|
|
|
|
|
|
|
957
|
|
|
|
|
|
|
=item get_feedback_status |
958
|
|
|
|
|
|
|
|
959
|
|
|
|
|
|
|
my $res = $tp->assets->get_feedback_status($id); |
960
|
|
|
|
|
|
|
|
961
|
|
|
|
|
|
|
Get the feedback status of the selected asset. |
962
|
|
|
|
|
|
|
|
963
|
|
|
|
|
|
|
Returns FeedbackStatus which contains following properties. |
964
|
|
|
|
|
|
|
|
965
|
|
|
|
|
|
|
=over 8 |
966
|
|
|
|
|
|
|
|
967
|
|
|
|
|
|
|
=item allowComments |
968
|
|
|
|
|
|
|
|
969
|
|
|
|
|
|
|
(boolean) CEtrueE if new comments may be posted to the related asset, or CEfalseE if no new comments are accepted. |
970
|
|
|
|
|
|
|
|
971
|
|
|
|
|
|
|
=item showComments |
972
|
|
|
|
|
|
|
|
973
|
|
|
|
|
|
|
(boolean) CEtrueE if comments should be displayed on the related asset's permalink page, or CEfalseE if they should be hidden. |
974
|
|
|
|
|
|
|
|
975
|
|
|
|
|
|
|
=item allowTrackback |
976
|
|
|
|
|
|
|
|
977
|
|
|
|
|
|
|
(boolean) CEtrueE if new trackback pings may be posted to the related asset, or CEfalseE if no new pings are accepted. |
978
|
|
|
|
|
|
|
|
979
|
|
|
|
|
|
|
|
980
|
|
|
|
|
|
|
=back |
981
|
|
|
|
|
|
|
|
982
|
|
|
|
|
|
|
=cut |
983
|
|
|
|
|
|
|
|
984
|
|
|
|
|
|
|
sub get_feedback_status { |
985
|
0
|
|
|
0
|
1
|
|
my $api = shift; |
986
|
0
|
|
|
|
|
|
my @args; |
987
|
0
|
|
|
|
|
|
push @args, shift; # id |
988
|
0
|
|
|
|
|
|
my $uri = sprintf '/assets/%s/feedback-status.json', @args; |
989
|
0
|
|
|
|
|
|
$api->base->call("GET", $uri, @_); |
990
|
|
|
|
|
|
|
} |
991
|
|
|
|
|
|
|
|
992
|
|
|
|
|
|
|
|
993
|
|
|
|
|
|
|
sub feedback_status { |
994
|
0
|
|
|
0
|
0
|
|
my $self = shift; |
995
|
0
|
|
|
|
|
|
Carp::carp("'feedback_status' is deprecated. Use 'get_feedback_status' instead."); |
996
|
0
|
|
|
|
|
|
$self->get_feedback_status(@_); |
997
|
|
|
|
|
|
|
} |
998
|
|
|
|
|
|
|
|
999
|
|
|
|
|
|
|
=pod |
1000
|
|
|
|
|
|
|
|
1001
|
|
|
|
|
|
|
|
1002
|
|
|
|
|
|
|
|
1003
|
|
|
|
|
|
|
=item put_feedback_status |
1004
|
|
|
|
|
|
|
|
1005
|
|
|
|
|
|
|
my $res = $tp->assets->put_feedback_status($id); |
1006
|
|
|
|
|
|
|
|
1007
|
|
|
|
|
|
|
Set the feedback status of the selected asset. |
1008
|
|
|
|
|
|
|
|
1009
|
|
|
|
|
|
|
Returns FeedbackStatus which contains following properties. |
1010
|
|
|
|
|
|
|
|
1011
|
|
|
|
|
|
|
=over 8 |
1012
|
|
|
|
|
|
|
|
1013
|
|
|
|
|
|
|
=item allowComments |
1014
|
|
|
|
|
|
|
|
1015
|
|
|
|
|
|
|
(boolean) CEtrueE if new comments may be posted to the related asset, or CEfalseE if no new comments are accepted. |
1016
|
|
|
|
|
|
|
|
1017
|
|
|
|
|
|
|
=item showComments |
1018
|
|
|
|
|
|
|
|
1019
|
|
|
|
|
|
|
(boolean) CEtrueE if comments should be displayed on the related asset's permalink page, or CEfalseE if they should be hidden. |
1020
|
|
|
|
|
|
|
|
1021
|
|
|
|
|
|
|
=item allowTrackback |
1022
|
|
|
|
|
|
|
|
1023
|
|
|
|
|
|
|
(boolean) CEtrueE if new trackback pings may be posted to the related asset, or CEfalseE if no new pings are accepted. |
1024
|
|
|
|
|
|
|
|
1025
|
|
|
|
|
|
|
|
1026
|
|
|
|
|
|
|
=back |
1027
|
|
|
|
|
|
|
|
1028
|
|
|
|
|
|
|
=cut |
1029
|
|
|
|
|
|
|
|
1030
|
|
|
|
|
|
|
sub put_feedback_status { |
1031
|
0
|
|
|
0
|
1
|
|
my $api = shift; |
1032
|
0
|
|
|
|
|
|
my @args; |
1033
|
0
|
|
|
|
|
|
push @args, shift; # id |
1034
|
0
|
|
|
|
|
|
my $uri = sprintf '/assets/%s/feedback-status.json', @args; |
1035
|
0
|
|
|
|
|
|
$api->base->call("PUT", $uri, @_); |
1036
|
|
|
|
|
|
|
} |
1037
|
|
|
|
|
|
|
|
1038
|
|
|
|
|
|
|
|
1039
|
|
|
|
|
|
|
=pod |
1040
|
|
|
|
|
|
|
|
1041
|
|
|
|
|
|
|
|
1042
|
|
|
|
|
|
|
|
1043
|
|
|
|
|
|
|
=item make_comment_preview |
1044
|
|
|
|
|
|
|
|
1045
|
|
|
|
|
|
|
my $res = $tp->assets->make_comment_preview($id); |
1046
|
|
|
|
|
|
|
|
1047
|
|
|
|
|
|
|
Send relevant data to get back a model of what the submitted comment will look like. |
1048
|
|
|
|
|
|
|
|
1049
|
|
|
|
|
|
|
Returns hash reference which contains following properties. |
1050
|
|
|
|
|
|
|
|
1051
|
|
|
|
|
|
|
=over 8 |
1052
|
|
|
|
|
|
|
|
1053
|
|
|
|
|
|
|
=item comment |
1054
|
|
|
|
|
|
|
|
1055
|
|
|
|
|
|
|
(Asset) A mockup of the future comment. |
1056
|
|
|
|
|
|
|
|
1057
|
|
|
|
|
|
|
|
1058
|
|
|
|
|
|
|
=back |
1059
|
|
|
|
|
|
|
|
1060
|
|
|
|
|
|
|
=cut |
1061
|
|
|
|
|
|
|
|
1062
|
|
|
|
|
|
|
sub make_comment_preview { |
1063
|
0
|
|
|
0
|
1
|
|
my $api = shift; |
1064
|
0
|
|
|
|
|
|
my @args; |
1065
|
0
|
|
|
|
|
|
push @args, shift; # id |
1066
|
0
|
|
|
|
|
|
my $uri = sprintf '/assets/%s/make-comment-preview.json', @args; |
1067
|
0
|
|
|
|
|
|
$api->base->call("POST", $uri, @_); |
1068
|
|
|
|
|
|
|
} |
1069
|
|
|
|
|
|
|
|
1070
|
|
|
|
|
|
|
|
1071
|
|
|
|
|
|
|
=pod |
1072
|
|
|
|
|
|
|
|
1073
|
|
|
|
|
|
|
|
1074
|
|
|
|
|
|
|
|
1075
|
|
|
|
|
|
|
=item get_media_assets |
1076
|
|
|
|
|
|
|
|
1077
|
|
|
|
|
|
|
my $res = $tp->assets->get_media_assets($id); |
1078
|
|
|
|
|
|
|
|
1079
|
|
|
|
|
|
|
Get a list of media assets that are embedded in the content of the selected asset. |
1080
|
|
|
|
|
|
|
|
1081
|
|
|
|
|
|
|
Returns ListEAssetE which contains following properties. |
1082
|
|
|
|
|
|
|
|
1083
|
|
|
|
|
|
|
=over 8 |
1084
|
|
|
|
|
|
|
|
1085
|
|
|
|
|
|
|
=item totalResults |
1086
|
|
|
|
|
|
|
|
1087
|
|
|
|
|
|
|
(integer) The total number of items in the whole list of which this list object is a paginated view. |
1088
|
|
|
|
|
|
|
|
1089
|
|
|
|
|
|
|
=item entries |
1090
|
|
|
|
|
|
|
|
1091
|
|
|
|
|
|
|
(arrayEAssetE) The items within the selected slice of the list. |
1092
|
|
|
|
|
|
|
|
1093
|
|
|
|
|
|
|
|
1094
|
|
|
|
|
|
|
=back |
1095
|
|
|
|
|
|
|
|
1096
|
|
|
|
|
|
|
=cut |
1097
|
|
|
|
|
|
|
|
1098
|
|
|
|
|
|
|
sub get_media_assets { |
1099
|
0
|
|
|
0
|
1
|
|
my $api = shift; |
1100
|
0
|
|
|
|
|
|
my @args; |
1101
|
0
|
|
|
|
|
|
push @args, shift; # id |
1102
|
0
|
|
|
|
|
|
my $uri = sprintf '/assets/%s/media-assets.json', @args; |
1103
|
0
|
|
|
|
|
|
$api->base->call("GET", $uri, @_); |
1104
|
|
|
|
|
|
|
} |
1105
|
|
|
|
|
|
|
|
1106
|
|
|
|
|
|
|
|
1107
|
|
|
|
|
|
|
sub media_assets { |
1108
|
0
|
|
|
0
|
0
|
|
my $self = shift; |
1109
|
0
|
|
|
|
|
|
Carp::carp("'media_assets' is deprecated. Use 'get_media_assets' instead."); |
1110
|
0
|
|
|
|
|
|
$self->get_media_assets(@_); |
1111
|
|
|
|
|
|
|
} |
1112
|
|
|
|
|
|
|
|
1113
|
|
|
|
|
|
|
=pod |
1114
|
|
|
|
|
|
|
|
1115
|
|
|
|
|
|
|
|
1116
|
|
|
|
|
|
|
|
1117
|
|
|
|
|
|
|
=item get_publication_status |
1118
|
|
|
|
|
|
|
|
1119
|
|
|
|
|
|
|
my $res = $tp->assets->get_publication_status($id); |
1120
|
|
|
|
|
|
|
|
1121
|
|
|
|
|
|
|
Get the publication status of the selected asset. |
1122
|
|
|
|
|
|
|
|
1123
|
|
|
|
|
|
|
Returns PublicationStatus which contains following properties. |
1124
|
|
|
|
|
|
|
|
1125
|
|
|
|
|
|
|
=over 8 |
1126
|
|
|
|
|
|
|
|
1127
|
|
|
|
|
|
|
=item publicationDate |
1128
|
|
|
|
|
|
|
|
1129
|
|
|
|
|
|
|
(string) The time at which the related asset was (or will be) published, as a W3CDTF timestamp. If the related asset has been scheduled to be posted later, this property's timestamp will be in the future. |
1130
|
|
|
|
|
|
|
|
1131
|
|
|
|
|
|
|
=item draft |
1132
|
|
|
|
|
|
|
|
1133
|
|
|
|
|
|
|
(boolean) CEtrueE if this asset is private (not yet published), or CEfalseE if it has been published. |
1134
|
|
|
|
|
|
|
|
1135
|
|
|
|
|
|
|
|
1136
|
|
|
|
|
|
|
=back |
1137
|
|
|
|
|
|
|
|
1138
|
|
|
|
|
|
|
=cut |
1139
|
|
|
|
|
|
|
|
1140
|
|
|
|
|
|
|
sub get_publication_status { |
1141
|
0
|
|
|
0
|
1
|
|
my $api = shift; |
1142
|
0
|
|
|
|
|
|
my @args; |
1143
|
0
|
|
|
|
|
|
push @args, shift; # id |
1144
|
0
|
|
|
|
|
|
my $uri = sprintf '/assets/%s/publication-status.json', @args; |
1145
|
0
|
|
|
|
|
|
$api->base->call("GET", $uri, @_); |
1146
|
|
|
|
|
|
|
} |
1147
|
|
|
|
|
|
|
|
1148
|
|
|
|
|
|
|
|
1149
|
|
|
|
|
|
|
sub publication_status { |
1150
|
0
|
|
|
0
|
0
|
|
my $self = shift; |
1151
|
0
|
|
|
|
|
|
Carp::carp("'publication_status' is deprecated. Use 'get_publication_status' instead."); |
1152
|
0
|
|
|
|
|
|
$self->get_publication_status(@_); |
1153
|
|
|
|
|
|
|
} |
1154
|
|
|
|
|
|
|
|
1155
|
|
|
|
|
|
|
=pod |
1156
|
|
|
|
|
|
|
|
1157
|
|
|
|
|
|
|
|
1158
|
|
|
|
|
|
|
|
1159
|
|
|
|
|
|
|
=item put_publication_status |
1160
|
|
|
|
|
|
|
|
1161
|
|
|
|
|
|
|
my $res = $tp->assets->put_publication_status($id); |
1162
|
|
|
|
|
|
|
|
1163
|
|
|
|
|
|
|
Set the publication status of the selected asset. |
1164
|
|
|
|
|
|
|
|
1165
|
|
|
|
|
|
|
Returns PublicationStatus which contains following properties. |
1166
|
|
|
|
|
|
|
|
1167
|
|
|
|
|
|
|
=over 8 |
1168
|
|
|
|
|
|
|
|
1169
|
|
|
|
|
|
|
=item publicationDate |
1170
|
|
|
|
|
|
|
|
1171
|
|
|
|
|
|
|
(string) The time at which the related asset was (or will be) published, as a W3CDTF timestamp. If the related asset has been scheduled to be posted later, this property's timestamp will be in the future. |
1172
|
|
|
|
|
|
|
|
1173
|
|
|
|
|
|
|
=item draft |
1174
|
|
|
|
|
|
|
|
1175
|
|
|
|
|
|
|
(boolean) CEtrueE if this asset is private (not yet published), or CEfalseE if it has been published. |
1176
|
|
|
|
|
|
|
|
1177
|
|
|
|
|
|
|
|
1178
|
|
|
|
|
|
|
=back |
1179
|
|
|
|
|
|
|
|
1180
|
|
|
|
|
|
|
=cut |
1181
|
|
|
|
|
|
|
|
1182
|
|
|
|
|
|
|
sub put_publication_status { |
1183
|
0
|
|
|
0
|
1
|
|
my $api = shift; |
1184
|
0
|
|
|
|
|
|
my @args; |
1185
|
0
|
|
|
|
|
|
push @args, shift; # id |
1186
|
0
|
|
|
|
|
|
my $uri = sprintf '/assets/%s/publication-status.json', @args; |
1187
|
0
|
|
|
|
|
|
$api->base->call("PUT", $uri, @_); |
1188
|
|
|
|
|
|
|
} |
1189
|
|
|
|
|
|
|
|
1190
|
|
|
|
|
|
|
|
1191
|
|
|
|
|
|
|
=pod |
1192
|
|
|
|
|
|
|
|
1193
|
|
|
|
|
|
|
|
1194
|
|
|
|
|
|
|
|
1195
|
|
|
|
|
|
|
=item get_reblogs |
1196
|
|
|
|
|
|
|
|
1197
|
|
|
|
|
|
|
my $res = $tp->assets->get_reblogs($id); |
1198
|
|
|
|
|
|
|
|
1199
|
|
|
|
|
|
|
Get a list of posts that were posted as reblogs of the selected asset. |
1200
|
|
|
|
|
|
|
|
1201
|
|
|
|
|
|
|
Returns ListEPostE which contains following properties. |
1202
|
|
|
|
|
|
|
|
1203
|
|
|
|
|
|
|
=over 8 |
1204
|
|
|
|
|
|
|
|
1205
|
|
|
|
|
|
|
=item totalResults |
1206
|
|
|
|
|
|
|
|
1207
|
|
|
|
|
|
|
(integer) The total number of items in the whole list of which this list object is a paginated view. |
1208
|
|
|
|
|
|
|
|
1209
|
|
|
|
|
|
|
=item entries |
1210
|
|
|
|
|
|
|
|
1211
|
|
|
|
|
|
|
(arrayEPostE) The items within the selected slice of the list. |
1212
|
|
|
|
|
|
|
|
1213
|
|
|
|
|
|
|
|
1214
|
|
|
|
|
|
|
=back |
1215
|
|
|
|
|
|
|
|
1216
|
|
|
|
|
|
|
=cut |
1217
|
|
|
|
|
|
|
|
1218
|
|
|
|
|
|
|
sub get_reblogs { |
1219
|
0
|
|
|
0
|
1
|
|
my $api = shift; |
1220
|
0
|
|
|
|
|
|
my @args; |
1221
|
0
|
|
|
|
|
|
push @args, shift; # id |
1222
|
0
|
|
|
|
|
|
my $uri = sprintf '/assets/%s/reblogs.json', @args; |
1223
|
0
|
|
|
|
|
|
$api->base->call("GET", $uri, @_); |
1224
|
|
|
|
|
|
|
} |
1225
|
|
|
|
|
|
|
|
1226
|
|
|
|
|
|
|
|
1227
|
|
|
|
|
|
|
sub reblogs { |
1228
|
0
|
|
|
0
|
0
|
|
my $self = shift; |
1229
|
0
|
|
|
|
|
|
Carp::carp("'reblogs' is deprecated. Use 'get_reblogs' instead."); |
1230
|
0
|
|
|
|
|
|
$self->get_reblogs(@_); |
1231
|
|
|
|
|
|
|
} |
1232
|
|
|
|
|
|
|
|
1233
|
|
|
|
|
|
|
=pod |
1234
|
|
|
|
|
|
|
|
1235
|
|
|
|
|
|
|
|
1236
|
|
|
|
|
|
|
|
1237
|
|
|
|
|
|
|
=item remove_category |
1238
|
|
|
|
|
|
|
|
1239
|
|
|
|
|
|
|
my $res = $tp->assets->remove_category($id); |
1240
|
|
|
|
|
|
|
|
1241
|
|
|
|
|
|
|
Send label argument to remove a category from an asset |
1242
|
|
|
|
|
|
|
|
1243
|
|
|
|
|
|
|
Returns hash reference which contains following properties. |
1244
|
|
|
|
|
|
|
|
1245
|
|
|
|
|
|
|
=over 8 |
1246
|
|
|
|
|
|
|
|
1247
|
|
|
|
|
|
|
|
1248
|
|
|
|
|
|
|
=back |
1249
|
|
|
|
|
|
|
|
1250
|
|
|
|
|
|
|
=cut |
1251
|
|
|
|
|
|
|
|
1252
|
|
|
|
|
|
|
sub remove_category { |
1253
|
0
|
|
|
0
|
1
|
|
my $api = shift; |
1254
|
0
|
|
|
|
|
|
my @args; |
1255
|
0
|
|
|
|
|
|
push @args, shift; # id |
1256
|
0
|
|
|
|
|
|
my $uri = sprintf '/assets/%s/remove-category.json', @args; |
1257
|
0
|
|
|
|
|
|
$api->base->call("POST", $uri, @_); |
1258
|
|
|
|
|
|
|
} |
1259
|
|
|
|
|
|
|
|
1260
|
|
|
|
|
|
|
|
1261
|
|
|
|
|
|
|
=pod |
1262
|
|
|
|
|
|
|
|
1263
|
|
|
|
|
|
|
|
1264
|
|
|
|
|
|
|
|
1265
|
|
|
|
|
|
|
=item update_publication_status |
1266
|
|
|
|
|
|
|
|
1267
|
|
|
|
|
|
|
my $res = $tp->assets->update_publication_status($id); |
1268
|
|
|
|
|
|
|
|
1269
|
|
|
|
|
|
|
Adjust publication status of an asset |
1270
|
|
|
|
|
|
|
|
1271
|
|
|
|
|
|
|
Returns hash reference which contains following properties. |
1272
|
|
|
|
|
|
|
|
1273
|
|
|
|
|
|
|
=over 8 |
1274
|
|
|
|
|
|
|
|
1275
|
|
|
|
|
|
|
|
1276
|
|
|
|
|
|
|
=back |
1277
|
|
|
|
|
|
|
|
1278
|
|
|
|
|
|
|
=cut |
1279
|
|
|
|
|
|
|
|
1280
|
|
|
|
|
|
|
sub update_publication_status { |
1281
|
0
|
|
|
0
|
1
|
|
my $api = shift; |
1282
|
0
|
|
|
|
|
|
my @args; |
1283
|
0
|
|
|
|
|
|
push @args, shift; # id |
1284
|
0
|
|
|
|
|
|
my $uri = sprintf '/assets/%s/update-publication-status.json', @args; |
1285
|
0
|
|
|
|
|
|
$api->base->call("POST", $uri, @_); |
1286
|
|
|
|
|
|
|
} |
1287
|
|
|
|
|
|
|
|
1288
|
|
|
|
|
|
|
|
1289
|
|
|
|
|
|
|
=pod |
1290
|
|
|
|
|
|
|
|
1291
|
|
|
|
|
|
|
|
1292
|
|
|
|
|
|
|
|
1293
|
|
|
|
|
|
|
=item get_trending |
1294
|
|
|
|
|
|
|
|
1295
|
|
|
|
|
|
|
my $res = $tp->assets->get_trending(); |
1296
|
|
|
|
|
|
|
|
1297
|
|
|
|
|
|
|
Gets a stream of trending assets across TypePad |
1298
|
|
|
|
|
|
|
|
1299
|
|
|
|
|
|
|
Returns StreamEAssetE which contains following properties. |
1300
|
|
|
|
|
|
|
|
1301
|
|
|
|
|
|
|
=over 8 |
1302
|
|
|
|
|
|
|
|
1303
|
|
|
|
|
|
|
=item totalResults |
1304
|
|
|
|
|
|
|
|
1305
|
|
|
|
|
|
|
(integer) The total number of items in the whole stream of which this response contains a subset. CEnullE if an exact count cannot be determined. |
1306
|
|
|
|
|
|
|
|
1307
|
|
|
|
|
|
|
=item estimatedTotalResults |
1308
|
|
|
|
|
|
|
|
1309
|
|
|
|
|
|
|
(integer) An estimate of the total number of items in the whole list of which this response contains a subset. CEnullE if a count cannot be determined at all, or if an exact count is returned in CEtotalResultsE. |
1310
|
|
|
|
|
|
|
|
1311
|
|
|
|
|
|
|
=item moreResultsToken |
1312
|
|
|
|
|
|
|
|
1313
|
|
|
|
|
|
|
(string) An opaque token that can be used as the CEstart-tokenE parameter of a followup request to retrieve additional results. CEnullE if there are no more results to retrieve, but the presence of this token does not guarantee that the response to a followup request will actually contain results. |
1314
|
|
|
|
|
|
|
|
1315
|
|
|
|
|
|
|
=item entries |
1316
|
|
|
|
|
|
|
|
1317
|
|
|
|
|
|
|
(arrayEAssetE) A selection of items from the underlying stream. |
1318
|
|
|
|
|
|
|
|
1319
|
|
|
|
|
|
|
|
1320
|
|
|
|
|
|
|
=back |
1321
|
|
|
|
|
|
|
|
1322
|
|
|
|
|
|
|
=cut |
1323
|
|
|
|
|
|
|
|
1324
|
|
|
|
|
|
|
sub get_trending { |
1325
|
0
|
|
|
0
|
1
|
|
my $api = shift; |
1326
|
0
|
|
|
|
|
|
my @args; |
1327
|
0
|
|
|
|
|
|
my $uri = sprintf '/assets/trending.json', @args; |
1328
|
0
|
|
|
|
|
|
$api->base->call("GET", $uri, @_); |
1329
|
|
|
|
|
|
|
} |
1330
|
|
|
|
|
|
|
|
1331
|
|
|
|
|
|
|
|
1332
|
|
|
|
|
|
|
sub trending { |
1333
|
0
|
|
|
0
|
0
|
|
my $self = shift; |
1334
|
0
|
|
|
|
|
|
Carp::carp("'trending' is deprecated. Use 'get_trending' instead."); |
1335
|
0
|
|
|
|
|
|
$self->get_trending(@_); |
1336
|
|
|
|
|
|
|
} |
1337
|
|
|
|
|
|
|
|
1338
|
|
|
|
|
|
|
=pod |
1339
|
|
|
|
|
|
|
|
1340
|
|
|
|
|
|
|
=back |
1341
|
|
|
|
|
|
|
|
1342
|
|
|
|
|
|
|
=cut |
1343
|
|
|
|
|
|
|
|
1344
|
|
|
|
|
|
|
### END auto-generated |
1345
|
|
|
|
|
|
|
|
1346
|
|
|
|
|
|
|
1; |