Class: Twilio::REST::Media::V1::PlayerStreamerContext::PlaybackGrantInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/media/v1/player_streamer/playback_grant.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ PlaybackGrantInstance

Initialize the PlaybackGrantInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The unique string generated to identify the PlayerStreamer resource that this PlaybackGrant authorizes views for.


126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/twilio-ruby/rest/media/v1/player_streamer/playback_grant.rb', line 126

def initialize(version, payload, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'url' => payload['url'],
      'account_sid' => payload['account_sid'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'grant' => payload['grant'],
  }

  # Context
  @instance_context = nil
  @params = {'sid' => sid, }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource


168
169
170
 
# File 'lib/twilio-ruby/rest/media/v1/player_streamer/playback_grant.rb', line 168

def 
  @properties['account_sid']
end

#context ⇒ PlaybackGrantContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:


147
148
149
150
151
152
 
# File 'lib/twilio-ruby/rest/media/v1/player_streamer/playback_grant.rb', line 147

def context
  unless @instance_context
    @instance_context = PlaybackGrantContext.new(@version, @params['sid'], )
  end
  @instance_context
end

#create(ttl: :unset, access_control_allow_origin: :unset) ⇒ PlaybackGrantInstance

Create the PlaybackGrantInstance

Parameters:

  • ttl (String) (defaults to: :unset) —

    The time to live of the PlaybackGrant. Default value is 15 seconds. Maximum value is 60 seconds.

  • access_control_allow_origin (String) (defaults to: :unset) —

    The full origin URL where the livestream can be streamed. If this is not provided, it can be streamed from any domain.

Returns:


192
193
194
 
# File 'lib/twilio-ruby/rest/media/v1/player_streamer/playback_grant.rb', line 192

def create(ttl: :unset, access_control_allow_origin: :unset)
  context.create(ttl: ttl, access_control_allow_origin: access_control_allow_origin, )
end

#date_created ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created


174
175
176
 
# File 'lib/twilio-ruby/rest/media/v1/player_streamer/playback_grant.rb', line 174

def date_created
  @properties['date_created']
end

#fetch ⇒ PlaybackGrantInstance

Fetch the PlaybackGrantInstance

Returns:


199
200
201
 
# File 'lib/twilio-ruby/rest/media/v1/player_streamer/playback_grant.rb', line 199

def fetch
  context.fetch
end

#grant ⇒ Hash

Returns The grant that authorizes the player sdk to connect to the livestream.

Returns:

  • (Hash) —

    The grant that authorizes the player sdk to connect to the livestream


180
181
182
 
# File 'lib/twilio-ruby/rest/media/v1/player_streamer/playback_grant.rb', line 180

def grant
  @properties['grant']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


212
213
214
215
 
# File 'lib/twilio-ruby/rest/media/v1/player_streamer/playback_grant.rb', line 212

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Media.V1.PlaybackGrantInstance #{values}>"
end

#sid ⇒ String

Returns The unique string that identifies the PlayerStreamer associated with this PlaybackGrant.

Returns:

  • (String) —

    The unique string that identifies the PlayerStreamer associated with this PlaybackGrant.


156
157
158
 
# File 'lib/twilio-ruby/rest/media/v1/player_streamer/playback_grant.rb', line 156

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation


205
206
207
208
 
# File 'lib/twilio-ruby/rest/media/v1/player_streamer/playback_grant.rb', line 205

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Media.V1.PlaybackGrantInstance #{values}>"
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource


162
163
164
 
# File 'lib/twilio-ruby/rest/media/v1/player_streamer/playback_grant.rb', line 162

def url
  @properties['url']
end