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

Download:
WWW-TypePad-0.3001.tar.gz

Dependencies

Annotate this POD

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

NAME ^

WWW::TypePad::Groups - Groups API methods

METHODS ^

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

Get basic information about the selected group.

Returns Group which contains following properties.

displayName

(string) The display name set by the group's owner.

tagline

(string) A tagline describing the group, as set by the group's owner.

objectTypes

(set<string>) B<Deprecated> An array of object type identifier URIs.

objectType

(string) A keyword describing the type of this object. For a group object, M<objectType> will be C<Group>.

avatarLink

(ImageLink) A link to an image representing this group.

siteUrl

(string) The URL to the front page of the group website.

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.

add_member
  my $res = $tp->groups->add_member($id);

Add a given user as a member of the selected group.

Returns hash reference which contains following properties.

post_to_audio_assets
  my $res = $tp->groups->post_to_audio_assets($id);

Create a new Audio asset within the selected group.

Returns Audio which contains following properties.

audioLink

(AudioLink) A link to the audio stream that is this Audio asset's content.

suppressEvents

(boolean) B<Editable> 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.

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.

get_audio_assets
  my $res = $tp->groups->get_audio_assets($id);

Get a list of recently created Audio assets from the selected group.

Returns List<Audio> 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<Audio>) The items within the selected slice of the list.

block_user
  my $res = $tp->groups->block_user($id);

Block the given user from joining the selected group, removing that user as a member in the process.

Returns hash reference which contains following properties.

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

Subscribe the group to one or more external feeds.

Returns hash reference which contains following properties.

subscription

(ExternalFeedSubscription) The subscription object that was created.

get_events
  my $res = $tp->groups->get_events($id);

Get a list of events describing actions performed in the selected group.

Returns List<Event> 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<Event>) The items within the selected slice of the list.

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

Get a list of the group'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.

post_to_link_assets
  my $res = $tp->groups->post_to_link_assets($id);

Create a new Link asset within the selected group.

Returns Link which contains following properties.

targetUrl

(string) The URL that is the target of this link.

suppressEvents

(boolean) B<Editable> 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.

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.

get_link_assets
  my $res = $tp->groups->get_link_assets($id);

Returns a list of recently created Link assets from the selected group.

Returns List<Link> 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<Link>) The items within the selected slice of the list.

get_memberships
  my $res = $tp->groups->get_memberships($id);

Get a list of relationships between users and the selected group.

Returns List<Relationship> 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<Relationship>) The items within the selected slice of the list.

get_admin_memberships
  my $res = $tp->groups->get_admin_memberships($id);

Get a list of relationships that have the Admin type between users and the selected group.

Returns List<Relationship> 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<Relationship>) The items within the selected slice of the list.

get_blocked_memberships
  my $res = $tp->groups->get_blocked_memberships($id);

Get a list of relationships that have the Blocked type between users and the selected groups. (Restricted to group admin.)

Returns List<Relationship> 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<Relationship>) The items within the selected slice of the list.

get_member_memberships
  my $res = $tp->groups->get_member_memberships($id);

Get a list of relationships that have the Member type between users and the selected group.

Returns List<Relationship> 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<Relationship>) The items within the selected slice of the list.

post_to_photo_assets
  my $res = $tp->groups->post_to_photo_assets($id);

Create a new Photo asset within the selected group.

Returns Photo which contains following properties.

imageLink

(ImageLink) A link to the image that is this Photo asset's content.

suppressEvents

(boolean) B<Editable> 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.

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.

get_photo_assets
  my $res = $tp->groups->get_photo_assets($id);

Get a list of recently created Photo assets from the selected group.

Returns List<Photo> 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<Photo>) The items within the selected slice of the list.

post_to_post_assets
  my $res = $tp->groups->post_to_post_assets($id);

Create a new Post asset within the selected group.

Returns Post which contains following properties.

categories

(array<string>) B<Editable> A list of categories associated with the post.

embeddedImageLinks

(array<ImageLink>) A list of links to the images that are embedded within the content of this post.

embeddedVideoLinks

(array<VideoLink>) A list of links to the videos that are embedded within the content of this post.

embeddedAudioLinks

(array<AudioLink>) A list of links to the audio streams that are embedded within the content of this post.

title

(string) B<Editable> The title of the post.

description

(string) B<Editable> The description of the post.

filename

(string) B<Editable> The base name of the post to use when creating its M<permalinkUrl>.

content

(string) B<Editable> The raw post content. The M<textFormat> property defines what format this data is in.

textFormat

(string) B<Editable> A keyword that indicates what formatting mode to use for the content of this post. 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.

publicationStatus

(PublicationStatus) B<Editable> An object describing the draft status and publication date for this post.

feedbackStatus

(FeedbackStatus) B<Editable> An object describing the comment and trackback behavior for this post.

reblogCount

(integer) The number of times this post has been reblogged by other people.

reblogOf

(AssetRef) A reference to a post of which this post is a reblog.

suppressEvents

(boolean) B<Editable> 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.

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.

get_post_assets
  my $res = $tp->groups->get_post_assets($id);

Get a list of recently created Post assets from the selected group.

Returns List<Post> 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<Post>) The items within the selected slice of the list.

remove_member
  my $res = $tp->groups->remove_member($id);

Remove a given user as a member of the selected group.

Returns hash reference which contains following properties.

unblock_user
  my $res = $tp->groups->unblock_user($id);

Remove the block preventing the given user from joining the selected group.

Returns hash reference which contains following properties.

post_to_video_assets
  my $res = $tp->groups->post_to_video_assets($id);

Create a new Video asset within the selected group.

Returns Video which contains following properties.

videoLink

(VideoLink) A link to the video that is this Video asset's content.

previewImageLink

(ImageLink) A link to a preview image or poster frame for this video. This property is omitted if no such image is available.

suppressEvents

(boolean) B<Editable> 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.

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.

get_video_assets
  my $res = $tp->groups->get_video_assets($id);

Get a list of recently created Video assets from the selected group.

Returns List<Video> 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<Video>) The items within the selected slice of the list.

syntax highlighting: