README
¶
go-sfdc
This is a golang library for interfacing with Salesforce APIs.
Getting Started
Installing
To start using GO-SFDC, install GO and run go get
go get -u github.com/g8rswimmer/go-sfdc
This will retrieve the library.
Usage
To use this library, the following will need to be done.
- Create
Salesforcecredentials to properly authenticate with theSalesforce org - Configure
- Open a session
- Use the
APIs
Configuration
The configuration defines several parameters that can be used by the library. The configuration is used per session.
Credentials- this is an implementation of thecredentials.ProviderinterfaceClient- the HTTP client used by theAPIsVersion- is theSalesforceversion. Please refer toSalesforcedocumentation to make sure thatAPIsare supported in the version that is specified.
Example
config := sfdc.Configuration{
Credentials: credentials.NewPasswordCredentials(creds),
Client: salesforceHTTPClient,
Version: 44,
}
License
GO-SFDC source code is available under the MIT License
Documentation
¶
Index ¶
- Constants
- func ParseTime(salesforceTime string) (time.Time, error)
- type Configuration
- type Error
- type Record
- func (r *Record) FieldValue(field string) (interface{}, bool)
- func (r *Record) Fields() map[string]interface{}
- func (r *Record) LookUp(lookUp string) (*Record, bool)
- func (r *Record) LookUps() []*Record
- func (r *Record) SObject() string
- func (r *Record) URL() string
- func (r *Record) UnmarshalJSON(data []byte) error
Constants ¶
const (
// RecordAttributes is the attribute map from the record JSON
RecordAttributes = "attributes"
)
const SalesforceDate = "2006-01-02"
SalesforceDate is the format returned by the Salesforce Date field type.
const SalesforceDateTime = "2006-01-02T15:04:05.000+0000"
SalesforceDateTime is the format returned by Salesforce TimeDate field type.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Configuration ¶
type Configuration struct {
Credentials *credentials.Credentials
Client *http.Client
Version int
}
Configuration is the structure for goforce sessions.
Credentials is the credentials that will be used to form a session.
Client is the HTTP client that will be used.
Version is the Salesforce version for the APIs.
type Error ¶
type Error struct {
ErrorCode string `json:"errorCode"`
Message string `json:"message"`
Fields []string `json:"fields"`
}
Error is the error structure defined by the Salesforce API.
func (*Error) UnmarshalJSON ¶
UnmarshalJSON will unmarshal a JSON byte array.
type Record ¶
type Record struct {
// contains filtered or unexported fields
}
Record is a representation of a Salesforce record.
func RecordFromJSONMap ¶
RecordFromJSONMap creates a recrod from a JSON map.
func (*Record) FieldValue ¶
FieldValue returns the field's value. If there is no field for the field name, then false will be returned.
func (*Record) UnmarshalJSON ¶
UnmarshalJSON provides a custom unmarshaling of a JSON byte array.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package session provides handles creation of a Salesforce session
|
Package session provides handles creation of a Salesforce session |
|
collections
Package collections is the implementation of the SObject Collections API.
|
Package collections is the implementation of the SObject Collections API. |