view release on metacpan or  search on metacpan

lib/Google/RestApi/DocsApi1/Document.pm  view on Meta::CPAN

Google::RestApi::DocsApi1::Document - Represents a Google Docs document with batch update support.

=head1 DESCRIPTION

Document inherits from L<Google::RestApi::Request> and provides methods
to queue Google Docs API batch update requests. Requests are collected
and submitted together via C<submit_requests()>.

See the description and synopsis at L<Google::RestApi::DocsApi1>.

=head1 NAVIGATION

=over

=item * L<Google::RestApi::DocsApi1>

=item * L<Google::RestApi::DocsApi1::Document>

=back

=head1 SUBROUTINES

=over

=item new(%args)

Creates a new Document instance.

%args consists of:

=over

=item * C<docs_api> L<Google::RestApi::DocsApi1>: Required. The parent DocsApi1 object.

=item * C<id> <string>: Required. The document ID (Google Drive file ID).

=back

=item api(%args)

Calls the parent DocsApi1's 'api' routine adding the document ID.

=item document_id()

Returns the document ID.

=item get(%args)

Gets the document content.

%args consists of:

=over

=item * C<fields> <string>: Optional. Fields to return (e.g. 'title', 'body').

=back

=item submit_requests()

Submits all queued batch requests to the Google Docs API batchUpdate endpoint.

=item insert_text(%args)

Queues an insertText request.

%args: C<text> (required), C<index> (optional), C<segment_id> (optional).

=item delete_content(%args)

Queues a deleteContentRange request.

%args: C<range> (required hashref with startIndex/endIndex).

=item replace_all_text(%args)

Queues a replaceAllText request.

%args: C<find> (required), C<replacement> (required), C<match_case> (default true).

=item update_text_style(%args)

Queues an updateTextStyle request.

%args: C<range> (required), C<style> (required hashref), C<fields> (required).

=item update_paragraph_style(%args)

Queues an updateParagraphStyle request.

%args: C<range> (required), C<style> (required hashref), C<fields> (required).

=item insert_table(%args)

Queues an insertTable request.

%args: C<index> (required), C<rows> (required), C<columns> (required), C<segment_id> (optional).

=item insert_inline_image(%args)

Queues an insertInlineImage request.

%args: C<index> (required), C<uri> (required), C<width> (optional hashref), C<height> (optional hashref), C<segment_id> (optional).

=item create_paragraph_bullets(%args)

Queues a createParagraphBullets request.

%args: C<range> (required), C<bullet_preset> (required).

=item delete_paragraph_bullets(%args)

Queues a deleteParagraphBullets request.

%args: C<range> (required hashref).

=item create_named_range(%args)

Queues a createNamedRange request.

%args: C<name> (required), C<range> (required hashref).