Class: MicrosoftGraph::Models::DocumentSet

Inherits:
Object
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::AdditionalDataHolder, MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/document_set.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeObject

Instantiates a new documentSet and sets the default values.



70
71
72
# File 'lib/models/document_set.rb', line 70

def initialize()
    @additional_data = Hash.new
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 document_set

Raises:

  • (StandardError)


78
79
80
81
# File 'lib/models/document_set.rb', line 78

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

Instance Method Details

#additional_dataObject

Gets the additionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

Returns:

  • a i_dictionary



40
41
42
# File 'lib/models/document_set.rb', line 40

def additional_data
    return @additional_data
end

#additional_data=(value) ⇒ Object

Sets the additionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

Parameters:

  • value

    Value to set for the additionalData property.

Returns:

  • a void



48
49
50
# File 'lib/models/document_set.rb', line 48

def additional_data=(value)
    @additional_data = value
end

#allowed_content_typesObject

Gets the allowedContentTypes property value. Content types allowed in document set.

Returns:

  • a content_type_info



55
56
57
# File 'lib/models/document_set.rb', line 55

def allowed_content_types
    return @allowed_content_types
end

#allowed_content_types=(value) ⇒ Object

Sets the allowedContentTypes property value. Content types allowed in document set.

Parameters:

  • value

    Value to set for the allowedContentTypes property.

Returns:

  • a void



63
64
65
# File 'lib/models/document_set.rb', line 63

def allowed_content_types=(value)
    @allowed_content_types = value
end

#default_contentsObject

Gets the defaultContents property value. Default contents of document set.

Returns:

  • a document_set_content



86
87
88
# File 'lib/models/document_set.rb', line 86

def default_contents
    return @default_contents
end

#default_contents=(value) ⇒ Object

Sets the defaultContents property value. Default contents of document set.

Parameters:

  • value

    Value to set for the defaultContents property.

Returns:

  • a void



94
95
96
# File 'lib/models/document_set.rb', line 94

def default_contents=(value)
    @default_contents = value
end

#get_field_deserializersObject

The deserialization information for the current model

Returns:

  • a i_dictionary



101
102
103
104
105
106
107
108
109
110
111
112
# File 'lib/models/document_set.rb', line 101

def get_field_deserializers()
    return {
        "allowedContentTypes" => lambda {|n| @allowed_content_types = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::ContentTypeInfo.create_from_discriminator_value(pn) }) },
        "defaultContents" => lambda {|n| @default_contents = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::DocumentSetContent.create_from_discriminator_value(pn) }) },
        "@odata.type" => lambda {|n| @odata_type = n.get_string_value() },
        "propagateWelcomePageChanges" => lambda {|n| @propagate_welcome_page_changes = n.get_boolean_value() },
        "sharedColumns" => lambda {|n| @shared_columns = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::ColumnDefinition.create_from_discriminator_value(pn) }) },
        "shouldPrefixNameToFile" => lambda {|n| @should_prefix_name_to_file = n.get_boolean_value() },
        "welcomePageColumns" => lambda {|n| @welcome_page_columns = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::ColumnDefinition.create_from_discriminator_value(pn) }) },
        "welcomePageUrl" => lambda {|n| @welcome_page_url = n.get_string_value() },
    }
end

#odata_typeObject

Gets the @odata.type property value. The OdataType property

Returns:

  • a string



117
118
119
# File 'lib/models/document_set.rb', line 117

def odata_type
    return @odata_type
end

#odata_type=(value) ⇒ Object

Sets the @odata.type property value. The OdataType property

Parameters:

  • value

    Value to set for the @odata.type property.

Returns:

  • a void



125
126
127
# File 'lib/models/document_set.rb', line 125

def odata_type=(value)
    @odata_type = value
end

#propagate_welcome_page_changesObject

Gets the propagateWelcomePageChanges property value. Specifies whether to push welcome page changes to inherited content types.

Returns:

  • a boolean



132
133
134
# File 'lib/models/document_set.rb', line 132

def propagate_welcome_page_changes
    return @propagate_welcome_page_changes
end

#propagate_welcome_page_changes=(value) ⇒ Object

Sets the propagateWelcomePageChanges property value. Specifies whether to push welcome page changes to inherited content types.

Parameters:

  • value

    Value to set for the propagateWelcomePageChanges property.

Returns:

  • a void



140
141
142
# File 'lib/models/document_set.rb', line 140

def propagate_welcome_page_changes=(value)
    @propagate_welcome_page_changes = 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)


148
149
150
151
152
153
154
155
156
157
158
159
# File 'lib/models/document_set.rb', line 148

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_collection_of_object_values("allowedContentTypes", @allowed_content_types)
    writer.write_collection_of_object_values("defaultContents", @default_contents)
    writer.write_string_value("@odata.type", @odata_type)
    writer.write_boolean_value("propagateWelcomePageChanges", @propagate_welcome_page_changes)
    writer.write_collection_of_object_values("sharedColumns", @shared_columns)
    writer.write_boolean_value("shouldPrefixNameToFile", @should_prefix_name_to_file)
    writer.write_collection_of_object_values("welcomePageColumns", @welcome_page_columns)
    writer.write_string_value("welcomePageUrl", @welcome_page_url)
    writer.write_additional_data(@additional_data)
end

#shared_columnsObject

Gets the sharedColumns property value. The sharedColumns property

Returns:

  • a column_definition



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

def shared_columns
    return @shared_columns
end

#shared_columns=(value) ⇒ Object

Sets the sharedColumns property value. The sharedColumns property

Parameters:

  • value

    Value to set for the sharedColumns property.

Returns:

  • a void



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

def shared_columns=(value)
    @shared_columns = value
end

#should_prefix_name_to_fileObject

Gets the shouldPrefixNameToFile property value. Indicates whether to add the name of the document set to each file name.

Returns:

  • a boolean



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

def should_prefix_name_to_file
    return @should_prefix_name_to_file
end

#should_prefix_name_to_file=(value) ⇒ Object

Sets the shouldPrefixNameToFile property value. Indicates whether to add the name of the document set to each file name.

Parameters:

  • value

    Value to set for the shouldPrefixNameToFile property.

Returns:

  • a void



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

def should_prefix_name_to_file=(value)
    @should_prefix_name_to_file = value
end

#welcome_page_columnsObject

Gets the welcomePageColumns property value. The welcomePageColumns property

Returns:

  • a column_definition



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

def welcome_page_columns
    return @welcome_page_columns
end

#welcome_page_columns=(value) ⇒ Object

Sets the welcomePageColumns property value. The welcomePageColumns property

Parameters:

  • value

    Value to set for the welcomePageColumns property.

Returns:

  • a void



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

def welcome_page_columns=(value)
    @welcome_page_columns = value
end

#welcome_page_urlObject

Gets the welcomePageUrl property value. Welcome page absolute URL.

Returns:

  • a string



209
210
211
# File 'lib/models/document_set.rb', line 209

def welcome_page_url
    return @welcome_page_url
end

#welcome_page_url=(value) ⇒ Object

Sets the welcomePageUrl property value. Welcome page absolute URL.

Parameters:

  • value

    Value to set for the welcomePageUrl property.

Returns:

  • a void



217
218
219
# File 'lib/models/document_set.rb', line 217

def welcome_page_url=(value)
    @welcome_page_url = value
end