README
¶
Session
The session is used to authenticate with Salesforce and retrieve the org's information. The session will be used by the API packages to properly access the Salesforce org. The credentials will need to be will be used to properly create the session.
Example
The following example demonstrates how to create a session.
pwdCreds, err := credentials.NewPasswordCredentials(credentials.PasswordCredentials{
URL: "https://login.salesforce.com",
Username: "my.user@name.com",
Password: "greatpassword",
ClientID: "asdfnapodfnavppe",
ClientSecret: "12312573857105",
})
if err != nil {
fmt.Printf("error %v\n", err)
return
}
config := sfdc.Configuration{
Credentials: pwdCreds,
Client: http.DefaultClient,
Version: 44,
}
session, err := session.Open(config)
if err != nil {
fmt.Printf("Error %v\n", err)
return
}
// access Salesforce APIs
Documentation
¶
Overview ¶
Package session provides handles creation of a Salesforce session
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type InstanceFormatter ¶
type InstanceFormatter interface {
InstanceURL() string
AuthorizationHeader(*http.Request)
Clienter
}
InstanceFormatter is the session interface that formaters the session instance information used by the resources.
InstanceURL will return the Salesforce instance.
AuthorizationHeader will add the authorization to the HTTP request's header.
type ServiceFormatter ¶
type ServiceFormatter interface {
InstanceFormatter
ServiceURL() string
}
ServiceFormatter is the session interface that formats the session for service resources.
ServiceURL provides the service URL for resources to user.
type Session ¶
type Session struct {
// contains filtered or unexported fields
}
Session is the authentication response. This is used to generate the authroization header for the Salesforce API calls.
func Open ¶
Open is used to authenticate with Salesforce and open a session. The user will need to supply the proper credentials and a HTTP client.
func (*Session) AuthorizationHeader ¶
AuthorizationHeader will add the authorization to the HTTP request's header.
func (*Session) InstanceURL ¶
InstanceURL will retuern the Salesforce instance from the session authentication.
func (*Session) ServiceURL ¶
ServiceURL will return the Salesforce instance for the service URL.
Source Files