Class: TeamBattlesSdk::Generated::Users::Item::Stream::StreamRequestBuilder

Inherits:
MicrosoftKiotaAbstractions::BaseRequestBuilder
  • Object
show all
Defined in:
lib/teambattles_sdk/generated/users/item/stream/stream_request_builder.rb

Overview

Builds and executes requests for operations under #users#identifier#stream

Instance Method Summary collapse

Constructor Details

#initialize(path_parameters, request_adapter) ⇒ Object

Instantiates a new StreamRequestBuilder and sets the default values.

Parameters:

  • path_parameters —

    Path parameters for the request

  • request_adapter —

    The request adapter to use to execute the requests.



24
25
26
 
# File 'lib/teambattles_sdk/generated/users/item/stream/stream_request_builder.rb', line 24

def initialize(path_parameters, request_adapter)
    super(path_parameters, request_adapter, "{+baseurl}/users/{identifier}/stream")
end

Instance Method Details

#get(request_configuration = nil) ⇒ Object

Returns whether a user is live, the platforms they are live on, and their primary (highest-viewer) stream details. The identifier may be a username or a Convex user ID. Visible for public or limited profiles, plus self; a private non-self profile returns 403. Unknown or currently-banned users return 404 (a banned user’s existence is not leaked). When offline, isLive is false, platforms is empty, and primaryStream is null. Requires stream.read.

Parameters:

  • request_configuration (defaults to: nil) —

    Configuration for the request such as headers, query parameters, and middleware options.

Returns:

  • a Fiber of api_stream_status_envelope



32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/teambattles_sdk/generated/users/item/stream/stream_request_builder.rb', line 32

def get(request_configuration=nil)
    request_info = self.to_get_request_information(
        request_configuration
    )
    error_mapping = Hash.new
    error_mapping["401"] = lambda {|pn| TeamBattlesSdk::Generated::Models::Error.create_from_discriminator_value(pn) }
    error_mapping["403"] = lambda {|pn| TeamBattlesSdk::Generated::Models::Error.create_from_discriminator_value(pn) }
    error_mapping["404"] = lambda {|pn| TeamBattlesSdk::Generated::Models::Error.create_from_discriminator_value(pn) }
    error_mapping["429"] = lambda {|pn| TeamBattlesSdk::Generated::Models::Error.create_from_discriminator_value(pn) }
    error_mapping["500"] = lambda {|pn| TeamBattlesSdk::Generated::Models::Error.create_from_discriminator_value(pn) }
    return @request_adapter.send_async(request_info, lambda {|pn| TeamBattlesSdk::Generated::Models::ApiStreamStatusEnvelope.create_from_discriminator_value(pn) }, error_mapping)
end

#to_get_request_information(request_configuration = nil) ⇒ Object

Returns whether a user is live, the platforms they are live on, and their primary (highest-viewer) stream details. The identifier may be a username or a Convex user ID. Visible for public or limited profiles, plus self; a private non-self profile returns 403. Unknown or currently-banned users return 404 (a banned user’s existence is not leaked). When offline, isLive is false, platforms is empty, and primaryStream is null. Requires stream.read.

Parameters:

  • request_configuration (defaults to: nil) —

    Configuration for the request such as headers, query parameters, and middleware options.

Returns:

  • a request_information



49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/teambattles_sdk/generated/users/item/stream/stream_request_builder.rb', line 49

def to_get_request_information(request_configuration=nil)
    request_info = MicrosoftKiotaAbstractions::RequestInformation.new()
    unless request_configuration.nil?
        request_info.add_headers_from_raw_object(request_configuration.headers)
        request_info.add_request_options(request_configuration.options)
    end
    request_info.url_template = @url_template
    request_info.path_parameters = @path_parameters
    request_info.http_method = :GET
    request_info.headers.try_add('Accept', 'application/json')
    return request_info
end

#with_url(raw_url) ⇒ Object

Returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored.

Parameters:

  • raw_url —

    The raw URL to use for the request builder.

Returns:

  • a stream_request_builder

Raises:

  • (StandardError) 


66
67
68
69
 
# File 'lib/teambattles_sdk/generated/users/item/stream/stream_request_builder.rb', line 66

def with_url(raw_url)
    raise StandardError, 'raw_url cannot be null' if raw_url.nil?
    return StreamRequestBuilder.new(raw_url, @request_adapter)
end