Class: Discordrb::Integration

Inherits:

Object

• Object
• Discordrb::Integration

Includes:

IDObject

Defined in:

lib/discordrb/data.rb

Overview

Server integration

Instance Attribute Summary

• #account ⇒ IntegrationAccount readonly

  The integration account information.

• #emoticon ⇒ true, false (also: #emoticon?) readonly

  Whether emoticons are enabled.

• #enabled ⇒ true, false readonly

  Whether the integration is enabled.

• #expire_behaviour ⇒ Symbol (also: #expire_behavior) readonly

  The behaviour of expiring subscribers (:remove = Remove User from role; :kick = Kick User from server).

• #expire_grace_period ⇒ Integer readonly

  The grace period before subscribers expire (in days).

• #name ⇒ String readonly

  The integration name.

• #role ⇒ Role^? readonly

  The role that this integration uses for "subscribers".

• #server ⇒ Server readonly

  The server the integration is linked to.

• #synced_at ⇒ Time readonly

  The time the integration was synced at.

• #syncing ⇒ true, false readonly

  Whether the integration is syncing.

• #type ⇒ String readonly

  The integration type (YouTube, Twitch, etc.).

• #user ⇒ User readonly

  The user the integration is linked to.

Attributes included from IDObject

#id

Instance Method Summary

• #initialize(data, bot, server) ⇒ Integration constructor

  A new instance of Integration.

• #inspect ⇒ Object

  The inspect method is overwritten to give more useful output.

Methods included from IDObject

#==, #creation_time, synthesise

Constructor Details

#initialize(data, bot, server) ⇒ Integration

Returns a new instance of Integration.

# File 'lib/discordrb/data.rb', line 2840

def initialize(data, bot, server)
  @bot = bot

  @name = data['name']
  @server = server
  @id = data['id'].to_i
  @enabled = data['enabled']
  @syncing = data['syncing']
  @type = data['type']
  @account = IntegrationAccount.new(data['account'])
  @synced_at = Time.parse(data['synced_at'])
  @expire_behaviour = %i[remove kick][data['expire_behavior']]
  @expire_grace_period = data['expire_grace_period']
  @user = @bot.ensure_user(data['user'])
  @role = server.role(data['role_id']) || nil
  @emoticon = data['enable_emoticons']
end

Instance Attribute Details

#account ⇒ IntegrationAccount (readonly)

Returns the integration account information.

Returns:

• (IntegrationAccount) —

  the integration account information

# File 'lib/discordrb/data.rb', line 2828

def account
  @account
end

#emoticon ⇒ true, false (readonly) Also known as: emoticon?

Returns whether emoticons are enabled.

Returns:

• (true, false) —

  whether emoticons are enabled

# File 'lib/discordrb/data.rb', line 2815

def emoticon
  @emoticon
end

#enabled ⇒ true, false (readonly)

Returns whether the integration is enabled.

Returns:

• (true, false) —

  whether the integration is enabled

# File 'lib/discordrb/data.rb', line 2822

def enabled
  @enabled
end

#expire_behaviour ⇒ Symbol (readonly) Also known as: expire_behavior

Returns the behaviour of expiring subscribers (:remove = Remove User from role; :kick = Kick User from server).

Returns:

• (Symbol) —

  the behaviour of expiring subscribers (:remove = Remove User from role; :kick = Kick User from server)

# File 'lib/discordrb/data.rb', line 2834

def expire_behaviour
  @expire_behaviour
end

#expire_grace_period ⇒ Integer (readonly)

Returns the grace period before subscribers expire (in days).

Returns:

• (Integer) —

  the grace period before subscribers expire (in days)

# File 'lib/discordrb/data.rb', line 2838

def expire_grace_period
  @expire_grace_period
end

#name ⇒ String (readonly)

Returns the integration name.

Returns:

• (String) —

  the integration name

# File 'lib/discordrb/data.rb', line 2803

def name
  @name
end

#role ⇒ Role^? (readonly)

Returns the role that this integration uses for "subscribers".

Returns:

• (Role, nil) —

  the role that this integration uses for "subscribers"

# File 'lib/discordrb/data.rb', line 2812

def role
  @role
end

#server ⇒ Server (readonly)

Returns the server the integration is linked to.

Returns:

• (Server) —

  the server the integration is linked to

# File 'lib/discordrb/data.rb', line 2806

def server
  @server
end

#synced_at ⇒ Time (readonly)

Returns the time the integration was synced at.

Returns:

• (Time) —

  the time the integration was synced at

# File 'lib/discordrb/data.rb', line 2831

def synced_at
  @synced_at
end

#syncing ⇒ true, false (readonly)

Returns whether the integration is syncing.

Returns:

• (true, false) —

  whether the integration is syncing

# File 'lib/discordrb/data.rb', line 2825

def syncing
  @syncing
end

#type ⇒ String (readonly)

Returns the integration type (YouTube, Twitch, etc.).

Returns:

• (String) —

  the integration type (YouTube, Twitch, etc.)

# File 'lib/discordrb/data.rb', line 2819

def type
  @type
end

#user ⇒ User (readonly)

Returns the user the integration is linked to.

Returns:

• (User) —

  the user the integration is linked to

# File 'lib/discordrb/data.rb', line 2809

def user
  @user
end

Instance Method Details

#inspect ⇒ Object

The inspect method is overwritten to give more useful output

# File 'lib/discordrb/data.rb', line 2859

def inspect
  "<Integration name=#{@name} id=#{@id} type=#{@type} enabled=#{@enabled}>"
end