Class: Google::Apps::Chat::V1::CreateMessageRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/chat/v1/message.rb

Overview

Creates a message.

Defined Under Namespace

Modules: MessageReplyOption

Instance Attribute Summary collapse

Instance Attribute Details

#message ⇒ ::Google::Apps::Chat::V1::Message

Returns Required. Message body.

Returns:



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'proto_docs/google/chat/v1/message.rb', line 486

class CreateMessageRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to reply to a message.
  # More states might be added in the future.
  module MessageReplyOption
    # Default. Starts a new thread. Using this option ignores any [thread
    # ID][google.chat.v1.Thread.name] or
    # {::Google::Apps::Chat::V1::Thread#thread_key `thread_key`} that's included.
    MESSAGE_REPLY_OPTION_UNSPECIFIED = 0

    # Creates the message as a reply to the thread specified by [thread
    # ID][google.chat.v1.Thread.name] or
    # {::Google::Apps::Chat::V1::Thread#thread_key `thread_key`}. If it fails, the
    # message starts a new thread instead.
    REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD = 1

    # Creates the message as a reply to the thread specified by [thread
    # ID][google.chat.v1.Thread.name] or
    # {::Google::Apps::Chat::V1::Thread#thread_key `thread_key`}. If a new `thread_key`
    # is used, a new thread is created. If the message creation fails, a
    # `NOT_FOUND` error is returned instead.
    REPLY_MESSAGE_OR_FAIL = 2
  end
end

#message_id ⇒ ::String

Returns 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.



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'proto_docs/google/chat/v1/message.rb', line 486

class CreateMessageRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to reply to a message.
  # More states might be added in the future.
  module MessageReplyOption
    # Default. Starts a new thread. Using this option ignores any [thread
    # ID][google.chat.v1.Thread.name] or
    # {::Google::Apps::Chat::V1::Thread#thread_key `thread_key`} that's included.
    MESSAGE_REPLY_OPTION_UNSPECIFIED = 0

    # Creates the message as a reply to the thread specified by [thread
    # ID][google.chat.v1.Thread.name] or
    # {::Google::Apps::Chat::V1::Thread#thread_key `thread_key`}. If it fails, the
    # message starts a new thread instead.
    REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD = 1

    # Creates the message as a reply to the thread specified by [thread
    # ID][google.chat.v1.Thread.name] or
    # {::Google::Apps::Chat::V1::Thread#thread_key `thread_key`}. If a new `thread_key`
    # is used, a new thread is created. If the message creation fails, a
    # `NOT_FOUND` error is returned instead.
    REPLY_MESSAGE_OR_FAIL = 2
  end
end

#message_reply_option ⇒ ::Google::Apps::Chat::V1::CreateMessageRequest::MessageReplyOption

Returns 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:



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'proto_docs/google/chat/v1/message.rb', line 486

class CreateMessageRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to reply to a message.
  # More states might be added in the future.
  module MessageReplyOption
    # Default. Starts a new thread. Using this option ignores any [thread
    # ID][google.chat.v1.Thread.name] or
    # {::Google::Apps::Chat::V1::Thread#thread_key `thread_key`} that's included.
    MESSAGE_REPLY_OPTION_UNSPECIFIED = 0

    # Creates the message as a reply to the thread specified by [thread
    # ID][google.chat.v1.Thread.name] or
    # {::Google::Apps::Chat::V1::Thread#thread_key `thread_key`}. If it fails, the
    # message starts a new thread instead.
    REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD = 1

    # Creates the message as a reply to the thread specified by [thread
    # ID][google.chat.v1.Thread.name] or
    # {::Google::Apps::Chat::V1::Thread#thread_key `thread_key`}. If a new `thread_key`
    # is used, a new thread is created. If the message creation fails, a
    # `NOT_FOUND` error is returned instead.
    REPLY_MESSAGE_OR_FAIL = 2
  end
end

#parent ⇒ ::String

Returns 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}



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'proto_docs/google/chat/v1/message.rb', line 486

class CreateMessageRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to reply to a message.
  # More states might be added in the future.
  module MessageReplyOption
    # Default. Starts a new thread. Using this option ignores any [thread
    # ID][google.chat.v1.Thread.name] or
    # {::Google::Apps::Chat::V1::Thread#thread_key `thread_key`} that's included.
    MESSAGE_REPLY_OPTION_UNSPECIFIED = 0

    # Creates the message as a reply to the thread specified by [thread
    # ID][google.chat.v1.Thread.name] or
    # {::Google::Apps::Chat::V1::Thread#thread_key `thread_key`}. If it fails, the
    # message starts a new thread instead.
    REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD = 1

    # Creates the message as a reply to the thread specified by [thread
    # ID][google.chat.v1.Thread.name] or
    # {::Google::Apps::Chat::V1::Thread#thread_key `thread_key`}. If a new `thread_key`
    # is used, a new thread is created. If the message creation fails, a
    # `NOT_FOUND` error is returned instead.
    REPLY_MESSAGE_OR_FAIL = 2
  end
end

#request_id ⇒ ::String

Returns 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.



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'proto_docs/google/chat/v1/message.rb', line 486

class CreateMessageRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to reply to a message.
  # More states might be added in the future.
  module MessageReplyOption
    # Default. Starts a new thread. Using this option ignores any [thread
    # ID][google.chat.v1.Thread.name] or
    # {::Google::Apps::Chat::V1::Thread#thread_key `thread_key`} that's included.
    MESSAGE_REPLY_OPTION_UNSPECIFIED = 0

    # Creates the message as a reply to the thread specified by [thread
    # ID][google.chat.v1.Thread.name] or
    # {::Google::Apps::Chat::V1::Thread#thread_key `thread_key`}. If it fails, the
    # message starts a new thread instead.
    REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD = 1

    # Creates the message as a reply to the thread specified by [thread
    # ID][google.chat.v1.Thread.name] or
    # {::Google::Apps::Chat::V1::Thread#thread_key `thread_key`}. If a new `thread_key`
    # is used, a new thread is created. If the message creation fails, a
    # `NOT_FOUND` error is returned instead.
    REPLY_MESSAGE_OR_FAIL = 2
  end
end

#thread_key ⇒ ::String

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns 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:



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'proto_docs/google/chat/v1/message.rb', line 486

class CreateMessageRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to reply to a message.
  # More states might be added in the future.
  module MessageReplyOption
    # Default. Starts a new thread. Using this option ignores any [thread
    # ID][google.chat.v1.Thread.name] or
    # {::Google::Apps::Chat::V1::Thread#thread_key `thread_key`} that's included.
    MESSAGE_REPLY_OPTION_UNSPECIFIED = 0

    # Creates the message as a reply to the thread specified by [thread
    # ID][google.chat.v1.Thread.name] or
    # {::Google::Apps::Chat::V1::Thread#thread_key `thread_key`}. If it fails, the
    # message starts a new thread instead.
    REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD = 1

    # Creates the message as a reply to the thread specified by [thread
    # ID][google.chat.v1.Thread.name] or
    # {::Google::Apps::Chat::V1::Thread#thread_key `thread_key`}. If a new `thread_key`
    # is used, a new thread is created. If the message creation fails, a
    # `NOT_FOUND` error is returned instead.
    REPLY_MESSAGE_OR_FAIL = 2
  end
end