Class: ZendeskAPI::Topic::TopicComment

Inherits:
ZendeskAPI::TopicComment show all
Includes:
Create, Destroy, Read, Update
Defined in:
lib/zendesk_api/resources.rb

Class Method Summary collapse

Instance Method Summary collapse

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

Class Method Details

.import(client, attributes) ⇒ Object 



209
210
211
212
213
 
# File 'lib/zendesk_api/resources.rb', line 209

def self.import(client, attributes)
  comment = new(client, attributes)
  return unless comment.save(:path => 'import/' + comment.path)
  comment
end

.import!(client, attributes) ⇒ Object 



203
204
205
206
207
 
# File 'lib/zendesk_api/resources.rb', line 203

def self.import!(client, attributes)
  new(client, attributes).tap do |comment|
    comment.save!(:path => 'import/' + comment.path)
  end
end

Instance Method Details

#clear_associations ⇒ Object Originally defined in module Save

Removes all cached associations

#destroy(&block) ⇒ Object Originally defined in module Destroy

Destroys, returning false on error.

#destroy! ⇒ Boolean Originally defined in module Destroy

If this resource hasn't already been deleted, then do so.

Returns:

  • (Boolean) —

    Successful?

#destroyed? ⇒ Boolean Originally defined in module Destroy

Has this object been deleted?

Returns:

  • (Boolean)

#handle_response(response) ⇒ Object Originally defined in module ResponseHandler

#reload! ⇒ Object Originally defined in module Read

Reloads a resource.

#save(options = {}, &block) ⇒ Object Originally defined in module Save

Saves, returning false if it fails and attaching the errors

#save!(options = {}) ⇒ Boolean Originally defined in module Save

If this resource hasn't been deleted, then create or save it. Executes a POST if it is a Data#new_record?, otherwise a PUT. Merges returned attributes on success.

Returns:

  • (Boolean) —

    Success?

#save_associations ⇒ Object Originally defined in module Save

Saves associations Takes into account inlining, collections, and id setting on the parent resource.

#uploads(options = {}) ⇒ ZendeskAPI::Attachment

Returns The associated object

Parameters:

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

    Options to pass to the collection object

Returns:



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

has_many :uploads, :class => Attachment, :inline => true

#uploads=(value) ⇒ ZendeskAPI::Attachment

Returns The associated object

Parameters:

Returns:



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

has_many :uploads, :class => Attachment, :inline => true