Class: TeamBattlesSdk::Generated::Models::ApiPrimaryStream

Inherits:
Object
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/teambattles_sdk/generated/models/api_primary_stream.rb

Overview

The user’s primary (highest-viewer) live stream.

Defined Under Namespace

Classes: ApiPrimaryStreamGameName, ApiPrimaryStreamLastLiveAt, ApiPrimaryStreamStartedAt, ApiPrimaryStreamStreamUrl, ApiPrimaryStreamThumbnailUrl, ApiPrimaryStreamTitle, ApiPrimaryStreamViewerCount

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

Creates a new instance of the appropriate class based on discriminator value

Parameters:

  • parse_node —

    The parse node to use to read the discriminator value and create the object

Returns:

  • a api_primary_stream

Raises:

  • (StandardError) 


41
42
43
44
 
# File 'lib/teambattles_sdk/generated/models/api_primary_stream.rb', line 41

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return ApiPrimaryStream.new
end

Instance Method Details

#game_name ⇒ Object

Gets the gameName property value. Game/category being streamed, when known.

Returns:

  • a api_primary_stream_game_name



49
50
51
 
# File 'lib/teambattles_sdk/generated/models/api_primary_stream.rb', line 49

def game_name
    return @game_name
end

#game_name=(value) ⇒ Object

Sets the gameName property value. Game/category being streamed, when known.

Parameters:

  • value —

    Value to set for the gameName property.

Returns:

  • a void



57
58
59
 
# File 'lib/teambattles_sdk/generated/models/api_primary_stream.rb', line 57

def game_name=(value)
    @game_name = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/teambattles_sdk/generated/models/api_primary_stream.rb', line 64

def get_field_deserializers()
    return {
        "gameName" => lambda {|n| @game_name = n.get_object_value(lambda {|pn| ApiPrimaryStream::ApiPrimaryStreamGameName.create_from_discriminator_value(pn) }) },
        "lastLiveAt" => lambda {|n| @last_live_at = n.get_object_value(lambda {|pn| ApiPrimaryStream::ApiPrimaryStreamLastLiveAt.create_from_discriminator_value(pn) }) },
        "platform" => lambda {|n| @platform = n.get_enum_value(TeamBattlesSdk::Generated::Models::StreamPlatform) },
        "startedAt" => lambda {|n| @started_at = n.get_object_value(lambda {|pn| ApiPrimaryStream::ApiPrimaryStreamStartedAt.create_from_discriminator_value(pn) }) },
        "streamUrl" => lambda {|n| @stream_url = n.get_object_value(lambda {|pn| ApiPrimaryStream::ApiPrimaryStreamStreamUrl.create_from_discriminator_value(pn) }) },
        "thumbnailUrl" => lambda {|n| @thumbnail_url = n.get_object_value(lambda {|pn| ApiPrimaryStream::ApiPrimaryStreamThumbnailUrl.create_from_discriminator_value(pn) }) },
        "title" => lambda {|n| @title = n.get_object_value(lambda {|pn| ApiPrimaryStream::ApiPrimaryStreamTitle.create_from_discriminator_value(pn) }) },
        "viewerCount" => lambda {|n| @viewer_count = n.get_object_value(lambda {|pn| ApiPrimaryStream::ApiPrimaryStreamViewerCount.create_from_discriminator_value(pn) }) },
    }
end

#last_live_at ⇒ Object

Gets the lastLiveAt property value. ISO timestamp the user was last observed live, when known.

Returns:

  • a api_primary_stream_last_live_at



80
81
82
 
# File 'lib/teambattles_sdk/generated/models/api_primary_stream.rb', line 80

def last_live_at
    return @last_live_at
end

#last_live_at=(value) ⇒ Object

Sets the lastLiveAt property value. ISO timestamp the user was last observed live, when known.

Parameters:

  • value —

    Value to set for the lastLiveAt property.

Returns:

  • a void



88
89
90
 
# File 'lib/teambattles_sdk/generated/models/api_primary_stream.rb', line 88

def last_live_at=(value)
    @last_live_at = value
end

#platform ⇒ Object

Gets the platform property value. Supported streaming platform.

Returns:

  • a stream_platform



95
96
97
 
# File 'lib/teambattles_sdk/generated/models/api_primary_stream.rb', line 95

def platform
    return @platform
end

#platform=(value) ⇒ Object

Sets the platform property value. Supported streaming platform.

Parameters:

  • value —

    Value to set for the platform property.

Returns:

  • a void



103
104
105
 
# File 'lib/teambattles_sdk/generated/models/api_primary_stream.rb', line 103

def platform=(value)
    @platform = value
end

#serialize(writer) ⇒ Object

Serializes information the current object

Parameters:

  • writer —

    Serialization writer to use to serialize this model

Returns:

  • a void

Raises:

  • (StandardError) 


111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/teambattles_sdk/generated/models/api_primary_stream.rb', line 111

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_object_value("gameName", @game_name)
    writer.write_object_value("lastLiveAt", @last_live_at)
    writer.write_enum_value("platform", @platform)
    writer.write_object_value("startedAt", @started_at)
    writer.write_object_value("streamUrl", @stream_url)
    writer.write_object_value("thumbnailUrl", @thumbnail_url)
    writer.write_object_value("title", @title)
    writer.write_object_value("viewerCount", @viewer_count)
end

#started_at ⇒ Object

Gets the startedAt property value. Stream start time (platform-provided ISO timestamp), when known.

Returns:

  • a api_primary_stream_started_at



126
127
128
 
# File 'lib/teambattles_sdk/generated/models/api_primary_stream.rb', line 126

def started_at
    return @started_at
end

#started_at=(value) ⇒ Object

Sets the startedAt property value. Stream start time (platform-provided ISO timestamp), when known.

Parameters:

  • value —

    Value to set for the startedAt property.

Returns:

  • a void



134
135
136
 
# File 'lib/teambattles_sdk/generated/models/api_primary_stream.rb', line 134

def started_at=(value)
    @started_at = value
end

#stream_url ⇒ Object

Gets the streamUrl property value. Watch URL, when known.

Returns:

  • a api_primary_stream_stream_url



141
142
143
 
# File 'lib/teambattles_sdk/generated/models/api_primary_stream.rb', line 141

def stream_url
    return @stream_url
end

#stream_url=(value) ⇒ Object

Sets the streamUrl property value. Watch URL, when known.

Parameters:

  • value —

    Value to set for the streamUrl property.

Returns:

  • a void



149
150
151
 
# File 'lib/teambattles_sdk/generated/models/api_primary_stream.rb', line 149

def stream_url=(value)
    @stream_url = value
end

#thumbnail_url ⇒ Object

Gets the thumbnailUrl property value. Stream thumbnail URL, when known.

Returns:

  • a api_primary_stream_thumbnail_url



156
157
158
 
# File 'lib/teambattles_sdk/generated/models/api_primary_stream.rb', line 156

def thumbnail_url
    return @thumbnail_url
end

#thumbnail_url=(value) ⇒ Object

Sets the thumbnailUrl property value. Stream thumbnail URL, when known.

Parameters:

  • value —

    Value to set for the thumbnailUrl property.

Returns:

  • a void



164
165
166
 
# File 'lib/teambattles_sdk/generated/models/api_primary_stream.rb', line 164

def thumbnail_url=(value)
    @thumbnail_url = value
end

#title ⇒ Object

Gets the title property value. Stream title, when known.

Returns:

  • a api_primary_stream_title



171
172
173
 
# File 'lib/teambattles_sdk/generated/models/api_primary_stream.rb', line 171

def title
    return @title
end

#title=(value) ⇒ Object

Sets the title property value. Stream title, when known.

Parameters:

  • value —

    Value to set for the title property.

Returns:

  • a void



179
180
181
 
# File 'lib/teambattles_sdk/generated/models/api_primary_stream.rb', line 179

def title=(value)
    @title = value
end

#viewer_count ⇒ Object

Gets the viewerCount property value. Current viewer count, when known.

Returns:

  • a api_primary_stream_viewer_count



186
187
188
 
# File 'lib/teambattles_sdk/generated/models/api_primary_stream.rb', line 186

def viewer_count
    return @viewer_count
end

#viewer_count=(value) ⇒ Object

Sets the viewerCount property value. Current viewer count, when known.

Parameters:

  • value —

    Value to set for the viewerCount property.

Returns:

  • a void



194
195
196
 
# File 'lib/teambattles_sdk/generated/models/api_primary_stream.rb', line 194

def viewer_count=(value)
    @viewer_count = value
end