Module: Messages

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

Instance Method Summary collapse

Instance Method Details

#create_message(data) ⇒ Object

Create message.

Create a message with data.

Parameters

data

(Hash) – Data to be submited.

Example

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



57
58
59
 
# File 'lib/user/content/messages.rb', line 57

def create_message(data)
    return @client.raw("post", "/content/messages", nil, 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)



87
88
89
 
# File 'lib/user/content/messages.rb', line 87

def delete_message(id)
    return @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)



36
37
38
 
# File 'lib/user/content/messages.rb', line 36

def get_message(id, options = nil)
    return @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)



19
20
21
 
# File 'lib/user/content/messages.rb', line 19

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

#update_message(id, data) ⇒ Object

Update message.

Update a message info.

Parameters

id

(Integer) – Message id.

data

(Hash) – Data to be submited.

Example

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



75
76
77
 
# File 'lib/user/content/messages.rb', line 75

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