Class: MemoriClient::Engine::V2::Topic

Inherits:
Resource show all
Defined in:
lib/memori_client/engine/v2/topic.rb

Overview

Generated on 2025-01-27 16:56:16 +0000

Class Method Summary collapse

Methods inherited from Resource

build_url

Methods inherited from Resource

build_arguments, build_url, exec_http_request, validate_payload!

Class Method Details

.get_topic(strSessionID:, strTopicID:) ⇒ Object

‘GET /memori/v2/Topic/strSessionID/strTopicID`

Gets the details of a Topic object.

‘get_topic(strSessionID:, strTopicID:)`

Parameters:

  • strSessionID (string) —

    The session ID. required

  • strTopicID (string) —

    The Topic object ID. required



45
46
47
48
49
 
# File 'lib/memori_client/engine/v2/topic.rb', line 45

def self.get_topic(strSessionID:, strTopicID:)
  args = build_arguments(binding)

  exec_http_request('get', '/memori/v2/Topic/{strSessionID}/{strTopicID}', **args)
end

.list_topic_users(strSessionID:, strTopicID:) ⇒ Object

‘GET /memori/v2/TopicUsers/strSessionID/strTopicID`

Lists all User objects referencing a specified Topic object.

‘list_topic_users(strSessionID:, strTopicID:)`

Parameters:

  • strSessionID (string) —

    The session ID. required

  • strTopicID (string) —

    The Topic object ID. required



61
62
63
64
65
 
# File 'lib/memori_client/engine/v2/topic.rb', line 61

def self.list_topic_users(strSessionID:, strTopicID:)
  args = build_arguments(binding)

  exec_http_request('get', '/memori/v2/TopicUsers/{strSessionID}/{strTopicID}', **args)
end

.list_topic_users_paginated(strSessionID:, strTopicID:, from:, howMany:) ⇒ Object

‘GET /memori/v2/TopicUsers/strSessionID/strTopicID/from/howMany`

Lists User objects referencing a specified User object, with pagination.

‘list_topic_users_paginated(strSessionID:, strTopicID:, from:, howMany:)`

Parameters:

  • strSessionID (string) —

    The session ID. required

  • strTopicID (string) —

    The Topic object ID. required

  • from (integer) —

    The 0-based index of the first User object to list. required

  • howMany (integer) —

    The number of User objects to list. required



81
82
83
84
85
 
# File 'lib/memori_client/engine/v2/topic.rb', line 81

def self.list_topic_users_paginated(strSessionID:, strTopicID:, from:, howMany:)
  args = build_arguments(binding)

  exec_http_request('get', '/memori/v2/TopicUsers/{strSessionID}/{strTopicID}/{from}/{howMany}', **args)
end

.list_topics(strSessionID:) ⇒ Object

‘GET /memori/v2/Topics/strSessionID`

Lists all Topic objects.

‘list_topics(strSessionID:)`

Parameters:

  • strSessionID (string) —

    The session ID. required



11
12
13
14
15
 
# File 'lib/memori_client/engine/v2/topic.rb', line 11

def self.list_topics(strSessionID:)
  args = build_arguments(binding)

  exec_http_request('get', '/memori/v2/Topics/{strSessionID}', **args)
end

.list_topics_paginated(strSessionID:, from:, howMany:) ⇒ Object

‘GET /memori/v2/Topics/strSessionID/from/howMany`

Lists Topic objects with pagination.

‘list_topics_paginated(strSessionID:, from:, howMany:)`

Parameters:

  • strSessionID (string) —

    The session ID. required

  • from (integer) —

    The 0-based index of the first Topic object to list. required

  • howMany (integer) —

    The number of the Topic objects to list. required



29
30
31
32
33
 
# File 'lib/memori_client/engine/v2/topic.rb', line 29

def self.list_topics_paginated(strSessionID:, from:, howMany:)
  args = build_arguments(binding)

  exec_http_request('get', '/memori/v2/Topics/{strSessionID}/{from}/{howMany}', **args)
end