Class: WhopSDK::Models::PageInfo

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/whop_sdk/models/page_info.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(end_cursor: , has_next_page: , has_previous_page: , start_cursor: ) ⇒ Object

Information about pagination in a connection.

Parameters:

  • end_cursor (String, nil) (defaults to: ) —

    When paginating forwards, the cursor to continue.

  • has_next_page (Boolean) (defaults to: ) —

    When paginating forwards, are there more items?

  • has_previous_page (Boolean) (defaults to: ) —

    When paginating backwards, are there more items?

  • start_cursor (String, nil) (defaults to: ) —

    When paginating backwards, the cursor to continue.




# File 'lib/whop_sdk/models/page_info.rb', line 30

Instance Attribute Details

#end_cursor ⇒ String?

When paginating forwards, the cursor to continue.

Returns:

  • (String, nil) 


10
 
# File 'lib/whop_sdk/models/page_info.rb', line 10

required :end_cursor, String, nil?: true

#has_next_page ⇒ Boolean

When paginating forwards, are there more items?

Returns:

  • (Boolean) 


16
 
# File 'lib/whop_sdk/models/page_info.rb', line 16

required :has_next_page, WhopSDK::Internal::Type::Boolean

#has_previous_page ⇒ Boolean

When paginating backwards, are there more items?

Returns:

  • (Boolean) 


22
 
# File 'lib/whop_sdk/models/page_info.rb', line 22

required :has_previous_page, WhopSDK::Internal::Type::Boolean

#start_cursor ⇒ String?

When paginating backwards, the cursor to continue.

Returns:

  • (String, nil) 


28
 
# File 'lib/whop_sdk/models/page_info.rb', line 28

required :start_cursor, String, nil?: true