Class: Google::Apis::PeopleV1::ListConnectionsResponse

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/people_v1/classes.rb,
generated/google/apis/people_v1/representations.rb,
generated/google/apis/people_v1/representations.rb

Overview

The response to a request for the authenticated user's connections.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ListConnectionsResponse

Returns a new instance of ListConnectionsResponse.



1046
1047
1048
 
# File 'generated/google/apis/people_v1/classes.rb', line 1046

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#connections ⇒ Array<Google::Apis::PeopleV1::Person>

The list of people that the requestor is connected to. Corresponds to the JSON property connections

Returns:



1020
1021
1022
 
# File 'generated/google/apis/people_v1/classes.rb', line 1020

def connections
  @connections
end

#next_page_token ⇒ String

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. Corresponds to the JSON property nextPageToken

Returns:

  • (String) 


1026
1027
1028
 
# File 'generated/google/apis/people_v1/classes.rb', line 1026

def next_page_token
  @next_page_token
end

#next_sync_token ⇒ String

A token, which can be sent as sync_token to retrieve changes since the last request. Request must set request_sync_token to return the sync token. When the response is paginated, only the last page will contain nextSyncToken. Corresponds to the JSON property nextSyncToken

Returns:

  • (String) 


1033
1034
1035
 
# File 'generated/google/apis/people_v1/classes.rb', line 1033

def next_sync_token
  @next_sync_token
end

#total_items ⇒ Fixnum

The total number of items in the list without pagination. Corresponds to the JSON property totalItems

Returns:

  • (Fixnum) 


1038
1039
1040
 
# File 'generated/google/apis/people_v1/classes.rb', line 1038

def total_items
  @total_items
end

#total_people ⇒ Fixnum

DEPRECATED (Please use totalItems) The total number of people in the list without pagination. Corresponds to the JSON property totalPeople

Returns:

  • (Fixnum) 


1044
1045
1046
 
# File 'generated/google/apis/people_v1/classes.rb', line 1044

def total_people
  @total_people
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1051
1052
1053
1054
1055
1056
1057
 
# File 'generated/google/apis/people_v1/classes.rb', line 1051

def update!(**args)
  @connections = args[:connections] if args.key?(:connections)
  @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
  @next_sync_token = args[:next_sync_token] if args.key?(:next_sync_token)
  @total_items = args[:total_items] if args.key?(:total_items)
  @total_people = args[:total_people] if args.key?(:total_people)
end