lib

package

Go to main page

Versions in this module

v1

v1.6.0

Dec 21, 2025

Changes in this version

+ var ScratchOrgExpiredError = errors.New("Scratch org has expired")

+ func ForceScratchCreateLoginAndSaveWithNamespace(scratchUser string, features []string, edition string, settings []string, ...) (username string, err error)

type Force

+ func (f *Force) CreateScratchOrgWithUserFeaturesEditionSettingsAndNamespace(username string, features []string, edition string, settings []string, ...) (id string, err error)

v1.5.0

Nov 28, 2025

Changes in this version

type Force

+ func (f *Force) CreateScratchOrgWithUserAndFeatures(username string, features []string) (id string, err error)

+ func (f *Force) CreateScratchOrgWithUserFeaturesAndEdition(username string, features []string, edition string) (id string, err error)

+ func (f *Force) CreateScratchOrgWithUserFeaturesEditionAndSettings(username string, features []string, edition string, settings []string) (id string, err error)

+ func (f *Force) DeploySettings(settings []string) error

+ func (f *Force) UpsertRecord(sobject string, externalIdField string, externalIdValue string, ...) (result ForceUpsertResult, err error)

+ type ForceUpsertResult struct

+ Created bool

+ Id string

+ Success bool

v1.4.3

Oct 24, 2025

Changes in this version

+ func CompleteSFDXSession(creds *ForceSession, aliasHint string) error

+ func ListSFDXAliases() map[string]string

type ComponentSuccess

+ ComponentType string

type ForceSession

+ func SFDXAuthToForceSession(auth SFDXAuth) ForceSession

type SFDXAuth

+ InstanceApiVersion string

+ LoginUrl string

+ RefreshToken string

+ UserId string

+ func ListSFDXAuths() ([]SFDXAuth, error)

v1.4.2

Sep 18, 2025

v1.4.1

Aug 29, 2025

v1.4.0

Aug 25, 2025

Changes in this version

+ func ForceLoginAtEndpointAndSaveDeviceFlow(endpoint string, output *os.File, prompt string) (username string, err error)

type ForceSession

+ func ForceLoginAtEndpointDeviceFlow(endpoint string, prompt string) (creds ForceSession, err error)

v1.3.2

Aug 18, 2025

v1.3.1

Aug 18, 2025

v1.3.0

Aug 15, 2025

Changes in this version

type Force

+ func (f *Force) CreateToolingRecordMultipart(objecttype string, body []byte, contentType string) (result ForceCreateRecordResult, err error)

+ func (f *Force) UpdateToolingRecord(objecttype string, id string, attrs map[string]string) (err error)

v1.2.0

Aug 6, 2025

v1.1.1

Jul 24, 2025

Changes in this version

+ type ExecuteAnonymousResult struct

+ Column int

+ CompileProblem string

+ Compiled bool

+ ExceptionMessage string

+ ExceptionStackTrace string

+ Line int

+ Success bool

type Force

+ func (f *Force) ExecuteAnonymousTooling(apex string) (result ExecuteAnonymousResult, err error)

v1.1.0

Jul 16, 2025

Changes in this version

+ func ForceLoginAtEndpointAndSaveWithPort(endpoint string, output *os.File, port int) (username string, err error)

+ func ForceLoginAtEndpointWithPromptAndSaveWithPort(endpoint string, output *os.File, prompt string, port int) (username string, err error)

+ type DescribeSObjectResponse struct

+ Body string

+ ETag string

+ NotModified bool

type Force

+ func (f *Force) DescribeSObjectWithETag(objecttype string, ifNoneMatch string) (result *DescribeSObjectResponse, err error)

type ForceSession

+ func ForceLoginAtEndpointWithPromptAndPort(endpoint string, prompt string, targetPort int) (creds ForceSession, err error)

v1.0.10

May 23, 2025

v1.0.9

May 2, 2025

v1.0.8

Dec 3, 2024

v1.0.7

Nov 18, 2024

Changes in this version

+ var PasswordExpiredError = errors.New("Password is expired")

+ func ForceLoginAtEndpointAndSaveClientCredentials(endpoint string, clientId string, clientSecret string, output *os.File) (username string, err error)

type ForceSession

+ Id string

+ func ClientCredentialsLoginAtEndpoint(endpoint string, clientId string, clientSecret string) (creds ForceSession, err error)

v1.0.6

Sep 2, 2024

Changes in this version

+ var AlreadyCompletedError = errors.New("Deployment already completed")

v1.0.5

Jun 12, 2024

Changes in this version

+ func ForceScratchCreateLoginAndSave(scratchUser string, output *os.File) (username string, err error)

type Force

+ func NewForceWithRetrier(creds *ForceSession, retrier *HttpRetrier) (force *Force)

+ func (f *Force) BulkQueryWithContext(ctx context.Context, soql string, jobId string, contentType string, ...) (BatchInfo, error)

+ func (f *Force) CancelableQueryAndSend(ctx context.Context, qs string, processor chan<- ForceRecord, ...) error

+ func (f *Force) CloseBulkJobWithContext(ctx context.Context, jobId string) (JobInfo, error)

+ func (f *Force) CreateBulkJobWithContext(ctx context.Context, jobInfo JobInfo, requestOptions ...func(*http.Request)) (JobInfo, error)

+ func (f *Force) CreateScratchOrgWithUser(username string) (id string, err error)

+ func (f *Force) GetBatchInfoWithContext(ctx context.Context, jobId string, batchId string) (BatchInfo, error)

+ func (f *Force) GetBatchesWithContext(ctx context.Context, jobId string) (result []BatchInfo, err error)

+ func (f *Force) GetJobInfoWithContext(ctx context.Context, jobId string) (JobInfo, error)

+ func (f *Force) RetrieveBulkJobQueryResultsWithCallbackWithContext(ctx context.Context, job JobInfo, batchId string, resultId string, ...) error

+ func (f *Force) RetrieveBulkQueryWithContext(ctx context.Context, jobId string, batchId string) ([]byte, error)

+ func (f *Force) RetrieveBulkRequest(jobId string, batchId string) ([]byte, error)

+ func (f *Force) UserInfo() (userinfo UserInfo, err error)

+ func (force *Force) GetRetrier() *HttpRetrier

+ func (force *Force) WithRetrier(retrier *HttpRetrier) *Force

type ForceCheckDeploymentStatusResult

+ CreatedByName string

+ LastModifiedDate time.Time

+ type HttpRetrier struct

+ func DefaultRetrier() *HttpRetrier

+ func NewHttpRetrier(maxAttempts int, backoffDelay time.Duration, ...) *HttpRetrier

+ func (r *HttpRetrier) AppendErrorCheck(check func(res *http.Response, err error) bool) *HttpRetrier

+ func (r *HttpRetrier) BackoffDelay(bd time.Duration) *HttpRetrier

+ func (r *HttpRetrier) Reauth() *HttpRetrier

+ type NullValue struct

type Request

+ func (r *Request) Inspect() map[string]interface{}

v1.0.4

Sep 5, 2023

Changes in this version

type Result

+ Errors []ResultError

+ type ResultError struct

+ Fields []string

+ Message string

+ StatusCode string

v1.0.3

Jul 3, 2023

v1.0.2

May 16, 2023

v1.0.1

Apr 19, 2023

Changes in this version

+ func FindMetapathForFile(file string) (string, error)

+ type CodeCoverage struct

+ Id string

+ LocationsNotCovered []LocationNotCovered

+ Name string

+ Namespace string

+ NumLocations int

+ NumLocationsNotCovered int

+ Type string

type Force

+ func (f *Force) Explain(query string) (QueryPlanResult, error)

+ func (f *Force) Search(qs string) ([]ForceRecord, error)

type ForceMetadata

+ func (fm *ForceMetadata) MakeZipWithOptions(files ForceMetadataFiles, options ForceDeployOptions) (zipdata []byte, err error)

+ func (fm *ForceMetadata) RetrieveByPackageXmlContents(data []byte) (files ForceMetadataFiles, problems []string, err error)

+ type ForceSearchResult struct

+ SearchRecords []ForceRecord

+ type LocationNotCovered struct

+ Column int

+ Line int

+ NumExecutions int

+ Time float32

type PackageBuilder

+ Root string

+ func (pb *PackageBuilder) Add(path string) error

+ func (pb *PackageBuilder) AddMetadataItem(metadataType string, name string) error

+ func (pb *PackageBuilder) AddMetadataType(metadataType string) error

+ func (pb *PackageBuilder) GetMetaForAbsolutePath(path string) (metaName string, objectName string, err error)

+ func (pb *PackageBuilder) MetadataDir(metadataType string) (path string, err error)

+ type QueryPlan struct

+ Cardinality int64

+ Fields []string

+ LeadingOperationType string

+ Notes []QueryPlanNote

+ RelativeCost float64

+ SObjectCardinality int64

+ SObjectType string

+ type QueryPlanNote struct

+ Description string

+ Fields []string

+ TableEnumOrId string

+ type QueryPlanResult struct

+ Plans []QueryPlan

+ SourceQuery string

type RunTestResult

+ CodeCoverage []CodeCoverage

v0

v0.99.4

Dec 1, 2022

Changes in this version

type Force

+ func (f *Force) AbortableQueryAndSend(qs string, processor chan<- ForceRecord, abort <-chan bool, ...) error

v0.99.3

Nov 16, 2022

v0.99.2

Oct 24, 2022

Changes in this version

type ComponentFailure

+ ColumnNumber int

+ ComponentType string

+ type ForceCancelDeployResult struct

+ Done bool

+ Id string

type ForceCheckDeploymentStatusResult

+ func (r ForceCheckDeploymentStatusResult) HasComponentFailures() bool

+ func (r ForceCheckDeploymentStatusResult) HasTestFailures() bool

+ func (r ForceCheckDeploymentStatusResult) ToJunit(duration float64) (string, error)

+ func (r ForceCheckDeploymentStatusResult) ToString(duration float64, verbose bool) string

type ForceMetadata

+ func (fm *ForceMetadata) CancelDeploy(id string) (ForceCancelDeployResult, error)

+ func (fm *ForceMetadata) StartDeploy(files ForceMetadataFiles, options ForceDeployOptions) (string, error)

type TestCoverage

+ func (c TestCoverage) ToJunit() (string, error)

v0.99.1

Oct 19, 2022

v0.99.0

Oct 12, 2022

Changes in this version

+ func ForceLoginAtEndpointWithPromptAndSave(endpoint string, output *os.File, prompt string) (username string, err error)

type Force

+ func (f *Force) PutAbsolute(url string, content string) (result string, err error)

+ func (f *Force) PutREST(url string, content string) (result string, err error)

type ForceSession

+ func ForceLoginAtEndpointWithPrompt(endpoint string, prompt string) (creds ForceSession, err error)

type HttpMethod

+ const HttpMethodPut

v0.33.0

Jan 31, 2022

Changes in this version

type Force

+ func (f *Force) CopyCredentialAuthFields(creds *ForceSession)

type SessionOptions

+ RefreshFunc func(*Force) error

v0.32.0

Nov 13, 2021

Changes in this version

+ var APIDisabledForUser = errors.New("API disabled for user")

type BatchInfo

+ NumberRecordsFailed int

+ type ForceErrors []ForceError

+ func (fs ForceErrors) Error() string

+ type HttpMethod string

+ const HttpMethodPatch

+ const HttpMethodPost

type LoginFault

+ func (lf LoginFault) Error() string

v0.31.0

Apr 7, 2021

Changes in this version

type Force

+ func (f *Force) ExecuteRequest(r *Request) (*Response, error)

+ type Request struct

+ Headers map[string]string

+ func NewRequest(httpMethod string) *Request

+ func (r *Request) AbsoluteUrl(url string) *Request

+ func (r *Request) ReadResponseBody() *Request

+ func (r *Request) RestUrl(url string) *Request

+ func (r *Request) RootUrl(url string) *Request

+ func (r *Request) Unauthed() *Request

+ func (r *Request) WithBody(rdr io.Reader) *Request

+ func (r *Request) WithContent(ct ContentType) *Request

+ func (r *Request) WithHeader(k, v string) *Request

+ func (r *Request) WithResponseCallback(cb HttpCallback) *Request

+ type Response struct

+ ContentType ContentType

+ HttpResponse *http.Response

+ ReadResponseBody []byte

v0.30.0

Mar 16, 2021

Changes in this version

+ const ContentTypeCsv

+ const ContentTypeJson

+ const ContentTypeNone

+ const ContentTypeXml

+ type ContentType string

type Force

+ func (f *Force) RetrieveBulkJobQueryResultsWithCallback(job JobInfo, batchId string, resultId string, callback HttpCallback) error

type ForcePartner

+ func (partner *ForcePartner) Merge(sobjectType string, masterId string, duplicateId string) (err error)

+ func (partner *ForcePartner) MergeMany(sobjectType string, dupMap map[string]string) (results []soap.MergeResult, err error)

+ func (partner *ForcePartner) Undelete(id string) (err error)

+ func (partner *ForcePartner) UndeleteMany(deleted []string) (results []soap.UndeleteResult, err error)

+ type HttpCallback func(*http.Response) error

+ func NewBatchResultChannelHttpCallback(results chan<- BatchResultChunk, bufferSize int) HttpCallback

+ type JobContentType string

+ const JobContentTypeCsv

+ const JobContentTypeJson

+ const JobContentTypeXml

type JobInfo

+ func (ji JobInfo) HttpContentType() (ContentType, error)

+ func (ji JobInfo) JobContentType() (JobContentType, error)

v0.29.0

Jan 4, 2021

v0.28.1

May 13, 2020

v0.28.0

May 8, 2020

Changes in this version

type Force

+ func (f *Force) QueryOptions() []query.Option

+ func (force *Force) GetCredentials() *ForceSession

+ func (force *Force) GetMetadata() *ForceMetadata

+ func (force *Force) GetPartner() *ForcePartner

v0.27.1

Jan 10, 2020

v0.27.0

Nov 11, 2019

Changes in this version

+ var ClassNotFoundError = errors.New("class not found")

+ var DefaultApiVersionNumber = "45.0"

+ var DevHubOrgRequiredError = errors.New("Org must be a Dev Hub")

+ var MetricsNotFoundError = errors.New("metrics not found")

+ func ForceScratchLoginAndSave(output *os.File) (username string, err error)

+ type AuthCodeSession struct

+ RefreshToken string

type Force

+ func (f *Force) CreateScratchOrg() (id string, err error)

+ func (f *Force) ForceLoginNewScratch(scratchOrgId string) (session ForceSession, err error)

+ type ScratchOrg struct

+ AuthCode string

+ InstanceUrl string

+ UserName string

v0.26.9

Jun 3, 2019

Changes in this version

+ var SessionRefreshUnavailable = errors.New("Unable to refresh. Please run `force login`.")

v0.26.8

May 31, 2019

v0.26.7

May 31, 2019

Changes in this version

type ForceMetadata

+ func (fm *ForceMetadata) GetStatus(id string) (status MetadataDeployStatus, err error)

+ func (fm *ForceMetadata) InstallPackageByNamespaceAndVersion(namespace, version, password string, activateRemoteSiteSettings bool) (id string, err error)

+ type MetadataDeployStatus struct

+ Done bool

+ Message string

+ State string

v0.26.6

May 28, 2019

v0.26.5

May 22, 2019

Changes in this version

+ func ForceLoginAtEndpointAndSave(endpoint string, output *os.File) (username string, err error)

+ func ForceLoginAtEndpointAndSaveJWT(endpoint string, assertion string, output *os.File) (username string, err error)

+ func ForceLoginAtEndpointAndSaveSoap(endpoint string, user_name string, password string, output *os.File) (username string, err error)

+ func JwtAssertionForEndpoint(endpoint string, username string, keyfile string, clientId string) (signedToken string, err error)

type ForceSession

+ EndpointUrl string

+ func ForceLoginAtEndpoint(endpoint string) (creds ForceSession, err error)

+ func ForceSoapLoginAtEndpoint(endpoint string, username string, password string) (creds ForceSession, err error)

+ func JWTLoginAtEndpoint(endpoint string, assertion string) (creds ForceSession, err error)

v0.26.4

May 8, 2019

v0.26.3

May 7, 2019

Changes in this version

type Force

+ func (f *Force) GetAbsoluteBytes(url string) (result []byte, err error)

v0.26.2

May 6, 2019

Changes in this version

+ var APILimitExceededError = errors.New("API limit exceeded")

+ var SessionRefreshError = errors.New("Failed to refresh session. Please run `force login`.")

+ type Logger interface

+ Info func(...interface{})

+ var Log Logger

v0.26.1

May 2, 2019

Changes in this version

+ type BatchResultChunk struct

+ Data []byte

+ HasCSVHeader bool

type Force

+ func (f *Force) RetrieveBulkJobQueryResultsAndSend(job JobInfo, batchId string, resultId string, results chan<- BatchResultChunk) error

v0.26.0

Mar 12, 2019

Changes in this version

type ForceCheckDeploymentStatusResult

+ ErrorMessage string

+ ErrorStatusCode string

v0.25.0

Oct 2, 2018

Changes in this version

type BatchInfo

+ StateMessage string

type ForceMetadata

+ func (fm *ForceMetadata) InstallPackageWithRSS(namespace, version, password string, activateRemoteSiteSettings bool) (err error)

v0.24.3

Jun 15, 2018

v0.24.2

Apr 29, 2018

Changes in this version

type ForceMetadata

+ func (fm *ForceMetadata) DeployRecentValidation(validationId string) (results ForceCheckDeploymentStatusResult, err error)

+ func (fm *ForceMetadata) InstallPackage(namespace, version, password string) (err error)

v0.24.1

Apr 13, 2018

v0.24.0

Mar 26, 2018

Changes in this version

+ var InvalidBulkObject = errors.New("Object Does Not Support Bulk API")

+ func ForceLoginAndSaveJWT(endpoint ForceEndpoint, assertion string, output *os.File) (username string, err error)

+ func JwtAssertion(endpoint ForceEndpoint, username string, keyfile string, clientId string) (signedToken string, err error)

type Force

+ func GetForce(accountName string) (force *Force, err error)

+ func (f *Force) RetrieveBulkJobQueryResults(job JobInfo, batchId string, resultId string) ([]byte, error)

+ func (f *Force) RetrieveBulkQueryResultList(job JobInfo, batchId string) ([]byte, error)

type ForceSession

+ ClientId string

+ func GetAccountCredentials(accountName string) (creds ForceSession, err error)

+ func JWTLogin(endpoint ForceEndpoint, assertion string) (creds ForceSession, err error)

+ type OAuthError struct

+ Error string

+ ErrorDescription string

type PackageBuilder

+ func (pb *PackageBuilder) AddDirectory(fpath string) (namePaths map[string]string, badPaths []string, err error)

v0.23.3

Feb 14, 2018

v0.23.2

Feb 9, 2018

Changes in this version

type Force

+ func (f *Force) DisplayAllForceRecordsf(result ForceQueryResult, format string)

v0.23.1

Jan 31, 2018

v0.23.0

Jan 31, 2018

Changes in this version

type Force

+ func (f *Force) GetAbsolute(url string) (result string, err error)

+ func (f *Force) PatchAbsolute(url string, content string) (result string, err error)

+ func (f *Force) PostAbsolute(url string, content string) (result string, err error)

+ func (f *Force) PostPatchAbsolute(url string, content string, method string) (result string, err error)

+ func (f *Force) QueryAndSend(query string, processor chan<- ForceRecord) (err error)

type ForceCheckDeploymentStatusResult

+ StateDetail string

+ func (results ForceCheckDeploymentStatusResult) String() string

type ForceDeployOptions

+ XMLName xml.Name

type QueryOptions

+ QueryAll bool

v0.22.84

Nov 28, 2017

Changes in this version

+ type FolderId string

+ type FolderName string

+ type FolderType string

+ type FolderedMetadata map[FolderType]Folders

+ type Folders map[FolderId]FolderName

type Force

+ func (force *Force) GetAllFolders() (folders FolderedMetadata, err error)

+ func (force *Force) GetMetadataInFolders(metadataType FolderType, folders Folders) (metadataItems []string, err error)

type JobInfo

+ ExternalIdFieldName string

+ XMLName xml.Name

+ type NamespacePrefix string

+ type QueryOptions struct

+ IsTooling bool

v0.22.83

Nov 15, 2017

v0.22.82

Oct 28, 2017

Changes in this version

+ type RunTestsRequest struct

+ AllTests bool

+ Classes []string

+ MaxFailedTests int

+ Namespace string

+ Tests []TestNode

+ func NewRunTestsRequest(tests []string, namespace string) (request RunTestsRequest, err error)

+ type TestNode struct

+ ClassName string

+ TestMethods []string

v0.22.81

Oct 16, 2017

Changes in this version

type ForcePartner

+ func (partner *ForcePartner) ExecuteAnonymousTest(apex string) (output string, err error)

v0.22.80

Oct 4, 2017

v0.22.79

Sep 29, 2017

Changes in this version

+ const RefreshOauth

+ const RefreshSFDX

+ const RefreshUnavailable

+ func SaveLogin(creds ForceSession) (err error)

+ func UseSFDXSession(authData SFDXAuth)

type Force

+ func (f *Force) DisplayAllForceRecords(result ForceQueryResult)

+ func (f *Force) RefreshSessionOrExit()

+ func (f *Force) UpdateApiVersion(version string) (err error)

+ type ForceSession struct

+ AccessToken string

+ ForceEndpoint ForceEndpoint

+ InstanceUrl string

+ IssuedAt string

+ RefreshToken string

+ Scope string

+ SessionOptions *SessionOptions

+ UserInfo *UserInfo

+ func (creds *ForceSession) SessionName() string

+ type RefreshMethod int

+ type SFDXAuth struct

+ AccessToken string

+ Alias string

+ ClientId string

+ CreatedBy string

+ DevHubId string

+ Edition string

+ Id string

+ InstanceUrl string

+ OrgName string

+ Password string

+ Status string

+ Username string

+ func GetSFDXAuth(user string) (auth SFDXAuth, err error)

+ type SessionOptions struct

+ Alias string

+ ApiVersion string

+ RefreshMethod RefreshMethod

+ type UserInfo struct

+ OrgId string

+ OrgNamespace string

+ ProfileId string

+ UserId string

+ UserName string

v0.22.78

Sep 27, 2017

Changes in this version

+ const ClientId

+ const EndpointCustom

+ const EndpointMobile1

+ const EndpointPrerelease

+ const EndpointProduction

+ const EndpointTest

+ const RedirectUri

+ var BatchInfoTemplate = ...

+ var CustomEndpoint = ``

+ var SessionExpiredError = errors.New("Session expired")

+ var Timeout int64 = 0

+ var Version = "dev"

+ func ActiveLogin() (account string, err error)

+ func ApiVersion() string

+ func ApiVersionNumber() string

+ func DeployPackage(resourcepaths []string, opts *ForceDeployOptions)

+ func DisplayAutonumberFieldDetails() (message string)

+ func DisplayBatchInfo(batchInfo BatchInfo)

+ func DisplayBatchList(batchInfos []BatchInfo)

+ func DisplayCheckboxFieldDetails() (message string)

+ func DisplayCurrencyFieldDetails() (message string)

+ func DisplayDatetimeFieldDetails() (message string)

+ func DisplayDoubleFieldDetails() (message string)

+ func DisplayFieldDetails(fieldType string)

+ func DisplayFieldTypes()

+ func DisplayForceRecord(record ForceRecord)

+ func DisplayForceRecords(result ForceQueryResult)

+ func DisplayForceRecordsf(records []ForceRecord, format string)

+ func DisplayForceSobject(sobject ForceSobject)

+ func DisplayForceSobjectDescribe(sobject string)

+ func DisplayForceSobjects(sobjects []ForceSobject)

+ func DisplayForceSobjectsJson(sobjects []ForceSobject)

+ func DisplayGeolocationFieldDetails() (message string)

+ func DisplayInterfaceMap(object map[string]interface{}, indent int)

+ func DisplayJobInfo(jobInfo JobInfo)

+ func DisplayListMetadataResponse(resp ListMetadataResponse)

+ func DisplayListMetadataResponseJson(resp ListMetadataResponse)

+ func DisplayLongTextAreaFieldDetails() (message string)

+ func DisplayLookupFieldDetails() (message string)

+ func DisplayMasterDetailFieldDetails() (message string)

+ func DisplayMetadataList(metadataObjects []DescribeMetadataObject)

+ func DisplayMetadataListJson(metadataObjects []DescribeMetadataObject)

+ func DisplayPicklistFieldDetails() (message string)

+ func DisplayRichTextAreaFieldDetails() (message string)

+ func DisplayTextAreaFieldDetails() (message string)

+ func DisplayTextFieldDetails() (message string)

+ func ForceLoginAndSave(endpoint ForceEndpoint, output *os.File) (username string, err error)

+ func ForceLoginAndSaveSoap(endpoint ForceEndpoint, user_name string, password string, output *os.File) (username string, err error)

+ func ForceSaveLogin(creds ForceCredentials, output *os.File) (username string, err error)

+ func MetaPathToSourcePath(mpath string) (spath string)

+ func PushByPaths(fpaths []string, byName bool, namePaths map[string]string, ...)

+ func RenderForceRecords(records []ForceRecord) string

+ func RenderForceRecordsCSV(records []ForceRecord, format string) string

+ func SetActiveCreds(authData UserAuth)

+ func SetActiveLogin(account string) (err error)

+ func SetActiveLoginDefault() (account string)

+ func SetApiVersion(version string)

+ func StringSliceContains(slice []string, value string) bool

+ func StringSlicePos(slice []string, value string) int

+ func StringSliceToInterfaceSlice(s []string) (i []interface{})

+ func UpdateApiVersion(version string)

+ func ValidateOptionsAndDefaults(typ string, fields map[string]reflect.StructField, ...) (newOptions map[string]string, err error)

+ type AuraDefinition struct

+ AuraDefinitionBundleId string

+ CreatedById string

+ CreatedDate string

+ DefType string

+ Format string

+ Id string

+ IsDeleted bool

+ LastModifiedById string

+ LastModifiedDate string

+ Source string

+ SystemModstamp string

+ type AuraDefinitionBundle struct

+ ApiVersion int

+ CreatedById string

+ CreatedDate string

+ Description string

+ DeveloperName string

+ Id string

+ IsDeleted bool

+ Language string

+ LastModifiedById string

+ LastModifiedDate string

+ MasterLabel string

+ NamespacePrefix string

+ SystemModstamp string

+ type AuraDefinitionBundleResult struct

+ Done bool

+ EntityTypeName string

+ NextRecordsUrl string

+ QueryLocator string

+ Records []ForceRecord

+ Size int

+ TotalSize int

+ type AutoNumberField struct

+ Description string

+ DisplayFormat string

+ ExternalId bool

+ HelpText string

+ Label string

+ StartingNumber int

+ type AutoNumberFieldRequired struct

+ DisplayFormat string

+ StartingNumber int

+ type BatchInfo struct

+ CreatedDate string

+ Id string

+ JobId string

+ NumberRecordsProcessed int

+ State string

+ SystemModstamp string

+ type BatchResult struct

+ Results []Result

+ type BigObject struct

+ DeploymentStatus string

+ Fields []BigObjectField

+ Label string

+ PluralLabel string

+ func (bo *BigObject) ToXml() string

+ type BigObjectField struct

+ FullName string

+ Label string

+ Length int

+ ReferenceTo string

+ RelationshipName string

+ Type string

+ type BoolField struct

+ DefaultValue bool

+ Description string

+ Formula string

+ FormulaTreatBlanksAs string

+ HelpText string

+ Label string

+ type BoolFieldRequired struct

+ DefaultValue bool

+ type BundleManifest struct

+ Files []ComponentFile

+ Id string

+ Name string

+ type ByFullName []MDFileProperties

+ func (a ByFullName) Len() int

+ func (a ByFullName) Less(i, j int) bool

+ func (a ByFullName) Swap(i, j int)

+ type ByXmlName []DescribeMetadataObject

+ func (a ByXmlName) Len() int

+ func (a ByXmlName) Less(i, j int) bool

+ func (a ByXmlName) Swap(i, j int)

+ type CodeCoverageWarning struct

+ Message string

+ Name string

+ type ComponentDetails struct

+ ComponentFailures []ComponentFailure

+ ComponentSuccesses []ComponentSuccess

+ RunTestResult RunTestResult

+ type ComponentFailure struct

+ Changed bool

+ Created bool

+ Deleted bool

+ FileName string

+ FullName string

+ LineNumber int

+ Problem string

+ ProblemType string

+ Success bool

+ type ComponentFile struct

+ ComponentId string

+ FileName string

+ type ComponentSuccess struct

+ Changed bool

+ Created bool

+ Deleted bool

+ FileName string

+ FullName string

+ Id string

+ Success bool

+ type DatetimeField struct

+ DefaultValue time.Time

+ Description string

+ Formula string

+ FormulaTreatBlanksAs string

+ HelpText string

+ Label string

+ Required bool

+ type DatetimeFieldRequired struct

+ type DescribeMetadataObject struct

+ ChildXmlNames []string

+ DirectoryName string

+ InFolder bool

+ MetaFile bool

+ Suffix string

+ XmlName string

+ type EmailField struct

+ Label string

+ type EmailFieldRequired struct

+ type EncryptedField struct

+ Description string

+ HelpText string

+ Label string

+ Length int

+ MaskChar string

+ MaskType string

+ Name string

+ Required bool

+ type EncryptedFieldRequired struct

+ Length int

+ MaskChar string

+ MaskType string

+ type FieldName struct

+ FieldName string

+ IsObject bool

+ type FloatField struct

+ DefaultValue uint

+ Description string

+ ExternalId bool

+ Formula string

+ FormulaTreatBlanksAs string

+ HelpText string

+ Label string

+ Precision int

+ Scale int

+ Unique bool

+ type FloatFieldRequired struct

+ Precision int

+ Scale int

+ type Force struct

+ Credentials *ForceCredentials

+ Metadata *ForceMetadata

+ Partner *ForcePartner

+ func ActiveForce() (force *Force, err error)

+ func NewForce(creds *ForceCredentials) (force *Force)

+ func (f *Force) AddBatchToJob(xmlbody string, jobId string) (result BatchInfo, err error)

+ func (f *Force) BulkQuery(soql string, jobId string, contettype string) (result BatchInfo, err error)

+ func (f *Force) ChangePassword(id string, attrs map[string]string) (result string, err error, emessages []ForceError)

+ func (f *Force) CloseBulkJob(jobId string, xmlbody string) (result JobInfo, err error)

+ func (f *Force) CreateAuraBundle(bundleName string) (result ForceCreateRecordResult, err error, emessages []ForceError)

+ func (f *Force) CreateAuraComponent(attrs map[string]string) (result ForceCreateRecordResult, err error, emessages []ForceError)

+ func (f *Force) CreateBulkJob(xmlbody string) (result JobInfo, err error)

+ func (f *Force) CreateDataPipeline(name string, masterLabel string, apiVersionNumber string, scriptContent string, ...) (result ForceCreateRecordResult, err error, emessages []ForceError)

+ func (f *Force) CreateDataPipelineJob(id string) (result ForceCreateRecordResult, err error, emessages []ForceError)

+ func (f *Force) CreateRecord(sobject string, attrs map[string]string) (id string, err error, emessages []ForceError)

+ func (f *Force) CreateToolingRecord(objecttype string, attrs map[string]string) (result ForceCreateRecordResult, err error)

+ func (f *Force) DecodeMe(jsonStream string) (result *list.List)

+ func (f *Force) DecodeMe2(jsonStream string) (result ForceQueryResult)

+ func (f *Force) DefaultDebugLevel() (id string, err error, emessages []ForceError)

+ func (f *Force) DeleteDataPipeline(id string) (err error)

+ func (f *Force) DeleteRecord(sobject string, id string) (err error)

+ func (f *Force) DeleteToolingRecord(objecttype string, id string) (err error)

+ func (f *Force) DescribeSObject(objecttype string) (result string, err error)

+ func (f *Force) DumpListStack(l *list.List)

+ func (f *Force) Get(url string) (object ForceRecord, err error)

+ func (f *Force) GetAuraBundle(bundleName string) (bundles AuraDefinitionBundleResult, definitions AuraDefinitionBundleResult, ...)

+ func (f *Force) GetAuraBundleByName(bundleName string) (bundles AuraDefinitionBundleResult, err error)

+ func (f *Force) GetAuraBundleDefinition(id string) (definitions AuraDefinitionBundleResult, err error)

+ func (f *Force) GetAuraBundleDefinitions() (definitions AuraDefinitionBundleResult, err error)

+ func (f *Force) GetAuraBundles() (bundles AuraDefinitionBundleResult, definitions AuraDefinitionBundleResult, ...)

+ func (f *Force) GetAuraBundlesList() (bundles AuraDefinitionBundleResult, err error)

+ func (f *Force) GetBatchInfo(jobId string, batchId string) (result BatchInfo, err error)

+ func (f *Force) GetBatches(jobId string) (result []BatchInfo, err error)

+ func (f *Force) GetBulkJobs() (result []JobInfo, err error)

+ func (f *Force) GetCodeCoverage(classId string, className string) (err error)

+ func (f *Force) GetConsoleLogLevelId() (result string, err error)

+ func (f *Force) GetDataPipeline(name string) (results ForceQueryResult, err error)

+ func (f *Force) GetJobInfo(jobId string) (result JobInfo, err error)

+ func (f *Force) GetLimits() (result map[string]ForceLimit, err error)

+ func (f *Force) GetMoreAuraBundleDefinitions(definitions *AuraDefinitionBundleResult) (err error)

+ func (f *Force) GetObjectSpec(objectName string, l *list.List) (result *SelectStruct)

+ func (f *Force) GetPasswordStatus(id string) (result ForcePasswordStatusResult, err error)

+ func (f *Force) GetPrevObjectSpec(objectName string, l *list.List) (foundItem *SelectStruct)

+ func (f *Force) GetREST(url string) (result string, err error)

+ func (f *Force) GetRecord(sobject, id string) (object ForceRecord, err error)

+ func (f *Force) GetSobject(name string) (sobject ForceSobject, err error)

+ func (f *Force) HasObject(objectName string, l *list.List) (result bool, foundItem *SelectStruct)

+ func (f *Force) ListSobjects() (sobjects []ForceSobject, err error)

+ func (f *Force) PatchREST(url string, content string) (result string, err error)

+ func (f *Force) PostPatchREST(url string, content string, method string) (result string, err error)

+ func (f *Force) PostREST(url string, content string) (result string, err error)

+ func (f *Force) PushFieldName(fieldName string, spec *SelectStruct, IsObject bool)

+ func (f *Force) Query(query string, isTooling bool) (result ForceQueryResult, fieldList *list.List, err error)

+ func (f *Force) QueryDataPipeline(soql string) (results ForceQueryResult, err error)

+ func (f *Force) QueryDataPipelineJob(soql string) (results ForceQueryResult, err error)

+ func (f *Force) QueryDefaultDebugLevel() (id string, err error)

+ func (f *Force) QueryEventLogFiles() (results ForceQueryResult, err error)

+ func (f *Force) QueryLogs() (results ForceQueryResult, err error)

+ func (f *Force) QueryProfile(fields ...string) (results ForceQueryResult, err error)

+ func (f *Force) QueryTraceFlags() (results ForceQueryResult, err error)

+ func (f *Force) RefreshSession() (err error, emessages []ForceError)

+ func (f *Force) ResetPassword(id string) (result ForcePasswordResetResult, err error)

+ func (f *Force) RetrieveBulkBatchResults(jobId string, batchId string) (results BatchResult, err error)

+ func (f *Force) RetrieveBulkQuery(jobId string, batchId string) (result []byte, err error)

+ func (f *Force) RetrieveBulkQueryResults(jobId string, batchId string, resultId string) (result []byte, err error)

+ func (f *Force) RetrieveEventLogFile(elfId string) (result string, err error)

+ func (f *Force) RetrieveLog(logId string) (result string, err error)

+ func (f *Force) SetFLS(profileId string, objectName string, fieldName string)

+ func (f *Force) StartTrace(userId ...string) (result ForceCreateRecordResult, err error, emessages []ForceError)

+ func (f *Force) UpdateAuraComponent(source map[string]string, id string) (err error)

+ func (f *Force) UpdateCredentials(creds ForceCredentials)

+ func (f *Force) UpdateDataPipeline(id string, masterLabel string, scriptContent string) (err error)

+ func (f *Force) UpdateRecord(sobject string, id string, attrs map[string]string) (err error)

+ func (f *Force) Whoami() (me ForceRecord, err error)

+ type ForceCheckDeploymentStatusResult struct

+ CheckOnly bool

+ CompletedDate time.Time

+ CreatedDate time.Time

+ Details ComponentDetails

+ Done bool

+ Id string

+ NumberComponentErrors int

+ NumberComponentsDeployed int

+ NumberComponentsTotal int

+ NumberTestErrors int

+ NumberTestsCompleted int

+ NumberTestsTotal int

+ RollbackOnError bool

+ Status string

+ Success bool

+ type ForceConnectedApp struct

+ Id string

+ Name string

+ Type string

+ type ForceConnectedApps []ForceConnectedApp

+ func (apps ForceConnectedApps) Len() int

+ func (apps ForceConnectedApps) Less(i, j int) bool

+ func (apps ForceConnectedApps) Swap(i, j int)

+ type ForceCreateRecordResult struct

+ Errors []string

+ Id string

+ Success bool

+ type ForceCredentials struct

+ AccessToken string

+ ApiVersion string

+ ForceEndpoint ForceEndpoint

+ HourlyCheck bool

+ Id string

+ InstanceUrl string

+ IsCustomEP bool

+ IsHourly bool

+ IssuedAt string

+ Namespace string

+ ProfileId string

+ RefreshToken string

+ Scope string

+ UserId string

+ func ActiveCredentials(requireCredentials bool) (creds ForceCredentials, err error)

+ func ForceLogin(endpoint ForceEndpoint) (creds ForceCredentials, err error)

+ func ForceSoapLogin(endpoint ForceEndpoint, username string, password string) (creds ForceCredentials, err error)

+ type ForceDeployOptions struct

+ AllowMissingFiles bool

+ AutoUpdatePackage bool

+ CheckOnly bool

+ IgnoreWarnings bool

+ PerformRetrieve bool

+ PurgeOnDelete bool

+ RollbackOnError bool

+ RunTests []string

+ SinglePackage bool

+ TestLevel string

+ type ForceEndpoint int

+ type ForceError struct

+ ErrorCode string

+ Message string

+ type ForceLimit struct

+ Max int64

+ Name string

+ Remaining int64

+ type ForceLimits map[string]ForceLimit

+ type ForceMetadata struct

+ ApiVersion string

+ Force *Force

+ func NewForceMetadata(force *Force) (fm *ForceMetadata)

+ func (fm *ForceMetadata) CheckDeployStatus(id string) (results ForceCheckDeploymentStatusResult, err error)

+ func (fm *ForceMetadata) CheckRetrieveStatus(id string) (files ForceMetadataFiles, err error)

+ func (fm *ForceMetadata) CheckStatus(id string) (err error)

+ func (fm *ForceMetadata) CreateBigObject(object BigObject) (err error)

+ func (fm *ForceMetadata) CreateConnectedApp(name, callback string) (err error)

+ func (fm *ForceMetadata) CreateCustomField(object, field, typ string, options map[string]string) (err error)

+ func (fm *ForceMetadata) CreateCustomObject(object string) (err error)

+ func (fm *ForceMetadata) DeleteCustomField(object, field string) (err error)

+ func (fm *ForceMetadata) DeleteCustomObject(object string) (err error)

+ func (fm *ForceMetadata) Deploy(files ForceMetadataFiles, options ForceDeployOptions) (results ForceCheckDeploymentStatusResult, err error)

+ func (fm *ForceMetadata) DeployWithTempFile(soap string, filename string)

+ func (fm *ForceMetadata) DeployZipFile(soap string, zipfile []byte) (results ForceCheckDeploymentStatusResult, err error)

+ func (fm *ForceMetadata) DescribeMetadata() (describe MetadataDescribeResult, err error)

+ func (fm *ForceMetadata) GetFLSUpdateXML(objectName string, fieldName string) (result string)

+ func (fm *ForceMetadata) ListAllMetadata() (describe MetadataDescribeResult, err error)

+ func (fm *ForceMetadata) ListConnectedApps() (apps ForceConnectedApps, err error)

+ func (fm *ForceMetadata) ListMetadata(query string) (res []byte, err error)

+ func (fm *ForceMetadata) MakeDeploySoap(options ForceDeployOptions) (soap string)

+ func (fm *ForceMetadata) MakeZip(files ForceMetadataFiles) (zipdata []byte, err error)

+ func (fm *ForceMetadata) Retrieve(query ForceMetadataQuery) (files ForceMetadataFiles, err error)

+ func (fm *ForceMetadata) RetrieveByPackageXml(package_xml string) (files ForceMetadataFiles, err error)

+ func (fm *ForceMetadata) RetrievePackage(packageName string) (files ForceMetadataFiles, err error)

+ func (fm *ForceMetadata) UpdateFLSOnProfile(objectName string, fieldName string) (err error)

+ func (fm *ForceMetadata) ValidateFieldOptions(typ string, options map[string]string) (newOptions map[string]string, err error)

+ type ForceMetadataDeployProblem struct

+ Changed bool

+ Created bool

+ Deleted bool

+ Filename string

+ Name string

+ Problem string

+ ProblemType string

+ Success bool

+ type ForceMetadataFiles map[string][]byte

+ type ForceMetadataQuery []ForceMetadataQueryElement

+ type ForceMetadataQueryElement struct

+ Members []string

+ Name []string

+ type ForcePartner struct

+ Force *Force

+ func NewForcePartner(force *Force) (partner *ForcePartner)

+ func (partner *ForcePartner) CheckStatus(id string) (err error)

+ func (partner *ForcePartner) ExecuteAnonymous(apex string) (output string, err error)

+ func (partner *ForcePartner) RunTests(tests []string, namespace string) (output TestCoverage, err error)

+ func (partner *ForcePartner) SoapExecuteCore(action, query string) (response []byte, err error)

+ type ForcePasswordResetResult struct

+ NewPassword string

+ type ForcePasswordStatusResult struct

+ IsExpired bool

+ type ForceQueryResult struct

+ Done bool

+ NextRecordsUrl string

+ Records []ForceRecord

+ TotalSize int

+ func (result *ForceQueryResult) Update(other ForceQueryResult, force *Force)

+ type ForceRecord map[string]interface

+ type ForceSobject map[string]interface

+ type ForceSobjectFields []interface

+ func (f ForceSobjectFields) Len() int

+ func (f ForceSobjectFields) Less(i, j int) bool

+ func (f ForceSobjectFields) Swap(i, j int)

+ type ForceSobjectsResult struct

+ Encoding string

+ MaxBatchSize int

+ Sobjects []ForceSobject

+ type GenericForceError struct

+ Error string

+ Error_Description string

+ type GeolocationField struct

+ Description string

+ DsiplayLocationInDecimal bool

+ HelpText string

+ Required bool

+ Scale int

+ type GeolocationFieldRequired struct

+ DisplayLocationInDecimal bool

+ Scale int

+ type JobInfo struct

+ ApexProcessingTime int

+ ApiActiveProcessingTime int

+ ApiVersion string

+ ConcurrencyMode string

+ ContentType string

+ CreatedById string

+ CreatedDate string

+ Id string

+ NumberBatchesCompleted int

+ NumberBatchesFailed int

+ NumberBatchesInProgress int

+ NumberBatchesQueued int

+ NumberBatchesTotal int

+ NumberRecordsFailed int

+ NumberRecordsProcessed int

+ NumberRetries int

+ Object string

+ Operation string

+ State string

+ SystemModStamp string

+ TotalProcessingTime int

+ type ListMetadataResponse struct

+ Result []MDFileProperties

+ type LoginFault struct

+ ExceptionCode string

+ ExceptionMessage string

+ type LongTextAreaField struct

+ DefaultValue string

+ Description string

+ HelpText string

+ Label string

+ Length int

+ Name string

+ Required bool

+ VisibleLines int

+ type LongTextAreaFieldRequired struct

+ Length int

+ VisibleLines int

+ type LookupField struct

+ Label string

+ ReferenceTo string

+ RelationshipLabel string

+ RelationshipName string

+ type LookupFieldRequired struct

+ type MDFileProperties struct

+ CreateByName string

+ CreateDate time.Time

+ CreatedById string

+ FileName string

+ FullName string

+ Id string

+ LastModifedDate time.Time

+ LastModifiedById string

+ LastModifiedByName string

+ ManageableState string

+ NamespacePrefix string

+ Type string

+ type MasterDetail struct

+ Label string

+ ReferenceTo string

+ RelationshipLabel string

+ RelationshipName string

+ type MasterDetailRequired struct

+ type MetaType struct

+ Members []string

+ Name string

+ type MetadataDescribeResult struct

+ MetadataObjects []DescribeMetadataObject

+ NamespacePrefix string

+ PartialSaveAllowed bool

+ TestRequired bool

+ type MetadataDescribeValueTypeResult struct

+ ValueTypeFields []MetadataValueTypeField

+ type MetadataValueTypeField struct

+ ForeignKeyDomain string

+ IsForeignKey bool

+ IsNameField bool

+ MinOccurs int

+ Name string

+ SoapType string

+ type NumberField struct

+ DefaultValue uint

+ Description string

+ ExternalId bool

+ Formula string

+ FormulaTreatBlanksAs string

+ HelpText string

+ Label string

+ Precision int

+ Scale int

+ Unique bool

+ type NumberFieldRequired struct

+ Precision int

+ Scale int

+ type Package struct

+ Types []MetaType

+ Version string

+ Xmlns string

+ type PackageBuilder struct

+ Files ForceMetadataFiles

+ IsPush bool

+ Metadata map[string]MetaType

+ func NewFetchBuilder() PackageBuilder

+ func NewPushBuilder() PackageBuilder

+ func (pb *PackageBuilder) AddFile(fpath string) (fname string, err error)

+ func (pb *PackageBuilder) AddMetaToPackage(metaName string, name string)

+ func (pb *PackageBuilder) ForceMetadataFiles() ForceMetadataFiles

+ func (pb PackageBuilder) PackageXml() []byte

+ type PhoneField struct

+ DefaultValue string

+ Description string

+ HelpText string

+ Label string

+ Name string

+ Required bool

+ type PhoneFieldRequired struct

+ type PicklistField struct

+ Label string

+ Picklist []PicklistValue

+ type PicklistFieldRequired struct

+ Picklist []PicklistValue

+ type PicklistValue struct

+ Default bool

+ FullName string

+ type Result struct

+ Created bool

+ Id string

+ Message string

+ Success bool

+ type RichTextAreaField struct

+ Description string

+ HelpText string

+ Label string

+ Length int

+ Name string

+ Required bool

+ VisibleLines int

+ type RichTextAreaFieldRequired struct

+ Length int

+ VisibleLines int

+ type RunTestResult struct

+ CodeCoverageWarnings []CodeCoverageWarning

+ NumberOfFailures int

+ NumberOfTestsRun int

+ TestFailures []TestFailure

+ TestSuccesses []TestSuccess

+ TotalTime float32

+ type SelectStruct struct

+ FieldNames []FieldName

+ ObjectName string

+ type Soap struct

+ AccessToken string

+ Endpoint string

+ Header string

+ Namespace string

+ func NewSoap(endpoint, namespace, accessToken string) (s *Soap)

+ func (s *Soap) Execute(action, query string) (response []byte, err error)

+ func (s *Soap) ExecuteLogin(username, password string) (response []byte, err error)

+ type SoapError struct

+ FaultCode string

+ FaultString string

+ type SoapFault struct

+ Detail LoginFault

+ FaultCode string

+ FaultString string

+ type StringField struct

+ CaseSensitive bool

+ DefaultValue string

+ Description string

+ ExternalId bool

+ Formula string

+ FormulaTreatBlanksAs string

+ HelpText string

+ Label string

+ Length int

+ Name string

+ Required bool

+ Unique bool

+ type StringFieldRequired struct

+ Length int

+ type TestCoverage struct

+ FClassNames []string

+ FMessage []string

+ FMethodNames []string

+ FStackTrace []string

+ Log string

+ Name []string

+ NumberFailures int

+ NumberLocations []int

+ NumberLocationsNotCovered []int

+ NumberRun int

+ SClassNames []string

+ SMethodNames []string

+ type TestFailure struct

+ Message string

+ MethodName string

+ Name string

+ StackTrace string

+ Time float32

+ type TestRunner interface

+ RunTests func(tests []string, namespace string) (output TestCoverage, err error)

+ type TestSuccess struct

+ MethodName string

+ Name string

+ Time float32

+ type TextAreaField struct

+ DefaultValue string

+ Description string

+ HelpText string

+ Label string

+ Name string

+ Required bool

+ type TextAreaFieldRequired struct

+ type UrlField struct

+ DefaultValue string

+ Description string

+ Formula string

+ FormulaTreatBlanksAs string

+ HelpText string

+ Label string

+ Name string

+ Required bool

+ type UrlFieldRequired struct

+ type UserAuth struct

+ AccessToken string

+ Alias string

+ ClientId string

+ CreatedBy string

+ DevHubId string

+ Edition string

+ Id string

+ InstanceUrl string

+ OrgName string

+ Password string

+ Status string

+ Username string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL