Google Chat V1 API - Class Google::Apps::Chat::V1::CreateMessageRequest (v0.7.0)

Reference documentation and code samples for the Google Chat V1 API class Google::Apps::Chat::V1::CreateMessageRequest.

Creates a message.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#message

def message() -> ::Google::Apps::Chat::V1::Message

Returns

(::Google::Apps::Chat::V1::Message) — Required. Message body.

#message=

def message=(value) -> ::Google::Apps::Chat::V1::Message

Parameter

value (::Google::Apps::Chat::V1::Message) — Required. Message body.

Returns

(::Google::Apps::Chat::V1::Message) — Required. Message body.

#message_id

def message_id() -> ::String

Returns

(::String) — Optional. A custom ID for a message. Lets Chat apps get, update, or delete a message without needing to store the system-assigned ID in the message's resource name (represented in the message name field).

The value for this field must meet the following requirements:
- Begins with client-. For example, client-custom-name is a valid custom ID, but custom-name is not.
- Contains up to 63 characters and only lowercase letters, numbers, and hyphens.
- Is unique within a space. A Chat app can't use the same custom ID for different messages.
For details, see Name a message.

#message_id=

def message_id=(value) -> ::String

Parameter

value (::String) — Optional. A custom ID for a message. Lets Chat apps get, update, or delete a message without needing to store the system-assigned ID in the message's resource name (represented in the message name field).

The value for this field must meet the following requirements:
- Begins with client-. For example, client-custom-name is a valid custom ID, but custom-name is not.
- Contains up to 63 characters and only lowercase letters, numbers, and hyphens.
- Is unique within a space. A Chat app can't use the same custom ID for different messages.
For details, see Name a message.

Returns

(::String) — Optional. A custom ID for a message. Lets Chat apps get, update, or delete a message without needing to store the system-assigned ID in the message's resource name (represented in the message name field).

The value for this field must meet the following requirements:
- Begins with client-. For example, client-custom-name is a valid custom ID, but custom-name is not.
- Contains up to 63 characters and only lowercase letters, numbers, and hyphens.
- Is unique within a space. A Chat app can't use the same custom ID for different messages.
For details, see Name a message.

#message_reply_option

def message_reply_option() -> ::Google::Apps::Chat::V1::CreateMessageRequest::MessageReplyOption

Returns

(::Google::Apps::Chat::V1::CreateMessageRequest::MessageReplyOption) — Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces.

When responding to user interactions, this field is ignored. For interactions within a thread, the reply is created in the same thread. Otherwise, the reply is created as a new thread.

#message_reply_option=

def message_reply_option=(value) -> ::Google::Apps::Chat::V1::CreateMessageRequest::MessageReplyOption

Parameter

value (::Google::Apps::Chat::V1::CreateMessageRequest::MessageReplyOption) — Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces.

When responding to user interactions, this field is ignored. For interactions within a thread, the reply is created in the same thread. Otherwise, the reply is created as a new thread.

Returns

(::Google::Apps::Chat::V1::CreateMessageRequest::MessageReplyOption) — Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces.

When responding to user interactions, this field is ignored. For interactions within a thread, the reply is created in the same thread. Otherwise, the reply is created as a new thread.

#parent

def parent() -> ::String

Returns

(::String) — Required. The resource name of the space in which to create a message.

Format: spaces/{space}

#parent=

def parent=(value) -> ::String

Parameter

value (::String) — Required. The resource name of the space in which to create a message.

Format: spaces/{space}

Returns

(::String) — Required. The resource name of the space in which to create a message.

Format: spaces/{space}

#request_id

def request_id() -> ::String

Returns

(::String) — Optional. A unique request ID for this message. Specifying an existing request ID returns the message created with that ID instead of creating a new message.

#request_id=

def request_id=(value) -> ::String

Parameter

value (::String) — Optional. A unique request ID for this message. Specifying an existing request ID returns the message created with that ID instead of creating a new message.

Returns

(::String) — Optional. A unique request ID for this message. Specifying an existing request ID returns the message created with that ID instead of creating a new message.

#thread_key

def thread_key() -> ::String

Returns

(::String) — Optional. Deprecated: Use thread.thread_key instead. ID for the thread. Supports up to 4000 characters. To start or add to a thread, create a message and specify a threadKey or the thread.name. For example usage, see Start or reply to a message thread.

#thread_key=

def thread_key=(value) -> ::String

Parameter

value (::String) — Optional. Deprecated: Use thread.thread_key instead. ID for the thread. Supports up to 4000 characters. To start or add to a thread, create a message and specify a threadKey or the thread.name. For example usage, see Start or reply to a message thread.

Returns

(::String) — Optional. Deprecated: Use thread.thread_key instead. ID for the thread. Supports up to 4000 characters. To start or add to a thread, create a message and specify a threadKey or the thread.name. For example usage, see Start or reply to a message thread.