Class: Discordrb::Integration

Inherits:
Object
  • Object
show all
Includes:
IDObject
Defined in:
lib/discordrb/data.rb

Overview

Server integration

Instance Attribute Summary collapse

Attributes included from IDObject

#id

Instance Method Summary collapse

Methods included from IDObject

#==, #creation_time

Constructor Details

#initialize(data, bot, server) ⇒ Integration

Returns a new instance of Integration.



1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
 
# File 'lib/discordrb/data.rb', line 1969

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 = [: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:



1957
1958
1959
 
# File 'lib/discordrb/data.rb', line 1957

def 
  @account
end

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

Returns whether emoticons are enabled.

Returns:

  • (true, false) —

    whether emoticons are enabled



1944
1945
1946
 
# File 'lib/discordrb/data.rb', line 1944

def emoticon
  @emoticon
end

#enabled ⇒ true, false (readonly)

Returns whether the integration is enabled.

Returns:

  • (true, false) —

    whether the integration is enabled



1951
1952
1953
 
# File 'lib/discordrb/data.rb', line 1951

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)



1963
1964
1965
 
# File 'lib/discordrb/data.rb', line 1963

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)



1967
1968
1969
 
# File 'lib/discordrb/data.rb', line 1967

def expire_grace_period
  @expire_grace_period
end

#name ⇒ String (readonly)

Returns the integration name.

Returns:

  • (String) —

    the integration name



1932
1933
1934
 
# File 'lib/discordrb/data.rb', line 1932

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"



1941
1942
1943
 
# File 'lib/discordrb/data.rb', line 1941

def role
  @role
end

#server ⇒ Server (readonly)

Returns the server the integration is linked to.

Returns:

  • (Server) —

    the server the integration is linked to



1935
1936
1937
 
# File 'lib/discordrb/data.rb', line 1935

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



1960
1961
1962
 
# File 'lib/discordrb/data.rb', line 1960

def synced_at
  @synced_at
end

#syncing ⇒ true, false (readonly)

Returns whether the integration is syncing.

Returns:

  • (true, false) —

    whether the integration is syncing



1954
1955
1956
 
# File 'lib/discordrb/data.rb', line 1954

def syncing
  @syncing
end

#type ⇒ String (readonly)

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

Returns:

  • (String) —

    the integration type (Youtube, Twitch, etc.)



1948
1949
1950
 
# File 'lib/discordrb/data.rb', line 1948

def type
  @type
end

#user ⇒ User (readonly)

Returns the user the integration is linked to.

Returns:

  • (User) —

    the user the integration is linked to



1938
1939
1940
 
# File 'lib/discordrb/data.rb', line 1938

def user
  @user
end

Instance Method Details

#inspect ⇒ Object

The inspect method is overwritten to give more useful output



1988
1989
1990
 
# File 'lib/discordrb/data.rb', line 1988

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