Class: ZendeskAPI::Forum

Inherits:

Resource

• Object
• Data
• DataResource
• Resource
• ZendeskAPI::Forum

Defined in:

lib/zendesk_api/resources.rb,
lib/zendesk_api/resources.rb

Instance Method Summary

• #category ⇒ ZendeskAPI::Category

  The associated object.

• #category=(value) ⇒ ZendeskAPI::Category

  The associated object.

• #locale ⇒ ZendeskAPI::Locale

  The associated object.

• #locale=(value) ⇒ ZendeskAPI::Locale

  The associated object.

• #organization ⇒ ZendeskAPI::Organization

  The associated object.

• #organization=(value) ⇒ ZendeskAPI::Organization

  The associated object.

• #subscriptions(options = {}) ⇒ ZendeskAPI::ForumSubscription

  The associated object.

• #subscriptions=(value) ⇒ ZendeskAPI::ForumSubscription

  The associated object.

• #topics(options = {}) ⇒ ZendeskAPI::Topic

  The associated object.

• #topics=(value) ⇒ ZendeskAPI::Topic

  The associated object.

Constructor Details

This class inherits a constructor from ZendeskAPI::Data

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class ZendeskAPI::Data

Instance Method Details

#category ⇒ ZendeskAPI::Category

Returns The associated object

Returns:

• (ZendeskAPI::Category) —

  The associated object

# File 'lib/zendesk_api/resources.rb', line 171

has Category

#category=(value) ⇒ ZendeskAPI::Category

Returns The associated object

Parameters:

• value (Hash or ZendeskAPI::Category) —

  The associated object or its attributes

Returns:

• (ZendeskAPI::Category) —

  The associated object

# File 'lib/zendesk_api/resources.rb', line 171

has Category

#locale ⇒ ZendeskAPI::Locale

Returns The associated object

Returns:

• (ZendeskAPI::Locale) —

  The associated object

# File 'lib/zendesk_api/resources.rb', line 173

has Locale

#locale=(value) ⇒ ZendeskAPI::Locale

Returns The associated object

Parameters:

• value (Hash or ZendeskAPI::Locale) —

  The associated object or its attributes

Returns:

• (ZendeskAPI::Locale) —

  The associated object

# File 'lib/zendesk_api/resources.rb', line 173

has Locale

#organization ⇒ ZendeskAPI::Organization

Returns The associated object

Returns:

• (ZendeskAPI::Organization) —

  The associated object

# File 'lib/zendesk_api/resources.rb', line 172

has Organization

#organization=(value) ⇒ ZendeskAPI::Organization

Returns The associated object

Parameters:

• value (Hash or ZendeskAPI::Organization) —

  The associated object or its attributes

Returns:

• (ZendeskAPI::Organization) —

  The associated object

# File 'lib/zendesk_api/resources.rb', line 172

has Organization

#subscriptions(options = {}) ⇒ ZendeskAPI::ForumSubscription

Returns The associated object

Parameters:

• options (Hash) (defaults to: {}) —

  Options to pass to the collection object

Returns:

• (ZendeskAPI::ForumSubscription) —

  The associated object

# File 'lib/zendesk_api/resources.rb', line 176

has_many :subscriptions, :class => ForumSubscription

#subscriptions=(value) ⇒ ZendeskAPI::ForumSubscription

Returns The associated object

Parameters:

• value (Hash or ZendeskAPI::ForumSubscription) —

  The associated object or its attributes

Returns:

• (ZendeskAPI::ForumSubscription) —

  The associated object

# File 'lib/zendesk_api/resources.rb', line 176

has_many :subscriptions, :class => ForumSubscription

#topics(options = {}) ⇒ ZendeskAPI::Topic

Returns The associated object

Parameters:

• options (Hash) (defaults to: {}) —

  Options to pass to the collection object

Returns:

• (ZendeskAPI::Topic) —

  The associated object

# File 'lib/zendesk_api/resources.rb', line 175

has_many Topic

#topics=(value) ⇒ ZendeskAPI::Topic

Returns The associated object

Parameters:

• value (Hash or ZendeskAPI::Topic) —

  The associated object or its attributes

Returns:

• (ZendeskAPI::Topic) —

  The associated object

# File 'lib/zendesk_api/resources.rb', line 175

has_many Topic