Six Apart Ltd. > WWW-TypePad-0.3001 > WWW::TypePad::ImportJobs

Download:
WWW-TypePad-0.3001.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source   Latest Release: WWW-TypePad-0.4002

NAME ^

WWW::TypePad::ImportJobs - ImportJobs API methods

METHODS ^

close_job
  my $res = $tp->import_jobs->close_job($id);

Terminates a blog import job.

Returns hash reference which contains following properties.

post_to_media_assets
  my $res = $tp->import_jobs->post_to_media_assets($id);

Add a new media asset to the account that owns the blog associated with this import job.

Returns Asset which contains following properties.

id

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

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.

permalinkUrl

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

author

(User) The user who created the selected asset.

published

(string) The time at which the asset was created, as a W3CDTF timestamp.

content

(string) The raw asset content. The M<textFormat> 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 M<content> value up to 10,000 bytes long, while a O<Post> asset in a blog may have up to 65,000 bytes of content.

renderedContent

(string) The content of this asset rendered to HTML. This is currently available only for O<Post> and O<Page> assets.

excerpt

(string) A short, plain-text excerpt of the entry content. This is currently available only for O<Post> assets.

textFormat

(string) A keyword that indicates what formatting mode to use for the content of this asset. This can be C<html> for assets the content of which is HTML, C<html_convert_linebreaks> for assets the content of which is HTML but where paragraph tags should be added automatically, or C<markdown> 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.

groups

(array<string>) B<Deprecated> An array of strings containing the M<id> URI of the O<Group> object that this asset is mapped into, if any. This property has been superseded by the M<container> property.

source

(AssetSource) An object describing the site from which this asset was retrieved, if the asset was obtained from an external source.

objectTypes

(set<string>) B<Deprecated> 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.

objectType

(string) The keyword identifying the type of asset this is.

isFavoriteForCurrentUser

(boolean) C<true> if this asset is a favorite for the currently authenticated user, or C<false> otherwise. This property is omitted from responses to anonymous requests.

favoriteCount

(integer) The number of distinct users who have added this asset as a favorite.

commentCount

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

title

(string) The title of the asset.

description

(string) The description of the asset.

container

(ContainerRef) An object describing the group or blog to which this asset belongs.

publicationStatus

(PublicationStatus) B<Editable> An object describing the visibility status and publication date for this asset. Only visibility status is editable.

crosspostAccounts

(set<string>) B<Editable> A set of identifiers for O<Account> objects to which to crosspost this asset when it's posted. This property is omitted when retrieving existing assets.

isConversationsAnswer

(boolean) B<Deprecated> C<true> 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.

reblogOf

(AssetRef) B<Deprecated> If this asset was created by 'reblogging' another asset, this property describes the original asset.

reblogOfUrl

(string) B<Deprecated> 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.

submit_items
  my $res = $tp->import_jobs->submit_items($id);

Imports a selection of items into a blog import job.

Returns hash reference which contains following properties.

syntax highlighting: