Google Apps Chat V1 Client - Class ListMessagePinsRequest (0.27.0)

0.27.0 (latest) 0.23.0 0.20.0 0.19.0 0.18.0 0.17.1 0.16.1 0.15.0 0.14.0 0.13.1 0.12.1 0.11.2 0.10.0 0.9.0 0.8.1 0.7.2 0.6.1 0.5.0 0.4.0 0.3.0 0.2.0 0.1.4

Reference documentation and code samples for the Google Apps Chat V1 Client class ListMessagePinsRequest.

Request message for listing message pins.

Generated from protobuf message google.chat.v1.ListMessagePinsRequest

Namespace

Google \ Apps \ Chat \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. The parent space which owns the collection of pinned items Format: spaces/{space}
↳ page_size	int Optional. The maximum number of message pins returned. The service might return fewer messages than this value. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100. If unspecified, at most 100 message pins will be returned. Negative values return an INVALID_ARGUMENT error.
↳ page_token	string Optional. A page token received from a previous list message pins call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.

getParent

Required. The parent space which owns the collection of pinned items Format: spaces/{space}

Returns
Type	Description
string

setParent

Required. The parent space which owns the collection of pinned items Format: spaces/{space}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPageSize

Optional. The maximum number of message pins returned. The service might return fewer messages than this value. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100. If unspecified, at most 100 message pins will be returned. Negative values return an INVALID_ARGUMENT error.

Returns
Type	Description
int

setPageSize

Optional. The maximum number of message pins returned. The service might return fewer messages than this value. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100. If unspecified, at most 100 message pins will be returned. Negative values return an INVALID_ARGUMENT error.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPageToken

Optional. A page token received from a previous list message pins call.

Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.

Returns
Type	Description
string

setPageToken

Optional. A page token received from a previous list message pins call.

Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameter
Name	Description
parent	string Required. The parent space which owns the collection of pinned items Format: spaces/{space} Please see ChatServiceClient::spaceName() for help formatting this field.

Returns
Type	Description
ListMessagePinsRequest