Class: Google::Apis::GmailV1::BatchModifyMessagesRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/gmail_v1/classes.rb,
generated/google/apis/gmail_v1/representations.rb,
generated/google/apis/gmail_v1/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ BatchModifyMessagesRequest

Returns a new instance of BatchModifyMessagesRequest



96
97
98
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 96

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

Instance Attribute Details

#add_label_ids ⇒ Array<String>

A list of label IDs to add to messages. Corresponds to the JSON property addLabelIds

Returns:

  • (Array<String>) 


84
85
86
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 84

def add_label_ids
  @add_label_ids
end

#ids ⇒ Array<String>

The IDs of the messages to modify. There is a limit of 1000 ids per request. Corresponds to the JSON property ids

Returns:

  • (Array<String>) 


89
90
91
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 89

def ids
  @ids
end

#remove_label_ids ⇒ Array<String>

A list of label IDs to remove from messages. Corresponds to the JSON property removeLabelIds

Returns:

  • (Array<String>) 


94
95
96
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 94

def remove_label_ids
  @remove_label_ids
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



101
102
103
104
105
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 101

def update!(**args)
  @add_label_ids = args[:add_label_ids] if args.key?(:add_label_ids)
  @ids = args[:ids] if args.key?(:ids)
  @remove_label_ids = args[:remove_label_ids] if args.key?(:remove_label_ids)
end