Class: Discorb::ScheduledEvent

Inherits:
DiscordModel show all
Defined in:
lib/discorb/event.rb

Overview

Represents an event in guild.

Defined Under Namespace

Classes: Metadata

Class Attribute Summary collapse

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from DiscordModel

#==, #eql?, #inspect

Class Attribute Details

.entity_type -> Object (readonly)

Returns the value of attribute entity_type.



286
287
288
 
# File 'lib/discorb/event.rb', line 286

def entity_type
  @entity_type
end

.privacy_level -> Object (readonly)

Returns the value of attribute privacy_level.



286
287
288
 
# File 'lib/discorb/event.rb', line 286

def privacy_level
  @privacy_level
end

.status -> Object (readonly)

Returns the value of attribute status.



286
287
288
 
# File 'lib/discorb/event.rb', line 286

def status
  @status
end

Instance Attribute Details

#channel -> Discorb::Channel? (readonly)

Returns The channel of the event. Only present if the event will do in stage instance or voice channel.

Returns:

  • (Discorb::Channel, nil) —

    The channel of the event. Only present if the event will do in stage instance or voice channel.



89
90
91
 
# File 'lib/discorb/event.rb', line 89

def guild
  @client.guilds[@guild_id]
end

#creator -> Discorb::User (readonly)

Returns The user who created the event.#.

Returns:



89
90
91
 
# File 'lib/discorb/event.rb', line 89

def guild
  @client.guilds[@guild_id]
end

#description -> String (readonly)

Returns The description of the event.

Returns:

  • (String) —

    The description of the event.



56
57
58
 
# File 'lib/discorb/event.rb', line 56

def description
  @description
end

#entity_id -> Discorb::Snowflake (readonly)

Returns The ID of the entity the event is for.

Returns:



73
74
75
 
# File 'lib/discorb/event.rb', line 73

def entity_id
  @entity_id
end

#entity_type -> :stage_instance, ... (readonly)

Returns The type of the event.

Returns:

  • (:stage_instance, :voice, :external) —

    The type of the event.



71
72
73
 
# File 'lib/discorb/event.rb', line 71

def entity_type
  @entity_type
end

#guild -> Object (readonly) 



89
90
91
 
# File 'lib/discorb/event.rb', line 89

def guild
  @client.guilds[@guild_id]
end

#id -> Discorb::Snowflake (readonly)

Returns The ID of the event.

Returns:



52
53
54
 
# File 'lib/discorb/event.rb', line 52

def id
  @id
end

#metadata -> Discorb::ScheduledEvent::Metadata (readonly)

Returns The metadata of the event.

Returns:



75
76
77
 
# File 'lib/discorb/event.rb', line 75

def metadata
  @metadata
end

#name -> String (readonly)

Returns The name of the event.

Returns:

  • (String) —

    The name of the event.



54
55
56
 
# File 'lib/discorb/event.rb', line 54

def name
  @name
end

#privacy_level -> :guild_only (readonly)

Returns The privacy level of the event.

Returns:

  • (:guild_only) —

    The privacy level of the event.



67
68
69
 
# File 'lib/discorb/event.rb', line 67

def privacy_level
  @privacy_level
end

#scheduled_end_time -> Time (readonly) Also known as: end_time, end_at

Returns The time the event ends.

Returns:

  • (Time) —

    The time the event ends.



63
64
65
 
# File 'lib/discorb/event.rb', line 63

def scheduled_end_time
  @scheduled_end_time
end

#scheduled_start_time -> Time (readonly) Also known as: start_time, start_at

Returns The time the event starts.

Returns:

  • (Time) —

    The time the event starts.



59
60
61
 
# File 'lib/discorb/event.rb', line 59

def scheduled_start_time
  @scheduled_start_time
end

#status -> :scheduled, ... (readonly)

Returns The status of the event.

Returns:

  • (:scheduled, :active, :completed, :canceled) —

    The status of the event.



69
70
71
 
# File 'lib/discorb/event.rb', line 69

def status
  @status
end

#time -> Range<Time> (readonly)

Returns The time range of the event.

Returns:

  • (Range<Time>) —

    The time range of the event.



89
90
91
 
# File 'lib/discorb/event.rb', line 89

def guild
  @client.guilds[@guild_id]
end

#user_count -> Integer (readonly)

Returns The user count of the event.

Returns:

  • (Integer) —

    The user count of the event.



77
78
79
 
# File 'lib/discorb/event.rb', line 77

def user_count
  @user_count
end

Instance Method Details

#cancel -> Object

Cancels the event. Shortcut for edit(status: :canceled).



206
207
208
 
# File 'lib/discorb/event.rb', line 206

def cancel
  edit(status: :canceled)
end

#complete -> Object Also known as: finish

Completes the event. Shortcut for edit(status: :completed).



197
198
199
 
# File 'lib/discorb/event.rb', line 197

def complete
  edit(status: :completed)
end

#delete! -> Async::Task<void> Also known as: destroy!

Deletes the event.

Returns:

  • (Async::Task<void>) —

    The task.



216
217
218
219
220
 
# File 'lib/discorb/event.rb', line 216

def delete!
  Async do
    @client.http.request(Route.new("/guilds/#{@guild_id}/scheduled-events/#{@id}", "//guilds/:guild_id/scheduled-events/:scheduled_event_id", :delete)).wait
  end
end

#edit(type: Discorb::Unset, name: Discorb::Unset, description: Discorb::Unset, start_time: Discorb::Unset, end_time: Discorb::Unset, privacy_level: Discorb::Unset, location: Discorb::Unset, channel: Discorb::Unset, status: Discorb::Unset) -> Async::Task<Discorb::ScheduledEvent> Also known as: modify

Create a scheduled event for the guild.

Parameters:

  • type (:stage_instance, :voice, :external) (defaults to: Discorb::Unset) —

    The type of event to create.

  • name (String) (defaults to: Discorb::Unset) —

    The name of the event.

  • description (String) (defaults to: Discorb::Unset) —

    The description of the event.

  • start_time (Time) (defaults to: Discorb::Unset) —

    The start time of the event.

  • end_time (Time, nil) (defaults to: Discorb::Unset) —

    The end time of the event. Defaults to nil.

  • channel (Discorb::Channel, Discorb::Snowflake, nil) (defaults to: Discorb::Unset) —

    The channel to run the event in.

  • location (String, nil) (defaults to: Discorb::Unset) —

    The location of the event. Defaults to nil.

  • privacy_level (:guild_only) (defaults to: Discorb::Unset) —

    The privacy level of the event. This must be :guild_only.

  • status (:active, :completed, :canceled) (defaults to: Discorb::Unset) —

    The status of the event.

Returns:

See Also:



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/discorb/event.rb', line 125

def edit(
  type: Discorb::Unset,
  name: Discorb::Unset,
  description: Discorb::Unset,
  start_time: Discorb::Unset,
  end_time: Discorb::Unset,
  privacy_level: Discorb::Unset,
  location: Discorb::Unset,
  channel: Discorb::Unset,
  status: Discorb::Unset
)
  Async do
    payload = case type == Discorb::Unset ? @entity_type : type
      when :stage_instance
        raise ArgumentError, "channel must be provided for stage_instance events" unless channel
        {
          name: name,
          description: description,
          scheduled_start_time: start_time.iso8601,
          scheduled_end_time: end_time&.iso8601,
          privacy_level: Discorb::ScheduledEvent::PRIVACY_LEVEL.key(privacy_level) || Discorb::Unset,
          channel_id: channel&.id,
          entity_type: Discorb::ScheduledEvent::ENTITY_TYPE.key(:stage_instance),
          status: Discorb::ScheduledEvent::STATUS.key(status) || Discorb::Unset,
        }.reject { |_, v| v == Discorb::Unset }
      when :voice
        raise ArgumentError, "channel must be provided for voice events" unless channel
        {
          name: name,
          description: description,
          scheduled_start_time: start_time.iso8601,
          scheduled_end_time: end_time&.iso8601,
          privacy_level: Discorb::ScheduledEvent::PRIVACY_LEVEL.key(privacy_level) || Discorb::Unset,
          channel_id: channel&.id,
          entity_type: Discorb::ScheduledEvent::ENTITY_TYPE.key(:voice),
          status: Discorb::ScheduledEvent::STATUS.key(status) || Discorb::Unset,
        }.reject { |_, v| v == Discorb::Unset }
      when :external
        raise ArgumentError, "location must be provided for external events" unless location
        raise ArgumentError, "end_time must be provided for external events" unless end_time
        {
          name: name,
          description: description,
          channel_id: nil,
          scheduled_start_time: start_time.iso8601,
          scheduled_end_time: end_time.iso8601,
          privacy_level: Discorb::ScheduledEvent::PRIVACY_LEVEL.key(privacy_level) || Discorb::Unset,
          entity_type: Discorb::ScheduledEvent::ENTITY_TYPE.key(:external),
          entity_metadata: {
            location: location,
          },
          status: Discorb::ScheduledEvent::STATUS.key(status) || Discorb::Unset,
        }.reject { |_, v| v == Discorb::Unset }
      else
        raise ArgumentError, "Invalid scheduled event type: #{type}"
      end
    @client.http.request(Route.new("/guilds/#{@guild_id}/scheduled-events/#{@id}", "//guilds/:guild_id/scheduled-events/:scheduled_event_id", :patch), payload).wait
  end
end

#fetch_users(limit = nil, before: nil, after: nil, with_member: true) -> Async::Task<Array<Discorb::Member>> Also known as: fetch_members

Note:

You can fetch all of members by not specifying a parameter.

Fetches the event users.

Parameters:

  • limit (Integer) (defaults to: nil) —

    The maximum number of users to fetch. Defaults to 100.

  • after (#to_s) (defaults to: nil) —

    The ID of the user to start fetching from. Defaults to nil.

  • before (#to_s) (defaults to: nil) —

    The ID of the user to stop fetching at. Defaults to nil.

  • with_member (Boolean) (defaults to: true) —

    Whether to include the member object of the event. Defaults to false. This should be used for manual fetching of members.

Returns:



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/discorb/event.rb', line 238

def fetch_users(limit = nil, before: nil, after: nil, with_member: true)
  Async do
    if limit.nil?
      after = 0
      res = []
      loop do
        _resp, users = @client.http.request(Route.new("/guilds/#{@guild_id}/scheduled-events/#{@id}/users?limit=100&after=#{after}&with_member=true", "//guilds/:guild_id/scheduled-events/:scheduled_event_id/users", :get)).wait
        break if users.empty?
        res += users.map { |u| Member.new(@client, @guild_id, u[:user], u[:member]) }
        after = users.last[:user][:id]
      end
      res
    else
      params = {
        limit: limit,
        before: Discorb::Utils.try(before, :id),
        after: Discorb::Utils.try(after, :id),
        with_member: with_member,
      }.filter { |_k, v| !v.nil? }.to_h
      _resp, messages = @client.http.request(Route.new("/channels/#{channel_id.wait}/messages?#{URI.encode_www_form(params)}", "//channels/:channel_id/messages", :get)).wait
      messages.map { |m| Message.new(@client, m.merge({ guild_id: @guild_id.to_s })) }
    end
  end
end

#start -> Object

Starts the event. Shortcut for edit(status: :active).



190
191
192
 
# File 'lib/discorb/event.rb', line 190

def start
  edit(status: :active)
end