Sha256: 446b0af0490eaab4f704208af482094b43185087e1097873f0871ce43d11aadc

Contents?: true

Size: 821 Bytes

Versions: 14

Compression:

Stored size: 821 Bytes

Contents

module Zype
  # Read more at https://docs.zype.com/v1.0/reference#live-events
  #
  # @since 0.1.0
  class LiveEvents < Zype::BaseModel
    # Starts broadcasting a live event
    #
    # @param id [String] the ID of the live event
    # @return [Hash] the live event
    def start(id:)
      client.execute(method: :put, path: "/live_events/#{id}/start")
    end

    # Stops broadcasting a live event
    #
    # @param id [String] the ID of the live event
    # @return [Hash] the live event
    def stop(id:)
      client.execute(method: :put, path: "/live_events/#{id}/stop")
    end

    # Archives the live event
    #
    # @param id [String] the ID of the live event
    # @return [Hash] the live event
    def archive(id:)
      client.execute(method: :put, path: "/live_events/#{id}/archive")
    end
  end
end

Version data entries

14 entries across 14 versions & 1 rubygems

Version Path
zype-0.20.0 lib/zype/models/live_events.rb
zype-0.19.0 lib/zype/models/live_events.rb
zype-0.18.0 lib/zype/models/live_events.rb
zype-0.17.0 lib/zype/models/live_events.rb
zype-0.16.1 lib/zype/models/live_events.rb
zype-0.16.0 lib/zype/models/live_events.rb
zype-0.15.0 lib/zype/models/live_events.rb
zype-0.14.0 lib/zype/models/live_events.rb
zype-0.13.0 lib/zype/models/live_events.rb
zype-0.12.0 lib/zype/models/live_events.rb
zype-0.11.0 lib/zype/models/live_events.rb
zype-0.10.0 lib/zype/models/live_events.rb
zype-0.9.0 lib/zype/models/live_events.rb
zype-0.8.0 lib/zype/models/live_events.rb