Class: Discordrb::Integration

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

Overview

Server integration

Instance Attribute Summary collapse

Attributes included from IDObject

#id

Instance Method Summary collapse

Methods included from IDObject

#==, #creation_time, synthesise

Instance Attribute Details

#account ⇒ IntegrationAccount (readonly)

Returns the integration account information.

Returns:



80
81
82
 
# File 'lib/discordrb/data/integration.rb', line 80

def 
  @account
end

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

Returns whether emoticons are enabled.

Returns:

  • (true, false) —

    whether emoticons are enabled



67
68
69
 
# File 'lib/discordrb/data/integration.rb', line 67

def emoticon
  @emoticon
end

#enabled ⇒ true, false (readonly)

Returns whether the integration is enabled.

Returns:

  • (true, false) —

    whether the integration is enabled



74
75
76
 
# File 'lib/discordrb/data/integration.rb', line 74

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)



86
87
88
 
# File 'lib/discordrb/data/integration.rb', line 86

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)



90
91
92
 
# File 'lib/discordrb/data/integration.rb', line 90

def expire_grace_period
  @expire_grace_period
end

#name ⇒ String (readonly)

Returns the integration name.

Returns:

  • (String) —

    the integration name



55
56
57
 
# File 'lib/discordrb/data/integration.rb', line 55

def name
  @name
end

#revoked ⇒ true, false (readonly)

Returns has this integration been revoked.

Returns:

  • (true, false) —

    has this integration been revoked.



96
97
98
 
# File 'lib/discordrb/data/integration.rb', line 96

def revoked
  @revoked
end

#role_id ⇒ Integer? (readonly)

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

Returns:

  • (Integer, nil) —

    the role that this integration uses for "subscribers"



64
65
66
 
# File 'lib/discordrb/data/integration.rb', line 64

def role_id
  @role_id
end

#server ⇒ Server (readonly)

Returns the server the integration is linked to.

Returns:

  • (Server) —

    the server the integration is linked to



58
59
60
 
# File 'lib/discordrb/data/integration.rb', line 58

def server
  @server
end

#subscriber_count ⇒ Integer? (readonly)

Returns how many subscribers this integration has.

Returns:

  • (Integer, nil) —

    how many subscribers this integration has.



93
94
95
 
# File 'lib/discordrb/data/integration.rb', line 93

def subscriber_count
  @subscriber_count
end

#synced_at ⇒ Time (readonly)

Returns the time the integration was synced at.

Returns:

  • (Time) —

    the time the integration was synced at



83
84
85
 
# File 'lib/discordrb/data/integration.rb', line 83

def synced_at
  @synced_at
end

#syncing ⇒ true, false (readonly)

Returns whether the integration is syncing.

Returns:

  • (true, false) —

    whether the integration is syncing



77
78
79
 
# File 'lib/discordrb/data/integration.rb', line 77

def syncing
  @syncing
end

#type ⇒ String (readonly)

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

Returns:

  • (String) —

    the integration type (YouTube, Twitch, etc.)



71
72
73
 
# File 'lib/discordrb/data/integration.rb', line 71

def type
  @type
end

#user ⇒ User (readonly)

Returns the user the integration is linked to.

Returns:

  • (User) —

    the user the integration is linked to



61
62
63
 
# File 'lib/discordrb/data/integration.rb', line 61

def user
  @user
end

Instance Method Details

#inspect ⇒ Object

The inspect method is overwritten to give more useful output



121
122
123
 
# File 'lib/discordrb/data/integration.rb', line 121

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