Class: Ably::Models::ChannelStatus

Inherits:
Object
  • Object
show all
Extended by:
Ably::Modules::Enum, Forwardable
Includes:
Ably::Modules::ModelCommon
Defined in:
lib/submodules/ably-ruby/lib/ably/models/channel_status.rb

Overview

ChannelStatus is a type that contains status and occupancy for a channel (CHS1)

Instance Attribute Summary collapse

Attributes included from Ably::Modules::ModelCommon

#hash

Instance Method Summary collapse

Methods included from Ably::Modules::ModelCommon

#==, #[], #as_json, included, #to_json, #to_s

Methods included from Ably::Modules::MessagePack

#to_msgpack

Constructor Details

#initialize(attrs) ⇒ ChannelStatus

Initialize a new ChannelStatus



31
32
33
 
# File 'lib/submodules/ably-ruby/lib/ably/models/channel_status.rb', line 31

def initialize(attrs)
  @attributes = IdiomaticRubyWrapper(attrs.clone)
end

Instance Attribute Details

#attributes ⇒ Object (readonly) Also known as: to_h

The attributes of ChannelStatus (CHS2)



25
26
27
 
# File 'lib/submodules/ably-ruby/lib/ably/models/channel_status.rb', line 25

def attributes
  @attributes
end

Instance Method Details

#is_active ⇒ Boolean Also known as: active?, is_active?

Represents if the channel is active (CHS2a)

Returns:

  • (Boolean) 


39
40
41
 
# File 'lib/submodules/ably-ruby/lib/ably/models/channel_status.rb', line 39

def is_active
  attributes[:isActive]
end

#occupancy ⇒ Ably::Models::ChannelOccupancy?

Occupancy ChannelOccupancy – occupancy is an object containing the metrics for the channel (CHS2b)

Returns:



49
50
51
 
# File 'lib/submodules/ably-ruby/lib/ably/models/channel_status.rb', line 49

def occupancy
  Ably::Models::ChannelOccupancy(attributes[:occupancy])
end