gestione documentale avanzata 1 parte

This commit is contained in:
2026-05-28 09:34:28 +02:00
parent 3471befb1a
commit f2b0833b90
34482 changed files with 4312269 additions and 546 deletions
@@ -0,0 +1,44 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class AddDocumentTabRequest extends \Google\Model
{
protected $tabPropertiesType = TabProperties::class;
protected $tabPropertiesDataType = '';
/**
* The properties of the tab to add. All properties are optional.
*
* @param TabProperties $tabProperties
*/
public function setTabProperties(TabProperties $tabProperties)
{
$this->tabProperties = $tabProperties;
}
/**
* @return TabProperties
*/
public function getTabProperties()
{
return $this->tabProperties;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AddDocumentTabRequest::class, 'Google_Service_Docs_AddDocumentTabRequest');
@@ -0,0 +1,44 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class AddDocumentTabResponse extends \Google\Model
{
protected $tabPropertiesType = TabProperties::class;
protected $tabPropertiesDataType = '';
/**
* The properties of the newly added tab.
*
* @param TabProperties $tabProperties
*/
public function setTabProperties(TabProperties $tabProperties)
{
$this->tabProperties = $tabProperties;
}
/**
* @return TabProperties
*/
public function getTabProperties()
{
return $this->tabProperties;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AddDocumentTabResponse::class, 'Google_Service_Docs_AddDocumentTabResponse');
+150
View File
@@ -0,0 +1,150 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class AutoText extends \Google\Collection
{
/**
* An unspecified auto text type.
*/
public const TYPE_TYPE_UNSPECIFIED = 'TYPE_UNSPECIFIED';
/**
* Type for auto text that represents the current page number.
*/
public const TYPE_PAGE_NUMBER = 'PAGE_NUMBER';
/**
* Type for auto text that represents the total number of pages in the
* document.
*/
public const TYPE_PAGE_COUNT = 'PAGE_COUNT';
protected $collection_key = 'suggestedInsertionIds';
/**
* The suggested deletion IDs. If empty, then there are no suggested deletions
* of this content.
*
* @var string[]
*/
public $suggestedDeletionIds;
/**
* The suggested insertion IDs. An AutoText may have multiple insertion IDs if
* it's a nested suggested change. If empty, then this is not a suggested
* insertion.
*
* @var string[]
*/
public $suggestedInsertionIds;
protected $suggestedTextStyleChangesType = SuggestedTextStyle::class;
protected $suggestedTextStyleChangesDataType = 'map';
protected $textStyleType = TextStyle::class;
protected $textStyleDataType = '';
/**
* The type of this auto text.
*
* @var string
*/
public $type;
/**
* The suggested deletion IDs. If empty, then there are no suggested deletions
* of this content.
*
* @param string[] $suggestedDeletionIds
*/
public function setSuggestedDeletionIds($suggestedDeletionIds)
{
$this->suggestedDeletionIds = $suggestedDeletionIds;
}
/**
* @return string[]
*/
public function getSuggestedDeletionIds()
{
return $this->suggestedDeletionIds;
}
/**
* The suggested insertion IDs. An AutoText may have multiple insertion IDs if
* it's a nested suggested change. If empty, then this is not a suggested
* insertion.
*
* @param string[] $suggestedInsertionIds
*/
public function setSuggestedInsertionIds($suggestedInsertionIds)
{
$this->suggestedInsertionIds = $suggestedInsertionIds;
}
/**
* @return string[]
*/
public function getSuggestedInsertionIds()
{
return $this->suggestedInsertionIds;
}
/**
* The suggested text style changes to this AutoText, keyed by suggestion ID.
*
* @param SuggestedTextStyle[] $suggestedTextStyleChanges
*/
public function setSuggestedTextStyleChanges($suggestedTextStyleChanges)
{
$this->suggestedTextStyleChanges = $suggestedTextStyleChanges;
}
/**
* @return SuggestedTextStyle[]
*/
public function getSuggestedTextStyleChanges()
{
return $this->suggestedTextStyleChanges;
}
/**
* The text style of this AutoText.
*
* @param TextStyle $textStyle
*/
public function setTextStyle(TextStyle $textStyle)
{
$this->textStyle = $textStyle;
}
/**
* @return TextStyle
*/
public function getTextStyle()
{
return $this->textStyle;
}
/**
* The type of this auto text.
*
* Accepted values: TYPE_UNSPECIFIED, PAGE_NUMBER, PAGE_COUNT
*
* @param self::TYPE_* $type
*/
public function setType($type)
{
$this->type = $type;
}
/**
* @return self::TYPE_*
*/
public function getType()
{
return $this->type;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AutoText::class, 'Google_Service_Docs_AutoText');
@@ -0,0 +1,44 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class Background extends \Google\Model
{
protected $colorType = OptionalColor::class;
protected $colorDataType = '';
/**
* The background color.
*
* @param OptionalColor $color
*/
public function setColor(OptionalColor $color)
{
$this->color = $color;
}
/**
* @return OptionalColor
*/
public function getColor()
{
return $this->color;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Background::class, 'Google_Service_Docs_Background');
@@ -0,0 +1,50 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class BackgroundSuggestionState extends \Google\Model
{
/**
* Indicates whether the current background color has been modified in this
* suggestion.
*
* @var bool
*/
public $backgroundColorSuggested;
/**
* Indicates whether the current background color has been modified in this
* suggestion.
*
* @param bool $backgroundColorSuggested
*/
public function setBackgroundColorSuggested($backgroundColorSuggested)
{
$this->backgroundColorSuggested = $backgroundColorSuggested;
}
/**
* @return bool
*/
public function getBackgroundColorSuggested()
{
return $this->backgroundColorSuggested;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BackgroundSuggestionState::class, 'Google_Service_Docs_BackgroundSuggestionState');
@@ -0,0 +1,63 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class BatchUpdateDocumentRequest extends \Google\Collection
{
protected $collection_key = 'requests';
protected $requestsType = Request::class;
protected $requestsDataType = 'array';
protected $writeControlType = WriteControl::class;
protected $writeControlDataType = '';
/**
* A list of updates to apply to the document.
*
* @param Request[] $requests
*/
public function setRequests($requests)
{
$this->requests = $requests;
}
/**
* @return Request[]
*/
public function getRequests()
{
return $this->requests;
}
/**
* Provides control over how write requests are executed.
*
* @param WriteControl $writeControl
*/
public function setWriteControl(WriteControl $writeControl)
{
$this->writeControl = $writeControl;
}
/**
* @return WriteControl
*/
public function getWriteControl()
{
return $this->writeControl;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BatchUpdateDocumentRequest::class, 'Google_Service_Docs_BatchUpdateDocumentRequest');
@@ -0,0 +1,86 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class BatchUpdateDocumentResponse extends \Google\Collection
{
protected $collection_key = 'replies';
/**
* The ID of the document to which the updates were applied to.
*
* @var string
*/
public $documentId;
protected $repliesType = Response::class;
protected $repliesDataType = 'array';
protected $writeControlType = WriteControl::class;
protected $writeControlDataType = '';
/**
* The ID of the document to which the updates were applied to.
*
* @param string $documentId
*/
public function setDocumentId($documentId)
{
$this->documentId = $documentId;
}
/**
* @return string
*/
public function getDocumentId()
{
return $this->documentId;
}
/**
* The reply of the updates. This maps 1:1 with the updates, although replies
* to some requests may be empty.
*
* @param Response[] $replies
*/
public function setReplies($replies)
{
$this->replies = $replies;
}
/**
* @return Response[]
*/
public function getReplies()
{
return $this->replies;
}
/**
* The updated write control after applying the request.
*
* @param WriteControl $writeControl
*/
public function setWriteControl(WriteControl $writeControl)
{
$this->writeControl = $writeControl;
}
/**
* @return WriteControl
*/
public function getWriteControl()
{
return $this->writeControl;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BatchUpdateDocumentResponse::class, 'Google_Service_Docs_BatchUpdateDocumentResponse');
+45
View File
@@ -0,0 +1,45 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class Body extends \Google\Collection
{
protected $collection_key = 'content';
protected $contentType = StructuralElement::class;
protected $contentDataType = 'array';
/**
* The contents of the body. The indexes for the body's content begin at zero.
*
* @param StructuralElement[] $content
*/
public function setContent($content)
{
$this->content = $content;
}
/**
* @return StructuralElement[]
*/
public function getContent()
{
return $this->content;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Body::class, 'Google_Service_Docs_Body');
@@ -0,0 +1,70 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class BookmarkLink extends \Google\Model
{
/**
* The ID of a bookmark in this document.
*
* @var string
*/
public $id;
/**
* The ID of the tab containing this bookmark.
*
* @var string
*/
public $tabId;
/**
* The ID of a bookmark in this document.
*
* @param string $id
*/
public function setId($id)
{
$this->id = $id;
}
/**
* @return string
*/
public function getId()
{
return $this->id;
}
/**
* The ID of the tab containing this bookmark.
*
* @param string $tabId
*/
public function setTabId($tabId)
{
$this->tabId = $tabId;
}
/**
* @return string
*/
public function getTabId()
{
return $this->tabId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BookmarkLink::class, 'Google_Service_Docs_BookmarkLink');
+88
View File
@@ -0,0 +1,88 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class Bullet extends \Google\Model
{
/**
* The ID of the list this paragraph belongs to.
*
* @var string
*/
public $listId;
/**
* The nesting level of this paragraph in the list.
*
* @var int
*/
public $nestingLevel;
protected $textStyleType = TextStyle::class;
protected $textStyleDataType = '';
/**
* The ID of the list this paragraph belongs to.
*
* @param string $listId
*/
public function setListId($listId)
{
$this->listId = $listId;
}
/**
* @return string
*/
public function getListId()
{
return $this->listId;
}
/**
* The nesting level of this paragraph in the list.
*
* @param int $nestingLevel
*/
public function setNestingLevel($nestingLevel)
{
$this->nestingLevel = $nestingLevel;
}
/**
* @return int
*/
public function getNestingLevel()
{
return $this->nestingLevel;
}
/**
* The paragraph-specific text style applied to this bullet.
*
* @param TextStyle $textStyle
*/
public function setTextStyle(TextStyle $textStyle)
{
$this->textStyle = $textStyle;
}
/**
* @return TextStyle
*/
public function getTextStyle()
{
return $this->textStyle;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Bullet::class, 'Google_Service_Docs_Bullet');
@@ -0,0 +1,89 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class BulletSuggestionState extends \Google\Model
{
/**
* Indicates if there was a suggested change to the list_id.
*
* @var bool
*/
public $listIdSuggested;
/**
* Indicates if there was a suggested change to the nesting_level.
*
* @var bool
*/
public $nestingLevelSuggested;
protected $textStyleSuggestionStateType = TextStyleSuggestionState::class;
protected $textStyleSuggestionStateDataType = '';
/**
* Indicates if there was a suggested change to the list_id.
*
* @param bool $listIdSuggested
*/
public function setListIdSuggested($listIdSuggested)
{
$this->listIdSuggested = $listIdSuggested;
}
/**
* @return bool
*/
public function getListIdSuggested()
{
return $this->listIdSuggested;
}
/**
* Indicates if there was a suggested change to the nesting_level.
*
* @param bool $nestingLevelSuggested
*/
public function setNestingLevelSuggested($nestingLevelSuggested)
{
$this->nestingLevelSuggested = $nestingLevelSuggested;
}
/**
* @return bool
*/
public function getNestingLevelSuggested()
{
return $this->nestingLevelSuggested;
}
/**
* A mask that indicates which of the fields in text style have been changed
* in this suggestion.
*
* @param TextStyleSuggestionState $textStyleSuggestionState
*/
public function setTextStyleSuggestionState(TextStyleSuggestionState $textStyleSuggestionState)
{
$this->textStyleSuggestionState = $textStyleSuggestionState;
}
/**
* @return TextStyleSuggestionState
*/
public function getTextStyleSuggestionState()
{
return $this->textStyleSuggestionState;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BulletSuggestionState::class, 'Google_Service_Docs_BulletSuggestionState');
+44
View File
@@ -0,0 +1,44 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class Color extends \Google\Model
{
protected $rgbColorType = RgbColor::class;
protected $rgbColorDataType = '';
/**
* The RGB color value.
*
* @param RgbColor $rgbColor
*/
public function setRgbColor(RgbColor $rgbColor)
{
$this->rgbColor = $rgbColor;
}
/**
* @return RgbColor
*/
public function getRgbColor()
{
return $this->rgbColor;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Color::class, 'Google_Service_Docs_Color');
@@ -0,0 +1,116 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class ColumnBreak extends \Google\Collection
{
protected $collection_key = 'suggestedInsertionIds';
/**
* The suggested deletion IDs. If empty, then there are no suggested deletions
* of this content.
*
* @var string[]
*/
public $suggestedDeletionIds;
/**
* The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs
* if it's a nested suggested change. If empty, then this is not a suggested
* insertion.
*
* @var string[]
*/
public $suggestedInsertionIds;
protected $suggestedTextStyleChangesType = SuggestedTextStyle::class;
protected $suggestedTextStyleChangesDataType = 'map';
protected $textStyleType = TextStyle::class;
protected $textStyleDataType = '';
/**
* The suggested deletion IDs. If empty, then there are no suggested deletions
* of this content.
*
* @param string[] $suggestedDeletionIds
*/
public function setSuggestedDeletionIds($suggestedDeletionIds)
{
$this->suggestedDeletionIds = $suggestedDeletionIds;
}
/**
* @return string[]
*/
public function getSuggestedDeletionIds()
{
return $this->suggestedDeletionIds;
}
/**
* The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs
* if it's a nested suggested change. If empty, then this is not a suggested
* insertion.
*
* @param string[] $suggestedInsertionIds
*/
public function setSuggestedInsertionIds($suggestedInsertionIds)
{
$this->suggestedInsertionIds = $suggestedInsertionIds;
}
/**
* @return string[]
*/
public function getSuggestedInsertionIds()
{
return $this->suggestedInsertionIds;
}
/**
* The suggested text style changes to this ColumnBreak, keyed by suggestion
* ID.
*
* @param SuggestedTextStyle[] $suggestedTextStyleChanges
*/
public function setSuggestedTextStyleChanges($suggestedTextStyleChanges)
{
$this->suggestedTextStyleChanges = $suggestedTextStyleChanges;
}
/**
* @return SuggestedTextStyle[]
*/
public function getSuggestedTextStyleChanges()
{
return $this->suggestedTextStyleChanges;
}
/**
* The text style of this ColumnBreak. Similar to text content, like text runs
* and footnote references, the text style of a column break can affect
* content layout as well as the styling of text inserted next to it.
*
* @param TextStyle $textStyle
*/
public function setTextStyle(TextStyle $textStyle)
{
$this->textStyle = $textStyle;
}
/**
* @return TextStyle
*/
public function getTextStyle()
{
return $this->textStyle;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ColumnBreak::class, 'Google_Service_Docs_ColumnBreak');
@@ -0,0 +1,79 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class CreateFooterRequest extends \Google\Model
{
/**
* The header/footer type is unspecified.
*/
public const TYPE_HEADER_FOOTER_TYPE_UNSPECIFIED = 'HEADER_FOOTER_TYPE_UNSPECIFIED';
/**
* A default header/footer.
*/
public const TYPE_DEFAULT = 'DEFAULT';
protected $sectionBreakLocationType = Location::class;
protected $sectionBreakLocationDataType = '';
/**
* The type of footer to create.
*
* @var string
*/
public $type;
/**
* The location of the SectionBreak immediately preceding the section whose
* SectionStyle this footer should belong to. If this is unset or refers to
* the first section break in the document, the footer applies to the document
* style.
*
* @param Location $sectionBreakLocation
*/
public function setSectionBreakLocation(Location $sectionBreakLocation)
{
$this->sectionBreakLocation = $sectionBreakLocation;
}
/**
* @return Location
*/
public function getSectionBreakLocation()
{
return $this->sectionBreakLocation;
}
/**
* The type of footer to create.
*
* Accepted values: HEADER_FOOTER_TYPE_UNSPECIFIED, DEFAULT
*
* @param self::TYPE_* $type
*/
public function setType($type)
{
$this->type = $type;
}
/**
* @return self::TYPE_*
*/
public function getType()
{
return $this->type;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CreateFooterRequest::class, 'Google_Service_Docs_CreateFooterRequest');
@@ -0,0 +1,48 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class CreateFooterResponse extends \Google\Model
{
/**
* The ID of the created footer.
*
* @var string
*/
public $footerId;
/**
* The ID of the created footer.
*
* @param string $footerId
*/
public function setFooterId($footerId)
{
$this->footerId = $footerId;
}
/**
* @return string
*/
public function getFooterId()
{
return $this->footerId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CreateFooterResponse::class, 'Google_Service_Docs_CreateFooterResponse');
@@ -0,0 +1,71 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class CreateFootnoteRequest extends \Google\Model
{
protected $endOfSegmentLocationType = EndOfSegmentLocation::class;
protected $endOfSegmentLocationDataType = '';
protected $locationType = Location::class;
protected $locationDataType = '';
/**
* Inserts the footnote reference at the end of the document body. Footnote
* references cannot be inserted inside a header, footer or footnote. Since
* footnote references can only be inserted in the body, the segment ID field
* must be empty.
*
* @param EndOfSegmentLocation $endOfSegmentLocation
*/
public function setEndOfSegmentLocation(EndOfSegmentLocation $endOfSegmentLocation)
{
$this->endOfSegmentLocation = $endOfSegmentLocation;
}
/**
* @return EndOfSegmentLocation
*/
public function getEndOfSegmentLocation()
{
return $this->endOfSegmentLocation;
}
/**
* Inserts the footnote reference at a specific index in the document. The
* footnote reference must be inserted inside the bounds of an existing
* Paragraph. For instance, it cannot be inserted at a table's start index
* (i.e. between the table and its preceding paragraph). Footnote references
* cannot be inserted inside an equation, header, footer or footnote. Since
* footnote references can only be inserted in the body, the segment ID field
* must be empty.
*
* @param Location $location
*/
public function setLocation(Location $location)
{
$this->location = $location;
}
/**
* @return Location
*/
public function getLocation()
{
return $this->location;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CreateFootnoteRequest::class, 'Google_Service_Docs_CreateFootnoteRequest');
@@ -0,0 +1,48 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class CreateFootnoteResponse extends \Google\Model
{
/**
* The ID of the created footnote.
*
* @var string
*/
public $footnoteId;
/**
* The ID of the created footnote.
*
* @param string $footnoteId
*/
public function setFootnoteId($footnoteId)
{
$this->footnoteId = $footnoteId;
}
/**
* @return string
*/
public function getFootnoteId()
{
return $this->footnoteId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CreateFootnoteResponse::class, 'Google_Service_Docs_CreateFootnoteResponse');
@@ -0,0 +1,79 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class CreateHeaderRequest extends \Google\Model
{
/**
* The header/footer type is unspecified.
*/
public const TYPE_HEADER_FOOTER_TYPE_UNSPECIFIED = 'HEADER_FOOTER_TYPE_UNSPECIFIED';
/**
* A default header/footer.
*/
public const TYPE_DEFAULT = 'DEFAULT';
protected $sectionBreakLocationType = Location::class;
protected $sectionBreakLocationDataType = '';
/**
* The type of header to create.
*
* @var string
*/
public $type;
/**
* The location of the SectionBreak which begins the section this header
* should belong to. If `section_break_location' is unset or if it refers to
* the first section break in the document body, the header applies to the
* DocumentStyle
*
* @param Location $sectionBreakLocation
*/
public function setSectionBreakLocation(Location $sectionBreakLocation)
{
$this->sectionBreakLocation = $sectionBreakLocation;
}
/**
* @return Location
*/
public function getSectionBreakLocation()
{
return $this->sectionBreakLocation;
}
/**
* The type of header to create.
*
* Accepted values: HEADER_FOOTER_TYPE_UNSPECIFIED, DEFAULT
*
* @param self::TYPE_* $type
*/
public function setType($type)
{
$this->type = $type;
}
/**
* @return self::TYPE_*
*/
public function getType()
{
return $this->type;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CreateHeaderRequest::class, 'Google_Service_Docs_CreateHeaderRequest');
@@ -0,0 +1,48 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class CreateHeaderResponse extends \Google\Model
{
/**
* The ID of the created header.
*
* @var string
*/
public $headerId;
/**
* The ID of the created header.
*
* @param string $headerId
*/
public function setHeaderId($headerId)
{
$this->headerId = $headerId;
}
/**
* @return string
*/
public function getHeaderId()
{
return $this->headerId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CreateHeaderResponse::class, 'Google_Service_Docs_CreateHeaderResponse');
@@ -0,0 +1,70 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class CreateNamedRangeRequest extends \Google\Model
{
/**
* The name of the NamedRange. Names do not need to be unique. Names must be
* at least 1 character and no more than 256 characters, measured in UTF-16
* code units.
*
* @var string
*/
public $name;
protected $rangeType = Range::class;
protected $rangeDataType = '';
/**
* The name of the NamedRange. Names do not need to be unique. Names must be
* at least 1 character and no more than 256 characters, measured in UTF-16
* code units.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* The range to apply the name to.
*
* @param Range $range
*/
public function setRange(Range $range)
{
$this->range = $range;
}
/**
* @return Range
*/
public function getRange()
{
return $this->range;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CreateNamedRangeRequest::class, 'Google_Service_Docs_CreateNamedRangeRequest');
@@ -0,0 +1,48 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class CreateNamedRangeResponse extends \Google\Model
{
/**
* The ID of the created named range.
*
* @var string
*/
public $namedRangeId;
/**
* The ID of the created named range.
*
* @param string $namedRangeId
*/
public function setNamedRangeId($namedRangeId)
{
$this->namedRangeId = $namedRangeId;
}
/**
* @return string
*/
public function getNamedRangeId()
{
return $this->namedRangeId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CreateNamedRangeResponse::class, 'Google_Service_Docs_CreateNamedRangeResponse');
@@ -0,0 +1,154 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class CreateParagraphBulletsRequest extends \Google\Model
{
/**
* The bullet glyph preset is unspecified.
*/
public const BULLET_PRESET_BULLET_GLYPH_PRESET_UNSPECIFIED = 'BULLET_GLYPH_PRESET_UNSPECIFIED';
/**
* A bulleted list with a `DISC`, `CIRCLE` and `SQUARE` bullet glyph for the
* first 3 list nesting levels.
*/
public const BULLET_PRESET_BULLET_DISC_CIRCLE_SQUARE = 'BULLET_DISC_CIRCLE_SQUARE';
/**
* A bulleted list with a `DIAMONDX`, `ARROW3D` and `SQUARE` bullet glyph for
* the first 3 list nesting levels.
*/
public const BULLET_PRESET_BULLET_DIAMONDX_ARROW3D_SQUARE = 'BULLET_DIAMONDX_ARROW3D_SQUARE';
/**
* A bulleted list with `CHECKBOX` bullet glyphs for all list nesting levels.
*/
public const BULLET_PRESET_BULLET_CHECKBOX = 'BULLET_CHECKBOX';
/**
* A bulleted list with a `ARROW`, `DIAMOND` and `DISC` bullet glyph for the
* first 3 list nesting levels.
*/
public const BULLET_PRESET_BULLET_ARROW_DIAMOND_DISC = 'BULLET_ARROW_DIAMOND_DISC';
/**
* A bulleted list with a `STAR`, `CIRCLE` and `SQUARE` bullet glyph for the
* first 3 list nesting levels.
*/
public const BULLET_PRESET_BULLET_STAR_CIRCLE_SQUARE = 'BULLET_STAR_CIRCLE_SQUARE';
/**
* A bulleted list with a `ARROW3D`, `CIRCLE` and `SQUARE` bullet glyph for
* the first 3 list nesting levels.
*/
public const BULLET_PRESET_BULLET_ARROW3D_CIRCLE_SQUARE = 'BULLET_ARROW3D_CIRCLE_SQUARE';
/**
* A bulleted list with a `LEFTTRIANGLE`, `DIAMOND` and `DISC` bullet glyph
* for the first 3 list nesting levels.
*/
public const BULLET_PRESET_BULLET_LEFTTRIANGLE_DIAMOND_DISC = 'BULLET_LEFTTRIANGLE_DIAMOND_DISC';
/**
* A bulleted list with a `DIAMONDX`, `HOLLOWDIAMOND` and `SQUARE` bullet
* glyph for the first 3 list nesting levels.
*/
public const BULLET_PRESET_BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE = 'BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE';
/**
* A bulleted list with a `DIAMOND`, `CIRCLE` and `SQUARE` bullet glyph for
* the first 3 list nesting levels.
*/
public const BULLET_PRESET_BULLET_DIAMOND_CIRCLE_SQUARE = 'BULLET_DIAMOND_CIRCLE_SQUARE';
/**
* A numbered list with `DECIMAL`, `ALPHA` and `ROMAN` numeric glyphs for the
* first 3 list nesting levels, followed by periods.
*/
public const BULLET_PRESET_NUMBERED_DECIMAL_ALPHA_ROMAN = 'NUMBERED_DECIMAL_ALPHA_ROMAN';
/**
* A numbered list with `DECIMAL`, `ALPHA` and `ROMAN` numeric glyphs for the
* first 3 list nesting levels, followed by parenthesis.
*/
public const BULLET_PRESET_NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS = 'NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS';
/**
* A numbered list with `DECIMAL` numeric glyphs separated by periods, where
* each nesting level uses the previous nesting level's glyph as a prefix. For
* example: '1.', '1.1.', '2.', '2.2.'.
*/
public const BULLET_PRESET_NUMBERED_DECIMAL_NESTED = 'NUMBERED_DECIMAL_NESTED';
/**
* A numbered list with `UPPERALPHA`, `ALPHA` and `ROMAN` numeric glyphs for
* the first 3 list nesting levels, followed by periods.
*/
public const BULLET_PRESET_NUMBERED_UPPERALPHA_ALPHA_ROMAN = 'NUMBERED_UPPERALPHA_ALPHA_ROMAN';
/**
* A numbered list with `UPPERROMAN`, `UPPERALPHA` and `DECIMAL` numeric
* glyphs for the first 3 list nesting levels, followed by periods.
*/
public const BULLET_PRESET_NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL = 'NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL';
/**
* A numbered list with `ZERODECIMAL`, `ALPHA` and `ROMAN` numeric glyphs for
* the first 3 list nesting levels, followed by periods.
*/
public const BULLET_PRESET_NUMBERED_ZERODECIMAL_ALPHA_ROMAN = 'NUMBERED_ZERODECIMAL_ALPHA_ROMAN';
/**
* The kinds of bullet glyphs to be used.
*
* @var string
*/
public $bulletPreset;
protected $rangeType = Range::class;
protected $rangeDataType = '';
/**
* The kinds of bullet glyphs to be used.
*
* Accepted values: BULLET_GLYPH_PRESET_UNSPECIFIED,
* BULLET_DISC_CIRCLE_SQUARE, BULLET_DIAMONDX_ARROW3D_SQUARE, BULLET_CHECKBOX,
* BULLET_ARROW_DIAMOND_DISC, BULLET_STAR_CIRCLE_SQUARE,
* BULLET_ARROW3D_CIRCLE_SQUARE, BULLET_LEFTTRIANGLE_DIAMOND_DISC,
* BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE, BULLET_DIAMOND_CIRCLE_SQUARE,
* NUMBERED_DECIMAL_ALPHA_ROMAN, NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS,
* NUMBERED_DECIMAL_NESTED, NUMBERED_UPPERALPHA_ALPHA_ROMAN,
* NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL, NUMBERED_ZERODECIMAL_ALPHA_ROMAN
*
* @param self::BULLET_PRESET_* $bulletPreset
*/
public function setBulletPreset($bulletPreset)
{
$this->bulletPreset = $bulletPreset;
}
/**
* @return self::BULLET_PRESET_*
*/
public function getBulletPreset()
{
return $this->bulletPreset;
}
/**
* The range to apply the bullet preset to.
*
* @param Range $range
*/
public function setRange(Range $range)
{
$this->range = $range;
}
/**
* @return Range
*/
public function getRange()
{
return $this->range;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CreateParagraphBulletsRequest::class, 'Google_Service_Docs_CreateParagraphBulletsRequest');
@@ -0,0 +1,154 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class CropProperties extends \Google\Model
{
/**
* The clockwise rotation angle of the crop rectangle around its center, in
* radians. Rotation is applied after the offsets.
*
* @var float
*/
public $angle;
/**
* The offset specifies how far inwards the bottom edge of the crop rectangle
* is from the bottom edge of the original content as a fraction of the
* original content's height.
*
* @var float
*/
public $offsetBottom;
/**
* The offset specifies how far inwards the left edge of the crop rectangle is
* from the left edge of the original content as a fraction of the original
* content's width.
*
* @var float
*/
public $offsetLeft;
/**
* The offset specifies how far inwards the right edge of the crop rectangle
* is from the right edge of the original content as a fraction of the
* original content's width.
*
* @var float
*/
public $offsetRight;
/**
* The offset specifies how far inwards the top edge of the crop rectangle is
* from the top edge of the original content as a fraction of the original
* content's height.
*
* @var float
*/
public $offsetTop;
/**
* The clockwise rotation angle of the crop rectangle around its center, in
* radians. Rotation is applied after the offsets.
*
* @param float $angle
*/
public function setAngle($angle)
{
$this->angle = $angle;
}
/**
* @return float
*/
public function getAngle()
{
return $this->angle;
}
/**
* The offset specifies how far inwards the bottom edge of the crop rectangle
* is from the bottom edge of the original content as a fraction of the
* original content's height.
*
* @param float $offsetBottom
*/
public function setOffsetBottom($offsetBottom)
{
$this->offsetBottom = $offsetBottom;
}
/**
* @return float
*/
public function getOffsetBottom()
{
return $this->offsetBottom;
}
/**
* The offset specifies how far inwards the left edge of the crop rectangle is
* from the left edge of the original content as a fraction of the original
* content's width.
*
* @param float $offsetLeft
*/
public function setOffsetLeft($offsetLeft)
{
$this->offsetLeft = $offsetLeft;
}
/**
* @return float
*/
public function getOffsetLeft()
{
return $this->offsetLeft;
}
/**
* The offset specifies how far inwards the right edge of the crop rectangle
* is from the right edge of the original content as a fraction of the
* original content's width.
*
* @param float $offsetRight
*/
public function setOffsetRight($offsetRight)
{
$this->offsetRight = $offsetRight;
}
/**
* @return float
*/
public function getOffsetRight()
{
return $this->offsetRight;
}
/**
* The offset specifies how far inwards the top edge of the crop rectangle is
* from the top edge of the original content as a fraction of the original
* content's height.
*
* @param float $offsetTop
*/
public function setOffsetTop($offsetTop)
{
$this->offsetTop = $offsetTop;
}
/**
* @return float
*/
public function getOffsetTop()
{
return $this->offsetTop;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CropProperties::class, 'Google_Service_Docs_CropProperties');
@@ -0,0 +1,136 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class CropPropertiesSuggestionState extends \Google\Model
{
/**
* Indicates if there was a suggested change to angle.
*
* @var bool
*/
public $angleSuggested;
/**
* Indicates if there was a suggested change to offset_bottom.
*
* @var bool
*/
public $offsetBottomSuggested;
/**
* Indicates if there was a suggested change to offset_left.
*
* @var bool
*/
public $offsetLeftSuggested;
/**
* Indicates if there was a suggested change to offset_right.
*
* @var bool
*/
public $offsetRightSuggested;
/**
* Indicates if there was a suggested change to offset_top.
*
* @var bool
*/
public $offsetTopSuggested;
/**
* Indicates if there was a suggested change to angle.
*
* @param bool $angleSuggested
*/
public function setAngleSuggested($angleSuggested)
{
$this->angleSuggested = $angleSuggested;
}
/**
* @return bool
*/
public function getAngleSuggested()
{
return $this->angleSuggested;
}
/**
* Indicates if there was a suggested change to offset_bottom.
*
* @param bool $offsetBottomSuggested
*/
public function setOffsetBottomSuggested($offsetBottomSuggested)
{
$this->offsetBottomSuggested = $offsetBottomSuggested;
}
/**
* @return bool
*/
public function getOffsetBottomSuggested()
{
return $this->offsetBottomSuggested;
}
/**
* Indicates if there was a suggested change to offset_left.
*
* @param bool $offsetLeftSuggested
*/
public function setOffsetLeftSuggested($offsetLeftSuggested)
{
$this->offsetLeftSuggested = $offsetLeftSuggested;
}
/**
* @return bool
*/
public function getOffsetLeftSuggested()
{
return $this->offsetLeftSuggested;
}
/**
* Indicates if there was a suggested change to offset_right.
*
* @param bool $offsetRightSuggested
*/
public function setOffsetRightSuggested($offsetRightSuggested)
{
$this->offsetRightSuggested = $offsetRightSuggested;
}
/**
* @return bool
*/
public function getOffsetRightSuggested()
{
return $this->offsetRightSuggested;
}
/**
* Indicates if there was a suggested change to offset_top.
*
* @param bool $offsetTopSuggested
*/
public function setOffsetTopSuggested($offsetTopSuggested)
{
$this->offsetTopSuggested = $offsetTopSuggested;
}
/**
* @return bool
*/
public function getOffsetTopSuggested()
{
return $this->offsetTopSuggested;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CropPropertiesSuggestionState::class, 'Google_Service_Docs_CropPropertiesSuggestionState');
@@ -0,0 +1,177 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class DateElement extends \Google\Collection
{
protected $collection_key = 'suggestedInsertionIds';
protected $dateElementPropertiesType = DateElementProperties::class;
protected $dateElementPropertiesDataType = '';
/**
* Output only. The unique ID of this date.
*
* @var string
*/
public $dateId;
protected $suggestedDateElementPropertiesChangesType = SuggestedDateElementProperties::class;
protected $suggestedDateElementPropertiesChangesDataType = 'map';
/**
* IDs for suggestions that remove this date from the document. A DateElement
* might have multiple deletion IDs if, for example, multiple users suggest
* deleting it. If empty, then this date isn't suggested for deletion.
*
* @var string[]
*/
public $suggestedDeletionIds;
/**
* IDs for suggestions that insert this date into the document. A DateElement
* might have multiple insertion IDs if it's a nested suggested change (a
* suggestion within a suggestion made by a different user, for example). If
* empty, then this date isn't a suggested insertion.
*
* @var string[]
*/
public $suggestedInsertionIds;
protected $suggestedTextStyleChangesType = SuggestedTextStyle::class;
protected $suggestedTextStyleChangesDataType = 'map';
protected $textStyleType = TextStyle::class;
protected $textStyleDataType = '';
/**
* The properties of this DateElement.
*
* @param DateElementProperties $dateElementProperties
*/
public function setDateElementProperties(DateElementProperties $dateElementProperties)
{
$this->dateElementProperties = $dateElementProperties;
}
/**
* @return DateElementProperties
*/
public function getDateElementProperties()
{
return $this->dateElementProperties;
}
/**
* Output only. The unique ID of this date.
*
* @param string $dateId
*/
public function setDateId($dateId)
{
$this->dateId = $dateId;
}
/**
* @return string
*/
public function getDateId()
{
return $this->dateId;
}
/**
* The suggested changes to the date element properties, keyed by suggestion
* ID.
*
* @param SuggestedDateElementProperties[] $suggestedDateElementPropertiesChanges
*/
public function setSuggestedDateElementPropertiesChanges($suggestedDateElementPropertiesChanges)
{
$this->suggestedDateElementPropertiesChanges = $suggestedDateElementPropertiesChanges;
}
/**
* @return SuggestedDateElementProperties[]
*/
public function getSuggestedDateElementPropertiesChanges()
{
return $this->suggestedDateElementPropertiesChanges;
}
/**
* IDs for suggestions that remove this date from the document. A DateElement
* might have multiple deletion IDs if, for example, multiple users suggest
* deleting it. If empty, then this date isn't suggested for deletion.
*
* @param string[] $suggestedDeletionIds
*/
public function setSuggestedDeletionIds($suggestedDeletionIds)
{
$this->suggestedDeletionIds = $suggestedDeletionIds;
}
/**
* @return string[]
*/
public function getSuggestedDeletionIds()
{
return $this->suggestedDeletionIds;
}
/**
* IDs for suggestions that insert this date into the document. A DateElement
* might have multiple insertion IDs if it's a nested suggested change (a
* suggestion within a suggestion made by a different user, for example). If
* empty, then this date isn't a suggested insertion.
*
* @param string[] $suggestedInsertionIds
*/
public function setSuggestedInsertionIds($suggestedInsertionIds)
{
$this->suggestedInsertionIds = $suggestedInsertionIds;
}
/**
* @return string[]
*/
public function getSuggestedInsertionIds()
{
return $this->suggestedInsertionIds;
}
/**
* The suggested text style changes to this DateElement, keyed by suggestion
* ID.
*
* @param SuggestedTextStyle[] $suggestedTextStyleChanges
*/
public function setSuggestedTextStyleChanges($suggestedTextStyleChanges)
{
$this->suggestedTextStyleChanges = $suggestedTextStyleChanges;
}
/**
* @return SuggestedTextStyle[]
*/
public function getSuggestedTextStyleChanges()
{
return $this->suggestedTextStyleChanges;
}
/**
* The text style of this DateElement.
*
* @param TextStyle $textStyle
*/
public function setTextStyle(TextStyle $textStyle)
{
$this->textStyle = $textStyle;
}
/**
* @return TextStyle
*/
public function getTextStyle()
{
return $this->textStyle;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DateElement::class, 'Google_Service_Docs_DateElement');
@@ -0,0 +1,253 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class DateElementProperties extends \Google\Model
{
/**
* The date format is unspecified.
*/
public const DATE_FORMAT_DATE_FORMAT_UNSPECIFIED = 'DATE_FORMAT_UNSPECIFIED';
/**
* Output only. The date format is imported from an external source.
*/
public const DATE_FORMAT_DATE_FORMAT_CUSTOM = 'DATE_FORMAT_CUSTOM';
/**
* The date format is an abbreviated month followed by the day. For example,
* "Jan 1".
*/
public const DATE_FORMAT_DATE_FORMAT_MONTH_DAY_ABBREVIATED = 'DATE_FORMAT_MONTH_DAY_ABBREVIATED';
/**
* The date format is a month followed by the day. For example, "January 01".
*/
public const DATE_FORMAT_DATE_FORMAT_MONTH_DAY_FULL = 'DATE_FORMAT_MONTH_DAY_FULL';
/**
* The date format is an abbreviated month followed by the day and the year.
* For example, "Jan 1, 1970".
*/
public const DATE_FORMAT_DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED = 'DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED';
/**
* The date format is in ISO 8601 format. For example, "1970-01-01".
*/
public const DATE_FORMAT_DATE_FORMAT_ISO8601 = 'DATE_FORMAT_ISO8601';
/**
* The time format is unspecified.
*/
public const TIME_FORMAT_TIME_FORMAT_UNSPECIFIED = 'TIME_FORMAT_UNSPECIFIED';
/**
* Indicates that the date does not have a time.
*/
public const TIME_FORMAT_TIME_FORMAT_DISABLED = 'TIME_FORMAT_DISABLED';
/**
* The time format shows the hour and minute. For example, "Jan 1, 1970 12:00
* PM".
*/
public const TIME_FORMAT_TIME_FORMAT_HOUR_MINUTE = 'TIME_FORMAT_HOUR_MINUTE';
/**
* The time format shows the hour, minute, and timezone. For example, "Jan 1,
* 1970 12:00 PM UTC".
*/
public const TIME_FORMAT_TIME_FORMAT_HOUR_MINUTE_TIMEZONE = 'TIME_FORMAT_HOUR_MINUTE_TIMEZONE';
/**
* Determines how the date part of the DateElement will be displayed in the
* document. If unset, the default value is
* DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be
* formatted as `MMM d, y` in `en`, or locale specific equivalent.
*
* @var string
*/
public $dateFormat;
/**
* Output only. Indicates how the DateElement is displayed in the document.
*
* @var string
*/
public $displayText;
/**
* The language code of the DateElement. For example, `en`. If unset, the
* default locale is `en`. Limited to the following locales: `af`, `am`, `ar`,
* `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`,
* `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`,
* `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`,
* `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`,
* `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`,
* `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`,
* `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`.
*
* @var string
*/
public $locale;
/**
* Determines how the time part of the DateElement will be displayed in the
* document. If unset, the default value is TIME_FORMAT_DISABLED, indicating
* no time should be shown.
*
* @var string
*/
public $timeFormat;
/**
* The time zone of the DateElement, as defined by the Unicode Common Locale
* Data Repository (CLDR) project. For example, `America/New_York`. If unset,
* the default time zone is `etc/UTC`.
*
* @var string
*/
public $timeZoneId;
/**
* The point in time to represent, in seconds and nanoseconds since Unix
* epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC.
* If time_zone_id is set, the timestamp is adjusted according to the time
* zone. For example, a timestamp of `18000` with a date format of
* `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be
* displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format
* of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and
* time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`.
*
* @var string
*/
public $timestamp;
/**
* Determines how the date part of the DateElement will be displayed in the
* document. If unset, the default value is
* DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be
* formatted as `MMM d, y` in `en`, or locale specific equivalent.
*
* Accepted values: DATE_FORMAT_UNSPECIFIED, DATE_FORMAT_CUSTOM,
* DATE_FORMAT_MONTH_DAY_ABBREVIATED, DATE_FORMAT_MONTH_DAY_FULL,
* DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, DATE_FORMAT_ISO8601
*
* @param self::DATE_FORMAT_* $dateFormat
*/
public function setDateFormat($dateFormat)
{
$this->dateFormat = $dateFormat;
}
/**
* @return self::DATE_FORMAT_*
*/
public function getDateFormat()
{
return $this->dateFormat;
}
/**
* Output only. Indicates how the DateElement is displayed in the document.
*
* @param string $displayText
*/
public function setDisplayText($displayText)
{
$this->displayText = $displayText;
}
/**
* @return string
*/
public function getDisplayText()
{
return $this->displayText;
}
/**
* The language code of the DateElement. For example, `en`. If unset, the
* default locale is `en`. Limited to the following locales: `af`, `am`, `ar`,
* `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`,
* `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`,
* `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`,
* `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`,
* `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`,
* `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`,
* `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`.
*
* @param string $locale
*/
public function setLocale($locale)
{
$this->locale = $locale;
}
/**
* @return string
*/
public function getLocale()
{
return $this->locale;
}
/**
* Determines how the time part of the DateElement will be displayed in the
* document. If unset, the default value is TIME_FORMAT_DISABLED, indicating
* no time should be shown.
*
* Accepted values: TIME_FORMAT_UNSPECIFIED, TIME_FORMAT_DISABLED,
* TIME_FORMAT_HOUR_MINUTE, TIME_FORMAT_HOUR_MINUTE_TIMEZONE
*
* @param self::TIME_FORMAT_* $timeFormat
*/
public function setTimeFormat($timeFormat)
{
$this->timeFormat = $timeFormat;
}
/**
* @return self::TIME_FORMAT_*
*/
public function getTimeFormat()
{
return $this->timeFormat;
}
/**
* The time zone of the DateElement, as defined by the Unicode Common Locale
* Data Repository (CLDR) project. For example, `America/New_York`. If unset,
* the default time zone is `etc/UTC`.
*
* @param string $timeZoneId
*/
public function setTimeZoneId($timeZoneId)
{
$this->timeZoneId = $timeZoneId;
}
/**
* @return string
*/
public function getTimeZoneId()
{
return $this->timeZoneId;
}
/**
* The point in time to represent, in seconds and nanoseconds since Unix
* epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC.
* If time_zone_id is set, the timestamp is adjusted according to the time
* zone. For example, a timestamp of `18000` with a date format of
* `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be
* displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format
* of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and
* time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`.
*
* @param string $timestamp
*/
public function setTimestamp($timestamp)
{
$this->timestamp = $timestamp;
}
/**
* @return string
*/
public function getTimestamp()
{
return $this->timestamp;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DateElementProperties::class, 'Google_Service_Docs_DateElementProperties');
@@ -0,0 +1,136 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class DateElementPropertiesSuggestionState extends \Google\Model
{
/**
* Indicates if there was a suggested change to date_format.
*
* @var bool
*/
public $dateFormatSuggested;
/**
* Indicates if there was a suggested change to locale.
*
* @var bool
*/
public $localeSuggested;
/**
* Indicates if there was a suggested change to time_format.
*
* @var bool
*/
public $timeFormatSuggested;
/**
* Indicates if there was a suggested change to time_zone_id.
*
* @var bool
*/
public $timeZoneIdSuggested;
/**
* Indicates if there was a suggested change to timestamp.
*
* @var bool
*/
public $timestampSuggested;
/**
* Indicates if there was a suggested change to date_format.
*
* @param bool $dateFormatSuggested
*/
public function setDateFormatSuggested($dateFormatSuggested)
{
$this->dateFormatSuggested = $dateFormatSuggested;
}
/**
* @return bool
*/
public function getDateFormatSuggested()
{
return $this->dateFormatSuggested;
}
/**
* Indicates if there was a suggested change to locale.
*
* @param bool $localeSuggested
*/
public function setLocaleSuggested($localeSuggested)
{
$this->localeSuggested = $localeSuggested;
}
/**
* @return bool
*/
public function getLocaleSuggested()
{
return $this->localeSuggested;
}
/**
* Indicates if there was a suggested change to time_format.
*
* @param bool $timeFormatSuggested
*/
public function setTimeFormatSuggested($timeFormatSuggested)
{
$this->timeFormatSuggested = $timeFormatSuggested;
}
/**
* @return bool
*/
public function getTimeFormatSuggested()
{
return $this->timeFormatSuggested;
}
/**
* Indicates if there was a suggested change to time_zone_id.
*
* @param bool $timeZoneIdSuggested
*/
public function setTimeZoneIdSuggested($timeZoneIdSuggested)
{
$this->timeZoneIdSuggested = $timeZoneIdSuggested;
}
/**
* @return bool
*/
public function getTimeZoneIdSuggested()
{
return $this->timeZoneIdSuggested;
}
/**
* Indicates if there was a suggested change to timestamp.
*
* @param bool $timestampSuggested
*/
public function setTimestampSuggested($timestampSuggested)
{
$this->timestampSuggested = $timestampSuggested;
}
/**
* @return bool
*/
public function getTimestampSuggested()
{
return $this->timestampSuggested;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DateElementPropertiesSuggestionState::class, 'Google_Service_Docs_DateElementPropertiesSuggestionState');
@@ -0,0 +1,55 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class DeleteContentRangeRequest extends \Google\Model
{
protected $rangeType = Range::class;
protected $rangeDataType = '';
/**
* The range of content to delete. Deleting text that crosses a paragraph
* boundary may result in changes to paragraph styles, lists, positioned
* objects and bookmarks as the two paragraphs are merged. Attempting to
* delete certain ranges can result in an invalid document structure in which
* case a 400 bad request error is returned. Some examples of invalid delete
* requests include: * Deleting one code unit of a surrogate pair. * Deleting
* the last newline character of a Body, Header, Footer, Footnote, TableCell
* or TableOfContents. * Deleting the start or end of a Table, TableOfContents
* or Equation without deleting the entire element. * Deleting the newline
* character before a Table, TableOfContents or SectionBreak without deleting
* the element. * Deleting individual rows or cells of a table. Deleting the
* content within a table cell is allowed.
*
* @param Range $range
*/
public function setRange(Range $range)
{
$this->range = $range;
}
/**
* @return Range
*/
public function getRange()
{
return $this->range;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DeleteContentRangeRequest::class, 'Google_Service_Docs_DeleteContentRangeRequest');
@@ -0,0 +1,88 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class DeleteFooterRequest extends \Google\Model
{
/**
* The id of the footer to delete. If this footer is defined on DocumentStyle,
* the reference to this footer is removed, resulting in no footer of that
* type for the first section of the document. If this footer is defined on a
* SectionStyle, the reference to this footer is removed and the footer of
* that type is now continued from the previous section.
*
* @var string
*/
public $footerId;
/**
* The tab that contains the footer to delete. When omitted, the request is
* applied to the first tab. In a document containing a single tab: - If
* provided, must match the singular tab's ID. - If omitted, the request
* applies to the singular tab. In a document containing multiple tabs: - If
* provided, the request applies to the specified tab. - If omitted, the
* request applies to the first tab in the document.
*
* @var string
*/
public $tabId;
/**
* The id of the footer to delete. If this footer is defined on DocumentStyle,
* the reference to this footer is removed, resulting in no footer of that
* type for the first section of the document. If this footer is defined on a
* SectionStyle, the reference to this footer is removed and the footer of
* that type is now continued from the previous section.
*
* @param string $footerId
*/
public function setFooterId($footerId)
{
$this->footerId = $footerId;
}
/**
* @return string
*/
public function getFooterId()
{
return $this->footerId;
}
/**
* The tab that contains the footer to delete. When omitted, the request is
* applied to the first tab. In a document containing a single tab: - If
* provided, must match the singular tab's ID. - If omitted, the request
* applies to the singular tab. In a document containing multiple tabs: - If
* provided, the request applies to the specified tab. - If omitted, the
* request applies to the first tab in the document.
*
* @param string $tabId
*/
public function setTabId($tabId)
{
$this->tabId = $tabId;
}
/**
* @return string
*/
public function getTabId()
{
return $this->tabId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DeleteFooterRequest::class, 'Google_Service_Docs_DeleteFooterRequest');
@@ -0,0 +1,88 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class DeleteHeaderRequest extends \Google\Model
{
/**
* The id of the header to delete. If this header is defined on DocumentStyle,
* the reference to this header is removed, resulting in no header of that
* type for the first section of the document. If this header is defined on a
* SectionStyle, the reference to this header is removed and the header of
* that type is now continued from the previous section.
*
* @var string
*/
public $headerId;
/**
* The tab containing the header to delete. When omitted, the request is
* applied to the first tab. In a document containing a single tab: - If
* provided, must match the singular tab's ID. - If omitted, the request
* applies to the singular tab. In a document containing multiple tabs: - If
* provided, the request applies to the specified tab. - If omitted, the
* request applies to the first tab in the document.
*
* @var string
*/
public $tabId;
/**
* The id of the header to delete. If this header is defined on DocumentStyle,
* the reference to this header is removed, resulting in no header of that
* type for the first section of the document. If this header is defined on a
* SectionStyle, the reference to this header is removed and the header of
* that type is now continued from the previous section.
*
* @param string $headerId
*/
public function setHeaderId($headerId)
{
$this->headerId = $headerId;
}
/**
* @return string
*/
public function getHeaderId()
{
return $this->headerId;
}
/**
* The tab containing the header to delete. When omitted, the request is
* applied to the first tab. In a document containing a single tab: - If
* provided, must match the singular tab's ID. - If omitted, the request
* applies to the singular tab. In a document containing multiple tabs: - If
* provided, the request applies to the specified tab. - If omitted, the
* request applies to the first tab in the document.
*
* @param string $tabId
*/
public function setTabId($tabId)
{
$this->tabId = $tabId;
}
/**
* @return string
*/
public function getTabId()
{
return $this->tabId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DeleteHeaderRequest::class, 'Google_Service_Docs_DeleteHeaderRequest');
@@ -0,0 +1,96 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class DeleteNamedRangeRequest extends \Google\Model
{
/**
* The name of the range(s) to delete. All named ranges with the given name
* will be deleted.
*
* @var string
*/
public $name;
/**
* The ID of the named range to delete.
*
* @var string
*/
public $namedRangeId;
protected $tabsCriteriaType = TabsCriteria::class;
protected $tabsCriteriaDataType = '';
/**
* The name of the range(s) to delete. All named ranges with the given name
* will be deleted.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* The ID of the named range to delete.
*
* @param string $namedRangeId
*/
public function setNamedRangeId($namedRangeId)
{
$this->namedRangeId = $namedRangeId;
}
/**
* @return string
*/
public function getNamedRangeId()
{
return $this->namedRangeId;
}
/**
* Optional. The criteria used to specify which tab(s) the range deletion
* should occur in. When omitted, the range deletion is applied to all tabs.
* In a document containing a single tab: - If provided, must match the
* singular tab's ID. - If omitted, the range deletion applies to the singular
* tab. In a document containing multiple tabs: - If provided, the range
* deletion applies to the specified tabs. - If not provided, the range
* deletion applies to all tabs.
*
* @param TabsCriteria $tabsCriteria
*/
public function setTabsCriteria(TabsCriteria $tabsCriteria)
{
$this->tabsCriteria = $tabsCriteria;
}
/**
* @return TabsCriteria
*/
public function getTabsCriteria()
{
return $this->tabsCriteria;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DeleteNamedRangeRequest::class, 'Google_Service_Docs_DeleteNamedRangeRequest');
@@ -0,0 +1,44 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class DeleteParagraphBulletsRequest extends \Google\Model
{
protected $rangeType = Range::class;
protected $rangeDataType = '';
/**
* The range to delete bullets from.
*
* @param Range $range
*/
public function setRange(Range $range)
{
$this->range = $range;
}
/**
* @return Range
*/
public function getRange()
{
return $this->range;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DeleteParagraphBulletsRequest::class, 'Google_Service_Docs_DeleteParagraphBulletsRequest');
@@ -0,0 +1,80 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class DeletePositionedObjectRequest extends \Google\Model
{
/**
* The ID of the positioned object to delete.
*
* @var string
*/
public $objectId;
/**
* The tab that the positioned object to delete is in. When omitted, the
* request is applied to the first tab. In a document containing a single tab:
* - If provided, must match the singular tab's ID. - If omitted, the request
* applies to the singular tab. In a document containing multiple tabs: - If
* provided, the request applies to the specified tab. - If omitted, the
* request applies to the first tab in the document.
*
* @var string
*/
public $tabId;
/**
* The ID of the positioned object to delete.
*
* @param string $objectId
*/
public function setObjectId($objectId)
{
$this->objectId = $objectId;
}
/**
* @return string
*/
public function getObjectId()
{
return $this->objectId;
}
/**
* The tab that the positioned object to delete is in. When omitted, the
* request is applied to the first tab. In a document containing a single tab:
* - If provided, must match the singular tab's ID. - If omitted, the request
* applies to the singular tab. In a document containing multiple tabs: - If
* provided, the request applies to the specified tab. - If omitted, the
* request applies to the first tab in the document.
*
* @param string $tabId
*/
public function setTabId($tabId)
{
$this->tabId = $tabId;
}
/**
* @return string
*/
public function getTabId()
{
return $this->tabId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DeletePositionedObjectRequest::class, 'Google_Service_Docs_DeletePositionedObjectRequest');
@@ -0,0 +1,48 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class DeleteTabRequest extends \Google\Model
{
/**
* The ID of the tab to delete.
*
* @var string
*/
public $tabId;
/**
* The ID of the tab to delete.
*
* @param string $tabId
*/
public function setTabId($tabId)
{
$this->tabId = $tabId;
}
/**
* @return string
*/
public function getTabId()
{
return $this->tabId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DeleteTabRequest::class, 'Google_Service_Docs_DeleteTabRequest');
@@ -0,0 +1,48 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class DeleteTableColumnRequest extends \Google\Model
{
protected $tableCellLocationType = TableCellLocation::class;
protected $tableCellLocationDataType = '';
/**
* The reference table cell location from which the column will be deleted.
* The column this cell spans will be deleted. If this is a merged cell that
* spans multiple columns, all columns that the cell spans will be deleted. If
* no columns remain in the table after this deletion, the whole table is
* deleted.
*
* @param TableCellLocation $tableCellLocation
*/
public function setTableCellLocation(TableCellLocation $tableCellLocation)
{
$this->tableCellLocation = $tableCellLocation;
}
/**
* @return TableCellLocation
*/
public function getTableCellLocation()
{
return $this->tableCellLocation;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DeleteTableColumnRequest::class, 'Google_Service_Docs_DeleteTableColumnRequest');
@@ -0,0 +1,47 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class DeleteTableRowRequest extends \Google\Model
{
protected $tableCellLocationType = TableCellLocation::class;
protected $tableCellLocationDataType = '';
/**
* The reference table cell location from which the row will be deleted. The
* row this cell spans will be deleted. If this is a merged cell that spans
* multiple rows, all rows that the cell spans will be deleted. If no rows
* remain in the table after this deletion, the whole table is deleted.
*
* @param TableCellLocation $tableCellLocation
*/
public function setTableCellLocation(TableCellLocation $tableCellLocation)
{
$this->tableCellLocation = $tableCellLocation;
}
/**
* @return TableCellLocation
*/
public function getTableCellLocation()
{
return $this->tableCellLocation;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DeleteTableRowRequest::class, 'Google_Service_Docs_DeleteTableRowRequest');
+72
View File
@@ -0,0 +1,72 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class Dimension extends \Google\Model
{
/**
* The units are unknown.
*/
public const UNIT_UNIT_UNSPECIFIED = 'UNIT_UNSPECIFIED';
/**
* A point, 1/72 of an inch.
*/
public const UNIT_PT = 'PT';
/**
* The magnitude.
*
* @var
*/
public $magnitude;
/**
* The units for magnitude.
*
* @var string
*/
public $unit;
public function setMagnitude($magnitude)
{
$this->magnitude = $magnitude;
}
public function getMagnitude()
{
return $this->magnitude;
}
/**
* The units for magnitude.
*
* Accepted values: UNIT_UNSPECIFIED, PT
*
* @param self::UNIT_* $unit
*/
public function setUnit($unit)
{
$this->unit = $unit;
}
/**
* @return self::UNIT_*
*/
public function getUnit()
{
return $this->unit;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Dimension::class, 'Google_Service_Docs_Dimension');
+111
View File
@@ -0,0 +1,111 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class DocsList extends \Google\Collection
{
protected $collection_key = 'suggestedDeletionIds';
protected $listPropertiesType = ListProperties::class;
protected $listPropertiesDataType = '';
/**
* The suggested deletion IDs. If empty, then there are no suggested deletions
* of this list.
*
* @var string[]
*/
public $suggestedDeletionIds;
/**
* The suggested insertion ID. If empty, then this is not a suggested
* insertion.
*
* @var string
*/
public $suggestedInsertionId;
protected $suggestedListPropertiesChangesType = SuggestedListProperties::class;
protected $suggestedListPropertiesChangesDataType = 'map';
/**
* The properties of the list.
*
* @param ListProperties $listProperties
*/
public function setListProperties(ListProperties $listProperties)
{
$this->listProperties = $listProperties;
}
/**
* @return ListProperties
*/
public function getListProperties()
{
return $this->listProperties;
}
/**
* The suggested deletion IDs. If empty, then there are no suggested deletions
* of this list.
*
* @param string[] $suggestedDeletionIds
*/
public function setSuggestedDeletionIds($suggestedDeletionIds)
{
$this->suggestedDeletionIds = $suggestedDeletionIds;
}
/**
* @return string[]
*/
public function getSuggestedDeletionIds()
{
return $this->suggestedDeletionIds;
}
/**
* The suggested insertion ID. If empty, then this is not a suggested
* insertion.
*
* @param string $suggestedInsertionId
*/
public function setSuggestedInsertionId($suggestedInsertionId)
{
$this->suggestedInsertionId = $suggestedInsertionId;
}
/**
* @return string
*/
public function getSuggestedInsertionId()
{
return $this->suggestedInsertionId;
}
/**
* The suggested changes to the list properties, keyed by suggestion ID.
*
* @param SuggestedListProperties[] $suggestedListPropertiesChanges
*/
public function setSuggestedListPropertiesChanges($suggestedListPropertiesChanges)
{
$this->suggestedListPropertiesChanges = $suggestedListPropertiesChanges;
}
/**
* @return SuggestedListProperties[]
*/
public function getSuggestedListPropertiesChanges()
{
return $this->suggestedListPropertiesChanges;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DocsList::class, 'Google_Service_Docs_DocsList');
+452
View File
@@ -0,0 +1,452 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class Document extends \Google\Collection
{
/**
* The SuggestionsViewMode applied to the returned document depends on the
* user's current access level. If the user only has view access,
* PREVIEW_WITHOUT_SUGGESTIONS is applied. Otherwise, SUGGESTIONS_INLINE is
* applied. This is the default suggestions view mode.
*/
public const SUGGESTIONS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS = 'DEFAULT_FOR_CURRENT_ACCESS';
/**
* The returned document has suggestions inline. Suggested changes will be
* differentiated from base content within the document. Requests to retrieve
* a document using this mode will return a 403 error if the user does not
* have permission to view suggested changes.
*/
public const SUGGESTIONS_VIEW_MODE_SUGGESTIONS_INLINE = 'SUGGESTIONS_INLINE';
/**
* The returned document is a preview with all suggested changes accepted.
* Requests to retrieve a document using this mode will return a 403 error if
* the user does not have permission to view suggested changes.
*/
public const SUGGESTIONS_VIEW_MODE_PREVIEW_SUGGESTIONS_ACCEPTED = 'PREVIEW_SUGGESTIONS_ACCEPTED';
/**
* The returned document is a preview with all suggested changes rejected if
* there are any suggestions in the document.
*/
public const SUGGESTIONS_VIEW_MODE_PREVIEW_WITHOUT_SUGGESTIONS = 'PREVIEW_WITHOUT_SUGGESTIONS';
protected $collection_key = 'tabs';
protected $bodyType = Body::class;
protected $bodyDataType = '';
/**
* Output only. The ID of the document.
*
* @var string
*/
public $documentId;
protected $documentStyleType = DocumentStyle::class;
protected $documentStyleDataType = '';
protected $footersType = Footer::class;
protected $footersDataType = 'map';
protected $footnotesType = Footnote::class;
protected $footnotesDataType = 'map';
protected $headersType = Header::class;
protected $headersDataType = 'map';
protected $inlineObjectsType = InlineObject::class;
protected $inlineObjectsDataType = 'map';
protected $listsType = DocsList::class;
protected $listsDataType = 'map';
protected $namedRangesType = NamedRanges::class;
protected $namedRangesDataType = 'map';
protected $namedStylesType = NamedStyles::class;
protected $namedStylesDataType = '';
protected $positionedObjectsType = PositionedObject::class;
protected $positionedObjectsDataType = 'map';
/**
* Output only. The revision ID of the document. Can be used in update
* requests to specify which revision of a document to apply updates to and
* how the request should behave if the document has been edited since that
* revision. Only populated if the user has edit access to the document. The
* revision ID is not a sequential number but an opaque string. The format of
* the revision ID might change over time. A returned revision ID is only
* guaranteed to be valid for 24 hours after it has been returned and cannot
* be shared across users. If the revision ID is unchanged between calls, then
* the document has not changed. Conversely, a changed ID (for the same
* document and user) usually means the document has been updated. However, a
* changed ID can also be due to internal factors such as ID format changes.
*
* @var string
*/
public $revisionId;
protected $suggestedDocumentStyleChangesType = SuggestedDocumentStyle::class;
protected $suggestedDocumentStyleChangesDataType = 'map';
protected $suggestedNamedStylesChangesType = SuggestedNamedStyles::class;
protected $suggestedNamedStylesChangesDataType = 'map';
/**
* Output only. The suggestions view mode applied to the document. Note: When
* editing a document, changes must be based on a document with
* SUGGESTIONS_INLINE.
*
* @var string
*/
public $suggestionsViewMode;
protected $tabsType = Tab::class;
protected $tabsDataType = 'array';
/**
* The title of the document.
*
* @var string
*/
public $title;
/**
* Output only. The main body of the document. Legacy field: Instead, use
* Document.tabs.documentTab.body, which exposes the actual document content
* from all tabs when the includeTabsContent parameter is set to `true`. If
* `false` or unset, this field contains information about the first tab in
* the document.
*
* @param Body $body
*/
public function setBody(Body $body)
{
$this->body = $body;
}
/**
* @return Body
*/
public function getBody()
{
return $this->body;
}
/**
* Output only. The ID of the document.
*
* @param string $documentId
*/
public function setDocumentId($documentId)
{
$this->documentId = $documentId;
}
/**
* @return string
*/
public function getDocumentId()
{
return $this->documentId;
}
/**
* Output only. The style of the document. Legacy field: Instead, use
* Document.tabs.documentTab.documentStyle, which exposes the actual document
* content from all tabs when the includeTabsContent parameter is set to
* `true`. If `false` or unset, this field contains information about the
* first tab in the document.
*
* @param DocumentStyle $documentStyle
*/
public function setDocumentStyle(DocumentStyle $documentStyle)
{
$this->documentStyle = $documentStyle;
}
/**
* @return DocumentStyle
*/
public function getDocumentStyle()
{
return $this->documentStyle;
}
/**
* Output only. The footers in the document, keyed by footer ID. Legacy field:
* Instead, use Document.tabs.documentTab.footers, which exposes the actual
* document content from all tabs when the includeTabsContent parameter is set
* to `true`. If `false` or unset, this field contains information about the
* first tab in the document.
*
* @param Footer[] $footers
*/
public function setFooters($footers)
{
$this->footers = $footers;
}
/**
* @return Footer[]
*/
public function getFooters()
{
return $this->footers;
}
/**
* Output only. The footnotes in the document, keyed by footnote ID. Legacy
* field: Instead, use Document.tabs.documentTab.footnotes, which exposes the
* actual document content from all tabs when the includeTabsContent parameter
* is set to `true`. If `false` or unset, this field contains information
* about the first tab in the document.
*
* @param Footnote[] $footnotes
*/
public function setFootnotes($footnotes)
{
$this->footnotes = $footnotes;
}
/**
* @return Footnote[]
*/
public function getFootnotes()
{
return $this->footnotes;
}
/**
* Output only. The headers in the document, keyed by header ID. Legacy field:
* Instead, use Document.tabs.documentTab.headers, which exposes the actual
* document content from all tabs when the includeTabsContent parameter is set
* to `true`. If `false` or unset, this field contains information about the
* first tab in the document.
*
* @param Header[] $headers
*/
public function setHeaders($headers)
{
$this->headers = $headers;
}
/**
* @return Header[]
*/
public function getHeaders()
{
return $this->headers;
}
/**
* Output only. The inline objects in the document, keyed by object ID. Legacy
* field: Instead, use Document.tabs.documentTab.inlineObjects, which exposes
* the actual document content from all tabs when the includeTabsContent
* parameter is set to `true`. If `false` or unset, this field contains
* information about the first tab in the document.
*
* @param InlineObject[] $inlineObjects
*/
public function setInlineObjects($inlineObjects)
{
$this->inlineObjects = $inlineObjects;
}
/**
* @return InlineObject[]
*/
public function getInlineObjects()
{
return $this->inlineObjects;
}
/**
* Output only. The lists in the document, keyed by list ID. Legacy field:
* Instead, use Document.tabs.documentTab.lists, which exposes the actual
* document content from all tabs when the includeTabsContent parameter is set
* to `true`. If `false` or unset, this field contains information about the
* first tab in the document.
*
* @param DocsList[] $lists
*/
public function setLists($lists)
{
$this->lists = $lists;
}
/**
* @return DocsList[]
*/
public function getLists()
{
return $this->lists;
}
/**
* Output only. The named ranges in the document, keyed by name. Legacy field:
* Instead, use Document.tabs.documentTab.namedRanges, which exposes the
* actual document content from all tabs when the includeTabsContent parameter
* is set to `true`. If `false` or unset, this field contains information
* about the first tab in the document.
*
* @param NamedRanges[] $namedRanges
*/
public function setNamedRanges($namedRanges)
{
$this->namedRanges = $namedRanges;
}
/**
* @return NamedRanges[]
*/
public function getNamedRanges()
{
return $this->namedRanges;
}
/**
* Output only. The named styles of the document. Legacy field: Instead, use
* Document.tabs.documentTab.namedStyles, which exposes the actual document
* content from all tabs when the includeTabsContent parameter is set to
* `true`. If `false` or unset, this field contains information about the
* first tab in the document.
*
* @param NamedStyles $namedStyles
*/
public function setNamedStyles(NamedStyles $namedStyles)
{
$this->namedStyles = $namedStyles;
}
/**
* @return NamedStyles
*/
public function getNamedStyles()
{
return $this->namedStyles;
}
/**
* Output only. The positioned objects in the document, keyed by object ID.
* Legacy field: Instead, use Document.tabs.documentTab.positionedObjects,
* which exposes the actual document content from all tabs when the
* includeTabsContent parameter is set to `true`. If `false` or unset, this
* field contains information about the first tab in the document.
*
* @param PositionedObject[] $positionedObjects
*/
public function setPositionedObjects($positionedObjects)
{
$this->positionedObjects = $positionedObjects;
}
/**
* @return PositionedObject[]
*/
public function getPositionedObjects()
{
return $this->positionedObjects;
}
/**
* Output only. The revision ID of the document. Can be used in update
* requests to specify which revision of a document to apply updates to and
* how the request should behave if the document has been edited since that
* revision. Only populated if the user has edit access to the document. The
* revision ID is not a sequential number but an opaque string. The format of
* the revision ID might change over time. A returned revision ID is only
* guaranteed to be valid for 24 hours after it has been returned and cannot
* be shared across users. If the revision ID is unchanged between calls, then
* the document has not changed. Conversely, a changed ID (for the same
* document and user) usually means the document has been updated. However, a
* changed ID can also be due to internal factors such as ID format changes.
*
* @param string $revisionId
*/
public function setRevisionId($revisionId)
{
$this->revisionId = $revisionId;
}
/**
* @return string
*/
public function getRevisionId()
{
return $this->revisionId;
}
/**
* Output only. The suggested changes to the style of the document, keyed by
* suggestion ID. Legacy field: Instead, use
* Document.tabs.documentTab.suggestedDocumentStyleChanges, which exposes the
* actual document content from all tabs when the includeTabsContent parameter
* is set to `true`. If `false` or unset, this field contains information
* about the first tab in the document.
*
* @param SuggestedDocumentStyle[] $suggestedDocumentStyleChanges
*/
public function setSuggestedDocumentStyleChanges($suggestedDocumentStyleChanges)
{
$this->suggestedDocumentStyleChanges = $suggestedDocumentStyleChanges;
}
/**
* @return SuggestedDocumentStyle[]
*/
public function getSuggestedDocumentStyleChanges()
{
return $this->suggestedDocumentStyleChanges;
}
/**
* Output only. The suggested changes to the named styles of the document,
* keyed by suggestion ID. Legacy field: Instead, use
* Document.tabs.documentTab.suggestedNamedStylesChanges, which exposes the
* actual document content from all tabs when the includeTabsContent parameter
* is set to `true`. If `false` or unset, this field contains information
* about the first tab in the document.
*
* @param SuggestedNamedStyles[] $suggestedNamedStylesChanges
*/
public function setSuggestedNamedStylesChanges($suggestedNamedStylesChanges)
{
$this->suggestedNamedStylesChanges = $suggestedNamedStylesChanges;
}
/**
* @return SuggestedNamedStyles[]
*/
public function getSuggestedNamedStylesChanges()
{
return $this->suggestedNamedStylesChanges;
}
/**
* Output only. The suggestions view mode applied to the document. Note: When
* editing a document, changes must be based on a document with
* SUGGESTIONS_INLINE.
*
* Accepted values: DEFAULT_FOR_CURRENT_ACCESS, SUGGESTIONS_INLINE,
* PREVIEW_SUGGESTIONS_ACCEPTED, PREVIEW_WITHOUT_SUGGESTIONS
*
* @param self::SUGGESTIONS_VIEW_MODE_* $suggestionsViewMode
*/
public function setSuggestionsViewMode($suggestionsViewMode)
{
$this->suggestionsViewMode = $suggestionsViewMode;
}
/**
* @return self::SUGGESTIONS_VIEW_MODE_*
*/
public function getSuggestionsViewMode()
{
return $this->suggestionsViewMode;
}
/**
* Tabs that are part of a document. Tabs can contain child tabs, a tab nested
* within another tab. Child tabs are represented by the Tab.childTabs field.
*
* @param Tab[] $tabs
*/
public function setTabs($tabs)
{
$this->tabs = $tabs;
}
/**
* @return Tab[]
*/
public function getTabs()
{
return $this->tabs;
}
/**
* The title of the document.
*
* @param string $title
*/
public function setTitle($title)
{
$this->title = $title;
}
/**
* @return string
*/
public function getTitle()
{
return $this->title;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Document::class, 'Google_Service_Docs_Document');
@@ -0,0 +1,62 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class DocumentFormat extends \Google\Model
{
/**
* The document mode is unspecified.
*/
public const DOCUMENT_MODE_DOCUMENT_MODE_UNSPECIFIED = 'DOCUMENT_MODE_UNSPECIFIED';
/**
* The document has pages.
*/
public const DOCUMENT_MODE_PAGES = 'PAGES';
/**
* The document is pageless.
*/
public const DOCUMENT_MODE_PAGELESS = 'PAGELESS';
/**
* Whether the document has pages or is pageless.
*
* @var string
*/
public $documentMode;
/**
* Whether the document has pages or is pageless.
*
* Accepted values: DOCUMENT_MODE_UNSPECIFIED, PAGES, PAGELESS
*
* @param self::DOCUMENT_MODE_* $documentMode
*/
public function setDocumentMode($documentMode)
{
$this->documentMode = $documentMode;
}
/**
* @return self::DOCUMENT_MODE_*
*/
public function getDocumentMode()
{
return $this->documentMode;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DocumentFormat::class, 'Google_Service_Docs_DocumentFormat');
@@ -0,0 +1,507 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class DocumentStyle extends \Google\Model
{
protected $backgroundType = Background::class;
protected $backgroundDataType = '';
/**
* The ID of the default footer. If not set, there's no default footer. If
* DocumentMode is PAGELESS, this property will not be rendered. This property
* is read-only.
*
* @var string
*/
public $defaultFooterId;
/**
* The ID of the default header. If not set, there's no default header. If
* DocumentMode is PAGELESS, this property will not be rendered. This property
* is read-only.
*
* @var string
*/
public $defaultHeaderId;
protected $documentFormatType = DocumentFormat::class;
protected $documentFormatDataType = '';
/**
* The ID of the footer used only for even pages. The value of
* use_even_page_header_footer determines whether to use the default_footer_id
* or this value for the footer on even pages. If not set, there's no even
* page footer. If DocumentMode is PAGELESS, this property will not be
* rendered. This property is read-only.
*
* @var string
*/
public $evenPageFooterId;
/**
* The ID of the header used only for even pages. The value of
* use_even_page_header_footer determines whether to use the default_header_id
* or this value for the header on even pages. If not set, there's no even
* page header. If DocumentMode is PAGELESS, this property will not be
* rendered. This property is read-only.
*
* @var string
*/
public $evenPageHeaderId;
/**
* The ID of the footer used only for the first page. If not set then a unique
* footer for the first page does not exist. The value of
* use_first_page_header_footer determines whether to use the
* default_footer_id or this value for the footer on the first page. If not
* set, there's no first page footer. If DocumentMode is PAGELESS, this
* property will not be rendered. This property is read-only.
*
* @var string
*/
public $firstPageFooterId;
/**
* The ID of the header used only for the first page. If not set then a unique
* header for the first page does not exist. The value of
* use_first_page_header_footer determines whether to use the
* default_header_id or this value for the header on the first page. If not
* set, there's no first page header. If DocumentMode is PAGELESS, this
* property will not be rendered. This property is read-only.
*
* @var string
*/
public $firstPageHeaderId;
/**
* Optional. Indicates whether to flip the dimensions of the page_size, which
* allows changing the page orientation between portrait and landscape. If
* DocumentMode is PAGELESS, this property will not be rendered.
*
* @var bool
*/
public $flipPageOrientation;
protected $marginBottomType = Dimension::class;
protected $marginBottomDataType = '';
protected $marginFooterType = Dimension::class;
protected $marginFooterDataType = '';
protected $marginHeaderType = Dimension::class;
protected $marginHeaderDataType = '';
protected $marginLeftType = Dimension::class;
protected $marginLeftDataType = '';
protected $marginRightType = Dimension::class;
protected $marginRightDataType = '';
protected $marginTopType = Dimension::class;
protected $marginTopDataType = '';
/**
* The page number from which to start counting the number of pages. If
* DocumentMode is PAGELESS, this property will not be rendered.
*
* @var int
*/
public $pageNumberStart;
protected $pageSizeType = Size::class;
protected $pageSizeDataType = '';
/**
* Indicates whether DocumentStyle margin_header, SectionStyle margin_header
* and DocumentStyle margin_footer, SectionStyle margin_footer are respected.
* When false, the default values in the Docs editor for header and footer
* margin is used. If DocumentMode is PAGELESS, this property will not be
* rendered. This property is read-only.
*
* @var bool
*/
public $useCustomHeaderFooterMargins;
/**
* Indicates whether to use the even page header / footer IDs for the even
* pages. If DocumentMode is PAGELESS, this property will not be rendered.
*
* @var bool
*/
public $useEvenPageHeaderFooter;
/**
* Indicates whether to use the first page header / footer IDs for the first
* page. If DocumentMode is PAGELESS, this property will not be rendered.
*
* @var bool
*/
public $useFirstPageHeaderFooter;
/**
* The background of the document. Documents cannot have a transparent
* background color.
*
* @param Background $background
*/
public function setBackground(Background $background)
{
$this->background = $background;
}
/**
* @return Background
*/
public function getBackground()
{
return $this->background;
}
/**
* The ID of the default footer. If not set, there's no default footer. If
* DocumentMode is PAGELESS, this property will not be rendered. This property
* is read-only.
*
* @param string $defaultFooterId
*/
public function setDefaultFooterId($defaultFooterId)
{
$this->defaultFooterId = $defaultFooterId;
}
/**
* @return string
*/
public function getDefaultFooterId()
{
return $this->defaultFooterId;
}
/**
* The ID of the default header. If not set, there's no default header. If
* DocumentMode is PAGELESS, this property will not be rendered. This property
* is read-only.
*
* @param string $defaultHeaderId
*/
public function setDefaultHeaderId($defaultHeaderId)
{
$this->defaultHeaderId = $defaultHeaderId;
}
/**
* @return string
*/
public function getDefaultHeaderId()
{
return $this->defaultHeaderId;
}
/**
* Specifies document-level format settings, such as the document mode (pages
* vs pageless).
*
* @param DocumentFormat $documentFormat
*/
public function setDocumentFormat(DocumentFormat $documentFormat)
{
$this->documentFormat = $documentFormat;
}
/**
* @return DocumentFormat
*/
public function getDocumentFormat()
{
return $this->documentFormat;
}
/**
* The ID of the footer used only for even pages. The value of
* use_even_page_header_footer determines whether to use the default_footer_id
* or this value for the footer on even pages. If not set, there's no even
* page footer. If DocumentMode is PAGELESS, this property will not be
* rendered. This property is read-only.
*
* @param string $evenPageFooterId
*/
public function setEvenPageFooterId($evenPageFooterId)
{
$this->evenPageFooterId = $evenPageFooterId;
}
/**
* @return string
*/
public function getEvenPageFooterId()
{
return $this->evenPageFooterId;
}
/**
* The ID of the header used only for even pages. The value of
* use_even_page_header_footer determines whether to use the default_header_id
* or this value for the header on even pages. If not set, there's no even
* page header. If DocumentMode is PAGELESS, this property will not be
* rendered. This property is read-only.
*
* @param string $evenPageHeaderId
*/
public function setEvenPageHeaderId($evenPageHeaderId)
{
$this->evenPageHeaderId = $evenPageHeaderId;
}
/**
* @return string
*/
public function getEvenPageHeaderId()
{
return $this->evenPageHeaderId;
}
/**
* The ID of the footer used only for the first page. If not set then a unique
* footer for the first page does not exist. The value of
* use_first_page_header_footer determines whether to use the
* default_footer_id or this value for the footer on the first page. If not
* set, there's no first page footer. If DocumentMode is PAGELESS, this
* property will not be rendered. This property is read-only.
*
* @param string $firstPageFooterId
*/
public function setFirstPageFooterId($firstPageFooterId)
{
$this->firstPageFooterId = $firstPageFooterId;
}
/**
* @return string
*/
public function getFirstPageFooterId()
{
return $this->firstPageFooterId;
}
/**
* The ID of the header used only for the first page. If not set then a unique
* header for the first page does not exist. The value of
* use_first_page_header_footer determines whether to use the
* default_header_id or this value for the header on the first page. If not
* set, there's no first page header. If DocumentMode is PAGELESS, this
* property will not be rendered. This property is read-only.
*
* @param string $firstPageHeaderId
*/
public function setFirstPageHeaderId($firstPageHeaderId)
{
$this->firstPageHeaderId = $firstPageHeaderId;
}
/**
* @return string
*/
public function getFirstPageHeaderId()
{
return $this->firstPageHeaderId;
}
/**
* Optional. Indicates whether to flip the dimensions of the page_size, which
* allows changing the page orientation between portrait and landscape. If
* DocumentMode is PAGELESS, this property will not be rendered.
*
* @param bool $flipPageOrientation
*/
public function setFlipPageOrientation($flipPageOrientation)
{
$this->flipPageOrientation = $flipPageOrientation;
}
/**
* @return bool
*/
public function getFlipPageOrientation()
{
return $this->flipPageOrientation;
}
/**
* The bottom page margin. Updating the bottom page margin on the document
* style clears the bottom page margin on all section styles. If DocumentMode
* is PAGELESS, this property will not be rendered.
*
* @param Dimension $marginBottom
*/
public function setMarginBottom(Dimension $marginBottom)
{
$this->marginBottom = $marginBottom;
}
/**
* @return Dimension
*/
public function getMarginBottom()
{
return $this->marginBottom;
}
/**
* The amount of space between the bottom of the page and the contents of the
* footer. If DocumentMode is PAGELESS, this property will not be rendered.
*
* @param Dimension $marginFooter
*/
public function setMarginFooter(Dimension $marginFooter)
{
$this->marginFooter = $marginFooter;
}
/**
* @return Dimension
*/
public function getMarginFooter()
{
return $this->marginFooter;
}
/**
* The amount of space between the top of the page and the contents of the
* header. If DocumentMode is PAGELESS, this property will not be rendered.
*
* @param Dimension $marginHeader
*/
public function setMarginHeader(Dimension $marginHeader)
{
$this->marginHeader = $marginHeader;
}
/**
* @return Dimension
*/
public function getMarginHeader()
{
return $this->marginHeader;
}
/**
* The left page margin. Updating the left page margin on the document style
* clears the left page margin on all section styles. It may also cause
* columns to resize in all sections. If DocumentMode is PAGELESS, this
* property will not be rendered.
*
* @param Dimension $marginLeft
*/
public function setMarginLeft(Dimension $marginLeft)
{
$this->marginLeft = $marginLeft;
}
/**
* @return Dimension
*/
public function getMarginLeft()
{
return $this->marginLeft;
}
/**
* The right page margin. Updating the right page margin on the document style
* clears the right page margin on all section styles. It may also cause
* columns to resize in all sections. If DocumentMode is PAGELESS, this
* property will not be rendered.
*
* @param Dimension $marginRight
*/
public function setMarginRight(Dimension $marginRight)
{
$this->marginRight = $marginRight;
}
/**
* @return Dimension
*/
public function getMarginRight()
{
return $this->marginRight;
}
/**
* The top page margin. Updating the top page margin on the document style
* clears the top page margin on all section styles. If DocumentMode is
* PAGELESS, this property will not be rendered.
*
* @param Dimension $marginTop
*/
public function setMarginTop(Dimension $marginTop)
{
$this->marginTop = $marginTop;
}
/**
* @return Dimension
*/
public function getMarginTop()
{
return $this->marginTop;
}
/**
* The page number from which to start counting the number of pages. If
* DocumentMode is PAGELESS, this property will not be rendered.
*
* @param int $pageNumberStart
*/
public function setPageNumberStart($pageNumberStart)
{
$this->pageNumberStart = $pageNumberStart;
}
/**
* @return int
*/
public function getPageNumberStart()
{
return $this->pageNumberStart;
}
/**
* The size of a page in the document. If DocumentMode is PAGELESS, this
* property will not be rendered.
*
* @param Size $pageSize
*/
public function setPageSize(Size $pageSize)
{
$this->pageSize = $pageSize;
}
/**
* @return Size
*/
public function getPageSize()
{
return $this->pageSize;
}
/**
* Indicates whether DocumentStyle margin_header, SectionStyle margin_header
* and DocumentStyle margin_footer, SectionStyle margin_footer are respected.
* When false, the default values in the Docs editor for header and footer
* margin is used. If DocumentMode is PAGELESS, this property will not be
* rendered. This property is read-only.
*
* @param bool $useCustomHeaderFooterMargins
*/
public function setUseCustomHeaderFooterMargins($useCustomHeaderFooterMargins)
{
$this->useCustomHeaderFooterMargins = $useCustomHeaderFooterMargins;
}
/**
* @return bool
*/
public function getUseCustomHeaderFooterMargins()
{
return $this->useCustomHeaderFooterMargins;
}
/**
* Indicates whether to use the even page header / footer IDs for the even
* pages. If DocumentMode is PAGELESS, this property will not be rendered.
*
* @param bool $useEvenPageHeaderFooter
*/
public function setUseEvenPageHeaderFooter($useEvenPageHeaderFooter)
{
$this->useEvenPageHeaderFooter = $useEvenPageHeaderFooter;
}
/**
* @return bool
*/
public function getUseEvenPageHeaderFooter()
{
return $this->useEvenPageHeaderFooter;
}
/**
* Indicates whether to use the first page header / footer IDs for the first
* page. If DocumentMode is PAGELESS, this property will not be rendered.
*
* @param bool $useFirstPageHeaderFooter
*/
public function setUseFirstPageHeaderFooter($useFirstPageHeaderFooter)
{
$this->useFirstPageHeaderFooter = $useFirstPageHeaderFooter;
}
/**
* @return bool
*/
public function getUseFirstPageHeaderFooter()
{
return $this->useFirstPageHeaderFooter;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DocumentStyle::class, 'Google_Service_Docs_DocumentStyle');
@@ -0,0 +1,442 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class DocumentStyleSuggestionState extends \Google\Model
{
protected $backgroundSuggestionStateType = BackgroundSuggestionState::class;
protected $backgroundSuggestionStateDataType = '';
/**
* Indicates if there was a suggested change to default_footer_id.
*
* @var bool
*/
public $defaultFooterIdSuggested;
/**
* Indicates if there was a suggested change to default_header_id.
*
* @var bool
*/
public $defaultHeaderIdSuggested;
/**
* Indicates if there was a suggested change to even_page_footer_id.
*
* @var bool
*/
public $evenPageFooterIdSuggested;
/**
* Indicates if there was a suggested change to even_page_header_id.
*
* @var bool
*/
public $evenPageHeaderIdSuggested;
/**
* Indicates if there was a suggested change to first_page_footer_id.
*
* @var bool
*/
public $firstPageFooterIdSuggested;
/**
* Indicates if there was a suggested change to first_page_header_id.
*
* @var bool
*/
public $firstPageHeaderIdSuggested;
/**
* Optional. Indicates if there was a suggested change to
* flip_page_orientation.
*
* @var bool
*/
public $flipPageOrientationSuggested;
/**
* Indicates if there was a suggested change to margin_bottom.
*
* @var bool
*/
public $marginBottomSuggested;
/**
* Indicates if there was a suggested change to margin_footer.
*
* @var bool
*/
public $marginFooterSuggested;
/**
* Indicates if there was a suggested change to margin_header.
*
* @var bool
*/
public $marginHeaderSuggested;
/**
* Indicates if there was a suggested change to margin_left.
*
* @var bool
*/
public $marginLeftSuggested;
/**
* Indicates if there was a suggested change to margin_right.
*
* @var bool
*/
public $marginRightSuggested;
/**
* Indicates if there was a suggested change to margin_top.
*
* @var bool
*/
public $marginTopSuggested;
/**
* Indicates if there was a suggested change to page_number_start.
*
* @var bool
*/
public $pageNumberStartSuggested;
protected $pageSizeSuggestionStateType = SizeSuggestionState::class;
protected $pageSizeSuggestionStateDataType = '';
/**
* Indicates if there was a suggested change to
* use_custom_header_footer_margins.
*
* @var bool
*/
public $useCustomHeaderFooterMarginsSuggested;
/**
* Indicates if there was a suggested change to use_even_page_header_footer.
*
* @var bool
*/
public $useEvenPageHeaderFooterSuggested;
/**
* Indicates if there was a suggested change to use_first_page_header_footer.
*
* @var bool
*/
public $useFirstPageHeaderFooterSuggested;
/**
* A mask that indicates which of the fields in background have been changed
* in this suggestion.
*
* @param BackgroundSuggestionState $backgroundSuggestionState
*/
public function setBackgroundSuggestionState(BackgroundSuggestionState $backgroundSuggestionState)
{
$this->backgroundSuggestionState = $backgroundSuggestionState;
}
/**
* @return BackgroundSuggestionState
*/
public function getBackgroundSuggestionState()
{
return $this->backgroundSuggestionState;
}
/**
* Indicates if there was a suggested change to default_footer_id.
*
* @param bool $defaultFooterIdSuggested
*/
public function setDefaultFooterIdSuggested($defaultFooterIdSuggested)
{
$this->defaultFooterIdSuggested = $defaultFooterIdSuggested;
}
/**
* @return bool
*/
public function getDefaultFooterIdSuggested()
{
return $this->defaultFooterIdSuggested;
}
/**
* Indicates if there was a suggested change to default_header_id.
*
* @param bool $defaultHeaderIdSuggested
*/
public function setDefaultHeaderIdSuggested($defaultHeaderIdSuggested)
{
$this->defaultHeaderIdSuggested = $defaultHeaderIdSuggested;
}
/**
* @return bool
*/
public function getDefaultHeaderIdSuggested()
{
return $this->defaultHeaderIdSuggested;
}
/**
* Indicates if there was a suggested change to even_page_footer_id.
*
* @param bool $evenPageFooterIdSuggested
*/
public function setEvenPageFooterIdSuggested($evenPageFooterIdSuggested)
{
$this->evenPageFooterIdSuggested = $evenPageFooterIdSuggested;
}
/**
* @return bool
*/
public function getEvenPageFooterIdSuggested()
{
return $this->evenPageFooterIdSuggested;
}
/**
* Indicates if there was a suggested change to even_page_header_id.
*
* @param bool $evenPageHeaderIdSuggested
*/
public function setEvenPageHeaderIdSuggested($evenPageHeaderIdSuggested)
{
$this->evenPageHeaderIdSuggested = $evenPageHeaderIdSuggested;
}
/**
* @return bool
*/
public function getEvenPageHeaderIdSuggested()
{
return $this->evenPageHeaderIdSuggested;
}
/**
* Indicates if there was a suggested change to first_page_footer_id.
*
* @param bool $firstPageFooterIdSuggested
*/
public function setFirstPageFooterIdSuggested($firstPageFooterIdSuggested)
{
$this->firstPageFooterIdSuggested = $firstPageFooterIdSuggested;
}
/**
* @return bool
*/
public function getFirstPageFooterIdSuggested()
{
return $this->firstPageFooterIdSuggested;
}
/**
* Indicates if there was a suggested change to first_page_header_id.
*
* @param bool $firstPageHeaderIdSuggested
*/
public function setFirstPageHeaderIdSuggested($firstPageHeaderIdSuggested)
{
$this->firstPageHeaderIdSuggested = $firstPageHeaderIdSuggested;
}
/**
* @return bool
*/
public function getFirstPageHeaderIdSuggested()
{
return $this->firstPageHeaderIdSuggested;
}
/**
* Optional. Indicates if there was a suggested change to
* flip_page_orientation.
*
* @param bool $flipPageOrientationSuggested
*/
public function setFlipPageOrientationSuggested($flipPageOrientationSuggested)
{
$this->flipPageOrientationSuggested = $flipPageOrientationSuggested;
}
/**
* @return bool
*/
public function getFlipPageOrientationSuggested()
{
return $this->flipPageOrientationSuggested;
}
/**
* Indicates if there was a suggested change to margin_bottom.
*
* @param bool $marginBottomSuggested
*/
public function setMarginBottomSuggested($marginBottomSuggested)
{
$this->marginBottomSuggested = $marginBottomSuggested;
}
/**
* @return bool
*/
public function getMarginBottomSuggested()
{
return $this->marginBottomSuggested;
}
/**
* Indicates if there was a suggested change to margin_footer.
*
* @param bool $marginFooterSuggested
*/
public function setMarginFooterSuggested($marginFooterSuggested)
{
$this->marginFooterSuggested = $marginFooterSuggested;
}
/**
* @return bool
*/
public function getMarginFooterSuggested()
{
return $this->marginFooterSuggested;
}
/**
* Indicates if there was a suggested change to margin_header.
*
* @param bool $marginHeaderSuggested
*/
public function setMarginHeaderSuggested($marginHeaderSuggested)
{
$this->marginHeaderSuggested = $marginHeaderSuggested;
}
/**
* @return bool
*/
public function getMarginHeaderSuggested()
{
return $this->marginHeaderSuggested;
}
/**
* Indicates if there was a suggested change to margin_left.
*
* @param bool $marginLeftSuggested
*/
public function setMarginLeftSuggested($marginLeftSuggested)
{
$this->marginLeftSuggested = $marginLeftSuggested;
}
/**
* @return bool
*/
public function getMarginLeftSuggested()
{
return $this->marginLeftSuggested;
}
/**
* Indicates if there was a suggested change to margin_right.
*
* @param bool $marginRightSuggested
*/
public function setMarginRightSuggested($marginRightSuggested)
{
$this->marginRightSuggested = $marginRightSuggested;
}
/**
* @return bool
*/
public function getMarginRightSuggested()
{
return $this->marginRightSuggested;
}
/**
* Indicates if there was a suggested change to margin_top.
*
* @param bool $marginTopSuggested
*/
public function setMarginTopSuggested($marginTopSuggested)
{
$this->marginTopSuggested = $marginTopSuggested;
}
/**
* @return bool
*/
public function getMarginTopSuggested()
{
return $this->marginTopSuggested;
}
/**
* Indicates if there was a suggested change to page_number_start.
*
* @param bool $pageNumberStartSuggested
*/
public function setPageNumberStartSuggested($pageNumberStartSuggested)
{
$this->pageNumberStartSuggested = $pageNumberStartSuggested;
}
/**
* @return bool
*/
public function getPageNumberStartSuggested()
{
return $this->pageNumberStartSuggested;
}
/**
* A mask that indicates which of the fields in size have been changed in this
* suggestion.
*
* @param SizeSuggestionState $pageSizeSuggestionState
*/
public function setPageSizeSuggestionState(SizeSuggestionState $pageSizeSuggestionState)
{
$this->pageSizeSuggestionState = $pageSizeSuggestionState;
}
/**
* @return SizeSuggestionState
*/
public function getPageSizeSuggestionState()
{
return $this->pageSizeSuggestionState;
}
/**
* Indicates if there was a suggested change to
* use_custom_header_footer_margins.
*
* @param bool $useCustomHeaderFooterMarginsSuggested
*/
public function setUseCustomHeaderFooterMarginsSuggested($useCustomHeaderFooterMarginsSuggested)
{
$this->useCustomHeaderFooterMarginsSuggested = $useCustomHeaderFooterMarginsSuggested;
}
/**
* @return bool
*/
public function getUseCustomHeaderFooterMarginsSuggested()
{
return $this->useCustomHeaderFooterMarginsSuggested;
}
/**
* Indicates if there was a suggested change to use_even_page_header_footer.
*
* @param bool $useEvenPageHeaderFooterSuggested
*/
public function setUseEvenPageHeaderFooterSuggested($useEvenPageHeaderFooterSuggested)
{
$this->useEvenPageHeaderFooterSuggested = $useEvenPageHeaderFooterSuggested;
}
/**
* @return bool
*/
public function getUseEvenPageHeaderFooterSuggested()
{
return $this->useEvenPageHeaderFooterSuggested;
}
/**
* Indicates if there was a suggested change to use_first_page_header_footer.
*
* @param bool $useFirstPageHeaderFooterSuggested
*/
public function setUseFirstPageHeaderFooterSuggested($useFirstPageHeaderFooterSuggested)
{
$this->useFirstPageHeaderFooterSuggested = $useFirstPageHeaderFooterSuggested;
}
/**
* @return bool
*/
public function getUseFirstPageHeaderFooterSuggested()
{
return $this->useFirstPageHeaderFooterSuggested;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DocumentStyleSuggestionState::class, 'Google_Service_Docs_DocumentStyleSuggestionState');
@@ -0,0 +1,244 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class DocumentTab extends \Google\Model
{
protected $bodyType = Body::class;
protected $bodyDataType = '';
protected $documentStyleType = DocumentStyle::class;
protected $documentStyleDataType = '';
protected $footersType = Footer::class;
protected $footersDataType = 'map';
protected $footnotesType = Footnote::class;
protected $footnotesDataType = 'map';
protected $headersType = Header::class;
protected $headersDataType = 'map';
protected $inlineObjectsType = InlineObject::class;
protected $inlineObjectsDataType = 'map';
protected $listsType = DocsList::class;
protected $listsDataType = 'map';
protected $namedRangesType = NamedRanges::class;
protected $namedRangesDataType = 'map';
protected $namedStylesType = NamedStyles::class;
protected $namedStylesDataType = '';
protected $positionedObjectsType = PositionedObject::class;
protected $positionedObjectsDataType = 'map';
protected $suggestedDocumentStyleChangesType = SuggestedDocumentStyle::class;
protected $suggestedDocumentStyleChangesDataType = 'map';
protected $suggestedNamedStylesChangesType = SuggestedNamedStyles::class;
protected $suggestedNamedStylesChangesDataType = 'map';
/**
* The main body of the document tab.
*
* @param Body $body
*/
public function setBody(Body $body)
{
$this->body = $body;
}
/**
* @return Body
*/
public function getBody()
{
return $this->body;
}
/**
* The style of the document tab.
*
* @param DocumentStyle $documentStyle
*/
public function setDocumentStyle(DocumentStyle $documentStyle)
{
$this->documentStyle = $documentStyle;
}
/**
* @return DocumentStyle
*/
public function getDocumentStyle()
{
return $this->documentStyle;
}
/**
* The footers in the document tab, keyed by footer ID.
*
* @param Footer[] $footers
*/
public function setFooters($footers)
{
$this->footers = $footers;
}
/**
* @return Footer[]
*/
public function getFooters()
{
return $this->footers;
}
/**
* The footnotes in the document tab, keyed by footnote ID.
*
* @param Footnote[] $footnotes
*/
public function setFootnotes($footnotes)
{
$this->footnotes = $footnotes;
}
/**
* @return Footnote[]
*/
public function getFootnotes()
{
return $this->footnotes;
}
/**
* The headers in the document tab, keyed by header ID.
*
* @param Header[] $headers
*/
public function setHeaders($headers)
{
$this->headers = $headers;
}
/**
* @return Header[]
*/
public function getHeaders()
{
return $this->headers;
}
/**
* The inline objects in the document tab, keyed by object ID.
*
* @param InlineObject[] $inlineObjects
*/
public function setInlineObjects($inlineObjects)
{
$this->inlineObjects = $inlineObjects;
}
/**
* @return InlineObject[]
*/
public function getInlineObjects()
{
return $this->inlineObjects;
}
/**
* The lists in the document tab, keyed by list ID.
*
* @param DocsList[] $lists
*/
public function setLists($lists)
{
$this->lists = $lists;
}
/**
* @return DocsList[]
*/
public function getLists()
{
return $this->lists;
}
/**
* The named ranges in the document tab, keyed by name.
*
* @param NamedRanges[] $namedRanges
*/
public function setNamedRanges($namedRanges)
{
$this->namedRanges = $namedRanges;
}
/**
* @return NamedRanges[]
*/
public function getNamedRanges()
{
return $this->namedRanges;
}
/**
* The named styles of the document tab.
*
* @param NamedStyles $namedStyles
*/
public function setNamedStyles(NamedStyles $namedStyles)
{
$this->namedStyles = $namedStyles;
}
/**
* @return NamedStyles
*/
public function getNamedStyles()
{
return $this->namedStyles;
}
/**
* The positioned objects in the document tab, keyed by object ID.
*
* @param PositionedObject[] $positionedObjects
*/
public function setPositionedObjects($positionedObjects)
{
$this->positionedObjects = $positionedObjects;
}
/**
* @return PositionedObject[]
*/
public function getPositionedObjects()
{
return $this->positionedObjects;
}
/**
* The suggested changes to the style of the document tab, keyed by suggestion
* ID.
*
* @param SuggestedDocumentStyle[] $suggestedDocumentStyleChanges
*/
public function setSuggestedDocumentStyleChanges($suggestedDocumentStyleChanges)
{
$this->suggestedDocumentStyleChanges = $suggestedDocumentStyleChanges;
}
/**
* @return SuggestedDocumentStyle[]
*/
public function getSuggestedDocumentStyleChanges()
{
return $this->suggestedDocumentStyleChanges;
}
/**
* The suggested changes to the named styles of the document tab, keyed by
* suggestion ID.
*
* @param SuggestedNamedStyles[] $suggestedNamedStylesChanges
*/
public function setSuggestedNamedStylesChanges($suggestedNamedStylesChanges)
{
$this->suggestedNamedStylesChanges = $suggestedNamedStylesChanges;
}
/**
* @return SuggestedNamedStyles[]
*/
public function getSuggestedNamedStylesChanges()
{
return $this->suggestedNamedStylesChanges;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DocumentTab::class, 'Google_Service_Docs_DocumentTab');
@@ -0,0 +1,25 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class EmbeddedDrawingProperties extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(EmbeddedDrawingProperties::class, 'Google_Service_Docs_EmbeddedDrawingProperties');
@@ -0,0 +1,25 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class EmbeddedDrawingPropertiesSuggestionState extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(EmbeddedDrawingPropertiesSuggestionState::class, 'Google_Service_Docs_EmbeddedDrawingPropertiesSuggestionState');
@@ -0,0 +1,238 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class EmbeddedObject extends \Google\Model
{
/**
* The description of the embedded object. The `title` and `description` are
* both combined to display alt text.
*
* @var string
*/
public $description;
protected $embeddedDrawingPropertiesType = EmbeddedDrawingProperties::class;
protected $embeddedDrawingPropertiesDataType = '';
protected $embeddedObjectBorderType = EmbeddedObjectBorder::class;
protected $embeddedObjectBorderDataType = '';
protected $imagePropertiesType = ImageProperties::class;
protected $imagePropertiesDataType = '';
protected $linkedContentReferenceType = LinkedContentReference::class;
protected $linkedContentReferenceDataType = '';
protected $marginBottomType = Dimension::class;
protected $marginBottomDataType = '';
protected $marginLeftType = Dimension::class;
protected $marginLeftDataType = '';
protected $marginRightType = Dimension::class;
protected $marginRightDataType = '';
protected $marginTopType = Dimension::class;
protected $marginTopDataType = '';
protected $sizeType = Size::class;
protected $sizeDataType = '';
/**
* The title of the embedded object. The `title` and `description` are both
* combined to display alt text.
*
* @var string
*/
public $title;
/**
* The description of the embedded object. The `title` and `description` are
* both combined to display alt text.
*
* @param string $description
*/
public function setDescription($description)
{
$this->description = $description;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
/**
* The properties of an embedded drawing.
*
* @param EmbeddedDrawingProperties $embeddedDrawingProperties
*/
public function setEmbeddedDrawingProperties(EmbeddedDrawingProperties $embeddedDrawingProperties)
{
$this->embeddedDrawingProperties = $embeddedDrawingProperties;
}
/**
* @return EmbeddedDrawingProperties
*/
public function getEmbeddedDrawingProperties()
{
return $this->embeddedDrawingProperties;
}
/**
* The border of the embedded object.
*
* @param EmbeddedObjectBorder $embeddedObjectBorder
*/
public function setEmbeddedObjectBorder(EmbeddedObjectBorder $embeddedObjectBorder)
{
$this->embeddedObjectBorder = $embeddedObjectBorder;
}
/**
* @return EmbeddedObjectBorder
*/
public function getEmbeddedObjectBorder()
{
return $this->embeddedObjectBorder;
}
/**
* The properties of an image.
*
* @param ImageProperties $imageProperties
*/
public function setImageProperties(ImageProperties $imageProperties)
{
$this->imageProperties = $imageProperties;
}
/**
* @return ImageProperties
*/
public function getImageProperties()
{
return $this->imageProperties;
}
/**
* A reference to the external linked source content. For example, it contains
* a reference to the source Google Sheets chart when the embedded object is a
* linked chart. If unset, then the embedded object is not linked.
*
* @param LinkedContentReference $linkedContentReference
*/
public function setLinkedContentReference(LinkedContentReference $linkedContentReference)
{
$this->linkedContentReference = $linkedContentReference;
}
/**
* @return LinkedContentReference
*/
public function getLinkedContentReference()
{
return $this->linkedContentReference;
}
/**
* The bottom margin of the embedded object.
*
* @param Dimension $marginBottom
*/
public function setMarginBottom(Dimension $marginBottom)
{
$this->marginBottom = $marginBottom;
}
/**
* @return Dimension
*/
public function getMarginBottom()
{
return $this->marginBottom;
}
/**
* The left margin of the embedded object.
*
* @param Dimension $marginLeft
*/
public function setMarginLeft(Dimension $marginLeft)
{
$this->marginLeft = $marginLeft;
}
/**
* @return Dimension
*/
public function getMarginLeft()
{
return $this->marginLeft;
}
/**
* The right margin of the embedded object.
*
* @param Dimension $marginRight
*/
public function setMarginRight(Dimension $marginRight)
{
$this->marginRight = $marginRight;
}
/**
* @return Dimension
*/
public function getMarginRight()
{
return $this->marginRight;
}
/**
* The top margin of the embedded object.
*
* @param Dimension $marginTop
*/
public function setMarginTop(Dimension $marginTop)
{
$this->marginTop = $marginTop;
}
/**
* @return Dimension
*/
public function getMarginTop()
{
return $this->marginTop;
}
/**
* The visible size of the image after cropping.
*
* @param Size $size
*/
public function setSize(Size $size)
{
$this->size = $size;
}
/**
* @return Size
*/
public function getSize()
{
return $this->size;
}
/**
* The title of the embedded object. The `title` and `description` are both
* combined to display alt text.
*
* @param string $title
*/
public function setTitle($title)
{
$this->title = $title;
}
/**
* @return string
*/
public function getTitle()
{
return $this->title;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(EmbeddedObject::class, 'Google_Service_Docs_EmbeddedObject');
@@ -0,0 +1,137 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class EmbeddedObjectBorder extends \Google\Model
{
/**
* Unspecified dash style.
*/
public const DASH_STYLE_DASH_STYLE_UNSPECIFIED = 'DASH_STYLE_UNSPECIFIED';
/**
* Solid line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'solid'.
* This is the default dash style.
*/
public const DASH_STYLE_SOLID = 'SOLID';
/**
* Dotted line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dot'.
*/
public const DASH_STYLE_DOT = 'DOT';
/**
* Dashed line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dash'.
*/
public const DASH_STYLE_DASH = 'DASH';
/**
* If a property's state is RENDERED, then the element has the corresponding
* property when rendered in the document. This is the default value.
*/
public const PROPERTY_STATE_RENDERED = 'RENDERED';
/**
* If a property's state is NOT_RENDERED, then the element does not have the
* corresponding property when rendered in the document.
*/
public const PROPERTY_STATE_NOT_RENDERED = 'NOT_RENDERED';
protected $colorType = OptionalColor::class;
protected $colorDataType = '';
/**
* The dash style of the border.
*
* @var string
*/
public $dashStyle;
/**
* The property state of the border property.
*
* @var string
*/
public $propertyState;
protected $widthType = Dimension::class;
protected $widthDataType = '';
/**
* The color of the border.
*
* @param OptionalColor $color
*/
public function setColor(OptionalColor $color)
{
$this->color = $color;
}
/**
* @return OptionalColor
*/
public function getColor()
{
return $this->color;
}
/**
* The dash style of the border.
*
* Accepted values: DASH_STYLE_UNSPECIFIED, SOLID, DOT, DASH
*
* @param self::DASH_STYLE_* $dashStyle
*/
public function setDashStyle($dashStyle)
{
$this->dashStyle = $dashStyle;
}
/**
* @return self::DASH_STYLE_*
*/
public function getDashStyle()
{
return $this->dashStyle;
}
/**
* The property state of the border property.
*
* Accepted values: RENDERED, NOT_RENDERED
*
* @param self::PROPERTY_STATE_* $propertyState
*/
public function setPropertyState($propertyState)
{
$this->propertyState = $propertyState;
}
/**
* @return self::PROPERTY_STATE_*
*/
public function getPropertyState()
{
return $this->propertyState;
}
/**
* The width of the border.
*
* @param Dimension $width
*/
public function setWidth(Dimension $width)
{
$this->width = $width;
}
/**
* @return Dimension
*/
public function getWidth()
{
return $this->width;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(EmbeddedObjectBorder::class, 'Google_Service_Docs_EmbeddedObjectBorder');
@@ -0,0 +1,114 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class EmbeddedObjectBorderSuggestionState extends \Google\Model
{
/**
* Indicates if there was a suggested change to color.
*
* @var bool
*/
public $colorSuggested;
/**
* Indicates if there was a suggested change to dash_style.
*
* @var bool
*/
public $dashStyleSuggested;
/**
* Indicates if there was a suggested change to property_state.
*
* @var bool
*/
public $propertyStateSuggested;
/**
* Indicates if there was a suggested change to width.
*
* @var bool
*/
public $widthSuggested;
/**
* Indicates if there was a suggested change to color.
*
* @param bool $colorSuggested
*/
public function setColorSuggested($colorSuggested)
{
$this->colorSuggested = $colorSuggested;
}
/**
* @return bool
*/
public function getColorSuggested()
{
return $this->colorSuggested;
}
/**
* Indicates if there was a suggested change to dash_style.
*
* @param bool $dashStyleSuggested
*/
public function setDashStyleSuggested($dashStyleSuggested)
{
$this->dashStyleSuggested = $dashStyleSuggested;
}
/**
* @return bool
*/
public function getDashStyleSuggested()
{
return $this->dashStyleSuggested;
}
/**
* Indicates if there was a suggested change to property_state.
*
* @param bool $propertyStateSuggested
*/
public function setPropertyStateSuggested($propertyStateSuggested)
{
$this->propertyStateSuggested = $propertyStateSuggested;
}
/**
* @return bool
*/
public function getPropertyStateSuggested()
{
return $this->propertyStateSuggested;
}
/**
* Indicates if there was a suggested change to width.
*
* @param bool $widthSuggested
*/
public function setWidthSuggested($widthSuggested)
{
$this->widthSuggested = $widthSuggested;
}
/**
* @return bool
*/
public function getWidthSuggested()
{
return $this->widthSuggested;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(EmbeddedObjectBorderSuggestionState::class, 'Google_Service_Docs_EmbeddedObjectBorderSuggestionState');
@@ -0,0 +1,253 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class EmbeddedObjectSuggestionState extends \Google\Model
{
/**
* Indicates if there was a suggested change to description.
*
* @var bool
*/
public $descriptionSuggested;
protected $embeddedDrawingPropertiesSuggestionStateType = EmbeddedDrawingPropertiesSuggestionState::class;
protected $embeddedDrawingPropertiesSuggestionStateDataType = '';
protected $embeddedObjectBorderSuggestionStateType = EmbeddedObjectBorderSuggestionState::class;
protected $embeddedObjectBorderSuggestionStateDataType = '';
protected $imagePropertiesSuggestionStateType = ImagePropertiesSuggestionState::class;
protected $imagePropertiesSuggestionStateDataType = '';
protected $linkedContentReferenceSuggestionStateType = LinkedContentReferenceSuggestionState::class;
protected $linkedContentReferenceSuggestionStateDataType = '';
/**
* Indicates if there was a suggested change to margin_bottom.
*
* @var bool
*/
public $marginBottomSuggested;
/**
* Indicates if there was a suggested change to margin_left.
*
* @var bool
*/
public $marginLeftSuggested;
/**
* Indicates if there was a suggested change to margin_right.
*
* @var bool
*/
public $marginRightSuggested;
/**
* Indicates if there was a suggested change to margin_top.
*
* @var bool
*/
public $marginTopSuggested;
protected $sizeSuggestionStateType = SizeSuggestionState::class;
protected $sizeSuggestionStateDataType = '';
/**
* Indicates if there was a suggested change to title.
*
* @var bool
*/
public $titleSuggested;
/**
* Indicates if there was a suggested change to description.
*
* @param bool $descriptionSuggested
*/
public function setDescriptionSuggested($descriptionSuggested)
{
$this->descriptionSuggested = $descriptionSuggested;
}
/**
* @return bool
*/
public function getDescriptionSuggested()
{
return $this->descriptionSuggested;
}
/**
* A mask that indicates which of the fields in embedded_drawing_properties
* have been changed in this suggestion.
*
* @param EmbeddedDrawingPropertiesSuggestionState $embeddedDrawingPropertiesSuggestionState
*/
public function setEmbeddedDrawingPropertiesSuggestionState(EmbeddedDrawingPropertiesSuggestionState $embeddedDrawingPropertiesSuggestionState)
{
$this->embeddedDrawingPropertiesSuggestionState = $embeddedDrawingPropertiesSuggestionState;
}
/**
* @return EmbeddedDrawingPropertiesSuggestionState
*/
public function getEmbeddedDrawingPropertiesSuggestionState()
{
return $this->embeddedDrawingPropertiesSuggestionState;
}
/**
* A mask that indicates which of the fields in embedded_object_border have
* been changed in this suggestion.
*
* @param EmbeddedObjectBorderSuggestionState $embeddedObjectBorderSuggestionState
*/
public function setEmbeddedObjectBorderSuggestionState(EmbeddedObjectBorderSuggestionState $embeddedObjectBorderSuggestionState)
{
$this->embeddedObjectBorderSuggestionState = $embeddedObjectBorderSuggestionState;
}
/**
* @return EmbeddedObjectBorderSuggestionState
*/
public function getEmbeddedObjectBorderSuggestionState()
{
return $this->embeddedObjectBorderSuggestionState;
}
/**
* A mask that indicates which of the fields in image_properties have been
* changed in this suggestion.
*
* @param ImagePropertiesSuggestionState $imagePropertiesSuggestionState
*/
public function setImagePropertiesSuggestionState(ImagePropertiesSuggestionState $imagePropertiesSuggestionState)
{
$this->imagePropertiesSuggestionState = $imagePropertiesSuggestionState;
}
/**
* @return ImagePropertiesSuggestionState
*/
public function getImagePropertiesSuggestionState()
{
return $this->imagePropertiesSuggestionState;
}
/**
* A mask that indicates which of the fields in linked_content_reference have
* been changed in this suggestion.
*
* @param LinkedContentReferenceSuggestionState $linkedContentReferenceSuggestionState
*/
public function setLinkedContentReferenceSuggestionState(LinkedContentReferenceSuggestionState $linkedContentReferenceSuggestionState)
{
$this->linkedContentReferenceSuggestionState = $linkedContentReferenceSuggestionState;
}
/**
* @return LinkedContentReferenceSuggestionState
*/
public function getLinkedContentReferenceSuggestionState()
{
return $this->linkedContentReferenceSuggestionState;
}
/**
* Indicates if there was a suggested change to margin_bottom.
*
* @param bool $marginBottomSuggested
*/
public function setMarginBottomSuggested($marginBottomSuggested)
{
$this->marginBottomSuggested = $marginBottomSuggested;
}
/**
* @return bool
*/
public function getMarginBottomSuggested()
{
return $this->marginBottomSuggested;
}
/**
* Indicates if there was a suggested change to margin_left.
*
* @param bool $marginLeftSuggested
*/
public function setMarginLeftSuggested($marginLeftSuggested)
{
$this->marginLeftSuggested = $marginLeftSuggested;
}
/**
* @return bool
*/
public function getMarginLeftSuggested()
{
return $this->marginLeftSuggested;
}
/**
* Indicates if there was a suggested change to margin_right.
*
* @param bool $marginRightSuggested
*/
public function setMarginRightSuggested($marginRightSuggested)
{
$this->marginRightSuggested = $marginRightSuggested;
}
/**
* @return bool
*/
public function getMarginRightSuggested()
{
return $this->marginRightSuggested;
}
/**
* Indicates if there was a suggested change to margin_top.
*
* @param bool $marginTopSuggested
*/
public function setMarginTopSuggested($marginTopSuggested)
{
$this->marginTopSuggested = $marginTopSuggested;
}
/**
* @return bool
*/
public function getMarginTopSuggested()
{
return $this->marginTopSuggested;
}
/**
* A mask that indicates which of the fields in size have been changed in this
* suggestion.
*
* @param SizeSuggestionState $sizeSuggestionState
*/
public function setSizeSuggestionState(SizeSuggestionState $sizeSuggestionState)
{
$this->sizeSuggestionState = $sizeSuggestionState;
}
/**
* @return SizeSuggestionState
*/
public function getSizeSuggestionState()
{
return $this->sizeSuggestionState;
}
/**
* Indicates if there was a suggested change to title.
*
* @param bool $titleSuggested
*/
public function setTitleSuggested($titleSuggested)
{
$this->titleSuggested = $titleSuggested;
}
/**
* @return bool
*/
public function getTitleSuggested()
{
return $this->titleSuggested;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(EmbeddedObjectSuggestionState::class, 'Google_Service_Docs_EmbeddedObjectSuggestionState');
@@ -0,0 +1,82 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class EndOfSegmentLocation extends \Google\Model
{
/**
* The ID of the header, footer or footnote the location is in. An empty
* segment ID signifies the document's body.
*
* @var string
*/
public $segmentId;
/**
* The tab that the location is in. When omitted, the request is applied to
* the first tab. In a document containing a single tab: - If provided, must
* match the singular tab's ID. - If omitted, the request applies to the
* singular tab. In a document containing multiple tabs: - If provided, the
* request applies to the specified tab. - If omitted, the request applies to
* the first tab in the document.
*
* @var string
*/
public $tabId;
/**
* The ID of the header, footer or footnote the location is in. An empty
* segment ID signifies the document's body.
*
* @param string $segmentId
*/
public function setSegmentId($segmentId)
{
$this->segmentId = $segmentId;
}
/**
* @return string
*/
public function getSegmentId()
{
return $this->segmentId;
}
/**
* The tab that the location is in. When omitted, the request is applied to
* the first tab. In a document containing a single tab: - If provided, must
* match the singular tab's ID. - If omitted, the request applies to the
* singular tab. In a document containing multiple tabs: - If provided, the
* request applies to the specified tab. - If omitted, the request applies to
* the first tab in the document.
*
* @param string $tabId
*/
public function setTabId($tabId)
{
$this->tabId = $tabId;
}
/**
* @return string
*/
public function getTabId()
{
return $this->tabId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(EndOfSegmentLocation::class, 'Google_Service_Docs_EndOfSegmentLocation');
+77
View File
@@ -0,0 +1,77 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class Equation extends \Google\Collection
{
protected $collection_key = 'suggestedInsertionIds';
/**
* The suggested deletion IDs. If empty, then there are no suggested deletions
* of this content.
*
* @var string[]
*/
public $suggestedDeletionIds;
/**
* The suggested insertion IDs. An Equation may have multiple insertion IDs if
* it's a nested suggested change. If empty, then this is not a suggested
* insertion.
*
* @var string[]
*/
public $suggestedInsertionIds;
/**
* The suggested deletion IDs. If empty, then there are no suggested deletions
* of this content.
*
* @param string[] $suggestedDeletionIds
*/
public function setSuggestedDeletionIds($suggestedDeletionIds)
{
$this->suggestedDeletionIds = $suggestedDeletionIds;
}
/**
* @return string[]
*/
public function getSuggestedDeletionIds()
{
return $this->suggestedDeletionIds;
}
/**
* The suggested insertion IDs. An Equation may have multiple insertion IDs if
* it's a nested suggested change. If empty, then this is not a suggested
* insertion.
*
* @param string[] $suggestedInsertionIds
*/
public function setSuggestedInsertionIds($suggestedInsertionIds)
{
$this->suggestedInsertionIds = $suggestedInsertionIds;
}
/**
* @return string[]
*/
public function getSuggestedInsertionIds()
{
return $this->suggestedInsertionIds;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Equation::class, 'Google_Service_Docs_Equation');
+68
View File
@@ -0,0 +1,68 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class Footer extends \Google\Collection
{
protected $collection_key = 'content';
protected $contentType = StructuralElement::class;
protected $contentDataType = 'array';
/**
* The ID of the footer.
*
* @var string
*/
public $footerId;
/**
* The contents of the footer. The indexes for a footer's content begin at
* zero.
*
* @param StructuralElement[] $content
*/
public function setContent($content)
{
$this->content = $content;
}
/**
* @return StructuralElement[]
*/
public function getContent()
{
return $this->content;
}
/**
* The ID of the footer.
*
* @param string $footerId
*/
public function setFooterId($footerId)
{
$this->footerId = $footerId;
}
/**
* @return string
*/
public function getFooterId()
{
return $this->footerId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Footer::class, 'Google_Service_Docs_Footer');
+68
View File
@@ -0,0 +1,68 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class Footnote extends \Google\Collection
{
protected $collection_key = 'content';
protected $contentType = StructuralElement::class;
protected $contentDataType = 'array';
/**
* The ID of the footnote.
*
* @var string
*/
public $footnoteId;
/**
* The contents of the footnote. The indexes for a footnote's content begin at
* zero.
*
* @param StructuralElement[] $content
*/
public function setContent($content)
{
$this->content = $content;
}
/**
* @return StructuralElement[]
*/
public function getContent()
{
return $this->content;
}
/**
* The ID of the footnote.
*
* @param string $footnoteId
*/
public function setFootnoteId($footnoteId)
{
$this->footnoteId = $footnoteId;
}
/**
* @return string
*/
public function getFootnoteId()
{
return $this->footnoteId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Footnote::class, 'Google_Service_Docs_Footnote');
@@ -0,0 +1,160 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class FootnoteReference extends \Google\Collection
{
protected $collection_key = 'suggestedInsertionIds';
/**
* The ID of the footnote that contains the content of this footnote
* reference.
*
* @var string
*/
public $footnoteId;
/**
* The rendered number of this footnote.
*
* @var string
*/
public $footnoteNumber;
/**
* The suggested deletion IDs. If empty, then there are no suggested deletions
* of this content.
*
* @var string[]
*/
public $suggestedDeletionIds;
/**
* The suggested insertion IDs. A FootnoteReference may have multiple
* insertion IDs if it's a nested suggested change. If empty, then this is not
* a suggested insertion.
*
* @var string[]
*/
public $suggestedInsertionIds;
protected $suggestedTextStyleChangesType = SuggestedTextStyle::class;
protected $suggestedTextStyleChangesDataType = 'map';
protected $textStyleType = TextStyle::class;
protected $textStyleDataType = '';
/**
* The ID of the footnote that contains the content of this footnote
* reference.
*
* @param string $footnoteId
*/
public function setFootnoteId($footnoteId)
{
$this->footnoteId = $footnoteId;
}
/**
* @return string
*/
public function getFootnoteId()
{
return $this->footnoteId;
}
/**
* The rendered number of this footnote.
*
* @param string $footnoteNumber
*/
public function setFootnoteNumber($footnoteNumber)
{
$this->footnoteNumber = $footnoteNumber;
}
/**
* @return string
*/
public function getFootnoteNumber()
{
return $this->footnoteNumber;
}
/**
* The suggested deletion IDs. If empty, then there are no suggested deletions
* of this content.
*
* @param string[] $suggestedDeletionIds
*/
public function setSuggestedDeletionIds($suggestedDeletionIds)
{
$this->suggestedDeletionIds = $suggestedDeletionIds;
}
/**
* @return string[]
*/
public function getSuggestedDeletionIds()
{
return $this->suggestedDeletionIds;
}
/**
* The suggested insertion IDs. A FootnoteReference may have multiple
* insertion IDs if it's a nested suggested change. If empty, then this is not
* a suggested insertion.
*
* @param string[] $suggestedInsertionIds
*/
public function setSuggestedInsertionIds($suggestedInsertionIds)
{
$this->suggestedInsertionIds = $suggestedInsertionIds;
}
/**
* @return string[]
*/
public function getSuggestedInsertionIds()
{
return $this->suggestedInsertionIds;
}
/**
* The suggested text style changes to this FootnoteReference, keyed by
* suggestion ID.
*
* @param SuggestedTextStyle[] $suggestedTextStyleChanges
*/
public function setSuggestedTextStyleChanges($suggestedTextStyleChanges)
{
$this->suggestedTextStyleChanges = $suggestedTextStyleChanges;
}
/**
* @return SuggestedTextStyle[]
*/
public function getSuggestedTextStyleChanges()
{
return $this->suggestedTextStyleChanges;
}
/**
* The text style of this FootnoteReference.
*
* @param TextStyle $textStyle
*/
public function setTextStyle(TextStyle $textStyle)
{
$this->textStyle = $textStyle;
}
/**
* @return TextStyle
*/
public function getTextStyle()
{
return $this->textStyle;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(FootnoteReference::class, 'Google_Service_Docs_FootnoteReference');
+68
View File
@@ -0,0 +1,68 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class Header extends \Google\Collection
{
protected $collection_key = 'content';
protected $contentType = StructuralElement::class;
protected $contentDataType = 'array';
/**
* The ID of the header.
*
* @var string
*/
public $headerId;
/**
* The contents of the header. The indexes for a header's content begin at
* zero.
*
* @param StructuralElement[] $content
*/
public function setContent($content)
{
$this->content = $content;
}
/**
* @return StructuralElement[]
*/
public function getContent()
{
return $this->content;
}
/**
* The ID of the header.
*
* @param string $headerId
*/
public function setHeaderId($headerId)
{
$this->headerId = $headerId;
}
/**
* @return string
*/
public function getHeaderId()
{
return $this->headerId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Header::class, 'Google_Service_Docs_Header');
@@ -0,0 +1,70 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class HeadingLink extends \Google\Model
{
/**
* The ID of a heading in this document.
*
* @var string
*/
public $id;
/**
* The ID of the tab containing this heading.
*
* @var string
*/
public $tabId;
/**
* The ID of a heading in this document.
*
* @param string $id
*/
public function setId($id)
{
$this->id = $id;
}
/**
* @return string
*/
public function getId()
{
return $this->id;
}
/**
* The ID of the tab containing this heading.
*
* @param string $tabId
*/
public function setTabId($tabId)
{
$this->tabId = $tabId;
}
/**
* @return string
*/
public function getTabId()
{
return $this->tabId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(HeadingLink::class, 'Google_Service_Docs_HeadingLink');
@@ -0,0 +1,116 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class HorizontalRule extends \Google\Collection
{
protected $collection_key = 'suggestedInsertionIds';
/**
* The suggested deletion IDs. If empty, then there are no suggested deletions
* of this content.
*
* @var string[]
*/
public $suggestedDeletionIds;
/**
* The suggested insertion IDs. A HorizontalRule may have multiple insertion
* IDs if it is a nested suggested change. If empty, then this is not a
* suggested insertion.
*
* @var string[]
*/
public $suggestedInsertionIds;
protected $suggestedTextStyleChangesType = SuggestedTextStyle::class;
protected $suggestedTextStyleChangesDataType = 'map';
protected $textStyleType = TextStyle::class;
protected $textStyleDataType = '';
/**
* The suggested deletion IDs. If empty, then there are no suggested deletions
* of this content.
*
* @param string[] $suggestedDeletionIds
*/
public function setSuggestedDeletionIds($suggestedDeletionIds)
{
$this->suggestedDeletionIds = $suggestedDeletionIds;
}
/**
* @return string[]
*/
public function getSuggestedDeletionIds()
{
return $this->suggestedDeletionIds;
}
/**
* The suggested insertion IDs. A HorizontalRule may have multiple insertion
* IDs if it is a nested suggested change. If empty, then this is not a
* suggested insertion.
*
* @param string[] $suggestedInsertionIds
*/
public function setSuggestedInsertionIds($suggestedInsertionIds)
{
$this->suggestedInsertionIds = $suggestedInsertionIds;
}
/**
* @return string[]
*/
public function getSuggestedInsertionIds()
{
return $this->suggestedInsertionIds;
}
/**
* The suggested text style changes to this HorizontalRule, keyed by
* suggestion ID.
*
* @param SuggestedTextStyle[] $suggestedTextStyleChanges
*/
public function setSuggestedTextStyleChanges($suggestedTextStyleChanges)
{
$this->suggestedTextStyleChanges = $suggestedTextStyleChanges;
}
/**
* @return SuggestedTextStyle[]
*/
public function getSuggestedTextStyleChanges()
{
return $this->suggestedTextStyleChanges;
}
/**
* The text style of this HorizontalRule. Similar to text content, like text
* runs and footnote references, the text style of a horizontal rule can
* affect content layout as well as the styling of text inserted next to it.
*
* @param TextStyle $textStyle
*/
public function setTextStyle(TextStyle $textStyle)
{
$this->textStyle = $textStyle;
}
/**
* @return TextStyle
*/
public function getTextStyle()
{
return $this->textStyle;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(HorizontalRule::class, 'Google_Service_Docs_HorizontalRule');
@@ -0,0 +1,190 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class ImageProperties extends \Google\Model
{
/**
* The clockwise rotation angle of the image, in radians.
*
* @var float
*/
public $angle;
/**
* The brightness effect of the image. The value should be in the interval
* [-1.0, 1.0], where 0 means no effect.
*
* @var float
*/
public $brightness;
/**
* A URI to the image with a default lifetime of 30 minutes. This URI is
* tagged with the account of the requester. Anyone with the URI effectively
* accesses the image as the original requester. Access to the image may be
* lost if the document's sharing settings change.
*
* @var string
*/
public $contentUri;
/**
* The contrast effect of the image. The value should be in the interval
* [-1.0, 1.0], where 0 means no effect.
*
* @var float
*/
public $contrast;
protected $cropPropertiesType = CropProperties::class;
protected $cropPropertiesDataType = '';
/**
* The source URI is the URI used to insert the image. The source URI can be
* empty.
*
* @var string
*/
public $sourceUri;
/**
* The transparency effect of the image. The value should be in the interval
* [0.0, 1.0], where 0 means no effect and 1 means transparent.
*
* @var float
*/
public $transparency;
/**
* The clockwise rotation angle of the image, in radians.
*
* @param float $angle
*/
public function setAngle($angle)
{
$this->angle = $angle;
}
/**
* @return float
*/
public function getAngle()
{
return $this->angle;
}
/**
* The brightness effect of the image. The value should be in the interval
* [-1.0, 1.0], where 0 means no effect.
*
* @param float $brightness
*/
public function setBrightness($brightness)
{
$this->brightness = $brightness;
}
/**
* @return float
*/
public function getBrightness()
{
return $this->brightness;
}
/**
* A URI to the image with a default lifetime of 30 minutes. This URI is
* tagged with the account of the requester. Anyone with the URI effectively
* accesses the image as the original requester. Access to the image may be
* lost if the document's sharing settings change.
*
* @param string $contentUri
*/
public function setContentUri($contentUri)
{
$this->contentUri = $contentUri;
}
/**
* @return string
*/
public function getContentUri()
{
return $this->contentUri;
}
/**
* The contrast effect of the image. The value should be in the interval
* [-1.0, 1.0], where 0 means no effect.
*
* @param float $contrast
*/
public function setContrast($contrast)
{
$this->contrast = $contrast;
}
/**
* @return float
*/
public function getContrast()
{
return $this->contrast;
}
/**
* The crop properties of the image.
*
* @param CropProperties $cropProperties
*/
public function setCropProperties(CropProperties $cropProperties)
{
$this->cropProperties = $cropProperties;
}
/**
* @return CropProperties
*/
public function getCropProperties()
{
return $this->cropProperties;
}
/**
* The source URI is the URI used to insert the image. The source URI can be
* empty.
*
* @param string $sourceUri
*/
public function setSourceUri($sourceUri)
{
$this->sourceUri = $sourceUri;
}
/**
* @return string
*/
public function getSourceUri()
{
return $this->sourceUri;
}
/**
* The transparency effect of the image. The value should be in the interval
* [0.0, 1.0], where 0 means no effect and 1 means transparent.
*
* @param float $transparency
*/
public function setTransparency($transparency)
{
$this->transparency = $transparency;
}
/**
* @return float
*/
public function getTransparency()
{
return $this->transparency;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ImageProperties::class, 'Google_Service_Docs_ImageProperties');
@@ -0,0 +1,177 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class ImagePropertiesSuggestionState extends \Google\Model
{
/**
* Indicates if there was a suggested change to angle.
*
* @var bool
*/
public $angleSuggested;
/**
* Indicates if there was a suggested change to brightness.
*
* @var bool
*/
public $brightnessSuggested;
/**
* Indicates if there was a suggested change to content_uri.
*
* @var bool
*/
public $contentUriSuggested;
/**
* Indicates if there was a suggested change to contrast.
*
* @var bool
*/
public $contrastSuggested;
protected $cropPropertiesSuggestionStateType = CropPropertiesSuggestionState::class;
protected $cropPropertiesSuggestionStateDataType = '';
/**
* Indicates if there was a suggested change to source_uri.
*
* @var bool
*/
public $sourceUriSuggested;
/**
* Indicates if there was a suggested change to transparency.
*
* @var bool
*/
public $transparencySuggested;
/**
* Indicates if there was a suggested change to angle.
*
* @param bool $angleSuggested
*/
public function setAngleSuggested($angleSuggested)
{
$this->angleSuggested = $angleSuggested;
}
/**
* @return bool
*/
public function getAngleSuggested()
{
return $this->angleSuggested;
}
/**
* Indicates if there was a suggested change to brightness.
*
* @param bool $brightnessSuggested
*/
public function setBrightnessSuggested($brightnessSuggested)
{
$this->brightnessSuggested = $brightnessSuggested;
}
/**
* @return bool
*/
public function getBrightnessSuggested()
{
return $this->brightnessSuggested;
}
/**
* Indicates if there was a suggested change to content_uri.
*
* @param bool $contentUriSuggested
*/
public function setContentUriSuggested($contentUriSuggested)
{
$this->contentUriSuggested = $contentUriSuggested;
}
/**
* @return bool
*/
public function getContentUriSuggested()
{
return $this->contentUriSuggested;
}
/**
* Indicates if there was a suggested change to contrast.
*
* @param bool $contrastSuggested
*/
public function setContrastSuggested($contrastSuggested)
{
$this->contrastSuggested = $contrastSuggested;
}
/**
* @return bool
*/
public function getContrastSuggested()
{
return $this->contrastSuggested;
}
/**
* A mask that indicates which of the fields in crop_properties have been
* changed in this suggestion.
*
* @param CropPropertiesSuggestionState $cropPropertiesSuggestionState
*/
public function setCropPropertiesSuggestionState(CropPropertiesSuggestionState $cropPropertiesSuggestionState)
{
$this->cropPropertiesSuggestionState = $cropPropertiesSuggestionState;
}
/**
* @return CropPropertiesSuggestionState
*/
public function getCropPropertiesSuggestionState()
{
return $this->cropPropertiesSuggestionState;
}
/**
* Indicates if there was a suggested change to source_uri.
*
* @param bool $sourceUriSuggested
*/
public function setSourceUriSuggested($sourceUriSuggested)
{
$this->sourceUriSuggested = $sourceUriSuggested;
}
/**
* @return bool
*/
public function getSourceUriSuggested()
{
return $this->sourceUriSuggested;
}
/**
* Indicates if there was a suggested change to transparency.
*
* @param bool $transparencySuggested
*/
public function setTransparencySuggested($transparencySuggested)
{
$this->transparencySuggested = $transparencySuggested;
}
/**
* @return bool
*/
public function getTransparencySuggested()
{
return $this->transparencySuggested;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ImagePropertiesSuggestionState::class, 'Google_Service_Docs_ImagePropertiesSuggestionState');
@@ -0,0 +1,134 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class InlineObject extends \Google\Collection
{
protected $collection_key = 'suggestedDeletionIds';
protected $inlineObjectPropertiesType = InlineObjectProperties::class;
protected $inlineObjectPropertiesDataType = '';
/**
* The ID of this inline object. Can be used to update an objects properties.
*
* @var string
*/
public $objectId;
/**
* The suggested deletion IDs. If empty, then there are no suggested deletions
* of this content.
*
* @var string[]
*/
public $suggestedDeletionIds;
protected $suggestedInlineObjectPropertiesChangesType = SuggestedInlineObjectProperties::class;
protected $suggestedInlineObjectPropertiesChangesDataType = 'map';
/**
* The suggested insertion ID. If empty, then this is not a suggested
* insertion.
*
* @var string
*/
public $suggestedInsertionId;
/**
* The properties of this inline object.
*
* @param InlineObjectProperties $inlineObjectProperties
*/
public function setInlineObjectProperties(InlineObjectProperties $inlineObjectProperties)
{
$this->inlineObjectProperties = $inlineObjectProperties;
}
/**
* @return InlineObjectProperties
*/
public function getInlineObjectProperties()
{
return $this->inlineObjectProperties;
}
/**
* The ID of this inline object. Can be used to update an objects properties.
*
* @param string $objectId
*/
public function setObjectId($objectId)
{
$this->objectId = $objectId;
}
/**
* @return string
*/
public function getObjectId()
{
return $this->objectId;
}
/**
* The suggested deletion IDs. If empty, then there are no suggested deletions
* of this content.
*
* @param string[] $suggestedDeletionIds
*/
public function setSuggestedDeletionIds($suggestedDeletionIds)
{
$this->suggestedDeletionIds = $suggestedDeletionIds;
}
/**
* @return string[]
*/
public function getSuggestedDeletionIds()
{
return $this->suggestedDeletionIds;
}
/**
* The suggested changes to the inline object properties, keyed by suggestion
* ID.
*
* @param SuggestedInlineObjectProperties[] $suggestedInlineObjectPropertiesChanges
*/
public function setSuggestedInlineObjectPropertiesChanges($suggestedInlineObjectPropertiesChanges)
{
$this->suggestedInlineObjectPropertiesChanges = $suggestedInlineObjectPropertiesChanges;
}
/**
* @return SuggestedInlineObjectProperties[]
*/
public function getSuggestedInlineObjectPropertiesChanges()
{
return $this->suggestedInlineObjectPropertiesChanges;
}
/**
* The suggested insertion ID. If empty, then this is not a suggested
* insertion.
*
* @param string $suggestedInsertionId
*/
public function setSuggestedInsertionId($suggestedInsertionId)
{
$this->suggestedInsertionId = $suggestedInsertionId;
}
/**
* @return string
*/
public function getSuggestedInsertionId()
{
return $this->suggestedInsertionId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(InlineObject::class, 'Google_Service_Docs_InlineObject');
@@ -0,0 +1,139 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class InlineObjectElement extends \Google\Collection
{
protected $collection_key = 'suggestedInsertionIds';
/**
* The ID of the InlineObject this element contains.
*
* @var string
*/
public $inlineObjectId;
/**
* The suggested deletion IDs. If empty, then there are no suggested deletions
* of this content.
*
* @var string[]
*/
public $suggestedDeletionIds;
/**
* The suggested insertion IDs. An InlineObjectElement may have multiple
* insertion IDs if it's a nested suggested change. If empty, then this is not
* a suggested insertion.
*
* @var string[]
*/
public $suggestedInsertionIds;
protected $suggestedTextStyleChangesType = SuggestedTextStyle::class;
protected $suggestedTextStyleChangesDataType = 'map';
protected $textStyleType = TextStyle::class;
protected $textStyleDataType = '';
/**
* The ID of the InlineObject this element contains.
*
* @param string $inlineObjectId
*/
public function setInlineObjectId($inlineObjectId)
{
$this->inlineObjectId = $inlineObjectId;
}
/**
* @return string
*/
public function getInlineObjectId()
{
return $this->inlineObjectId;
}
/**
* The suggested deletion IDs. If empty, then there are no suggested deletions
* of this content.
*
* @param string[] $suggestedDeletionIds
*/
public function setSuggestedDeletionIds($suggestedDeletionIds)
{
$this->suggestedDeletionIds = $suggestedDeletionIds;
}
/**
* @return string[]
*/
public function getSuggestedDeletionIds()
{
return $this->suggestedDeletionIds;
}
/**
* The suggested insertion IDs. An InlineObjectElement may have multiple
* insertion IDs if it's a nested suggested change. If empty, then this is not
* a suggested insertion.
*
* @param string[] $suggestedInsertionIds
*/
public function setSuggestedInsertionIds($suggestedInsertionIds)
{
$this->suggestedInsertionIds = $suggestedInsertionIds;
}
/**
* @return string[]
*/
public function getSuggestedInsertionIds()
{
return $this->suggestedInsertionIds;
}
/**
* The suggested text style changes to this InlineObject, keyed by suggestion
* ID.
*
* @param SuggestedTextStyle[] $suggestedTextStyleChanges
*/
public function setSuggestedTextStyleChanges($suggestedTextStyleChanges)
{
$this->suggestedTextStyleChanges = $suggestedTextStyleChanges;
}
/**
* @return SuggestedTextStyle[]
*/
public function getSuggestedTextStyleChanges()
{
return $this->suggestedTextStyleChanges;
}
/**
* The text style of this InlineObjectElement. Similar to text content, like
* text runs and footnote references, the text style of an inline object
* element can affect content layout as well as the styling of text inserted
* next to it.
*
* @param TextStyle $textStyle
*/
public function setTextStyle(TextStyle $textStyle)
{
$this->textStyle = $textStyle;
}
/**
* @return TextStyle
*/
public function getTextStyle()
{
return $this->textStyle;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(InlineObjectElement::class, 'Google_Service_Docs_InlineObjectElement');
@@ -0,0 +1,44 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class InlineObjectProperties extends \Google\Model
{
protected $embeddedObjectType = EmbeddedObject::class;
protected $embeddedObjectDataType = '';
/**
* The embedded object of this inline object.
*
* @param EmbeddedObject $embeddedObject
*/
public function setEmbeddedObject(EmbeddedObject $embeddedObject)
{
$this->embeddedObject = $embeddedObject;
}
/**
* @return EmbeddedObject
*/
public function getEmbeddedObject()
{
return $this->embeddedObject;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(InlineObjectProperties::class, 'Google_Service_Docs_InlineObjectProperties');
@@ -0,0 +1,45 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class InlineObjectPropertiesSuggestionState extends \Google\Model
{
protected $embeddedObjectSuggestionStateType = EmbeddedObjectSuggestionState::class;
protected $embeddedObjectSuggestionStateDataType = '';
/**
* A mask that indicates which of the fields in embedded_object have been
* changed in this suggestion.
*
* @param EmbeddedObjectSuggestionState $embeddedObjectSuggestionState
*/
public function setEmbeddedObjectSuggestionState(EmbeddedObjectSuggestionState $embeddedObjectSuggestionState)
{
$this->embeddedObjectSuggestionState = $embeddedObjectSuggestionState;
}
/**
* @return EmbeddedObjectSuggestionState
*/
public function getEmbeddedObjectSuggestionState()
{
return $this->embeddedObjectSuggestionState;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(InlineObjectPropertiesSuggestionState::class, 'Google_Service_Docs_InlineObjectPropertiesSuggestionState');
@@ -0,0 +1,83 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class InsertDateRequest extends \Google\Model
{
protected $dateElementPropertiesType = DateElementProperties::class;
protected $dateElementPropertiesDataType = '';
protected $endOfSegmentLocationType = EndOfSegmentLocation::class;
protected $endOfSegmentLocationDataType = '';
protected $locationType = Location::class;
protected $locationDataType = '';
/**
* The properties of the date to insert.
*
* @param DateElementProperties $dateElementProperties
*/
public function setDateElementProperties(DateElementProperties $dateElementProperties)
{
$this->dateElementProperties = $dateElementProperties;
}
/**
* @return DateElementProperties
*/
public function getDateElementProperties()
{
return $this->dateElementProperties;
}
/**
* Inserts the date at the end of the given header, footer or document body.
*
* @param EndOfSegmentLocation $endOfSegmentLocation
*/
public function setEndOfSegmentLocation(EndOfSegmentLocation $endOfSegmentLocation)
{
$this->endOfSegmentLocation = $endOfSegmentLocation;
}
/**
* @return EndOfSegmentLocation
*/
public function getEndOfSegmentLocation()
{
return $this->endOfSegmentLocation;
}
/**
* Inserts the date at a specific index in the document. The date must be
* inserted inside the bounds of an existing Paragraph. For instance, it
* cannot be inserted at a table's start index (i.e. between an existing table
* and its preceding paragraph).
*
* @param Location $location
*/
public function setLocation(Location $location)
{
$this->location = $location;
}
/**
* @return Location
*/
public function getLocation()
{
return $this->location;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(InsertDateRequest::class, 'Google_Service_Docs_InsertDateRequest');
@@ -0,0 +1,124 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class InsertInlineImageRequest extends \Google\Model
{
protected $endOfSegmentLocationType = EndOfSegmentLocation::class;
protected $endOfSegmentLocationDataType = '';
protected $locationType = Location::class;
protected $locationDataType = '';
protected $objectSizeType = Size::class;
protected $objectSizeDataType = '';
/**
* The image URI. The image is fetched once at insertion time and a copy is
* stored for display inside the document. Images must be less than 50MB in
* size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF
* format. The provided URI must be publicly accessible and at most 2 kB in
* length. The URI itself is saved with the image, and exposed via the
* ImageProperties.content_uri field.
*
* @var string
*/
public $uri;
/**
* Inserts the text at the end of a header, footer or the document body.
* Inline images cannot be inserted inside a footnote.
*
* @param EndOfSegmentLocation $endOfSegmentLocation
*/
public function setEndOfSegmentLocation(EndOfSegmentLocation $endOfSegmentLocation)
{
$this->endOfSegmentLocation = $endOfSegmentLocation;
}
/**
* @return EndOfSegmentLocation
*/
public function getEndOfSegmentLocation()
{
return $this->endOfSegmentLocation;
}
/**
* Inserts the image at a specific index in the document. The image must be
* inserted inside the bounds of an existing Paragraph. For instance, it
* cannot be inserted at a table's start index (i.e. between the table and its
* preceding paragraph). Inline images cannot be inserted inside a footnote or
* equation.
*
* @param Location $location
*/
public function setLocation(Location $location)
{
$this->location = $location;
}
/**
* @return Location
*/
public function getLocation()
{
return $this->location;
}
/**
* The size that the image should appear as in the document. This property is
* optional and the final size of the image in the document is determined by
* the following rules: * If neither width nor height is specified, then a
* default size of the image is calculated based on its resolution. * If one
* dimension is specified then the other dimension is calculated to preserve
* the aspect ratio of the image. * If both width and height are specified,
* the image is scaled to fit within the provided dimensions while maintaining
* its aspect ratio.
*
* @param Size $objectSize
*/
public function setObjectSize(Size $objectSize)
{
$this->objectSize = $objectSize;
}
/**
* @return Size
*/
public function getObjectSize()
{
return $this->objectSize;
}
/**
* The image URI. The image is fetched once at insertion time and a copy is
* stored for display inside the document. Images must be less than 50MB in
* size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF
* format. The provided URI must be publicly accessible and at most 2 kB in
* length. The URI itself is saved with the image, and exposed via the
* ImageProperties.content_uri field.
*
* @param string $uri
*/
public function setUri($uri)
{
$this->uri = $uri;
}
/**
* @return string
*/
public function getUri()
{
return $this->uri;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(InsertInlineImageRequest::class, 'Google_Service_Docs_InsertInlineImageRequest');
@@ -0,0 +1,48 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class InsertInlineImageResponse extends \Google\Model
{
/**
* The ID of the created InlineObject.
*
* @var string
*/
public $objectId;
/**
* The ID of the created InlineObject.
*
* @param string $objectId
*/
public function setObjectId($objectId)
{
$this->objectId = $objectId;
}
/**
* @return string
*/
public function getObjectId()
{
return $this->objectId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(InsertInlineImageResponse::class, 'Google_Service_Docs_InsertInlineImageResponse');
@@ -0,0 +1,48 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class InsertInlineSheetsChartResponse extends \Google\Model
{
/**
* The object ID of the inserted chart.
*
* @var string
*/
public $objectId;
/**
* The object ID of the inserted chart.
*
* @param string $objectId
*/
public function setObjectId($objectId)
{
$this->objectId = $objectId;
}
/**
* @return string
*/
public function getObjectId()
{
return $this->objectId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(InsertInlineSheetsChartResponse::class, 'Google_Service_Docs_InsertInlineSheetsChartResponse');
@@ -0,0 +1,69 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class InsertPageBreakRequest extends \Google\Model
{
protected $endOfSegmentLocationType = EndOfSegmentLocation::class;
protected $endOfSegmentLocationDataType = '';
protected $locationType = Location::class;
protected $locationDataType = '';
/**
* Inserts the page break at the end of the document body. Page breaks cannot
* be inserted inside a footnote, header or footer. Since page breaks can only
* be inserted inside the body, the segment ID field must be empty.
*
* @param EndOfSegmentLocation $endOfSegmentLocation
*/
public function setEndOfSegmentLocation(EndOfSegmentLocation $endOfSegmentLocation)
{
$this->endOfSegmentLocation = $endOfSegmentLocation;
}
/**
* @return EndOfSegmentLocation
*/
public function getEndOfSegmentLocation()
{
return $this->endOfSegmentLocation;
}
/**
* Inserts the page break at a specific index in the document. The page break
* must be inserted inside the bounds of an existing Paragraph. For instance,
* it cannot be inserted at a table's start index (i.e. between the table and
* its preceding paragraph). Page breaks cannot be inserted inside a table,
* equation, footnote, header or footer. Since page breaks can only be
* inserted inside the body, the segment ID field must be empty.
*
* @param Location $location
*/
public function setLocation(Location $location)
{
$this->location = $location;
}
/**
* @return Location
*/
public function getLocation()
{
return $this->location;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(InsertPageBreakRequest::class, 'Google_Service_Docs_InsertPageBreakRequest');
@@ -0,0 +1,85 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class InsertPersonRequest extends \Google\Model
{
protected $endOfSegmentLocationType = EndOfSegmentLocation::class;
protected $endOfSegmentLocationDataType = '';
protected $locationType = Location::class;
protected $locationDataType = '';
protected $personPropertiesType = PersonProperties::class;
protected $personPropertiesDataType = '';
/**
* Inserts the person mention at the end of a header, footer, footnote or the
* document body.
*
* @param EndOfSegmentLocation $endOfSegmentLocation
*/
public function setEndOfSegmentLocation(EndOfSegmentLocation $endOfSegmentLocation)
{
$this->endOfSegmentLocation = $endOfSegmentLocation;
}
/**
* @return EndOfSegmentLocation
*/
public function getEndOfSegmentLocation()
{
return $this->endOfSegmentLocation;
}
/**
* Inserts the person mention at a specific index in the document. The person
* mention must be inserted inside the bounds of an existing Paragraph. For
* instance, it cannot be inserted at a table's start index (i.e. between the
* table and its preceding paragraph). Person mentions cannot be inserted
* inside an equation.
*
* @param Location $location
*/
public function setLocation(Location $location)
{
$this->location = $location;
}
/**
* @return Location
*/
public function getLocation()
{
return $this->location;
}
/**
* The properties of the person mention to insert.
*
* @param PersonProperties $personProperties
*/
public function setPersonProperties(PersonProperties $personProperties)
{
$this->personProperties = $personProperties;
}
/**
* @return PersonProperties
*/
public function getPersonProperties()
{
return $this->personProperties;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(InsertPersonRequest::class, 'Google_Service_Docs_InsertPersonRequest');
@@ -0,0 +1,85 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class InsertRichLinkRequest extends \Google\Model
{
protected $endOfSegmentLocationType = EndOfSegmentLocation::class;
protected $endOfSegmentLocationDataType = '';
protected $locationType = Location::class;
protected $locationDataType = '';
protected $richLinkPropertiesType = RichLinkProperties::class;
protected $richLinkPropertiesDataType = '';
/**
* Inserts the rich link at the end of a header, footer, footnote or the
* document body.
*
* @param EndOfSegmentLocation $endOfSegmentLocation
*/
public function setEndOfSegmentLocation(EndOfSegmentLocation $endOfSegmentLocation)
{
$this->endOfSegmentLocation = $endOfSegmentLocation;
}
/**
* @return EndOfSegmentLocation
*/
public function getEndOfSegmentLocation()
{
return $this->endOfSegmentLocation;
}
/**
* Inserts the rich link at a specific index in the document. The rich link
* must be inserted inside the bounds of an existing Paragraph. For instance,
* it cannot be inserted at a table's start index (i.e. between the table and
* its preceding paragraph). The rich link cannot be inserted inside an
* equation.
*
* @param Location $location
*/
public function setLocation(Location $location)
{
$this->location = $location;
}
/**
* @return Location
*/
public function getLocation()
{
return $this->location;
}
/**
* The properties of the rich link to insert.
*
* @param RichLinkProperties $richLinkProperties
*/
public function setRichLinkProperties(RichLinkProperties $richLinkProperties)
{
$this->richLinkProperties = $richLinkProperties;
}
/**
* @return RichLinkProperties
*/
public function getRichLinkProperties()
{
return $this->richLinkProperties;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(InsertRichLinkRequest::class, 'Google_Service_Docs_InsertRichLinkRequest');
@@ -0,0 +1,108 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class InsertSectionBreakRequest extends \Google\Model
{
/**
* The section type is unspecified.
*/
public const SECTION_TYPE_SECTION_TYPE_UNSPECIFIED = 'SECTION_TYPE_UNSPECIFIED';
/**
* The section starts immediately after the last paragraph of the previous
* section.
*/
public const SECTION_TYPE_CONTINUOUS = 'CONTINUOUS';
/**
* The section starts on the next page.
*/
public const SECTION_TYPE_NEXT_PAGE = 'NEXT_PAGE';
protected $endOfSegmentLocationType = EndOfSegmentLocation::class;
protected $endOfSegmentLocationDataType = '';
protected $locationType = Location::class;
protected $locationDataType = '';
/**
* The type of section to insert.
*
* @var string
*/
public $sectionType;
/**
* Inserts a newline and a section break at the end of the document body.
* Section breaks cannot be inserted inside a footnote, header or footer.
* Because section breaks can only be inserted inside the body, the segment ID
* field must be empty.
*
* @param EndOfSegmentLocation $endOfSegmentLocation
*/
public function setEndOfSegmentLocation(EndOfSegmentLocation $endOfSegmentLocation)
{
$this->endOfSegmentLocation = $endOfSegmentLocation;
}
/**
* @return EndOfSegmentLocation
*/
public function getEndOfSegmentLocation()
{
return $this->endOfSegmentLocation;
}
/**
* Inserts a newline and a section break at a specific index in the document.
* The section break must be inserted inside the bounds of an existing
* Paragraph. For instance, it cannot be inserted at a table's start index
* (i.e. between the table and its preceding paragraph). Section breaks cannot
* be inserted inside a table, equation, footnote, header, or footer. Since
* section breaks can only be inserted inside the body, the segment ID field
* must be empty.
*
* @param Location $location
*/
public function setLocation(Location $location)
{
$this->location = $location;
}
/**
* @return Location
*/
public function getLocation()
{
return $this->location;
}
/**
* The type of section to insert.
*
* Accepted values: SECTION_TYPE_UNSPECIFIED, CONTINUOUS, NEXT_PAGE
*
* @param self::SECTION_TYPE_* $sectionType
*/
public function setSectionType($sectionType)
{
$this->sectionType = $sectionType;
}
/**
* @return self::SECTION_TYPE_*
*/
public function getSectionType()
{
return $this->sectionType;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(InsertSectionBreakRequest::class, 'Google_Service_Docs_InsertSectionBreakRequest');
@@ -0,0 +1,71 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class InsertTableColumnRequest extends \Google\Model
{
/**
* Whether to insert new column to the right of the reference cell location. -
* `True`: insert to the right. - `False`: insert to the left.
*
* @var bool
*/
public $insertRight;
protected $tableCellLocationType = TableCellLocation::class;
protected $tableCellLocationDataType = '';
/**
* Whether to insert new column to the right of the reference cell location. -
* `True`: insert to the right. - `False`: insert to the left.
*
* @param bool $insertRight
*/
public function setInsertRight($insertRight)
{
$this->insertRight = $insertRight;
}
/**
* @return bool
*/
public function getInsertRight()
{
return $this->insertRight;
}
/**
* The reference table cell location from which columns will be inserted. A
* new column will be inserted to the left (or right) of the column where the
* reference cell is. If the reference cell is a merged cell, a new column
* will be inserted to the left (or right) of the merged cell.
*
* @param TableCellLocation $tableCellLocation
*/
public function setTableCellLocation(TableCellLocation $tableCellLocation)
{
$this->tableCellLocation = $tableCellLocation;
}
/**
* @return TableCellLocation
*/
public function getTableCellLocation()
{
return $this->tableCellLocation;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(InsertTableColumnRequest::class, 'Google_Service_Docs_InsertTableColumnRequest');
@@ -0,0 +1,113 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class InsertTableRequest extends \Google\Model
{
/**
* The number of columns in the table.
*
* @var int
*/
public $columns;
protected $endOfSegmentLocationType = EndOfSegmentLocation::class;
protected $endOfSegmentLocationDataType = '';
protected $locationType = Location::class;
protected $locationDataType = '';
/**
* The number of rows in the table.
*
* @var int
*/
public $rows;
/**
* The number of columns in the table.
*
* @param int $columns
*/
public function setColumns($columns)
{
$this->columns = $columns;
}
/**
* @return int
*/
public function getColumns()
{
return $this->columns;
}
/**
* Inserts the table at the end of the given header, footer or document body.
* A newline character will be inserted before the inserted table. Tables
* cannot be inserted inside a footnote.
*
* @param EndOfSegmentLocation $endOfSegmentLocation
*/
public function setEndOfSegmentLocation(EndOfSegmentLocation $endOfSegmentLocation)
{
$this->endOfSegmentLocation = $endOfSegmentLocation;
}
/**
* @return EndOfSegmentLocation
*/
public function getEndOfSegmentLocation()
{
return $this->endOfSegmentLocation;
}
/**
* Inserts the table at a specific model index. A newline character will be
* inserted before the inserted table, therefore the table start index will be
* at the specified location index + 1. The table must be inserted inside the
* bounds of an existing Paragraph. For instance, it cannot be inserted at a
* table's start index (i.e. between an existing table and its preceding
* paragraph). Tables cannot be inserted inside a footnote or equation.
*
* @param Location $location
*/
public function setLocation(Location $location)
{
$this->location = $location;
}
/**
* @return Location
*/
public function getLocation()
{
return $this->location;
}
/**
* The number of rows in the table.
*
* @param int $rows
*/
public function setRows($rows)
{
$this->rows = $rows;
}
/**
* @return int
*/
public function getRows()
{
return $this->rows;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(InsertTableRequest::class, 'Google_Service_Docs_InsertTableRequest');
@@ -0,0 +1,71 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class InsertTableRowRequest extends \Google\Model
{
/**
* Whether to insert new row below the reference cell location. - `True`:
* insert below the cell. - `False`: insert above the cell.
*
* @var bool
*/
public $insertBelow;
protected $tableCellLocationType = TableCellLocation::class;
protected $tableCellLocationDataType = '';
/**
* Whether to insert new row below the reference cell location. - `True`:
* insert below the cell. - `False`: insert above the cell.
*
* @param bool $insertBelow
*/
public function setInsertBelow($insertBelow)
{
$this->insertBelow = $insertBelow;
}
/**
* @return bool
*/
public function getInsertBelow()
{
return $this->insertBelow;
}
/**
* The reference table cell location from which rows will be inserted. A new
* row will be inserted above (or below) the row where the reference cell is.
* If the reference cell is a merged cell, a new row will be inserted above
* (or below) the merged cell.
*
* @param TableCellLocation $tableCellLocation
*/
public function setTableCellLocation(TableCellLocation $tableCellLocation)
{
$this->tableCellLocation = $tableCellLocation;
}
/**
* @return TableCellLocation
*/
public function getTableCellLocation()
{
return $this->tableCellLocation;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(InsertTableRowRequest::class, 'Google_Service_Docs_InsertTableRowRequest');
@@ -0,0 +1,106 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class InsertTextRequest extends \Google\Model
{
protected $endOfSegmentLocationType = EndOfSegmentLocation::class;
protected $endOfSegmentLocationDataType = '';
protected $locationType = Location::class;
protected $locationDataType = '';
/**
* The text to be inserted. Inserting a newline character will implicitly
* create a new Paragraph at that index. The paragraph style of the new
* paragraph will be copied from the paragraph at the current insertion index,
* including lists and bullets. Text styles for inserted text will be
* determined automatically, generally preserving the styling of neighboring
* text. In most cases, the text style for the inserted text will match the
* text immediately before the insertion index. Some control characters
* (U+0000-U+0008, U+000C-U+001F) and characters from the Unicode Basic
* Multilingual Plane Private Use Area (U+E000-U+F8FF) will be stripped out of
* the inserted text.
*
* @var string
*/
public $text;
/**
* Inserts the text at the end of a header, footer, footnote or the document
* body.
*
* @param EndOfSegmentLocation $endOfSegmentLocation
*/
public function setEndOfSegmentLocation(EndOfSegmentLocation $endOfSegmentLocation)
{
$this->endOfSegmentLocation = $endOfSegmentLocation;
}
/**
* @return EndOfSegmentLocation
*/
public function getEndOfSegmentLocation()
{
return $this->endOfSegmentLocation;
}
/**
* Inserts the text at a specific index in the document. Text must be inserted
* inside the bounds of an existing Paragraph. For instance, text cannot be
* inserted at a table's start index (i.e. between the table and its preceding
* paragraph). The text must be inserted in the preceding paragraph.
*
* @param Location $location
*/
public function setLocation(Location $location)
{
$this->location = $location;
}
/**
* @return Location
*/
public function getLocation()
{
return $this->location;
}
/**
* The text to be inserted. Inserting a newline character will implicitly
* create a new Paragraph at that index. The paragraph style of the new
* paragraph will be copied from the paragraph at the current insertion index,
* including lists and bullets. Text styles for inserted text will be
* determined automatically, generally preserving the styling of neighboring
* text. In most cases, the text style for the inserted text will match the
* text immediately before the insertion index. Some control characters
* (U+0000-U+0008, U+000C-U+001F) and characters from the Unicode Basic
* Multilingual Plane Private Use Area (U+E000-U+F8FF) will be stripped out of
* the inserted text.
*
* @param string $text
*/
public function setText($text)
{
$this->text = $text;
}
/**
* @return string
*/
public function getText()
{
return $this->text;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(InsertTextRequest::class, 'Google_Service_Docs_InsertTextRequest');
+184
View File
@@ -0,0 +1,184 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class Link extends \Google\Model
{
protected $bookmarkType = BookmarkLink::class;
protected $bookmarkDataType = '';
/**
* The ID of a bookmark in this document. Legacy field: Instead, set
* includeTabsContent to `true` and use Link.bookmark for read and write
* operations. This field is only returned when includeTabsContent is set to
* `false` in documents containing a single tab and links to a bookmark within
* the singular tab. Otherwise, Link.bookmark is returned. If this field is
* used in a write request, the bookmark is considered to be from the tab ID
* specified in the request. If a tab ID is not specified in the request, it
* is considered to be from the first tab in the document.
*
* @var string
*/
public $bookmarkId;
protected $headingType = HeadingLink::class;
protected $headingDataType = '';
/**
* The ID of a heading in this document. Legacy field: Instead, set
* includeTabsContent to `true` and use Link.heading for read and write
* operations. This field is only returned when includeTabsContent is set to
* `false` in documents containing a single tab and links to a heading within
* the singular tab. Otherwise, Link.heading is returned. If this field is
* used in a write request, the heading is considered to be from the tab ID
* specified in the request. If a tab ID is not specified in the request, it
* is considered to be from the first tab in the document.
*
* @var string
*/
public $headingId;
/**
* The ID of a tab in this document.
*
* @var string
*/
public $tabId;
/**
* An external URL.
*
* @var string
*/
public $url;
/**
* A bookmark in this document. In documents containing a single tab, links to
* bookmarks within the singular tab continue to return Link.bookmarkId when
* the includeTabsContent parameter is set to `false` or unset. Otherwise,
* this field is returned.
*
* @param BookmarkLink $bookmark
*/
public function setBookmark(BookmarkLink $bookmark)
{
$this->bookmark = $bookmark;
}
/**
* @return BookmarkLink
*/
public function getBookmark()
{
return $this->bookmark;
}
/**
* The ID of a bookmark in this document. Legacy field: Instead, set
* includeTabsContent to `true` and use Link.bookmark for read and write
* operations. This field is only returned when includeTabsContent is set to
* `false` in documents containing a single tab and links to a bookmark within
* the singular tab. Otherwise, Link.bookmark is returned. If this field is
* used in a write request, the bookmark is considered to be from the tab ID
* specified in the request. If a tab ID is not specified in the request, it
* is considered to be from the first tab in the document.
*
* @param string $bookmarkId
*/
public function setBookmarkId($bookmarkId)
{
$this->bookmarkId = $bookmarkId;
}
/**
* @return string
*/
public function getBookmarkId()
{
return $this->bookmarkId;
}
/**
* A heading in this document. In documents containing a single tab, links to
* headings within the singular tab continue to return Link.headingId when the
* includeTabsContent parameter is set to `false` or unset. Otherwise, this
* field is returned.
*
* @param HeadingLink $heading
*/
public function setHeading(HeadingLink $heading)
{
$this->heading = $heading;
}
/**
* @return HeadingLink
*/
public function getHeading()
{
return $this->heading;
}
/**
* The ID of a heading in this document. Legacy field: Instead, set
* includeTabsContent to `true` and use Link.heading for read and write
* operations. This field is only returned when includeTabsContent is set to
* `false` in documents containing a single tab and links to a heading within
* the singular tab. Otherwise, Link.heading is returned. If this field is
* used in a write request, the heading is considered to be from the tab ID
* specified in the request. If a tab ID is not specified in the request, it
* is considered to be from the first tab in the document.
*
* @param string $headingId
*/
public function setHeadingId($headingId)
{
$this->headingId = $headingId;
}
/**
* @return string
*/
public function getHeadingId()
{
return $this->headingId;
}
/**
* The ID of a tab in this document.
*
* @param string $tabId
*/
public function setTabId($tabId)
{
$this->tabId = $tabId;
}
/**
* @return string
*/
public function getTabId()
{
return $this->tabId;
}
/**
* An external URL.
*
* @param string $url
*/
public function setUrl($url)
{
$this->url = $url;
}
/**
* @return string
*/
public function getUrl()
{
return $this->url;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Link::class, 'Google_Service_Docs_Link');
@@ -0,0 +1,44 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class LinkedContentReference extends \Google\Model
{
protected $sheetsChartReferenceType = SheetsChartReference::class;
protected $sheetsChartReferenceDataType = '';
/**
* A reference to the linked chart.
*
* @param SheetsChartReference $sheetsChartReference
*/
public function setSheetsChartReference(SheetsChartReference $sheetsChartReference)
{
$this->sheetsChartReference = $sheetsChartReference;
}
/**
* @return SheetsChartReference
*/
public function getSheetsChartReference()
{
return $this->sheetsChartReference;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(LinkedContentReference::class, 'Google_Service_Docs_LinkedContentReference');
@@ -0,0 +1,45 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class LinkedContentReferenceSuggestionState extends \Google\Model
{
protected $sheetsChartReferenceSuggestionStateType = SheetsChartReferenceSuggestionState::class;
protected $sheetsChartReferenceSuggestionStateDataType = '';
/**
* A mask that indicates which of the fields in sheets_chart_reference have
* been changed in this suggestion.
*
* @param SheetsChartReferenceSuggestionState $sheetsChartReferenceSuggestionState
*/
public function setSheetsChartReferenceSuggestionState(SheetsChartReferenceSuggestionState $sheetsChartReferenceSuggestionState)
{
$this->sheetsChartReferenceSuggestionState = $sheetsChartReferenceSuggestionState;
}
/**
* @return SheetsChartReferenceSuggestionState
*/
public function getSheetsChartReferenceSuggestionState()
{
return $this->sheetsChartReferenceSuggestionState;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(LinkedContentReferenceSuggestionState::class, 'Google_Service_Docs_LinkedContentReferenceSuggestionState');
@@ -0,0 +1,49 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class ListProperties extends \Google\Collection
{
protected $collection_key = 'nestingLevels';
protected $nestingLevelsType = NestingLevel::class;
protected $nestingLevelsDataType = 'array';
/**
* Describes the properties of the bullets at the associated level. A list has
* at most 9 levels of nesting with nesting level 0 corresponding to the top-
* most level and nesting level 8 corresponding to the most nested level. The
* nesting levels are returned in ascending order with the least nested
* returned first.
*
* @param NestingLevel[] $nestingLevels
*/
public function setNestingLevels($nestingLevels)
{
$this->nestingLevels = $nestingLevels;
}
/**
* @return NestingLevel[]
*/
public function getNestingLevels()
{
return $this->nestingLevels;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListProperties::class, 'Google_Service_Docs_ListProperties');
@@ -0,0 +1,48 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class ListPropertiesSuggestionState extends \Google\Collection
{
protected $collection_key = 'nestingLevelsSuggestionStates';
protected $nestingLevelsSuggestionStatesType = NestingLevelSuggestionState::class;
protected $nestingLevelsSuggestionStatesDataType = 'array';
/**
* A mask that indicates which of the fields on the corresponding NestingLevel
* in nesting_levels have been changed in this suggestion. The nesting level
* suggestion states are returned in ascending order of the nesting level with
* the least nested returned first.
*
* @param NestingLevelSuggestionState[] $nestingLevelsSuggestionStates
*/
public function setNestingLevelsSuggestionStates($nestingLevelsSuggestionStates)
{
$this->nestingLevelsSuggestionStates = $nestingLevelsSuggestionStates;
}
/**
* @return NestingLevelSuggestionState[]
*/
public function getNestingLevelsSuggestionStates()
{
return $this->nestingLevelsSuggestionStates;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListPropertiesSuggestionState::class, 'Google_Service_Docs_ListPropertiesSuggestionState');
+106
View File
@@ -0,0 +1,106 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class Location extends \Google\Model
{
/**
* The zero-based index, in UTF-16 code units. The index is relative to the
* beginning of the segment specified by segment_id.
*
* @var int
*/
public $index;
/**
* The ID of the header, footer or footnote the location is in. An empty
* segment ID signifies the document's body.
*
* @var string
*/
public $segmentId;
/**
* The tab that the location is in. When omitted, the request is applied to
* the first tab. In a document containing a single tab: - If provided, must
* match the singular tab's ID. - If omitted, the request applies to the
* singular tab. In a document containing multiple tabs: - If provided, the
* request applies to the specified tab. - If omitted, the request applies to
* the first tab in the document.
*
* @var string
*/
public $tabId;
/**
* The zero-based index, in UTF-16 code units. The index is relative to the
* beginning of the segment specified by segment_id.
*
* @param int $index
*/
public function setIndex($index)
{
$this->index = $index;
}
/**
* @return int
*/
public function getIndex()
{
return $this->index;
}
/**
* The ID of the header, footer or footnote the location is in. An empty
* segment ID signifies the document's body.
*
* @param string $segmentId
*/
public function setSegmentId($segmentId)
{
$this->segmentId = $segmentId;
}
/**
* @return string
*/
public function getSegmentId()
{
return $this->segmentId;
}
/**
* The tab that the location is in. When omitted, the request is applied to
* the first tab. In a document containing a single tab: - If provided, must
* match the singular tab's ID. - If omitted, the request applies to the
* singular tab. In a document containing multiple tabs: - If provided, the
* request applies to the specified tab. - If omitted, the request applies to
* the first tab in the document.
*
* @param string $tabId
*/
public function setTabId($tabId)
{
$this->tabId = $tabId;
}
/**
* @return string
*/
public function getTabId()
{
return $this->tabId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Location::class, 'Google_Service_Docs_Location');
@@ -0,0 +1,50 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class MergeTableCellsRequest extends \Google\Model
{
protected $tableRangeType = TableRange::class;
protected $tableRangeDataType = '';
/**
* The table range specifying which cells of the table to merge. Any text in
* the cells being merged will be concatenated and stored in the "head" cell
* of the range. This is the upper-left cell of the range when the content
* direction is left to right, and the upper-right cell of the range
* otherwise. If the range is non-rectangular (which can occur in some cases
* where the range covers cells that are already merged or where the table is
* non-rectangular), a 400 bad request error is returned.
*
* @param TableRange $tableRange
*/
public function setTableRange(TableRange $tableRange)
{
$this->tableRange = $tableRange;
}
/**
* @return TableRange
*/
public function getTableRange()
{
return $this->tableRange;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(MergeTableCellsRequest::class, 'Google_Service_Docs_MergeTableCellsRequest');
@@ -0,0 +1,89 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class NamedRange extends \Google\Collection
{
protected $collection_key = 'ranges';
/**
* The name of the named range.
*
* @var string
*/
public $name;
/**
* The ID of the named range.
*
* @var string
*/
public $namedRangeId;
protected $rangesType = Range::class;
protected $rangesDataType = 'array';
/**
* The name of the named range.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* The ID of the named range.
*
* @param string $namedRangeId
*/
public function setNamedRangeId($namedRangeId)
{
$this->namedRangeId = $namedRangeId;
}
/**
* @return string
*/
public function getNamedRangeId()
{
return $this->namedRangeId;
}
/**
* The ranges that belong to this named range.
*
* @param Range[] $ranges
*/
public function setRanges($ranges)
{
$this->ranges = $ranges;
}
/**
* @return Range[]
*/
public function getRanges()
{
return $this->ranges;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(NamedRange::class, 'Google_Service_Docs_NamedRange');
@@ -0,0 +1,67 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class NamedRanges extends \Google\Collection
{
protected $collection_key = 'namedRanges';
/**
* The name that all the named ranges share.
*
* @var string
*/
public $name;
protected $namedRangesType = NamedRange::class;
protected $namedRangesDataType = 'array';
/**
* The name that all the named ranges share.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* The NamedRanges that share the same name.
*
* @param NamedRange[] $namedRanges
*/
public function setNamedRanges($namedRanges)
{
$this->namedRanges = $namedRanges;
}
/**
* @return NamedRange[]
*/
public function getNamedRanges()
{
return $this->namedRanges;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(NamedRanges::class, 'Google_Service_Docs_NamedRanges');
+127
View File
@@ -0,0 +1,127 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class NamedStyle extends \Google\Model
{
/**
* The type of named style is unspecified.
*/
public const NAMED_STYLE_TYPE_NAMED_STYLE_TYPE_UNSPECIFIED = 'NAMED_STYLE_TYPE_UNSPECIFIED';
/**
* Normal text.
*/
public const NAMED_STYLE_TYPE_NORMAL_TEXT = 'NORMAL_TEXT';
/**
* Title.
*/
public const NAMED_STYLE_TYPE_TITLE = 'TITLE';
/**
* Subtitle.
*/
public const NAMED_STYLE_TYPE_SUBTITLE = 'SUBTITLE';
/**
* Heading 1.
*/
public const NAMED_STYLE_TYPE_HEADING_1 = 'HEADING_1';
/**
* Heading 2.
*/
public const NAMED_STYLE_TYPE_HEADING_2 = 'HEADING_2';
/**
* Heading 3.
*/
public const NAMED_STYLE_TYPE_HEADING_3 = 'HEADING_3';
/**
* Heading 4.
*/
public const NAMED_STYLE_TYPE_HEADING_4 = 'HEADING_4';
/**
* Heading 5.
*/
public const NAMED_STYLE_TYPE_HEADING_5 = 'HEADING_5';
/**
* Heading 6.
*/
public const NAMED_STYLE_TYPE_HEADING_6 = 'HEADING_6';
/**
* The type of this named style.
*
* @var string
*/
public $namedStyleType;
protected $paragraphStyleType = ParagraphStyle::class;
protected $paragraphStyleDataType = '';
protected $textStyleType = TextStyle::class;
protected $textStyleDataType = '';
/**
* The type of this named style.
*
* Accepted values: NAMED_STYLE_TYPE_UNSPECIFIED, NORMAL_TEXT, TITLE,
* SUBTITLE, HEADING_1, HEADING_2, HEADING_3, HEADING_4, HEADING_5, HEADING_6
*
* @param self::NAMED_STYLE_TYPE_* $namedStyleType
*/
public function setNamedStyleType($namedStyleType)
{
$this->namedStyleType = $namedStyleType;
}
/**
* @return self::NAMED_STYLE_TYPE_*
*/
public function getNamedStyleType()
{
return $this->namedStyleType;
}
/**
* The paragraph style of this named style.
*
* @param ParagraphStyle $paragraphStyle
*/
public function setParagraphStyle(ParagraphStyle $paragraphStyle)
{
$this->paragraphStyle = $paragraphStyle;
}
/**
* @return ParagraphStyle
*/
public function getParagraphStyle()
{
return $this->paragraphStyle;
}
/**
* The text style of this named style.
*
* @param TextStyle $textStyle
*/
public function setTextStyle(TextStyle $textStyle)
{
$this->textStyle = $textStyle;
}
/**
* @return TextStyle
*/
public function getTextStyle()
{
return $this->textStyle;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(NamedStyle::class, 'Google_Service_Docs_NamedStyle');
@@ -0,0 +1,133 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class NamedStyleSuggestionState extends \Google\Model
{
/**
* The type of named style is unspecified.
*/
public const NAMED_STYLE_TYPE_NAMED_STYLE_TYPE_UNSPECIFIED = 'NAMED_STYLE_TYPE_UNSPECIFIED';
/**
* Normal text.
*/
public const NAMED_STYLE_TYPE_NORMAL_TEXT = 'NORMAL_TEXT';
/**
* Title.
*/
public const NAMED_STYLE_TYPE_TITLE = 'TITLE';
/**
* Subtitle.
*/
public const NAMED_STYLE_TYPE_SUBTITLE = 'SUBTITLE';
/**
* Heading 1.
*/
public const NAMED_STYLE_TYPE_HEADING_1 = 'HEADING_1';
/**
* Heading 2.
*/
public const NAMED_STYLE_TYPE_HEADING_2 = 'HEADING_2';
/**
* Heading 3.
*/
public const NAMED_STYLE_TYPE_HEADING_3 = 'HEADING_3';
/**
* Heading 4.
*/
public const NAMED_STYLE_TYPE_HEADING_4 = 'HEADING_4';
/**
* Heading 5.
*/
public const NAMED_STYLE_TYPE_HEADING_5 = 'HEADING_5';
/**
* Heading 6.
*/
public const NAMED_STYLE_TYPE_HEADING_6 = 'HEADING_6';
/**
* The named style type that this suggestion state corresponds to. This field
* is provided as a convenience for matching the NamedStyleSuggestionState
* with its corresponding NamedStyle.
*
* @var string
*/
public $namedStyleType;
protected $paragraphStyleSuggestionStateType = ParagraphStyleSuggestionState::class;
protected $paragraphStyleSuggestionStateDataType = '';
protected $textStyleSuggestionStateType = TextStyleSuggestionState::class;
protected $textStyleSuggestionStateDataType = '';
/**
* The named style type that this suggestion state corresponds to. This field
* is provided as a convenience for matching the NamedStyleSuggestionState
* with its corresponding NamedStyle.
*
* Accepted values: NAMED_STYLE_TYPE_UNSPECIFIED, NORMAL_TEXT, TITLE,
* SUBTITLE, HEADING_1, HEADING_2, HEADING_3, HEADING_4, HEADING_5, HEADING_6
*
* @param self::NAMED_STYLE_TYPE_* $namedStyleType
*/
public function setNamedStyleType($namedStyleType)
{
$this->namedStyleType = $namedStyleType;
}
/**
* @return self::NAMED_STYLE_TYPE_*
*/
public function getNamedStyleType()
{
return $this->namedStyleType;
}
/**
* A mask that indicates which of the fields in paragraph style have been
* changed in this suggestion.
*
* @param ParagraphStyleSuggestionState $paragraphStyleSuggestionState
*/
public function setParagraphStyleSuggestionState(ParagraphStyleSuggestionState $paragraphStyleSuggestionState)
{
$this->paragraphStyleSuggestionState = $paragraphStyleSuggestionState;
}
/**
* @return ParagraphStyleSuggestionState
*/
public function getParagraphStyleSuggestionState()
{
return $this->paragraphStyleSuggestionState;
}
/**
* A mask that indicates which of the fields in text style have been changed
* in this suggestion.
*
* @param TextStyleSuggestionState $textStyleSuggestionState
*/
public function setTextStyleSuggestionState(TextStyleSuggestionState $textStyleSuggestionState)
{
$this->textStyleSuggestionState = $textStyleSuggestionState;
}
/**
* @return TextStyleSuggestionState
*/
public function getTextStyleSuggestionState()
{
return $this->textStyleSuggestionState;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(NamedStyleSuggestionState::class, 'Google_Service_Docs_NamedStyleSuggestionState');
@@ -0,0 +1,46 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class NamedStyles extends \Google\Collection
{
protected $collection_key = 'styles';
protected $stylesType = NamedStyle::class;
protected $stylesDataType = 'array';
/**
* The named styles. There's an entry for each of the possible named style
* types.
*
* @param NamedStyle[] $styles
*/
public function setStyles($styles)
{
$this->styles = $styles;
}
/**
* @return NamedStyle[]
*/
public function getStyles()
{
return $this->styles;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(NamedStyles::class, 'Google_Service_Docs_NamedStyles');
@@ -0,0 +1,48 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class NamedStylesSuggestionState extends \Google\Collection
{
protected $collection_key = 'stylesSuggestionStates';
protected $stylesSuggestionStatesType = NamedStyleSuggestionState::class;
protected $stylesSuggestionStatesDataType = 'array';
/**
* A mask that indicates which of the fields on the corresponding NamedStyle
* in styles have been changed in this suggestion. The order of these named
* style suggestion states matches the order of the corresponding named style
* within the named styles suggestion.
*
* @param NamedStyleSuggestionState[] $stylesSuggestionStates
*/
public function setStylesSuggestionStates($stylesSuggestionStates)
{
$this->stylesSuggestionStates = $stylesSuggestionStates;
}
/**
* @return NamedStyleSuggestionState[]
*/
public function getStylesSuggestionStates()
{
return $this->stylesSuggestionStates;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(NamedStylesSuggestionState::class, 'Google_Service_Docs_NamedStylesSuggestionState');
@@ -0,0 +1,317 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class NestingLevel extends \Google\Model
{
/**
* The bullet alignment is unspecified.
*/
public const BULLET_ALIGNMENT_BULLET_ALIGNMENT_UNSPECIFIED = 'BULLET_ALIGNMENT_UNSPECIFIED';
/**
* The bullet is aligned to the start of the space allotted for rendering the
* bullet. Left-aligned for LTR text, right-aligned otherwise.
*/
public const BULLET_ALIGNMENT_START = 'START';
/**
* The bullet is aligned to the center of the space allotted for rendering the
* bullet.
*/
public const BULLET_ALIGNMENT_CENTER = 'CENTER';
/**
* The bullet is aligned to the end of the space allotted for rendering the
* bullet. Right-aligned for LTR text, left-aligned otherwise.
*/
public const BULLET_ALIGNMENT_END = 'END';
/**
* The glyph type is unspecified or unsupported.
*/
public const GLYPH_TYPE_GLYPH_TYPE_UNSPECIFIED = 'GLYPH_TYPE_UNSPECIFIED';
/**
* An empty string.
*/
public const GLYPH_TYPE_NONE = 'NONE';
/**
* A number, like `1`, `2`, or `3`.
*/
public const GLYPH_TYPE_DECIMAL = 'DECIMAL';
/**
* A number where single digit numbers are prefixed with a zero, like `01`,
* `02`, or `03`. Numbers with more than one digit are not prefixed with a
* zero.
*/
public const GLYPH_TYPE_ZERO_DECIMAL = 'ZERO_DECIMAL';
/**
* An uppercase letter, like `A`, `B`, or `C`.
*/
public const GLYPH_TYPE_UPPER_ALPHA = 'UPPER_ALPHA';
/**
* A lowercase letter, like `a`, `b`, or `c`.
*/
public const GLYPH_TYPE_ALPHA = 'ALPHA';
/**
* An uppercase Roman numeral, like `I`, `II`, or `III`.
*/
public const GLYPH_TYPE_UPPER_ROMAN = 'UPPER_ROMAN';
/**
* A lowercase Roman numeral, like `i`, `ii`, or `iii`.
*/
public const GLYPH_TYPE_ROMAN = 'ROMAN';
/**
* The alignment of the bullet within the space allotted for rendering the
* bullet.
*
* @var string
*/
public $bulletAlignment;
/**
* The format string used by bullets at this level of nesting. The glyph
* format contains one or more placeholders, and these placeholders are
* replaced with the appropriate values depending on the glyph_type or
* glyph_symbol. The placeholders follow the pattern `%[nesting_level]`.
* Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph
* format follows the pattern `%[nesting_level]`. Note that the prefix and
* suffix are optional and can be arbitrary strings. For example, the glyph
* format `%0.` indicates that the rendered glyph will replace the placeholder
* with the corresponding glyph for nesting level 0 followed by a period as
* the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format
* `%0.` at nesting level 0 will result in a list with rendered glyphs `A.`
* `B.` `C.` The glyph format can contain placeholders for the current nesting
* level as well as placeholders for parent nesting levels. For example, a
* list can have a glyph format of `%0.` at nesting level 0 and a glyph format
* of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL
* glyph types, this would result in a list with rendered glyphs `1.` `2.` `
* 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that
* replaces a placeholder in the glyph format for a particular paragraph
* depends on the paragraph's order within the list.
*
* @var string
*/
public $glyphFormat;
/**
* A custom glyph symbol used by bullets when paragraphs at this level of
* nesting is unordered. The glyph symbol replaces placeholders within the
* glyph_format. For example, if the glyph_symbol is the solid circle
* corresponding to Unicode U+25cf code point and the glyph_format is `%0`,
* the rendered glyph would be the solid circle.
*
* @var string
*/
public $glyphSymbol;
/**
* The type of glyph used by bullets when paragraphs at this level of nesting
* is ordered. The glyph type determines the type of glyph used to replace
* placeholders within the glyph_format when paragraphs at this level of
* nesting are ordered. For example, if the nesting level is 0, the
* glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered
* glyph would replace the placeholder `%0` in the glyph format with a number
* corresponding to the list item's order within the list.
*
* @var string
*/
public $glyphType;
protected $indentFirstLineType = Dimension::class;
protected $indentFirstLineDataType = '';
protected $indentStartType = Dimension::class;
protected $indentStartDataType = '';
/**
* The number of the first list item at this nesting level. A value of 0 is
* treated as a value of 1 for lettered lists and Roman numeral lists. For
* values of both 0 and 1, lettered and Roman numeral lists will begin at `a`
* and `i` respectively. This value is ignored for nesting levels with
* unordered glyphs.
*
* @var int
*/
public $startNumber;
protected $textStyleType = TextStyle::class;
protected $textStyleDataType = '';
/**
* The alignment of the bullet within the space allotted for rendering the
* bullet.
*
* Accepted values: BULLET_ALIGNMENT_UNSPECIFIED, START, CENTER, END
*
* @param self::BULLET_ALIGNMENT_* $bulletAlignment
*/
public function setBulletAlignment($bulletAlignment)
{
$this->bulletAlignment = $bulletAlignment;
}
/**
* @return self::BULLET_ALIGNMENT_*
*/
public function getBulletAlignment()
{
return $this->bulletAlignment;
}
/**
* The format string used by bullets at this level of nesting. The glyph
* format contains one or more placeholders, and these placeholders are
* replaced with the appropriate values depending on the glyph_type or
* glyph_symbol. The placeholders follow the pattern `%[nesting_level]`.
* Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph
* format follows the pattern `%[nesting_level]`. Note that the prefix and
* suffix are optional and can be arbitrary strings. For example, the glyph
* format `%0.` indicates that the rendered glyph will replace the placeholder
* with the corresponding glyph for nesting level 0 followed by a period as
* the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format
* `%0.` at nesting level 0 will result in a list with rendered glyphs `A.`
* `B.` `C.` The glyph format can contain placeholders for the current nesting
* level as well as placeholders for parent nesting levels. For example, a
* list can have a glyph format of `%0.` at nesting level 0 and a glyph format
* of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL
* glyph types, this would result in a list with rendered glyphs `1.` `2.` `
* 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that
* replaces a placeholder in the glyph format for a particular paragraph
* depends on the paragraph's order within the list.
*
* @param string $glyphFormat
*/
public function setGlyphFormat($glyphFormat)
{
$this->glyphFormat = $glyphFormat;
}
/**
* @return string
*/
public function getGlyphFormat()
{
return $this->glyphFormat;
}
/**
* A custom glyph symbol used by bullets when paragraphs at this level of
* nesting is unordered. The glyph symbol replaces placeholders within the
* glyph_format. For example, if the glyph_symbol is the solid circle
* corresponding to Unicode U+25cf code point and the glyph_format is `%0`,
* the rendered glyph would be the solid circle.
*
* @param string $glyphSymbol
*/
public function setGlyphSymbol($glyphSymbol)
{
$this->glyphSymbol = $glyphSymbol;
}
/**
* @return string
*/
public function getGlyphSymbol()
{
return $this->glyphSymbol;
}
/**
* The type of glyph used by bullets when paragraphs at this level of nesting
* is ordered. The glyph type determines the type of glyph used to replace
* placeholders within the glyph_format when paragraphs at this level of
* nesting are ordered. For example, if the nesting level is 0, the
* glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered
* glyph would replace the placeholder `%0` in the glyph format with a number
* corresponding to the list item's order within the list.
*
* Accepted values: GLYPH_TYPE_UNSPECIFIED, NONE, DECIMAL, ZERO_DECIMAL,
* UPPER_ALPHA, ALPHA, UPPER_ROMAN, ROMAN
*
* @param self::GLYPH_TYPE_* $glyphType
*/
public function setGlyphType($glyphType)
{
$this->glyphType = $glyphType;
}
/**
* @return self::GLYPH_TYPE_*
*/
public function getGlyphType()
{
return $this->glyphType;
}
/**
* The amount of indentation for the first line of paragraphs at this level of
* nesting.
*
* @param Dimension $indentFirstLine
*/
public function setIndentFirstLine(Dimension $indentFirstLine)
{
$this->indentFirstLine = $indentFirstLine;
}
/**
* @return Dimension
*/
public function getIndentFirstLine()
{
return $this->indentFirstLine;
}
/**
* The amount of indentation for paragraphs at this level of nesting. Applied
* to the side that corresponds to the start of the text, based on the
* paragraph's content direction.
*
* @param Dimension $indentStart
*/
public function setIndentStart(Dimension $indentStart)
{
$this->indentStart = $indentStart;
}
/**
* @return Dimension
*/
public function getIndentStart()
{
return $this->indentStart;
}
/**
* The number of the first list item at this nesting level. A value of 0 is
* treated as a value of 1 for lettered lists and Roman numeral lists. For
* values of both 0 and 1, lettered and Roman numeral lists will begin at `a`
* and `i` respectively. This value is ignored for nesting levels with
* unordered glyphs.
*
* @param int $startNumber
*/
public function setStartNumber($startNumber)
{
$this->startNumber = $startNumber;
}
/**
* @return int
*/
public function getStartNumber()
{
return $this->startNumber;
}
/**
* The text style of bullets at this level of nesting.
*
* @param TextStyle $textStyle
*/
public function setTextStyle(TextStyle $textStyle)
{
$this->textStyle = $textStyle;
}
/**
* @return TextStyle
*/
public function getTextStyle()
{
return $this->textStyle;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(NestingLevel::class, 'Google_Service_Docs_NestingLevel');
@@ -0,0 +1,199 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class NestingLevelSuggestionState extends \Google\Model
{
/**
* Indicates if there was a suggested change to bullet_alignment.
*
* @var bool
*/
public $bulletAlignmentSuggested;
/**
* Indicates if there was a suggested change to glyph_format.
*
* @var bool
*/
public $glyphFormatSuggested;
/**
* Indicates if there was a suggested change to glyph_symbol.
*
* @var bool
*/
public $glyphSymbolSuggested;
/**
* Indicates if there was a suggested change to glyph_type.
*
* @var bool
*/
public $glyphTypeSuggested;
/**
* Indicates if there was a suggested change to indent_first_line.
*
* @var bool
*/
public $indentFirstLineSuggested;
/**
* Indicates if there was a suggested change to indent_start.
*
* @var bool
*/
public $indentStartSuggested;
/**
* Indicates if there was a suggested change to start_number.
*
* @var bool
*/
public $startNumberSuggested;
protected $textStyleSuggestionStateType = TextStyleSuggestionState::class;
protected $textStyleSuggestionStateDataType = '';
/**
* Indicates if there was a suggested change to bullet_alignment.
*
* @param bool $bulletAlignmentSuggested
*/
public function setBulletAlignmentSuggested($bulletAlignmentSuggested)
{
$this->bulletAlignmentSuggested = $bulletAlignmentSuggested;
}
/**
* @return bool
*/
public function getBulletAlignmentSuggested()
{
return $this->bulletAlignmentSuggested;
}
/**
* Indicates if there was a suggested change to glyph_format.
*
* @param bool $glyphFormatSuggested
*/
public function setGlyphFormatSuggested($glyphFormatSuggested)
{
$this->glyphFormatSuggested = $glyphFormatSuggested;
}
/**
* @return bool
*/
public function getGlyphFormatSuggested()
{
return $this->glyphFormatSuggested;
}
/**
* Indicates if there was a suggested change to glyph_symbol.
*
* @param bool $glyphSymbolSuggested
*/
public function setGlyphSymbolSuggested($glyphSymbolSuggested)
{
$this->glyphSymbolSuggested = $glyphSymbolSuggested;
}
/**
* @return bool
*/
public function getGlyphSymbolSuggested()
{
return $this->glyphSymbolSuggested;
}
/**
* Indicates if there was a suggested change to glyph_type.
*
* @param bool $glyphTypeSuggested
*/
public function setGlyphTypeSuggested($glyphTypeSuggested)
{
$this->glyphTypeSuggested = $glyphTypeSuggested;
}
/**
* @return bool
*/
public function getGlyphTypeSuggested()
{
return $this->glyphTypeSuggested;
}
/**
* Indicates if there was a suggested change to indent_first_line.
*
* @param bool $indentFirstLineSuggested
*/
public function setIndentFirstLineSuggested($indentFirstLineSuggested)
{
$this->indentFirstLineSuggested = $indentFirstLineSuggested;
}
/**
* @return bool
*/
public function getIndentFirstLineSuggested()
{
return $this->indentFirstLineSuggested;
}
/**
* Indicates if there was a suggested change to indent_start.
*
* @param bool $indentStartSuggested
*/
public function setIndentStartSuggested($indentStartSuggested)
{
$this->indentStartSuggested = $indentStartSuggested;
}
/**
* @return bool
*/
public function getIndentStartSuggested()
{
return $this->indentStartSuggested;
}
/**
* Indicates if there was a suggested change to start_number.
*
* @param bool $startNumberSuggested
*/
public function setStartNumberSuggested($startNumberSuggested)
{
$this->startNumberSuggested = $startNumberSuggested;
}
/**
* @return bool
*/
public function getStartNumberSuggested()
{
return $this->startNumberSuggested;
}
/**
* A mask that indicates which of the fields in text style have been changed
* in this suggestion.
*
* @param TextStyleSuggestionState $textStyleSuggestionState
*/
public function setTextStyleSuggestionState(TextStyleSuggestionState $textStyleSuggestionState)
{
$this->textStyleSuggestionState = $textStyleSuggestionState;
}
/**
* @return TextStyleSuggestionState
*/
public function getTextStyleSuggestionState()
{
return $this->textStyleSuggestionState;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(NestingLevelSuggestionState::class, 'Google_Service_Docs_NestingLevelSuggestionState');
@@ -0,0 +1,49 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class ObjectReferences extends \Google\Collection
{
protected $collection_key = 'objectIds';
/**
* The object IDs.
*
* @var string[]
*/
public $objectIds;
/**
* The object IDs.
*
* @param string[] $objectIds
*/
public function setObjectIds($objectIds)
{
$this->objectIds = $objectIds;
}
/**
* @return string[]
*/
public function getObjectIds()
{
return $this->objectIds;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ObjectReferences::class, 'Google_Service_Docs_ObjectReferences');
@@ -0,0 +1,45 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class OptionalColor extends \Google\Model
{
protected $colorType = Color::class;
protected $colorDataType = '';
/**
* If set, this will be used as an opaque color. If unset, this represents a
* transparent color.
*
* @param Color $color
*/
public function setColor(Color $color)
{
$this->color = $color;
}
/**
* @return Color
*/
public function getColor()
{
return $this->color;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(OptionalColor::class, 'Google_Service_Docs_OptionalColor');
+115
View File
@@ -0,0 +1,115 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class PageBreak extends \Google\Collection
{
protected $collection_key = 'suggestedInsertionIds';
/**
* The suggested deletion IDs. If empty, then there are no suggested deletions
* of this content.
*
* @var string[]
*/
public $suggestedDeletionIds;
/**
* The suggested insertion IDs. A PageBreak may have multiple insertion IDs if
* it's a nested suggested change. If empty, then this is not a suggested
* insertion.
*
* @var string[]
*/
public $suggestedInsertionIds;
protected $suggestedTextStyleChangesType = SuggestedTextStyle::class;
protected $suggestedTextStyleChangesDataType = 'map';
protected $textStyleType = TextStyle::class;
protected $textStyleDataType = '';
/**
* The suggested deletion IDs. If empty, then there are no suggested deletions
* of this content.
*
* @param string[] $suggestedDeletionIds
*/
public function setSuggestedDeletionIds($suggestedDeletionIds)
{
$this->suggestedDeletionIds = $suggestedDeletionIds;
}
/**
* @return string[]
*/
public function getSuggestedDeletionIds()
{
return $this->suggestedDeletionIds;
}
/**
* The suggested insertion IDs. A PageBreak may have multiple insertion IDs if
* it's a nested suggested change. If empty, then this is not a suggested
* insertion.
*
* @param string[] $suggestedInsertionIds
*/
public function setSuggestedInsertionIds($suggestedInsertionIds)
{
$this->suggestedInsertionIds = $suggestedInsertionIds;
}
/**
* @return string[]
*/
public function getSuggestedInsertionIds()
{
return $this->suggestedInsertionIds;
}
/**
* The suggested text style changes to this PageBreak, keyed by suggestion ID.
*
* @param SuggestedTextStyle[] $suggestedTextStyleChanges
*/
public function setSuggestedTextStyleChanges($suggestedTextStyleChanges)
{
$this->suggestedTextStyleChanges = $suggestedTextStyleChanges;
}
/**
* @return SuggestedTextStyle[]
*/
public function getSuggestedTextStyleChanges()
{
return $this->suggestedTextStyleChanges;
}
/**
* The text style of this PageBreak. Similar to text content, like text runs
* and footnote references, the text style of a page break can affect content
* layout as well as the styling of text inserted next to it.
*
* @param TextStyle $textStyle
*/
public function setTextStyle(TextStyle $textStyle)
{
$this->textStyle = $textStyle;
}
/**
* @return TextStyle
*/
public function getTextStyle()
{
return $this->textStyle;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PageBreak::class, 'Google_Service_Docs_PageBreak');
+160
View File
@@ -0,0 +1,160 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class Paragraph extends \Google\Collection
{
protected $collection_key = 'positionedObjectIds';
protected $bulletType = Bullet::class;
protected $bulletDataType = '';
protected $elementsType = ParagraphElement::class;
protected $elementsDataType = 'array';
protected $paragraphStyleType = ParagraphStyle::class;
protected $paragraphStyleDataType = '';
/**
* The IDs of the positioned objects tethered to this paragraph.
*
* @var string[]
*/
public $positionedObjectIds;
protected $suggestedBulletChangesType = SuggestedBullet::class;
protected $suggestedBulletChangesDataType = 'map';
protected $suggestedParagraphStyleChangesType = SuggestedParagraphStyle::class;
protected $suggestedParagraphStyleChangesDataType = 'map';
protected $suggestedPositionedObjectIdsType = ObjectReferences::class;
protected $suggestedPositionedObjectIdsDataType = 'map';
/**
* The bullet for this paragraph. If not present, the paragraph does not
* belong to a list.
*
* @param Bullet $bullet
*/
public function setBullet(Bullet $bullet)
{
$this->bullet = $bullet;
}
/**
* @return Bullet
*/
public function getBullet()
{
return $this->bullet;
}
/**
* The content of the paragraph, broken down into its component parts.
*
* @param ParagraphElement[] $elements
*/
public function setElements($elements)
{
$this->elements = $elements;
}
/**
* @return ParagraphElement[]
*/
public function getElements()
{
return $this->elements;
}
/**
* The style of this paragraph.
*
* @param ParagraphStyle $paragraphStyle
*/
public function setParagraphStyle(ParagraphStyle $paragraphStyle)
{
$this->paragraphStyle = $paragraphStyle;
}
/**
* @return ParagraphStyle
*/
public function getParagraphStyle()
{
return $this->paragraphStyle;
}
/**
* The IDs of the positioned objects tethered to this paragraph.
*
* @param string[] $positionedObjectIds
*/
public function setPositionedObjectIds($positionedObjectIds)
{
$this->positionedObjectIds = $positionedObjectIds;
}
/**
* @return string[]
*/
public function getPositionedObjectIds()
{
return $this->positionedObjectIds;
}
/**
* The suggested changes to this paragraph's bullet.
*
* @param SuggestedBullet[] $suggestedBulletChanges
*/
public function setSuggestedBulletChanges($suggestedBulletChanges)
{
$this->suggestedBulletChanges = $suggestedBulletChanges;
}
/**
* @return SuggestedBullet[]
*/
public function getSuggestedBulletChanges()
{
return $this->suggestedBulletChanges;
}
/**
* The suggested paragraph style changes to this paragraph, keyed by
* suggestion ID.
*
* @param SuggestedParagraphStyle[] $suggestedParagraphStyleChanges
*/
public function setSuggestedParagraphStyleChanges($suggestedParagraphStyleChanges)
{
$this->suggestedParagraphStyleChanges = $suggestedParagraphStyleChanges;
}
/**
* @return SuggestedParagraphStyle[]
*/
public function getSuggestedParagraphStyleChanges()
{
return $this->suggestedParagraphStyleChanges;
}
/**
* The IDs of the positioned objects suggested to be attached to this
* paragraph, keyed by suggestion ID.
*
* @param ObjectReferences[] $suggestedPositionedObjectIds
*/
public function setSuggestedPositionedObjectIds($suggestedPositionedObjectIds)
{
$this->suggestedPositionedObjectIds = $suggestedPositionedObjectIds;
}
/**
* @return ObjectReferences[]
*/
public function getSuggestedPositionedObjectIds()
{
return $this->suggestedPositionedObjectIds;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Paragraph::class, 'Google_Service_Docs_Paragraph');
@@ -0,0 +1,121 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class ParagraphBorder extends \Google\Model
{
/**
* Unspecified dash style.
*/
public const DASH_STYLE_DASH_STYLE_UNSPECIFIED = 'DASH_STYLE_UNSPECIFIED';
/**
* Solid line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'solid'.
* This is the default dash style.
*/
public const DASH_STYLE_SOLID = 'SOLID';
/**
* Dotted line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dot'.
*/
public const DASH_STYLE_DOT = 'DOT';
/**
* Dashed line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dash'.
*/
public const DASH_STYLE_DASH = 'DASH';
protected $colorType = OptionalColor::class;
protected $colorDataType = '';
/**
* The dash style of the border.
*
* @var string
*/
public $dashStyle;
protected $paddingType = Dimension::class;
protected $paddingDataType = '';
protected $widthType = Dimension::class;
protected $widthDataType = '';
/**
* The color of the border.
*
* @param OptionalColor $color
*/
public function setColor(OptionalColor $color)
{
$this->color = $color;
}
/**
* @return OptionalColor
*/
public function getColor()
{
return $this->color;
}
/**
* The dash style of the border.
*
* Accepted values: DASH_STYLE_UNSPECIFIED, SOLID, DOT, DASH
*
* @param self::DASH_STYLE_* $dashStyle
*/
public function setDashStyle($dashStyle)
{
$this->dashStyle = $dashStyle;
}
/**
* @return self::DASH_STYLE_*
*/
public function getDashStyle()
{
return $this->dashStyle;
}
/**
* The padding of the border.
*
* @param Dimension $padding
*/
public function setPadding(Dimension $padding)
{
$this->padding = $padding;
}
/**
* @return Dimension
*/
public function getPadding()
{
return $this->padding;
}
/**
* The width of the border.
*
* @param Dimension $width
*/
public function setWidth(Dimension $width)
{
$this->width = $width;
}
/**
* @return Dimension
*/
public function getWidth()
{
return $this->width;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ParagraphBorder::class, 'Google_Service_Docs_ParagraphBorder');
@@ -0,0 +1,271 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class ParagraphElement extends \Google\Model
{
protected $autoTextType = AutoText::class;
protected $autoTextDataType = '';
protected $columnBreakType = ColumnBreak::class;
protected $columnBreakDataType = '';
protected $dateElementType = DateElement::class;
protected $dateElementDataType = '';
/**
* The zero-base end index of this paragraph element, exclusive, in UTF-16
* code units.
*
* @var int
*/
public $endIndex;
protected $equationType = Equation::class;
protected $equationDataType = '';
protected $footnoteReferenceType = FootnoteReference::class;
protected $footnoteReferenceDataType = '';
protected $horizontalRuleType = HorizontalRule::class;
protected $horizontalRuleDataType = '';
protected $inlineObjectElementType = InlineObjectElement::class;
protected $inlineObjectElementDataType = '';
protected $pageBreakType = PageBreak::class;
protected $pageBreakDataType = '';
protected $personType = Person::class;
protected $personDataType = '';
protected $richLinkType = RichLink::class;
protected $richLinkDataType = '';
/**
* The zero-based start index of this paragraph element, in UTF-16 code units.
*
* @var int
*/
public $startIndex;
protected $textRunType = TextRun::class;
protected $textRunDataType = '';
/**
* An auto text paragraph element.
*
* @param AutoText $autoText
*/
public function setAutoText(AutoText $autoText)
{
$this->autoText = $autoText;
}
/**
* @return AutoText
*/
public function getAutoText()
{
return $this->autoText;
}
/**
* A column break paragraph element.
*
* @param ColumnBreak $columnBreak
*/
public function setColumnBreak(ColumnBreak $columnBreak)
{
$this->columnBreak = $columnBreak;
}
/**
* @return ColumnBreak
*/
public function getColumnBreak()
{
return $this->columnBreak;
}
/**
* A paragraph element that represents a date.
*
* @param DateElement $dateElement
*/
public function setDateElement(DateElement $dateElement)
{
$this->dateElement = $dateElement;
}
/**
* @return DateElement
*/
public function getDateElement()
{
return $this->dateElement;
}
/**
* The zero-base end index of this paragraph element, exclusive, in UTF-16
* code units.
*
* @param int $endIndex
*/
public function setEndIndex($endIndex)
{
$this->endIndex = $endIndex;
}
/**
* @return int
*/
public function getEndIndex()
{
return $this->endIndex;
}
/**
* An equation paragraph element.
*
* @param Equation $equation
*/
public function setEquation(Equation $equation)
{
$this->equation = $equation;
}
/**
* @return Equation
*/
public function getEquation()
{
return $this->equation;
}
/**
* A footnote reference paragraph element.
*
* @param FootnoteReference $footnoteReference
*/
public function setFootnoteReference(FootnoteReference $footnoteReference)
{
$this->footnoteReference = $footnoteReference;
}
/**
* @return FootnoteReference
*/
public function getFootnoteReference()
{
return $this->footnoteReference;
}
/**
* A horizontal rule paragraph element.
*
* @param HorizontalRule $horizontalRule
*/
public function setHorizontalRule(HorizontalRule $horizontalRule)
{
$this->horizontalRule = $horizontalRule;
}
/**
* @return HorizontalRule
*/
public function getHorizontalRule()
{
return $this->horizontalRule;
}
/**
* An inline object paragraph element.
*
* @param InlineObjectElement $inlineObjectElement
*/
public function setInlineObjectElement(InlineObjectElement $inlineObjectElement)
{
$this->inlineObjectElement = $inlineObjectElement;
}
/**
* @return InlineObjectElement
*/
public function getInlineObjectElement()
{
return $this->inlineObjectElement;
}
/**
* A page break paragraph element.
*
* @param PageBreak $pageBreak
*/
public function setPageBreak(PageBreak $pageBreak)
{
$this->pageBreak = $pageBreak;
}
/**
* @return PageBreak
*/
public function getPageBreak()
{
return $this->pageBreak;
}
/**
* A paragraph element that links to a person or email address.
*
* @param Person $person
*/
public function setPerson(Person $person)
{
$this->person = $person;
}
/**
* @return Person
*/
public function getPerson()
{
return $this->person;
}
/**
* A paragraph element that links to a Google resource (such as a file in
* Google Drive, a YouTube video, or a Calendar event.)
*
* @param RichLink $richLink
*/
public function setRichLink(RichLink $richLink)
{
$this->richLink = $richLink;
}
/**
* @return RichLink
*/
public function getRichLink()
{
return $this->richLink;
}
/**
* The zero-based start index of this paragraph element, in UTF-16 code units.
*
* @param int $startIndex
*/
public function setStartIndex($startIndex)
{
$this->startIndex = $startIndex;
}
/**
* @return int
*/
public function getStartIndex()
{
return $this->startIndex;
}
/**
* A text run paragraph element.
*
* @param TextRun $textRun
*/
public function setTextRun(TextRun $textRun)
{
$this->textRun = $textRun;
}
/**
* @return TextRun
*/
public function getTextRun()
{
return $this->textRun;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ParagraphElement::class, 'Google_Service_Docs_ParagraphElement');
@@ -0,0 +1,612 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class ParagraphStyle extends \Google\Collection
{
/**
* The paragraph alignment is inherited from the parent.
*/
public const ALIGNMENT_ALIGNMENT_UNSPECIFIED = 'ALIGNMENT_UNSPECIFIED';
/**
* The paragraph is aligned to the start of the line. Left-aligned for LTR
* text, right-aligned otherwise.
*/
public const ALIGNMENT_START = 'START';
/**
* The paragraph is centered.
*/
public const ALIGNMENT_CENTER = 'CENTER';
/**
* The paragraph is aligned to the end of the line. Right-aligned for LTR
* text, left-aligned otherwise.
*/
public const ALIGNMENT_END = 'END';
/**
* The paragraph is justified.
*/
public const ALIGNMENT_JUSTIFIED = 'JUSTIFIED';
/**
* The content direction is unspecified.
*/
public const DIRECTION_CONTENT_DIRECTION_UNSPECIFIED = 'CONTENT_DIRECTION_UNSPECIFIED';
/**
* The content goes from left to right.
*/
public const DIRECTION_LEFT_TO_RIGHT = 'LEFT_TO_RIGHT';
/**
* The content goes from right to left.
*/
public const DIRECTION_RIGHT_TO_LEFT = 'RIGHT_TO_LEFT';
/**
* The type of named style is unspecified.
*/
public const NAMED_STYLE_TYPE_NAMED_STYLE_TYPE_UNSPECIFIED = 'NAMED_STYLE_TYPE_UNSPECIFIED';
/**
* Normal text.
*/
public const NAMED_STYLE_TYPE_NORMAL_TEXT = 'NORMAL_TEXT';
/**
* Title.
*/
public const NAMED_STYLE_TYPE_TITLE = 'TITLE';
/**
* Subtitle.
*/
public const NAMED_STYLE_TYPE_SUBTITLE = 'SUBTITLE';
/**
* Heading 1.
*/
public const NAMED_STYLE_TYPE_HEADING_1 = 'HEADING_1';
/**
* Heading 2.
*/
public const NAMED_STYLE_TYPE_HEADING_2 = 'HEADING_2';
/**
* Heading 3.
*/
public const NAMED_STYLE_TYPE_HEADING_3 = 'HEADING_3';
/**
* Heading 4.
*/
public const NAMED_STYLE_TYPE_HEADING_4 = 'HEADING_4';
/**
* Heading 5.
*/
public const NAMED_STYLE_TYPE_HEADING_5 = 'HEADING_5';
/**
* Heading 6.
*/
public const NAMED_STYLE_TYPE_HEADING_6 = 'HEADING_6';
/**
* The spacing mode is inherited from the parent.
*/
public const SPACING_MODE_SPACING_MODE_UNSPECIFIED = 'SPACING_MODE_UNSPECIFIED';
/**
* Paragraph spacing is always rendered.
*/
public const SPACING_MODE_NEVER_COLLAPSE = 'NEVER_COLLAPSE';
/**
* Paragraph spacing is skipped between list elements.
*/
public const SPACING_MODE_COLLAPSE_LISTS = 'COLLAPSE_LISTS';
protected $collection_key = 'tabStops';
/**
* The text alignment for this paragraph.
*
* @var string
*/
public $alignment;
/**
* Whether to avoid widows and orphans for the paragraph. If unset, the value
* is inherited from the parent.
*
* @var bool
*/
public $avoidWidowAndOrphan;
protected $borderBetweenType = ParagraphBorder::class;
protected $borderBetweenDataType = '';
protected $borderBottomType = ParagraphBorder::class;
protected $borderBottomDataType = '';
protected $borderLeftType = ParagraphBorder::class;
protected $borderLeftDataType = '';
protected $borderRightType = ParagraphBorder::class;
protected $borderRightDataType = '';
protected $borderTopType = ParagraphBorder::class;
protected $borderTopDataType = '';
/**
* The text direction of this paragraph. If unset, the value defaults to
* LEFT_TO_RIGHT since paragraph direction is not inherited.
*
* @var string
*/
public $direction;
/**
* The heading ID of the paragraph. If empty, then this paragraph is not a
* heading. This property is read-only.
*
* @var string
*/
public $headingId;
protected $indentEndType = Dimension::class;
protected $indentEndDataType = '';
protected $indentFirstLineType = Dimension::class;
protected $indentFirstLineDataType = '';
protected $indentStartType = Dimension::class;
protected $indentStartDataType = '';
/**
* Whether all lines of the paragraph should be laid out on the same page or
* column if possible. If unset, the value is inherited from the parent.
*
* @var bool
*/
public $keepLinesTogether;
/**
* Whether at least a part of this paragraph should be laid out on the same
* page or column as the next paragraph if possible. If unset, the value is
* inherited from the parent.
*
* @var bool
*/
public $keepWithNext;
/**
* The amount of space between lines, as a percentage of normal, where normal
* is represented as 100.0. If unset, the value is inherited from the parent.
*
* @var float
*/
public $lineSpacing;
/**
* The named style type of the paragraph. Since updating the named style type
* affects other properties within ParagraphStyle, the named style type is
* applied before the other properties are updated.
*
* @var string
*/
public $namedStyleType;
/**
* Whether the current paragraph should always start at the beginning of a
* page. If unset, the value is inherited from the parent. Attempting to
* update page_break_before for paragraphs in unsupported regions, including
* Table, Header, Footer and Footnote, can result in an invalid document state
* that returns a 400 bad request error.
*
* @var bool
*/
public $pageBreakBefore;
protected $shadingType = Shading::class;
protected $shadingDataType = '';
protected $spaceAboveType = Dimension::class;
protected $spaceAboveDataType = '';
protected $spaceBelowType = Dimension::class;
protected $spaceBelowDataType = '';
/**
* The spacing mode for the paragraph.
*
* @var string
*/
public $spacingMode;
protected $tabStopsType = TabStop::class;
protected $tabStopsDataType = 'array';
/**
* The text alignment for this paragraph.
*
* Accepted values: ALIGNMENT_UNSPECIFIED, START, CENTER, END, JUSTIFIED
*
* @param self::ALIGNMENT_* $alignment
*/
public function setAlignment($alignment)
{
$this->alignment = $alignment;
}
/**
* @return self::ALIGNMENT_*
*/
public function getAlignment()
{
return $this->alignment;
}
/**
* Whether to avoid widows and orphans for the paragraph. If unset, the value
* is inherited from the parent.
*
* @param bool $avoidWidowAndOrphan
*/
public function setAvoidWidowAndOrphan($avoidWidowAndOrphan)
{
$this->avoidWidowAndOrphan = $avoidWidowAndOrphan;
}
/**
* @return bool
*/
public function getAvoidWidowAndOrphan()
{
return $this->avoidWidowAndOrphan;
}
/**
* The border between this paragraph and the next and previous paragraphs. If
* unset, the value is inherited from the parent. The between border is
* rendered when the adjacent paragraph has the same border and indent
* properties. Paragraph borders cannot be partially updated. When changing a
* paragraph border, the new border must be specified in its entirety.
*
* @param ParagraphBorder $borderBetween
*/
public function setBorderBetween(ParagraphBorder $borderBetween)
{
$this->borderBetween = $borderBetween;
}
/**
* @return ParagraphBorder
*/
public function getBorderBetween()
{
return $this->borderBetween;
}
/**
* The border at the bottom of this paragraph. If unset, the value is
* inherited from the parent. The bottom border is rendered when the paragraph
* below has different border and indent properties. Paragraph borders cannot
* be partially updated. When changing a paragraph border, the new border must
* be specified in its entirety.
*
* @param ParagraphBorder $borderBottom
*/
public function setBorderBottom(ParagraphBorder $borderBottom)
{
$this->borderBottom = $borderBottom;
}
/**
* @return ParagraphBorder
*/
public function getBorderBottom()
{
return $this->borderBottom;
}
/**
* The border to the left of this paragraph. If unset, the value is inherited
* from the parent. Paragraph borders cannot be partially updated. When
* changing a paragraph border, the new border must be specified in its
* entirety.
*
* @param ParagraphBorder $borderLeft
*/
public function setBorderLeft(ParagraphBorder $borderLeft)
{
$this->borderLeft = $borderLeft;
}
/**
* @return ParagraphBorder
*/
public function getBorderLeft()
{
return $this->borderLeft;
}
/**
* The border to the right of this paragraph. If unset, the value is inherited
* from the parent. Paragraph borders cannot be partially updated. When
* changing a paragraph border, the new border must be specified in its
* entirety.
*
* @param ParagraphBorder $borderRight
*/
public function setBorderRight(ParagraphBorder $borderRight)
{
$this->borderRight = $borderRight;
}
/**
* @return ParagraphBorder
*/
public function getBorderRight()
{
return $this->borderRight;
}
/**
* The border at the top of this paragraph. If unset, the value is inherited
* from the parent. The top border is rendered when the paragraph above has
* different border and indent properties. Paragraph borders cannot be
* partially updated. When changing a paragraph border, the new border must be
* specified in its entirety.
*
* @param ParagraphBorder $borderTop
*/
public function setBorderTop(ParagraphBorder $borderTop)
{
$this->borderTop = $borderTop;
}
/**
* @return ParagraphBorder
*/
public function getBorderTop()
{
return $this->borderTop;
}
/**
* The text direction of this paragraph. If unset, the value defaults to
* LEFT_TO_RIGHT since paragraph direction is not inherited.
*
* Accepted values: CONTENT_DIRECTION_UNSPECIFIED, LEFT_TO_RIGHT,
* RIGHT_TO_LEFT
*
* @param self::DIRECTION_* $direction
*/
public function setDirection($direction)
{
$this->direction = $direction;
}
/**
* @return self::DIRECTION_*
*/
public function getDirection()
{
return $this->direction;
}
/**
* The heading ID of the paragraph. If empty, then this paragraph is not a
* heading. This property is read-only.
*
* @param string $headingId
*/
public function setHeadingId($headingId)
{
$this->headingId = $headingId;
}
/**
* @return string
*/
public function getHeadingId()
{
return $this->headingId;
}
/**
* The amount of indentation for the paragraph on the side that corresponds to
* the end of the text, based on the current paragraph direction. If unset,
* the value is inherited from the parent.
*
* @param Dimension $indentEnd
*/
public function setIndentEnd(Dimension $indentEnd)
{
$this->indentEnd = $indentEnd;
}
/**
* @return Dimension
*/
public function getIndentEnd()
{
return $this->indentEnd;
}
/**
* The amount of indentation for the first line of the paragraph. If unset,
* the value is inherited from the parent.
*
* @param Dimension $indentFirstLine
*/
public function setIndentFirstLine(Dimension $indentFirstLine)
{
$this->indentFirstLine = $indentFirstLine;
}
/**
* @return Dimension
*/
public function getIndentFirstLine()
{
return $this->indentFirstLine;
}
/**
* The amount of indentation for the paragraph on the side that corresponds to
* the start of the text, based on the current paragraph direction. If unset,
* the value is inherited from the parent.
*
* @param Dimension $indentStart
*/
public function setIndentStart(Dimension $indentStart)
{
$this->indentStart = $indentStart;
}
/**
* @return Dimension
*/
public function getIndentStart()
{
return $this->indentStart;
}
/**
* Whether all lines of the paragraph should be laid out on the same page or
* column if possible. If unset, the value is inherited from the parent.
*
* @param bool $keepLinesTogether
*/
public function setKeepLinesTogether($keepLinesTogether)
{
$this->keepLinesTogether = $keepLinesTogether;
}
/**
* @return bool
*/
public function getKeepLinesTogether()
{
return $this->keepLinesTogether;
}
/**
* Whether at least a part of this paragraph should be laid out on the same
* page or column as the next paragraph if possible. If unset, the value is
* inherited from the parent.
*
* @param bool $keepWithNext
*/
public function setKeepWithNext($keepWithNext)
{
$this->keepWithNext = $keepWithNext;
}
/**
* @return bool
*/
public function getKeepWithNext()
{
return $this->keepWithNext;
}
/**
* The amount of space between lines, as a percentage of normal, where normal
* is represented as 100.0. If unset, the value is inherited from the parent.
*
* @param float $lineSpacing
*/
public function setLineSpacing($lineSpacing)
{
$this->lineSpacing = $lineSpacing;
}
/**
* @return float
*/
public function getLineSpacing()
{
return $this->lineSpacing;
}
/**
* The named style type of the paragraph. Since updating the named style type
* affects other properties within ParagraphStyle, the named style type is
* applied before the other properties are updated.
*
* Accepted values: NAMED_STYLE_TYPE_UNSPECIFIED, NORMAL_TEXT, TITLE,
* SUBTITLE, HEADING_1, HEADING_2, HEADING_3, HEADING_4, HEADING_5, HEADING_6
*
* @param self::NAMED_STYLE_TYPE_* $namedStyleType
*/
public function setNamedStyleType($namedStyleType)
{
$this->namedStyleType = $namedStyleType;
}
/**
* @return self::NAMED_STYLE_TYPE_*
*/
public function getNamedStyleType()
{
return $this->namedStyleType;
}
/**
* Whether the current paragraph should always start at the beginning of a
* page. If unset, the value is inherited from the parent. Attempting to
* update page_break_before for paragraphs in unsupported regions, including
* Table, Header, Footer and Footnote, can result in an invalid document state
* that returns a 400 bad request error.
*
* @param bool $pageBreakBefore
*/
public function setPageBreakBefore($pageBreakBefore)
{
$this->pageBreakBefore = $pageBreakBefore;
}
/**
* @return bool
*/
public function getPageBreakBefore()
{
return $this->pageBreakBefore;
}
/**
* The shading of the paragraph. If unset, the value is inherited from the
* parent.
*
* @param Shading $shading
*/
public function setShading(Shading $shading)
{
$this->shading = $shading;
}
/**
* @return Shading
*/
public function getShading()
{
return $this->shading;
}
/**
* The amount of extra space above the paragraph. If unset, the value is
* inherited from the parent.
*
* @param Dimension $spaceAbove
*/
public function setSpaceAbove(Dimension $spaceAbove)
{
$this->spaceAbove = $spaceAbove;
}
/**
* @return Dimension
*/
public function getSpaceAbove()
{
return $this->spaceAbove;
}
/**
* The amount of extra space below the paragraph. If unset, the value is
* inherited from the parent.
*
* @param Dimension $spaceBelow
*/
public function setSpaceBelow(Dimension $spaceBelow)
{
$this->spaceBelow = $spaceBelow;
}
/**
* @return Dimension
*/
public function getSpaceBelow()
{
return $this->spaceBelow;
}
/**
* The spacing mode for the paragraph.
*
* Accepted values: SPACING_MODE_UNSPECIFIED, NEVER_COLLAPSE, COLLAPSE_LISTS
*
* @param self::SPACING_MODE_* $spacingMode
*/
public function setSpacingMode($spacingMode)
{
$this->spacingMode = $spacingMode;
}
/**
* @return self::SPACING_MODE_*
*/
public function getSpacingMode()
{
return $this->spacingMode;
}
/**
* A list of the tab stops for this paragraph. The list of tab stops is not
* inherited. This property is read-only.
*
* @param TabStop[] $tabStops
*/
public function setTabStops($tabStops)
{
$this->tabStops = $tabStops;
}
/**
* @return TabStop[]
*/
public function getTabStops()
{
return $this->tabStops;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ParagraphStyle::class, 'Google_Service_Docs_ParagraphStyle');
@@ -0,0 +1,485 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class ParagraphStyleSuggestionState extends \Google\Model
{
/**
* Indicates if there was a suggested change to alignment.
*
* @var bool
*/
public $alignmentSuggested;
/**
* Indicates if there was a suggested change to avoid_widow_and_orphan.
*
* @var bool
*/
public $avoidWidowAndOrphanSuggested;
/**
* Indicates if there was a suggested change to border_between.
*
* @var bool
*/
public $borderBetweenSuggested;
/**
* Indicates if there was a suggested change to border_bottom.
*
* @var bool
*/
public $borderBottomSuggested;
/**
* Indicates if there was a suggested change to border_left.
*
* @var bool
*/
public $borderLeftSuggested;
/**
* Indicates if there was a suggested change to border_right.
*
* @var bool
*/
public $borderRightSuggested;
/**
* Indicates if there was a suggested change to border_top.
*
* @var bool
*/
public $borderTopSuggested;
/**
* Indicates if there was a suggested change to direction.
*
* @var bool
*/
public $directionSuggested;
/**
* Indicates if there was a suggested change to heading_id.
*
* @var bool
*/
public $headingIdSuggested;
/**
* Indicates if there was a suggested change to indent_end.
*
* @var bool
*/
public $indentEndSuggested;
/**
* Indicates if there was a suggested change to indent_first_line.
*
* @var bool
*/
public $indentFirstLineSuggested;
/**
* Indicates if there was a suggested change to indent_start.
*
* @var bool
*/
public $indentStartSuggested;
/**
* Indicates if there was a suggested change to keep_lines_together.
*
* @var bool
*/
public $keepLinesTogetherSuggested;
/**
* Indicates if there was a suggested change to keep_with_next.
*
* @var bool
*/
public $keepWithNextSuggested;
/**
* Indicates if there was a suggested change to line_spacing.
*
* @var bool
*/
public $lineSpacingSuggested;
/**
* Indicates if there was a suggested change to named_style_type.
*
* @var bool
*/
public $namedStyleTypeSuggested;
/**
* Indicates if there was a suggested change to page_break_before.
*
* @var bool
*/
public $pageBreakBeforeSuggested;
protected $shadingSuggestionStateType = ShadingSuggestionState::class;
protected $shadingSuggestionStateDataType = '';
/**
* Indicates if there was a suggested change to space_above.
*
* @var bool
*/
public $spaceAboveSuggested;
/**
* Indicates if there was a suggested change to space_below.
*
* @var bool
*/
public $spaceBelowSuggested;
/**
* Indicates if there was a suggested change to spacing_mode.
*
* @var bool
*/
public $spacingModeSuggested;
/**
* Indicates if there was a suggested change to alignment.
*
* @param bool $alignmentSuggested
*/
public function setAlignmentSuggested($alignmentSuggested)
{
$this->alignmentSuggested = $alignmentSuggested;
}
/**
* @return bool
*/
public function getAlignmentSuggested()
{
return $this->alignmentSuggested;
}
/**
* Indicates if there was a suggested change to avoid_widow_and_orphan.
*
* @param bool $avoidWidowAndOrphanSuggested
*/
public function setAvoidWidowAndOrphanSuggested($avoidWidowAndOrphanSuggested)
{
$this->avoidWidowAndOrphanSuggested = $avoidWidowAndOrphanSuggested;
}
/**
* @return bool
*/
public function getAvoidWidowAndOrphanSuggested()
{
return $this->avoidWidowAndOrphanSuggested;
}
/**
* Indicates if there was a suggested change to border_between.
*
* @param bool $borderBetweenSuggested
*/
public function setBorderBetweenSuggested($borderBetweenSuggested)
{
$this->borderBetweenSuggested = $borderBetweenSuggested;
}
/**
* @return bool
*/
public function getBorderBetweenSuggested()
{
return $this->borderBetweenSuggested;
}
/**
* Indicates if there was a suggested change to border_bottom.
*
* @param bool $borderBottomSuggested
*/
public function setBorderBottomSuggested($borderBottomSuggested)
{
$this->borderBottomSuggested = $borderBottomSuggested;
}
/**
* @return bool
*/
public function getBorderBottomSuggested()
{
return $this->borderBottomSuggested;
}
/**
* Indicates if there was a suggested change to border_left.
*
* @param bool $borderLeftSuggested
*/
public function setBorderLeftSuggested($borderLeftSuggested)
{
$this->borderLeftSuggested = $borderLeftSuggested;
}
/**
* @return bool
*/
public function getBorderLeftSuggested()
{
return $this->borderLeftSuggested;
}
/**
* Indicates if there was a suggested change to border_right.
*
* @param bool $borderRightSuggested
*/
public function setBorderRightSuggested($borderRightSuggested)
{
$this->borderRightSuggested = $borderRightSuggested;
}
/**
* @return bool
*/
public function getBorderRightSuggested()
{
return $this->borderRightSuggested;
}
/**
* Indicates if there was a suggested change to border_top.
*
* @param bool $borderTopSuggested
*/
public function setBorderTopSuggested($borderTopSuggested)
{
$this->borderTopSuggested = $borderTopSuggested;
}
/**
* @return bool
*/
public function getBorderTopSuggested()
{
return $this->borderTopSuggested;
}
/**
* Indicates if there was a suggested change to direction.
*
* @param bool $directionSuggested
*/
public function setDirectionSuggested($directionSuggested)
{
$this->directionSuggested = $directionSuggested;
}
/**
* @return bool
*/
public function getDirectionSuggested()
{
return $this->directionSuggested;
}
/**
* Indicates if there was a suggested change to heading_id.
*
* @param bool $headingIdSuggested
*/
public function setHeadingIdSuggested($headingIdSuggested)
{
$this->headingIdSuggested = $headingIdSuggested;
}
/**
* @return bool
*/
public function getHeadingIdSuggested()
{
return $this->headingIdSuggested;
}
/**
* Indicates if there was a suggested change to indent_end.
*
* @param bool $indentEndSuggested
*/
public function setIndentEndSuggested($indentEndSuggested)
{
$this->indentEndSuggested = $indentEndSuggested;
}
/**
* @return bool
*/
public function getIndentEndSuggested()
{
return $this->indentEndSuggested;
}
/**
* Indicates if there was a suggested change to indent_first_line.
*
* @param bool $indentFirstLineSuggested
*/
public function setIndentFirstLineSuggested($indentFirstLineSuggested)
{
$this->indentFirstLineSuggested = $indentFirstLineSuggested;
}
/**
* @return bool
*/
public function getIndentFirstLineSuggested()
{
return $this->indentFirstLineSuggested;
}
/**
* Indicates if there was a suggested change to indent_start.
*
* @param bool $indentStartSuggested
*/
public function setIndentStartSuggested($indentStartSuggested)
{
$this->indentStartSuggested = $indentStartSuggested;
}
/**
* @return bool
*/
public function getIndentStartSuggested()
{
return $this->indentStartSuggested;
}
/**
* Indicates if there was a suggested change to keep_lines_together.
*
* @param bool $keepLinesTogetherSuggested
*/
public function setKeepLinesTogetherSuggested($keepLinesTogetherSuggested)
{
$this->keepLinesTogetherSuggested = $keepLinesTogetherSuggested;
}
/**
* @return bool
*/
public function getKeepLinesTogetherSuggested()
{
return $this->keepLinesTogetherSuggested;
}
/**
* Indicates if there was a suggested change to keep_with_next.
*
* @param bool $keepWithNextSuggested
*/
public function setKeepWithNextSuggested($keepWithNextSuggested)
{
$this->keepWithNextSuggested = $keepWithNextSuggested;
}
/**
* @return bool
*/
public function getKeepWithNextSuggested()
{
return $this->keepWithNextSuggested;
}
/**
* Indicates if there was a suggested change to line_spacing.
*
* @param bool $lineSpacingSuggested
*/
public function setLineSpacingSuggested($lineSpacingSuggested)
{
$this->lineSpacingSuggested = $lineSpacingSuggested;
}
/**
* @return bool
*/
public function getLineSpacingSuggested()
{
return $this->lineSpacingSuggested;
}
/**
* Indicates if there was a suggested change to named_style_type.
*
* @param bool $namedStyleTypeSuggested
*/
public function setNamedStyleTypeSuggested($namedStyleTypeSuggested)
{
$this->namedStyleTypeSuggested = $namedStyleTypeSuggested;
}
/**
* @return bool
*/
public function getNamedStyleTypeSuggested()
{
return $this->namedStyleTypeSuggested;
}
/**
* Indicates if there was a suggested change to page_break_before.
*
* @param bool $pageBreakBeforeSuggested
*/
public function setPageBreakBeforeSuggested($pageBreakBeforeSuggested)
{
$this->pageBreakBeforeSuggested = $pageBreakBeforeSuggested;
}
/**
* @return bool
*/
public function getPageBreakBeforeSuggested()
{
return $this->pageBreakBeforeSuggested;
}
/**
* A mask that indicates which of the fields in shading have been changed in
* this suggestion.
*
* @param ShadingSuggestionState $shadingSuggestionState
*/
public function setShadingSuggestionState(ShadingSuggestionState $shadingSuggestionState)
{
$this->shadingSuggestionState = $shadingSuggestionState;
}
/**
* @return ShadingSuggestionState
*/
public function getShadingSuggestionState()
{
return $this->shadingSuggestionState;
}
/**
* Indicates if there was a suggested change to space_above.
*
* @param bool $spaceAboveSuggested
*/
public function setSpaceAboveSuggested($spaceAboveSuggested)
{
$this->spaceAboveSuggested = $spaceAboveSuggested;
}
/**
* @return bool
*/
public function getSpaceAboveSuggested()
{
return $this->spaceAboveSuggested;
}
/**
* Indicates if there was a suggested change to space_below.
*
* @param bool $spaceBelowSuggested
*/
public function setSpaceBelowSuggested($spaceBelowSuggested)
{
$this->spaceBelowSuggested = $spaceBelowSuggested;
}
/**
* @return bool
*/
public function getSpaceBelowSuggested()
{
return $this->spaceBelowSuggested;
}
/**
* Indicates if there was a suggested change to spacing_mode.
*
* @param bool $spacingModeSuggested
*/
public function setSpacingModeSuggested($spacingModeSuggested)
{
$this->spacingModeSuggested = $spacingModeSuggested;
}
/**
* @return bool
*/
public function getSpacingModeSuggested()
{
return $this->spacingModeSuggested;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ParagraphStyleSuggestionState::class, 'Google_Service_Docs_ParagraphStyleSuggestionState');
+159
View File
@@ -0,0 +1,159 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class Person extends \Google\Collection
{
protected $collection_key = 'suggestedInsertionIds';
/**
* Output only. The unique ID of this link.
*
* @var string
*/
public $personId;
protected $personPropertiesType = PersonProperties::class;
protected $personPropertiesDataType = '';
/**
* IDs for suggestions that remove this person link from the document. A
* Person might have multiple deletion IDs if, for example, multiple users
* suggest deleting it. If empty, then this person link isn't suggested for
* deletion.
*
* @var string[]
*/
public $suggestedDeletionIds;
/**
* IDs for suggestions that insert this person link into the document. A
* Person might have multiple insertion IDs if it's a nested suggested change
* (a suggestion within a suggestion made by a different user, for example).
* If empty, then this person link isn't a suggested insertion.
*
* @var string[]
*/
public $suggestedInsertionIds;
protected $suggestedTextStyleChangesType = SuggestedTextStyle::class;
protected $suggestedTextStyleChangesDataType = 'map';
protected $textStyleType = TextStyle::class;
protected $textStyleDataType = '';
/**
* Output only. The unique ID of this link.
*
* @param string $personId
*/
public function setPersonId($personId)
{
$this->personId = $personId;
}
/**
* @return string
*/
public function getPersonId()
{
return $this->personId;
}
/**
* Output only. The properties of this Person. This field is always present.
*
* @param PersonProperties $personProperties
*/
public function setPersonProperties(PersonProperties $personProperties)
{
$this->personProperties = $personProperties;
}
/**
* @return PersonProperties
*/
public function getPersonProperties()
{
return $this->personProperties;
}
/**
* IDs for suggestions that remove this person link from the document. A
* Person might have multiple deletion IDs if, for example, multiple users
* suggest deleting it. If empty, then this person link isn't suggested for
* deletion.
*
* @param string[] $suggestedDeletionIds
*/
public function setSuggestedDeletionIds($suggestedDeletionIds)
{
$this->suggestedDeletionIds = $suggestedDeletionIds;
}
/**
* @return string[]
*/
public function getSuggestedDeletionIds()
{
return $this->suggestedDeletionIds;
}
/**
* IDs for suggestions that insert this person link into the document. A
* Person might have multiple insertion IDs if it's a nested suggested change
* (a suggestion within a suggestion made by a different user, for example).
* If empty, then this person link isn't a suggested insertion.
*
* @param string[] $suggestedInsertionIds
*/
public function setSuggestedInsertionIds($suggestedInsertionIds)
{
$this->suggestedInsertionIds = $suggestedInsertionIds;
}
/**
* @return string[]
*/
public function getSuggestedInsertionIds()
{
return $this->suggestedInsertionIds;
}
/**
* The suggested text style changes to this Person, keyed by suggestion ID.
*
* @param SuggestedTextStyle[] $suggestedTextStyleChanges
*/
public function setSuggestedTextStyleChanges($suggestedTextStyleChanges)
{
$this->suggestedTextStyleChanges = $suggestedTextStyleChanges;
}
/**
* @return SuggestedTextStyle[]
*/
public function getSuggestedTextStyleChanges()
{
return $this->suggestedTextStyleChanges;
}
/**
* The text style of this Person.
*
* @param TextStyle $textStyle
*/
public function setTextStyle(TextStyle $textStyle)
{
$this->textStyle = $textStyle;
}
/**
* @return TextStyle
*/
public function getTextStyle()
{
return $this->textStyle;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Person::class, 'Google_Service_Docs_Person');
@@ -0,0 +1,72 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Docs;
class PersonProperties extends \Google\Model
{
/**
* The email address linked to this Person. This field is always present.
*
* @var string
*/
public $email;
/**
* The name of the person if it's displayed in the link text instead of the
* person's email address.
*
* @var string
*/
public $name;
/**
* The email address linked to this Person. This field is always present.
*
* @param string $email
*/
public function setEmail($email)
{
$this->email = $email;
}
/**
* @return string
*/
public function getEmail()
{
return $this->email;
}
/**
* The name of the person if it's displayed in the link text instead of the
* person's email address.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PersonProperties::class, 'Google_Service_Docs_PersonProperties');

Some files were not shown because too many files have changed in this diff Show More