Module: Intercom

Defined in:
lib/intercom.rb,
lib/intercom/tag.rb,
lib/intercom/user.rb,
lib/intercom/note.rb,
lib/intercom/version.rb,
lib/intercom/request.rb,
lib/intercom/impression.rb,
lib/intercom/flat_store.rb,
lib/intercom/user_resource.rb,
lib/intercom/social_profile.rb,
lib/intercom/message_thread.rb,
lib/intercom/hashable_object.rb,
lib/intercom/requires_parameters.rb,
lib/intercom/user_collection_proxy.rb,
lib/intercom/unix_timestamp_unwrapper.rb

Overview

:nodoc:

Defined Under Namespace

Modules: HashableObject, RequiresParameters, UnixTimestampUnwrapper Classes: AuthenticationError, FlatStore, Impression, Message, MessageAuthor, MessageThread, Note, Request, ResourceNotFound, ServerError, ServiceUnavailableError, SocialProfile, Tag, User, UserCollectionProxy, UserResource

Constant Summary

VERSION = 
"0.1.10"

Class Method Summary (collapse)

Class Method Details

+ (String) api_key=(api_key)

Set the api key to gain access to your application data. When logged into your intercom console, you can view/create api keys in the settings menu

Parameters:

  • api_key (String)

Returns:

  • (String) 


45
46
47
 
# File 'lib/intercom.rb', line 45

def self.api_key=(api_key)
  @api_key = api_key
end

+ (String) app_id=(app_id)

Set the id of the application you want to interact with. When logged into your intercom console, the app_id is in the url after /apps (eg www.intercom.io/apps/>)

Parameters:

  • app_id (String)

Returns:

  • (String) 


36
37
38
 
# File 'lib/intercom.rb', line 36

def self.app_id=(app_id)
  @app_id = app_id
end