Class: MicrosoftGraph::Models::MailFolder

Inherits:
Entity
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/mail_folder.rb

Direct Known Subclasses

MailSearchFolder

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Entity

#additional_data, #additional_data=, #id, #id=, #odata_type, #odata_type=

Constructor Details

#initialize ⇒ Object

Instantiates a new mailFolder and sets the default values.



76
77
78
 
# File 'lib/models/mail_folder.rb', line 76

def initialize()
    super
end

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

Creates a new instance of the appropriate class based on discriminator value

Raises:

  • (StandardError) 


84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/models/mail_folder.rb', line 84

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    mapping_value_node = parse_node.get_child_node("@odata.type")
    unless mapping_value_node.nil? then
        mapping_value = mapping_value_node.get_string_value
        case mapping_value
            when "#microsoft.graph.mailSearchFolder"
                return MailSearchFolder.new
        end
    end
    return MailFolder.new
end

Instance Method Details

#child_folder_count ⇒ Object

Gets the childFolderCount property value. The number of immediate child mailFolders in the current mailFolder.



46
47
48
 
# File 'lib/models/mail_folder.rb', line 46

def child_folder_count
    return @child_folder_count
end

#child_folder_count=(value) ⇒ Object

Sets the childFolderCount property value. The number of immediate child mailFolders in the current mailFolder.



54
55
56
 
# File 'lib/models/mail_folder.rb', line 54

def child_folder_count=(value)
    @child_folder_count = value
end

#child_folders ⇒ Object

Gets the childFolders property value. The collection of child folders in the mailFolder.



61
62
63
 
# File 'lib/models/mail_folder.rb', line 61

def child_folders
    return @child_folders
end

#child_folders=(value) ⇒ Object

Sets the childFolders property value. The collection of child folders in the mailFolder.



69
70
71
 
# File 'lib/models/mail_folder.rb', line 69

def child_folders=(value)
    @child_folders = value
end

#display_name ⇒ Object

Gets the displayName property value. The mailFolder’s display name.



100
101
102
 
# File 'lib/models/mail_folder.rb', line 100

def display_name
    return @display_name
end

#display_name=(value) ⇒ Object

Sets the displayName property value. The mailFolder’s display name.



108
109
110
 
# File 'lib/models/mail_folder.rb', line 108

def display_name=(value)
    @display_name = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/models/mail_folder.rb', line 115

def get_field_deserializers()
    return super.merge({
        "childFolderCount" => lambda {|n| @child_folder_count = n.get_number_value() },
        "childFolders" => lambda {|n| @child_folders = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::MailFolder.create_from_discriminator_value(pn) }) },
        "displayName" => lambda {|n| @display_name = n.get_string_value() },
        "isHidden" => lambda {|n| @is_hidden = n.get_boolean_value() },
        "messageRules" => lambda {|n| @message_rules = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::MessageRule.create_from_discriminator_value(pn) }) },
        "messages" => lambda {|n| @messages = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::Message.create_from_discriminator_value(pn) }) },
        "multiValueExtendedProperties" => lambda {|n| @multi_value_extended_properties = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::MultiValueLegacyExtendedProperty.create_from_discriminator_value(pn) }) },
        "parentFolderId" => lambda {|n| @parent_folder_id = n.get_string_value() },
        "singleValueExtendedProperties" => lambda {|n| @single_value_extended_properties = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::SingleValueLegacyExtendedProperty.create_from_discriminator_value(pn) }) },
        "totalItemCount" => lambda {|n| @total_item_count = n.get_number_value() },
        "unreadItemCount" => lambda {|n| @unread_item_count = n.get_number_value() },
    })
end

#is_hidden ⇒ Object

Gets the isHidden property value. Indicates whether the mailFolder is hidden. This property can be set only when creating the folder. Find more information in Hidden mail folders.



134
135
136
 
# File 'lib/models/mail_folder.rb', line 134

def is_hidden
    return @is_hidden
end

#is_hidden=(value) ⇒ Object

Sets the isHidden property value. Indicates whether the mailFolder is hidden. This property can be set only when creating the folder. Find more information in Hidden mail folders.



142
143
144
 
# File 'lib/models/mail_folder.rb', line 142

def is_hidden=(value)
    @is_hidden = value
end

#message_rules ⇒ Object

Gets the messageRules property value. The collection of rules that apply to the user’s Inbox folder.



149
150
151
 
# File 'lib/models/mail_folder.rb', line 149

def message_rules
    return @message_rules
end

#message_rules=(value) ⇒ Object

Sets the messageRules property value. The collection of rules that apply to the user’s Inbox folder.



157
158
159
 
# File 'lib/models/mail_folder.rb', line 157

def message_rules=(value)
    @message_rules = value
end

#messages ⇒ Object

Gets the messages property value. The collection of messages in the mailFolder.



164
165
166
 
# File 'lib/models/mail_folder.rb', line 164

def messages
    return @messages
end

#messages=(value) ⇒ Object

Sets the messages property value. The collection of messages in the mailFolder.



172
173
174
 
# File 'lib/models/mail_folder.rb', line 172

def messages=(value)
    @messages = value
end

#multi_value_extended_properties ⇒ Object

Gets the multiValueExtendedProperties property value. The collection of multi-value extended properties defined for the mailFolder. Read-only. Nullable.



179
180
181
 
# File 'lib/models/mail_folder.rb', line 179

def multi_value_extended_properties
    return @multi_value_extended_properties
end

#multi_value_extended_properties=(value) ⇒ Object

Sets the multiValueExtendedProperties property value. The collection of multi-value extended properties defined for the mailFolder. Read-only. Nullable.



187
188
189
 
# File 'lib/models/mail_folder.rb', line 187

def multi_value_extended_properties=(value)
    @multi_value_extended_properties = value
end

#parent_folder_id ⇒ Object

Gets the parentFolderId property value. The unique identifier for the mailFolder’s parent mailFolder.



194
195
196
 
# File 'lib/models/mail_folder.rb', line 194

def parent_folder_id
    return @parent_folder_id
end

#parent_folder_id=(value) ⇒ Object

Sets the parentFolderId property value. The unique identifier for the mailFolder’s parent mailFolder.



202
203
204
 
# File 'lib/models/mail_folder.rb', line 202

def parent_folder_id=(value)
    @parent_folder_id = value
end

#serialize(writer) ⇒ Object

Serializes information the current object

Raises:

  • (StandardError) 


210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/models/mail_folder.rb', line 210

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_number_value("childFolderCount", @child_folder_count)
    writer.write_collection_of_object_values("childFolders", @child_folders)
    writer.write_string_value("displayName", @display_name)
    writer.write_boolean_value("isHidden", @is_hidden)
    writer.write_collection_of_object_values("messageRules", @message_rules)
    writer.write_collection_of_object_values("messages", @messages)
    writer.write_collection_of_object_values("multiValueExtendedProperties", @multi_value_extended_properties)
    writer.write_string_value("parentFolderId", @parent_folder_id)
    writer.write_collection_of_object_values("singleValueExtendedProperties", @single_value_extended_properties)
    writer.write_number_value("totalItemCount", @total_item_count)
    writer.write_number_value("unreadItemCount", @unread_item_count)
end

#single_value_extended_properties ⇒ Object

Gets the singleValueExtendedProperties property value. The collection of single-value extended properties defined for the mailFolder. Read-only. Nullable.



229
230
231
 
# File 'lib/models/mail_folder.rb', line 229

def single_value_extended_properties
    return @single_value_extended_properties
end

#single_value_extended_properties=(value) ⇒ Object

Sets the singleValueExtendedProperties property value. The collection of single-value extended properties defined for the mailFolder. Read-only. Nullable.



237
238
239
 
# File 'lib/models/mail_folder.rb', line 237

def single_value_extended_properties=(value)
    @single_value_extended_properties = value
end

#total_item_count ⇒ Object

Gets the totalItemCount property value. The number of items in the mailFolder.



244
245
246
 
# File 'lib/models/mail_folder.rb', line 244

def total_item_count
    return @total_item_count
end

#total_item_count=(value) ⇒ Object

Sets the totalItemCount property value. The number of items in the mailFolder.



252
253
254
 
# File 'lib/models/mail_folder.rb', line 252

def total_item_count=(value)
    @total_item_count = value
end

#unread_item_count ⇒ Object

Gets the unreadItemCount property value. The number of items in the mailFolder marked as unread.



259
260
261
 
# File 'lib/models/mail_folder.rb', line 259

def unread_item_count
    return @unread_item_count
end

#unread_item_count=(value) ⇒ Object

Sets the unreadItemCount property value. The number of items in the mailFolder marked as unread.



267
268
269
 
# File 'lib/models/mail_folder.rb', line 267

def unread_item_count=(value)
    @unread_item_count = value
end