@veeva/myinsights_javascript_library v0.0.9

Table of Contents

• DataAccessLibrary
  • queryRecord
    • Parameters
  • runQuery
    • Parameters
  • querySalesData
    • Parameters
  • joinQueries
    • Parameters
  • getInStatement
    • Parameters
  • getDataForCurrentObject
    • Parameters
  • getObjectLabels
    • Parameters
  • getFieldLabels
    • Parameters
  • getPicklistValueLabels
    • Parameters
  • getVeevaMessagesWithDefault
    • Parameters
  • checkQueryQueue
  • newRecord
    • Parameters
  • viewRecord
    • Parameters
  • smartLinking
    • Parameters
  • executeSuggestionAction
    • Parameters
  • launchMediaForAccount
    • Parameters
  • getAvailableObjects
  • getObjectMetadata
    • Parameters
  • getRecordTypeLabels
    • Parameters
  • queryVDSRecord
    • Parameters
• OnlineAPI
  • genericQueryErrorHandler
    • Parameters
  • queryRecord
    • Parameters
  • querySalesData
    • Parameters
  • query
    • Parameters
  • getDataForCurrentObject
    • Parameters
  • getObjectLabels
    • Parameters
  • getFieldLabels
    • Parameters
  • getTranslation
    • Parameters
  • getPicklistValueLabels
    • Parameters
  • newRecord
    • Parameters
  • viewRecord
    • Parameters
  • smartLinking
    • Parameters
  • getAvailableObjects
  • getObjectMetadata
    • Parameters
  • getRecordTypeLabels
    • Parameters
• Utilities
  • isWin8
  • isOnline
  • addMessageListener
    • Parameters
  • removeMessageListener
    • Parameters
  • mergeObjects
    • Parameters
  • copyObject
    • Parameters
  • deepCopy
    • Parameters
  • replaceStringInWhereClause
    • Parameters

DataAccessLibrary

queryRecord

Parameters

• queryObject Object

Returns Promise

runQuery

Parameters

• queryConfig Object

Returns Promise

querySalesData

Parameters

• queryObject
• Object

Returns Promise

joinQueries

Parameters

• q1 Object The query to which to outerjoin q2
• q2 Object The query to which to outerjoin to q1
• keyForID String The member name of what to consider as the primary key
• fieldsLabelsToExclude Array
• primaryObjectName String The object name assigned to the query desired to be the primary query to which to join the non-primary query.

Returns Object Joined query result

getInStatement

Generates an in-statment fragment to be included in a query.

Parameters

• ids Array the ids to include in the generated in-statement

Returns string In-statement to use in a query

getDataForCurrentObject

Returns the value of a field for a specific record related to the current object

Parameters

• object String The api name of the object on which the field can be found.
• field String The name of the field whose value you want returned.

Returns Promise

getObjectLabels

Parameters

• objects Array API names of objects for which to retrieve object labels.

Returns Promise

getFieldLabels

Parameters

• queryConfig Object

Returns Promise

getPicklistValueLabels

Returns the translated label for each of the picklist values of the specified field

Parameters

• object String Object API name
• field String Field API name for which to get the picklist labels

Returns Promise

getVeevaMessagesWithDefault

Parameters

• tokens Array The tokens for which to get translations
• languageLocaleKey String Locale key of the translations to return.

Returns Promise

checkQueryQueue

Returns Promise

newRecord

Parameters

• configObject Object

Returns Promise

viewRecord

Parameters

• configObject Object

Returns Promise

smartLinking

Parameters

• configObject Object

Returns Promise

executeSuggestionAction

Parameters

• suggestionId String
• actionType String

Returns Promise

launchMediaForAccount

Parameters

• account String
• presentationId String
• keyMessageMediaFileName String

Returns Promise

getAvailableObjects

Returns Promise

getObjectMetadata

Parameters

• queryObject Object

Returns Promise

getRecordTypeLabels

Parameters

• objectName String

Returns Promise

queryVDSRecord

CDW Query Record

Parameters

• configObject
• Object

Returns Promise

Meta

• copyright: All rights reserved

OnlineAPI

Extends DataAccessLibrary

Overrides for the online environment.

genericQueryErrorHandler

Parameters

• e Object Error

Returns null

queryRecord

Parameters

• queryObject Object

Returns Promise

querySalesData

Parameters

• queryObject
• Object

Returns Promise

query

Parameters

• queryConfig Object

Returns Promise

getDataForCurrentObject

Returns the value of a field for a specific record related to the current object

Parameters

• object String The api name of the object on which the field can be found.
• field String The name of the field whose value you want returned.

Returns Promise

getObjectLabels

Parameters

• objects Array API names of objects for which to retrieve object labels.

Returns Promise

getFieldLabels

Parameters

• queryConfig Object

Returns Promise

getTranslation

Parameters

• tokens Array
• localeKey String

Returns Promise

getPicklistValueLabels

Returns the translated label for each of the picklist values of the specified field

Parameters

• object String Object API name
• field String Field API name for which to get the picklist labels

Returns Promise

newRecord

Parameters

• configObject Object

Returns Promise

viewRecord

Parameters

• configObject Object

Returns Promise

smartLinking

Parameters

• configObject Object

Returns Promise

getAvailableObjects

Returns Promise

getObjectMetadata

Parameters

• queryObject Object

Returns Promise

getRecordTypeLabels

Parameters

• objectName String

Returns Promise

Utilities

Provided for your convenience.

isWin8

Returns Boolean Returns true if the client is Windows 8

isOnline

Returns Boolean

addMessageListener

Adds a listener for the rest api call callback

Parameters

• callback Function Listener function

Returns Function The callback function passed in.

removeMessageListener

Parameters

• callback Function Listener function to remove

Returns undefined

mergeObjects

Parameters

• dst object Source of truth object to which to add members from src object.
• src object Object from which to copy members to dst
• clobber boolean Boolean to indicate if src members should override dst members.

Returns object

copyObject

Parameters

• obj Object Object to copy

Returns Object

deepCopy

Parameters

• originalObject Object The object to copy.

Returns Object

replaceStringInWhereClause

Parameters

• whereClause String
• input String String to use in place of stringToBeReplaced
• stringToBeReplaced String The string to replace with the input.

Returns String