Class: MicrosoftGraph::Education::Me::Assignments::AssignmentsRequestBuilder::AssignmentsRequestBuilderGetQueryParameters

Inherits:
Object
  • Object
show all
Defined in:
lib/education/me/assignments/assignments_request_builder.rb

Overview

Returns a list of educationAssignment assigned to a educationUser for all classes. Only teachers, students, and applications with application permissions can perform this operation. This method allows a caller to find all the assignments belonging to a student or a teacher in a single call rather than having to request assignments from each class. The assignment list contains what is needed to get the detailed information for the assignment from within the class namespace. Use the methods defined for the assignment for all other operations.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#countObject

Include count of items



126
127
128
# File 'lib/education/me/assignments/assignments_request_builder.rb', line 126

def count
  @count
end

#expandObject

Expand related entities



129
130
131
# File 'lib/education/me/assignments/assignments_request_builder.rb', line 129

def expand
  @expand
end

#filterObject

Filter items by property values



132
133
134
# File 'lib/education/me/assignments/assignments_request_builder.rb', line 132

def filter
  @filter
end

#orderbyObject

Order items by property values



135
136
137
# File 'lib/education/me/assignments/assignments_request_builder.rb', line 135

def orderby
  @orderby
end

#searchObject

Search items by search phrases



138
139
140
# File 'lib/education/me/assignments/assignments_request_builder.rb', line 138

def search
  @search
end

#selectObject

Select properties to be returned



141
142
143
# File 'lib/education/me/assignments/assignments_request_builder.rb', line 141

def select
  @select
end

#skipObject

Skip the first n items



144
145
146
# File 'lib/education/me/assignments/assignments_request_builder.rb', line 144

def skip
  @skip
end

#topObject

Show only the first n items



147
148
149
# File 'lib/education/me/assignments/assignments_request_builder.rb', line 147

def top
  @top
end

Instance Method Details

#get_query_parameter(original_name) ⇒ Object

Maps the query parameters names to their encoded names for the URI template parsing.

Parameters:

  • original_name

    The original query parameter name in the class.

Returns:

  • a string

Raises:

  • (StandardError)


153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
# File 'lib/education/me/assignments/assignments_request_builder.rb', line 153

def get_query_parameter(original_name)
    raise StandardError, 'original_name cannot be null' if original_name.nil?
    case original_name
        when "count"
            return "%24count"
        when "expand"
            return "%24expand"
        when "filter"
            return "%24filter"
        when "orderby"
            return "%24orderby"
        when "search"
            return "%24search"
        when "select"
            return "%24select"
        when "skip"
            return "%24skip"
        when "top"
            return "%24top"
        else
            return original_name
    end
end