Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

service

package

Go to main page

Versions in this module

v1

v1.6.7

Aug 9, 2024

v1.6.6

Jul 24, 2024

v1.6.5

Jun 21, 2024

v1.6.4

May 21, 2024

v1.6.3

Apr 19, 2024

v1.6.2

Mar 7, 2024

v1.6.1

Feb 23, 2024

v1.6.0

Feb 2, 2024

Changes in this version

+ var ErrDocAppNotFound = errors.New("doc app not found")

+ var ErrSignatureRequestAlreadyExists = errors.New("Request already exists")

+ var ErrTxHashEmpty = errors.New("no txHash given")

+ var ErrUnableToEdit = errors.New("document edit failed")

+ func GetDataManager(auth model.MemoryAuth) form.DataManager

+ func Init(s *sys.System)

+ func NewApiService() *defaultApiService

+ func NewAuthenticationService(userS UserService, workflowS WorkflowService, emailS EmailService) *defaultAuthenticationService

+ func NewNodeService(workflowService WorkflowService) *defaultNodeService

+ func NewUserService() *defaultUserService

+ type ApiService interface

+ AuthenticateApiKeyForUser func(apiKey string, userId string) (*model.User, error)

+ AuthenticateWithApiKey func(apiKey string) (*model.User, error)

+ CreateApiKey func(auth model.Auth, userId, apiKeyName string) (string, error)

+ DeleteApiKey func(auth model.Auth, userId, hiddenApiKey string) error

+ type AuthenticationService interface

+ ChangeEmail func(tokenID string) (*model.TokenRequest, error)

+ LoginWithUsernamePassword func(email, password string) (*model.User, error)

+ LoginWithWallet func(challenge, signature string) (bool, *model.User, error)

+ PutTokenRequest func(token *model.TokenRequest) error

+ Register func(translator www.Translator, tokenID, password string) (error, map[string]interface{})

+ RegisterRequest func(translator www.Translator, scheme, host string, m *model.TokenRequest) (model.TokenRequest, error)

+ ResetPassword func(translator www.Translator, password, tokenID string) (error, map[string]interface{})

+ ResetPasswordRequest func(translator www.Translator, scheme, host string, m *model.TokenRequest) (model.TokenRequest, error)

+ type DefaultDocumentService struct

+ func NewDocumentService(userS UserService, fileS FileService) *DefaultDocumentService

+ func (me *DefaultDocumentService) Delete(auth model.MemoryAuth, id string) error

+ func (me *DefaultDocumentService) Edit(auth model.Auth, userId string, formInput map[string]interface{}) error

+ func (me *DefaultDocumentService) GetDocApp(auth model.MemoryAuth, id string) *app.DocumentFlowInstance

+ func (me *DefaultDocumentService) GetFile(auth model.MemoryAuth, id, inputName string) (*file.IO, error)

+ func (me *DefaultDocumentService) GetWorkflowSchema(auth model.Auth, workflowId string) (*model.WorkflowItem, map[string]interface{}, error)

+ func (me *DefaultDocumentService) Next(auth model.MemoryAuth, id, lang string, data map[string]interface{}, ...) (*app.DocumentFlowInstance, *app.Status, error)

+ func (me *DefaultDocumentService) Prev(auth model.MemoryAuth, id string) (*app.Status, error)

+ func (me *DefaultDocumentService) Preview(auth model.MemoryAuth, id, templateId, lang, format string) (*app.PreviewResponse, error)

+ func (me *DefaultDocumentService) Update(auth model.MemoryAuth, id string, data map[string]interface{}) (validate.ErrorMap, error)

+ func (me *DefaultDocumentService) UpdateFile(auth model.MemoryAuth, id, fieldName, fileName, contentType string, ...) (*file.IO, validate.Errors, error)

+ type DefaultEmailService struct

+ func (me *DefaultEmailService) Send(emailTo, subject, body string) error

+ func (me *DefaultEmailService) SendFrom(emailFrom, emailTo, subject, body string) error

+ type DefaultFileService struct

+ func NewFileService() *DefaultFileService

+ func (me *DefaultFileService) GetDataAndFiles(auth model.Auth, id, dataPath string) (interface{}, []string, error)

+ func (me *DefaultFileService) GetDataFile(auth model.Auth, id, dataPath string) (*file.IO, error)

+ func (me *DefaultFileService) Read(path string, w io.Writer) error

+ type DefaultFormComponentService struct

+ func NewFormComponentService() *DefaultFormComponentService

+ func (me *DefaultFormComponentService) DelComp(auth model.Auth, id string) error

+ func (me *DefaultFormComponentService) EnsureDefaultFormComponents(auth model.Auth) error

+ func (me *DefaultFormComponentService) GetComp(auth model.Auth, id string) (*model.FormComponentItem, error)

+ func (me *DefaultFormComponentService) ListComp(auth model.Auth, contains string, options storage.Options) (map[string]*model.FormComponentItem, error)

+ func (me *DefaultFormComponentService) SetComp(auth model.Auth, reader io.ReadCloser) (*model.FormComponentItem, error)

+ type DefaultFormService struct

+ func NewFormService() *DefaultFormService

+ func (me *DefaultFormService) Delete(auth model.Auth, id string) error

+ func (me *DefaultFormService) ExportForms(auth model.Auth, id, contains string) []string

+ func (me *DefaultFormService) Get(auth model.Auth, id string) (*model.FormItem, error)

+ func (me *DefaultFormService) GetFormData(auth model.MemoryAuth, id string, reset bool) (map[string]interface{}, error)

+ func (me *DefaultFormService) GetFormFile(auth model.MemoryAuth, id string, fieldname string, writer io.Writer) error

+ func (me *DefaultFormService) List(auth model.Auth, contains string, options storage.Options) ([]*model.FormItem, error)

+ func (me *DefaultFormService) PostFormFile(auth model.MemoryAuth, id string, fileName string, fieldname string, ...) (interface{}, error)

+ func (me *DefaultFormService) SetFormSrc(auth model.MemoryAuth, id string, formSrc map[string]interface{}) error

+ func (me *DefaultFormService) TestFormData(auth model.MemoryAuth, id string, input map[string]interface{}, submit bool) (validate.ErrorMap, error)

+ func (me *DefaultFormService) UpdateForm(auth model.Auth, id string, reader io.ReadCloser) (*model.FormItem, error)

+ func (me *DefaultFormService) Vars(auth model.Auth, contains string, options storage.Options) ([]string, error)

+ type DefaultPaymentService struct

+ func NewPaymentService(userService UserService) *DefaultPaymentService

+ func (me *DefaultPaymentService) All() ([]*model.WorkflowPaymentItem, error)

+ func (me *DefaultPaymentService) CancelWorkflowPayment(paymentId, ethAddress string) error

+ func (me *DefaultPaymentService) CheckForWorkflowPayment(auth model.Auth, workflowId string) error

+ func (me *DefaultPaymentService) CheckIfWorkflowPaymentRequired(auth model.Auth, workflowId string) (bool, error)

+ func (me *DefaultPaymentService) CreateWorkflowPayment(auth model.Auth, workflowId, ethAddress string) (*model.WorkflowPaymentItem, error)

+ func (me *DefaultPaymentService) Delete(paymentId string) error

+ func (me *DefaultPaymentService) GetWorkflowPayment(txHash, ethAddresses, status string) (*model.WorkflowPaymentItem, error)

+ func (me *DefaultPaymentService) GetWorkflowPaymentById(paymentId string) (*model.WorkflowPaymentItem, error)

+ func (me *DefaultPaymentService) RedeemPayment(workflowId, ethAddr string) error

+ func (me *DefaultPaymentService) UpdateWorkflowPaymentPending(paymentId, txHash, ethAddress string) error

+ type DefaultSignatureService struct

+ func (me *DefaultSignatureService) AddAndNotify(auth model.Auth, translator www.Translator, ...) error

+ func (me *DefaultSignatureService) GetById(id, documentId string) (SignatureRequestsMinimal, error)

+ func (me *DefaultSignatureService) GetForCurrentUser(auth model.Auth) (SignatureRequestsComplete, error)

+ func (me *DefaultSignatureService) RejectAndNotify(auth model.Auth, translator www.Translator, id, docId, host string) error

+ func (me *DefaultSignatureService) RevokeAndNotify(auth model.Auth, translator www.Translator, ...) error

+ type DefaultTemplateDocumentService struct

+ func NewTemplateDocumentService() *DefaultTemplateDocumentService

+ func (me *DefaultTemplateDocumentService) Compile(template eio.Template) (*http.Response, error)

+ func (me *DefaultTemplateDocumentService) DeleteTemplate(auth model.Auth, id, lang string) error

+ func (me *DefaultTemplateDocumentService) DeleteTemplateFiles(auth model.Auth, id string) error

+ func (me *DefaultTemplateDocumentService) DownloadExtension(os string) (resp *http.Response, err error)

+ func (me *DefaultTemplateDocumentService) Exists(path string) (bool, error)

+ func (me *DefaultTemplateDocumentService) Get(auth model.Auth, id string) (*model.TemplateItem, error)

+ func (me *DefaultTemplateDocumentService) GetTemplate(auth model.Auth, id, lang string) (*file.IO, error)

+ func (me *DefaultTemplateDocumentService) GetTemplateVars(auth model.Auth, contains string, settings storage.Options) ([]string, error)

+ func (me *DefaultTemplateDocumentService) List(auth model.Auth, contains string, options storage.Options) ([]*model.TemplateItem, error)

+ func (me *DefaultTemplateDocumentService) Put(auth model.Auth, item *model.TemplateItem) error

+ func (me *DefaultTemplateDocumentService) ReadFile(path string, writer io.Writer) error

+ func (me *DefaultTemplateDocumentService) SaveTemplate(auth model.Auth, id, lang, contentType, fileName string, data []byte) error

+ type DefaultUserDocumentService struct

+ func NewUserDocumentService(userS UserService, fileS FileService, ...) *DefaultUserDocumentService

+ func (me *DefaultUserDocumentService) Get(auth model.Auth, id string) (*model.UserDataItem, error)

+ func (me *DefaultUserDocumentService) GetByWorkflow(auth model.Auth, wf *model.WorkflowItem, finished bool) (*model.UserDataItem, bool, error)

+ func (me *DefaultUserDocumentService) GetDocFile(auth model.Auth, id, dataPath, inlineOrAttachment string) (*FileHeaderResponse, string, error)

+ func (me *DefaultUserDocumentService) GetTemplateWithFormatFile(auth model.Auth, id, dataPath, format, inlineOrAttachment string) (*FileHeaderResponse, io.ReadCloser, error)

+ func (me *DefaultUserDocumentService) List(auth model.Auth, contains string, settings storage.Options) ([]*model.UserDataItem, error)

+ func (me *DefaultUserDocumentService) Put(auth model.Auth, userDataItem *model.UserDataItem) error

+ type DefaultWorkflowService struct

+ func NewWorkflowService(userService UserService) *DefaultWorkflowService

+ func (me *DefaultWorkflowService) CopyWorkflows(rootUser, newUser *model.User)

+ func (me *DefaultWorkflowService) Delete(auth model.Auth, id string) error

+ func (me *DefaultWorkflowService) Get(auth model.Auth, id string) (*model.WorkflowItem, error)

+ func (me *DefaultWorkflowService) GetAndPopulateOwner(auth model.Auth, id string) (*model.WorkflowItem, error)

+ func (me *DefaultWorkflowService) GetPublished(auth model.Auth, id string) (*model.WorkflowItem, error)

+ func (me *DefaultWorkflowService) InstantiateExternalNode(auth model.Auth, nodeId, nodeName string) (*extNode.ExternalQuery, error)

+ func (me *DefaultWorkflowService) List(auth model.Auth, contains string, options storage.Options) ([]*model.WorkflowItem, error)

+ func (me *DefaultWorkflowService) ListIds(auth model.Auth, contains string, options storage.Options) ([]string, error)

+ func (me *DefaultWorkflowService) ListPublished(auth model.Auth, contains string, options storage.Options) ([]*model.WorkflowItem, error)

+ func (me *DefaultWorkflowService) Publish(auth model.Auth, wfItem *model.WorkflowItem) map[string]interface{}

+ func (me *DefaultWorkflowService) Put(auth model.Auth, wfItem *model.WorkflowItem) error

+ type DocumentService interface

+ Delete func(auth model.MemoryAuth, id string) error

+ Edit func(auth model.Auth, userId string, formInput map[string]interface{}) error

+ GetDocApp func(auth model.MemoryAuth, id string) *app.DocumentFlowInstance

+ GetFile func(auth model.MemoryAuth, id, inputName string) (*file.IO, error)

+ GetWorkflowSchema func(auth model.Auth, workflowId string) (*model.WorkflowItem, map[string]interface{}, error)

+ Next func(auth model.MemoryAuth, id, lang string, data map[string]interface{}, ...) (*app.DocumentFlowInstance, *app.Status, error)

+ Prev func(auth model.MemoryAuth, id string) (*app.Status, error)

+ Preview func(auth model.MemoryAuth, id, templateId, lang, format string) (*app.PreviewResponse, error)

+ Update func(auth model.MemoryAuth, id string, data map[string]interface{}) (validate.ErrorMap, error)

+ UpdateFile func(auth model.MemoryAuth, id, fieldName, fileName, contentType string, ...) (*file.IO, validate.Errors, error)

+ type EmailService interface

+ Send func(emailTo, subject, body string) error

+ SendFrom func(emailFrom, emailTo, subject, body string) error

+ func NewEmailService() EmailService

+ type FileHeaderResponse struct

+ ContentDisposition string

+ ContentLength string

+ ContentPages string

+ ContentType string

+ type FileService interface

+ GetDataAndFiles func(auth model.Auth, id, dataPath string) (interface{}, []string, error)

+ GetDataFile func(auth model.Auth, id, dataPath string) (*file.IO, error)

+ Read func(path string, w io.Writer) error

+ type FormComponentService interface

+ DelComp func(auth model.Auth, id string) error

+ EnsureDefaultFormComponents func(auth model.Auth) error

+ GetComp func(auth model.Auth, id string) (*model.FormComponentItem, error)

+ ListComp func(auth model.Auth, contains string, options storage.Options) (map[string]*model.FormComponentItem, error)

+ SetComp func(auth model.Auth, reader io.ReadCloser) (*model.FormComponentItem, error)

+ type FormService interface

+ Delete func(auth model.Auth, id string) error

+ ExportForms func(auth model.Auth, id, contains string) []string

+ Get func(auth model.Auth, id string) (*model.FormItem, error)

+ GetFormData func(auth model.MemoryAuth, id string, reset bool) (map[string]interface{}, error)

+ GetFormFile func(auth model.MemoryAuth, id string, fieldname string, writer io.Writer) error

+ List func(auth model.Auth, contains string, options storage.Options) ([]*model.FormItem, error)

+ PostFormFile func(auth model.MemoryAuth, id string, fileName string, fieldname string, ...) (interface{}, error)

+ SetFormSrc func(auth model.MemoryAuth, id string, formSrc map[string]interface{}) error

+ TestFormData func(auth model.MemoryAuth, id string, input map[string]interface{}, submit bool) (validate.ErrorMap, error)

+ UpdateForm func(auth model.Auth, id string, reader io.ReadCloser) (*model.FormItem, error)

+ Vars func(auth model.Auth, contains string, options storage.Options) ([]string, error)

+ type NodeService interface

+ List func(nodeType string) []*workflow.Node

+ ListExternalNodes func() []*externalnode.ExternalNode

+ ProbeExternalNodes func()

+ PutExternalNodeInstance func(auth model.Auth, instance *externalnode.ExternalNodeInstance) error

+ QueryFromInstanceID func(auth model.Auth, nodeId string) (externalnode.ExternalNodeInstance, error)

+ RegisterExternalNode func(user *model.User, node *externalnode.ExternalNode) error

+ type PaymentService interface

+ All func() ([]*model.WorkflowPaymentItem, error)

+ CancelWorkflowPayment func(paymentId, ethAddress string) error

+ CheckForWorkflowPayment func(auth model.Auth, workflowId string) error

+ CheckIfWorkflowPaymentRequired func(auth model.Auth, workflowId string) (bool, error)

+ CreateWorkflowPayment func(auth model.Auth, workflowId, ethAddress string) (*model.WorkflowPaymentItem, error)

+ Delete func(paymentId string) error

+ GetWorkflowPayment func(txHash, ethAddresses, status string) (*model.WorkflowPaymentItem, error)

+ GetWorkflowPaymentById func(paymentId string) (*model.WorkflowPaymentItem, error)

+ RedeemPayment func(workflowId, ethAddr string) error

+ UpdateWorkflowPaymentPending func(paymentId, txHash, ethAddress string) error

+ type SignatureRequestItemComplete struct

+ DocID string

+ From string

+ FromAddr string

+ Hash string

+ ID string

+ Rejected bool

+ RejectedAt *string

+ RequestedAt *string

+ Revoked bool

+ RevokedAt *string

+ type SignatureRequestItemMinimal struct

+ Rejected bool

+ RejectedAt *string

+ RequestedAt *string

+ Revoked bool

+ RevokedAt *string

+ SignatoryAddr string

+ SignatoryName string

+ type SignatureRequestsComplete []SignatureRequestItemComplete

+ type SignatureRequestsMinimal []SignatureRequestItemMinimal

+ type SignatureService interface

+ AddAndNotify func(auth model.Auth, translator www.Translator, ...) error

+ GetById func(id, docId string) (SignatureRequestsMinimal, error)

+ GetForCurrentUser func(auth model.Auth) (SignatureRequestsComplete, error)

+ RejectAndNotify func(auth model.Auth, translator www.Translator, id, docId, host string) error

+ RevokeAndNotify func(auth model.Auth, translator www.Translator, ...) error

+ func NewSignatureService(fileService FileService, userService UserService, emailService EmailService) SignatureService

+ type TemplateDocumentService interface

+ Compile func(template eio.Template) (*http.Response, error)

+ DeleteTemplate func(auth model.Auth, id, lang string) error

+ DeleteTemplateFiles func(auth model.Auth, id string) error

+ DownloadExtension func(os string) (resp *http.Response, err error)

+ Exists func(path string) (bool, error)

+ Get func(auth model.Auth, id string) (*model.TemplateItem, error)

+ GetTemplate func(auth model.Auth, id, lang string) (*file.IO, error)

+ GetTemplateVars func(auth model.Auth, contains string, settings storage.Options) ([]string, error)

+ List func(auth model.Auth, contains string, options storage.Options) ([]*model.TemplateItem, error)

+ Put func(auth model.Auth, item *model.TemplateItem) error

+ ReadFile func(path string, writer io.Writer) error

+ SaveTemplate func(auth model.Auth, id, lang, contentType, fileName string, data []byte) error

+ type UserDocumentService interface

+ Get func(auth model.Auth, id string) (*model.UserDataItem, error)

+ GetByWorkflow func(auth model.Auth, wf *model.WorkflowItem, finished bool) (*model.UserDataItem, bool, error)

+ GetDocFile func(auth model.Auth, id, dataPath, inlineOrAttachment string) (*FileHeaderResponse, string, error)

+ GetTemplateWithFormatFile func(auth model.Auth, id, dataPath, format, inlineOrAttachment string) (*FileHeaderResponse, io.ReadCloser, error)

+ List func(auth model.Auth, contains string, settings storage.Options) ([]*model.UserDataItem, error)

+ Put func(auth model.Auth, userDataItem *model.UserDataItem) error

+ type UserService interface

+ DeleteUser func(auth model.Auth) error

+ DeleteUserData func(auth model.Auth, id string) error

+ GetByBCAddress func(blockchainAddress string) (*model.User, error)

+ GetByEmail func(email string) (*model.User, error)

+ GetById func(auth model.Auth, id string) (*model.User, error)

+ GetProfilePhoto func(auth model.Auth, id string, writer io.Writer) error

+ GetUser func(auth model.Auth) (*model.User, error)

+ GetUserDataById func(auth model.Auth, id string) (*model.UserDataItem, error)

+ List func(sess model.Auth, contains string, settings storage.Options) ([]*model.User, error)

+ Put func(auth model.Auth, user *model.User) error

+ PutPassword func(userId, password string) error

+ PutProfilePhoto func(auth model.Auth, userId string, reader io.ReadCloser) error

+ type WorkflowService interface

+ CopyWorkflows func(rootUser, newUser *model.User)

+ Delete func(auth model.Auth, id string) error

+ Get func(auth model.Auth, id string) (*model.WorkflowItem, error)

+ GetAndPopulateOwner func(auth model.Auth, id string) (*model.WorkflowItem, error)

+ GetPublished func(auth model.Auth, id string) (*model.WorkflowItem, error)

+ InstantiateExternalNode func(auth model.Auth, nodeId, nodeName string) (*extNode.ExternalQuery, error)

+ List func(auth model.Auth, contains string, options storage.Options) ([]*model.WorkflowItem, error)

+ ListIds func(auth model.Auth, contains string, options storage.Options) ([]string, error)

+ ListPublished func(auth model.Auth, contains string, options storage.Options) ([]*model.WorkflowItem, error)

+ Publish func(auth model.Auth, wfItem *model.WorkflowItem) map[string]interface{}

+ Put func(auth model.Auth, wfItem *model.WorkflowItem) error