Reference documentation and code samples for the Google Apps Chat V1 Client class MessagePin.
A pin on a Chat message. For more information see Pin a message.
Generated from protobuf message google.chat.v1.MessagePin
Namespace
Google \ Apps \ Chat \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The resource name of the message pin. Format: |
↳ message |
string
Required. Immutable. The resource name of the message that is pinned. Format: |
getName
Identifier. The resource name of the message pin.
Format: spaces/{space}/messagePins/{message_pin}
The resource ID component matches the resource ID component of the
message. For example, a message with spaces/AAA/messages/bbb.ccc
corresponds to the message pin with the resource name
spaces/AAA/messagePins/bbb.ccc.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The resource name of the message pin.
Format: spaces/{space}/messagePins/{message_pin}
The resource ID component matches the resource ID component of the
message. For example, a message with spaces/AAA/messages/bbb.ccc
corresponds to the message pin with the resource name
spaces/AAA/messagePins/bbb.ccc.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMessage
Required. Immutable. The resource name of the message that is pinned.
Format: spaces/{space}/messages/{message}
| Returns | |
|---|---|
| Type | Description |
string |
|
setMessage
Required. Immutable. The resource name of the message that is pinned.
Format: spaces/{space}/messages/{message}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|