aclindsa/ofxgo
1
0
Fork 0
mirror of https://github.com/aclindsa/ofxgo.git synced 2024-11-25 04:20:05 -05:00
Code Issues Releases Wiki Activity

common: Improve comments

Browse Source
This commit is contained in:
Aaron Lindsay 2017-04-12 21:39:54 -04:00
parent 6c20007ada
commit e670b52a08
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
common.go
View File

@ -7,16 +7,18 @@ import (
"github.com/aclindsa/go/src/encoding/xml" "github.com/aclindsa/go/src/encoding/xml"
) )
// Represents an OFX message in a message set // Message represents an OFX message in a message set. it is used to ease
// marshalling and unmarshalling.
type Message interface { type Message interface {
Name() string // The name of the OFX transaction wrapper element this represents Name() string // The name of the OFX transaction wrapper element this represents
Valid() (bool, error) // Called before a Message is marshaled and after Valid() (bool, error) // Called before a Message is marshaled and after it's unmarshaled to ensure the request or response is valid
// it's unmarshaled to ensure the request or response is valid Type() messageType // The message set this message belongs to
Type() messageType // The message set this message belongs to
} }
type messageType uint type messageType uint
// These constants are returned by Messages' Type() functions to determine
// which message set they belong to
const ( const (
// Requests // Requests
SignonRq messageType = iota SignonRq messageType = iota
@ -34,6 +36,7 @@ const (
PresDlvRq PresDlvRq
ProfRq ProfRq
ImageRq ImageRq
// Responses // Responses
SignonRs SignonRs
SignupRs SignupRs