Class: MicrosoftGraph::Drives::Item::Special::SpecialRequestBuilder

Inherits:
MicrosoftKiotaAbstractions::BaseRequestBuilder
  • Object
show all
Defined in:
lib/drives/item/special/special_request_builder.rb

Overview

Provides operations to manage the special property of the microsoft.graph.drive entity.

Defined Under Namespace

Classes: SpecialRequestBuilderGetQueryParameters

Instance Method Summary collapse

Constructor Details

#initialize(path_parameters, request_adapter) ⇒ Object

Instantiates a new SpecialRequestBuilder and sets the default values.

Parameters:

  • path_parameters —

    Path parameters for the request

  • request_adapter —

    The request adapter to use to execute the requests.



41
42
43
 
# File 'lib/drives/item/special/special_request_builder.rb', line 41

def initialize(path_parameters, request_adapter)
    super(path_parameters, request_adapter, "{+baseurl}/drives/{drive%2Did}/special{?%24top,%24skip,%24search,%24filter,%24count,%24orderby,%24select,%24expand}")
end

Instance Method Details

#by_drive_item_id(drive_item_id) ⇒ Object

Provides operations to manage the special property of the microsoft.graph.drive entity.

Parameters:

  • drive_item_id —

    The unique identifier of driveItem

Returns:

  • a drive_item_item_request_builder

Raises:

  • (StandardError) 


29
30
31
32
33
34
 
# File 'lib/drives/item/special/special_request_builder.rb', line 29

def by_drive_item_id(drive_item_id)
    raise StandardError, 'drive_item_id cannot be null' if drive_item_id.nil?
    url_tpl_params = @path_parameters.clone
    url_tpl_params["driveItem%2Did"] = drive_item_id
    return MicrosoftGraph::Drives::Item::Special::Item::DriveItemItemRequestBuilder.new(url_tpl_params, @request_adapter)
end

#count ⇒ Object

Provides operations to count the resources in the collection.



21
22
23
 
# File 'lib/drives/item/special/special_request_builder.rb', line 21

def count()
    return MicrosoftGraph::Drives::Item::Special::Count::CountRequestBuilder.new(@path_parameters, @request_adapter)
end

#get(request_configuration = nil) ⇒ Object

Use the special collection to access a special folder by name. Special folders provide simple aliases to access well-known folders in OneDrive without the need to look up the folder by path (which would require localization), or reference the folder with an ID. If a special folder is renamed or moved to another location within the drive, this syntax will continue to find that folder. Special folders are automatically created the first time an application attempts to write to one, if it doesn't already exist. If a user deletes one, it is recreated when written to again.

Parameters:

  • request_configuration (defaults to: nil) —

    Configuration for the request such as headers, query parameters, and middleware options.

Returns:

  • a Fiber of drive_item_collection_response



49
50
51
52
53
54
55
56
57
 
# File 'lib/drives/item/special/special_request_builder.rb', line 49

def get(request_configuration=nil)
    request_info = self.to_get_request_information(
        request_configuration
    )
    error_mapping = Hash.new
    error_mapping["4XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrorsODataError.create_from_discriminator_value(pn) }
    error_mapping["5XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrorsODataError.create_from_discriminator_value(pn) }
    return @request_adapter.send_async(request_info, lambda {|pn| MicrosoftGraph::Models::DriveItemCollectionResponse.create_from_discriminator_value(pn) }, error_mapping)
end

#to_get_request_information(request_configuration = nil) ⇒ Object

Use the special collection to access a special folder by name. Special folders provide simple aliases to access well-known folders in OneDrive without the need to look up the folder by path (which would require localization), or reference the folder with an ID. If a special folder is renamed or moved to another location within the drive, this syntax will continue to find that folder. Special folders are automatically created the first time an application attempts to write to one, if it doesn't already exist. If a user deletes one, it is recreated when written to again.

Parameters:

  • request_configuration (defaults to: nil) —

    Configuration for the request such as headers, query parameters, and middleware options.

Returns:

  • a request_information



63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/drives/item/special/special_request_builder.rb', line 63

def to_get_request_information(request_configuration=nil)
    request_info = MicrosoftKiotaAbstractions::RequestInformation.new()
    request_info.url_template = @url_template
    request_info.path_parameters = @path_parameters
    request_info.http_method = :GET
    request_info.headers.add('Accept', 'application/json')
    unless request_configuration.nil?
        request_info.add_headers_from_raw_object(request_configuration.headers)
        request_info.set_query_string_parameters_from_raw_object(request_configuration.query_parameters)
        request_info.add_request_options(request_configuration.options)
    end
    return request_info
end