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

Download:
WWW-TypePad-0.4002.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source  

NAME ^

WWW::TypePad::Conversations - Conversations API methods

METHODS ^

add_external_response
  my $res = $tp->conversations->add_external_response($id);

Record a response to a conversation originating from somewhere other than a TypePad blog.

Returns hash reference which contains following properties.

response

(ConversationResponse) A ConversationResponse object representing the created response.

add_poll_response
  my $res = $tp->conversations->add_poll_response($id);

Record a response choosing one of the polling options for this conversation.

Returns hash reference which contains following properties.

responseToken

(string) A secret token associated with the responseId.

responseId

(string) An identifier for the poll response.

get_responses
  my $res = $tp->conversations->get_responses($id);

Retrieve a list of responses for the selected conversation.

Returns Stream<ConversationResponse> which contains following properties.

totalResults

(integer) The total number of items in the whole stream of which this response contains a subset. C<null> if an exact count cannot be determined.

estimatedTotalResults

(integer) An estimate of the total number of items in the whole list of which this response contains a subset. C<null> if a count cannot be determined at all, or if an exact count is returned in C<totalResults>.

moreResultsToken

(string) An opaque token that can be used as the C<start-token> parameter of a followup request to retrieve additional results. C<null> 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.

entries

(array<ConversationResponse>) A selection of items from the underlying stream.

get_featured_responses
  my $res = $tp->conversations->get_featured_responses($id);

Retrieve a list of featured responses for the selected conversation.

Returns Stream<ConversationResponse> which contains following properties.

totalResults

(integer) The total number of items in the whole stream of which this response contains a subset. C<null> if an exact count cannot be determined.

estimatedTotalResults

(integer) An estimate of the total number of items in the whole list of which this response contains a subset. C<null> if a count cannot be determined at all, or if an exact count is returned in C<totalResults>.

moreResultsToken

(string) An opaque token that can be used as the C<start-token> parameter of a followup request to retrieve additional results. C<null> 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.

entries

(array<ConversationResponse>) A selection of items from the underlying stream.

get_from_voices_responses
  my $res = $tp->conversations->get_from_voices_responses($id);

Retrieve a list of responses from invited participants for the selected conversation.

Returns Stream<ConversationResponse> which contains following properties.

totalResults

(integer) The total number of items in the whole stream of which this response contains a subset. C<null> if an exact count cannot be determined.

estimatedTotalResults

(integer) An estimate of the total number of items in the whole list of which this response contains a subset. C<null> if a count cannot be determined at all, or if an exact count is returned in C<totalResults>.

moreResultsToken

(string) An opaque token that can be used as the C<start-token> parameter of a followup request to retrieve additional results. C<null> 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.

entries

(array<ConversationResponse>) A selection of items from the underlying stream.

syntax highlighting: