| 1 | package WWW::TypePad::Users; | ||
| 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::users { __PACKAGE__->new( base => $_[0] ) } |
|
Subroutine
users: 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::Users - Users 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->users->get($id); | ||
| 39 | |||
| 40 | Get basic information about the selected user. | ||
| 41 | |||
| 42 | Returns User which contains following properties. | ||
| 43 | |||
| 44 | =over 8 | ||
| 45 | |||
| 46 | =item displayName | ||
| 47 | |||
| 48 | (string) The user's chosen display name. | ||
| 49 | |||
| 50 | =item location | ||
| 51 | |||
| 52 | (string) BE<lt>DeprecatedE<gt> The user's location, as a free-form string provided by them. Use the the ME<lt>locationE<gt> property of the related OE<lt>UserProfileE<gt> object, which can be retrieved from the NE<lt>/users/{id}/profileE<gt> endpoint. | ||
| 53 | |||
| 54 | =item interests | ||
| 55 | |||
| 56 | (arrayE<lt>stringE<gt>) BE<lt>DeprecatedE<gt> A list of interests provided by the user and displayed on the user's profile page. Use the ME<lt>interestsE<gt> property of the OE<lt>UserProfileE<gt> object, which can be retrieved from the NE<lt>/users/{id}/profileE<gt> endpoint. | ||
| 57 | |||
| 58 | =item preferredUsername | ||
| 59 | |||
| 60 | (string) The name the user has chosen for use in the URL of their TypePad profile page. This property can be used to select this user in URLs, although it is not a persistent key, as the user can change it at any time. | ||
| 61 | |||
| 62 | =item avatarLink | ||
| 63 | |||
| 64 | (ImageLink) A link to an image representing this user. | ||
| 65 | |||
| 66 | =item profilePageUrl | ||
| 67 | |||
| 68 | (string) The URL of the user's TypePad profile page. | ||
| 69 | |||
| 70 | =item objectTypes | ||
| 71 | |||
| 72 | (setE<lt>stringE<gt>) BE<lt>DeprecatedE<gt> An array of object type identifier URIs. | ||
| 73 | |||
| 74 | =item objectType | ||
| 75 | |||
| 76 | (string) The keyword identifying the type of object this is. For a User object, ME<lt>objectTypeE<gt> will be CE<lt>UserE<gt>. | ||
| 77 | |||
| 78 | =item email | ||
| 79 | |||
| 80 | (string) BE<lt>DeprecatedE<gt> The user's email address. This property is only provided for authenticated requests if the user has shared it with the authenticated application, and the authenticated user is allowed to view it (as with administrators of groups the user has joined). In all other cases, this property is omitted. | ||
| 81 | |||
| 82 | =item gender | ||
| 83 | |||
| 84 | (string) BE<lt>DeprecatedE<gt> The user's gender, as they provided it. This property is only provided for authenticated requests if the user has shared it with the authenticated application, and the authenticated user is allowed to view it (as with administrators of groups the user has joined). In all other cases, this property is omitted. | ||
| 85 | |||
| 86 | =item id | ||
| 87 | |||
| 88 | (string) A URI that serves as a globally unique identifier for the object. | ||
| 89 | |||
| 90 | =item urlId | ||
| 91 | |||
| 92 | (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. | ||
| 93 | |||
| 94 | |||
| 95 | =back | ||
| 96 | |||
| 97 | =cut | ||
| 98 | |||
| 99 | 0 | ▶ | sub get { |
|
Subroutine
get: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 100 | 0 | my $api = shift; | |
| 101 | 0 | my @args; | |
| 102 | 0 | push @args, shift; # id | |
| 103 | 0 | my $uri = sprintf '/users/%s.json', @args; | |
| 104 | 0 | $api->base->call("GET", $uri, @_); | |
| 105 | } | ||
| 106 | |||
| 107 | |||
| 108 | =pod | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =item get_badges | ||
| 113 | |||
| 114 | my $res = $tp->users->get_badges($id); | ||
| 115 | |||
| 116 | Get a list of badges that the selected user has won. | ||
| 117 | |||
| 118 | Returns ListE<lt>UserBadgeE<gt> which contains following properties. | ||
| 119 | |||
| 120 | =over 8 | ||
| 121 | |||
| 122 | =item totalResults | ||
| 123 | |||
| 124 | (integer) The total number of items in the whole list of which this list object is a paginated view. | ||
| 125 | |||
| 126 | =item entries | ||
| 127 | |||
| 128 | (arrayE<lt>UserBadgeE<gt>) The items within the selected slice of the list. | ||
| 129 | |||
| 130 | |||
| 131 | =back | ||
| 132 | |||
| 133 | =cut | ||
| 134 | |||
| 135 | 0 | ▶ | sub get_badges { |
|
Subroutine
get_badges: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 136 | 0 | my $api = shift; | |
| 137 | 0 | my @args; | |
| 138 | 0 | push @args, shift; # id | |
| 139 | 0 | my $uri = sprintf '/users/%s/badges.json', @args; | |
| 140 | 0 | $api->base->call("GET", $uri, @_); | |
| 141 | } | ||
| 142 | |||
| 143 | |||
| 144 | 0 | ▶ | sub badges { |
|
Subroutine
badges: not called CC=1 SCAR=6.9
Pod
undocumented
| |||
| 145 | 0 | my $self = shift; | |
| 146 | 0 | Carp::carp("'badges' is deprecated. Use 'get_badges' instead."); | |
| 147 | 0 | $self->get_badges(@_); | |
| 148 | } | ||
| 149 | |||
| 150 | =pod | ||
| 151 | |||
| 152 | |||
| 153 | |||
| 154 | =item get_learning_badges | ||
| 155 | |||
| 156 | my $res = $tp->users->get_learning_badges($id); | ||
| 157 | |||
| 158 | Get a list of learning badges that the selected user has won. | ||
| 159 | |||
| 160 | Returns ListE<lt>UserBadgeE<gt> which contains following properties. | ||
| 161 | |||
| 162 | =over 8 | ||
| 163 | |||
| 164 | =item totalResults | ||
| 165 | |||
| 166 | (integer) The total number of items in the whole list of which this list object is a paginated view. | ||
| 167 | |||
| 168 | =item entries | ||
| 169 | |||
| 170 | (arrayE<lt>UserBadgeE<gt>) The items within the selected slice of the list. | ||
| 171 | |||
| 172 | |||
| 173 | =back | ||
| 174 | |||
| 175 | =cut | ||
| 176 | |||
| 177 | 0 | ▶ | sub get_learning_badges { |
|
Subroutine
get_learning_badges: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 178 | 0 | my $api = shift; | |
| 179 | 0 | my @args; | |
| 180 | 0 | push @args, shift; # id | |
| 181 | 0 | my $uri = sprintf '/users/%s/badges/@learning.json', @args; | |
| 182 | 0 | $api->base->call("GET", $uri, @_); | |
| 183 | } | ||
| 184 | |||
| 185 | |||
| 186 | 0 | ▶ | sub learning_badges { |
|
Subroutine
learning_badges: not called CC=1 SCAR=6.9
Pod
undocumented
| |||
| 187 | 0 | my $self = shift; | |
| 188 | 0 | Carp::carp("'learning_badges' is deprecated. Use 'get_learning_badges' instead."); | |
| 189 | 0 | $self->get_learning_badges(@_); | |
| 190 | } | ||
| 191 | |||
| 192 | =pod | ||
| 193 | |||
| 194 | |||
| 195 | |||
| 196 | =item get_public_badges | ||
| 197 | |||
| 198 | my $res = $tp->users->get_public_badges($id); | ||
| 199 | |||
| 200 | Get a list of public badges that the selected user has won. | ||
| 201 | |||
| 202 | Returns ListE<lt>UserBadgeE<gt> which contains following properties. | ||
| 203 | |||
| 204 | =over 8 | ||
| 205 | |||
| 206 | =item totalResults | ||
| 207 | |||
| 208 | (integer) The total number of items in the whole list of which this list object is a paginated view. | ||
| 209 | |||
| 210 | =item entries | ||
| 211 | |||
| 212 | (arrayE<lt>UserBadgeE<gt>) The items within the selected slice of the list. | ||
| 213 | |||
| 214 | |||
| 215 | =back | ||
| 216 | |||
| 217 | =cut | ||
| 218 | |||
| 219 | 0 | ▶ | sub get_public_badges { |
|
Subroutine
get_public_badges: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 220 | 0 | my $api = shift; | |
| 221 | 0 | my @args; | |
| 222 | 0 | push @args, shift; # id | |
| 223 | 0 | my $uri = sprintf '/users/%s/badges/@public.json', @args; | |
| 224 | 0 | $api->base->call("GET", $uri, @_); | |
| 225 | } | ||
| 226 | |||
| 227 | |||
| 228 | 0 | ▶ | sub public_badges { |
|
Subroutine
public_badges: not called CC=1 SCAR=6.9
Pod
undocumented
| |||
| 229 | 0 | my $self = shift; | |
| 230 | 0 | Carp::carp("'public_badges' is deprecated. Use 'get_public_badges' instead."); | |
| 231 | 0 | $self->get_public_badges(@_); | |
| 232 | } | ||
| 233 | |||
| 234 | =pod | ||
| 235 | |||
| 236 | |||
| 237 | |||
| 238 | =item get_blogs | ||
| 239 | |||
| 240 | my $res = $tp->users->get_blogs($id); | ||
| 241 | |||
| 242 | Get a list of blogs that the selected user has access to. | ||
| 243 | |||
| 244 | Returns ListE<lt>BlogE<gt> which contains following properties. | ||
| 245 | |||
| 246 | =over 8 | ||
| 247 | |||
| 248 | =item totalResults | ||
| 249 | |||
| 250 | (integer) The total number of items in the whole list of which this list object is a paginated view. | ||
| 251 | |||
| 252 | =item entries | ||
| 253 | |||
| 254 | (arrayE<lt>BlogE<gt>) The items within the selected slice of the list. | ||
| 255 | |||
| 256 | |||
| 257 | =back | ||
| 258 | |||
| 259 | =cut | ||
| 260 | |||
| 261 | 0 | ▶ | sub get_blogs { |
|
Subroutine
get_blogs: 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 '/users/%s/blogs.json', @args; | |
| 266 | 0 | $api->base->call("GET", $uri, @_); | |
| 267 | } | ||
| 268 | |||
| 269 | |||
| 270 | 0 | ▶ | sub blogs { |
|
Subroutine
blogs: not called CC=1 SCAR=6.9
Pod
undocumented
| |||
| 271 | 0 | my $self = shift; | |
| 272 | 0 | Carp::carp("'blogs' is deprecated. Use 'get_blogs' instead."); | |
| 273 | 0 | $self->get_blogs(@_); | |
| 274 | } | ||
| 275 | |||
| 276 | =pod | ||
| 277 | |||
| 278 | |||
| 279 | |||
| 280 | =item get_elsewhere_accounts | ||
| 281 | |||
| 282 | my $res = $tp->users->get_elsewhere_accounts($id); | ||
| 283 | |||
| 284 | Get a list of elsewhere accounts for the selected user. | ||
| 285 | |||
| 286 | Returns ListE<lt>AccountE<gt> which contains following properties. | ||
| 287 | |||
| 288 | =over 8 | ||
| 289 | |||
| 290 | =item totalResults | ||
| 291 | |||
| 292 | (integer) The total number of items in the whole list of which this list object is a paginated view. | ||
| 293 | |||
| 294 | =item entries | ||
| 295 | |||
| 296 | (arrayE<lt>AccountE<gt>) The items within the selected slice of the list. | ||
| 297 | |||
| 298 | |||
| 299 | =back | ||
| 300 | |||
| 301 | =cut | ||
| 302 | |||
| 303 | 0 | ▶ | sub get_elsewhere_accounts { |
|
Subroutine
get_elsewhere_accounts: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 304 | 0 | my $api = shift; | |
| 305 | 0 | my @args; | |
| 306 | 0 | push @args, shift; # id | |
| 307 | 0 | my $uri = sprintf '/users/%s/elsewhere-accounts.json', @args; | |
| 308 | 0 | $api->base->call("GET", $uri, @_); | |
| 309 | } | ||
| 310 | |||
| 311 | |||
| 312 | 0 | ▶ | sub elsewhere_accounts { |
|
Subroutine
elsewhere_accounts: not called CC=1 SCAR=6.9
Pod
undocumented
| |||
| 313 | 0 | my $self = shift; | |
| 314 | 0 | Carp::carp("'elsewhere_accounts' is deprecated. Use 'get_elsewhere_accounts' instead."); | |
| 315 | 0 | $self->get_elsewhere_accounts(@_); | |
| 316 | } | ||
| 317 | |||
| 318 | =pod | ||
| 319 | |||
| 320 | |||
| 321 | |||
| 322 | =item get_events | ||
| 323 | |||
| 324 | my $res = $tp->users->get_events($id); | ||
| 325 | |||
| 326 | Get a list of events describing actions that the selected user performed. | ||
| 327 | |||
| 328 | Returns StreamE<lt>EventE<gt> which contains following properties. | ||
| 329 | |||
| 330 | =over 8 | ||
| 331 | |||
| 332 | =item totalResults | ||
| 333 | |||
| 334 | (integer) The total number of items in the whole stream of which this response contains a subset. CE<lt>nullE<gt> if an exact count cannot be determined. | ||
| 335 | |||
| 336 | =item estimatedTotalResults | ||
| 337 | |||
| 338 | (integer) An estimate of the total number of items in the whole list of which this response contains a subset. CE<lt>nullE<gt> if a count cannot be determined at all, or if an exact count is returned in CE<lt>totalResultsE<gt>. | ||
| 339 | |||
| 340 | =item moreResultsToken | ||
| 341 | |||
| 342 | (string) An opaque token that can be used as the CE<lt>start-tokenE<gt> parameter of a followup request to retrieve additional results. CE<lt>nullE<gt> 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. | ||
| 343 | |||
| 344 | =item entries | ||
| 345 | |||
| 346 | (arrayE<lt>EventE<gt>) A selection of items from the underlying stream. | ||
| 347 | |||
| 348 | |||
| 349 | =back | ||
| 350 | |||
| 351 | =cut | ||
| 352 | |||
| 353 | 0 | ▶ | sub get_events { |
|
Subroutine
get_events: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 354 | 0 | my $api = shift; | |
| 355 | 0 | my @args; | |
| 356 | 0 | push @args, shift; # id | |
| 357 | 0 | my $uri = sprintf '/users/%s/events.json', @args; | |
| 358 | 0 | $api->base->call("GET", $uri, @_); | |
| 359 | } | ||
| 360 | |||
| 361 | |||
| 362 | 0 | ▶ | sub events { |
|
Subroutine
events: not called CC=1 SCAR=6.9
Pod
undocumented
| |||
| 363 | 0 | my $self = shift; | |
| 364 | 0 | Carp::carp("'events' is deprecated. Use 'get_events' instead."); | |
| 365 | 0 | $self->get_events(@_); | |
| 366 | } | ||
| 367 | |||
| 368 | =pod | ||
| 369 | |||
| 370 | |||
| 371 | |||
| 372 | =item get_events_by_group | ||
| 373 | |||
| 374 | my $res = $tp->users->get_events_by_group($id, $groupId); | ||
| 375 | |||
| 376 | Get a list of events describing actions that the selected user performed in a particular group. | ||
| 377 | |||
| 378 | Returns ListE<lt>EventE<gt> which contains following properties. | ||
| 379 | |||
| 380 | =over 8 | ||
| 381 | |||
| 382 | =item totalResults | ||
| 383 | |||
| 384 | (integer) The total number of items in the whole list of which this list object is a paginated view. | ||
| 385 | |||
| 386 | =item entries | ||
| 387 | |||
| 388 | (arrayE<lt>EventE<gt>) The items within the selected slice of the list. | ||
| 389 | |||
| 390 | |||
| 391 | =back | ||
| 392 | |||
| 393 | =cut | ||
| 394 | |||
| 395 | 0 | ▶ | sub get_events_by_group { |
|
Subroutine
get_events_by_group: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 396 | 0 | my $api = shift; | |
| 397 | 0 | my @args; | |
| 398 | 0 | push @args, shift; # id | |
| 399 | 0 | push @args, shift; # groupId | |
| 400 | 0 | my $uri = sprintf '/users/%s/events/@by-group/%s.json', @args; | |
| 401 | 0 | $api->base->call("GET", $uri, @_); | |
| 402 | } | ||
| 403 | |||
| 404 | |||
| 405 | 0 | ▶ | sub events_by_group { |
|
Subroutine
events_by_group: not called CC=1 SCAR=6.9
Pod
undocumented
| |||
| 406 | 0 | my $self = shift; | |
| 407 | 0 | Carp::carp("'events_by_group' is deprecated. Use 'get_events_by_group' instead."); | |
| 408 | 0 | $self->get_events_by_group(@_); | |
| 409 | } | ||
| 410 | |||
| 411 | =pod | ||
| 412 | |||
| 413 | |||
| 414 | |||
| 415 | =item post_to_favorites | ||
| 416 | |||
| 417 | my $res = $tp->users->post_to_favorites($id); | ||
| 418 | |||
| 419 | Create a new favorite in the selected user's list of favorites. | ||
| 420 | |||
| 421 | Returns Favorite which contains following properties. | ||
| 422 | |||
| 423 | =over 8 | ||
| 424 | |||
| 425 | =item id | ||
| 426 | |||
| 427 | (string) A URI that serves as a globally unique identifier for the favorite. | ||
| 428 | |||
| 429 | =item urlId | ||
| 430 | |||
| 431 | (string) A string containing the canonical identifier that can be used to identify this favorite in URLs. This can be used to recognise where the same favorite is returned in response to different requests, and as a mapping key for an application's local data store. | ||
| 432 | |||
| 433 | =item author | ||
| 434 | |||
| 435 | (User) The user who saved this favorite. That is, this property is the user who saved the target asset as a favorite, not the creator of that asset. | ||
| 436 | |||
| 437 | =item inReplyTo | ||
| 438 | |||
| 439 | (AssetRef) A reference to the target asset that has been marked as a favorite. | ||
| 440 | |||
| 441 | =item published | ||
| 442 | |||
| 443 | (datetime) The time that the favorite was created, as a W3CDTF timestamp. | ||
| 444 | |||
| 445 | |||
| 446 | =back | ||
| 447 | |||
| 448 | =cut | ||
| 449 | |||
| 450 | 0 | ▶ | sub post_to_favorites { |
|
Subroutine
post_to_favorites: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 451 | 0 | my $api = shift; | |
| 452 | 0 | my @args; | |
| 453 | 0 | push @args, shift; # id | |
| 454 | 0 | my $uri = sprintf '/users/%s/favorites.json', @args; | |
| 455 | 0 | $api->base->call("POST", $uri, @_); | |
| 456 | } | ||
| 457 | |||
| 458 | |||
| 459 | =pod | ||
| 460 | |||
| 461 | |||
| 462 | |||
| 463 | =item get_favorites | ||
| 464 | |||
| 465 | my $res = $tp->users->get_favorites($id); | ||
| 466 | |||
| 467 | Get a list of favorites that were listed by the selected user. | ||
| 468 | |||
| 469 | Returns ListE<lt>FavoriteE<gt> which contains following properties. | ||
| 470 | |||
| 471 | =over 8 | ||
| 472 | |||
| 473 | =item totalResults | ||
| 474 | |||
| 475 | (integer) The total number of items in the whole list of which this list object is a paginated view. | ||
| 476 | |||
| 477 | =item entries | ||
| 478 | |||
| 479 | (arrayE<lt>FavoriteE<gt>) The items within the selected slice of the list. | ||
| 480 | |||
| 481 | |||
| 482 | =back | ||
| 483 | |||
| 484 | =cut | ||
| 485 | |||
| 486 | 0 | ▶ | sub get_favorites { |
|
Subroutine
get_favorites: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 487 | 0 | my $api = shift; | |
| 488 | 0 | my @args; | |
| 489 | 0 | push @args, shift; # id | |
| 490 | 0 | my $uri = sprintf '/users/%s/favorites.json', @args; | |
| 491 | 0 | $api->base->call("GET", $uri, @_); | |
| 492 | } | ||
| 493 | |||
| 494 | |||
| 495 | 0 | ▶ | sub favorites { |
|
Subroutine
favorites: not called CC=1 SCAR=6.9
Pod
undocumented
| |||
| 496 | 0 | my $self = shift; | |
| 497 | 0 | Carp::carp("'favorites' is deprecated. Use 'get_favorites' instead."); | |
| 498 | 0 | $self->get_favorites(@_); | |
| 499 | } | ||
| 500 | |||
| 501 | =pod | ||
| 502 | |||
| 503 | |||
| 504 | |||
| 505 | =item get_memberships | ||
| 506 | |||
| 507 | my $res = $tp->users->get_memberships($id); | ||
| 508 | |||
| 509 | Get a list of relationships that the selected user has with groups. | ||
| 510 | |||
| 511 | Returns ListE<lt>RelationshipE<gt> which contains following properties. | ||
| 512 | |||
| 513 | =over 8 | ||
| 514 | |||
| 515 | =item totalResults | ||
| 516 | |||
| 517 | (integer) The total number of items in the whole list of which this list object is a paginated view. | ||
| 518 | |||
| 519 | =item entries | ||
| 520 | |||
| 521 | (arrayE<lt>RelationshipE<gt>) The items within the selected slice of the list. | ||
| 522 | |||
| 523 | |||
| 524 | =back | ||
| 525 | |||
| 526 | =cut | ||
| 527 | |||
| 528 | 0 | ▶ | sub get_memberships { |
|
Subroutine
get_memberships: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 529 | 0 | my $api = shift; | |
| 530 | 0 | my @args; | |
| 531 | 0 | push @args, shift; # id | |
| 532 | 0 | my $uri = sprintf '/users/%s/memberships.json', @args; | |
| 533 | 0 | $api->base->call("GET", $uri, @_); | |
| 534 | } | ||
| 535 | |||
| 536 | |||
| 537 | 0 | ▶ | sub memberships { |
|
Subroutine
memberships: not called CC=1 SCAR=6.9
Pod
undocumented
| |||
| 538 | 0 | my $self = shift; | |
| 539 | 0 | Carp::carp("'memberships' is deprecated. Use 'get_memberships' instead."); | |
| 540 | 0 | $self->get_memberships(@_); | |
| 541 | } | ||
| 542 | |||
| 543 | =pod | ||
| 544 | |||
| 545 | |||
| 546 | |||
| 547 | =item get_admin_memberships | ||
| 548 | |||
| 549 | my $res = $tp->users->get_admin_memberships($id); | ||
| 550 | |||
| 551 | Get a list of relationships that have an Admin type that the selected user has with groups. | ||
| 552 | |||
| 553 | Returns ListE<lt>RelationshipE<gt> which contains following properties. | ||
| 554 | |||
| 555 | =over 8 | ||
| 556 | |||
| 557 | =item totalResults | ||
| 558 | |||
| 559 | (integer) The total number of items in the whole list of which this list object is a paginated view. | ||
| 560 | |||
| 561 | =item entries | ||
| 562 | |||
| 563 | (arrayE<lt>RelationshipE<gt>) The items within the selected slice of the list. | ||
| 564 | |||
| 565 | |||
| 566 | =back | ||
| 567 | |||
| 568 | =cut | ||
| 569 | |||
| 570 | 0 | ▶ | sub get_admin_memberships { |
|
Subroutine
get_admin_memberships: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 571 | 0 | my $api = shift; | |
| 572 | 0 | my @args; | |
| 573 | 0 | push @args, shift; # id | |
| 574 | 0 | my $uri = sprintf '/users/%s/memberships/@admin.json', @args; | |
| 575 | 0 | $api->base->call("GET", $uri, @_); | |
| 576 | } | ||
| 577 | |||
| 578 | |||
| 579 | 0 | ▶ | sub admin_memberships { |
|
Subroutine
admin_memberships: not called CC=1 SCAR=6.9
Pod
undocumented
| |||
| 580 | 0 | my $self = shift; | |
| 581 | 0 | Carp::carp("'admin_memberships' is deprecated. Use 'get_admin_memberships' instead."); | |
| 582 | 0 | $self->get_admin_memberships(@_); | |
| 583 | } | ||
| 584 | |||
| 585 | =pod | ||
| 586 | |||
| 587 | |||
| 588 | |||
| 589 | =item get_memberships_by_group | ||
| 590 | |||
| 591 | my $res = $tp->users->get_memberships_by_group($id, $groupId); | ||
| 592 | |||
| 593 | Get a list containing only the relationship between the selected user and a particular group, or an empty list if the user has no relationship with the group. | ||
| 594 | |||
| 595 | Returns ListE<lt>RelationshipE<gt> which contains following properties. | ||
| 596 | |||
| 597 | =over 8 | ||
| 598 | |||
| 599 | =item totalResults | ||
| 600 | |||
| 601 | (integer) The total number of items in the whole list of which this list object is a paginated view. | ||
| 602 | |||
| 603 | =item entries | ||
| 604 | |||
| 605 | (arrayE<lt>RelationshipE<gt>) The items within the selected slice of the list. | ||
| 606 | |||
| 607 | |||
| 608 | =back | ||
| 609 | |||
| 610 | =cut | ||
| 611 | |||
| 612 | 0 | ▶ | sub get_memberships_by_group { |
|
Subroutine
get_memberships_by_group: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 613 | 0 | my $api = shift; | |
| 614 | 0 | my @args; | |
| 615 | 0 | push @args, shift; # id | |
| 616 | 0 | push @args, shift; # groupId | |
| 617 | 0 | my $uri = sprintf '/users/%s/memberships/@by-group/%s.json', @args; | |
| 618 | 0 | $api->base->call("GET", $uri, @_); | |
| 619 | } | ||
| 620 | |||
| 621 | |||
| 622 | 0 | ▶ | sub memberships_by_group { |
|
Subroutine
memberships_by_group: not called CC=1 SCAR=6.9
Pod
undocumented
| |||
| 623 | 0 | my $self = shift; | |
| 624 | 0 | Carp::carp("'memberships_by_group' is deprecated. Use 'get_memberships_by_group' instead."); | |
| 625 | 0 | $self->get_memberships_by_group(@_); | |
| 626 | } | ||
| 627 | |||
| 628 | =pod | ||
| 629 | |||
| 630 | |||
| 631 | |||
| 632 | =item get_member_memberships | ||
| 633 | |||
| 634 | my $res = $tp->users->get_member_memberships($id); | ||
| 635 | |||
| 636 | Get a list of relationships that have a Member type that the selected user has with groups. | ||
| 637 | |||
| 638 | Returns ListE<lt>RelationshipE<gt> which contains following properties. | ||
| 639 | |||
| 640 | =over 8 | ||
| 641 | |||
| 642 | =item totalResults | ||
| 643 | |||
| 644 | (integer) The total number of items in the whole list of which this list object is a paginated view. | ||
| 645 | |||
| 646 | =item entries | ||
| 647 | |||
| 648 | (arrayE<lt>RelationshipE<gt>) The items within the selected slice of the list. | ||
| 649 | |||
| 650 | |||
| 651 | =back | ||
| 652 | |||
| 653 | =cut | ||
| 654 | |||
| 655 | 0 | ▶ | sub get_member_memberships { |
|
Subroutine
get_member_memberships: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 656 | 0 | my $api = shift; | |
| 657 | 0 | my @args; | |
| 658 | 0 | push @args, shift; # id | |
| 659 | 0 | my $uri = sprintf '/users/%s/memberships/@member.json', @args; | |
| 660 | 0 | $api->base->call("GET", $uri, @_); | |
| 661 | } | ||
| 662 | |||
| 663 | |||
| 664 | 0 | ▶ | sub member_memberships { |
|
Subroutine
member_memberships: not called CC=1 SCAR=6.9
Pod
undocumented
| |||
| 665 | 0 | my $self = shift; | |
| 666 | 0 | Carp::carp("'member_memberships' is deprecated. Use 'get_member_memberships' instead."); | |
| 667 | 0 | $self->get_member_memberships(@_); | |
| 668 | } | ||
| 669 | |||
| 670 | =pod | ||
| 671 | |||
| 672 | |||
| 673 | |||
| 674 | =item get_notifications | ||
| 675 | |||
| 676 | my $res = $tp->users->get_notifications($id); | ||
| 677 | |||
| 678 | Get a list of events describing actions by users that the selected user is following. | ||
| 679 | |||
| 680 | Returns ListE<lt>EventE<gt> which contains following properties. | ||
| 681 | |||
| 682 | =over 8 | ||
| 683 | |||
| 684 | =item totalResults | ||
| 685 | |||
| 686 | (integer) The total number of items in the whole list of which this list object is a paginated view. | ||
| 687 | |||
| 688 | =item entries | ||
| 689 | |||
| 690 | (arrayE<lt>EventE<gt>) The items within the selected slice of the list. | ||
| 691 | |||
| 692 | |||
| 693 | =back | ||
| 694 | |||
| 695 | =cut | ||
| 696 | |||
| 697 | 0 | ▶ | sub get_notifications { |
|
Subroutine
get_notifications: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 698 | 0 | my $api = shift; | |
| 699 | 0 | my @args; | |
| 700 | 0 | push @args, shift; # id | |
| 701 | 0 | my $uri = sprintf '/users/%s/notifications.json', @args; | |
| 702 | 0 | $api->base->call("GET", $uri, @_); | |
| 703 | } | ||
| 704 | |||
| 705 | |||
| 706 | 0 | ▶ | sub notifications { |
|
Subroutine
notifications: not called CC=1 SCAR=6.9
Pod
undocumented
| |||
| 707 | 0 | my $self = shift; | |
| 708 | 0 | Carp::carp("'notifications' is deprecated. Use 'get_notifications' instead."); | |
| 709 | 0 | $self->get_notifications(@_); | |
| 710 | } | ||
| 711 | |||
| 712 | =pod | ||
| 713 | |||
| 714 | |||
| 715 | |||
| 716 | =item get_notifications_by_group | ||
| 717 | |||
| 718 | my $res = $tp->users->get_notifications_by_group($id, $groupId); | ||
| 719 | |||
| 720 | Get a list of events describing actions in a particular group by users that the selected user is following. | ||
| 721 | |||
| 722 | Returns ListE<lt>EventE<gt> which contains following properties. | ||
| 723 | |||
| 724 | =over 8 | ||
| 725 | |||
| 726 | =item totalResults | ||
| 727 | |||
| 728 | (integer) The total number of items in the whole list of which this list object is a paginated view. | ||
| 729 | |||
| 730 | =item entries | ||
| 731 | |||
| 732 | (arrayE<lt>EventE<gt>) The items within the selected slice of the list. | ||
| 733 | |||
| 734 | |||
| 735 | =back | ||
| 736 | |||
| 737 | =cut | ||
| 738 | |||
| 739 | 0 | ▶ | sub get_notifications_by_group { |
|
Subroutine
get_notifications_by_group: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 740 | 0 | my $api = shift; | |
| 741 | 0 | my @args; | |
| 742 | 0 | push @args, shift; # id | |
| 743 | 0 | push @args, shift; # groupId | |
| 744 | 0 | my $uri = sprintf '/users/%s/notifications/@by-group/%s.json', @args; | |
| 745 | 0 | $api->base->call("GET", $uri, @_); | |
| 746 | } | ||
| 747 | |||
| 748 | |||
| 749 | 0 | ▶ | sub notifications_by_group { |
|
Subroutine
notifications_by_group: not called CC=1 SCAR=6.9
Pod
undocumented
| |||
| 750 | 0 | my $self = shift; | |
| 751 | 0 | Carp::carp("'notifications_by_group' is deprecated. Use 'get_notifications_by_group' instead."); | |
| 752 | 0 | $self->get_notifications_by_group(@_); | |
| 753 | } | ||
| 754 | |||
| 755 | =pod | ||
| 756 | |||
| 757 | |||
| 758 | |||
| 759 | =item get_profile | ||
| 760 | |||
| 761 | my $res = $tp->users->get_profile($id); | ||
| 762 | |||
| 763 | Get a more extensive set of user properties that can be used to build a user profile page. | ||
| 764 | |||
| 765 | Returns UserProfile which contains following properties. | ||
| 766 | |||
| 767 | =over 8 | ||
| 768 | |||
| 769 | =item id | ||
| 770 | |||
| 771 | (string) The URI from the related OE<lt>UserE<gt> object's ME<lt>idE<gt> property. | ||
| 772 | |||
| 773 | =item urlId | ||
| 774 | |||
| 775 | (string) The canonical identifier from the related OE<lt>UserE<gt> object's ME<lt>urlIdE<gt> property. | ||
| 776 | |||
| 777 | =item displayName | ||
| 778 | |||
| 779 | (string) The user's chosen display name. | ||
| 780 | |||
| 781 | =item location | ||
| 782 | |||
| 783 | (string) The user's location, as a free-form string they provided. | ||
| 784 | |||
| 785 | =item aboutMe | ||
| 786 | |||
| 787 | (string) The user's long description or biography, as a free-form string they provided. | ||
| 788 | |||
| 789 | =item interests | ||
| 790 | |||
| 791 | (arrayE<lt>stringE<gt>) A list of interests provided by the user and displayed on their profile page. | ||
| 792 | |||
| 793 | =item preferredUsername | ||
| 794 | |||
| 795 | (string) The name the user has chosen for use in the URL of their TypePad profile page. This property can be used to select this user in URLs, although it is not a persistent key, as the user can change it at any time. | ||
| 796 | |||
| 797 | =item avatarLink | ||
| 798 | |||
| 799 | (ImageLink) A link to an image representing this user. | ||
| 800 | |||
| 801 | =item profilePageUrl | ||
| 802 | |||
| 803 | (string) The URL of the user's TypePad profile page. | ||
| 804 | |||
| 805 | =item followFrameContentUrl | ||
| 806 | |||
| 807 | (string) The URL of a widget that, when rendered in an CE<lt>iframeE<gt>, allows viewers to follow this user. Render this widget in an CE<lt>iframeE<gt> 300 pixels wide and 125 pixels high. | ||
| 808 | |||
| 809 | =item profileEditPageUrl | ||
| 810 | |||
| 811 | (string) The URL of a page where this user can edit their profile information. If this is not the authenticated user's UserProfile object, this property is omitted. | ||
| 812 | |||
| 813 | =item membershipManagementPageUrl | ||
| 814 | |||
| 815 | (string) The URL of a page where this user can manage their group memberships. If this is not the authenticated user's UserProfile object, this property is omitted. | ||
| 816 | |||
| 817 | =item homepageUrl | ||
| 818 | |||
| 819 | (string) The address of the user's homepage, as a URL they provided. This property is omitted if the user has not provided a homepage. | ||
| 820 | |||
| 821 | =item email | ||
| 822 | |||
| 823 | (string) The user's email address. This property is only provided for authenticated requests if the user has shared it with the authenticated application, and the authenticated user is allowed to view it (as with administrators of groups the user has joined). In all other cases, this property is omitted. | ||
| 824 | |||
| 825 | =item gender | ||
| 826 | |||
| 827 | (string) The user's gender, as they provided it. This property is only provided for authenticated requests if the user has shared it with the authenticated application, and the authenticated user is allowed to view it (as with administrators of groups the user has joined). In all other cases, this property is omitted. | ||
| 828 | |||
| 829 | |||
| 830 | =back | ||
| 831 | |||
| 832 | =cut | ||
| 833 | |||
| 834 | 0 | ▶ | sub get_profile { |
|
Subroutine
get_profile: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 835 | 0 | my $api = shift; | |
| 836 | 0 | my @args; | |
| 837 | 0 | push @args, shift; # id | |
| 838 | 0 | my $uri = sprintf '/users/%s/profile.json', @args; | |
| 839 | 0 | $api->base->call("GET", $uri, @_); | |
| 840 | } | ||
| 841 | |||
| 842 | |||
| 843 | 0 | ▶ | sub profile { |
|
Subroutine
profile: not called CC=1 SCAR=6.9
Pod
undocumented
| |||
| 844 | 0 | my $self = shift; | |
| 845 | 0 | Carp::carp("'profile' is deprecated. Use 'get_profile' instead."); | |
| 846 | 0 | $self->get_profile(@_); | |
| 847 | } | ||
| 848 | |||
| 849 | =pod | ||
| 850 | |||
| 851 | |||
| 852 | |||
| 853 | =item get_relationships | ||
| 854 | |||
| 855 | my $res = $tp->users->get_relationships($id); | ||
| 856 | |||
| 857 | Get a list of relationships that the selected user has with other users, and that other users have with the selected user. | ||
| 858 | |||
| 859 | Returns ListE<lt>RelationshipE<gt> which contains following properties. | ||
| 860 | |||
| 861 | =over 8 | ||
| 862 | |||
| 863 | =item totalResults | ||
| 864 | |||
| 865 | (integer) The total number of items in the whole list of which this list object is a paginated view. | ||
| 866 | |||
| 867 | =item entries | ||
| 868 | |||
| 869 | (arrayE<lt>RelationshipE<gt>) The items within the selected slice of the list. | ||
| 870 | |||
| 871 | |||
| 872 | =back | ||
| 873 | |||
| 874 | =cut | ||
| 875 | |||
| 876 | 0 | ▶ | sub get_relationships { |
|
Subroutine
get_relationships: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 877 | 0 | my $api = shift; | |
| 878 | 0 | my @args; | |
| 879 | 0 | push @args, shift; # id | |
| 880 | 0 | my $uri = sprintf '/users/%s/relationships.json', @args; | |
| 881 | 0 | $api->base->call("GET", $uri, @_); | |
| 882 | } | ||
| 883 | |||
| 884 | |||
| 885 | 0 | ▶ | sub relationships { |
|
Subroutine
relationships: not called CC=1 SCAR=6.9
Pod
undocumented
| |||
| 886 | 0 | my $self = shift; | |
| 887 | 0 | Carp::carp("'relationships' is deprecated. Use 'get_relationships' instead."); | |
| 888 | 0 | $self->get_relationships(@_); | |
| 889 | } | ||
| 890 | |||
| 891 | =pod | ||
| 892 | |||
| 893 | |||
| 894 | |||
| 895 | =item get_relationships_by_group | ||
| 896 | |||
| 897 | my $res = $tp->users->get_relationships_by_group($id, $groupId); | ||
| 898 | |||
| 899 | Get a list of relationships that the selected user has with other users, and that other users have with the selected user, constrained to members of a particular group. | ||
| 900 | |||
| 901 | Returns ListE<lt>RelationshipE<gt> which contains following properties. | ||
| 902 | |||
| 903 | =over 8 | ||
| 904 | |||
| 905 | =item totalResults | ||
| 906 | |||
| 907 | (integer) The total number of items in the whole list of which this list object is a paginated view. | ||
| 908 | |||
| 909 | =item entries | ||
| 910 | |||
| 911 | (arrayE<lt>RelationshipE<gt>) The items within the selected slice of the list. | ||
| 912 | |||
| 913 | |||
| 914 | =back | ||
| 915 | |||
| 916 | =cut | ||
| 917 | |||
| 918 | 0 | ▶ | sub get_relationships_by_group { |
|
Subroutine
get_relationships_by_group: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 919 | 0 | my $api = shift; | |
| 920 | 0 | my @args; | |
| 921 | 0 | push @args, shift; # id | |
| 922 | 0 | push @args, shift; # groupId | |
| 923 | 0 | my $uri = sprintf '/users/%s/relationships/@by-group/%s.json', @args; | |
| 924 | 0 | $api->base->call("GET", $uri, @_); | |
| 925 | } | ||
| 926 | |||
| 927 | |||
| 928 | 0 | ▶ | sub relationships_by_group { |
|
Subroutine
relationships_by_group: not called CC=1 SCAR=6.9
Pod
undocumented
| |||
| 929 | 0 | my $self = shift; | |
| 930 | 0 | Carp::carp("'relationships_by_group' is deprecated. Use 'get_relationships_by_group' instead."); | |
| 931 | 0 | $self->get_relationships_by_group(@_); | |
| 932 | } | ||
| 933 | |||
| 934 | =pod | ||
| 935 | |||
| 936 | |||
| 937 | |||
| 938 | =item get_relationships_by_user | ||
| 939 | |||
| 940 | my $res = $tp->users->get_relationships_by_user($id, $userId); | ||
| 941 | |||
| 942 | Get a list of relationships that the selected user has with a single other user. | ||
| 943 | |||
| 944 | Returns ListE<lt>RelationshipE<gt> which contains following properties. | ||
| 945 | |||
| 946 | =over 8 | ||
| 947 | |||
| 948 | =item totalResults | ||
| 949 | |||
| 950 | (integer) The total number of items in the whole list of which this list object is a paginated view. | ||
| 951 | |||
| 952 | =item entries | ||
| 953 | |||
| 954 | (arrayE<lt>RelationshipE<gt>) The items within the selected slice of the list. | ||
| 955 | |||
| 956 | |||
| 957 | =back | ||
| 958 | |||
| 959 | =cut | ||
| 960 | |||
| 961 | 0 | ▶ | sub get_relationships_by_user { |
|
Subroutine
get_relationships_by_user: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 962 | 0 | my $api = shift; | |
| 963 | 0 | my @args; | |
| 964 | 0 | push @args, shift; # id | |
| 965 | 0 | push @args, shift; # userId | |
| 966 | 0 | my $uri = sprintf '/users/%s/relationships/@by-user/%s.json', @args; | |
| 967 | 0 | $api->base->call("GET", $uri, @_); | |
| 968 | } | ||
| 969 | |||
| 970 | |||
| 971 | 0 | ▶ | sub relationships_by_user { |
|
Subroutine
relationships_by_user: not called CC=1 SCAR=6.9
Pod
undocumented
| |||
| 972 | 0 | my $self = shift; | |
| 973 | 0 | Carp::carp("'relationships_by_user' is deprecated. Use 'get_relationships_by_user' instead."); | |
| 974 | 0 | $self->get_relationships_by_user(@_); | |
| 975 | } | ||
| 976 | |||
| 977 | =pod | ||
| 978 | |||
| 979 | |||
| 980 | |||
| 981 | =item get_follower_relationships | ||
| 982 | |||
| 983 | my $res = $tp->users->get_follower_relationships($id); | ||
| 984 | |||
| 985 | Get a list of relationships that have the Contact type that the selected user has with other users. | ||
| 986 | |||
| 987 | Returns ListE<lt>RelationshipE<gt> which contains following properties. | ||
| 988 | |||
| 989 | =over 8 | ||
| 990 | |||
| 991 | =item totalResults | ||
| 992 | |||
| 993 | (integer) The total number of items in the whole list of which this list object is a paginated view. | ||
| 994 | |||
| 995 | =item entries | ||
| 996 | |||
| 997 | (arrayE<lt>RelationshipE<gt>) The items within the selected slice of the list. | ||
| 998 | |||
| 999 | |||
| 1000 | =back | ||
| 1001 | |||
| 1002 | =cut | ||
| 1003 | |||
| 1004 | 0 | ▶ | sub get_follower_relationships { |
|
Subroutine
get_follower_relationships: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 1005 | 0 | my $api = shift; | |
| 1006 | 0 | my @args; | |
| 1007 | 0 | push @args, shift; # id | |
| 1008 | 0 | my $uri = sprintf '/users/%s/relationships/@follower.json', @args; | |
| 1009 | 0 | $api->base->call("GET", $uri, @_); | |
| 1010 | } | ||
| 1011 | |||
| 1012 | |||
| 1013 | 0 | ▶ | sub follower_relationships { |
|
Subroutine
follower_relationships: not called CC=1 SCAR=6.9
Pod
undocumented
| |||
| 1014 | 0 | my $self = shift; | |
| 1015 | 0 | Carp::carp("'follower_relationships' is deprecated. Use 'get_follower_relationships' instead."); | |
| 1016 | 0 | $self->get_follower_relationships(@_); | |
| 1017 | } | ||
| 1018 | |||
| 1019 | =pod | ||
| 1020 | |||
| 1021 | |||
| 1022 | |||
| 1023 | =item get_follower_relationships_by_group | ||
| 1024 | |||
| 1025 | my $res = $tp->users->get_follower_relationships_by_group($id, $groupId); | ||
| 1026 | |||
| 1027 | Get a list of relationships that have the Contact type that the selected user has with other users, constrained to members of a particular group. | ||
| 1028 | |||
| 1029 | Returns ListE<lt>RelationshipE<gt> which contains following properties. | ||
| 1030 | |||
| 1031 | =over 8 | ||
| 1032 | |||
| 1033 | =item totalResults | ||
| 1034 | |||
| 1035 | (integer) The total number of items in the whole list of which this list object is a paginated view. | ||
| 1036 | |||
| 1037 | =item entries | ||
| 1038 | |||
| 1039 | (arrayE<lt>RelationshipE<gt>) The items within the selected slice of the list. | ||
| 1040 | |||
| 1041 | |||
| 1042 | =back | ||
| 1043 | |||
| 1044 | =cut | ||
| 1045 | |||
| 1046 | 0 | ▶ | sub get_follower_relationships_by_group { |
|
Subroutine
get_follower_relationships_by_group: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 1047 | 0 | my $api = shift; | |
| 1048 | 0 | my @args; | |
| 1049 | 0 | push @args, shift; # id | |
| 1050 | 0 | push @args, shift; # groupId | |
| 1051 | 0 | my $uri = sprintf '/users/%s/relationships/@follower/@by-group/%s.json', @args; | |
| 1052 | 0 | $api->base->call("GET", $uri, @_); | |
| 1053 | } | ||
| 1054 | |||
| 1055 | |||
| 1056 | 0 | ▶ | sub follower_relationships_by_group { |
|
Subroutine
follower_relationships_by_group: not called CC=1 SCAR=6.9
Pod
undocumented
| |||
| 1057 | 0 | my $self = shift; | |
| 1058 | 0 | Carp::carp("'follower_relationships_by_group' is deprecated. Use 'get_follower_relationships_by_group' instead."); | |
| 1059 | 0 | $self->get_follower_relationships_by_group(@_); | |
| 1060 | } | ||
| 1061 | |||
| 1062 | =pod | ||
| 1063 | |||
| 1064 | |||
| 1065 | |||
| 1066 | =item get_following_relationships | ||
| 1067 | |||
| 1068 | my $res = $tp->users->get_following_relationships($id); | ||
| 1069 | |||
| 1070 | Get a list of relationships that have the Contact type that other users have with the selected user. | ||
| 1071 | |||
| 1072 | Returns ListE<lt>RelationshipE<gt> which contains following properties. | ||
| 1073 | |||
| 1074 | =over 8 | ||
| 1075 | |||
| 1076 | =item totalResults | ||
| 1077 | |||
| 1078 | (integer) The total number of items in the whole list of which this list object is a paginated view. | ||
| 1079 | |||
| 1080 | =item entries | ||
| 1081 | |||
| 1082 | (arrayE<lt>RelationshipE<gt>) The items within the selected slice of the list. | ||
| 1083 | |||
| 1084 | |||
| 1085 | =back | ||
| 1086 | |||
| 1087 | =cut | ||
| 1088 | |||
| 1089 | 0 | ▶ | sub get_following_relationships { |
|
Subroutine
get_following_relationships: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 1090 | 0 | my $api = shift; | |
| 1091 | 0 | my @args; | |
| 1092 | 0 | push @args, shift; # id | |
| 1093 | 0 | my $uri = sprintf '/users/%s/relationships/@following.json', @args; | |
| 1094 | 0 | $api->base->call("GET", $uri, @_); | |
| 1095 | } | ||
| 1096 | |||
| 1097 | |||
| 1098 | 0 | ▶ | sub following_relationships { |
|
Subroutine
following_relationships: not called CC=1 SCAR=6.9
Pod
undocumented
| |||
| 1099 | 0 | my $self = shift; | |
| 1100 | 0 | Carp::carp("'following_relationships' is deprecated. Use 'get_following_relationships' instead."); | |
| 1101 | 0 | $self->get_following_relationships(@_); | |
| 1102 | } | ||
| 1103 | |||
| 1104 | =pod | ||
| 1105 | |||
| 1106 | |||
| 1107 | |||
| 1108 | =item get_following_relationships_by_group | ||
| 1109 | |||
| 1110 | my $res = $tp->users->get_following_relationships_by_group($id, $groupId); | ||
| 1111 | |||
| 1112 | Get a list of relationships that have the Contact type that other users have with the selected user, constrained to members of a particular group. | ||
| 1113 | |||
| 1114 | Returns ListE<lt>RelationshipE<gt> which contains following properties. | ||
| 1115 | |||
| 1116 | =over 8 | ||
| 1117 | |||
| 1118 | =item totalResults | ||
| 1119 | |||
| 1120 | (integer) The total number of items in the whole list of which this list object is a paginated view. | ||
| 1121 | |||
| 1122 | =item entries | ||
| 1123 | |||
| 1124 | (arrayE<lt>RelationshipE<gt>) The items within the selected slice of the list. | ||
| 1125 | |||
| 1126 | |||
| 1127 | =back | ||
| 1128 | |||
| 1129 | =cut | ||
| 1130 | |||
| 1131 | 0 | ▶ | sub get_following_relationships_by_group { |
|
Subroutine
get_following_relationships_by_group: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 1132 | 0 | my $api = shift; | |
| 1133 | 0 | my @args; | |
| 1134 | 0 | push @args, shift; # id | |
| 1135 | 0 | push @args, shift; # groupId | |
| 1136 | 0 | my $uri = sprintf '/users/%s/relationships/@following/@by-group/%s.json', @args; | |
| 1137 | 0 | $api->base->call("GET", $uri, @_); | |
| 1138 | } | ||
| 1139 | |||
| 1140 | |||
| 1141 | 0 | ▶ | sub following_relationships_by_group { |
|
Subroutine
following_relationships_by_group: not called CC=1 SCAR=6.9
Pod
undocumented
| |||
| 1142 | 0 | my $self = shift; | |
| 1143 | 0 | Carp::carp("'following_relationships_by_group' is deprecated. Use 'get_following_relationships_by_group' instead."); | |
| 1144 | 0 | $self->get_following_relationships_by_group(@_); | |
| 1145 | } | ||
| 1146 | |||
| 1147 | =pod | ||
| 1148 | |||
| 1149 | =back | ||
| 1150 | |||
| 1151 | =cut | ||
| 1152 | |||
| 1153 | ### END auto-generated | ||
| 1154 | |||
| 1155 | 1 | 1; | |