Class: Appwrite::Activities

Inherits:
Service
  • Object
show all
Defined in:
lib/appwrite/services/activities.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Activities

Returns a new instance of Activities.



6
7
8
 
# File 'lib/appwrite/services/activities.rb', line 6

def initialize(client)
    @client = client
end

Instance Method Details

#get_event(event_id:) ⇒ ActivityEvent

Get event by ID.

Parameters:

  • event_id (String) —

    Event ID.

Returns:

  • (ActivityEvent) 


43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/appwrite/services/activities.rb', line 43

def get_event(event_id:)
    api_path = '/activities/events/{eventId}'
        .gsub('{eventId}', event_id)

    if event_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "eventId"')
    end

    api_params = {
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "accept": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ActivityEvent
    )

end

#list_events(queries: nil) ⇒ ActivityEventList

List all events for selected filters.

Parameters:

  • queries (String) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. Learn more about queries. Maximum of 100 queries are allowed, each 4096 characters long. You may filter on attributes such as userId, teamId, etc.

Returns:

  • (ActivityEventList) 


15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/appwrite/services/activities.rb', line 15

def list_events(queries: nil)
    api_path = '/activities/events'

    api_params = {
        queries: queries,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "accept": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ActivityEventList
    )

end