Class: Google::Apis::ChatV1::ActionStatus

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/chat_v1/classes.rb,
lib/google/apis/chat_v1/representations.rb,
lib/google/apis/chat_v1/representations.rb

Overview

ActionStatus represents status of a request from the bot developer's side. In specific, for each request a bot gets, the bot developer will set both fields below in relation to what the response status and message related to status should be.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ActionStatus

Returns a new instance of ActionStatus.



105
106
107
 
# File 'lib/google/apis/chat_v1/classes.rb', line 105

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#status_code ⇒ String

The status code. Corresponds to the JSON property statusCode

Returns:

  • (String) 


95
96
97
 
# File 'lib/google/apis/chat_v1/classes.rb', line 95

def status_code
  @status_code
end

#user_facing_message ⇒ String

This message will be the corresponding string to the above status_code. If unset, an appropriate generic message based on the status_code will be shown to the user. If this field is set then the message will be surfaced to the user for both successes and errors. Corresponds to the JSON property userFacingMessage

Returns:

  • (String) 


103
104
105
 
# File 'lib/google/apis/chat_v1/classes.rb', line 103

def user_facing_message
  @user_facing_message
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



110
111
112
113
 
# File 'lib/google/apis/chat_v1/classes.rb', line 110

def update!(**args)
  @status_code = args[:status_code] if args.key?(:status_code)
  @user_facing_message = args[:user_facing_message] if args.key?(:user_facing_message)
end