Class: QuickBase::WorkPlaceClient

Inherits:

Client

• Object
• Client
• QuickBase::WorkPlaceClient

Defined in:

lib/WorkPlaceClient.rb

Overview

Client that defaults the host to workplace.intuit.com

Instance Attribute Summary

Attributes inherited from Client

#HTML, #access, #accessid, #accountLimit, #accountUsage, #action, #admin, #adminOnly, #ancestorappid, #app, #appdata, #appdbid, #applicationLimit, #applicationUsage, #apptoken, #authenticationXML, #cacheSchemas, #cachedSchemas, #chdbids, #choice, #clist, #create, #createapptoken, #createdTime, #databases, #dbdesc, #dbid, #dbidForRequestURL, #dbname, #delete, #disprec, #domain, #downLoadFileURL, #email, #encoding, #errcode, #errdetail, #errtext, #escapeBR, #eventSubscribers, #excludeparents, #externalAuth, #fform, #fid, #fids, #field, #fieldTypeLabelMap, #fieldValue, #field_data, #field_data_list, #fields, #fileContents, #fileUploadToken, #firstName, #fmt, #fname, #fnames, #fvlist, #hours, #httpConnection, #id, #ignoreCR, #ignoreError, #ignoreLF, #ignoreTAB, #includeancestors, #jht, #jsa, #keepData, #key_fid, #label, #lastAccessTime, #lastError, #lastModifiedTime, #lastName, #lastPaymentDate, #lastRecModTime, #logger, #login, #mgrID, #mgrName, #mode, #modify, #name, #newappname, #newdbdesc, #newdbid, #newdbname, #newowner, #numMatches, #numRecords, #num_fields, #num_records, #num_recs_added, #num_recs_deleted, #num_recs_input, #num_recs_updated, #numadded, #numremoved, #oldestancestorappid, #options, #org, #page, #pagebody, #pageid, #pagename, #pagetype, #password, #permissions, #printRequestsAndResponses, #properties, #qarancestorappid, #qbhost, #qdbapi, #qid, #qname, #queries, #query, #rdr, #record, #records, #records_csv, #requestHeaders, #requestNextAllowedTime, #requestSucceeded, #requestTime, #requestURL, #requestXML, #responseElement, #responseElementText, #responseElements, #responseXML, #responseXMLdoc, #rid, #rids, #role, #roleid, #rolename, #saveviews, #screenName, #serverDatabases, #serverGroups, #serverStatus, #serverUpdays, #serverUptime, #serverUsers, #serverVersion, #showAppData, #skipfirst, #slist, #standardRequestHeaders, #status, #stopOnError, #table, #tables, #ticket, #type, #udata, #uname, #update_id, #user, #userid, #username, #users, #validFieldProperties, #validFieldTypes, #value, #variables, #varname, #version, #vid, #view, #withembeddedtables, #xsl

Class Method Summary

• .init(options) ⇒ Object

Instance Method Summary

• #initialize(username = nil, password = nil, appname = nil, useSSL = true, printRequestsAndResponses = false, stopOnError = false, showTrace = false, apptoken = nil, debugHTTPConnection = false, proxy_options = nil) ⇒ WorkPlaceClient constructor

  A new instance of WorkPlaceClient.

Methods inherited from Client

#_addField, #_addRecord, #_addReplaceDBPage, #_addUserToRole, #_changePermission, #_changeRecordOwner, #_changeUserRole, #_cloneDatabase, #_deleteDatabase, #_deleteField, #_deleteFieldName, #_deleteRecord, #_doQuery, #_doQueryCount, #_doQueryHash, #_doQueryName, #_downLoadFile, #_editRecord, #_fieldAddChoices, #_fieldNameAddChoices, #_fieldNameRemoveChoices, #_fieldRemoveChoices, #_genAddRecordForm, #_genResultsTable, #_getAncestorInfo, #_getAppDTMInfo, #_getBillingStatus, #_getDBInfo, #_getDBPage, #_getDBvar, #_getEntitlementValues, #_getFileAttachmentUsage, #_getNumRecords, #_getRecordAsHTML, #_getRecordInfo, #_getRoleInfo, #_getSchema, #_getUserRole, #_importFromCSV, #_importFromExcel, #_listDBPages, #_printChildElements, #_provisionUser, #_purgeRecords, #_removeUserFromRole, #_renameApp, #_runImport, #_sendInvitation, #_setActiveRecord, #_setAppData, #_setDBvar, #_setFieldProperties, #_setKeyField, #_updateFile, #_uploadFile, #_userRoles, #addField, #addFieldValuePair, #addOrEditRecord, #addRecord, #addReplaceDBPage, #addUserToRole, #alias_methods, #applyDeviationToRecords, #applyPercentToRecords, #authenticate, #average, #chainAPIcallsBlock, #changePermission, #changeRecordOwner, #changeRecords, #changeUserRole, #clearFieldValuePairList, #clientMethods, #cloneDatabase, #copyRecord, #count, #createDatabase, #createTable, #dateToMS, #debugHTTPConnection, #decodeXML, #deleteDatabase, #deleteDuplicateRecords, #deleteField, #deleteRecord, #deleteRecords, #deviation, #doQuery, #doQueryCount, #doSQLInsert, #doSQLQuery, #doSQLUpdate, #downLoadFile, #eachField, #eachRecord, #editRecord, #editRecords, #encodeXML, #encodingStrings, #escapeXML, #fieldAddChoices, #fieldRemoveChoices, #fieldTypeForLabel, #findDBByname, #findDuplicateRecordIDs, #findElementByAttributeValue, #findElementsByAttributeName, #findElementsByAttributeValue, #formatChdbidName, #formatCurrency, #formatDate, #formatDuration, #formatFieldValue, #formatImportCSV, #formatPercent, #formatTimeOfDay, #genAddRecordForm, #genResultsTable, #getAllRecordIDs, #getAllValuesForFields, #getAllValuesForFieldsAsArray, #getAllValuesForFieldsAsJSON, #getAllValuesForFieldsAsPrettyJSON, #getAncestorInfo, #getAppDTMInfo, #getApplicationVariable, #getApplicationVariables, #getAttributeString, #getAuthenticationXMLforRequest, #getBillingStatus, #getColumnListForQuery, #getDBInfo, #getDBPage, #getDBPagesAsArray, #getDBforRequestURL, #getDBvar, #getEntitlementValues, #getErrorInfoFromResponse, #getFieldChoices, #getFieldDataPrintableValue, #getFieldDataValue, #getFieldIDs, #getFieldNames, #getFileAttachmentUsage, #getFileUploadToken, #getFilteredRecords, #getJoinRecords, #getNumRecords, #getNumTables, #getOneTimeTicket, #getQueryRequestXML, #getRecord, #getRecordAsHTML, #getRecordInfo, #getReportNames, #getResponseElement, #getResponseElements, #getResponsePathValue, #getResponsePathValues, #getResponseValue, #getRoleInfo, #getSchema, #getServerStatus, #getSortListForQuery, #getSummaryRecords, #getTableIDs, #getTableName, #getTableNames, #getUnionRecords, #getUserInfo, #getUserRole, #grantedDBs, #importCSVFile, #importFromCSV, #importFromExcel, #importSVFile, #importTSVFile, #isAverageField?, #isBuiltInField?, #isHTMLRequest?, #isRecordidField?, #isTotalField?, #isValidFieldProperty?, #isValidFieldType?, #iterateDBPages, #iterateFilteredRecords, #iterateJoinRecords, #iterateRecordInfos, #iterateRecords, #iterateSummaryRecords, #iterateUnionRecords, #listDBPages, #logToFile, #lookupBaseFieldTypeByName, #lookupChdbid, #lookupField, #lookupFieldData, #lookupFieldIDByName, #lookupFieldName, #lookupFieldNameFromID, #lookupFieldPropertyByName, #lookupFieldType, #lookupFieldTypeByName, #lookupFieldsByType, #lookupQuery, #lookupQueryByName, #lookupRecord, #makeSVFile, #max, #method_missing, #min, #obStatus, #onChangedDbid, #parseResponseXML, #percent, #prependAPI?, #printChildElements, #printLastError, #printRequest, #printResponse, #processChildElements, processDatabase, #processRESTFieldNameOrRecordKeyRequest, #processRESTRequest, #processResponse, #provisionUser, #purgeRecords, #removeUserFromRole, #renameApp, #replaceFieldValuePair, #resetErrorInfo, #resetfid, #resetrid, #runImport, #sendInvitation, #sendRequest, #setActiveRecord, #setActiveTable, #setAppData, #setDBvar, #setFieldProperties, #setFieldValue, #setFieldValues, #setHTTPConnection, #setHTTPConnectionAndqbhost, #setKeyField, #setLogger, #setqbhost, #signOut, #splitString, #subscribe, #sum, #toXML, #toggleTraceInfo, #updateFile, #uploadFile, #userRoles, #verifyFieldList, #verifyQueryOperator

Constructor Details

#initialize(username = nil, password = nil, appname = nil, useSSL = true, printRequestsAndResponses = false, stopOnError = false, showTrace = false, apptoken = nil, debugHTTPConnection = false, proxy_options = nil) ⇒ WorkPlaceClient

Returns a new instance of WorkPlaceClient.

# File 'lib/WorkPlaceClient.rb', line 19

def initialize(username=nil,password=nil,appname=nil,useSSL=true,printRequestsAndResponses=false, 
                    stopOnError=false,showTrace=false,apptoken=nil,debugHTTPConnection=false,proxy_options = nil)
   super(username,password,appname,useSSL,printRequestsAndResponses,stopOnError,showTrace,"workplace",apptoken,debugHTTPConnection,"intuit",proxy_options)
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class QuickBase::Client

Class Method Details

.init(options) ⇒ Object

# File 'lib/WorkPlaceClient.rb', line 23

def WorkPlaceClient.init(options)
  options ||= {}
  options["useSSL"] ||= true
  options["printRequestsAndResponses"] ||= false
  options["stopOnError"] ||= false
  options["showTrace"] ||= false
  options["debugHTTPConnection"] ||= false
  options["proxy_options"] ||= nil
  instance = WorkPlaceClient.new( options["username"], 
                                  options["password"], 
                                  options["appname"],
                                  options["useSSL"], 
                                  options["printRequestsAndResponses"],
                                  options["stopOnError"],
                                  options["showTrace"],
                                  options["apptoken"],
                                  options["debugHTTPConnection"],
                                  options["proxy_options"])
end