Module: Ably::Models

Defined in:
lib/ably/models/stat.rb,
lib/ably/models/token.rb,
lib/ably/models/message.rb,
lib/ably/models/error_info.rb,
lib/ably/models/nil_logger.rb,
lib/ably/models/presence_message.rb,
lib/ably/models/protocol_message.rb,
lib/ably/models/paginated_resource.rb,
lib/ably/models/idiomatic_ruby_wrapper.rb

Defined Under Namespace

Modules: MessageEncoders Classes: ErrorInfo, IdiomaticRubyWrapper, Message, NilLogger, PaginatedResource, PresenceMessage, ProtocolMessage, Stat, Token

Class Method Summary collapse

Class Method Details

.Message(message, options = {}) ⇒ Message

Convert messsage argument to a Message object and associate with a protocol message if provided

Parameters:

  • message (Message, Hash) —

    A message object or Hash of message properties

  • options (Hash) (defaults to: {}) —

    (see Message#initialize)

Returns:



8
9
10
11
12
13
14
15
16
17
 
# File 'lib/ably/models/message.rb', line 8

def self.Message(message, options = {})
  case message
  when Message
    message.tap do
      message.assign_to_protocol_message options[:protocol_message] if options[:protocol_message]
    end
  else
    Message.new(message, options)
  end
end

.PresenceMessage(presence_message, options = {}) ⇒ PresenceMessage

Convert presence_messsage argument to a PresenceMessage object and associate with a protocol message if provided

Parameters:

  • presence_message (PresenceMessage, Hash) —

    A presence message object or Hash of presence message properties

  • options (Hash) (defaults to: {}) —

    (see PresenceMessage#initialize)

Returns:



8
9
10
11
12
13
14
15
16
17
 
# File 'lib/ably/models/presence_message.rb', line 8

def self.PresenceMessage(presence_message, options = {})
  case presence_message
  when PresenceMessage
    presence_message.tap do
      presence_message.assign_to_protocol_message options[:protocol_message] if options[:protocol_message]
    end
  else
    PresenceMessage.new(presence_message, options)
  end
end

.Stat(stat) ⇒ Stat

Convert stat argument to a Stat object

Parameters:

  • stat (Stat, Hash) —

    A Stat object or Hash of stat properties

Returns:



7
8
9
10
11
12
13
14
 
# File 'lib/ably/models/stat.rb', line 7

def self.Stat(stat)
  case stat
  when Stat
    stat
  else
    Stat.new(stat)
  end
end