Class: Client (Databasedotcom)
Prev Chapter 4.  User Defined Modules and Classes  Next

Class: Client (Databasedotcom)

Overview
Module Structure
Class Hierarchy
Instance Attributes
Client#client_id [RW]
Client#client_secret [RW]
Client#oauth_token [RW]
Client#refresh_token [RW]
Client#instance_url [RW]
Client#debugging [RW]
Client#host [RW]
Client#version [RW]
Client#sobject_module [RW]
Client#user_id [R]
Client#username [RW]
Client#password [RW]
Client#org_id [R] (1/2)
Client#ca_file [RW]
Client#verify_mode [RW]
Instance Methods
Client#initialize / 1
Client#authenticate / 1
Client#org_id (2/E)
Client#list_sobjects
Client#materialize / 1
Client#describe_sobjects
Client#describe_sobject / 1
Client#find / 2
Client#query / 1
Client#search / 1
Client#next_page / 1
Client#previous_page / 1
Client#create / 2
Client#update / 3
Client#upsert / 4
Client#delete / 2
Client#recent
Client#trending_topics
Client#http_get / 3
Client#http_delete / 3
Client#http_post / 4
Client#http_patch / 4
Client#http_multipart_post / 4
Client#with_encoded_path_and_checked_response / 3
Client#with_logging / 2
Client#ensure_expected_response / 1
Client#https_request / 1
Client#encode_path_with_params / 2
Client#encode_parameters / 1
Client#log_request / 2
Client#uri_escape / 1
Client#log_response / 1
Client#find_or_materialize / 1
Client#module_namespace
Client#collection_from / 1
Client#record_from_hash / 1
Client#collection_from_hash / 1
Client#set_value / 4
Client#coerced_json / 2
Client#key_from_label / 1
Client#user_and_pass? / 1
Client#parse_user_id_and_org_id_from_identity_url / 1
Client#parse_auth_response / 1
Client#query_org_id
Client#const_defined_in_module / 2
is a submodule of
module: Databasedotcom   
has modular siblings
class: SalesForceError   
class: Collection   
module: Sobject   
module: Chatter   
inherits from
  Object ( Builtin-Module )
has class siblings
  Array ( Builtin-Module )
  Exception ( Builtin-Module )
  Class ( Builtin-Module )
  Hash ( Builtin-Module )
  String ( Builtin-Module )
  Sobject ( Databasedotcom::Sobject )
  Record ( Databasedotcom::Chatter )
has properties
attribute: client_id [RW]   
attribute: client_secret [RW]   
attribute: oauth_token [RW]   
attribute: refresh_token [RW]   
attribute: instance_url [RW]   
attribute: debugging [RW]   
attribute: host [RW]   
attribute: version [RW]   
attribute: sobject_module [RW]   
attribute: user_id [R]   
attribute: username [RW]   
attribute: password [RW]   
attribute: org_id (1/2) [R]   
attribute: ca_file [RW]   
attribute: verify_mode [RW]   
method: initialize / 1   
method: authenticate / 1   
method: org_id (2/E)   
method: list_sobjects   
method: materialize / 1   
method: describe_sobjects   
method: describe_sobject / 1   
method: find / 2   
method: query / 1   
method: search / 1   
method: next_page / 1   
method: previous_page / 1   
method: create / 2   
method: update / 3   
method: upsert / 4   
method: delete / 2   
method: recent   
method: trending_topics   
method: http_get / 3   
method: http_delete / 3   
method: http_post / 4   
method: http_patch / 4   
method: http_multipart_post / 4   
method: with_encoded_path_and_checked_response / 3   
method: with_logging / 2   
method: ensure_expected_response / 1   
method: https_request / 1   
method: encode_path_with_params / 2   
method: encode_parameters / 1   
method: log_request / 2   
method: uri_escape / 1   
method: log_response / 1   
method: find_or_materialize / 1   
method: module_namespace   
method: collection_from / 1   
method: record_from_hash / 1   
method: collection_from_hash / 1   
method: set_value / 4   
method: coerced_json / 2   
method: key_from_label / 1   
method: user_and_pass? / 1   
method: parse_user_id_and_org_id_from_identity_url / 1   
method: parse_auth_response / 1   
method: query_org_id   
method: const_defined_in_module / 2   
is defined at
#8 in databasedotcom/client.rb  

Overview

Module Structure
Class Hierarchy

Module Structure

  module: <Toplevel Module>
  module: <Built-in Module>
  class: Array     
  class: Exception     
  class: Class     
  class: Hash     
  class: String     
  module: <Unknown Module>
  module: Databasedotcom
  class: SalesForceError
✗ class: Client
  class: Collection
  module: Sobject
  class: Sobject     
  module: Chatter
  class: Record     

Class Hierarchy

  Object ( Builtin-Module )
  Array ( Builtin-Module )
    Collection ( Databasedotcom )   
  Exception ( Builtin-Module )
  StandardError ( Builtin-Module )
    SalesForceError ( Databasedotcom )   
  Class ( Builtin-Module )
  Hash ( Builtin-Module )
  String ( Builtin-Module )
✗ Client ( Databasedotcom )
has properties
attribute: client_id [RW]   
attribute: client_secret [RW]   
attribute: oauth_token [RW]   
attribute: refresh_token [RW]   
attribute: instance_url [RW]   
attribute: debugging [RW]   
attribute: host [RW]   
attribute: version [RW]   
attribute: sobject_module [RW]   
attribute: user_id [R]   
attribute: username [RW]   
attribute: password [RW]   
attribute: org_id (1/2) [R]   
attribute: ca_file [RW]   
attribute: verify_mode [RW]   
method: initialize / 1   
method: authenticate / 1   
method: org_id (2/E)   
method: list_sobjects   
method: materialize / 1   
method: describe_sobjects   
method: describe_sobject / 1   
method: find / 2   
method: query / 1   
method: search / 1   
method: next_page / 1   
method: previous_page / 1   
method: create / 2   
method: update / 3   
method: upsert / 4   
method: delete / 2   
method: recent   
method: trending_topics   
method: http_get / 3   
method: http_delete / 3   
method: http_post / 4   
method: http_patch / 4   
method: http_multipart_post / 4   
method: with_encoded_path_and_checked_response / 3   
method: with_logging / 2   
method: ensure_expected_response / 1   
method: https_request / 1   
method: encode_path_with_params / 2   
method: encode_parameters / 1   
method: log_request / 2   
method: uri_escape / 1   
method: log_response / 1   
method: find_or_materialize / 1   
method: module_namespace   
method: collection_from / 1   
method: record_from_hash / 1   
method: collection_from_hash / 1   
method: set_value / 4   
method: coerced_json / 2   
method: key_from_label / 1   
method: user_and_pass? / 1   
method: parse_user_id_and_org_id_from_identity_url / 1   
method: parse_auth_response / 1   
method: query_org_id   
method: const_defined_in_module / 2   
  Sobject ( Databasedotcom::Sobject )
  Record ( Databasedotcom::Chatter )

Instance Attributes

Client#client_id [RW]
Client#client_secret [RW]
Client#oauth_token [RW]
Client#refresh_token [RW]
Client#instance_url [RW]
Client#debugging [RW]
Client#host [RW]
Client#version [RW]
Client#sobject_module [RW]
Client#user_id [R]
Client#username [RW]
Client#password [RW]
Client#org_id [R] (1/2)
Client#ca_file [RW]
Client#verify_mode [RW]

Client#client_id [RW]

#10 in databasedotcom/client.rb

Client#client_secret [RW]

#12 in databasedotcom/client.rb

Client#oauth_token [RW]

#14 in databasedotcom/client.rb

Client#refresh_token [RW]

#16 in databasedotcom/client.rb

Client#instance_url [RW]

#18 in databasedotcom/client.rb

Client#debugging [RW]

#20 in databasedotcom/client.rb

Client#host [RW]

#22 in databasedotcom/client.rb

Client#version [RW]

#24 in databasedotcom/client.rb

Client#sobject_module [RW]

#26 in databasedotcom/client.rb

Client#user_id [R]

#28 in databasedotcom/client.rb

Client#username [RW]

#30 in databasedotcom/client.rb

Client#password [RW]

#32 in databasedotcom/client.rb

Client#org_id [R] (1/2)

#34 in databasedotcom/client.rb

Client#ca_file [RW]

#36 in databasedotcom/client.rb

Client#verify_mode [RW]

#38 in databasedotcom/client.rb

Instance Methods

Client#initialize / 1
Client#authenticate / 1
Client#org_id (2/E)
Client#list_sobjects
Client#materialize / 1
Client#describe_sobjects
Client#describe_sobject / 1
Client#find / 2
Client#query / 1
Client#search / 1
Client#next_page / 1
Client#previous_page / 1
Client#create / 2
Client#update / 3
Client#upsert / 4
Client#delete / 2
Client#recent
Client#trending_topics
Client#http_get / 3
Client#http_delete / 3
Client#http_post / 4
Client#http_patch / 4
Client#http_multipart_post / 4
Client#with_encoded_path_and_checked_response / 3
Client#with_logging / 2
Client#ensure_expected_response / 1
Client#https_request / 1
Client#encode_path_with_params / 2
Client#encode_parameters / 1
Client#log_request / 2
Client#uri_escape / 1
Client#log_response / 1
Client#find_or_materialize / 1
Client#module_namespace
Client#collection_from / 1
Client#record_from_hash / 1
Client#collection_from_hash / 1
Client#set_value / 4
Client#coerced_json / 2
Client#key_from_label / 1
Client#user_and_pass? / 1
Client#parse_user_id_and_org_id_from_identity_url / 1
Client#parse_auth_response / 1
Client#query_org_id
Client#const_defined_in_module / 2

Client#initialize / 1

#64 in databasedotcom/client.rb

initialize ( options = {} )

Client#authenticate / 1

#103 in databasedotcom/client.rb

authenticate ( options = nil )

Client#org_id (2/E)

#136 in databasedotcom/client.rb

org_id

Client#list_sobjects

#141 in databasedotcom/client.rb

list_sobjects

Client#materialize / 1

#156 in databasedotcom/client.rb

materialize ( classnames )

Client#describe_sobjects

#174 in databasedotcom/client.rb

describe_sobjects

Client#describe_sobject / 1

#180 in databasedotcom/client.rb

describe_sobject ( class_name )

Client#find / 2

#189 in databasedotcom/client.rb

find ( class_or_classname ,
  record_id )

Client#query / 1

#203 in databasedotcom/client.rb

query ( soql_expr )

Client#search / 1

#211 in databasedotcom/client.rb

search ( sosl_expr )

Client#next_page / 1

#217 in databasedotcom/client.rb

next_page ( path )

Client#previous_page / 1

#223 in databasedotcom/client.rb

previous_page ( path )

Client#create / 2

#231 in databasedotcom/client.rb

create ( class_or_classname ,
  object_attrs )

Client#update / 3

#247 in databasedotcom/client.rb

update ( class_or_classname ,
  record_id ,
  new_attrs )

Client#upsert / 4

#257 in databasedotcom/client.rb

upsert ( class_or_classname ,
  field ,
  value ,
  attrs )

Client#delete / 2

#266 in databasedotcom/client.rb

delete ( class_or_classname ,
  record_id )

Client#recent

#272 in databasedotcom/client.rb

recent

Client#trending_topics

#278 in databasedotcom/client.rb

trending_topics

Client#http_get / 3

#287 in databasedotcom/client.rb

http_get ( path ,
  parameters={} ,
  headers={} )

Client#http_delete / 3

#297 in databasedotcom/client.rb

http_delete ( path ,
  parameters={} ,
  headers={} )

Client#http_post / 4

#306 in databasedotcom/client.rb

http_post ( path ,
  data=nil ,
  parameters={} ,
  headers={} )

Client#http_patch / 4

#315 in databasedotcom/client.rb

http_patch ( path ,
  data=nil ,
  parameters={} ,
  headers={} )

Client#http_multipart_post / 4

#325 in databasedotcom/client.rb

http_multipart_post ( path ,
  parts ,
  parameters={} ,
  headers={} )

Client#with_encoded_path_and_checked_response / 3

#333 in databasedotcom/client.rb

with_encoded_path_and_checked_response ( path ,
  parameters ,
  options = {} )

Client#with_logging / 2

#341 in databasedotcom/client.rb

with_logging ( encoded_path ,
  options )

Client#ensure_expected_response / 1

#348 in databasedotcom/client.rb

ensure_expected_response ( expected_result_class )

Client#https_request / 1

#382 in databasedotcom/client.rb

https_request ( host=nil )

Client#encode_path_with_params / 2

#390 in databasedotcom/client.rb

encode_path_with_params ( path ,
  parameters={} )

Client#encode_parameters / 1

#394 in databasedotcom/client.rb

encode_parameters ( parameters={} )

Client#log_request / 2

#398 in databasedotcom/client.rb

log_request ( path ,
  options={} )

Client#uri_escape / 1

#403 in databasedotcom/client.rb

uri_escape ( str )

Client#log_response / 1

#407 in databasedotcom/client.rb

log_response ( result )

Client#find_or_materialize / 1

#411 in databasedotcom/client.rb

find_or_materialize ( class_or_classname )

Client#module_namespace

#425 in databasedotcom/client.rb

module_namespace

Client#collection_from / 1

#431 in databasedotcom/client.rb

collection_from ( response )

Client#record_from_hash / 1

#437 in databasedotcom/client.rb

record_from_hash ( data )

Client#collection_from_hash / 1

#463 in databasedotcom/client.rb

collection_from_hash ( data )

Client#set_value / 4

#476 in databasedotcom/client.rb

set_value ( record ,
  attr ,
  value ,
  attr_type )

Client#coerced_json / 2

#493 in databasedotcom/client.rb

coerced_json ( attrs ,
  clazz )

Client#key_from_label / 1

#518 in databasedotcom/client.rb

key_from_label ( label )

Client#user_and_pass? / 1

#522 in databasedotcom/client.rb

user_and_pass? ( options )

Client#parse_user_id_and_org_id_from_identity_url / 1

#526 in databasedotcom/client.rb

parse_user_id_and_org_id_from_identity_url ( identity_url )

Client#parse_auth_response / 1

#532 in databasedotcom/client.rb

parse_auth_response ( body )

Client#query_org_id

#539 in databasedotcom/client.rb

query_org_id

Client#const_defined_in_module / 2

#543 in databasedotcom/client.rb

const_defined_in_module ( mod ,
  const )

Prev Up Next
Class: SalesForceError (Databasedotcom)  Home  Class: Collection (Databasedotcom)