Module: CloudConnect::Client::Messages

Included in:
CloudConnect::Client
Defined in:
lib/cloud_connect/client/messages.rb

Defined Under Namespace

Modules: MessageMethods

Instance Method Summary collapse

Instance Method Details

#asset_messages(imei, options = {}) ⇒ Array

Get messages from an asset

Examples:

Get messages from the asset 351732050019192

@client = CloudConnect::Client.new(:account => 'foo', :token => 'bar')
@client.asset_messages("351732050019192")

Parameters:

  • imei (String) —

    IMEI of the asset

Returns:

  • (Array) —

    The messages you requested, if it exists

See Also:



36
37
38
 
# File 'lib/cloud_connect/client/messages.rb', line 36

def asset_messages(imei, options={})
  enhance( get("assets/#{imei}/messages", options), with: MessageMethods )
end

#message(id, options = {}) ⇒ Message

Get a message

Examples:

Get message 380342888036303061

@client = CloudConnect::Client.new(:account => 'foo', :token => 'bar')
@client.message("380342888036303061")

Parameters:

  • id (String) —

    ID of the message

Returns:

  • (Message) —

    The message you requested, if it exists

See Also:



12
13
14
 
# File 'lib/cloud_connect/client/messages.rb', line 12

def message(id, options={})
  enhance( get("messages/#{id}", options), with: MessageMethods )
end

#messages(options = {}) ⇒ Array Also known as: list_messages

Get all messages

Examples:

List all messages

@client = CloudConnect::Client.new(:account => 'foo', :token => 'bar')
@client.messages

Returns:

  • (Array) —

    A list of all messages

See Also:



47
48
49
 
# File 'lib/cloud_connect/client/messages.rb', line 47

def messages(options={})
  enhance( get("messages", options), with: MessageMethods )
end

#search_messages(search_term, options = {}) ⇒ Array

Search messages

Examples:

Search for ‘123’ in the messages

@client = CloudConnect::Client.new(:account => 'foor', :token => 'bar')
@client.search_messages

Parameters:

  • search_term (String) —

    The term to search for

Returns:

  • (Array) —

    A list of messages matching the search term

See Also:



24
25
26
 
# File 'lib/cloud_connect/client/messages.rb', line 24

def search_messages(search_term, options={})
  enhance( get("messages?q=#{search_term}", options), with: MessageMethods )
end

#send_message(imei, channel, payload, options = {}) ⇒ Message

Send a message to the unit

Parameters:

  • imei (String) —

    IMEI of the asset

  • channel (String) —

    Channel for the message

  • payload (String) —

    Payload of the message to send

Returns:

  • (Message) —

    The message

See Also:



59
60
61
 
# File 'lib/cloud_connect/client/messages.rb', line 59

def send_message(imei, channel, payload, options={})
  enhance( post("messages", options.merge({recipient: imei, asset: imei, channel: channel, b64_payload: Base64.encode64(payload)})), with: MessageMethods )
end