Module: Messages

Included in:
Content
Defined in:
lib/user/content/messages.rb

Instance Method Summary collapse

Instance Method Details

#create_message(data, options = nil) ⇒ Object

Create message.

Create a message with data.

Parameters

data

(Hash) – Data to be submitted.

Example

data = {
  type: 'text',
  conversation_id: 1,
  sender_type: 'User',
  sender_id: 1,
  value: {
    text: 'Hello'
  }
}
@data = @mints_user.create_message(data)



59
60
61
 
# File 'lib/user/content/messages.rb', line 59

def create_message(data, options = nil)
  @client.raw('post', '/content/messages', options, data_transform(data))
end

#delete_message(id) ⇒ Object

Delete message.

Delete a message.

Parameters

id

(Integer) – Message id.

Example

@data = @mints_user.delete_message(101)



89
90
91
 
# File 'lib/user/content/messages.rb', line 89

def delete_message(id)
  @client.raw('delete', "/content/messages/#{id}")
end

#get_message(id, options = nil) ⇒ Object

Get message.

Get a message info.

Parameters

id

(Integer) – Message id.

options

(Hash) – List of Resource Collection Options shown above can be used as parameter.

First Example

@data = @mints_user.get_message(1)

Second Example

options = { fields: "value" }
@data = @mints_user.get_message(1, options)



38
39
40
 
# File 'lib/user/content/messages.rb', line 38

def get_message(id, options = nil)
  @client.raw('get', "/content/messages/#{id}", options)
end

#get_messages(options = nil) ⇒ Object

Get messages.

Get a collection of messages.

Parameters

options

(Hash) – List of Resource Collection Options shown above can be used as parameter.

First Example

@data = @mints_user.get_messages

Second Example

options = { fields: "value" }
@data = @mints_user.get_messages(options)



21
22
23
 
# File 'lib/user/content/messages.rb', line 21

def get_messages(options = nil)
  @client.raw('get', '/content/messages', options)
end

#update_message(id, data, options = nil) ⇒ Object

Update message.

Update a message info.

Parameters

id

(Integer) – Message id.

data

(Hash) – Data to be submitted.

Example

data = {
  value: {
    text: 'Hello World!'
  }
}
@data = @mints_user.update_message(102, data)



77
78
79
 
# File 'lib/user/content/messages.rb', line 77

def update_message(id, data, options = nil)
  @client.raw('put', "/content/messages/#{id}", options, data_transform(data))
end