Class: Wikidotrb::Module::ClientPrivateMessageMethods

Inherits:
Object
  • Object
show all
Defined in:
lib/wikidotrb/module/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ClientPrivateMessageMethods

Returns a new instance of ClientPrivateMessageMethods.



40
41
42
 
# File 'lib/wikidotrb/module/client.rb', line 40

def initialize(client)
  @client = client
end

Instance Attribute Details

#client (readonly)

Returns the value of attribute client.



38
39
40
 
# File 'lib/wikidotrb/module/client.rb', line 38

def client
  @client
end

Instance Method Details

#get_inbox ⇒ PrivateMessageInbox

Get inbox

Returns:



56
57
58
 
# File 'lib/wikidotrb/module/client.rb', line 56

def get_inbox
  Wikidotrb::Module::PrivateMessageInbox.acquire(client: @client)
end

#get_message(message_id) ⇒ PrivateMessage

Get a message

Parameters:

  • message_id (Integer) —

    Message ID

Returns:



76
77
78
 
# File 'lib/wikidotrb/module/client.rb', line 76

def get_message(message_id)
  Wikidotrb::Module::PrivateMessage.from_id(client: @client, message_id: message_id)
end

#get_messages(message_ids) ⇒ PrivateMessageCollection

Get messages

Parameters:

  • message_ids (Array<Integer>) —

    List of message IDs

Returns:



69
70
71
 
# File 'lib/wikidotrb/module/client.rb', line 69

def get_messages(message_ids)
  Wikidotrb::Module::PrivateMessageCollection.from_ids(client: @client, message_ids: message_ids)
end

#get_sentbox ⇒ PrivateMessageSentBox

Get sent box

Returns:



62
63
64
 
# File 'lib/wikidotrb/module/client.rb', line 62

def get_sentbox
  Wikidotrb::Module::PrivateMessageSentBox.acquire(client: @client)
end

#send_message(recipient, subject, body)

Send a message

Parameters:

  • recipient (User) —

    Recipient

  • subject (String) —

    Subject

  • body (String) —

    Message body



48
49
50
51
52
 
# File 'lib/wikidotrb/module/client.rb', line 48

def send_message(recipient, subject, body)
  Wikidotrb::Module::PrivateMessage.send_message(
    client: @client, recipient: recipient, subject: subject, body: body
  )
end