Class: MicrosoftGraph::Education::Classes::Item::Teachers::TeachersRequestBuilder

Inherits:
MicrosoftKiotaAbstractions::BaseRequestBuilder
  • Object
show all
Defined in:
lib/education/classes/item/teachers/teachers_request_builder.rb

Overview

Provides operations to manage the teachers property of the microsoft.graph.educationClass entity.

Defined Under Namespace

Classes: TeachersRequestBuilderGetQueryParameters

Instance Method Summary collapse

Constructor Details

#initialize(path_parameters, request_adapter) ⇒ Object

Instantiates a new TeachersRequestBuilder and sets the default values.

Parameters:

  • path_parameters —

    Path parameters for the request

  • request_adapter —

    The request adapter to use to execute the requests.



49
50
51
 
# File 'lib/education/classes/item/teachers/teachers_request_builder.rb', line 49

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

Instance Method Details

#by_education_user_id(education_user_id) ⇒ Object

Gets an item from the MicrosoftGraph.education.classes.item.teachers.item collection

Parameters:

  • education_user_id —

    Unique identifier of the item

Returns:

  • a education_user_item_request_builder

Raises:

  • (StandardError) 


37
38
39
40
41
42
 
# File 'lib/education/classes/item/teachers/teachers_request_builder.rb', line 37

def by_education_user_id(education_user_id)
    raise StandardError, 'education_user_id cannot be null' if education_user_id.nil?
    url_tpl_params = @path_parameters.clone
    url_tpl_params["educationUser%2Did"] = education_user_id
    return MicrosoftGraph::Education::Classes::Item::Teachers::Item::EducationUserItemRequestBuilder.new(url_tpl_params, @request_adapter)
end

#count ⇒ Object

Provides operations to count the resources in the collection.



24
25
26
 
# File 'lib/education/classes/item/teachers/teachers_request_builder.rb', line 24

def count()
    return MicrosoftGraph::Education::Classes::Item::Teachers::Count::CountRequestBuilder.new(@path_parameters, @request_adapter)
end

#get(request_configuration = nil) ⇒ Object

Retrieve a list teachers for a class. Delegated tokens must be members of the class to get the teacher list.

Parameters:

  • request_configuration (defaults to: nil) —

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

Returns:

  • a Fiber of education_user_collection_response



57
58
59
60
61
62
63
64
65
 
# File 'lib/education/classes/item/teachers/teachers_request_builder.rb', line 57

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::EducationUserCollectionResponse.create_from_discriminator_value(pn) }, error_mapping)
end

#ref ⇒ Object

Provides operations to manage the collection of educationRoot entities.



29
30
31
 
# File 'lib/education/classes/item/teachers/teachers_request_builder.rb', line 29

def ref()
    return MicrosoftGraph::Education::Classes::Item::Teachers::Ref::RefRequestBuilder.new(@path_parameters, @request_adapter)
end

#to_get_request_information(request_configuration = nil) ⇒ Object

Retrieve a list teachers for a class. Delegated tokens must be members of the class to get the teacher list.

Parameters:

  • request_configuration (defaults to: nil) —

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

Returns:

  • a request_information



71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/education/classes/item/teachers/teachers_request_builder.rb', line 71

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