Class: Knockapi::Models::Providers::SlackListChannelsParams::QueryOptions

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/knockapi/models/providers/slack_list_channels_params.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(cursor: nil, exclude_archived: nil, limit: nil, team_id: nil, types: nil) ⇒ Object

Some parameter documentations has been truncated, see Knockapi::Models::Providers::SlackListChannelsParams::QueryOptions for more details.

Parameters:

  • cursor (String) (defaults to: nil) —

    Paginate through collections of data by setting the cursor parameter to a next_c

  • exclude_archived (Boolean) (defaults to: nil) —

    Set to true to exclude archived channels from the list. Defaults to ‘true` when

  • limit (Integer) (defaults to: nil) —

    The maximum number of channels to return. Defaults to 200.

  • team_id (String) (defaults to: nil) —

    Encoded team ID (T1234) to list channels in, required if org token is used.

  • types (String) (defaults to: nil) —

    Mix and match channel types by providing a comma-separated list of any combinati



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/knockapi/models/providers/slack_list_channels_params.rb', line 29

class QueryOptions < Knockapi::Internal::Type::BaseModel
  # @!attribute cursor
  #   Paginate through collections of data by setting the cursor parameter to a
  #   next_cursor attribute returned by a previous request's response_metadata.
  #   Default value fetches the first "page" of the collection.
  #
  #   @return [String, nil]
  optional :cursor, String

  # @!attribute exclude_archived
  #   Set to true to exclude archived channels from the list. Defaults to `true` when
  #   not explicitly provided.
  #
  #   @return [Boolean, nil]
  optional :exclude_archived, Knockapi::Internal::Type::Boolean

  # @!attribute limit
  #   The maximum number of channels to return. Defaults to 200.
  #
  #   @return [Integer, nil]
  optional :limit, Integer

  # @!attribute team_id
  #   Encoded team ID (T1234) to list channels in, required if org token is used.
  #
  #   @return [String, nil]
  optional :team_id, String

  # @!attribute types
  #   Mix and match channel types by providing a comma-separated list of any
  #   combination of public_channel, private_channel, mpim, im. Defaults to
  #   `"public_channel,private_channel"`. If the user's Slack ID is unavailable, this
  #   option is ignored and only public channels are returned.
  #
  #   @return [String, nil]
  optional :types, String

  # @!method initialize(cursor: nil, exclude_archived: nil, limit: nil, team_id: nil, types: nil)
  #   Some parameter documentations has been truncated, see
  #   {Knockapi::Models::Providers::SlackListChannelsParams::QueryOptions} for more
  #   details.
  #
  #   @param cursor [String] Paginate through collections of data by setting the cursor parameter to a next_c
  #
  #   @param exclude_archived [Boolean] Set to true to exclude archived channels from the list. Defaults to `true` when
  #
  #   @param limit [Integer] The maximum number of channels to return. Defaults to 200.
  #
  #   @param team_id [String] Encoded team ID (T1234) to list channels in, required if org token is used.
  #
  #   @param types [String] Mix and match channel types by providing a comma-separated list of any combinati
end

Instance Attribute Details

#cursor ⇒ String?

Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request’s response_metadata. Default value fetches the first “page” of the collection.

Returns:

  • (String, nil) 


36
 
# File 'lib/knockapi/models/providers/slack_list_channels_params.rb', line 36

optional :cursor, String

#exclude_archived ⇒ Boolean?

Set to true to exclude archived channels from the list. Defaults to ‘true` when not explicitly provided.

Returns:

  • (Boolean, nil) 


43
 
# File 'lib/knockapi/models/providers/slack_list_channels_params.rb', line 43

optional :exclude_archived, Knockapi::Internal::Type::Boolean

#limit ⇒ Integer?

The maximum number of channels to return. Defaults to 200.

Returns:

  • (Integer, nil) 


49
 
# File 'lib/knockapi/models/providers/slack_list_channels_params.rb', line 49

optional :limit, Integer

#team_id ⇒ String?

Encoded team ID (T1234) to list channels in, required if org token is used.

Returns:

  • (String, nil) 


55
 
# File 'lib/knockapi/models/providers/slack_list_channels_params.rb', line 55

optional :team_id, String

#types ⇒ String?

Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im. Defaults to ‘“public_channel,private_channel”`. If the user’s Slack ID is unavailable, this option is ignored and only public channels are returned.

Returns:

  • (String, nil) 


64
 
# File 'lib/knockapi/models/providers/slack_list_channels_params.rb', line 64

optional :types, String