SAY MEDIA > WWW-TypePad-0.4002 > WWW::TypePad::Applications

Download:
WWW-TypePad-0.4002.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source  

NAME ^

WWW::TypePad::Applications - Applications API methods

METHODS ^

get
  my $res = $tp->applications->get($id);

Get basic information about the selected application.

Returns Application which contains following properties.

name

(string) The name of the application as provided by its developer.

id

(string) A string containing the canonical identifier that can be used to identify this application in URLs.

objectTypes

(set<string>) B<Deprecated> The object types for this object. This set will contain the string C<tag:api.typepad.com,2009:Application> for an Application object.

objectType

(string) The keyword identifying the type of object this is. For an Application object, M<objectType> will be C<Application>.

oauthRequestTokenUrl

(string) The URL of the OAuth request token endpoint for this application.

oauthAuthorizationUrl

(string) The URL to send the user's browser to for the user authorization step.

oauthAccessTokenUrl

(string) The URL of the OAuth access token endpoint for this application.

oauthIdentificationUrl

(string) The URL to send the user's browser to in order to identify who is logged in (that is, the "sign in" link).

sessionSyncScriptUrl

(string) The URL of the session sync script.

signoutUrl

(string) The URL to send the user's browser to in order to sign them out of TypePad.

userFlyoutsScriptUrl

(string) The URL of a script to embed to enable the user flyouts functionality.

id

(string) A URI that serves as a globally unique identifier for the object.

urlId

(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.

get_badges
  my $res = $tp->applications->get_badges($id);

Get a list of badges defined by this application.

Returns List<Badge> which contains following properties.

totalResults

(integer) The total number of items in the whole list of which this list object is a paginated view.

entries

(array<Badge>) The items within the selected slice of the list.

get_learning_badges
  my $res = $tp->applications->get_learning_badges($id);

Get a list of all learning badges defined by this application.

Returns List<Badge> which contains following properties.

totalResults

(integer) The total number of items in the whole list of which this list object is a paginated view.

entries

(array<Badge>) The items within the selected slice of the list.

get_public_badges
  my $res = $tp->applications->get_public_badges($id);

Get a list of all public badges defined by this application.

Returns List<Badge> which contains following properties.

totalResults

(integer) The total number of items in the whole list of which this list object is a paginated view.

entries

(array<Badge>) The items within the selected slice of the list.

create_external_feed_subscription
  my $res = $tp->applications->create_external_feed_subscription($id);

Subscribe the application to one or more external feeds.

Returns hash reference which contains following properties.

subscription

(ExternalFeedSubscription) The subscription object that was created.

get_external_feed_subscriptions
  my $res = $tp->applications->get_external_feed_subscriptions($id);

Get a list of the application's active external feed subscriptions.

Returns List<ExternalFeedSubscription> which contains following properties.

totalResults

(integer) The total number of items in the whole list of which this list object is a paginated view.

entries

(array<ExternalFeedSubscription>) The items within the selected slice of the list.

get_groups
  my $res = $tp->applications->get_groups($id);

Get a list of groups in which a client using a C<app_full> access auth token from this application can act.

Returns List<Group> which contains following properties.

totalResults

(integer) The total number of items in the whole list of which this list object is a paginated view.

entries

(array<Group>) The items within the selected slice of the list.

syntax highlighting: