Class: Rixl::Videos::Item::Subtitles::SubtitlesRequestBuilder

Inherits:
MicrosoftKiotaAbstractions::BaseRequestBuilder
  • Object
show all
Defined in:
lib/videos/item/subtitles/subtitles_request_builder.rb

Overview

Builds and executes requests for operations under videosvideoIdsubtitles

Instance Method Summary collapse

Constructor Details

#initialize(path_parameters, request_adapter) ⇒ Object

Instantiates a new SubtitlesRequestBuilder and sets the default values.

Parameters:

  • path_parameters —

    Path parameters for the request

  • request_adapter —

    The request adapter to use to execute the requests.



41
42
43
 
# File 'lib/videos/item/subtitles/subtitles_request_builder.rb', line 41

def initialize(path_parameters, request_adapter)
    super(path_parameters, request_adapter, "{+baseurl}/videos/{videoId}/subtitles")
end

Instance Method Details

#by_subtitle_id(subtitle_id) ⇒ Object

Gets an item from the rixl.videos.item.subtitles.item collection

Parameters:

  • subtitle_id —

    Subtitle ID

Returns:

  • a with_subtitle_item_request_builder

Raises:

  • (StandardError) 


29
30
31
32
33
34
 
# File 'lib/videos/item/subtitles/subtitles_request_builder.rb', line 29

def by_subtitle_id(subtitle_id)
    raise StandardError, 'subtitle_id cannot be null' if subtitle_id.nil?
    url_tpl_params = @path_parameters.clone
    url_tpl_params["subtitleId"] = subtitle_id
    return Rixl::Videos::Item::Subtitles::Item::WithSubtitleItemRequestBuilder.new(url_tpl_params, @request_adapter)
end

#delete(request_configuration = nil) ⇒ Object

Remove all subtitles from a video using API key authentication

Parameters:

  • request_configuration (defaults to: nil) —

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

Returns:

  • a Fiber of subtitle_delete



49
50
51
52
53
54
 
# File 'lib/videos/item/subtitles/subtitles_request_builder.rb', line 49

def delete(request_configuration=nil)
    request_info = self.to_delete_request_information(
        request_configuration
    )
    return @request_adapter.send_async(request_info, lambda {|pn| Rixl::Models::SubtitleDelete.create_from_discriminator_value(pn) }, nil)
end

#language ⇒ Object

The language property



21
22
23
 
# File 'lib/videos/item/subtitles/subtitles_request_builder.rb', line 21

def language()
    return Rixl::Videos::Item::Subtitles::Language::LanguageRequestBuilder.new(@path_parameters, @request_adapter)
end

#post(body, request_configuration = nil) ⇒ Object

Replace all subtitles with the provided ones using API key authentication

Parameters:

  • body —

    The request body

  • request_configuration (defaults to: nil) —

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

Returns:

  • a Fiber of subtitle

Raises:

  • (StandardError) 


61
62
63
64
65
66
67
 
# File 'lib/videos/item/subtitles/subtitles_request_builder.rb', line 61

def post(body, request_configuration=nil)
    raise StandardError, 'body cannot be null' if body.nil?
    request_info = self.to_post_request_information(
        body, request_configuration
    )
    return @request_adapter.send_async(request_info, lambda {|pn| Rixl::Models::Subtitle.create_from_discriminator_value(pn) }, nil)
end

#to_delete_request_information(request_configuration = nil) ⇒ Object

Remove all subtitles from a video using API key authentication

Parameters:

  • request_configuration (defaults to: nil) —

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

Returns:

  • a request_information



73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/videos/item/subtitles/subtitles_request_builder.rb', line 73

def to_delete_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 = :DELETE
    request_info.headers.try_add('Accept', 'application/json')
    return request_info
end

#to_post_request_information(body, request_configuration = nil) ⇒ Object

Replace all subtitles with the provided ones using API key authentication

Parameters:

  • body —

    The request body

  • request_configuration (defaults to: nil) —

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

Returns:

  • a request_information

Raises:

  • (StandardError) 


91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/videos/item/subtitles/subtitles_request_builder.rb', line 91

def to_post_request_information(body, request_configuration=nil)
    raise StandardError, 'body cannot be null' if body.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.set_content_from_parsable(@request_adapter, 'multipart/form-data', body)
    request_info.url_template = @url_template
    request_info.path_parameters = @path_parameters
    request_info.http_method = :POST
    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 subtitles_request_builder

Raises:

  • (StandardError) 


110
111
112
113
 
# File 'lib/videos/item/subtitles/subtitles_request_builder.rb', line 110

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