Class: MicrosoftGraph::Users::Item::People::PeopleRequestBuilder::PeopleRequestBuilderGetQueryParameters

Inherits:
Object
  • Object
show all
Defined in:
lib/users/item/people/people_request_builder.rb

Overview

Retrieve a collection of person objects ordered by their relevance to the user, which is determined by the user’s communication and collaboration patterns, and business relationships. You can get this information via the People API. For examples, see the Examples section and the article Use the People API to get information about the people most relevant to you.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#countObject

Include count of items



83
84
85
# File 'lib/users/item/people/people_request_builder.rb', line 83

def count
  @count
end

#filterObject

Filter items by property values



86
87
88
# File 'lib/users/item/people/people_request_builder.rb', line 86

def filter
  @filter
end

#orderbyObject

Order items by property values



89
90
91
# File 'lib/users/item/people/people_request_builder.rb', line 89

def orderby
  @orderby
end

#searchObject

Search items by search phrases



92
93
94
# File 'lib/users/item/people/people_request_builder.rb', line 92

def search
  @search
end

#selectObject

Select properties to be returned



95
96
97
# File 'lib/users/item/people/people_request_builder.rb', line 95

def select
  @select
end

#skipObject

Skip the first n items



98
99
100
# File 'lib/users/item/people/people_request_builder.rb', line 98

def skip
  @skip
end

#topObject

Show only the first n items



101
102
103
# File 'lib/users/item/people/people_request_builder.rb', line 101

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)


107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
# File 'lib/users/item/people/people_request_builder.rb', line 107

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 "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