Class: MicrosoftGraph::Models::MailSearchFolder

Inherits:
MailFolder show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/mail_search_folder.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from MailFolder

#child_folder_count, #child_folder_count=, #child_folders, #child_folders=, #display_name, #display_name=, #is_hidden, #is_hidden=, #message_rules, #message_rules=, #messages, #messages=, #multi_value_extended_properties, #multi_value_extended_properties=, #parent_folder_id, #parent_folder_id=, #single_value_extended_properties, #single_value_extended_properties=, #total_item_count, #total_item_count=, #unread_item_count, #unread_item_count=

Methods inherited from Entity

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

Constructor Details

#initialize ⇒ Object

Instantiates a new mailSearchFolder and sets the default values.



25
26
27
28
 
# File 'lib/models/mail_search_folder.rb', line 25

def initialize()
    super
    @odata_type = "#microsoft.graph.mailSearchFolder"
end

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

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

Parameters:

  • parse_node —

    The parse node to use to read the discriminator value and create the object

Returns:

  • a mail_search_folder

Raises:

  • (StandardError) 


34
35
36
37
 
# File 'lib/models/mail_search_folder.rb', line 34

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return MailSearchFolder.new
end

Instance Method Details

#filter_query ⇒ Object

Gets the filterQuery property value. The OData query to filter the messages.

Returns:

  • a string



42
43
44
 
# File 'lib/models/mail_search_folder.rb', line 42

def filter_query
    return @filter_query
end

#filter_query=(value) ⇒ Object

Sets the filterQuery property value. The OData query to filter the messages.

Parameters:

  • value —

    Value to set for the filterQuery property.

Returns:

  • a void



50
51
52
 
# File 'lib/models/mail_search_folder.rb', line 50

def filter_query=(value)
    @filter_query = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



57
58
59
60
61
62
63
64
 
# File 'lib/models/mail_search_folder.rb', line 57

def get_field_deserializers()
    return super.merge({
        "filterQuery" => lambda {|n| @filter_query = n.get_string_value() },
        "includeNestedFolders" => lambda {|n| @include_nested_folders = n.get_boolean_value() },
        "isSupported" => lambda {|n| @is_supported = n.get_boolean_value() },
        "sourceFolderIds" => lambda {|n| @source_folder_ids = n.get_collection_of_primitive_values(String) },
    })
end

#include_nested_folders ⇒ Object

Gets the includeNestedFolders property value. Indicates how the mailbox folder hierarchy should be traversed in the search. true means that a deep search should be done to include child folders in the hierarchy of each folder explicitly specified in sourceFolderIds. false means a shallow search of only each of the folders explicitly specified in sourceFolderIds.

Returns:

  • a boolean



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

def include_nested_folders
    return @include_nested_folders
end

#include_nested_folders=(value) ⇒ Object

Sets the includeNestedFolders property value. Indicates how the mailbox folder hierarchy should be traversed in the search. true means that a deep search should be done to include child folders in the hierarchy of each folder explicitly specified in sourceFolderIds. false means a shallow search of only each of the folders explicitly specified in sourceFolderIds.

Parameters:

  • value —

    Value to set for the includeNestedFolders property.

Returns:

  • a void



77
78
79
 
# File 'lib/models/mail_search_folder.rb', line 77

def include_nested_folders=(value)
    @include_nested_folders = value
end

#is_supported ⇒ Object

Gets the isSupported property value. Indicates whether a search folder is editable using REST APIs.

Returns:

  • a boolean



84
85
86
 
# File 'lib/models/mail_search_folder.rb', line 84

def is_supported
    return @is_supported
end

#is_supported=(value) ⇒ Object

Sets the isSupported property value. Indicates whether a search folder is editable using REST APIs.

Parameters:

  • value —

    Value to set for the isSupported property.

Returns:

  • a void



92
93
94
 
# File 'lib/models/mail_search_folder.rb', line 92

def is_supported=(value)
    @is_supported = value
end

#serialize(writer) ⇒ Object

Serializes information the current object

Parameters:

  • writer —

    Serialization writer to use to serialize this model

Returns:

  • a void

Raises:

  • (StandardError) 


100
101
102
103
104
105
106
107
 
# File 'lib/models/mail_search_folder.rb', line 100

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_string_value("filterQuery", @filter_query)
    writer.write_boolean_value("includeNestedFolders", @include_nested_folders)
    writer.write_boolean_value("isSupported", @is_supported)
    writer.write_collection_of_primitive_values("sourceFolderIds", @source_folder_ids)
end

#source_folder_ids ⇒ Object

Gets the sourceFolderIds property value. The mailbox folders that should be mined.

Returns:

  • a string



112
113
114
 
# File 'lib/models/mail_search_folder.rb', line 112

def source_folder_ids
    return @source_folder_ids
end

#source_folder_ids=(value) ⇒ Object

Sets the sourceFolderIds property value. The mailbox folders that should be mined.

Parameters:

  • value —

    Value to set for the sourceFolderIds property.

Returns:

  • a void



120
121
122
 
# File 'lib/models/mail_search_folder.rb', line 120

def source_folder_ids=(value)
    @source_folder_ids = value
end