Google Chat V1 API - Class Google::Apps::Chat::V1::CreateMessageRequest (v0.31.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

#create_message_notification_options

def create_message_notification_options() -> ::Google::Apps::Chat::V1::CreateMessageNotificationOptions
Returns

#create_message_notification_options=

def create_message_notification_options=(value) -> ::Google::Apps::Chat::V1::CreateMessageNotificationOptions
Parameter
Returns

#message

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

#message=

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

#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

#message_reply_option=

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

#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 ID for this request. A random UUID is recommended. Specifying a request ID makes the request idempotent, which ensures that multiple identical requests with the same request ID result in only a single message being created. Subsequent requests with the same request ID return the existing message and do not update the message, even if the requested details differ from the current state.

    To use this field effectively:

    • Ensure that subsequent requests are identical and use the same authentication credentials as the original request.
    • If a message was already created with the provided request ID, the request returns that message. Note that the returned message might not be fully populated; the API echoes the message in your request with the system-assigned resource names populated. To retrieve the latest metadata for the message, call GetMessage.
    • Reusing an existing request ID with a different authenticated user results in an error.

#request_id=

def request_id=(value) -> ::String
Parameter
  • value (::String) —

    Optional. A unique ID for this request. A random UUID is recommended. Specifying a request ID makes the request idempotent, which ensures that multiple identical requests with the same request ID result in only a single message being created. Subsequent requests with the same request ID return the existing message and do not update the message, even if the requested details differ from the current state.

    To use this field effectively:

    • Ensure that subsequent requests are identical and use the same authentication credentials as the original request.
    • If a message was already created with the provided request ID, the request returns that message. Note that the returned message might not be fully populated; the API echoes the message in your request with the system-assigned resource names populated. To retrieve the latest metadata for the message, call GetMessage.
    • Reusing an existing request ID with a different authenticated user results in an error.
Returns
  • (::String) —

    Optional. A unique ID for this request. A random UUID is recommended. Specifying a request ID makes the request idempotent, which ensures that multiple identical requests with the same request ID result in only a single message being created. Subsequent requests with the same request ID return the existing message and do not update the message, even if the requested details differ from the current state.

    To use this field effectively:

    • Ensure that subsequent requests are identical and use the same authentication credentials as the original request.
    • If a message was already created with the provided request ID, the request returns that message. Note that the returned message might not be fully populated; the API echoes the message in your request with the system-assigned resource names populated. To retrieve the latest metadata for the message, call GetMessage.
    • Reusing an existing request ID with a different authenticated user results in an error.

#thread_key

def thread_key() -> ::String
Returns

#thread_key=

def thread_key=(value) -> ::String
Parameter
Returns