package
1.8.0
Repository: https://github.com/blues/note-go.git
Documentation: pkg.go.dev

# Functions

BodyToObject Unmarshals the specified map into an object.
CreateNote creates the core data structure for an object, given a JSON body.
ErrorClean removes all error keywords from an error string.
ErrorContains tests to see if an error contains an error keyword that we might expect.
ErrorJSON returns a JSON object with nothing but an error code, and with an optional message.
ErrorString safely returns a string from any error, returning "" for nil.
GetAggregateEventStatus returns the status of the event given all of the route logs for the event.
JSONMarshal is the equivalent to the json package's Marshal, however it does not escape HTML sitting inside JSON strings.
JSONMarshalIndent is like Marshal but applies Indent to format the output.
JSONToBody unmarshals the specified object and returns it as a map[string]interface{}.
JSONUnmarshal uses JSON Numbers, rather than assuming Floats.
ObjectToBody Marshals the specified object and returns it as map.
ObjectToJSON Marshals the specified object and returns it as a []byte.
WordsFromNumber converts a number to three simple words.
WordsFromString hashes a string with a 32-bit function and converts it to three simple words.
WordsToNumber looks up a number from two or three simple words.
WordToNumber converts a single word to a number.

# Constants

ACActionAnd ensures that all of these actions are allowed.
ACActionCreate (golint).
ACActionDelete (golint).
ACActionMonitor (golint).
ACActionOr ensures that any of these actions are allowed.
ACActionRead (golint).
ACActionUpdate (golint).
ACResourceAccount is an account resource, which is the accountUID that always begins with this string.
ACResourceAccounts is the resource for all accounts and all meta-account-level actions.
ACResourceApp is the app (project) resource, which is the appUID that always begins with this string.
ACResourceApps is the resource for all apps.
ACResourceDevice is the device resource, which is the deviceUID that always begins with this string.
ACResourceDevices is the resource for all devices.
ACResourceNotecardFirmwares is the resource for all notecard firmware.
ACResourceNotefile is the notefile resource and its note-level actions, which is the notefileID prefixed with this string.
ACResourceNotefiles is the resource for all notefiles and all meta-notefile-level actions.
ACResourceRoute is an route resource, which is the routeUID that always begins with this string.
ACResourceRoutes is the resource for all routes and all meta-route-level actions.
ACResourceSep is the separator for building compound resource names.
ACResourceUserFirmwares is the resource for all user firmware.
ACValidActionsAccount are actions allowed on accounts.
ACValidActionsApp are actions allowed on apps.
ACValidActionsDev are actions allowed on devices.
ACValidActionsFile are actions allowed on notefiles.
ACValidActionsFirmware are actions allowed on user firmware.
ACValidActionsNotecard are actions allowed on notecard firmware.
ACValidActionsRoute are actions allowed on routes.
ContactOwnerNoteID indicates that this is my contact.
ContactStore is the place where the user retains contact info.
DefaultDeviceEndpointID is the default endpoint name of the edge, chosen for its length in protocol messages.
DefaultHubEndpointID is the default endpoint name of the hub, chosen for its length in protocol messages.
EnvNotefile is the hard-wired notefile that the notecard uses for env vars.
ErrAccessDenied (golint).
ErrAddToFleet (golint).
ErrAppDeleted (golint).
ErrAppExists (golint).
ErrAppNotFound (golint).
ErrAppNotSpecified (golint).
ErrAuth (golint).
ErrCardIo (golint).
ErrClosed (golint).
ErrDeviceDelay10 (golint).
ErrDeviceDelay15 (golint).
ErrDeviceDelay20 (golint).
ErrDeviceDelay30 (golint).
ErrDeviceDelay5 (golint).
ErrDeviceDelay60 (golint).
ErrDeviceDisabled (golint).
ErrDeviceNotFound (golint).
ErrDeviceNotSpecified (golint).
ErrDFUInProgress (golint).
ErrDFUNotReady (golint).
ErrDoNotRoute (golint).
ErrExtendedNetworkFailure (golint).
ErrExtendedServiceFailure (golint).
ErrFileNoExist (golint).
ErrFleetNotFound (golint).
ErrGPSInactive (golint).
ErrHostUnreachable (golint).
ErrHubMode (golint).
ErrHubNoHandler (golint).
ErrIdle (golint).
ErrIncompatible (golint).
ErrJson (golint).
ErrLeaveFleetAlone (golint).
ErrNetwork (golint).
ErrNoteExists (golint).
ErrNotefileExists (golint).
ErrNotefileInUse (golint).
ErrNotefileName (golint).
ErrNotefileNoExist (golint).
ErrNotefileQueueDisallowed (golint).
ErrNoteNoExist (golint).
ErrNtnIdle (golint).
ErrProductNotFound (golint).
ErrProductNotSpecified (golint).
ErrRegistrationFailure (golint).
ErrRemoveFromFleet (golint).
ErrReqNotSupported (golint).
ErrSyntax (golint).
ErrTemplateIncompatible (golint).
ErrTicket (golint).
ErrTimeout (golint).
ErrTooBig (golint).
ErrTrackerExists (golint).
ErrTrackerNoExist (golint).
ErrTransportConnected (golint).
ErrTransportConnectedClosed (golint).
ErrTransportConnectFailure (golint).
ErrTransportConnecting (golint).
ErrTransportDisconnected (golint).
ErrTransportWaitData (golint).
ErrTransportWaitGateway (golint).
ErrTransportWaitModule (golint).
ErrTransportWaitService (golint).
ErrWebPayload (golint).
EventAdd (golint).
EventDelete (golint).
EventGeolocation (golint).
EventGet (golint).
EventNoAction (golint).
EventPost (golint).
EventPut (golint).
EventSessionBegin (golint).
EventSessionEndNotehub (golint).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
EventTest (golint).
EventUpdate (golint).
EventWebhook (golint).
GeolocationNotefile is the hard-wired notefile that the notehub uses when performing a geolocation.
HealthHostNotefile is the hard-wired notefile that the host uses for health-related info.
HealthNotefile is the hard-wired notefile that the notecard uses for health-related info.
HubDefaultInboundNotefile is the hard-wired default notefile for user data.
HubDefaultOutboundNotefile is the hard-wired default notefile for user data.
LogNotefile is the hard-wired notefile that the notecard uses for debug logging.
MessageContentASCII is just simple ASCII text.
MessageInbox is the place into which messages are received.
MessageOutbox is the place from which messages are sent.
MessageSTagReceived indicates that this was a received message.
MessageSTagSent indicates that this was a sent message.
MessageStore is the place where the user retains messages.
MessageTagImportant indicates that the sender feels that this is an important message.
MessageTagUrgent indicates that the sender feels that this is an urgent message.
NotecardRequestNotefile is a special notefile for sending notecard requests.
NotecardResponseNotefile is a special notefile for sending notecard responses.
SessionNotefile is the hard-wired notefile that the notehub uses when starting a session.
SyncPriorityHigh (golint).
SyncPriorityHigher (golint).
SyncPriorityHighest (golint).
SyncPriorityLow (golint).
SyncPriorityLower (golint).
SyncPriorityLowest (golint).
SyncPriorityNormal (golint).
TrackNotefile is the hard-wired notefile that the notecard can use for tracking the device.
WebNotefile is the hard-wired notefile that the notehub uses when performing web requests.

# Structs

Contact has the basic contact info structure NOTE: This structure's underlying storage has been decoupled from the use of the structure in business logic.
Contacts has contact info for this app NOTE: This structure's underlying storage has been decoupled from the use of the structure in business logic.
DeviceSession is the basic unit of recorded device usage history.
DeviceUsage is the device usage metric representing values from the beginning of time, since Provisioned.
Event is the request structure passed to the Notification proc NOTE: This structure's underlying storage has been decoupled from the use of the structure in business logic.
History records the update history, optimized so that if the most recent entry is by the same endpoint as an update/delete, that entry is re-used.
Info is a general "content" structure.
Message is the core message data structure.
MessageAddress is the network routing information for a message.
MessageContact is the entity sending a message, who may have multiple devices/addresses.
Note is the most fundamental data structure, containing user data referred to as its "body" and its "payload".
Information about notefiles and their templates.
NotefileInfo has parameters about the Notefile.
RouteLogEntry is the log entry used by notification processing.
TowerLocation is the cell tower location structure generated by the tower utility.
Word index data structure.

# Type aliases

No description provided by the author